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

package/dist/es/dataTypes/blobStorageDataTypes.js

@@ -0,0 +1,30 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { DataTypeHandlerFactory } from "@twin.org/data-core";
+import { BlobStorageContexts } from "../models/blobStorageContexts.js";
+import { BlobStorageTypes } from "../models/blobStorageTypes.js";
+import BlobStorageCompressionTypeSchema from "../schemas/BlobStorageCompressionType.json" with { type: "json" };
+import BlobStorageEntrySchema from "../schemas/BlobStorageEntry.json" with { type: "json" };
+/**
+ * Handle all the data types for blob storage.
+ */
+export 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
+        }));
+    }
+}
+//# sourceMappingURL=blobStorageDataTypes.js.map

package/dist/es/dataTypes/blobStorageDataTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"blobStorageDataTypes.js","sourceRoot":"","sources":["../../../src/dataTypes/blobStorageDataTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,sBAAsB,EAAoB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,gCAAgC,MAAM,4CAA4C,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAChH,OAAO,sBAAsB,MAAM,kCAAkC,CAAC,OAAO,IAAI,EAAE,MAAM,EAAE,CAAC;AAE5F;;GAEG;AACH,MAAM,OAAO,oBAAoB;IAChC;;OAEG;IACI,MAAM,CAAC,aAAa;QAC1B,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,mBAAmB,CAAC,WAAW,GAAG,gBAAgB,CAAC,KAAK,EAAE,EAC7D,GAAG,EAAE,CAAC,CAAC;YACN,OAAO,EAAE,mBAAmB,CAAC,WAAW;YACxC,IAAI,EAAE,gBAAgB,CAAC,KAAK;YAC5B,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,sBAAqC;SAC7D,CAAC,CACF,CAAC;QAEF,sBAAsB,CAAC,QAAQ,CAC9B,GAAG,mBAAmB,CAAC,WAAW,GAAG,gBAAgB,CAAC,eAAe,EAAE,EACvE,GAAG,EAAE,CAAC,CAAC;YACN,OAAO,EAAE,mBAAmB,CAAC,WAAW;YACxC,IAAI,EAAE,gBAAgB,CAAC,eAAe;YACtC,YAAY,EAAE,EAAE;YAChB,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,gCAA+C;SACvE,CAAC,CACF,CAAC;IACH,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { DataTypeHandlerFactory, type IJsonSchema } from \"@twin.org/data-core\";\nimport { BlobStorageContexts } from \"../models/blobStorageContexts.js\";\nimport { BlobStorageTypes } from \"../models/blobStorageTypes.js\";\nimport BlobStorageCompressionTypeSchema from \"../schemas/BlobStorageCompressionType.json\" with { type: \"json\" };\nimport BlobStorageEntrySchema from \"../schemas/BlobStorageEntry.json\" with { type: \"json\" };\n\n/**\n * Handle all the data types for blob storage.\n */\nexport class BlobStorageDataTypes {\n\t/**\n\t * Register all the data types.\n\t */\n\tpublic static registerTypes(): void {\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.Entry}`,\n\t\t\t() => ({\n\t\t\t\tcontext: BlobStorageContexts.ContextRoot,\n\t\t\t\ttype: BlobStorageTypes.Entry,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => BlobStorageEntrySchema as IJsonSchema\n\t\t\t})\n\t\t);\n\n\t\tDataTypeHandlerFactory.register(\n\t\t\t`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.CompressionType}`,\n\t\t\t() => ({\n\t\t\t\tcontext: BlobStorageContexts.ContextRoot,\n\t\t\t\ttype: BlobStorageTypes.CompressionType,\n\t\t\t\tdefaultValue: {},\n\t\t\t\tjsonSchema: async () => BlobStorageCompressionTypeSchema as IJsonSchema\n\t\t\t})\n\t\t);\n\t}\n}\n"]}

package/dist/es/factories/blobStorageConnectorFactory.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"blobStorageConnectorFactory.js","sourceRoot":"","sources":["../../../src/factories/blobStorageConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GACvC,OAAO,CAAC,aAAa,CAAwB,cAAc,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@twin.org/core\";\nimport type { IBlobStorageConnector } from \"../models/IBlobStorageConnector.js\";\n\n/**\n * Factory for creating blob storage connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const BlobStorageConnectorFactory =\n\tFactory.createFactory<IBlobStorageConnector>(\"blob-storage\");\n"]}

