@squiz/dx-json-schema-lib 1.2.13-alpha.0

package/lib/manifest/v1/DxComponentInputSchema.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$id": "DxComponentInputSchema.json",
+    "title": "DxComponentInputSchema",
+    "description": "Input schema for a DxComponent",
+    "type": "object",
+    "properties": {
+        "type": {
+            "const": "object"
+        },
+        "additionalProperties": {
+            "default": false
+        }
+    },
+    "allOf": [
+        {
+            "$ref": "DxContentMetaSchema.json"
+        }
+    ]
+}

package/lib/manifest/v1/DxComponentInputSchema.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/manifest/v1/DxComponentInputSchema.spec.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const JsonValidationService_1 = require("../../JsonValidationService");
+describe('DxComponentInputSchema', () => {
+    let jsonValidationService;
+    beforeAll(() => {
+        jsonValidationService = new JsonValidationService_1.JsonValidationService();
+    });
+    it('should allow empty object', () => {
+        expect(() => jsonValidationService.validateContentSchema({})).not.toThrowError();
+    });
+    it('should require required if properties is specified', () => {
+        expect(() => jsonValidationService.validateContentSchema({
+            properties: {
+                foo: {
+                    type: 'string',
+                },
+            },
+        })).toThrowError();
+    });
+    it('should pass if required and properties are specified', () => {
+        expect(() => jsonValidationService.validateContentSchema({
+            required: ['foo'],
+            properties: {
+                foo: {
+                    type: 'string',
+                },
+            },
+        })).not.toThrowError();
+    });
+    it('should error if type is not "object"', () => {
+        expect(() => jsonValidationService.validateContentSchema({
+            type: 'string',
+        })).toThrowError();
+    });
+    it('should allow a nested type to be "FormattedText"', () => {
+        expect(() => jsonValidationService.validateContentSchema({
+            type: 'object',
+            properties: {
+                foo: {
+                    type: 'FormattedText',
+                },
+            },
+            required: ['foo'],
+        })).not.toThrowError();
+    });
+    it('should error on unknown keywords', () => {
+        expect(() => jsonValidationService.validateContentSchema({
+            type: 'object',
+            foo: 'bar',
+        })).toThrowError();
+    });
+    it('should allow a nested property to be an array of of objects which have a property of type to be "FormattedText" that is required', () => {
+        expect(() => jsonValidationService.validateContentSchema({
+            type: 'object',
+            properties: {
+                foo: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            bar: {
+                                type: 'FormattedText',
+                            },
+                        },
+                        required: ['bar'],
+                    },
+                },
+            },
+            required: ['foo'],
+        })).not.toThrowError();
+    });
+    it('should error if any nested object does not have a required property', () => {
+        expect(() => jsonValidationService.validateContentSchema({
+            type: 'object',
+            properties: {
+                foo: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            bar: {
+                                type: 'FormattedText',
+                            },
+                        },
+                    },
+                },
+            },
+            required: ['foo'],
+        })).toThrowError();
+    });
+    it('should succeed if required is on every nested object', () => {
+        expect(() => jsonValidationService.validateContentSchema({
+            type: 'object',
+            properties: {
+                foo: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        properties: {
+                            bar: {
+                                type: 'FormattedText',
+                            },
+                        },
+                        required: ['bar'],
+                    },
+                },
+            },
+            required: ['foo'],
+        })).not.toThrowError();
+    });
+});
+//# sourceMappingURL=DxComponentInputSchema.spec.js.map

