@extrahorizon/exh-cli 1.7.0-dev-48-62caf3f → 1.7.0-dev-50-125337b

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Extra Horizon CLI changelog
 
 ### v1.7.0
+* `exh data schemas sync` now allows schema `.json` files to contain a `$schema` property
+  * This allows you to specify a json-schema for the schema files themselves, providing hints and validation in your editor
+* `exh data schemas sync` now allows all components in a schema to have a `description` property
+  * These descriptions are not synced, but allow you to provide inline documentation for the components in your schema
 
 ### v1.6.1
 * `exh data schemas sync` no longer logs the full schema definition json

package/build/commands/data/schemas/util/metaschema.json

@@ -1,6 +1,9 @@
 {
     "type": "object",
     "properties": {
+        "$schema": {
+            "type": "string"
+        },
         "name": {
             "type": "string"
         },
@@ -78,6 +81,9 @@
                 },
                 "type": {
                     "const": "manual"
+                },
+                "description": {
+                    "type": "string"
                 }
             },
             "additionalProperties": false,
@@ -95,6 +101,9 @@
                     "name": {
                         "type": "string"
                     },
+                    "description": {
+                        "type": "string"
+                    },
                     "type": {
                         "enum": [
                             "manual",
@@ -139,6 +148,9 @@
                     "name": {
                         "type": "string"
                     },
+                    "description": {
+                        "type": "string"
+                    },
                     "fields": {
                         "type": "array",
                         "items": {
@@ -249,6 +261,9 @@
                     "type": "string",
                     "enum": ["input"]
                 },
+                "description": {
+                    "type": "string"
+                },
                 "required": {
                     "type": "array",
                     "items": { "type": "string" }
@@ -261,7 +276,10 @@
                 "configuration": { "$ref": "#/definitions/configurations" },
                 "type": {
                     "type": "string",
-                    "enum": ["input"]
+                    "enum": ["document"]
+                },
+                "description": {
+                    "type": "string"
                 },
                 "required": {
                     "type": "array",
@@ -278,6 +296,9 @@
                         "initiatorHasRelationToUserInData"
                     ]
                 },
+                "description": {
+                    "type": "string"
+                },
                 "userIdField": {
                     "type": "string"
                 },
@@ -299,6 +320,9 @@
                         "initiatorHasRelationToGroupInData"
                     ]
                 },
+                "description": {
+                    "type": "string"
+                },
                 "groupIdField": {
                     "type": "string"
                 },
@@ -321,6 +345,9 @@
                     "type": "string",
                     "enum": ["object"]
                 },
+                "description": {
+                    "type": "string"
+                },
                 "required": {
                     "type": "array",
                     "items": {
@@ -341,6 +368,9 @@
                     "type": "string",
                     "enum": ["array"]
                 },
+                "description": {
+                    "type": "string"
+                },
                 "items": {
                     "type": "object"
                 },
@@ -365,6 +395,9 @@
                     "type": "string",
                     "enum": ["string"]
                 },
+                "description": {
+                    "type": "string"
+                },
                 "minLength": {
                     "type": "number"
                 },
@@ -399,6 +432,9 @@
                     "type": "string",
                     "enum": ["string"]
                 },
+                "description": {
+                    "type": "string"
+                },
                 "minimum": {
                     "type": "number"
                 },
@@ -426,6 +462,9 @@
                     "type": "string",
                     "enum": ["boolean"]
                 },
