@trayio/tray-schema 0.33.0 → 0.35.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Tray.io, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/schema/TJSTraySchemaGenerator.d.ts

@@ -0,0 +1,9 @@
+import * as TJS from 'typescript-json-schema';
+import { Either } from 'fp-ts/Either';
+import { DynamicObject } from '@trayio/tray-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;
+}
+//# sourceMappingURL=TJSTraySchemaGenerator.d.ts.map

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

@@ -0,0 +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,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAC7E,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;IA2B1E,sBAAsB,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU;CAsF9D"}

package/dist/schema/{TJSTraySchemaTypeTransformer.js → TJSTraySchemaGenerator.js}

@@ -23,13 +23,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TJSTraySchemaTypeTransformer = void 0;
+exports.TJSTraySchemaGenerator = void 0;
 const path_1 = require("path");
 const TJS = __importStar(require("typescript-json-schema"));
 const Either_1 = require("fp-ts/Either");
 const lodash_1 = require("lodash");
-class TJSTraySchemaTypeTransformer {
-    generateFromTypes(type, path) {
+class TJSTraySchemaGenerator {
+    generateFromType(type, path) {
         const settings = {
             // this will prevent creating references in the schema when references are used in the types
             ref: false,
@@ -37,6 +37,8 @@ class TJSTraySchemaTypeTransformer {
             validationKeywords: ['lookupInput', 'lookupOperation', 'enumLabels'],
             // 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,
         };
         const compilerOptions = {
             strictNullChecks: true,
@@ -133,4 +135,4 @@ class TJSTraySchemaTypeTransformer {
         return schema;
     }
 }
-exports.TJSTraySchemaTypeTransformer = TJSTraySchemaTypeTransformer;
+exports.TJSTraySchemaGenerator = TJSTraySchemaGenerator;

package/dist/schema/TJSTraySchemaGenerator.unit.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=TJSTraySchemaGenerator.unit.test.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TJSTraySchemaGenerator.unit.test.d.ts","sourceRoot":"","sources":["../../src/schema/TJSTraySchemaGenerator.unit.test.ts"],"names":[],"mappings":""}

package/dist/schema/{TJSTraySchemaTypeTransformer.test.js → TJSTraySchemaGenerator.unit.test.js}

@@ -25,13 +25,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const E = __importStar(require("fp-ts/Either"));
 const path_1 = require("path");
-const TJSTraySchemaTypeTransformer_1 = require("./TJSTraySchemaTypeTransformer");
-describe('TJSTraySchemaTypeTransformer', () => {
+const TJSTraySchemaGenerator_1 = require("./TJSTraySchemaGenerator");
+describe('TJSTraySchemaGenerator', () => {
     it('Generates data types', () => {
         const type = 'Input';
         const dirPath = __dirname;
-        const path = (0, path_1.join)(dirPath, 'datatypes.test.data.ts');
-        const result = new TJSTraySchemaTypeTransformer_1.TJSTraySchemaTypeTransformer().generateFromTypes(type, path);
+        const path = (0, path_1.join)(dirPath, 'dataTypes.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`);
@@ -50,6 +50,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
                 },
             },
             required: ['arr', 'bool', 'int', 'num', 'obj', 'str'],
+            additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
         expect(actual).toEqual(expected);
@@ -58,7 +59,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
         const type = 'Input';
         const dirPath = __dirname;
         const path = (0, path_1.join)(dirPath, 'importsReusable.test.data.ts');
-        const result = new TJSTraySchemaTypeTransformer_1.TJSTraySchemaTypeTransformer().generateFromTypes(type, path);
+        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`);
@@ -74,16 +75,18 @@ describe('TJSTraySchemaTypeTransformer', () => {
                         reusableFieldB: { type: 'string' },
                     },
                     required: ['reusableFieldA', 'reusableFieldB'],
+                    additionalProperties: false,
                 },
                 reusableSchemaA: { type: 'number' },
                 reusableSchemaB: { type: 'string' },
             },
             required: [
                 'reusableFields',
-                'specificField',
                 'reusableSchemaA',
                 'reusableSchemaB',
+                'specificField',
             ],
+            additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
         expect(actual).toEqual(expected);
@@ -92,7 +95,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
         const type = 'Input';
         const dirPath = __dirname;
         const path = (0, path_1.join)(dirPath, 'oneOf.test.data.ts');
-        const result = new TJSTraySchemaTypeTransformer_1.TJSTraySchemaTypeTransformer().generateFromTypes(type, path);
+        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`);
@@ -118,16 +121,19 @@ describe('TJSTraySchemaTypeTransformer', () => {
                                                     metadata: { type: 'string' },
                                                 },
                                                 required: ['metadata', 'path'],
+                                                additionalProperties: false,
                                             },
                                             {
                                                 type: 'object',
                                                 properties: { imgId: { type: 'number' } },
                                                 required: ['imgId'],
+                                                additionalProperties: false,
                                             },
                                         ],
                                     },
                                 },
                                 required: ['src'],
+                                additionalProperties: false,
                             },
                             {
                                 type: 'object',
@@ -139,12 +145,14 @@ describe('TJSTraySchemaTypeTransformer', () => {
                                     },
                                 },
                                 required: ['msg'],
+                                additionalProperties: false,
                             },
                         ],
                     },
                 },
             },
             required: ['elements'],
+            additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
         expect(actual).toEqual(expected);
@@ -153,7 +161,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
         const type = 'Input';
         const dirPath = __dirname;
         const path = (0, path_1.join)(dirPath, 'enum.test.data.ts');
-        const result = new TJSTraySchemaTypeTransformer_1.TJSTraySchemaTypeTransformer().generateFromTypes(type, path);
+        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`);
@@ -175,10 +183,12 @@ describe('TJSTraySchemaTypeTransformer', () => {
                             },
                         },
                         required: ['text', 'type'],
+                        additionalProperties: false,
                     },
                 },
             },
             required: ['actions'],
+            additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
         expect(actual).toEqual(expected);
@@ -187,7 +197,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
         const type = 'Input';
         const dirPath = __dirname;
         const path = (0, path_1.join)(dirPath, 'ddl.test.data.ts');
-        const result = new TJSTraySchemaTypeTransformer_1.TJSTraySchemaTypeTransformer().generateFromTypes(type, path);
+        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`);
@@ -207,6 +217,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
                 },
             },
             required: ['emails'],