package/lib/manifest/v1/DxComponentInputSchema.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DxComponentInputSchema.spec.js","sourceRoot":"","sources":["../../../src/manifest/v1/DxComponentInputSchema.spec.ts"],"names":[],"mappings":";;AAAA,uEAAoE;AAEpE,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACtC,IAAI,qBAA4C,CAAC;IACjD,SAAS,CAAC,GAAG,EAAE;QACb,qBAAqB,GAAG,IAAI,6CAAqB,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,CAAC,GAAG,EAAE,CAAC,qBAAqB,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;IACnF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,CAAC,GAAG,EAAE,CACV,qBAAqB,CAAC,qBAAqB,CAAC;YAC1C,UAAU,EAAE;gBACV,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CACH,CAAC,YAAY,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,CAAC,GAAG,EAAE,CACV,qBAAqB,CAAC,qBAAqB,CAAC;YAC1C,QAAQ,EAAE,CAAC,KAAK,CAAC;YACjB,UAAU,EAAE;gBACV,GAAG,EAAE;oBACH,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CACH,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,GAAG,EAAE,CACV,qBAAqB,CAAC,qBAAqB,CAAC;YAC1C,IAAI,EAAE,QAAQ;SACf,CAAC,CACH,CAAC,YAAY,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;QAC1D,MAAM,CAAC,GAAG,EAAE,CACV,qBAAqB,CAAC,qBAAqB,CAAC;YAC1C,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,GAAG,EAAE;oBACH,IAAI,EAAE,eAAe;iBACtB;aACF;YACD,QAAQ,EAAE,CAAC,KAAK,CAAC;SAClB,CAAC,CACH,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,CAAC,GAAG,EAAE,CACV,qBAAqB,CAAC,qBAAqB,CAAC;YAC1C,IAAI,EAAE,QAAQ;YACd,GAAG,EAAE,KAAK;SACX,CAAC,CACH,CAAC,YAAY,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kIAAkI,EAAE,GAAG,EAAE;QAC1I,MAAM,CAAC,GAAG,EAAE,CACV,qBAAqB,CAAC,qBAAqB,CAAC;YAC1C,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,GAAG,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,GAAG,EAAE;gCACH,IAAI,EAAE,eAAe;6BACtB;yBACF;wBACD,QAAQ,EAAE,CAAC,KAAK,CAAC;qBAClB;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,KAAK,CAAC;SAClB,CAAC,CACH,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,GAAG,EAAE;QAC7E,MAAM,CAAC,GAAG,EAAE,CACV,qBAAqB,CAAC,qBAAqB,CAAC;YAC1C,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,GAAG,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,GAAG,EAAE;gCACH,IAAI,EAAE,eAAe;6BACtB;yBACF;qBACF;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,KAAK,CAAC;SAClB,CAAC,CACH,CAAC,YAAY,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,CAAC,GAAG,EAAE,CACV,qBAAqB,CAAC,qBAAqB,CAAC;YAC1C,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,GAAG,EAAE;oBACH,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,GAAG,EAAE;gCACH,IAAI,EAAE,eAAe;6BACtB;yBACF;wBACD,QAAQ,EAAE,CAAC,KAAK,CAAC;qBAClB;iBACF;aACF;YACD,QAAQ,EAAE,CAAC,KAAK,CAAC;SAClB,CAAC,CACH,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/lib/manifest/v1/DxContentMetaSchema.json