package/dist/es/index.js

@@ -0,0 +1,21 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./dataTypes/blobStorageDataTypes.js";
+export * from "./factories/blobStorageConnectorFactory.js";
+export * from "./models/api/IBlobStorageCreateRequest.js";
+export * from "./models/api/IBlobStorageGetContentRequest.js";
+export * from "./models/api/IBlobStorageGetContentResponse.js";
+export * from "./models/api/IBlobStorageGetRequest.js";
+export * from "./models/api/IBlobStorageGetResponse.js";
+export * from "./models/api/IBlobStorageListRequest.js";
+export * from "./models/api/IBlobStorageListResponse.js";
+export * from "./models/api/IBlobStorageRemoveRequest.js";
+export * from "./models/api/IBlobStorageUpdateRequest.js";
+export * from "./models/blobStorageCompressionType.js";
+export * from "./models/blobStorageContexts.js";
+export * from "./models/blobStorageTypes.js";
+export * from "./models/IBlobStorageComponent.js";
+export * from "./models/IBlobStorageConnector.js";
+export * from "./models/IBlobStorageEntry.js";
+export * from "./models/IBlobStorageEntryList.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,qCAAqC,CAAC;AACpD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,yCAAyC,CAAC;AACxD,cAAc,0CAA0C,CAAC;AACzD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,wCAAwC,CAAC;AACvD,cAAc,iCAAiC,CAAC;AAChD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mCAAmC,CAAC;AAClD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/blobStorageDataTypes.js\";\nexport * from \"./factories/blobStorageConnectorFactory.js\";\nexport * from \"./models/api/IBlobStorageCreateRequest.js\";\nexport * from \"./models/api/IBlobStorageGetContentRequest.js\";\nexport * from \"./models/api/IBlobStorageGetContentResponse.js\";\nexport * from \"./models/api/IBlobStorageGetRequest.js\";\nexport * from \"./models/api/IBlobStorageGetResponse.js\";\nexport * from \"./models/api/IBlobStorageListRequest.js\";\nexport * from \"./models/api/IBlobStorageListResponse.js\";\nexport * from \"./models/api/IBlobStorageRemoveRequest.js\";\nexport * from \"./models/api/IBlobStorageUpdateRequest.js\";\nexport * from \"./models/blobStorageCompressionType.js\";\nexport * from \"./models/blobStorageContexts.js\";\nexport * from \"./models/blobStorageTypes.js\";\nexport * from \"./models/IBlobStorageComponent.js\";\nexport * from \"./models/IBlobStorageConnector.js\";\nexport * from \"./models/IBlobStorageEntry.js\";\nexport * from \"./models/IBlobStorageEntryList.js\";\n"]}