+            additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
         expect(actual).toEqual(expected);
@@ -215,7 +226,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
         const type = 'Input';
         const dirPath = __dirname;
         const path = (0, path_1.join)(dirPath, 'required.test.data.ts');
-        const result = new TJSTraySchemaTypeTransformer_1.TJSTraySchemaTypeTransformer().generateFromTypes(type, path);
+        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`);
@@ -227,6 +238,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
                 optionalField: { type: 'string' },
             },
             required: ['mandatoryField'],
+            additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
         expect(actual).toEqual(expected);
@@ -235,7 +247,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
         const type = 'Input';
         const dirPath = __dirname;
         const path = (0, path_1.join)(dirPath, 'format.test.data.ts');
-        const result = new TJSTraySchemaTypeTransformer_1.TJSTraySchemaTypeTransformer().generateFromTypes(type, path);
+        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`);
@@ -250,6 +262,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
                 file: { format: 'file', type: 'string' },
             },
             required: ['file', 'html', 'longNotes', 'password', 'timestamp'],
+            additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
         expect(actual).toEqual(expected);
@@ -258,7 +271,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
         const type = 'Input';
         const dirPath = __dirname;
         const path = (0, path_1.join)(dirPath, 'default.test.data.ts');
-        const result = new TJSTraySchemaTypeTransformer_1.TJSTraySchemaTypeTransformer().generateFromTypes(type, path);
+        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`);
@@ -283,6 +296,7 @@ describe('TJSTraySchemaTypeTransformer', () => {
                 },
             },
             required: ['arr', 'bool', 'int', 'num', 'obj', 'str'],
+            additionalProperties: false,
             $schema: 'http://json-schema.org/draft-07/schema#',
         };
         expect(actual).toEqual(expected);

package/dist/schema/TraySchemaGenerator.d.ts

@@ -0,0 +1,6 @@
+import { Either } from 'fp-ts/lib/Either';
+import { DynamicObject } from '@trayio/tray-commons/dynamictype/DynamicType';
+export interface TraySchemaGenerator {
+    generateFromType(type: string, path: string): Either<Error, DynamicObject>;
+}
+//# sourceMappingURL=TraySchemaGenerator.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TraySchemaGenerator.d.ts","sourceRoot":"","sources":["../../src/schema/TraySchemaGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAE7E,MAAM,WAAW,mBAAmB;IACnC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;CAC3E"}

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@trayio/tray-schema",
-  "version": "0.33.0",
+  "version": "0.35.0",
   "description": "Vanilla typescript code with extensions to the language or basic features",
   "exports": {
     "./*": "./dist/*.js"
   },
   "author": "Tray.io",
-  "license": "Proprietary",
+  "license": "MIT",
   "publishConfig": {
     "access": "public"
   },
   "dependencies": {
-    "@trayio/tray-commons": "0.33.0",
-    "@types/node": "18.7.18",
+    "@trayio/tray-commons": "0.35.0",
+    "@types/node": "18.11.9",
     "lodash": "4.17.5",
     "typescript-json-schema": "0.61.0"
   },

package/dist/schema/TJSTraySchemaTypeTransformer.d.ts

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

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

@@ -1 +0,0 @@
-{"version":3,"file":"TJSTraySchemaTypeTransformer.d.ts","sourceRoot":"","sources":["../../src/schema/TJSTraySchemaTypeTransformer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,GAAG,MAAM,wBAAwB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAe,MAAM,cAAc,CAAC;AAEnD,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAC7E,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,qBAAa,4BAA6B,YAAW,yBAAyB;IAC7E,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC;IAyB3E,sBAAsB,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU;CAsF9D"}

package/dist/schema/TJSTraySchemaTypeTransformer.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=TJSTraySchemaTypeTransformer.test.d.ts.map

package/dist/schema/TJSTraySchemaTypeTransformer.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"TJSTraySchemaTypeTransformer.test.d.ts","sourceRoot":"","sources":["../../src/schema/TJSTraySchemaTypeTransformer.test.ts"],"names":[],"mappings":""}

package/dist/schema/TraySchemaTypeTransformer.d.ts

@@ -1,6 +0,0 @@
-import { Either } from 'fp-ts/lib/Either';
-import { DynamicObject } from '@trayio/tray-commons/dynamictype/DynamicType';
-export interface TraySchemaTypeTransformer {
-    generateFromTypes(type: string, path: string): Either<Error, DynamicObject>;
-}
-//# sourceMappingURL=TraySchemaTypeTransformer.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"TraySchemaTypeTransformer.d.ts","sourceRoot":"","sources":["../../src/schema/TraySchemaTypeTransformer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,8CAA8C,CAAC;AAE7E,MAAM,WAAW,yBAAyB;IACzC,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;CAC5E"}