@twin.org/data-core 0.0.2-next.4 → 0.0.3-next.10

package/dist/es/factories/dataTypeHandlerFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@twin.org/core";
+/**
+ * Factory for creating handlers for data types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const DataTypeHandlerFactory = Factory.createFactory("data-type");
+//# sourceMappingURL=dataTypeHandlerFactory.js.map

package/dist/es/factories/dataTypeHandlerFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataTypeHandlerFactory.js","sourceRoot":"","sources":["../../../src/factories/dataTypeHandlerFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAmB,WAAW,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IDataTypeHandler } from \"../models/IDataTypeHandler.js\";\n\n/**\n * Factory for creating handlers for data types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const DataTypeHandlerFactory = Factory.createFactory<IDataTypeHandler>(\"data-type\");\n"]}

package/dist/es/factories/identifierHandlerFactory.js

@@ -0,0 +1,19 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory, Urn } from "@twin.org/core";
+/**
+ * Factory for creating handlers for identifiers.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const IdentifierHandlerFactory = Factory.createFactory("namespace", false, (names, uri) => {
+    Urn.guard("IdentifierHandlerFactory", "uri", uri);
+    const urn = Urn.fromValidString(uri);
+    const urnParts = urn.parts();
+    for (let i = urnParts.length - 1; i >= 0; i--) {
+        const wholeNamespace = urnParts.slice(i).join(":");
+        if (names.includes(wholeNamespace)) {
+            return wholeNamespace;
+        }
+    }
+});
+//# sourceMappingURL=identifierHandlerFactory.js.map

package/dist/es/factories/identifierHandlerFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identifierHandlerFactory.js","sourceRoot":"","sources":["../../../src/factories/identifierHandlerFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAI9C;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,wBAAwB,GAAG,OAAO,CAAC,aAAa,CAC5D,WAAW,EACX,KAAK,EACL,CAAC,KAAe,EAAE,GAAW,EAAE,EAAE;IAChC,GAAG,CAAC,KAAK,oCAAgD,GAAG,CAAC,CAAC;IAE9D,MAAM,GAAG,GAAG,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,EAAE,CAAC;IAE7B,KAAK,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC/C,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnD,IAAI,KAAK,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YACpC,OAAO,cAAc,CAAC;QACvB,CAAC;IACF,CAAC;AACF,CAAC,CACD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory, Urn } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IIdentifierHandler } from \"../models/IIdentifierHandler.js\";\n\n/**\n * Factory for creating handlers for identifiers.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const IdentifierHandlerFactory = Factory.createFactory<IIdentifierHandler>(\n\t\"namespace\",\n\tfalse,\n\t(names: string[], uri: string) => {\n\t\tUrn.guard(nameof(IdentifierHandlerFactory), nameof(uri), uri);\n\n\t\tconst urn = Urn.fromValidString(uri);\n\t\tconst urnParts = urn.parts();\n\n\t\tfor (let i = urnParts.length - 1; i >= 0; i--) {\n\t\t\tconst wholeNamespace = urnParts.slice(i).join(\":\");\n\t\t\tif (names.includes(wholeNamespace)) {\n\t\t\t\treturn wholeNamespace;\n\t\t\t}\n\t\t}\n\t}\n);\n"]}

package/dist/es/index.js

@@ -0,0 +1,13 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/dataTypeHandlerFactory.js";
+export * from "./factories/identifierHandlerFactory.js";
+export * from "./models/IDataTypeHandler.js";
+export * from "./models/IIdentifierHandler.js";
+export * from "./models/IJsonSchema.js";
+export * from "./models/ISchemaValidationError.js";
+export * from "./models/ISchemaValidationResult.js";
+export * from "./models/validationMode.js";
+export * from "./utils/dataTypeHelper.js";
+export * from "./utils/jsonSchemaHelper.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,uCAAuC,CAAC;AACtD,cAAc,yCAAyC,CAAC;AACxD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/dataTypeHandlerFactory.js\";\nexport * from \"./factories/identifierHandlerFactory.js\";\nexport * from \"./models/IDataTypeHandler.js\";\nexport * from \"./models/IIdentifierHandler.js\";\nexport * from \"./models/IJsonSchema.js\";\nexport * from \"./models/ISchemaValidationError.js\";\nexport * from \"./models/ISchemaValidationResult.js\";\nexport * from \"./models/validationMode.js\";\nexport * from \"./utils/dataTypeHelper.js\";\nexport * from \"./utils/jsonSchemaHelper.js\";\n"]}

package/dist/es/models/IDataTypeHandler.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IDataTypeHandler.js.map

package/dist/es/models/IDataTypeHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IDataTypeHandler.js","sourceRoot":"","sources":["../../../src/models/IDataTypeHandler.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IValidationFailure } from \"@twin.org/core\";\nimport type { IJsonSchema } from \"./IJsonSchema.js\";\n\n/**\n * Interface describing a type which can handle a specific data type.\n */\nexport interface IDataTypeHandler {\n\t/**\n\t * The namespace for the type.\n\t */\n\tnamespace: string;\n\n\t/**\n\t * The type for the item.\n\t */\n\ttype: string;\n\n\t/**\n\t * The JSON LD context for the type.\n\t */\n\tjsonLdContext?: string;\n\n\t/**\n\t * The default value for the item to use when constructing a new object.\n\t */\n\tdefaultValue?: unknown;\n\n\t/**\n\t * Get the JSON schema for the data type.\n\t * @returns The JSON schema for the data type.\n\t */\n\tjsonSchema?(): Promise<IJsonSchema | undefined>;\n\n\t/**\n\t * A method for validating the data type.\n\t * @param propertyName The name of the property being validated.\n\t * @param value The value to validate.\n\t * @param failures List of failures to add to.\n\t * @param container The object which contains this one.\n\t * @returns True if the item is valid.\n\t */\n\tvalidate?(\n\t\tpropertyName: string,\n\t\tvalue: unknown,\n\t\tfailures: IValidationFailure[],\n\t\tcontainer?: unknown\n\t): Promise<boolean>;\n}\n"]}

package/dist/es/models/IIdentifierHandler.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IIdentifierHandler.js.map