package/dist/es/models/IBlobStorageComponent.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageComponent.js","sourceRoot":"","sources":["../../../src/models/IBlobStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { EntityCondition, SortDirection } from \"@twin.org/entity\";\nimport type { BlobStorageCompressionType } from \"./blobStorageCompressionType.js\";\nimport type { IBlobStorageEntry } from \"./IBlobStorageEntry.js\";\nimport type { IBlobStorageEntryList } from \"./IBlobStorageEntryList.js\";\n\n/**\n * Interface describing an blob storage component.\n */\nexport interface IBlobStorageComponent extends IComponent {\n\t/**\n\t * Create the blob with some metadata.\n\t * @param blob The data for the blob in base64 format.\n\t * @param encodingFormat Mime type for the blob, will be detected if left undefined.\n\t * @param fileExtension Extension for the blob, will be detected if left undefined.\n\t * @param metadata Data for the custom metadata as JSON-LD.\n\t * @param options Optional options for the creation of the blob.\n\t * @param options.disableEncryption Disables encryption if enabled by default.\n\t * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.\n\t * @param options.compress Optional compression type to use for the blob, defaults to no compression.\n\t * @param options.namespace The namespace to use for storing, defaults to component configured namespace.\n\t * @returns The id of the stored blob in urn format.\n\t */\n\tcreate(\n\t\tblob: string,\n\t\tencodingFormat?: string,\n\t\tfileExtension?: string,\n\t\tmetadata?: IJsonLdNodeObject,\n\t\toptions?: {\n\t\t\tdisableEncryption?: boolean;\n\t\t\toverrideVaultKeyId?: string;\n\t\t\tcompress?: BlobStorageCompressionType;\n\t\t\tnamespace?: string;\n\t\t}\n\t): Promise<string>;\n\n\t/**\n\t * Get the blob and metadata.\n\t * @param id The id of the blob to get in urn format.\n\t * @param options Optional options for the retrieval of the blob.\n\t * @param options.includeContent Include the content, or just get the metadata.\n\t * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.\n\t * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.\n\t * @returns The data and metadata for the blob if it can be found.\n\t * @throws Not found error if the blob cannot be found.\n\t */\n\tget(\n\t\tid: string,\n\t\toptions?: {\n\t\t\tincludeContent?: boolean;\n\t\t\tdecompress?: boolean;\n\t\t\toverrideVaultKeyId?: string;\n\t\t}\n\t): Promise<IBlobStorageEntry>;\n\n\t/**\n\t * Update the blob with metadata.\n\t * @param id The id of the blob metadata to update.\n\t * @param encodingFormat Mime type for the blob, will be detected if left undefined.\n\t * @param fileExtension Extension for the blob, will be detected if left undefined.\n\t * @param metadata Data for the custom metadata as JSON-LD.\n\t * @returns Nothing.\n\t * @throws Not found error if the blob cannot be found.\n\t */\n\tupdate(\n\t\tid: string,\n\t\tencodingFormat?: string,\n\t\tfileExtension?: string,\n\t\tmetadata?: IJsonLdNodeObject\n\t): Promise<void>;\n\n\t/**\n\t * Remove the blob.\n\t * @param id The id of the blob to remove in urn format.\n\t * @returns Nothing.\n\t * @throws Not found error if the blob cannot be found.\n\t */\n\tremove(id: string): Promise<void>;\n\n\t/**\n\t * Query all the blob storage entries which match the conditions.\n\t * @param conditions The conditions to match for the entries.\n\t * @param orderBy The order for the results, defaults to created.\n\t * @param orderByDirection The direction for the order, defaults to descending.\n\t * @param cursor The cursor to request the next page of entries.\n\t * @param limit The suggested number of entries to return in each chunk, in some scenarios can return a different amount.\n\t * @returns All the entries for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tquery(\n\t\tconditions?: EntityCondition<IBlobStorageEntry>,\n\t\torderBy?: keyof Pick<IBlobStorageEntry, \"dateCreated\" | \"dateModified\">,\n\t\torderByDirection?: SortDirection,\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<IBlobStorageEntryList>;\n}\n"]}

package/dist/es/models/IBlobStorageConnector.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageConnector.js","sourceRoot":"","sources":["../../../src/models/IBlobStorageConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\n\n/**\n * Interface describing an blob storage connector.\n */\nexport interface IBlobStorageConnector extends IComponent {\n\t/**\n\t * Set the blob.\n\t * @param blob The data for the blob.\n\t * @returns The id of the stored blob in urn format.\n\t */\n\tset(blob: Uint8Array): Promise<string>;\n\n\t/**\n\t * Get the blob.\n\t * @param id The id of the blob to get in urn format.\n\t * @returns The data for the blob if it can be found or undefined.\n\t */\n\tget(id: string): Promise<Uint8Array | undefined>;\n\n\t/**\n\t * Remove the blob.\n\t * @param id The id of the blob to remove in urn format.\n\t * @returns True if the blob was found.\n\t */\n\tremove(id: string): Promise<boolean>;\n}\n"]}

