@twin.org/blob-storage-models 0.0.1-next.10 → 0.0.1-next.13

package/dist/cjs/index.cjs

@@ -1,7 +1,126 @@
 '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 types of blob storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BlobStorageTypes = {
+    /**
+     * The context root for the auditable item blob storage types.
+     */
+    ContextRoot: "https://schema.twindev.org/blob-storage/",
+    /**
+     * Represents blob storage entry.
+     */
+    Entry: "BlobStorageEntry",
+    /**
+     * Represents blob storage entry list.
+     */
+    EntryList: "BlobStorageEntryList"
+};
+
+var type = "object";
+var properties = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/blob-storage/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/blob-storage/"
+					}
+				],
+				additionalItems: {
+					type: "string"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	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."
+	},
+	encodingFormat: {
+		type: "string",
+		description: "The mime type for the blob."
+	},
+	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, if the includeContent flag was set in the request."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"dateCreated",
+	"blobSize"
+];
+var additionalProperties = false;
+var description = "Interface describing a blob storage entry.";
+var BlobStorageEntrySchema = {
+	type: type,
+	properties: properties,
+	required: required,
+	additionalProperties: additionalProperties,
+	description: description
+};
+
+// 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(BlobStorageTypes.Entry, () => ({
+            type: BlobStorageTypes.Entry,
+            defaultValue: {},
+            jsonSchema: async () => BlobStorageEntrySchema
+        }));
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -11,3 +130,5 @@ var core = require('@twin.org/core');
 const BlobStorageConnectorFactory = core.Factory.createFactory("blob-storage");
 
 exports.BlobStorageConnectorFactory = BlobStorageConnectorFactory;
+exports.BlobStorageDataTypes = BlobStorageDataTypes;
+exports.BlobStorageTypes = BlobStorageTypes;

package/dist/esm/index.mjs

@@ -1,5 +1,124 @@
+import { DataTypeHandlerFactory } from '@twin.org/data-core';
 import { Factory } from '@twin.org/core';
 
+// 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 = {
+    /**
+     * The context root for the auditable item blob storage types.
+     */
+    ContextRoot: "https://schema.twindev.org/blob-storage/",
+    /**
+     * Represents blob storage entry.
+     */
+    Entry: "BlobStorageEntry",
+    /**
+     * Represents blob storage entry list.
+     */
+    EntryList: "BlobStorageEntryList"
+};
+
+var type = "object";
+var properties = {
+	"@context": {
+		anyOf: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/blob-storage/"
+			},
+			{
+				type: "array",
+				minItems: 1,
+				items: [
+					{
+						type: "string",
+						"const": "https://schema.twindev.org/blob-storage/"
+					}
+				],
+				additionalItems: {
+					type: "string"
+				}
+			}
+		],
+		description: "JSON-LD Context."
+	},
+	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."
+	},
+	encodingFormat: {
+		type: "string",
+		description: "The mime type for the blob."
+	},
+	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, if the includeContent flag was set in the request."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"dateCreated",
+	"blobSize"
+];
+var additionalProperties = false;
+var description = "Interface describing a blob storage entry.";
+var BlobStorageEntrySchema = {
+	type: type,
+	properties: properties,
+	required: required,
+	additionalProperties: additionalProperties,
+	description: description
+};
+
+// 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(BlobStorageTypes.Entry, () => ({
+            type: BlobStorageTypes.Entry,
+            defaultValue: {},
+            jsonSchema: async () => BlobStorageEntrySchema
+        }));
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -8,4 +127,4 @@ import { Factory } from '@twin.org/core';
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageConnectorFactory = Factory.createFactory("blob-storage");
 
-export { BlobStorageConnectorFactory };
+export { BlobStorageConnectorFactory, BlobStorageDataTypes, BlobStorageTypes };

package/dist/types/dataTypes/blobStorageDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the data types for blob storage.
+ */
+export declare class BlobStorageDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./dataTypes/blobStorageDataTypes";
 export * from "./factories/blobStorageConnectorFactory";
 export * from "./models/api/IBlobStorageCreateRequest";
 export * from "./models/api/IBlobStorageGetContentRequest";
@@ -8,6 +9,8 @@ export * from "./models/api/IBlobStorageListRequest";
 export * from "./models/api/IBlobStorageListResponse";
 export * from "./models/api/IBlobStorageRemoveRequest";
 export * from "./models/api/IBlobStorageUpdateRequest";
+export * from "./models/blobStorageTypes";
 export * from "./models/IBlobStorageComponent";
 export * from "./models/IBlobStorageConnector";
 export * from "./models/IBlobStorageEntry";
