@twin.org/data-core 0.0.1-next.3

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Data Core
+
+The package contains definitions and helpers for using with data and schemas.
+
+## Installation
+
+```shell
+npm install @twin.org/data-core
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,255 @@
+'use strict';
+
+var core = require('@twin.org/core');
+var web = require('@twin.org/web');
+var Ajv = require('ajv');
+var addFormats = require('ajv-formats');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating handlers for data types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const DataTypeHandlerFactory = core.Factory.createFactory("data-type");
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Factory for creating handlers for identifiers.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const IdentifierHandlerFactory = core.Factory.createFactory("namespace", false, (names, uri) => {
+    core.Urn.guard("IdentifierHandlerFactory", "uri", uri);
+    const urn = core.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;
+        }
+    }
+});
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Validation modes for validating data types.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+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"
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * A helper for JSON schemas.
+ */
+class JsonSchemaHelper {
+    /**
+     * The schema version.
+     */
+    static SCHEMA_VERSION = "https://json-schema.org/draft/2020-12/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 ajv = new Ajv({
+            allowUnionTypes: true,
+            loadSchema: async (uri) => {
+                const subTypeHandler = DataTypeHandlerFactory.getIfExists(uri);
+                if (core.Is.function(subTypeHandler?.jsonSchema)) {
+                    const subSchema = await subTypeHandler.jsonSchema();
+                    if (core.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
+                    return web.FetchHelper.fetchJson(JsonSchemaHelper._CLASS_NAME, uri, web.HttpMethod.GET, undefined, {
+                        // Cache for an hour
+                        cacheTtlMs: 3600000
+                    });
+                }
+                catch {
+                    // Failed to load remotely so return an empty object
+                    // so the schema validation doesn't completely fail
+                    return {};
+                }
+            }
+        });
+        addFormats(ajv);
+        // Add the additional types provided by the user
+        if (core.Is.objectValue(additionalTypes)) {
+            for (const key in additionalTypes) {
+                ajv.addSchema(additionalTypes[key], key);
+            }
+        }
+        const compiled = await ajv.compileAsync(schema);
+        const result = await 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" && core.Is.objectValue(schema.properties)) {
+            const propertySchema = schema.properties[propertyName];
+            if (core.Is.object(propertySchema)) {
+                if (core.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 = core.StringHelper.trimTrailingSlashes(baseDomain ?? "");
+        if (domain.length > 0) {
+            domain += "/";
+        }
+        const properties = {};
+        const required = [];
+        if (core.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 (core.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
+        };
+    }
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class to help with data types.
+ */
+class DataTypeHelper {
+    /**
+     * 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 validationMode The validation mode to use, defaults to either.
+     * @returns True if the data was valid.
+     */
+    static async validate(propertyName, dataType, data, validationFailures, validationMode) {
+        if (core.Is.stringValue(dataType)) {
+            const handler = DataTypeHandlerFactory.getIfExists(dataType);
+            if (handler) {
+                validationMode = validationMode ?? ValidationMode.Either;
+                // If we have a validate function use that as it is more specific
+                // and will produce better error messages
+                if ((validationMode === ValidationMode.Validate ||
+                    validationMode === ValidationMode.Either) &&
+                    core.Is.function(handler.validate)) {
+                    return handler.validate(propertyName, data, validationFailures);
+                }
+                else if ((validationMode === ValidationMode.JsonSchema ||
+                    validationMode === ValidationMode.Either) &&
+                    core.Is.function(handler.jsonSchema)) {
+                    // Otherwise use the JSON schema if there is one
+                    const schema = await handler.jsonSchema();
+                    if (core.Is.object(schema)) {
+                        const validationResult = await JsonSchemaHelper.validate(schema, data);
+                        if (core.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(", ")
+                                }
+                            });
+                        }
+                        return validationResult.result;
+                    }
+                }
+            }
+        }
+        // Return true by default if no other mechanism for validation is available
+        return true;
+    }
+}
+
+exports.DataTypeHandlerFactory = DataTypeHandlerFactory;
+exports.DataTypeHelper = DataTypeHelper;
+exports.IdentifierHandlerFactory = IdentifierHandlerFactory;
+exports.JsonSchemaHelper = JsonSchemaHelper;
+exports.ValidationMode = ValidationMode;