package/dist/es/models/IBlobStorageEntry.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageEntry.js","sourceRoot":"","sources":["../../../src/models/IBlobStorageEntry.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { BlobStorageCompressionType } from \"./blobStorageCompressionType.js\";\nimport type { BlobStorageContexts } from \"./blobStorageContexts.js\";\nimport type { BlobStorageTypes } from \"./blobStorageTypes.js\";\n\n/**\n * Interface describing a blob storage entry.\n */\nexport interface IBlobStorageEntry {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof BlobStorageContexts.ContextRoot,\n\t\ttypeof BlobStorageContexts.ContextRootCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof BlobStorageTypes.Entry;\n\n\t/**\n\t * The id for the blob.\n\t */\n\tid: string;\n\n\t/**\n\t * The date/time when the entry was created.\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The date/time when the entry was modified.\n\t */\n\tdateModified?: string;\n\n\t/**\n\t * The size of the data in the blob.\n\t */\n\tblobSize: number;\n\n\t/**\n\t * The hash of the data in the blob.\n\t */\n\tblobHash: string;\n\n\t/**\n\t * The mime type for the blob.\n\t */\n\tencodingFormat?: string;\n\n\t/**\n\t * Indicates if the blob is encrypted.\n\t */\n\tisEncrypted?: boolean;\n\n\t/**\n\t * The type of compression used for the blob, if not set it is not stored with compression.\n\t */\n\tcompression?: BlobStorageCompressionType;\n\n\t/**\n\t * The extension.\n\t */\n\tfileExtension?: string;\n\n\t/**\n\t * The metadata for the blob as JSON-LD.\n\t */\n\tmetadata?: IJsonLdNodeObject;\n\n\t/**\n\t * The blob in base64 format, included if the includeContent flag was set in the request.\n\t */\n\tblob?: string;\n}\n"]}

package/dist/es/models/IBlobStorageEntryList.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageEntryList.js","sourceRoot":"","sources":["../../../src/models/IBlobStorageEntryList.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts, SchemaOrgTypes } from \"@twin.org/standards-schema-org\";\nimport type { BlobStorageContexts } from \"./blobStorageContexts.js\";\nimport type { IBlobStorageEntry } from \"./IBlobStorageEntry.js\";\n\n/**\n * Interface describing an blob storage entry list.\n */\nexport interface IBlobStorageEntryList {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.ContextRoot,\n\t\ttypeof BlobStorageContexts.ContextRoot,\n\t\ttypeof BlobStorageContexts.ContextRootCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof SchemaOrgTypes.ItemList;\n\n\t/**\n\t * The list of entries.\n\t */\n\t[SchemaOrgTypes.ItemListElement]: IBlobStorageEntry[];\n\n\t/**\n\t * The cursor to get the next chunk of entries.\n\t */\n\t[SchemaOrgTypes.NextItem]?: string;\n}\n"]}

package/dist/es/models/api/IBlobStorageCreateRequest.js

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

package/dist/es/models/api/IBlobStorageCreateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageCreateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageCreateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { BlobStorageCompressionType } from \"../blobStorageCompressionType.js\";\n\n/**\n * Request to create an entry in blob storage.\n */\nexport interface IBlobStorageCreateRequest {\n\t/**\n\t * The body parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The data to store in base64 encoding.\n\t\t */\n\t\tblob: string;\n\n\t\t/**\n\t\t * The mime type of the blob, will be detected if left undefined.\n\t\t */\n\t\tencodingFormat?: string;\n\n\t\t/**\n\t\t * The extension of the blob, will be detected if left undefined.\n\t\t */\n\t\tfileExtension?: string;\n\n\t\t/**\n\t\t * Custom metadata to associate with the blob as JSON-LD.\n\t\t */\n\t\tmetadata?: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * Disables encryption if enabled by default.\n\t\t * @default false\n\t\t */\n\t\tdisableEncryption?: boolean;\n\n\t\t/**\n\t\t * Optional compression type to use for the blob, defaults to no compression.\n\t\t */\n\t\tcompress?: BlobStorageCompressionType;\n\n\t\t/**\n\t\t * Use a different vault key id for encryption, if not provided the default vault key id will be used.\n\t\t * @default undefined\n\t\t */\n\t\toverrideVaultKeyId?: string;\n\n\t\t/**\n\t\t * The namespace to store the data in, defaults to component configured namespace.\n\t\t */\n\t\tnamespace?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IBlobStorageGetContentRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IBlobStorageGetContentRequest.js.map

package/dist/es/models/api/IBlobStorageGetContentRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageGetContentRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageGetContentRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to get the content from blob storage.\n */\nexport interface IBlobStorageGetContentRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the blob to get in urn format.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * If the content should be decompressed, if it was compressed when stored, defaults to true.\n\t\t * @default true\n\t\t */\n\t\tdecompress?: boolean | string;\n\n\t\t/**\n\t\t * Use a different vault key id for decryption, if not provided the default vault key id will be used.\n\t\t * @default undefined\n\t\t */\n\t\toverrideVaultKeyId?: string;\n\n\t\t/**\n\t\t * Set the download flag which should prompt the browser to save the file.\n\t\t * Otherwise the browser should show the content inside the page.\n\t\t * @default false\n\t\t */\n\t\tdownload?: boolean | string;\n\n\t\t/**\n\t\t * Set the filename to use when a download is triggered.\n\t\t * A filename will be generated if not provided.\n\t\t */\n\t\tfilename?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IBlobStorageGetContentResponse.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IBlobStorageGetContentResponse.js.map