package/dist/es/models/IIdentifierHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IIdentifierHandler.js","sourceRoot":"","sources":["../../../src/models/IIdentifierHandler.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IValidationFailure } from \"@twin.org/core\";\n\n/**\n * Interface describing a type which can handle a specific urn namespace.\n */\nexport interface IIdentifierHandler {\n\t/**\n\t * The namespace for the identifier.\n\t */\n\tnamespace: string;\n\n\t/**\n\t * A method for validating the identifier.\n\t * @param propertyName The name of the property being validated.\n\t * @param value The value to validate.\n\t * @param failures List of failures to add to.\n\t * @returns True if the item is valid.\n\t */\n\tvalidate(propertyName: string, value: unknown, failures: IValidationFailure[]): boolean;\n}\n"]}

package/dist/es/models/IJsonSchema.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IJsonSchema.js.map

package/dist/es/models/IJsonSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IJsonSchema.js","sourceRoot":"","sources":["../../../src/models/IJsonSchema.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type Ajv from \"ajv/dist/2020.js\";\n\n/**\n * Default schema type.\n */\nexport type IJsonSchema = Ajv.SchemaObject;\n"]}

package/dist/es/models/ISchemaValidationError.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ISchemaValidationError.js.map

package/dist/es/models/ISchemaValidationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISchemaValidationError.js","sourceRoot":"","sources":["../../../src/models/ISchemaValidationError.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ErrorObject } from \"ajv\";\n\n/**\n * Schema validation error.\n */\nexport type ISchemaValidationError = ErrorObject[];\n"]}

package/dist/es/models/ISchemaValidationResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ISchemaValidationResult.js.map

package/dist/es/models/ISchemaValidationResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ISchemaValidationResult.js","sourceRoot":"","sources":["../../../src/models/ISchemaValidationResult.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ISchemaValidationError } from \"./ISchemaValidationError.js\";\n\n/**\n * Validation result.\n */\nexport interface ISchemaValidationResult {\n\t/**\n\t * The result.\n\t */\n\tresult: boolean;\n\n\t/**\n\t * The error.\n\t */\n\terror?: ISchemaValidationError;\n}\n"]}

package/dist/es/models/validationMode.js

@@ -0,0 +1,25 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Validation modes for validating data types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const ValidationMode = {
+    /**
+     * Use the validation method of the data type.
+     */
+    Validate: "validate",
+    /**
+     * Use the JSON Schema methods of the data type.
+     */
+    JsonSchema: "json-schema",
+    /**
+     * Use either validation mode.
+     */
+    Either: "either",
+    /**
+     * Use both validation modes.
+     */
+    Both: "both"
+};
+//# sourceMappingURL=validationMode.js.map

package/dist/es/models/validationMode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validationMode.js","sourceRoot":"","sources":["../../../src/models/validationMode.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B;;OAEG;IACH,QAAQ,EAAE,UAAU;IAEpB;;OAEG;IACH,UAAU,EAAE,aAAa;IAEzB;;OAEG;IACH,MAAM,EAAE,QAAQ;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM;CACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Validation modes for validating data types.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const ValidationMode = {\n\t/**\n\t * Use the validation method of the data type.\n\t */\n\tValidate: \"validate\",\n\n\t/**\n\t * Use the JSON Schema methods of the data type.\n\t */\n\tJsonSchema: \"json-schema\",\n\n\t/**\n\t * Use either validation mode.\n\t */\n\tEither: \"either\",\n\n\t/**\n\t * Use both validation modes.\n\t */\n\tBoth: \"both\"\n} as const;\n\n/**\n * Validation modes for validating data types.\n */\nexport type ValidationMode = (typeof ValidationMode)[keyof typeof ValidationMode];\n"]}

package/dist/es/utils/dataTypeHelper.js

@@ -0,0 +1,115 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is } from "@twin.org/core";
+import { JsonSchemaHelper } from "./jsonSchemaHelper.js";
+import { DataTypeHandlerFactory } from "../factories/dataTypeHandlerFactory.js";
+import { ValidationMode } from "../models/validationMode.js";
+/**
+ * Class to help with data types.
+ */
+export class DataTypeHelper {
+    /**
+     * Register a data type.
+     * @param namespace The namespace for the type.
+     * @param type The type for the item.
+     * @param jsonLdContext The JSON LD context for the type.
+     * @param schema The JSON schema for the type.
+     */
+    static registerType(namespace, type, jsonLdContext, schema) {
+        DataTypeHandlerFactory.register(`${namespace}${type}`, () => ({
+            namespace,
+            jsonLdContext,
+            type,
+            jsonSchema: async () => schema
+        }));
+    }
+    /**
+     * Register a  list of types.
+     * @param namespace The namespace for the types.
+     * @param jsonLdContext The JSON LD context for the types.
+     * @param typeDefinition The type definitions to register.
+     */
+    static registerTypes(namespace, jsonLdContext, typeDefinition) {
+        for (const typeDef of typeDefinition) {
+            DataTypeHelper.registerType(namespace, typeDef.type, jsonLdContext, typeDef.schema);
+        }
+    }
+    /**
+     * Get the JSON schema for a data type.
+     * @param dataType The data type to get the schema for.
+     * @returns The JSON schema for the data type or undefined if not found.
+     */
+    static async getSchemaForType(dataType) {
+        const handler = DataTypeHandlerFactory.getIfExists(dataType);
+        return handler?.jsonSchema ? handler.jsonSchema() : undefined;
+    }
+    /**
+     * Validate a data type.
+     * @param propertyName The name of the property being validated to use in error messages.
+     * @param dataType The data type to validate.
+     * @param data The data to validate.
+     * @param validationFailures The list of validation failures to add to.
+     * @param options Optional options for validation.
+     * @param options.failOnMissingType If true, will fail validation if the data type is missing, defaults to false.
+     * @param options.validationMode The validation mode to use, defaults to either.
+     * @returns True if the data was valid.
+     */
+    static async validate(propertyName, dataType, data, validationFailures, options) {
+        let isValid = true;
+        if (Is.stringValue(dataType)) {
+            const handler = DataTypeHandlerFactory.getIfExists(dataType);
+            if (handler) {
+                const validationMode = options?.validationMode ?? ValidationMode.Either;
+                // If we have a validate function use that as it is more specific
+                // and will produce better error messages
+                let hasValidated = false;
+                const validateMethod = handler.validate?.bind(handler);
+                if ((validationMode === ValidationMode.Validate ||
+                    validationMode === ValidationMode.Both ||
+                    validationMode === ValidationMode.Either) &&
+                    Is.function(validateMethod)) {
+                    isValid = await validateMethod(propertyName, data, validationFailures);
+                    hasValidated = true;
+                }
+                const jsonSchemaMethod = handler.jsonSchema?.bind(handler);
+                if ((validationMode === ValidationMode.JsonSchema ||
+                    (validationMode === ValidationMode.Either && !hasValidated) ||
+                    validationMode === ValidationMode.Both) &&
+                    Is.function(jsonSchemaMethod)) {
+                    // Otherwise use the JSON schema if there is one
+                    const schema = await jsonSchemaMethod();
+                    if (Is.object(schema)) {
+                        const validationResult = await JsonSchemaHelper.validate(schema, data);
+                        if (Is.arrayValue(validationResult.error)) {
+                            validationFailures.push({
+                                property: propertyName,
+                                reason: "validation.schema.failedValidation",
+                                properties: {
+                                    value: data,
+                                    schemaErrors: validationResult.error,
+                                    message: validationResult.error.map(e => e.message).join("\n")
+                                }
+                            });
+                        }
+                        if (!validationResult.result) {
+                            isValid = false;
+                        }
+                    }
+                }
+            }
+            else if (options?.failOnMissingType ?? false) {
+                // If we don't have a handler for a specific type and we are failing on missing type
+                validationFailures.push({
+                    property: propertyName,
+                    reason: "validation.schema.missingType",
+                    properties: {
+                        dataType
+                    }
+                });
+                isValid = false;
+            }
+        }
+        return isValid;
+    }
+}
+//# sourceMappingURL=dataTypeHelper.js.map