@@ -0,0 +1,165 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema",
+    "$id": "DxContentMetaSchema.json",
+    "title": "Core schema meta-schema",
+    "definitions": {
+        "schemaArray": {
+            "type": "array",
+            "minItems": 1,
+            "items": { "$ref": "#" }
+        },
+        "nonNegativeInteger": {
+            "type": "integer",
+            "minimum": 0
+        },
+        "nonNegativeIntegerDefault0": {
+            "allOf": [{ "$ref": "#/definitions/nonNegativeInteger" }, { "default": 0 }]
+        },
+        "simpleTypes": {
+            "enum": ["array", "boolean", "integer", "null", "number", "object", "string", "FormattedText"]
+        },
+        "stringArray": {
+            "type": "array",
+            "items": { "type": "string" },
+            "uniqueItems": true,
+            "default": []
+        }
+    },
+    "type": ["object", "boolean"],
+    "properties": {
+        "$id": {
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "$schema": {
+            "type": "string",
+            "format": "uri"
+        },
+        "$ref": {
+            "type": "string",
+            "format": "uri-reference"
+        },
+        "$comment": {
+            "type": "string"
+        },
+        "title": {
+            "type": "string"
+        },
+        "description": {
+            "type": "string"
+        },
+        "default": true,
+        "readOnly": {
+            "type": "boolean",
+            "default": false
+        },
+        "writeOnly": {
+            "type": "boolean",
+            "default": false
+        },
+        "examples": {
+            "type": "array",
+            "items": true
+        },
+        "multipleOf": {
+            "type": "number",
+            "exclusiveMinimum": 0
+        },
+        "maximum": {
+            "type": "number"
+        },
+        "exclusiveMaximum": {
+            "type": "number"
+        },
+        "minimum": {
+            "type": "number"
+        },
+        "exclusiveMinimum": {
+            "type": "number"
+        },
+        "maxLength": { "$ref": "#/definitions/nonNegativeInteger" },
+        "minLength": { "$ref": "#/definitions/nonNegativeIntegerDefault0" },
+        "pattern": {
+            "type": "string",
+            "format": "regex"
+        },
+        "additionalItems": { "$ref": "#" },
+        "items": {
+            "anyOf": [{ "$ref": "#" }, { "$ref": "#/definitions/schemaArray" }],
+            "default": true
+        },
+        "maxItems": { "$ref": "#/definitions/nonNegativeInteger" },
+        "minItems": { "$ref": "#/definitions/nonNegativeIntegerDefault0" },
+        "uniqueItems": {
+            "type": "boolean",
+            "default": false
+        },
+        "contains": { "$ref": "#" },
+        "maxProperties": { "$ref": "#/definitions/nonNegativeInteger" },
+        "minProperties": { "$ref": "#/definitions/nonNegativeIntegerDefault0" },
+        "required": { "$ref": "#/definitions/stringArray" },
+        "additionalProperties": { "$ref": "#" },
+        "definitions": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "properties": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "default": {}
+        },
+        "patternProperties": {
+            "type": "object",
+            "additionalProperties": { "$ref": "#" },
+            "propertyNames": { "format": "regex" },
+            "default": {}
+        },
+        "dependencies": {
+            "type": "object",
+            "additionalProperties": {
+                "anyOf": [{ "$ref": "#" }, { "$ref": "#/definitions/stringArray" }]
+            }
+        },
+        "propertyNames": { "$ref": "#" },
+        "const": true,
+        "enum": {
+            "type": "array",
+            "items": true,
+            "minItems": 1,
+            "uniqueItems": true
+        },
+        "type": {
+            "anyOf": [
+                { "$ref": "#/definitions/simpleTypes" },
+                {
+                    "type": "array",
+                    "items": { "$ref": "#/definitions/simpleTypes" },
+                    "minItems": 1,
+                    "uniqueItems": true
+                }
+            ]
+        },
+        "format": { "type": "string" },
+        "contentMediaType": { "type": "string" },
+        "contentEncoding": { "type": "string" },
+        "if": { "$ref": "#" },
+        "then": { "$ref": "#" },
+        "else": { "$ref": "#" },
+        "allOf": { "$ref": "#/definitions/schemaArray" },
+        "anyOf": { "$ref": "#/definitions/schemaArray" },
+        "oneOf": { "$ref": "#/definitions/schemaArray" },
+        "not": { "$ref": "#" }
+    },
+    "additionalProperties": false,
+    "dependencies": {
+        "properties": {
+            "properties": {
+                "required": {
+                    "$ref": "#/definitions/stringArray"
+                }
+            },
+            "required": ["required"]
+        }
+    }
+}

package/lib/manifest/v1/__test__/schemas/badFunctionInputComponent.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "../../v1.json",
+    "description": "t",
+    "displayName": "t",
+    "name": "test",
+    "namespace": "other",
+    "mainFunction": "main",
+    "version": "1.0.4",
+    "environment": [],
+    "functions": [
+        {
+            "entry": "main.js",
+            "name": "main",
+            "output": {
+                "responseType": "html"
+            },
+            "input": {
+                "type": "object",
+                "properties": {
+                    "textValue": {
+                        "type": "badInputType"
+                    },
+                    "anotherValue": {
+                        "type": "object",
+                        "properties": {
+                            "xt": {
+                                "type": "FormattedText"
+                            }
+                        },
+                        "additionalProperties": {
+                            "type": "FormattedText"
+                        }
+                    }
+                },
+                "required": []
+            }
+        }
+    ]
+}

package/lib/manifest/v1/__test__/schemas/badNestedFunctionInput.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "../../v1.json",
+    "description": "t",
+    "displayName": "t",
+    "name": "test",
+    "namespace": "other",
+    "mainFunction": "main",
+    "version": "1.0.4",
+    "environment": [],
+    "functions": [
+        {
+            "entry": "main.js",
+            "name": "main",
+            "output": {
+                "responseType": "html"
+            },
+            "input": {
+                "type": "object",
+                "properties": {
+                    "textValue": {
+                        "type": "string"
+                    },
+                    "anotherValue": {
+                        "type": "object",
+                        "properties": {
+                            "xt": {
+                                "type": "astd"
+                            }
+                        },
+                        "additionalProperties": {
+                            "type": "FormattedText"
+                        }
+                    }
+                },
+                "required": []
+            }
+        }
+    ]
+}

package/lib/manifest/v1/__test__/schemas/nonObjectFunctionInputComponent.json