+                "description": {
+                    "type": "string"
+                },
                 "enum": {
                     "type": "array",
                     "items": {

package/build/commands/data/schemas/util/stripUnsupportedDescriptionFields.d.ts

@@ -0,0 +1,22 @@
+import { Schema, Transition } from '@extrahorizon/javascript-sdk';
+export declare function stripUnsupportedDescriptionFields(schema: Schema): {
+    id: string;
+    name: string;
+    description: string;
+    properties: Record<string, any>;
+    indexes: import("@extrahorizon/javascript-sdk").Index[];
+    statuses: Record<string, Record<string, string>>;
+    creationTransition: import("@extrahorizon/javascript-sdk").CreationTransition;
+    transitions: Transition[];
+    createMode: import("@extrahorizon/javascript-sdk").CreateMode;
+    readMode: import("@extrahorizon/javascript-sdk").ReadMode;
+    updateMode: import("@extrahorizon/javascript-sdk").UpdateMode;
+    deleteMode: import("@extrahorizon/javascript-sdk").DeleteMode;
+    groupSyncMode: import("@extrahorizon/javascript-sdk").GroupSyncMode;
+    defaultLimit?: number;
+    maximumLimit?: number;
+    updateTimestamp: Date;
+    creationTimestamp: Date;
+    findTransitionIdByName?: (name: string) => string;
+    transitionsByName?: Record<string, Transition>;
+};

package/build/commands/data/schemas/util/stripUnsupportedDescriptionFields.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stripUnsupportedDescriptionFields = void 0;
+const _ = require("lodash");
+function stripUnsupportedDescriptionFields(schema) {
+    const newSchema = { ...schema };
+    if (schema.creationTransition) {
+        newSchema.creationTransition = _.omit(schema.creationTransition, 'description');
+    }
+    if (schema.transitions) {
+        newSchema.transitions = schema.transitions.map(stripDescriptionsFromTransition);
+    }
+    if (schema.properties) {
+        newSchema.properties = _.mapValues(schema.properties, stripDescriptionsFromTypeConfiguration);
+    }
+    if (schema.indexes) {
+        newSchema.indexes = schema.indexes.map(index => _.omit(index, 'description'));
+    }
+    return newSchema;
+}
+exports.stripUnsupportedDescriptionFields = stripUnsupportedDescriptionFields;
+function stripDescriptionsFromTransition(transition) {
+    const newTransition = _.omit(transition, 'description');
+    if (newTransition.conditions) {
+        newTransition.conditions = newTransition.conditions.map(condition => {
+            const newCondition = _.omit(condition, 'description');
+            if (newCondition.type === 'input' || newCondition.type === 'document') {
+                if (newCondition.configuration) {
+                    newCondition.configuration = stripDescriptionsFromTypeConfiguration(newCondition.configuration);
+                }
+            }
+            return newCondition;
+        });
+    }
+    if (newTransition.actions) {
+        newTransition.actions = newTransition.actions.map(action => _.omit(action, 'description'));
+    }
+    return newTransition;
+}
+function stripDescriptionsFromTypeConfiguration(configuration) {
+    const newConfiguration = _.omit(configuration, 'description');
+    if (newConfiguration.type === 'object') {
+        if (newConfiguration.properties) {
+            newConfiguration.properties = _.mapValues(newConfiguration.properties, stripDescriptionsFromTypeConfiguration);
+        }
+        if (newConfiguration.additionalProperties) {
+            newConfiguration.additionalProperties = stripDescriptionsFromTypeConfiguration(newConfiguration.additionalProperties);
+        }
+    }
+    if (newConfiguration.type === 'array') {
+        if (newConfiguration.items) {
+            newConfiguration.items = stripDescriptionsFromTypeConfiguration(newConfiguration.items);
+        }
+        if (newConfiguration.contains) {
+            newConfiguration.contains = stripDescriptionsFromTypeConfiguration(newConfiguration.contains);
+        }
+    }
+    return newConfiguration;
+}

package/build/commands/data/schemas/util/syncSchema.js

@@ -11,6 +11,7 @@ const chalk = require("chalk");
 const _ = require("lodash");
 const schemaRepository = require("../../../../repositories/schemas");
 const statusHelpers_1 = require("../sync/statusHelpers");
+const stripUnsupportedDescriptionFields_1 = require("./stripUnsupportedDescriptionFields");
 class SyncSchema {
     constructor(sdk, dry) {
         _SyncSchema_instances.add(this);
@@ -23,7 +24,7 @@ class SyncSchema {
         return new SyncSchema(sdk, dry);
     }
     async sync(target) {
-        this.localSchema = target;
+        this.localSchema = (0, stripUnsupportedDescriptionFields_1.stripUnsupportedDescriptionFields)(target);
         if (!this.localSchema.name) {
             console.log('No schema name defined, skipping this file');
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extrahorizon/exh-cli",
-  "version": "1.7.0-dev-48-62caf3f",
+  "version": "1.7.0-dev-50-125337b",
   "main": "build/index.js",
   "exports": "./build/index.js",
   "license": "MIT",