package/dist/es/utils/dataTypeHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataTypeHelper.js","sourceRoot":"","sources":["../../../src/utils/dataTypeHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAA2B,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAEhF,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D;;GAEG;AACH,MAAM,OAAO,cAAc;IAC1B;;;;;;OAMG;IACI,MAAM,CAAC,YAAY,CACzB,SAAiB,EACjB,IAAY,EACZ,aAAiC,EACjC,MAA0C;QAE1C,sBAAsB,CAAC,QAAQ,CAAC,GAAG,SAAS,GAAG,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;YAC7D,SAAS;YACT,aAAa;YACb,IAAI;YACJ,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,MAAM;SAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAC1B,SAAiB,EACjB,aAAiC,EACjC,cAGG;QAEH,KAAK,MAAM,OAAO,IAAI,cAAc,EAAE,CAAC;YACtC,cAAc,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;QACrF,CAAC;IACF,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,QAAgB;QACpD,MAAM,OAAO,GAAG,sBAAsB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QAC7D,OAAO,OAAO,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAC3B,YAAoB,EACpB,QAA4B,EAC5B,IAAa,EACb,kBAAwC,EACxC,OAGC;QAED,IAAI,OAAO,GAAG,IAAI,CAAC;QAEnB,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,sBAAsB,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;YAE7D,IAAI,OAAO,EAAE,CAAC;gBACb,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,IAAI,cAAc,CAAC,MAAM,CAAC;gBAExE,iEAAiE;gBACjE,yCAAyC;gBACzC,IAAI,YAAY,GAAG,KAAK,CAAC;gBACzB,MAAM,cAAc,GAAG,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBACvD,IACC,CAAC,cAAc,KAAK,cAAc,CAAC,QAAQ;oBAC1C,cAAc,KAAK,cAAc,CAAC,IAAI;oBACtC,cAAc,KAAK,cAAc,CAAC,MAAM,CAAC;oBAC1C,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,EAC1B,CAAC;oBACF,OAAO,GAAG,MAAM,cAAc,CAAC,YAAY,EAAE,IAAI,EAAE,kBAAkB,CAAC,CAAC;oBACvE,YAAY,GAAG,IAAI,CAAC;gBACrB,CAAC;gBAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC3D,IACC,CAAC,cAAc,KAAK,cAAc,CAAC,UAAU;oBAC5C,CAAC,cAAc,KAAK,cAAc,CAAC,MAAM,IAAI,CAAC,YAAY,CAAC;oBAC3D,cAAc,KAAK,cAAc,CAAC,IAAI,CAAC;oBACxC,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAC5B,CAAC;oBACF,gDAAgD;oBAChD,MAAM,MAAM,GAAG,MAAM,gBAAgB,EAAE,CAAC;oBAExC,IAAI,EAAE,CAAC,MAAM,CAAc,MAAM,CAAC,EAAE,CAAC;wBACpC,MAAM,gBAAgB,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;wBACvE,IAAI,EAAE,CAAC,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;4BAC3C,kBAAkB,CAAC,IAAI,CAAC;gCACvB,QAAQ,EAAE,YAAY;gCACtB,MAAM,EAAE,oCAAoC;gCAC5C,UAAU,EAAE;oCACX,KAAK,EAAE,IAAI;oCACX,YAAY,EAAE,gBAAgB,CAAC,KAAK;oCACpC,OAAO,EAAE,gBAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;iCAC9D;6BACD,CAAC,CAAC;wBACJ,CAAC;wBACD,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC;4BAC9B,OAAO,GAAG,KAAK,CAAC;wBACjB,CAAC;oBACF,CAAC;gBACF,CAAC;YACF,CAAC;iBAAM,IAAI,OAAO,EAAE,iBAAiB,IAAI,KAAK,EAAE,CAAC;gBAChD,oFAAoF;gBACpF,kBAAkB,CAAC,IAAI,CAAC;oBACvB,QAAQ,EAAE,YAAY;oBACtB,MAAM,EAAE,+BAA+B;oBACvC,UAAU,EAAE;wBACX,QAAQ;qBACR;iBACD,CAAC,CAAC;gBACH,OAAO,GAAG,KAAK,CAAC;YACjB,CAAC;QACF,CAAC;QAED,OAAO,OAAO,CAAC;IAChB,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is, type IValidationFailure } from \"@twin.org/core\";\nimport { JsonSchemaHelper } from \"./jsonSchemaHelper.js\";\nimport { DataTypeHandlerFactory } from \"../factories/dataTypeHandlerFactory.js\";\nimport type { IJsonSchema } from \"../models/IJsonSchema.js\";\nimport { ValidationMode } from \"../models/validationMode.js\";\n\n/**\n * Class to help with data types.\n */\nexport class DataTypeHelper {\n\t/**\n\t * Register a data type.\n\t * @param namespace The namespace for the type.\n\t * @param type The type for the item.\n\t * @param jsonLdContext The JSON LD context for the type.\n\t * @param schema The JSON schema for the type.\n\t */\n\tpublic static registerType(\n\t\tnamespace: string,\n\t\ttype: string,\n\t\tjsonLdContext: string | undefined,\n\t\tschema: IJsonSchema | Promise<IJsonSchema>\n\t): void {\n\t\tDataTypeHandlerFactory.register(`${namespace}${type}`, () => ({\n\t\t\tnamespace,\n\t\t\tjsonLdContext,\n\t\t\ttype,\n\t\t\tjsonSchema: async () => schema\n\t\t}));\n\t}\n\n\t/**\n\t * Register a  list of types.\n\t * @param namespace The namespace for the types.\n\t * @param jsonLdContext The JSON LD context for the types.\n\t * @param typeDefinition The type definitions to register.\n\t */\n\tpublic static registerTypes(\n\t\tnamespace: string,\n\t\tjsonLdContext: string | undefined,\n\t\ttypeDefinition: {\n\t\t\ttype: string;\n\t\t\tschema: IJsonSchema | Promise<IJsonSchema>;\n\t\t}[]\n\t): void {\n\t\tfor (const typeDef of typeDefinition) {\n\t\t\tDataTypeHelper.registerType(namespace, typeDef.type, jsonLdContext, typeDef.schema);\n\t\t}\n\t}\n\n\t/**\n\t * Get the JSON schema for a data type.\n\t * @param dataType The data type to get the schema for.\n\t * @returns The JSON schema for the data type or undefined if not found.\n\t */\n\tpublic static async getSchemaForType(dataType: string): Promise<IJsonSchema | undefined> {\n\t\tconst handler = DataTypeHandlerFactory.getIfExists(dataType);\n\t\treturn handler?.jsonSchema ? handler.jsonSchema() : undefined;\n\t}\n\n\t/**\n\t * Validate a data type.\n\t * @param propertyName The name of the property being validated to use in error messages.\n\t * @param dataType The data type to validate.\n\t * @param data The data to validate.\n\t * @param validationFailures The list of validation failures to add to.\n\t * @param options Optional options for validation.\n\t * @param options.failOnMissingType If true, will fail validation if the data type is missing, defaults to false.\n\t * @param options.validationMode The validation mode to use, defaults to either.\n\t * @returns True if the data was valid.\n\t */\n\tpublic static async validate(\n\t\tpropertyName: string,\n\t\tdataType: string | undefined,\n\t\tdata: unknown,\n\t\tvalidationFailures: IValidationFailure[],\n\t\toptions?: {\n\t\t\tvalidationMode?: ValidationMode;\n\t\t\tfailOnMissingType?: boolean;\n\t\t}\n\t): Promise<boolean> {\n\t\tlet isValid = true;\n\n\t\tif (Is.stringValue(dataType)) {\n\t\t\tconst handler = DataTypeHandlerFactory.getIfExists(dataType);\n\n\t\t\tif (handler) {\n\t\t\t\tconst validationMode = options?.validationMode ?? ValidationMode.Either;\n\n\t\t\t\t// If we have a validate function use that as it is more specific\n\t\t\t\t// and will produce better error messages\n\t\t\t\tlet hasValidated = false;\n\t\t\t\tconst validateMethod = handler.validate?.bind(handler);\n\t\t\t\tif (\n\t\t\t\t\t(validationMode === ValidationMode.Validate ||\n\t\t\t\t\t\tvalidationMode === ValidationMode.Both ||\n\t\t\t\t\t\tvalidationMode === ValidationMode.Either) &&\n\t\t\t\t\tIs.function(validateMethod)\n\t\t\t\t) {\n\t\t\t\t\tisValid = await validateMethod(propertyName, data, validationFailures);\n\t\t\t\t\thasValidated = true;\n\t\t\t\t}\n\n\t\t\t\tconst jsonSchemaMethod = handler.jsonSchema?.bind(handler);\n\t\t\t\tif (\n\t\t\t\t\t(validationMode === ValidationMode.JsonSchema ||\n\t\t\t\t\t\t(validationMode === ValidationMode.Either && !hasValidated) ||\n\t\t\t\t\t\tvalidationMode === ValidationMode.Both) &&\n\t\t\t\t\tIs.function(jsonSchemaMethod)\n\t\t\t\t) {\n\t\t\t\t\t// Otherwise use the JSON schema if there is one\n\t\t\t\t\tconst schema = await jsonSchemaMethod();\n\n\t\t\t\t\tif (Is.object<IJsonSchema>(schema)) {\n\t\t\t\t\t\tconst validationResult = await JsonSchemaHelper.validate(schema, data);\n\t\t\t\t\t\tif (Is.arrayValue(validationResult.error)) {\n\t\t\t\t\t\t\tvalidationFailures.push({\n\t\t\t\t\t\t\t\tproperty: propertyName,\n\t\t\t\t\t\t\t\treason: \"validation.schema.failedValidation\",\n\t\t\t\t\t\t\t\tproperties: {\n\t\t\t\t\t\t\t\t\tvalue: data,\n\t\t\t\t\t\t\t\t\tschemaErrors: validationResult.error,\n\t\t\t\t\t\t\t\t\tmessage: validationResult.error.map(e => e.message).join(\"\\n\")\n\t\t\t\t\t\t\t\t}\n\t\t\t\t\t\t\t});\n\t\t\t\t\t\t}\n\t\t\t\t\t\tif (!validationResult.result) {\n\t\t\t\t\t\t\tisValid = false;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t} else if (options?.failOnMissingType ?? false) {\n\t\t\t\t// If we don't have a handler for a specific type and we are failing on missing type\n\t\t\t\tvalidationFailures.push({\n\t\t\t\t\tproperty: propertyName,\n\t\t\t\t\treason: \"validation.schema.missingType\",\n\t\t\t\t\tproperties: {\n\t\t\t\t\t\tdataType\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t\tisValid = false;\n\t\t\t}\n\t\t}\n\n\t\treturn isValid;\n\t}\n}\n"]}

