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

package/docs/changelog.md

@@ -1,5 +1,92 @@
 # @twin.org/data-core - Changelog
 
+## [0.0.3-next.10](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.9...data-core-v0.0.3-next.10) (2026-02-24)
+
+
+### Miscellaneous Chores
+
+* **data-core:** Synchronize repo versions
+
+## [0.0.3-next.9](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.8...data-core-v0.0.3-next.9) (2026-02-23)
+
+
+### Miscellaneous Chores
+
+* **data-core:** Synchronize repo versions
+
+## [0.0.3-next.8](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.7...data-core-v0.0.3-next.8) (2026-02-02)
+
+
+### Miscellaneous Chores
+
+* **data-core:** Synchronize repo versions
+
+## [0.0.3-next.7](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.6...data-core-v0.0.3-next.7) (2026-01-21)
+
+
+### Miscellaneous Chores
+
+* **data-core:** Synchronize repo versions
+
+## [0.0.3-next.6](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.5...data-core-v0.0.3-next.6) (2026-01-14)
+
+
+### Bug Fixes
+
+* getSchemaForType async ([a26a4f0](https://github.com/twinfoundation/data/commit/a26a4f09d6e22ee0882597b71a134db3079d72d0))
+
+## [0.0.3-next.5](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.4...data-core-v0.0.3-next.5) (2026-01-14)
+
+
+### Features
+
+* improve data type registration ([#34](https://github.com/twinfoundation/data/issues/34)) ([855d110](https://github.com/twinfoundation/data/commit/855d11046a4d85317b77a5c4e0f4a7b1b6d1a767))
+
+## [0.0.3-next.4](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.3...data-core-v0.0.3-next.4) (2026-01-06)
+
+
+### Features
+
+* support JSON Schema 2019 ([#31](https://github.com/twinfoundation/data/issues/31)) ([f798f72](https://github.com/twinfoundation/data/commit/f798f721c998cf50b8ba2318bec574069aad02ae))
+
+## [0.0.3-next.3](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.2...data-core-v0.0.3-next.3) (2026-01-05)
+
+
+### Miscellaneous Chores
+
+* **data-core:** Synchronize repo versions
+
+## [0.0.3-next.2](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.1...data-core-v0.0.3-next.2) (2025-11-24)
+
+
+### Miscellaneous Chores
+
+* **data-core:** Synchronize repo versions
+
+## [0.0.3-next.1](https://github.com/twinfoundation/data/compare/data-core-v0.0.3-next.0...data-core-v0.0.3-next.1) (2025-11-10)
+
+
+### Features
+
+* add context id features ([#25](https://github.com/twinfoundation/data/issues/25)) ([6592f2e](https://github.com/twinfoundation/data/commit/6592f2e4e59021cc42a079a4f46242758a54313d))
+* add document cache access methods ([dbf1e36](https://github.com/twinfoundation/data/commit/dbf1e36d176c5f428f8c52628fb5a1ff7a6a174a))
+* add fail on missing type option and both mode ([e8b9702](https://github.com/twinfoundation/data/commit/e8b97029a04b646497ff0e55b9610291e58ae92a))
+* add validate-locales ([cf9b761](https://github.com/twinfoundation/data/commit/cf9b76160820fe0b13b4fe56ed241c1d5511b7c1))
+* eslint migration to flat config ([b0db6e6](https://github.com/twinfoundation/data/commit/b0db6e69a90046fc60d29e4273fcdfee13c16088))
+* expand Json LD Keyword ([70632d1](https://github.com/twinfoundation/data/commit/70632d1e11ad85cf3c57e118476b125a673f1681))
+* update framework core ([c077b8c](https://github.com/twinfoundation/data/commit/c077b8c07e7ee66b5482254eab6f2a52cd911270))
+* use fully qualified names for data type lookups ([b7b5c74](https://github.com/twinfoundation/data/commit/b7b5c746b0180a87baa976f6a7a76cedd53d8ff7))
+* use shared store mechanism ([#3](https://github.com/twinfoundation/data/issues/3)) ([33eb221](https://github.com/twinfoundation/data/commit/33eb221ccec2b4a79549c06e9a04225009b93a46))
+* use updated Is.function ([46a4715](https://github.com/twinfoundation/data/commit/46a4715f995aea34f2011138662fe003c9727d07))
+* use updated JSON schema specs ([465223a](https://github.com/twinfoundation/data/commit/465223a9e9c24af546480ef084327a78fa366eaa))
+
+
+### Bug Fixes
+
+* interface name ([6e49322](https://github.com/twinfoundation/data/commit/6e49322ec1797417220ec9e529bb124f4717f489))
+* remove undici reference ([d77721e](https://github.com/twinfoundation/data/commit/d77721e21d23c7a6750c2f5cac8104851dfaa6d7))
+* tests using context ([577b3bb](https://github.com/twinfoundation/data/commit/577b3bbb661eafbf6d3fd157133c106732e8eb3d))
+
 ## [0.0.2-next.4](https://github.com/twinfoundation/data/compare/data-core-v0.0.2-next.3...data-core-v0.0.2-next.4) (2025-10-09)
 
 

package/docs/reference/classes/DataTypeHelper.md

@@ -14,6 +14,98 @@ Class to help with data types.
 
 ## Methods
 
+### registerType()
+
+> `static` **registerType**(`namespace`, `type`, `jsonLdContext`, `schema`): `void`
+
+Register a data type.
+
+#### Parameters
+
+##### namespace
+
+`string`
+
+The namespace for the type.
+
+##### type
+
+`string`
+
+The type for the item.
+
+##### jsonLdContext
+
+The JSON LD context for the type.
+
+`string` | `undefined`
+
+##### schema
+
+The JSON schema for the type.
+
+`SchemaObject` | `Promise`\<`SchemaObject`\>
+
+#### Returns
+
+`void`
+
+***
+
+### registerTypes()
+
+> `static` **registerTypes**(`namespace`, `jsonLdContext`, `typeDefinition`): `void`
+
+Register a  list of types.
+
+#### Parameters
+
+##### namespace
+
+`string`
+
+The namespace for the types.
+
+##### jsonLdContext
+
+The JSON LD context for the types.
+
+`string` | `undefined`
+
+##### typeDefinition
+
+`object`[]
+
+The type definitions to register.
+
+#### Returns
+
+`void`
+
+***
+
+### getSchemaForType()
+
+> `static` **getSchemaForType**(`dataType`): `Promise`\<`SchemaObject` \| `undefined`\>
+
+Get the JSON schema for a data type.
+
+#### Parameters
+
+##### dataType
+
+`string`
+
+The data type to get the schema for.
+
+#### Returns
+
+`Promise`\<`SchemaObject` \| `undefined`\>
+
+The JSON schema for the data type or undefined if not found.
+
+***
+
 ### validate()
 
 > `static` **validate**(`propertyName`, `dataType`, `data`, `validationFailures`, `options?`): `Promise`\<`boolean`\>
@@ -32,7 +124,7 @@ The name of the property being validated to use in error messages.
 
 The data type to validate.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### data
 

package/docs/reference/classes/JsonSchemaHelper.md

@@ -18,7 +18,15 @@ A helper for JSON schemas.
 
 > `readonly` `static` **SCHEMA\_VERSION**: `"https://json-schema.org/draft/2020-12/schema"` = `"https://json-schema.org/draft/2020-12/schema"`
 
-The schema version.
+The schema version 2020 (default).
+
+***
+
+### SCHEMA\_VERSION\_2019
+
+> `readonly` `static` **SCHEMA\_VERSION\_2019**: `"https://json-schema.org/draft/2019-09/schema"` = `"https://json-schema.org/draft/2019-09/schema"`
+
+The schema version 2019.
 
 ## Methods
 
@@ -62,7 +70,7 @@ Result containing errors if there are any.
 
 ### getPropertyType()
 
-> `static` **getPropertyType**(`schema`, `propertyName`): `undefined` \| `string`
+> `static` **getPropertyType**(`schema`, `propertyName`): `string` \| `undefined`
 
 Get the property type from a schema.
 
@@ -82,7 +90,7 @@ The name of the property to get the type for.
 
 #### Returns
 
-`undefined` \| `string`
+`string` \| `undefined`
 
 The types of the property.
 
@@ -100,7 +108,7 @@ Convert an entity schema to JSON schema e.g https://example.com/schemas/.
 
 The entity schema to convert.
 
-`undefined` | `IEntitySchema`\<`unknown`\>
+`IEntitySchema`\<`unknown`\> | `undefined`
 
 ##### baseDomain?
 

package/docs/reference/interfaces/IDataTypeHandler.md

@@ -4,11 +4,11 @@ Interface describing a type which can handle a specific data type.
 
 ## Properties
 
-### context
+### namespace
 
-> **context**: `string`
+> **namespace**: `string`
 
-The context for the type.
+The namespace for the type.
 
 ***
 
@@ -20,6 +20,14 @@ The type for the item.
 
 ***
 
+### jsonLdContext?
+
+> `optional` **jsonLdContext**: `string`
+
+The JSON LD context for the type.
+
+***
+
 ### defaultValue?
 
 > `optional` **defaultValue**: `unknown`
@@ -30,13 +38,13 @@ The default value for the item to use when constructing a new object.
 
 ### jsonSchema()?
 
-> `optional` **jsonSchema**(): `Promise`\<`undefined` \| `SchemaObject`\>
+> `optional` **jsonSchema**(): `Promise`\<`SchemaObject` \| `undefined`\>
 
 Get the JSON schema for the data type.
 
 #### Returns
 
-`Promise`\<`undefined` \| `SchemaObject`\>
+`Promise`\<`SchemaObject` \| `undefined`\>
 
 The JSON schema for the data type.
 

package/docs/reference/type-aliases/IJsonSchema.md

@@ -1,5 +1,5 @@
 # Type Alias: IJsonSchema
 
-> **IJsonSchema** = `SchemaObject`
+> **IJsonSchema** = `Ajv.SchemaObject`
 
 Default schema type.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-core",
-	"version": "0.0.2-next.4",
+	"version": "0.0.3-next.10",
 	"description": "Definitions and helpers for using with data and schemas",
 	"repository": {
 		"type": "git",
@@ -21,19 +21,17 @@
 		"ajv": "8.17.1",
 		"ajv-formats": "3.0.1"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,282 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var web = require('@twin.org/web');
-var Ajv = require('ajv/dist/2020.js');
-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",
-    /**
-     * Use both validation modes.
-     */
-    Both: "both"
-};
-
-// 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,
-            // 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);
-                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 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 (core.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;
-                if ((validationMode === ValidationMode.Validate ||
-                    validationMode === ValidationMode.Both ||
-                    validationMode === ValidationMode.Either) &&
-                    core.Is.function(handler.validate)) {
-                    isValid = await handler.validate(propertyName, data, validationFailures);
-                    hasValidated = true;
-                }
-                if ((validationMode === ValidationMode.JsonSchema ||
-                    (validationMode === ValidationMode.Either && !hasValidated) ||
-                    validationMode === ValidationMode.Both) &&
-                    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("\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;
-    }
-}
-
-exports.DataTypeHandlerFactory = DataTypeHandlerFactory;
-exports.DataTypeHelper = DataTypeHelper;
-exports.IdentifierHandlerFactory = IdentifierHandlerFactory;
-exports.JsonSchemaHelper = JsonSchemaHelper;
-exports.ValidationMode = ValidationMode;