+export * from "./models/IBlobStorageEntryList";

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

@@ -2,6 +2,7 @@ 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 { IBlobStorageEntry } from "./IBlobStorageEntry";
+import type { IBlobStorageEntryList } from "./IBlobStorageEntryList";
 /**
  * Interface describing an blob storage component.
  */
@@ -9,15 +10,15 @@ export interface IBlobStorageComponent extends IComponent {
     /**
      * Create the blob with some metadata.
      * @param blob The data for the blob in base64 format.
-     * @param mimeType Mime type for the blob, will be detected if left undefined.
-     * @param extension Extension for the blob, will be detected if left undefined.
+     * @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 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, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject, namespace?: string, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(blob: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, namespace?: string, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
      * Get the blob and metadata.
      * @param id The id of the blob to get in urn format.
@@ -27,24 +28,19 @@ export interface IBlobStorageComponent extends IComponent {
      * @returns The data and metadata for the blob if it can be found.
      * @throws Not found error if the blob cannot be found.
      */
-    get(id: string, includeContent: boolean, userIdentity?: string, nodeIdentity?: string): Promise<{
-        blob?: string;
-        mimeType?: string;
-        extension?: string;
-        metadata?: IJsonLdNodeObject;
-    }>;
+    get(id: string, includeContent: boolean, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntry>;
     /**
      * Update the blob with metadata.
      * @param id The id of the blob metadata to update.
-     * @param mimeType Mime type for the blob, will be detected if left undefined.
-     * @param extension Extension for the blob, will be detected if left undefined.
+     * @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.
      * @param nodeIdentity The node identity to use with storage operations.
      * @returns Nothing.
      * @throws Not found error if the blob cannot be found.
      */
-    update(id: string, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    update(id: string, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<void>;
     /**
      * Remove the blob.
      * @param id The id of the blob to remove in urn format.
@@ -66,16 +62,7 @@ export interface IBlobStorageComponent extends IComponent {
      * and a cursor which can be used to request more entities.
      */
     query(conditions?: EntityCondition<IBlobStorageEntry>, sortProperties?: {
-        property: keyof IBlobStorageEntry;
+        property: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">;
         sortDirection: SortDirection;
-    }[], cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<{
-        /**
-         * The entities.
-         */
-        entities: IBlobStorageEntry[];
-        /**
-         * An optional cursor, when defined can be used to call find to get more entities.
-         */
-        cursor?: string;
-    }>;
+    }[], cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntryList>;
 }

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

@@ -1,22 +1,47 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { BlobStorageTypes } from "./blobStorageTypes";
 /**
  * Interface describing a blob storage entry.
  */
 export interface IBlobStorageEntry {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof BlobStorageTypes.ContextRoot | [typeof BlobStorageTypes.ContextRoot, ...string[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof BlobStorageTypes.Entry;
     /**
      * The id for the blob.
      */
     id: string;
+    /**
+     * The date/time when the entry was created.
+     */
+    dateCreated: string;
+    /**
+     * The date/time when the entry was modified.
+     */
+    dateModified?: string;
+    /**
+     * The size of the data in the blob.
+     */
+    blobSize: number;
     /**
      * The mime type for the blob.
      */
-    mimeType?: string;
+    encodingFormat?: string;
     /**
      * The extension.
      */
-    extension?: string;
+    fileExtension?: string;
     /**
      * The metadata for the blob as JSON-LD.
      */
     metadata?: IJsonLdNodeObject;
+    /**
+     * The blob in base64 format, if the includeContent flag was set in the request.
+     */
+    blob?: string;
 }

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

@@ -0,0 +1,23 @@
+import type { BlobStorageTypes } from "./blobStorageTypes";
+import type { IBlobStorageEntry } from "./IBlobStorageEntry";
+/**
+ * Interface describing an blob storage entry list.
+ */
+export interface IBlobStorageEntryList {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": typeof BlobStorageTypes.ContextRoot | [typeof BlobStorageTypes.ContextRoot, ...string[]];
+    /**
+     * JSON-LD Type.
+     */
+    type: typeof BlobStorageTypes.EntryList;
+    /**
+     * The list of entries.
+     */
+    entries: IBlobStorageEntry[];
+    /**
+     * The cursor to get the next chunk of entries.
+     */
+    cursor?: string;
+}

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

@@ -14,11 +14,11 @@ export interface IBlobStorageCreateRequest {
         /**
          * The mime type of the blob, will be detected if left undefined.
          */
-        mimeType?: string;
+        encodingFormat?: string;
         /**
          * The extension of the blob, will be detected if left undefined.
          */
-        extension?: string;
+        fileExtension?: string;
         /**
          * Custom metadata to associate with the blob as JSON-LD.
          */

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

@@ -1,7 +1,14 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * Request to get an entry from blob storage.
  */
 export interface IBlobStorageGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
     /**
      * The path parameters.
      */

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

@@ -1,27 +1,17 @@
-import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IBlobStorageEntry } from "../IBlobStorageEntry";
 /**
  * Response to get an entry from blob storage.
  */
 export interface IBlobStorageGetResponse {
     /**
-     * The body parameters.
+     * The headers which can be used to determine the response data type.
      */
-    body: {
-        /**
-         * The mime type of the blob.
-         */
-        mimeType?: string;
-        /**
-         * The extension of the blob.
-         */
-        extension?: string;
-        /**
-         * Custom metadata to associate with the blob as JSON-LD.
-         */
-        metadata?: IJsonLdNodeObject;
-        /**
-         * The blob in base64 format, if the includeContent flag was set in the request.
-         */
-        blob?: string;
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
+    /**
+     * The body parameters.
+     */
+    body: IBlobStorageEntry;
 }

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

@@ -1,7 +1,14 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * Query the entries from blob storage.
  */
 export interface IBlobStorageListRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
     /**
      * The parameters from the query.
      */

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

@@ -1,19 +1,17 @@
-import type { IBlobStorageEntry } from "../IBlobStorageEntry";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IBlobStorageEntryList } from "../IBlobStorageEntryList";
 /**
  * Response to getting the list of entries from a query.
  */
 export interface IBlobStorageListResponse {
     /**
-     * The list of entries from the query.
+     * The headers which can be used to determine the response data type.
      */
-    body: {
-        /**
-         * The entities from the query.
-         */
-        entities: IBlobStorageEntry[];
-        /**
-         * The cursor for the next page.
-         */
-        cursor?: string;
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
+    /**
+     * The list of entries from the query.
+     */
+    body: IBlobStorageEntryList;
 }

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

@@ -19,11 +19,11 @@ export interface IBlobStorageUpdateRequest {
         /**
          * The mime type of the blob, will be detected if left undefined.
          */
-        mimeType?: string;
+        encodingFormat?: string;
         /**
          * The extension of the blob, will be detected if left undefined.
          */
-        extension?: string;
+        fileExtension?: string;
         /**
          * Custom metadata to associate with the blob as JSON-LD.
          */

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

@@ -0,0 +1,21 @@
+/**
+ * The types of blob storage data.
+ */
+export declare const BlobStorageTypes: {
+    /**
+     * The context root for the auditable item blob storage types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/blob-storage/";
+    /**
+     * Represents blob storage entry.
+     */
+    readonly Entry: "BlobStorageEntry";
+    /**
+     * Represents blob storage entry list.
+     */
+    readonly EntryList: "BlobStorageEntryList";
+};
+/**
+ * The types of blob storage data.
+ */
+export type BlobStorageTypes = (typeof BlobStorageTypes)[keyof typeof BlobStorageTypes];

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/blob-storage-models - Changelog
 
-## v0.0.1-next.10
+## v0.0.1-next.13
 
 - Initial Release

package/docs/reference/classes/BlobStorageDataTypes.md

@@ -0,0 +1,25 @@
+# Class: BlobStorageDataTypes
+
+Handle all the data types for blob storage.
+
+## Constructors
+
+### new BlobStorageDataTypes()
+
+> **new BlobStorageDataTypes**(): [`BlobStorageDataTypes`](BlobStorageDataTypes.md)
+
+#### Returns
+
+[`BlobStorageDataTypes`](BlobStorageDataTypes.md)
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -1,10 +1,15 @@
 # @twin.org/blob-storage-models
 
+## Classes
+
+- [BlobStorageDataTypes](classes/BlobStorageDataTypes.md)
+
 ## Interfaces
 
 - [IBlobStorageComponent](interfaces/IBlobStorageComponent.md)
 - [IBlobStorageConnector](interfaces/IBlobStorageConnector.md)
 - [IBlobStorageEntry](interfaces/IBlobStorageEntry.md)
+- [IBlobStorageEntryList](interfaces/IBlobStorageEntryList.md)
 - [IBlobStorageCreateRequest](interfaces/IBlobStorageCreateRequest.md)
 - [IBlobStorageGetContentRequest](interfaces/IBlobStorageGetContentRequest.md)
 - [IBlobStorageGetContentResponse](interfaces/IBlobStorageGetContentResponse.md)
@@ -15,6 +20,11 @@
 - [IBlobStorageRemoveRequest](interfaces/IBlobStorageRemoveRequest.md)
 - [IBlobStorageUpdateRequest](interfaces/IBlobStorageUpdateRequest.md)
 
+## Type Aliases
+
+- [BlobStorageTypes](type-aliases/BlobStorageTypes.md)
+
 ## Variables
 
 - [BlobStorageConnectorFactory](variables/BlobStorageConnectorFactory.md)
+- [BlobStorageTypes](variables/BlobStorageTypes.md)

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -10,7 +10,7 @@ Interface describing an blob storage component.
 
 ### create()
 
-> **create**(`blob`, `mimeType`?, `extension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat`?, `fileExtension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 Create the blob with some metadata.
 
@@ -20,11 +20,11 @@ Create the blob with some metadata.
 
 The data for the blob in base64 format.
 
-• **mimeType?**: `string`
+• **encodingFormat?**: `string`
 
 Mime type for the blob, will be detected if left undefined.
 
-• **extension?**: `string`
+• **fileExtension?**: `string`
 
 Extension for the blob, will be detected if left undefined.
 
@@ -54,7 +54,7 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`, `includeContent`, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
+> **get**(`id`, `includeContent`, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
 Get the blob and metadata.
 
@@ -78,26 +78,10 @@ The node identity to use with storage operations.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
 The data and metadata for the blob if it can be found.
 
-##### blob?
-
-> `optional` **blob**: `string`
-
-##### mimeType?
-
-> `optional` **mimeType**: `string`
-
-##### extension?
-
-> `optional` **extension**: `string`
-
-##### metadata?
-
-> `optional` **metadata**: `IJsonLdNodeObject`
-
 #### Throws
 
 Not found error if the blob cannot be found.
@@ -106,7 +90,7 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `mimeType`?, `extension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat`?, `fileExtension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
 Update the blob with metadata.
 
@@ -116,11 +100,11 @@ Update the blob with metadata.
 
 The id of the blob metadata to update.
 
-• **mimeType?**: `string`
+• **encodingFormat?**: `string`
 
 Mime type for the blob, will be detected if left undefined.
 
-• **extension?**: `string`
+• **fileExtension?**: `string`
 
 Extension for the blob, will be detected if left undefined.
 
@@ -182,7 +166,7 @@ Not found error if the blob cannot be found.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`object`\>
+> **query**(`conditions`?, `sortProperties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -214,19 +198,7 @@ The node identity to use with storage operations.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<[`IBlobStorageEntryList`](IBlobStorageEntryList.md)\>
 
 All the entries for the storage matching the conditions,
 and a cursor which can be used to request more entities.
-
-##### entities
-
-> **entities**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
-
-The entities.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.

package/docs/reference/interfaces/IBlobStorageCreateRequest.md

@@ -16,15 +16,15 @@ The body parameters.
 
 The data to store in base64 encoding.
 
-#### mimeType?
+#### encodingFormat?
 
-> `optional` **mimeType**: `string`
+> `optional` **encodingFormat**: `string`
 
 The mime type of the blob, will be detected if left undefined.
 
-#### extension?
+#### fileExtension?
 
-> `optional` **extension**: `string`
+> `optional` **fileExtension**: `string`
 
 The extension of the blob, will be detected if left undefined.
 

package/docs/reference/interfaces/IBlobStorageEntry.md

@@ -4,6 +4,22 @@ Interface describing a blob storage entry.
 
 ## Properties
 
+### @context
+
+> **@context**: `"https://schema.twindev.org/blob-storage/"` \| [`"https://schema.twindev.org/blob-storage/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"BlobStorageEntry"`
+
+JSON-LD Type.
+
+***
+
 ### id
 
 > **id**: `string`
@@ -12,17 +28,41 @@ The id for the blob.
 
 ***
 
-### mimeType?
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time when the entry was created.
+
+***
+
+### dateModified?
 
-> `optional` **mimeType**: `string`
+> `optional` **dateModified**: `string`
+
+The date/time when the entry was modified.
+
+***
+
+### blobSize
+
+> **blobSize**: `number`
+
+The size of the data in the blob.
+
+***
+
+### encodingFormat?
+
+> `optional` **encodingFormat**: `string`
 
 The mime type for the blob.
 
 ***
 
-### extension?
+### fileExtension?
 
-> `optional` **extension**: `string`
+> `optional` **fileExtension**: `string`
 
 The extension.
 
@@ -33,3 +73,11 @@ The extension.
 > `optional` **metadata**: `IJsonLdNodeObject`
 
 The metadata for the blob as JSON-LD.
+
+***
+
+### blob?
+
+> `optional` **blob**: `string`
+
+The blob in base64 format, if the includeContent flag was set in the request.

package/docs/reference/interfaces/IBlobStorageEntryList.md

@@ -0,0 +1,35 @@
+# Interface: IBlobStorageEntryList
+
+Interface describing an blob storage entry list.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/blob-storage/"` \| [`"https://schema.twindev.org/blob-storage/"`, `...string[]`]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"BlobStorageEntryList"`
+
+JSON-LD Type.
+
+***
+
+### entries
+
+> **entries**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
+
+The list of entries.
+
+***
+
+### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get the next chunk of entries.

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -4,6 +4,18 @@ Request to get an entry from blob storage.
 
 ## Properties
 
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
 ### pathParams
 
 > **pathParams**: `object`

package/docs/reference/interfaces/IBlobStorageGetResponse.md

@@ -4,32 +4,20 @@ Response to get an entry from blob storage.
 
 ## Properties
 
-### body
-
-> **body**: `object`
-
-The body parameters.
-
-#### mimeType?
+### headers?
 
-> `optional` **mimeType**: `string`
+> `optional` **headers**: `object`
 
-The mime type of the blob.
+The headers which can be used to determine the response data type.
 
-#### extension?
+#### content-type
 
-> `optional` **extension**: `string`
+> **content-type**: `"application/json"` \| `"application/ld+json"`
 
-The extension of the blob.
+***
 
-#### metadata?
-
-> `optional` **metadata**: `IJsonLdNodeObject`
-
-Custom metadata to associate with the blob as JSON-LD.
-
-#### blob?
+### body
 
-> `optional` **blob**: `string`
+> **body**: [`IBlobStorageEntry`](IBlobStorageEntry.md)
 
-The blob in base64 format, if the includeContent flag was set in the request.
+The body parameters.

package/docs/reference/interfaces/IBlobStorageListRequest.md

@@ -4,6 +4,18 @@ Query the entries from blob storage.
 
 ## Properties
 
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
 ### query?
 
 > `optional` **query**: `object`

package/docs/reference/interfaces/IBlobStorageListResponse.md

@@ -4,20 +4,20 @@ Response to getting the list of entries from a query.
 
 ## Properties
 
-### body
+### headers?
 
-> **body**: `object`
+> `optional` **headers**: `object`
 
-The list of entries from the query.
+The headers which can be used to determine the response data type.
 
-#### entities
+#### content-type
 
-> **entities**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
+> **content-type**: `"application/json"` \| `"application/ld+json"`
 
-The entities from the query.
+***
 
-#### cursor?
+### body
 
-> `optional` **cursor**: `string`
+> **body**: [`IBlobStorageEntryList`](IBlobStorageEntryList.md)
 
-The cursor for the next page.
+The list of entries from the query.

package/docs/reference/interfaces/IBlobStorageUpdateRequest.md

@@ -24,15 +24,15 @@ The id of the blob to get in urn format.
 
 The body parameters.
 
-#### mimeType?
+#### encodingFormat?
 
-> `optional` **mimeType**: `string`
+> `optional` **encodingFormat**: `string`
 
 The mime type of the blob, will be detected if left undefined.
 
-#### extension?
+#### fileExtension?
 
-> `optional` **extension**: `string`
+> `optional` **fileExtension**: `string`
 
 The extension of the blob, will be detected if left undefined.
 

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

@@ -0,0 +1,5 @@
+# Type Alias: BlobStorageTypes
+
+> **BlobStorageTypes**: *typeof* [`BlobStorageTypes`](../variables/BlobStorageTypes.md)\[keyof *typeof* [`BlobStorageTypes`](../variables/BlobStorageTypes.md)\]
+
+The types of blob storage data.

package/docs/reference/variables/BlobStorageTypes.md

@@ -0,0 +1,25 @@
+# Variable: BlobStorageTypes
+
+> `const` **BlobStorageTypes**: `object`
+
+The types of blob storage data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/blob-storage/"` = `"https://schema.twindev.org/blob-storage/"`
+
+The context root for the auditable item blob storage types.
+
+### Entry
+
+> `readonly` **Entry**: `"BlobStorageEntry"` = `"BlobStorageEntry"`
+
+Represents blob storage entry.
+
+### EntryList
+
+> `readonly` **EntryList**: `"BlobStorageEntryList"` = `"BlobStorageEntryList"`
+
+Represents blob storage entry list.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.1-next.10",
+	"version": "0.0.1-next.13",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -15,9 +15,11 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/nameof": "next"
+		"@twin.org/nameof": "next",
+		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",