package/dist/es/utils/jsonSchemaHelper.js

@@ -0,0 +1,161 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Is, StringHelper } from "@twin.org/core";
+import { FetchHelper, HttpMethod } from "@twin.org/web";
+import Ajv2019 from "ajv/dist/2019.js";
+import Ajv2020 from "ajv/dist/2020.js";
+import formatsPlugin from "ajv-formats";
+import { DataTypeHandlerFactory } from "../factories/dataTypeHandlerFactory.js";
+/**
+ * A helper for JSON schemas.
+ */
+export class JsonSchemaHelper {
+    /**
+     * The schema version 2020 (default).
+     */
+    static SCHEMA_VERSION = "https://json-schema.org/draft/2020-12/schema";
+    /**
+     * The schema version 2019.
+     */
+    static SCHEMA_VERSION_2019 = "https://json-schema.org/draft/2019-09/schema";
+    /**
+     * The class name.
+     * @internal
+     */
+    static CLASS_NAME = "JsonSchemaHelper";
+    /**
+     * Validates data against the schema.
+     * @param schema The schema to validate the data with.
+     * @param data The data to be validated.
+     * @param additionalTypes Additional types to add for reference, not already in DataTypeHandlerFactory.
+     * @returns Result containing errors if there are any.
+     */
+    static async validate(schema, data, additionalTypes) {
+        const params = {
+            allowUnionTypes: true,
+            // Disable strict tuples as it causes issues with the schema validation when
+            // you have an array with fixed elements e.g. myType: [string, ...string[]]
+            // https://github.com/ajv-validator/ajv/issues/1417
+            strictTuples: false,
+            loadSchema: async (uri) => {
+                const subTypeHandler = DataTypeHandlerFactory.getIfExists(uri);
+                const jsonSchemaMethod = subTypeHandler?.jsonSchema?.bind(subTypeHandler);
+                if (Is.function(jsonSchemaMethod)) {
+                    const subSchema = await jsonSchemaMethod();
+                    if (Is.object(subSchema)) {
+                        return subSchema;
+                    }
+                }
+                try {
+                    // We don't have the type in our local data types, so we try to fetch it from the web
+                    const result = await FetchHelper.fetchJson(JsonSchemaHelper.CLASS_NAME, uri, HttpMethod.GET, undefined, {
+                        // Cache for an hour
+                        cacheTtlMs: 3600000
+                    });
+                    return result;
+                }
+                catch {
+                    // Failed to load remotely so return an empty object
+                    // so the schema validation doesn't completely fail
+                    return {};
+                }
+            }
+        };
+        let ajv = new Ajv2020.Ajv2020(params);
+        if (schema.$schema === JsonSchemaHelper.SCHEMA_VERSION_2019) {
+            ajv = new Ajv2019.Ajv2019({ strict: false, ...params });
+        }
+        formatsPlugin.default(ajv);
+        // Add the additional types provided by the user
+        if (Is.objectValue(additionalTypes)) {
+            for (const key in additionalTypes) {
+                ajv.addSchema(additionalTypes[key], key);
+            }
+        }
+        const compiled = await ajv.compileAsync(schema);
+        const result = compiled(data);
+        const output = {
+            result
+        };
+        if (!output.result) {
+            output.error = compiled.errors;
+        }
+        return output;
+    }
+    /**
+     * Get the property type from a schema.
+     * @param schema The schema to extract the types from.
+     * @param propertyName The name of the property to get the type for.
+     * @returns The types of the property.
+     */
+    static getPropertyType(schema, propertyName) {
+        if (schema.type === "object" && Is.objectValue(schema.properties)) {
+            const propertySchema = schema.properties[propertyName];
+            if (Is.object(propertySchema)) {
+                if (Is.stringValue(propertySchema.$ref)) {
+                    return propertySchema.$ref;
+                }
+                return propertySchema.type;
+            }
+        }
+    }
+    /**
+     * Convert an entity schema to JSON schema e.g https://example.com/schemas/.
+     * @param entitySchema The entity schema to convert.
+     * @param baseDomain The base domain for local schemas e.g. https://example.com/
+     * @returns The JSON schema for the entity.
+     */
+    static entitySchemaToJsonSchema(entitySchema, baseDomain) {
+        let domain = StringHelper.trimTrailingSlashes(baseDomain ?? "");
+        if (domain.length > 0) {
+            domain += "/";
+        }
+        const properties = {};
+        const required = [];
+        if (Is.arrayValue(entitySchema?.properties)) {
+            for (const propertySchema of entitySchema.properties) {
+                const jsonPropertySchema = {
+                    type: propertySchema.type,
+                    description: propertySchema.description,
+                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                    examples: propertySchema.examples
+                };
+                if (Is.stringValue(propertySchema.itemType) && propertySchema.type === "array") {
+                    if (propertySchema.itemType === "object") {
+                        jsonPropertySchema.items = {
+                            $ref: propertySchema.itemTypeRef?.startsWith("http")
+                                ? propertySchema.itemTypeRef
+                                : `${domain}${propertySchema.itemTypeRef}`
+                        };
+                    }
+                    else {
+                        jsonPropertySchema.items = {
+                            type: propertySchema.itemType
+                        };
+                    }
+                }
+                else if (propertySchema.type === "object") {
+                    delete jsonPropertySchema.type;
+                    jsonPropertySchema.$ref = propertySchema.itemTypeRef?.startsWith("http")
+                        ? propertySchema.itemTypeRef
+                        : `${domain}${propertySchema.itemTypeRef}`;
+                }
+                properties[propertySchema.property] = jsonPropertySchema;
+                if (!propertySchema.optional) {
+                    required.push(propertySchema.property);
+                }
+            }
+        }
+        return {
+            $schema: JsonSchemaHelper.SCHEMA_VERSION,
+            $id: `${domain}${entitySchema?.type}`,
+            title: entitySchema?.type,
+            type: entitySchema ? "object" : "null",
+            description: entitySchema?.options?.description,
+            required,
+            properties,
+            additionalProperties: false
+        };
+    }
+}
+//# sourceMappingURL=jsonSchemaHelper.js.map

