@trayio/tray-schema 3.13.2-unstable → 3.13.3-unstable

package/dist/schema/TJSTraySchemaGenerator.d.ts

@@ -1,9 +1,8 @@
-import * as TJS from 'typescript-json-schema';
 import { Either } from 'fp-ts/Either';
 import { DynamicObject } from '@trayio/commons/dynamictype/DynamicType';
 import { TraySchemaGenerator } from './TraySchemaGenerator';
 export declare class TJSTraySchemaGenerator implements TraySchemaGenerator {
     generateFromType(type: string, path: string): Either<Error, DynamicObject>;
-    jsonSchemaToTraySchema(schema: TJS.Definition): TJS.Definition;
+    jsonSchemaToTraySchema(schema: DynamicObject): DynamicObject;
 }
 //# sourceMappingURL=TJSTraySchemaGenerator.d.ts.map

package/dist/schema/TJSTraySchemaGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TJSTraySchemaGenerator.d.ts","sourceRoot":"","sources":["../../src/schema/TJSTraySchemaGenerator.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,GAAG,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAe,MAAM,cAAc,CAAC;AAEnD,OAAO,EAEN,aAAa,EAEb,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,qBAAa,sBAAuB,YAAW,mBAAmB;IACjE,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC;IAuC1E,sBAAsB,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU;CA0H9D"}
+{"version":3,"file":"TJSTraySchemaGenerator.d.ts","sourceRoot":"","sources":["../../src/schema/TJSTraySchemaGenerator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAe,MAAM,cAAc,CAAC;AAEnD,OAAO,EAEN,aAAa,EAEb,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,qBAAa,sBAAuB,YAAW,mBAAmB;IACjE,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC;IA2C1E,sBAAsB,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa;CA4J5D"}

package/dist/schema/TJSTraySchemaGenerator.js

@@ -28,6 +28,7 @@ const path_1 = require("path");
 const TJS = __importStar(require("typescript-json-schema"));
 const Either_1 = require("fp-ts/Either");
 const lodash_1 = require("lodash");
+const Try_1 = require("@trayio/commons/try/Try");
 class TJSTraySchemaGenerator {
     generateFromType(type, path) {
         const settings = {
@@ -41,11 +42,14 @@ class TJSTraySchemaGenerator {
                 'enumLabels',
                 'advanced',
                 'dropdown',
+                'dynamicSchemaReference',
             ],
             // adds a required array to every entitiy in the schema which describes which children are required
             required: true,
             // adds "additionalProperties: false" to the schemas
             noExtraProps: true,
+            // allows for using literal/const types by converting them to single element enums in json schema
+            constAsEnum: true,
         };
         const compilerOptions = {
             strictNullChecks: true,
@@ -58,8 +62,7 @@ class TJSTraySchemaGenerator {
         const program = TJS.getProgramFromFiles([(0, path_1.resolve)(path)], compilerOptions);
         const schema = TJS.generateSchema(program, type, settings);
         if (schema !== null) {
-            const traySchema = this.jsonSchemaToTraySchema(schema);
-            return (0, Either_1.right)(traySchema);
+            return (0, Try_1.tryToEither)(() => this.jsonSchemaToTraySchema(schema));
         }
         return (0, Either_1.left)(new Error('Failed to generate JSON schema from type'));
     }
@@ -149,11 +152,14 @@ class TJSTraySchemaGenerator {
                 delete object.allOf;
             }
         };
-        const transformAdvanced = (object) => {
+        const transformProperties = (object) => {
             if (Object.prototype.hasOwnProperty.call(object, 'properties') &&
                 object.properties !== null) {
                 object.advanced = [];
                 for (const [key, value] of Object.entries(object.properties)) {
+                    if (key.startsWith('__@_brand')) {
+                        throw new Error(`Branded types not supported, change or remove [${key}] property`);
+                    }
                     if (value.advanced === true) {
                         object.advanced.push(key);
                     }
@@ -161,9 +167,33 @@ class TJSTraySchemaGenerator {
                 }
             }
         };
+        const transformSpecialTypes = (object) => {
+            if (Object.prototype.hasOwnProperty.call(object, '$ref')) {
+                throw new Error(`Recursive types not supported, make sure none of the types being used are recursive`);
+            }
+            if (Object.prototype.hasOwnProperty.call(object, 'type') &&
+                object.type !== null &&
+                typeof object.type === 'string') {
+                switch (object.type) {
+                    case 'DynamicObject':
+                        object.type = 'object';
+                        object.tag = 'DynamicObject';
+                        object.properties = {};
+                        break;
+                    case 'DynamicSchema':
+                        object.type = 'object';
+                        object.tag = 'DynamicSchema';
+                        object.properties = {};
+                        break;
+                    default:
+                        break;
+                }
+            }
+        };
         const recursiveObjectSearch = (object) => {
+            transformSpecialTypes(object);
             transformAllOf(object);
-            transformAdvanced(object);
+            transformProperties(object);
             for (const [key, value] of Object.entries(object)) {
                 if (typeof value === 'object' && value !== null) {
                     transformLookup(value);

package/dist/schema/TJSTraySchemaGenerator.unit.test.js

@@ -199,15 +199,25 @@ describe('TJSTraySchemaGenerator', () => {
                                 enum: ['default always', 'the_danger', 'primary-one'],
                                 type: 'string',
                             },
+                            nestedConstProp: {
+                                type: 'string',
+                                enum: ['NestedConstProperty'],
+                                enumLabels: ['Nested Const Property'],
+                            },
                         },
                         advanced: [],
-                        required: ['text', 'type'],
+                        required: ['nestedConstProp', 'text', 'type'],
                         additionalProperties: false,
                     },
                 },
+                constProp: {
+                    type: 'string',
+                    enum: ['ConstProperty'],
+                    enumLabels: ['Const Property'],
+                },
             },
             advanced: [],
-            required: ['actions'],
+            required: ['actions', 'constProp'],
             additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
@@ -478,4 +488,68 @@ describe('TJSTraySchemaGenerator', () => {
         };
         expect(actual).toEqual(expected);
     });
+    it('Adds tags to fields of special types', () => {
+        const type = 'Input';
+        const dirPath = __dirname;
+        const path = (0, path_1.join)(dirPath, 'tag.test.data.ts');
+        const result = new TJSTraySchemaGenerator_1.TJSTraySchemaGenerator().generateFromType(type, path);
+        const actual = E.getOrElse((error) => {
+            console.warn(error);
+            throw new Error(`Failed to generate JSON schema from type`);
+        })(result);
+        const expected = {
+            type: 'object',
+            properties: {
+                schema: {
+                    type: 'object',
+                    tag: 'DynamicSchema',
+                    properties: {},
+                    advanced: [],
+                },
+                obj: {
+                    type: 'object',
+                    dynamicSchemaReference: 'input.value',
+                    tag: 'DynamicObject',
+                    properties: {},
+                    advanced: [],
+                },
+                nested: {
+                    type: 'object',
+                    properties: {
+                        nestedSchema: {
+                            type: 'object',
+                            tag: 'DynamicSchema',
+                            properties: {},
+                            advanced: [],
+                        },
+                        nestedObj: {
+                            type: 'object',
+                            dynamicSchemaReference: 'input.test.value',
+                            tag: 'DynamicObject',
+                            properties: {},
+                            advanced: [],
+                        },
+                        nestedConstProp: {
+                            type: 'string',
+                            enum: ['NestedConstProperty'],
+                            enumLabels: ['Nested Const Property'],
+                        },
+                    },
+                    additionalProperties: false,
+                    required: ['nestedConstProp', 'nestedObj', 'nestedSchema'],
+                    advanced: [],
+                },
+                constProp: {
+                    type: 'string',
+                    enum: ['ConstProperty'],
+                    enumLabels: ['Const Property'],
+                },
+            },
+            additionalProperties: false,
+            required: ['constProp', 'nested', 'obj', 'schema'],
+            $schema: 'http://json-schema.org/draft-07/schema#',
+            advanced: [],
+        };
+        expect(actual).toEqual(expected);
+    });
 });

package/dist/schema/enum.test.data.d.ts

@@ -3,10 +3,12 @@ export type Input = {
      * @description example dropdown
      */
     actions: Action[];
+    constProp: 'ConstProperty';
 };
 type Action = {
     text: string;
     type: ActionType;
+    nestedConstProp: 'NestedConstProperty';
 };
 declare enum ActionType {
     default = "default always",

package/dist/schema/enum.test.data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enum.test.data.d.ts","sourceRoot":"","sources":["../../src/schema/enum.test.data.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,KAAK,GAAG;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,KAAK,MAAM,GAAG;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,CAAC;CACjB,CAAC;AAEF,aAAK,UAAU;IACd,OAAO,mBAAmB;IAC1B,MAAM,eAAe;IACrB,OAAO,gBAAgB;CACvB"}
+{"version":3,"file":"enum.test.data.d.ts","sourceRoot":"","sources":["../../src/schema/enum.test.data.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,KAAK,GAAG;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,SAAS,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,KAAK,MAAM,GAAG;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,UAAU,CAAC;IACjB,eAAe,EAAE,qBAAqB,CAAC;CACvC,CAAC;AAEF,aAAK,UAAU;IACd,OAAO,mBAAmB;IAC1B,MAAM,eAAe;IACrB,OAAO,gBAAgB;CACvB"}

package/dist/schema/tag.test.data.d.ts

@@ -0,0 +1,27 @@
+import { DynamicObject } from '@trayio/commons/dynamictype/DynamicType';
+export type Input = {
+    /**
+     * @TJS-type DynamicSchema
+     */
+    schema: DynamicObject;
+    /**
+     * @TJS-type DynamicObject
+     * @dynamicSchemaReference input.value
+     */
+    obj: DynamicObject;
+    nested: Nested;
+    constProp: 'ConstProperty';
+};
+export type Nested = {
+    /**
+     * @TJS-type DynamicSchema
+     */
+    nestedSchema: DynamicObject;
+    /**
+     * @TJS-type DynamicObject
+     * @dynamicSchemaReference input.test.value
+     */
+    nestedObj: DynamicObject;
+    nestedConstProp: 'NestedConstProperty';
+};
+//# sourceMappingURL=tag.test.data.d.ts.map

package/dist/schema/tag.test.data.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tag.test.data.d.ts","sourceRoot":"","sources":["../../src/schema/tag.test.data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yCAAyC,CAAC;AAExE,MAAM,MAAM,KAAK,GAAG;IACnB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAC;IACtB;;;OAGG;IACH,GAAG,EAAE,aAAa,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,eAAe,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACpB;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;IAC5B;;;OAGG;IACH,SAAS,EAAE,aAAa,CAAC;IACzB,eAAe,EAAE,qBAAqB,CAAC;CACvC,CAAC"}

package/dist/schema/tag.test.data.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/tray-schema",
-  "version": "3.13.2-unstable",
+  "version": "3.13.3-unstable",
   "description": "Schema for Tray connectors and authentications",
   "exports": {
     "./*": "./dist/*.js"
@@ -11,7 +11,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@trayio/commons": "3.13.2-unstable",
+    "@trayio/commons": "3.13.3-unstable",
     "@types/node": "18.11.9",
     "lodash": "4.17.21",
     "typescript-json-schema": "0.62.0"