package/dist/es/models/api/IBlobStorageGetContentResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageGetContentResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageGetContentResponse.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Response to get an entry from blob storage.\n */\nexport interface IBlobStorageGetContentResponse {\n\t/**\n\t * The body parameters.\n\t */\n\tbody: Uint8Array;\n}\n"]}

package/dist/es/models/api/IBlobStorageGetRequest.js

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

package/dist/es/models/api/IBlobStorageGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Request to get an entry from blob storage.\n */\nexport interface IBlobStorageGetRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the blob to get in urn format.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Include the content in the response, otherwise only metadata is returned.\n\t\t * @default false\n\t\t */\n\t\tincludeContent?: boolean | string;\n\n\t\t/**\n\t\t * If the content should be decompressed, if it was compressed when stored, defaults to true.\n\t\t * @default true\n\t\t */\n\t\tdecompress?: boolean | string;\n\n\t\t/**\n\t\t * Use a different vault key id for decryption, if not provided the default vault key id will be used.\n\t\t * @default undefined\n\t\t */\n\t\toverrideVaultKeyId?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IBlobStorageGetResponse.js

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

package/dist/es/models/api/IBlobStorageGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IBlobStorageEntry } from \"../IBlobStorageEntry.js\";\n\n/**\n * Response to get an entry from blob storage.\n */\nexport interface IBlobStorageGetResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: IBlobStorageEntry;\n}\n"]}

package/dist/es/models/api/IBlobStorageListRequest.js

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

package/dist/es/models/api/IBlobStorageListRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SortDirection } from \"@twin.org/entity\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IBlobStorageEntry } from \"../IBlobStorageEntry.js\";\n\n/**\n * Query the entries from blob storage.\n */\nexport interface IBlobStorageListRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The parameters from the query.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The condition for the query as JSON version of EntityCondition type.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * The order for the results, default to created.\n\t\t */\n\t\torderBy?: keyof Pick<IBlobStorageEntry, \"dateCreated\" | \"dateModified\">;\n\n\t\t/**\n\t\t * The direction for the order, defaults to desc.\n\t\t */\n\t\torderByDirection?: SortDirection;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\n\t\t/**\n\t\t * The cursor to get next chunk of data, returned in previous response.\n\t\t */\n\t\tcursor?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IBlobStorageListResponse.js

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

package/dist/es/models/api/IBlobStorageListResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageListResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageListResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IBlobStorageEntryList } from \"../IBlobStorageEntryList.js\";\n\n/**\n * Response to getting the list of entries from a query.\n */\nexport interface IBlobStorageListResponse {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The list of entries from the query.\n\t */\n\tbody: IBlobStorageEntryList;\n}\n"]}

package/dist/es/models/api/IBlobStorageRemoveRequest.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IBlobStorageRemoveRequest.js.map

package/dist/es/models/api/IBlobStorageRemoveRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Request to remove an entry from blob storage.\n */\nexport interface IBlobStorageRemoveRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the blob to remove in urn format.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}

package/dist/es/models/api/IBlobStorageUpdateRequest.js

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

package/dist/es/models/api/IBlobStorageUpdateRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IBlobStorageUpdateRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IBlobStorageUpdateRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Request to update a blob entry.\n */\nexport interface IBlobStorageUpdateRequest {\n\t/**\n\t * The path parameters.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the blob to get in urn format.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The body parameters.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The mime type of the blob, will be detected if left undefined.\n\t\t */\n\t\tencodingFormat?: string;\n\n\t\t/**\n\t\t * The extension of the blob, will be detected if left undefined.\n\t\t */\n\t\tfileExtension?: string;\n\n\t\t/**\n\t\t * Custom metadata to associate with the blob as JSON-LD.\n\t\t */\n\t\tmetadata?: IJsonLdNodeObject;\n\t};\n}\n"]}

package/dist/es/models/blobStorageCompressionType.js