package/dist/es/utils/jsonSchemaHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonSchemaHelper.js","sourceRoot":"","sources":["../../../src/utils/jsonSchemaHelper.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAGlD,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AACxD,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,OAAO,MAAM,kBAAkB,CAAC;AACvC,OAAO,aAAa,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAKhF;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC5B;;OAEG;IACI,MAAM,CAAU,cAAc,GAAG,8CAA8C,CAAC;IAEvF;;OAEG;IACI,MAAM,CAAU,mBAAmB,GAAG,8CAA8C,CAAC;IAE5F;;;OAGG;IACI,MAAM,CAAU,UAAU,sBAA8B;IAE/D;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAC3B,MAAmB,EACnB,IAAO,EACP,eAA+C;QAE/C,MAAM,MAAM,GAAG;YACd,eAAe,EAAE,IAAI;YACrB,4EAA4E;YAC5E,2EAA2E;YAC3E,mDAAmD;YACnD,YAAY,EAAE,KAAK;YACnB,UAAU,EAAE,KAAK,EAAE,GAAW,EAAE,EAAE;gBACjC,MAAM,cAAc,GAAG,sBAAsB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC/D,MAAM,gBAAgB,GAAG,cAAc,EAAE,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;gBAC1E,IAAI,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACnC,MAAM,SAAS,GAAG,MAAM,gBAAgB,EAAE,CAAC;oBAC3C,IAAI,EAAE,CAAC,MAAM,CAAc,SAAS,CAAC,EAAE,CAAC;wBACvC,OAAO,SAAS,CAAC;oBAClB,CAAC;gBACF,CAAC;gBAED,IAAI,CAAC;oBACJ,qFAAqF;oBACrF,MAAM,MAAM,GAAG,MAAM,WAAW,CAAC,SAAS,CACzC,gBAAgB,CAAC,UAAU,EAC3B,GAAG,EACH,UAAU,CAAC,GAAG,EACd,SAAS,EACT;wBACC,oBAAoB;wBACpB,UAAU,EAAE,OAAO;qBACnB,CACD,CAAC;oBACF,OAAO,MAAM,CAAC;gBACf,CAAC;gBAAC,MAAM,CAAC;oBACR,oDAAoD;oBACpD,mDAAmD;oBACnD,OAAO,EAAE,CAAC;gBACX,CAAC;YACF,CAAC;SACD,CAAC;QAEF,IAAI,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtC,IAAI,MAAM,CAAC,OAAO,KAAK,gBAAgB,CAAC,mBAAmB,EAAE,CAAC;YAC7D,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;QACzD,CAAC;QAED,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAE3B,gDAAgD;QAChD,IAAI,EAAE,CAAC,WAAW,CAAC,eAAe,CAAC,EAAE,CAAC;YACrC,KAAK,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;gBACnC,GAAG,CAAC,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE9B,MAAM,MAAM,GAA4B;YACvC,MAAM;SACN,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,CAAC,KAAK,GAAG,QAAQ,CAAC,MAAgC,CAAC;QAC1D,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,MAAmB,EAAE,YAAoB;QACtE,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,EAAE,CAAC,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;YACnE,MAAM,cAAc,GAAG,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;YACvD,IAAI,EAAE,CAAC,MAAM,CAAc,cAAc,CAAC,EAAE,CAAC;gBAC5C,IAAI,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC;oBACzC,OAAO,cAAc,CAAC,IAAI,CAAC;gBAC5B,CAAC;gBACD,OAAO,cAAc,CAAC,IAAc,CAAC;YACtC,CAAC;QACF,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,wBAAwB,CACrC,YAAuC,EACvC,UAAmB;QAEnB,IAAI,MAAM,GAAG,YAAY,CAAC,mBAAmB,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;QAChE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,GAAG,CAAC;QACf,CAAC;QAED,MAAM,UAAU,GAEZ,EAAE,CAAC;QAEP,MAAM,QAAQ,GAAa,EAAE,CAAC;QAE9B,IAAI,EAAE,CAAC,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,EAAE,CAAC;YAC7C,KAAK,MAAM,cAAc,IAAI,YAAY,CAAC,UAAU,EAAE,CAAC;gBACtD,MAAM,kBAAkB,GAAgB;oBACvC,IAAI,EAAE,cAAc,CAAC,IAAI;oBACzB,WAAW,EAAE,cAAc,CAAC,WAAW;oBACvC,8DAA8D;oBAC9D,QAAQ,EAAE,cAAc,CAAC,QAA0B;iBACnD,CAAC;gBAEF,IAAI,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,QAAQ,CAAC,IAAI,cAAc,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAChF,IAAI,cAAc,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;wBAC1C,kBAAkB,CAAC,KAAK,GAAG;4BAC1B,IAAI,EAAE,cAAc,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC;gCACnD,CAAC,CAAC,cAAc,CAAC,WAAW;gCAC5B,CAAC,CAAC,GAAG,MAAM,GAAG,cAAc,CAAC,WAAW,EAAE;yBAC3C,CAAC;oBACH,CAAC;yBAAM,CAAC;wBACP,kBAAkB,CAAC,KAAK,GAAG;4BAC1B,IAAI,EAAE,cAAc,CAAC,QAAQ;yBAC7B,CAAC;oBACH,CAAC;gBACF,CAAC;qBAAM,IAAI,cAAc,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC7C,OAAO,kBAAkB,CAAC,IAAI,CAAC;oBAC/B,kBAAkB,CAAC,IAAI,GAAG,cAAc,CAAC,WAAW,EAAE,UAAU,CAAC,MAAM,CAAC;wBACvE,CAAC,CAAC,cAAc,CAAC,WAAW;wBAC5B,CAAC,CAAC,GAAG,MAAM,GAAG,cAAc,CAAC,WAAW,EAAE,CAAC;gBAC7C,CAAC;gBAED,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAC;gBAEzD,IAAI,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC;oBAC9B,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;gBACxC,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO;YACN,OAAO,EAAE,gBAAgB,CAAC,cAAc;YACxC,GAAG,EAAE,GAAG,MAAM,GAAG,YAAY,EAAE,IAAI,EAAE;YACrC,KAAK,EAAE,YAAY,EAAE,IAAI;YACzB,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM;YACtC,WAAW,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW;YAC/C,QAAQ;YACR,UAAU;YACV,oBAAoB,EAAE,KAAK;SAC3B,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Is, StringHelper } from \"@twin.org/core\";\nimport type { IEntitySchema } from \"@twin.org/entity\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { FetchHelper, HttpMethod } from \"@twin.org/web\";\nimport Ajv2019 from \"ajv/dist/2019.js\";\nimport Ajv2020 from \"ajv/dist/2020.js\";\nimport formatsPlugin from \"ajv-formats\";\nimport { DataTypeHandlerFactory } from \"../factories/dataTypeHandlerFactory.js\";\nimport type { IJsonSchema } from \"../models/IJsonSchema.js\";\nimport type { ISchemaValidationError } from \"../models/ISchemaValidationError.js\";\nimport type { ISchemaValidationResult } from \"../models/ISchemaValidationResult.js\";\n\n/**\n * A helper for JSON schemas.\n */\nexport class JsonSchemaHelper {\n\t/**\n\t * The schema version 2020 (default).\n\t */\n\tpublic static readonly SCHEMA_VERSION = \"https://json-schema.org/draft/2020-12/schema\";\n\n\t/**\n\t * The schema version 2019.\n\t */\n\tpublic static readonly SCHEMA_VERSION_2019 = \"https://json-schema.org/draft/2019-09/schema\";\n\n\t/**\n\t * The class name.\n\t * @internal\n\t */\n\tpublic static readonly CLASS_NAME = nameof<JsonSchemaHelper>();\n\n\t/**\n\t * Validates data against the schema.\n\t * @param schema The schema to validate the data with.\n\t * @param data The data to be validated.\n\t * @param additionalTypes Additional types to add for reference, not already in DataTypeHandlerFactory.\n\t * @returns Result containing errors if there are any.\n\t */\n\tpublic static async validate<T = unknown>(\n\t\tschema: IJsonSchema,\n\t\tdata: T,\n\t\tadditionalTypes?: { [id: string]: IJsonSchema }\n\t): Promise<ISchemaValidationResult> {\n\t\tconst params = {\n\t\t\tallowUnionTypes: true,\n\t\t\t// Disable strict tuples as it causes issues with the schema validation when\n\t\t\t// you have an array with fixed elements e.g. myType: [string, ...string[]]\n\t\t\t// https://github.com/ajv-validator/ajv/issues/1417\n\t\t\tstrictTuples: false,\n\t\t\tloadSchema: async (uri: string) => {\n\t\t\t\tconst subTypeHandler = DataTypeHandlerFactory.getIfExists(uri);\n\t\t\t\tconst jsonSchemaMethod = subTypeHandler?.jsonSchema?.bind(subTypeHandler);\n\t\t\t\tif (Is.function(jsonSchemaMethod)) {\n\t\t\t\t\tconst subSchema = await jsonSchemaMethod();\n\t\t\t\t\tif (Is.object<IJsonSchema>(subSchema)) {\n\t\t\t\t\t\treturn subSchema;\n\t\t\t\t\t}\n\t\t\t\t}\n\n\t\t\t\ttry {\n\t\t\t\t\t// We don't have the type in our local data types, so we try to fetch it from the web\n\t\t\t\t\tconst result = await FetchHelper.fetchJson<never, IJsonSchema>(\n\t\t\t\t\t\tJsonSchemaHelper.CLASS_NAME,\n\t\t\t\t\t\turi,\n\t\t\t\t\t\tHttpMethod.GET,\n\t\t\t\t\t\tundefined,\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t// Cache for an hour\n\t\t\t\t\t\t\tcacheTtlMs: 3600000\n\t\t\t\t\t\t}\n\t\t\t\t\t);\n\t\t\t\t\treturn result;\n\t\t\t\t} catch {\n\t\t\t\t\t// Failed to load remotely so return an empty object\n\t\t\t\t\t// so the schema validation doesn't completely fail\n\t\t\t\t\treturn {};\n\t\t\t\t}\n\t\t\t}\n\t\t};\n\n\t\tlet ajv = new Ajv2020.Ajv2020(params);\n\t\tif (schema.$schema === JsonSchemaHelper.SCHEMA_VERSION_2019) {\n\t\t\tajv = new Ajv2019.Ajv2019({ strict: false, ...params });\n\t\t}\n\n\t\tformatsPlugin.default(ajv);\n\n\t\t// Add the additional types provided by the user\n\t\tif (Is.objectValue(additionalTypes)) {\n\t\t\tfor (const key in additionalTypes) {\n\t\t\t\tajv.addSchema(additionalTypes[key], key);\n\t\t\t}\n\t\t}\n\n\t\tconst compiled = await ajv.compileAsync(schema);\n\t\tconst result = compiled(data);\n\n\t\tconst output: ISchemaValidationResult = {\n\t\t\tresult\n\t\t};\n\n\t\tif (!output.result) {\n\t\t\toutput.error = compiled.errors as ISchemaValidationError;\n\t\t}\n\n\t\treturn output;\n\t}\n\n\t/**\n\t * Get the property type from a schema.\n\t * @param schema The schema to extract the types from.\n\t * @param propertyName The name of the property to get the type for.\n\t * @returns The types of the property.\n\t */\n\tpublic static getPropertyType(schema: IJsonSchema, propertyName: string): string | undefined {\n\t\tif (schema.type === \"object\" && Is.objectValue(schema.properties)) {\n\t\t\tconst propertySchema = schema.properties[propertyName];\n\t\t\tif (Is.object<IJsonSchema>(propertySchema)) {\n\t\t\t\tif (Is.stringValue(propertySchema.$ref)) {\n\t\t\t\t\treturn propertySchema.$ref;\n\t\t\t\t}\n\t\t\t\treturn propertySchema.type as string;\n\t\t\t}\n\t\t}\n\t}\n\n\t/**\n\t * Convert an entity schema to JSON schema e.g https://example.com/schemas/.\n\t * @param entitySchema The entity schema to convert.\n\t * @param baseDomain The base domain for local schemas e.g. https://example.com/\n\t * @returns The JSON schema for the entity.\n\t */\n\tpublic static entitySchemaToJsonSchema(\n\t\tentitySchema: IEntitySchema | undefined,\n\t\tbaseDomain?: string\n\t): IJsonSchema {\n\t\tlet domain = StringHelper.trimTrailingSlashes(baseDomain ?? \"\");\n\t\tif (domain.length > 0) {\n\t\t\tdomain += \"/\";\n\t\t}\n\n\t\tconst properties: {\n\t\t\t[key: string]: IJsonSchema;\n\t\t} = {};\n\n\t\tconst required: string[] = [];\n\n\t\tif (Is.arrayValue(entitySchema?.properties)) {\n\t\t\tfor (const propertySchema of entitySchema.properties) {\n\t\t\t\tconst jsonPropertySchema: IJsonSchema = {\n\t\t\t\t\ttype: propertySchema.type,\n\t\t\t\t\tdescription: propertySchema.description,\n\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t\t\t\t\texamples: propertySchema.examples as unknown as any\n\t\t\t\t};\n\n\t\t\t\tif (Is.stringValue(propertySchema.itemType) && propertySchema.type === \"array\") {\n\t\t\t\t\tif (propertySchema.itemType === \"object\") {\n\t\t\t\t\t\tjsonPropertySchema.items = {\n\t\t\t\t\t\t\t$ref: propertySchema.itemTypeRef?.startsWith(\"http\")\n\t\t\t\t\t\t\t\t? propertySchema.itemTypeRef\n\t\t\t\t\t\t\t\t: `${domain}${propertySchema.itemTypeRef}`\n\t\t\t\t\t\t};\n\t\t\t\t\t} else {\n\t\t\t\t\t\tjsonPropertySchema.items = {\n\t\t\t\t\t\t\ttype: propertySchema.itemType\n\t\t\t\t\t\t};\n\t\t\t\t\t}\n\t\t\t\t} else if (propertySchema.type === \"object\") {\n\t\t\t\t\tdelete jsonPropertySchema.type;\n\t\t\t\t\tjsonPropertySchema.$ref = propertySchema.itemTypeRef?.startsWith(\"http\")\n\t\t\t\t\t\t? propertySchema.itemTypeRef\n\t\t\t\t\t\t: `${domain}${propertySchema.itemTypeRef}`;\n\t\t\t\t}\n\n\t\t\t\tproperties[propertySchema.property] = jsonPropertySchema;\n\n\t\t\t\tif (!propertySchema.optional) {\n\t\t\t\t\trequired.push(propertySchema.property);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\treturn {\n\t\t\t$schema: JsonSchemaHelper.SCHEMA_VERSION,\n\t\t\t$id: `${domain}${entitySchema?.type}`,\n\t\t\ttitle: entitySchema?.type,\n\t\t\ttype: entitySchema ? \"object\" : \"null\",\n\t\t\tdescription: entitySchema?.options?.description,\n\t\t\trequired,\n\t\t\tproperties,\n\t\t\tadditionalProperties: false\n\t\t};\n\t}\n}\n"]}