@@ -0,0 +1,39 @@
+{
+    "$schema": "../../v1.json",
+    "description": "t",
+    "displayName": "t",
+    "name": "test",
+    "namespace": "other",
+    "mainFunction": "main",
+    "version": "1.0.4",
+    "environment": [],
+    "functions": [
+        {
+            "entry": "main.js",
+            "name": "main",
+            "output": {
+                "responseType": "html"
+            },
+            "input": {
+                "type": "string",
+                "properties": {
+                    "textValue": {
+                        "type": "FormattedText"
+                    },
+                    "anotherValue": {
+                        "type": "object",
+                        "properties": {
+                            "xt": {
+                                "type": "FormattedText"
+                            }
+                        },
+                        "additionalProperties": {
+                            "type": "FormattedText"
+                        }
+                    }
+                },
+                "required": []
+            }
+        }
+    ]
+}

package/lib/manifest/v1/__test__/schemas/validComponent.json

@@ -0,0 +1,40 @@
+{
+    "$schema": "../../v1.json",
+    "description": "t",
+    "displayName": "t",
+    "name": "test",
+    "namespace": "other",
+    "mainFunction": "main",
+    "version": "1.0.4",
+    "environment": [],
+    "functions": [
+        {
+            "entry": "main.js",
+            "name": "main",
+            "output": {
+                "responseType": "html"
+            },
+            "input": {
+                "type": "object",
+                "properties": {
+                    "textValue": {
+                        "type": "FormattedText"
+                    },
+                    "anotherValue": {
+                        "type": "object",
+                        "properties": {
+                            "xt": {
+                                "type": "FormattedText"
+                            }
+                        },
+                        "required": [],
+                        "additionalProperties": {
+                            "type": "FormattedText"
+                        }
+                    }
+                },
+                "required": []
+            }
+        }
+    ]
+}

package/lib/manifest/v1/manifestModels.d.ts

@@ -0,0 +1 @@
+export * as v1 from './v1';

package/lib/manifest/v1/manifestModels.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v1 = void 0;
+exports.v1 = __importStar(require("./v1"));
+//# sourceMappingURL=manifestModels.js.map

package/lib/manifest/v1/manifestModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifestModels.js","sourceRoot":"","sources":["../../../src/manifest/v1/manifestModels.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA2B"}

package/lib/manifest/v1/manifestSchemas.d.ts

@@ -0,0 +1,2 @@
+import v1 from './v1.json';
+export { v1 };

package/lib/manifest/v1/manifestSchemas.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v1 = void 0;
+const v1_json_1 = __importDefault(require("./v1.json"));
+exports.v1 = v1_json_1.default;
+//# sourceMappingURL=manifestSchemas.js.map

package/lib/manifest/v1/manifestSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifestSchemas.js","sourceRoot":"","sources":["../../../src/manifest/v1/manifestSchemas.ts"],"names":[],"mappings":";;;;;;AAAA,wDAA2B;AAElB,aAFF,iBAAE,CAEE"}

package/lib/manifest/v1/subSchemas.d.ts

@@ -0,0 +1,4 @@
+import DxComponentIcons from './DxComponentIcons.json';
+import DxComponentInputSchema from './DxComponentInputSchema.json';
+import DxContentMetaSchema from './DxContentMetaSchema.json';
+export { DxComponentIcons, DxComponentInputSchema, DxContentMetaSchema };

package/lib/manifest/v1/subSchemas.js

@@ -0,0 +1,13 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DxContentMetaSchema = exports.DxComponentInputSchema = exports.DxComponentIcons = void 0;
+const DxComponentIcons_json_1 = __importDefault(require("./DxComponentIcons.json"));
+exports.DxComponentIcons = DxComponentIcons_json_1.default;
+const DxComponentInputSchema_json_1 = __importDefault(require("./DxComponentInputSchema.json"));
+exports.DxComponentInputSchema = DxComponentInputSchema_json_1.default;
+const DxContentMetaSchema_json_1 = __importDefault(require("./DxContentMetaSchema.json"));
+exports.DxContentMetaSchema = DxContentMetaSchema_json_1.default;
+//# sourceMappingURL=subSchemas.js.map

package/lib/manifest/v1/subSchemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subSchemas.js","sourceRoot":"","sources":["../../../src/manifest/v1/subSchemas.ts"],"names":[],"mappings":";;;;;;AAAA,oFAAuD;AAI9C,2BAJF,+BAAgB,CAIE;AAHzB,gGAAmE;AAGxC,iCAHpB,qCAAsB,CAGoB;AAFjD,0FAA6D;AAEV,8BAF5C,kCAAmB,CAE4C"}