@@ -0,0 +1,17 @@
+// 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
+export const BlobStorageCompressionType = {
+    /**
+     * Gzip.
+     */
+    Gzip: "gzip",
+    /**
+     * Deflate.
+     */
+    Deflate: "deflate"
+};
+//# sourceMappingURL=blobStorageCompressionType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"blobStorageCompressionType.js","sourceRoot":"","sources":["../../../src/models/blobStorageCompressionType.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,MAAM;IACZ;;OAEG;IACH,OAAO,EAAE,SAAS;CACT,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of compression for blob storage data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const BlobStorageCompressionType = {\n\t/**\n\t * Gzip.\n\t */\n\tGzip: \"gzip\",\n\t/**\n\t * Deflate.\n\t */\n\tDeflate: \"deflate\"\n} as const;\n\n/**\n * The types of compression for blob storage data.\n */\nexport type BlobStorageCompressionType =\n\t(typeof BlobStorageCompressionType)[keyof typeof BlobStorageCompressionType];\n"]}

package/dist/es/models/blobStorageContexts.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of blob storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export 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/"
+};
+//# sourceMappingURL=blobStorageContexts.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"blobStorageContexts.js","sourceRoot":"","sources":["../../../src/models/blobStorageContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG;IAClC;;OAEG;IACH,WAAW,EAAE,0CAA0C;IAEvD;;OAEG;IACH,iBAAiB,EAAE,oCAAoC;CAC9C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of blob storage data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const BlobStorageContexts = {\n\t/**\n\t * The context root for the blob storage types.\n\t */\n\tContextRoot: \"https://schema.twindev.org/blob-storage/\",\n\n\t/**\n\t * The context root for the common types.\n\t */\n\tContextRootCommon: \"https://schema.twindev.org/common/\"\n} as const;\n\n/**\n * The contexts of blob storage data.\n */\nexport type BlobStorageContexts = (typeof BlobStorageContexts)[keyof typeof BlobStorageContexts];\n"]}

package/dist/es/models/blobStorageTypes.js

@@ -0,0 +1,17 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of blob storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const BlobStorageTypes = {
+    /**
+     * Represents blob storage entry.
+     */
+    Entry: "BlobStorageEntry",
+    /**
+     * Represents blob storage entry compression.
+     */
+    CompressionType: "BlobStorageCompressionType"
+};
+//# sourceMappingURL=blobStorageTypes.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"blobStorageTypes.js","sourceRoot":"","sources":["../../../src/models/blobStorageTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC/B;;OAEG;IACH,KAAK,EAAE,kBAAkB;IAEzB;;OAEG;IACH,eAAe,EAAE,4BAA4B;CACpC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of blob storage data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const BlobStorageTypes = {\n\t/**\n\t * Represents blob storage entry.\n\t */\n\tEntry: \"BlobStorageEntry\",\n\n\t/**\n\t * Represents blob storage entry compression.\n\t */\n\tCompressionType: \"BlobStorageCompressionType\"\n} as const;\n\n/**\n * The types of blob storage data.\n */\nexport type BlobStorageTypes = (typeof BlobStorageTypes)[keyof typeof BlobStorageTypes];\n"]}

package/dist/es/schemas/BlobStorageCompressionType.json

@@ -0,0 +1,10 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/blob-storage/BlobStorageCompressionType",
+    "description": "The types of compression for blob storage data.",
+    "type": "string",
+    "enum": [
+        "gzip",
+        "deflate"
+    ]
+}

package/dist/es/schemas/BlobStorageEntry.json

@@ -0,0 +1,84 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://schema.twindev.org/blob-storage/BlobStorageEntry",
+    "description": "Interface describing a blob storage entry.",
+    "type": "object",
+    "properties": {
+        "@context": {
+            "type": "array",
+            "minItems": 2,
+            "description": "JSON-LD Context.",
+            "prefixItems": [
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/blob-storage/"
+                },
+                {
+                    "type": "string",
+                    "const": "https://schema.twindev.org/common/"
+                }
+            ],
+            "items": {
+                "$ref": "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+            }
+        },
+        "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."
+        }
+    },
+    "required": [
+        "@context",
+        "type",
+        "id",
+        "dateCreated",
+        "blobSize",
+        "blobHash"
+    ],
+    "additionalProperties": false
+}

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

@@ -1,5 +1,5 @@
 import { Factory } from "@twin.org/core";