package/dist/types/factories/dataTypeHandlerFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IDataTypeHandler } from "../models/IDataTypeHandler";
+import type { IDataTypeHandler } from "../models/IDataTypeHandler.js";
 /**
  * Factory for creating handlers for data types.
  */

package/dist/types/factories/identifierHandlerFactory.d.ts

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IIdentifierHandler } from "../models/IIdentifierHandler";
+import type { IIdentifierHandler } from "../models/IIdentifierHandler.js";
 /**
  * Factory for creating handlers for identifiers.
  */

package/dist/types/index.d.ts

@@ -1,10 +1,10 @@
-export * from "./factories/dataTypeHandlerFactory";
-export * from "./factories/identifierHandlerFactory";
-export * from "./models/IDataTypeHandler";
-export * from "./models/IIdentifierHandler";
-export * from "./models/IJsonSchema";
-export * from "./models/ISchemaValidationError";
-export * from "./models/ISchemaValidationResult";
-export * from "./models/validationMode";
-export * from "./utils/dataTypeHelper";
-export * from "./utils/jsonSchemaHelper";
+export * from "./factories/dataTypeHandlerFactory.js";
+export * from "./factories/identifierHandlerFactory.js";
+export * from "./models/IDataTypeHandler.js";
+export * from "./models/IIdentifierHandler.js";
+export * from "./models/IJsonSchema.js";
+export * from "./models/ISchemaValidationError.js";
+export * from "./models/ISchemaValidationResult.js";
+export * from "./models/validationMode.js";
+export * from "./utils/dataTypeHelper.js";
+export * from "./utils/jsonSchemaHelper.js";

