@twin.org/blob-storage-models 0.0.1-next.3 → 0.0.1-next.30

package/dist/cjs/index.cjs

@@ -1,7 +1,123 @@
 '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 = {
+    /**
+     * Represents blob storage entry.
+     */
+    Entry: "BlobStorageEntry",
+    /**
+     * Represents blob storage entry list.
+     */
+    EntryList: "BlobStorageEntryList"
+};
+
+var type = "object";
+var properties = {
+	"@context": {
+		type: "array",
+		minItems: 2,
+		items: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/blob-storage/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
+			}
+		],
+		additionalItems: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		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."
+	},
+	blobHash: {
+		type: "string",
+		description: "The hash 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, included if the includeContent flag was set in the request."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"dateCreated",
+	"blobSize",
+	"blobHash"
+];
+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.
 /**
@@ -10,4 +126,24 @@ var core = require('@twin.org/core');
 // 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 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/"
+};
+
 exports.BlobStorageConnectorFactory = BlobStorageConnectorFactory;
+exports.BlobStorageContexts = BlobStorageContexts;
+exports.BlobStorageDataTypes = BlobStorageDataTypes;
+exports.BlobStorageTypes = BlobStorageTypes;

package/dist/esm/index.mjs

@@ -1,5 +1,121 @@
+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 = {
+    /**
+     * Represents blob storage entry.
+     */
+    Entry: "BlobStorageEntry",
+    /**
+     * Represents blob storage entry list.
+     */
+    EntryList: "BlobStorageEntryList"
+};
+
+var type = "object";
+var properties = {
+	"@context": {
+		type: "array",
+		minItems: 2,
+		items: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/blob-storage/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
+			}
+		],
+		additionalItems: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		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."
+	},
+	blobHash: {
+		type: "string",
+		description: "The hash 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, included if the includeContent flag was set in the request."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"dateCreated",
+	"blobSize",
+	"blobHash"
+];
+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 +124,21 @@ import { Factory } from '@twin.org/core';
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageConnectorFactory = Factory.createFactory("blob-storage");
 
-export { BlobStorageConnectorFactory };
+// 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/"
+};
+
+export { BlobStorageConnectorFactory, BlobStorageContexts, 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,10 +1,17 @@
+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/blobStorageContexts";
+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

@@ -1,5 +1,8 @@
 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.
  */
@@ -7,43 +10,57 @@ 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 nodeIdentity The node identity which controls the vault key.
+     * @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, 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.
      * @param includeContent Include the content, or just get the metadata.
-     * @param nodeIdentity The node identity which controls the vault key.
+     * @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.
      */
-    get(id: string, includeContent: boolean, 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): 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.
+     * @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.
      */
-    remove(id: string): Promise<void>;
+    remove(id: string, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    /**
+     * Query all the blob storage entries which match the conditions.
+     * @param conditions The conditions to match for the entries.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to descending.
+     * @param cursor The cursor to request the next page of entries.
+     * @param pageSize 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.
+     * @param nodeIdentity The node 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, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntryList>;
 }

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

@@ -0,0 +1,56 @@
+import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { BlobStorageContexts } from "./blobStorageContexts";
+import type { BlobStorageTypes } from "./blobStorageTypes";
+/**
+ * Interface describing a blob storage entry.
+ */
+export interface IBlobStorageEntry {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof BlobStorageContexts.ContextRoot,
+        typeof BlobStorageContexts.ContextRootCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * 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 hash of the data in the blob.
+     */
+    blobHash: string;
+    /**
+     * The mime type for the blob.
+     */
+    encodingFormat?: string;
+    /**
+     * The extension.
+     */
+    fileExtension?: string;
+    /**
+     * The metadata for the blob as JSON-LD.
+     */
+    metadata?: IJsonLdNodeObject;
+    /**
+     * The blob in base64 format, included if the includeContent flag was set in the request.
+     */
+    blob?: string;
+}

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

@@ -0,0 +1,29 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { BlobStorageContexts } from "./blobStorageContexts";
+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 BlobStorageContexts.ContextRoot,
+        typeof BlobStorageContexts.ContextRootCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * 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

@@ -0,0 +1,39 @@
+import type { SortDirection } from "@twin.org/entity";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IBlobStorageEntry } from "../IBlobStorageEntry";
+/**
+ * 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.
+     */
+    query?: {
+        /**
+         * The condition for the query as JSON version of EntityCondition type.
+         */
+        conditions?: string;
+        /**
+         * The order for the results, default to created.
+         */
+        orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">;
+        /**
+         * The direction for the order, defaults to desc.
+         */
+        orderByDirection?: SortDirection;
+        /**
+         * The number of entries to return per page.
+         */
+        pageSize?: number;
+        /**
+         * The cursor to get next chunk of data, returned in previous response.
+         */
+        cursor?: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+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 headers which can be used to determine the response data type.
+     */
+    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/blobStorageContexts.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The contexts of blob storage data.
+ */
+export declare const BlobStorageContexts: {
+    /**
+     * The context root for the blob storage types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/blob-storage/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of blob storage data.
+ */
+export type BlobStorageContexts = (typeof BlobStorageContexts)[keyof typeof BlobStorageContexts];

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

@@ -0,0 +1,17 @@
+/**
+ * The types of blob storage data.
+ */
+export declare const BlobStorageTypes: {
+    /**
+     * 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];