-import type { IBlobStorageConnector } from "../models/IBlobStorageConnector";
+import type { IBlobStorageConnector } from "../models/IBlobStorageConnector.js";
 /**
  * Factory for creating blob storage connectors.
  */

package/dist/types/index.d.ts

@@ -1,18 +1,18 @@
-export * from "./dataTypes/blobStorageDataTypes";
-export * from "./factories/blobStorageConnectorFactory";
-export * from "./models/api/IBlobStorageCreateRequest";
-export * from "./models/api/IBlobStorageGetContentRequest";
-export * from "./models/api/IBlobStorageGetContentResponse";
-export * from "./models/api/IBlobStorageGetRequest";
-export * from "./models/api/IBlobStorageGetResponse";
-export * from "./models/api/IBlobStorageListRequest";
-export * from "./models/api/IBlobStorageListResponse";
-export * from "./models/api/IBlobStorageRemoveRequest";
-export * from "./models/api/IBlobStorageUpdateRequest";
-export * from "./models/blobStorageCompressionType";
-export * from "./models/blobStorageContexts";
-export * from "./models/blobStorageTypes";
-export * from "./models/IBlobStorageComponent";
-export * from "./models/IBlobStorageConnector";
-export * from "./models/IBlobStorageEntry";
-export * from "./models/IBlobStorageEntryList";
+export * from "./dataTypes/blobStorageDataTypes.js";
+export * from "./factories/blobStorageConnectorFactory.js";
+export * from "./models/api/IBlobStorageCreateRequest.js";
+export * from "./models/api/IBlobStorageGetContentRequest.js";
+export * from "./models/api/IBlobStorageGetContentResponse.js";
+export * from "./models/api/IBlobStorageGetRequest.js";
+export * from "./models/api/IBlobStorageGetResponse.js";
+export * from "./models/api/IBlobStorageListRequest.js";
+export * from "./models/api/IBlobStorageListResponse.js";
+export * from "./models/api/IBlobStorageRemoveRequest.js";
+export * from "./models/api/IBlobStorageUpdateRequest.js";
+export * from "./models/blobStorageCompressionType.js";
+export * from "./models/blobStorageContexts.js";
+export * from "./models/blobStorageTypes.js";
+export * from "./models/IBlobStorageComponent.js";
+export * from "./models/IBlobStorageConnector.js";
+export * from "./models/IBlobStorageEntry.js";
+export * from "./models/IBlobStorageEntryList.js";

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

@@ -1,9 +1,9 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { EntityCondition, SortDirection } from "@twin.org/entity";
-import type { BlobStorageCompressionType } from "./blobStorageCompressionType";
-import type { IBlobStorageEntry } from "./IBlobStorageEntry";
-import type { IBlobStorageEntryList } from "./IBlobStorageEntryList";
+import type { BlobStorageCompressionType } from "./blobStorageCompressionType.js";
+import type { IBlobStorageEntry } from "./IBlobStorageEntry.js";
+import type { IBlobStorageEntryList } from "./IBlobStorageEntryList.js";
 /**
  * Interface describing an blob storage component.
  */
