Merge branch 'master' into develop

sueddeutsche · Oct 6, 2021 · 8409f5b · 8409f5b
2 parents 0c7004a + 7414ef0
commit 8409f5b
Show file tree

Hide file tree

Showing 9 changed files with 518 additions and 278 deletions.
diff --git a/dist/editron-modules.js b/dist/editron-modules.js
diff --git a/dist/manifest.json b/dist/manifest.json
diff --git a/dist/module/src/Editron.js b/dist/module/src/Editron.js
@@ -93,7 +93,6 @@ export default class Editron {
         this.plugins = [];
         /** editron proxy instance */
         _proxy.set(this, void 0);
-        schema = UISchema.extendSchema(schema);
         this.options = {
             editors: [],
             addDefaultEditors: true,
@@ -357,7 +356,6 @@ export default class Editron {
      * @param schema   - a valid json-schema
      */
     setSchema(schema) {
-        schema = UISchema.extendSchema(schema);
         this.service("validation").set(schema);
         this.service("schema").setSchema(schema);
     }

diff --git a/dist/module/src/utils/UISchema.js b/dist/module/src/utils/UISchema.js
@@ -1,6 +1,5 @@
 import gp from "gson-pointer";
 import populated from "./populated";
-import { eachSchema } from "json-schema-library";
 const UI_PROPERTY = "editron:ui";
 /** property on a schema-definition, containing editron-options */
 export const EDITRON_OPTION_PROPERTY = "editron:ui";
@@ -83,29 +82,6 @@ function copyOptions(pointer, editron) {
     });
     return settings;
 }
-/**
- * Ensures each schema contains a valid schema[UI_PROPERTY] object
- * @param rootSchema
- * @return extended clone of json-schema
- */
-function extendSchema(rootSchema) {
-    rootSchema = JSON.parse(JSON.stringify(rootSchema));
-    eachSchema(rootSchema, childSchema => {
-        if (childSchema.$ref && childSchema[UI_PROPERTY] == null) {
-            // do not add default options for references - json-schema-library
-            // merges on root elements only (which is acceptable)
-            return;
-        }
-        childSchema[UI_PROPERTY] = {
-            hidden: false,
-            title: childSchema.title || "",
-            description: childSchema.description || "",
-            ...childSchema.options,
-            ...childSchema[UI_PROPERTY]
-        };
-    });
-    return rootSchema;
-}
 /**
  * Resolves a list of pointers, where the first found value is returned. Supports simple strings as fallback.
  *  e.g. `["/data/local/title", "/data/local/subtitle", "Title"]`
@@ -142,7 +118,7 @@ function getOption(pointer, editron, ...options) {
         throw new Error("Expected at least one options property to be given in getOption");
     }
     const schema = editron.service("schema").get(pointer);
-    const editronOptions = schema[UI_PROPERTY] || {};
+    const editronOptions = schema[UI_PROPERTY] || schema.options || {};
     for (let i = 0; i < options.length; i += 1) {
         const option = editronOptions[options[i]];
         const resolver = isPointer(option) ? resolveReference : resolveOption;
@@ -167,7 +143,6 @@ function getDefaultOption(schema, option) {
 export default {
     copyOptions,
     enumOptions,
-    extendSchema,
     getBreadcrumps,
     getDefaultOption,
     getEditronOptions,

diff --git a/dist/src/utils/UISchema.d.ts b/dist/src/utils/UISchema.d.ts
@@ -19,12 +19,6 @@ export declare type EditorSettings = {
  * @return a resolved copy of the editron:ui settings
  */
 declare function copyOptions(pointer: JSONPointer, editron: Editron): EditorSettings;
-/**
- * Ensures each schema contains a valid schema[UI_PROPERTY] object
- * @param rootSchema
- * @return extended clone of json-schema
- */
-declare function extendSchema<T extends JSONSchema>(rootSchema: T): T;
 /**
  * Returns the first defined option set in schema. Supports relative and absolute pointers in data
  *
@@ -39,7 +33,6 @@ declare function getDefaultOption(schema: JSONSchema, option: string): "" | any;
 declare const _default: {
     copyOptions: typeof copyOptions;
     enumOptions: typeof enumOptions;
-    extendSchema: typeof extendSchema;
     getBreadcrumps: typeof getBreadcrumps;
     getDefaultOption: typeof getDefaultOption;
     getEditronOptions: typeof getEditronOptions;

diff --git a/src/Editron.ts b/src/Editron.ts
@@ -128,8 +128,6 @@ export default class Editron {
      * @param [options.plugins] - list of editron-plugins to use
      */
     constructor(schema: JSONSchema = { type: "object" }, data: JSONData = {}, options: Options = {}) {
-        schema = UISchema.extendSchema(schema);
-
         this.options = {
             editors: [],
             addDefaultEditors: true,
@@ -431,7 +429,6 @@ export default class Editron {
      * @param schema   - a valid json-schema
      */
     setSchema(schema: JSONSchema): void {
-        schema = UISchema.extendSchema(schema);
         this.service("validation").set(schema);
         this.service("schema").setSchema(schema);
     }

diff --git a/src/utils/UISchema.ts b/src/utils/UISchema.ts
@@ -1,6 +1,5 @@
 import gp from "gson-pointer";
 import populated from "./populated";
-import { eachSchema } from "json-schema-library";
 const UI_PROPERTY = "editron:ui";
 import { JSONPointer, JSONSchema } from "../types";
 import Editron from "../Editron";
@@ -111,34 +110,6 @@ function copyOptions(pointer: JSONPointer, editron: Editron): EditorSettings {
 }
 
 
-/**
- * Ensures each schema contains a valid schema[UI_PROPERTY] object
- * @param rootSchema
- * @return extended clone of json-schema
- */
-function extendSchema<T extends JSONSchema>(rootSchema: T): T {
-    rootSchema = JSON.parse(JSON.stringify(rootSchema));
-
-    eachSchema(rootSchema, childSchema => {
-        if (childSchema.$ref && childSchema[UI_PROPERTY] == null) {
-            // do not add default options for references - json-schema-library
-            // merges on root elements only (which is acceptable)
-            return;
-        }
-
-        childSchema[UI_PROPERTY] = {
-            hidden: false,
-            title: childSchema.title || "",
-            description: childSchema.description || "",
-            ...childSchema.options, // @legacy options
-            ...childSchema[UI_PROPERTY]
-        };
-    });
-
-    return rootSchema;
-}
-
-
 /**
  * Resolves a list of pointers, where the first found value is returned. Supports simple strings as fallback.
  *  e.g. `["/data/local/title", "/data/local/subtitle", "Title"]`
@@ -177,7 +148,7 @@ function getOption(pointer: JSONPointer, editron: Editron, ...options: Array<str
     }
 
     const schema = editron.service("schema").get(pointer);
-    const editronOptions = schema[UI_PROPERTY] || {};
+    const editronOptions = schema[UI_PROPERTY] || schema.options || {};
 
     for (let i = 0; i < options.length; i += 1) {
         const option = editronOptions[options[i]];
@@ -210,7 +181,6 @@ function getDefaultOption(schema: JSONSchema, option: string): ""|any {
 export default {
     copyOptions,
     enumOptions,
-    extendSchema,
     getBreadcrumps,
     getDefaultOption,
     getEditronOptions,

diff --git a/test/utils/uischema/getOption.test.ts b/test/utils/uischema/getOption.test.ts
@@ -29,12 +29,6 @@ describe("UISchema.getOption", () => {
         assert.ok(result === null);
     });
 
-    it("should have option 'hidden' defined per default", () => {
-        const result = UISchema.getOption("#", controller, "hidden");
-
-        assert.ok(result === false);
-    });
-
     it("should return value of option", () => {
         schema["editron:ui"].title = "title in options";
         controller.setSchema(schema);