@twin.org/blob-storage-models 0.0.2-next.4 → 0.0.3-next.1

package/docs/changelog.md

@@ -1,5 +1,36 @@
 # @twin.org/blob-storage-models - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.3-next.0...blob-storage-models-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add compression support ([67d239b](https://github.com/twinfoundation/blob-storage/commit/67d239bca8321bd90bf4ff93167c564130309730))
+* add context id features ([#30](https://github.com/twinfoundation/blob-storage/issues/30)) ([fbf1c92](https://github.com/twinfoundation/blob-storage/commit/fbf1c9276424c841ef5ef3f4de8469ab3fba7e9c))
+* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+* additional encryption options on per item basis ([4b95a65](https://github.com/twinfoundation/blob-storage/commit/4b95a656d19e3b571cea905e36f29b679b13e1e8))
+* eslint migration to flat config ([e4239dd](https://github.com/twinfoundation/blob-storage/commit/e4239dd1c721955cff7f0357255d2bba15319972))
+* remove includeNodeIdentity flag ([13bc334](https://github.com/twinfoundation/blob-storage/commit/13bc33445b179879688af3c98e8be8a5609d3f46))
+* update dependencies ([56f0094](https://github.com/twinfoundation/blob-storage/commit/56f0094b68d8bd22864cd899ac1b61d95540f719))
+* update framework core ([ff339fe](https://github.com/twinfoundation/blob-storage/commit/ff339fe7e3f09ddff429907834bdf43617e9c05e))
+* update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+* update ts-to-schema generation ([03439c7](https://github.com/twinfoundation/blob-storage/commit/03439c726108bf645941290e41824c57a6a23de3))
+* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+* use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
+
+
+### Bug Fixes
+
+* Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
+* query params force coercion ([a5e547a](https://github.com/twinfoundation/blob-storage/commit/a5e547a775f8997cb04780938c7a9561ddb048d1))
+
+## [0.0.2-next.5](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.4...blob-storage-models-v0.0.2-next.5) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([f20fcec](https://github.com/twinfoundation/blob-storage/commit/f20fceced91e39a0c9edb770b2e43ce944c92f3c))
+
 ## [0.0.2-next.4](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.2-next.3...blob-storage-models-v0.0.2-next.4) (2025-10-02)
 
 

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -10,7 +10,7 @@ Interface describing an blob storage component.
 
 ### create()
 
-> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat?`, `fileExtension?`, `metadata?`, `options?`): `Promise`\<`string`\>
 
 Create the blob with some metadata.
 
@@ -68,18 +68,6 @@ Optional compression type to use for the blob, defaults to no compression.
 
 The namespace to use for storing, defaults to component configured namespace.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`string`\>
@@ -90,7 +78,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
+> **get**(`id`, `options?`): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
 Get the blob and metadata.
 
@@ -124,18 +112,6 @@ If the content should be decompressed, if it was compressed when stored, default
 
 Use a different vault key id for decryption, if not provided the default vault key id will be used.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
@@ -150,7 +126,7 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`, `userIdentity?`): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat?`, `fileExtension?`, `metadata?`): `Promise`\<`void`\>
 
 Update the blob with metadata.
 
@@ -180,12 +156,6 @@ Extension for the blob, will be detected if left undefined.
 
 Data for the custom metadata as JSON-LD.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -200,7 +170,7 @@ Not found error if the blob cannot be found.
 
 ### remove()
 
-> **remove**(`id`, `userIdentity?`): `Promise`\<`void`\>
+> **remove**(`id`): `Promise`\<`void`\>
 
 Remove the blob.
 
@@ -212,12 +182,6 @@ Remove the blob.
 
 The id of the blob to remove in urn format.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -232,7 +196,7 @@ Not found error if the blob cannot be found.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `pageSize?`, `userIdentity?`): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
+> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -262,18 +226,12 @@ The direction for the order, defaults to descending.
 
 The cursor to request the next page of entries.
 
-##### pageSize?
+##### limit?
 
 `number`
 
 The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
 
-##### userIdentity?
-
-`string`
-
-The user identity to use with storage operations.
-
 #### Returns
 
 `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>

package/docs/reference/interfaces/IBlobStorageConnector.md

@@ -32,7 +32,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+> **get**(`id`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 Get the blob.
 
@@ -46,7 +46,7 @@ The id of the blob to get in urn format.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
 The data for the blob if it can be found or undefined.
 

package/docs/reference/interfaces/IBlobStorageListRequest.md

@@ -40,11 +40,11 @@ The order for the results, default to created.
 
 The direction for the order, defaults to desc.
 
-#### pageSize?
+#### limit?
 
-> `optional` **pageSize**: `string` \| `number`
+> `optional` **limit**: `string`
 
-The number of entries to return per page.
+Limit the number of entities to return.
 
 #### cursor?
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.2-next.4",
+	"version": "0.0.3-next.1",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -22,20 +22,18 @@
 		"@twin.org/standards-schema-org": "next",
 		"@twin.org/web": "next"
 	},
-	"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"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -54,5 +52,9 @@
 		"models",
 		"types",
 		"schemas"
-	]
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/blob-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,201 +0,0 @@
-'use strict';
-
-var dataCore = require('@twin.org/data-core');
-var core = require('@twin.org/core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageContexts = {
-    /**
-     * The context root for the blob storage types.
-     */
-    ContextRoot: "https://schema.twindev.org/blob-storage/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/"
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The types of blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageTypes = {
-    /**
-     * Represents blob storage entry.
-     */
-    Entry: "BlobStorageEntry",
-    /**
-     * Represents blob storage entry compression.
-     */
-    CompressionType: "BlobStorageCompressionType"
-};
-
-var $schema$1 = "https://json-schema.org/draft/2020-12/schema";
-var $id$1 = "https://schema.twindev.org/blob-storage/BlobStorageCompressionType";
-var description$1 = "The types of compression for blob storage data.";
-var type$1 = "string";
-var BlobStorageCompressionTypeSchema = {
-	$schema: $schema$1,
-	$id: $id$1,
-	description: description$1,
-	type: type$1,
-	"enum": [
-	"gzip",
-	"deflate"
-]
-};
-
-var $schema = "https://json-schema.org/draft/2020-12/schema";
-var $id = "https://schema.twindev.org/blob-storage/BlobStorageEntry";
-var description = "Interface describing a blob storage entry.";
-var type = "object";
-var properties = {
-	"@context": {
-		type: "array",
-		minItems: 2,
-		items: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context.",
-		prefixItems: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/blob-storage/"
-			},
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/common/"
-			}
-		]
-	},
-	type: {
-		type: "string",
-		"const": "BlobStorageEntry",
-		description: "JSON-LD Type."
-	},
-	id: {
-		type: "string",
-		description: "The id for the blob."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time when the entry was created."
-	},
-	dateModified: {
-		type: "string",
-		description: "The date/time when the entry was modified."
-	},
-	blobSize: {
-		type: "number",
-		description: "The size of the data in the blob."
-	},
-	blobHash: {
-		type: "string",
-		description: "The hash of the data in the blob."
-	},
-	encodingFormat: {
-		type: "string",
-		description: "The mime type for the blob."
-	},
-	isEncrypted: {
-		type: "boolean",
-		description: "Indicates if the blob is encrypted."
-	},
-	compression: {
-		$ref: "https://schema.twindev.org/blob-storage/BlobStorageCompressionType",
-		description: "The type of compression used for the blob, if not set it is not stored with compression."
-	},
-	fileExtension: {
-		type: "string",
-		description: "The extension."
-	},
-	metadata: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata for the blob as JSON-LD."
-	},
-	blob: {
-		type: "string",
-		description: "The blob in base64 format, included if the includeContent flag was set in the request."
-	}
-};
-var required = [
-	"@context",
-	"type",
-	"id",
-	"dateCreated",
-	"blobSize",
-	"blobHash"
-];
-var additionalProperties = false;
-var BlobStorageEntrySchema = {
-	$schema: $schema,
-	$id: $id,
-	description: description,
-	type: type,
-	properties: properties,
-	required: required,
-	additionalProperties: additionalProperties
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Handle all the data types for blob storage.
- */
-class BlobStorageDataTypes {
-    /**
-     * Register all the data types.
-     */
-    static registerTypes() {
-        dataCore.DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.Entry}`, () => ({
-            context: BlobStorageContexts.ContextRoot,
-            type: BlobStorageTypes.Entry,
-            defaultValue: {},
-            jsonSchema: async () => BlobStorageEntrySchema
-        }));
-        dataCore.DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.CompressionType}`, () => ({
-            context: BlobStorageContexts.ContextRoot,
-            type: BlobStorageTypes.CompressionType,
-            defaultValue: {},
-            jsonSchema: async () => BlobStorageCompressionTypeSchema
-        }));
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating blob storage connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageConnectorFactory = core.Factory.createFactory("blob-storage");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The types of compression for blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageCompressionType = {
-    /**
-     * Gzip.
-     */
-    Gzip: "gzip",
-    /**
-     * Deflate.
-     */
-    Deflate: "deflate"
-};
-
-exports.BlobStorageCompressionType = BlobStorageCompressionType;
-exports.BlobStorageConnectorFactory = BlobStorageConnectorFactory;
-exports.BlobStorageContexts = BlobStorageContexts;
-exports.BlobStorageDataTypes = BlobStorageDataTypes;
-exports.BlobStorageTypes = BlobStorageTypes;

package/dist/esm/index.mjs

@@ -1,195 +0,0 @@
-import { DataTypeHandlerFactory } from '@twin.org/data-core';
-import { Factory } from '@twin.org/core';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageContexts = {
-    /**
-     * The context root for the blob storage types.
-     */
-    ContextRoot: "https://schema.twindev.org/blob-storage/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/"
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The types of blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageTypes = {
-    /**
-     * Represents blob storage entry.
-     */
-    Entry: "BlobStorageEntry",
-    /**
-     * Represents blob storage entry compression.
-     */
-    CompressionType: "BlobStorageCompressionType"
-};
-
-var $schema$1 = "https://json-schema.org/draft/2020-12/schema";
-var $id$1 = "https://schema.twindev.org/blob-storage/BlobStorageCompressionType";
-var description$1 = "The types of compression for blob storage data.";
-var type$1 = "string";
-var BlobStorageCompressionTypeSchema = {
-	$schema: $schema$1,
-	$id: $id$1,
-	description: description$1,
-	type: type$1,
-	"enum": [
-	"gzip",
-	"deflate"
-]
-};
-
-var $schema = "https://json-schema.org/draft/2020-12/schema";
-var $id = "https://schema.twindev.org/blob-storage/BlobStorageEntry";
-var description = "Interface describing a blob storage entry.";
-var type = "object";
-var properties = {
-	"@context": {
-		type: "array",
-		minItems: 2,
-		items: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context.",
-		prefixItems: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/blob-storage/"
-			},
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/common/"
-			}
-		]
-	},
-	type: {
-		type: "string",
-		"const": "BlobStorageEntry",
-		description: "JSON-LD Type."
-	},
-	id: {
-		type: "string",
-		description: "The id for the blob."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time when the entry was created."
-	},
-	dateModified: {
-		type: "string",
-		description: "The date/time when the entry was modified."
-	},
-	blobSize: {
-		type: "number",
-		description: "The size of the data in the blob."
-	},
-	blobHash: {
-		type: "string",
-		description: "The hash of the data in the blob."
-	},
-	encodingFormat: {
-		type: "string",
-		description: "The mime type for the blob."
-	},
-	isEncrypted: {
-		type: "boolean",
-		description: "Indicates if the blob is encrypted."
-	},
-	compression: {
-		$ref: "https://schema.twindev.org/blob-storage/BlobStorageCompressionType",
-		description: "The type of compression used for the blob, if not set it is not stored with compression."
-	},
-	fileExtension: {
-		type: "string",
-		description: "The extension."
-	},
-	metadata: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata for the blob as JSON-LD."
-	},
-	blob: {
-		type: "string",
-		description: "The blob in base64 format, included if the includeContent flag was set in the request."
-	}
-};
-var required = [
-	"@context",
-	"type",
-	"id",
-	"dateCreated",
-	"blobSize",
-	"blobHash"
-];
-var additionalProperties = false;
-var BlobStorageEntrySchema = {
-	$schema: $schema,
-	$id: $id,
-	description: description,
-	type: type,
-	properties: properties,
-	required: required,
-	additionalProperties: additionalProperties
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Handle all the data types for blob storage.
- */
-class BlobStorageDataTypes {
-    /**
-     * Register all the data types.
-     */
-    static registerTypes() {
-        DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.Entry}`, () => ({
-            context: BlobStorageContexts.ContextRoot,
-            type: BlobStorageTypes.Entry,
-            defaultValue: {},
-            jsonSchema: async () => BlobStorageEntrySchema
-        }));
-        DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.CompressionType}`, () => ({
-            context: BlobStorageContexts.ContextRoot,
-            type: BlobStorageTypes.CompressionType,
-            defaultValue: {},
-            jsonSchema: async () => BlobStorageCompressionTypeSchema
-        }));
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating blob storage connectors.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageConnectorFactory = Factory.createFactory("blob-storage");
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The types of compression for blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageCompressionType = {
-    /**
-     * Gzip.
-     */
-    Gzip: "gzip",
-    /**
-     * Deflate.
-     */
-    Deflate: "deflate"
-};
-
-export { BlobStorageCompressionType, BlobStorageConnectorFactory, BlobStorageContexts, BlobStorageDataTypes, BlobStorageTypes };