package/dist/types/models/IDataTypeHandler.d.ts

@@ -1,17 +1,21 @@
 import type { IValidationFailure } from "@twin.org/core";
-import type { IJsonSchema } from "./IJsonSchema";
+import type { IJsonSchema } from "./IJsonSchema.js";
 /**
  * Interface describing a type which can handle a specific data type.
  */
 export interface IDataTypeHandler {
     /**
-     * The context for the type.
+     * The namespace for the type.
      */
-    context: string;
+    namespace: string;
     /**
      * The type for the item.
      */
     type: string;
+    /**
+     * The JSON LD context for the type.
+     */
+    jsonLdContext?: string;
     /**
      * The default value for the item to use when constructing a new object.
      */

package/dist/types/models/IJsonSchema.d.ts

@@ -1,5 +1,5 @@
-import type { SchemaObject } from "ajv/dist/2020";
+import type Ajv from "ajv/dist/2020.js";
 /**
  * Default schema type.
  */
-export type IJsonSchema = SchemaObject;
+export type IJsonSchema = Ajv.SchemaObject;

package/dist/types/models/ISchemaValidationResult.d.ts

@@ -1,4 +1,4 @@
-import type { ISchemaValidationError } from "./ISchemaValidationError";
+import type { ISchemaValidationError } from "./ISchemaValidationError.js";
 /**
  * Validation result.
  */

package/dist/types/utils/dataTypeHelper.d.ts

@@ -1,9 +1,34 @@
 import { type IValidationFailure } from "@twin.org/core";
-import { ValidationMode } from "../models/validationMode";
+import type { IJsonSchema } from "../models/IJsonSchema.js";
+import { ValidationMode } from "../models/validationMode.js";
 /**
  * Class to help with data types.
  */
 export declare class DataTypeHelper {
+    /**
+     * Register a data type.
+     * @param namespace The namespace for the type.
+     * @param type The type for the item.
+     * @param jsonLdContext The JSON LD context for the type.
+     * @param schema The JSON schema for the type.
+     */
+    static registerType(namespace: string, type: string, jsonLdContext: string | undefined, schema: IJsonSchema | Promise<IJsonSchema>): void;
+    /**
+     * Register a  list of types.
+     * @param namespace The namespace for the types.
+     * @param jsonLdContext The JSON LD context for the types.
+     * @param typeDefinition The type definitions to register.
+     */
+    static registerTypes(namespace: string, jsonLdContext: string | undefined, typeDefinition: {
+        type: string;
+        schema: IJsonSchema | Promise<IJsonSchema>;
+    }[]): void;
+    /**
+     * Get the JSON schema for a data type.
+     * @param dataType The data type to get the schema for.
+     * @returns The JSON schema for the data type or undefined if not found.
+     */
+    static getSchemaForType(dataType: string): Promise<IJsonSchema | undefined>;
     /**
      * Validate a data type.
      * @param propertyName The name of the property being validated to use in error messages.

package/dist/types/utils/jsonSchemaHelper.d.ts

@@ -1,14 +1,18 @@
 import type { IEntitySchema } from "@twin.org/entity";
-import type { IJsonSchema } from "../models/IJsonSchema";
-import type { ISchemaValidationResult } from "../models/ISchemaValidationResult";
+import type { IJsonSchema } from "../models/IJsonSchema.js";
+import type { ISchemaValidationResult } from "../models/ISchemaValidationResult.js";
 /**
  * A helper for JSON schemas.
  */
 export declare class JsonSchemaHelper {
     /**
-     * The schema version.
+     * The schema version 2020 (default).
      */
     static readonly SCHEMA_VERSION = "https://json-schema.org/draft/2020-12/schema";
+    /**
+     * The schema version 2019.
+     */
+    static readonly SCHEMA_VERSION_2019 = "https://json-schema.org/draft/2019-09/schema";
     /**
      * Validates data against the schema.
      * @param schema The schema to validate the data with.