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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Blob Storage Models
+
+Models which define the structure of the blob storage contracts and connectors.
+
+## Installation
+
+```shell
+npm install @twin.org/blob-storage-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+var core = require('@twin.org/core');
+
+// 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");
+
+exports.BlobStorageConnectorFactory = BlobStorageConnectorFactory;

package/dist/esm/index.mjs

@@ -0,0 +1,11 @@
+import { Factory } from '@twin.org/core';
+
+// 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");
+
+export { BlobStorageConnectorFactory };

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

@@ -0,0 +1,6 @@
+import { Factory } from "@twin.org/core";
+import type { IBlobStorageConnector } from "../models/IBlobStorageConnector";
+/**
+ * Factory for creating blob storage connectors.
+ */
+export declare const BlobStorageConnectorFactory: Factory<IBlobStorageConnector>;

package/dist/types/index.d.ts

@@ -0,0 +1,10 @@
+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/IBlobStorageRemoveRequest";
+export * from "./models/api/IBlobStorageUpdateRequest";
+export * from "./models/IBlobStorageComponent";
+export * from "./models/IBlobStorageConnector";

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

@@ -0,0 +1,49 @@
+import type { IComponent } from "@twin.org/core";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Interface describing an blob storage component.
+ */
+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 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.
+     * @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>;
+    /**
+     * 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.
+     * @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;
+    }>;
+    /**
+     * 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 metadata Data for the custom metadata as JSON-LD.
+     * @returns Nothing.
+     * @throws Not found error if the blob cannot be found.
+     */
+    update(id: string, mimeType?: string, extension?: string, metadata?: IJsonLdNodeObject): Promise<void>;
+    /**
+     * Remove the blob.
+     * @param id The id of the blob to remove in urn format.
+     * @returns Nothing.
+     * @throws Not found error if the blob cannot be found.
+     */
+    remove(id: string): Promise<void>;
+}

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

@@ -0,0 +1,24 @@
+import type { IComponent } from "@twin.org/core";
+/**
+ * Interface describing an blob storage connector.
+ */
+export interface IBlobStorageConnector extends IComponent {
+    /**
+     * Set the blob.
+     * @param blob The data for the blob.
+     * @returns The id of the stored blob in urn format.
+     */
+    set(blob: Uint8Array): Promise<string>;
+    /**
+     * Get the blob.
+     * @param id The id of the blob to get in urn format.
+     * @returns The data for the blob if it can be found or undefined.
+     */
+    get(id: string): Promise<Uint8Array | undefined>;
+    /**
+     * Remove the blob.
+     * @param id The id of the blob to remove in urn format.
+     * @returns True if the blob was found.
+     */
+    remove(id: string): Promise<boolean>;
+}

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

@@ -0,0 +1,31 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Request to create an entry in blob storage.
+ */
+export interface IBlobStorageCreateRequest {
+    /**
+     * The body parameters.
+     */
+    body: {
+        /**
+         * The data to store in base64 encoding.
+         */
+        blob: string;
+        /**
+         * The mime type of the blob, will be detected if left undefined.
+         */
+        mimeType?: string;
+        /**
+         * The extension of the blob, will be detected if left undefined.
+         */
+        extension?: string;
+        /**
+         * Custom metadata to associate with the blob as JSON-LD.
+         */
+        metadata?: IJsonLdNodeObject;
+        /**
+         * The namespace to store the data in, defaults to component configured namespace.
+         */
+        namespace?: string;
+    };
+}

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

@@ -0,0 +1,30 @@
+/**
+ * Request to get the content from blob storage.
+ */
+export interface IBlobStorageGetContentRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the blob to get in urn format.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Set the download flag which should prompt the browser to save the file.
+         * Otherwise the browser should show the content inside the page.
+         * @default false
+         */
+        download?: boolean;
+        /**
+         * Set the filename to use when a download is triggered.
+         * A filename will be generated if not provided.
+         */
+        filename?: string;
+    };
+}

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

@@ -0,0 +1,9 @@
+/**
+ * Response to get an entry from blob storage.
+ */
+export interface IBlobStorageGetContentResponse {
+    /**
+     * The body parameters.
+     */
+    body: Uint8Array;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * Request to get an entry from blob storage.
+ */
+export interface IBlobStorageGetRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the blob to get in urn format.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Include the content in the response, otherwise only metadata is returned.
+         * @default false
+         */
+        includeContent?: boolean;
+    };
+}

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

@@ -0,0 +1,27 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Response to get an entry from blob storage.
+ */
+export interface IBlobStorageGetResponse {
+    /**
+     * The body parameters.
+     */
+    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;
+    };
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Request to remove an entry from blob storage.
+ */
+export interface IBlobStorageRemoveRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the blob to remove in urn format.
+         */
+        id: string;
+    };
+}

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

@@ -0,0 +1,32 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Request to update a blob entry.
+ */
+export interface IBlobStorageUpdateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The id of the blob to get in urn format.
+         */
+        id: string;
+    };
+    /**
+     * The body parameters.
+     */
+    body: {
+        /**
+         * The mime type of the blob, will be detected if left undefined.
+         */
+        mimeType?: string;
+        /**
+         * The extension of the blob, will be detected if left undefined.
+         */
+        extension?: string;
+        /**
+         * Custom metadata to associate with the blob as JSON-LD.
+         */
+        metadata?: IJsonLdNodeObject;
+    };
+}

package/docs/changelog.md

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

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/blob-storage-models - Examples

package/docs/reference/index.md

@@ -0,0 +1,17 @@
+# @twin.org/blob-storage-models
+
+## Interfaces
+
+- [IBlobStorageComponent](interfaces/IBlobStorageComponent.md)
+- [IBlobStorageConnector](interfaces/IBlobStorageConnector.md)
+- [IBlobStorageCreateRequest](interfaces/IBlobStorageCreateRequest.md)
+- [IBlobStorageGetContentRequest](interfaces/IBlobStorageGetContentRequest.md)
+- [IBlobStorageGetContentResponse](interfaces/IBlobStorageGetContentResponse.md)
+- [IBlobStorageGetRequest](interfaces/IBlobStorageGetRequest.md)
+- [IBlobStorageGetResponse](interfaces/IBlobStorageGetResponse.md)
+- [IBlobStorageRemoveRequest](interfaces/IBlobStorageRemoveRequest.md)
+- [IBlobStorageUpdateRequest](interfaces/IBlobStorageUpdateRequest.md)
+
+## Variables
+
+- [BlobStorageConnectorFactory](variables/BlobStorageConnectorFactory.md)

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -0,0 +1,155 @@
+# Interface: IBlobStorageComponent
+
+Interface describing an blob storage component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### create()
+
+> **create**(`blob`, `mimeType`?, `extension`?, `metadata`?, `namespace`?, `nodeIdentity`?): `Promise`\<`string`\>
+
+Create the blob with some metadata.
+
+#### Parameters
+
+• **blob**: `string`
+
+The data for the blob in base64 format.
+
+• **mimeType?**: `string`
+
+Mime type for the blob, will be detected if left undefined.
+
+• **extension?**: `string`
+
+Extension for the blob, will be detected if left undefined.
+
+• **metadata?**: `IJsonLdNodeObject`
+
+Data for the custom metadata as JSON-LD.
+
+• **namespace?**: `string`
+
+The namespace to use for storing, defaults to component configured namespace.
+
+• **nodeIdentity?**: `string`
+
+The node identity which controls the vault key.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the stored blob in urn format.
+
+***
+
+### get()
+
+> **get**(`id`, `includeContent`, `nodeIdentity`?): `Promise`\<`object`\>
+
+Get the blob and metadata.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob to get in urn format.
+
+• **includeContent**: `boolean`
+
+Include the content, or just get the metadata.
+
+• **nodeIdentity?**: `string`
+
+The node identity which controls the vault key.
+
+#### Returns
+
+`Promise`\<`object`\>
+
+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.
+
+***
+
+### update()
+
+> **update**(`id`, `mimeType`?, `extension`?, `metadata`?): `Promise`\<`void`\>
+
+Update the blob with metadata.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob metadata to update.
+
+• **mimeType?**: `string`
+
+Mime type for the blob, will be detected if left undefined.
+
+• **extension?**: `string`
+
+Extension for the blob, will be detected if left undefined.
+
+• **metadata?**: `IJsonLdNodeObject`
+
+Data for the custom metadata as JSON-LD.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+Not found error if the blob cannot be found.
+
+***
+
+### remove()
+
+> **remove**(`id`): `Promise`\<`void`\>
+
+Remove the blob.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob to remove in urn format.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Throws
+
+Not found error if the blob cannot be found.

package/docs/reference/interfaces/IBlobStorageConnector.md

@@ -0,0 +1,67 @@
+# Interface: IBlobStorageConnector
+
+Interface describing an blob storage connector.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### set()
+
+> **set**(`blob`): `Promise`\<`string`\>
+
+Set the blob.
+
+#### Parameters
+
+• **blob**: `Uint8Array`
+
+The data for the blob.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The id of the stored blob in urn format.
+
+***
+
+### get()
+
+> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\>
+
+Get the blob.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob to get in urn format.
+
+#### Returns
+
+`Promise`\<`undefined` \| `Uint8Array`\>
+
+The data for the blob if it can be found or undefined.
+
+***
+
+### remove()
+
+> **remove**(`id`): `Promise`\<`boolean`\>
+
+Remove the blob.
+
+#### Parameters
+
+• **id**: `string`
+
+The id of the blob to remove in urn format.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the blob was found.

package/docs/reference/interfaces/IBlobStorageCreateRequest.md

@@ -0,0 +1,41 @@
+# Interface: IBlobStorageCreateRequest
+
+Request to create an entry in blob storage.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The body parameters.
+
+#### blob
+
+> **blob**: `string`
+
+The data to store in base64 encoding.
+
+#### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type of the blob, will be detected if left undefined.
+
+#### extension?
+
+> `optional` **extension**: `string`
+
+The extension of the blob, will be detected if left undefined.
+
+#### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+Custom metadata to associate with the blob as JSON-LD.
+
+#### namespace?
+
+> `optional` **namespace**: `string`
+
+The namespace to store the data in, defaults to component configured namespace.

package/docs/reference/interfaces/IBlobStorageGetContentRequest.md

@@ -0,0 +1,45 @@
+# Interface: IBlobStorageGetContentRequest
+
+Request to get the content from blob storage.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the blob to get in urn format.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### download?
+
+> `optional` **download**: `boolean`
+
+Set the download flag which should prompt the browser to save the file.
+Otherwise the browser should show the content inside the page.
+
+##### Default
+
+```ts
+false
+```
+
+#### filename?
+
+> `optional` **filename**: `string`
+
+Set the filename to use when a download is triggered.
+A filename will be generated if not provided.

package/docs/reference/interfaces/IBlobStorageGetContentResponse.md

@@ -0,0 +1,11 @@
+# Interface: IBlobStorageGetContentResponse
+
+Response to get an entry from blob storage.
+
+## Properties
+
+### body
+
+> **body**: `Uint8Array`
+
+The body parameters.

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -0,0 +1,37 @@
+# Interface: IBlobStorageGetRequest
+
+Request to get an entry from blob storage.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the blob to get in urn format.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### includeContent?
+
+> `optional` **includeContent**: `boolean`
+
+Include the content in the response, otherwise only metadata is returned.
+
+##### Default
+
+```ts
+false
+```

package/docs/reference/interfaces/IBlobStorageGetResponse.md

@@ -0,0 +1,35 @@
+# Interface: IBlobStorageGetResponse
+
+Response to get an entry from blob storage.
+
+## Properties
+
+### body
+
+> **body**: `object`
+
+The body parameters.
+
+#### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type of the blob.
+
+#### extension?
+
+> `optional` **extension**: `string`
+
+The extension of the blob.
+
+#### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+Custom metadata to associate with 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/IBlobStorageRemoveRequest.md

@@ -0,0 +1,17 @@
+# Interface: IBlobStorageRemoveRequest
+
+Request to remove an entry from blob storage.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the blob to remove in urn format.

package/docs/reference/interfaces/IBlobStorageUpdateRequest.md

@@ -0,0 +1,43 @@
+# Interface: IBlobStorageUpdateRequest
+
+Request to update a blob entry.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the blob to get in urn format.
+
+***
+
+### body
+
+> **body**: `object`
+
+The body parameters.
+
+#### mimeType?
+
+> `optional` **mimeType**: `string`
+
+The mime type of the blob, will be detected if left undefined.
+
+#### extension?
+
+> `optional` **extension**: `string`
+
+The extension of the blob, will be detected if left undefined.
+
+#### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+Custom metadata to associate with the blob as JSON-LD.

package/docs/reference/variables/BlobStorageConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: BlobStorageConnectorFactory
+
+> `const` **BlobStorageConnectorFactory**: `Factory`\<[`IBlobStorageConnector`](../interfaces/IBlobStorageConnector.md)\>
+
+Factory for creating blob storage connectors.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}

package/package.json

@@ -0,0 +1,65 @@
+{
+	"name": "@twin.org/blob-storage-models",
+	"version": "0.0.1-next.3",
+	"description": "Models which define the structure of the blob storage contracts and connectors",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/blob-storage.git",
+		"directory": "packages/blob-storage-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/data-json-ld": "next"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "next",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.22.0",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}