@@ -19,8 +19,6 @@ export interface IBlobStorageComponent extends IComponent {
      * @param options.overrideVaultKeyId Use a different vault key id for encryption, if not provided the default vault key id will be used.
      * @param options.compress Optional compression type to use for the blob, defaults to no compression.
      * @param options.namespace The namespace to use for storing, defaults to component configured namespace.
-     * @param userIdentity The user identity to use with storage operations.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns The id of the stored blob in urn format.
      */
     create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, options?: {
@@ -28,7 +26,7 @@ export interface IBlobStorageComponent extends IComponent {
         overrideVaultKeyId?: string;
         compress?: BlobStorageCompressionType;
         namespace?: string;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    }): Promise<string>;
     /**
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
@@ -36,8 +34,6 @@ export interface IBlobStorageComponent extends IComponent {
      * @param options.includeContent Include the content, or just get the metadata.
      * @param options.overrideVaultKeyId Use a different vault key id for decryption, if not provided the default vault key id will be used.
      * @param options.decompress If the content should be decompressed, if it was compressed when stored, defaults to true.
-     * @param userIdentity The user identity to use with storage operations.
-     * @param nodeIdentity The node identity to use with storage operations.
      * @returns The data and metadata for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
@@ -45,26 +41,24 @@ export interface IBlobStorageComponent extends IComponent {
         includeContent?: boolean;
         decompress?: boolean;
         overrideVaultKeyId?: string;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntry>;
+    }): Promise<IBlobStorageEntry>;
     /**
      * Update the blob with metadata.
      * @param id The id of the blob metadata to update.
      * @param encodingFormat Mime type for the blob, will be detected if left undefined.
      * @param fileExtension Extension for the blob, will be detected if left undefined.
      * @param metadata Data for the custom metadata as JSON-LD.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    update(id: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, userIdentity?: string): Promise<void>;
+    update(id: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject): Promise<void>;
     /**
      * Remove the blob.
      * @param id The id of the blob to remove in urn format.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    remove(id: string, userIdentity?: string): Promise<void>;
+    remove(id: string): Promise<void>;
     /**
      * Query all the blob storage entries which match the conditions.
      * @param conditions The conditions to match for the entries.
@@ -72,9 +66,8 @@ export interface IBlobStorageComponent extends IComponent {
      * @param orderByDirection The direction for the order, defaults to descending.
      * @param cursor The cursor to request the next page of entries.
      * @param limit The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
-     * @param userIdentity The user identity to use with storage operations.
      * @returns All the entries for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, limit?: number, userIdentity?: string): Promise<IBlobStorageEntryList>;
+    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, limit?: number): Promise<IBlobStorageEntryList>;
 }

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

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { BlobStorageCompressionType } from "./blobStorageCompressionType";
-import type { BlobStorageContexts } from "./blobStorageContexts";
-import type { BlobStorageTypes } from "./blobStorageTypes";
+import type { BlobStorageCompressionType } from "./blobStorageCompressionType.js";
+import type { BlobStorageContexts } from "./blobStorageContexts.js";
+import type { BlobStorageTypes } from "./blobStorageTypes.js";
 /**
  * Interface describing a blob storage entry.
  */

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

@@ -1,7 +1,7 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
-import type { BlobStorageContexts } from "./blobStorageContexts";
-import type { IBlobStorageEntry } from "./IBlobStorageEntry";
+import type { BlobStorageContexts } from "./blobStorageContexts.js";
+import type { IBlobStorageEntry } from "./IBlobStorageEntry.js";
 /**
  * Interface describing an blob storage entry list.
  */

package/dist/types/models/api/IBlobStorageCreateRequest.d.ts

@@ -1,5 +1,5 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { BlobStorageCompressionType } from "../blobStorageCompressionType";
+import type { BlobStorageCompressionType } from "../blobStorageCompressionType.js";
 /**
  * Request to create an entry in blob storage.
  */

package/dist/types/models/api/IBlobStorageGetResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IBlobStorageEntry } from "../IBlobStorageEntry";
+import type { IBlobStorageEntry } from "../IBlobStorageEntry.js";
 /**
  * Response to get an entry from blob storage.
  */

package/dist/types/models/api/IBlobStorageListRequest.d.ts

@@ -1,6 +1,6 @@
 import type { SortDirection } from "@twin.org/entity";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IBlobStorageEntry } from "../IBlobStorageEntry";
+import type { IBlobStorageEntry } from "../IBlobStorageEntry.js";
 /**
  * Query the entries from blob storage.
  */

package/dist/types/models/api/IBlobStorageListResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IBlobStorageEntryList } from "../IBlobStorageEntryList";
+import type { IBlobStorageEntryList } from "../IBlobStorageEntryList.js";
 /**
  * Response to getting the list of entries from a query.
  */

package/docs/changelog.md

@@ -1,5 +1,29 @@
 # @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)
 
 

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -6,19 +6,11 @@ Interface describing an blob storage component.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### 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.
 
@@ -76,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`\>
@@ -98,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.
 
@@ -132,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)\>
@@ -158,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.
 
@@ -188,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`\>
@@ -208,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.
 
@@ -220,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`\>
@@ -240,7 +196,7 @@ Not found error if the blob cannot be found.
 
 ### query()
 
-> **query**(`conditions?`, `orderBy?`, `orderByDirection?`, `cursor?`, `limit?`, `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.
 
@@ -276,12 +232,6 @@ The cursor to request the next page of entries.
 
 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

@@ -6,14 +6,6 @@ Interface describing an blob storage connector.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### set()
@@ -40,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.
 
@@ -54,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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.2-next.5",
+	"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"

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 };