@twin.org/blob-storage-models 0.0.1-next.22 → 0.0.1-next.24

package/dist/cjs/index.cjs

@@ -11,9 +11,13 @@ var core = require('@twin.org/core');
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageTypes = {
     /**
-     * The context root for the auditable item blob storage types.
+     * 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/",
     /**
      * Represents blob storage entry.
      */
@@ -27,25 +31,21 @@ const BlobStorageTypes = {
 var type = "object";
 var properties = {
 	"@context": {
-		anyOf: [
+		type: "array",
+		minItems: 2,
+		items: [
 			{
 				type: "string",
 				"const": "https://schema.twindev.org/blob-storage/"
 			},
 			{
-				type: "array",
-				minItems: 1,
-				items: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/blob-storage/"
-					}
-				],
-				additionalItems: {
-					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-				}
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
 			}
 		],
+		additionalItems: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
 		description: "JSON-LD Context."
 	},
 	type: {
@@ -69,6 +69,10 @@ var properties = {
 		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."
@@ -77,9 +81,9 @@ var properties = {
 		type: "string",
 		description: "The extension."
 	},
-	metadata: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata for the blob as JSON-LD."
+		description: "The annotation object for the blob as JSON-LD."
 	},
 	blob: {
 		type: "string",
@@ -91,7 +95,8 @@ var required = [
 	"type",
 	"id",
 	"dateCreated",
-	"blobSize"
+	"blobSize",
+	"blobHash"
 ];
 var additionalProperties = false;
 var description = "Interface describing a blob storage entry.";

package/dist/esm/index.mjs

@@ -9,9 +9,13 @@ import { Factory } from '@twin.org/core';
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageTypes = {
     /**
-     * The context root for the auditable item blob storage types.
+     * 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/",
     /**
      * Represents blob storage entry.
      */
@@ -25,25 +29,21 @@ const BlobStorageTypes = {
 var type = "object";
 var properties = {
 	"@context": {
-		anyOf: [
+		type: "array",
+		minItems: 2,
+		items: [
 			{
 				type: "string",
 				"const": "https://schema.twindev.org/blob-storage/"
 			},
 			{
-				type: "array",
-				minItems: 1,
-				items: [
-					{
-						type: "string",
-						"const": "https://schema.twindev.org/blob-storage/"
-					}
-				],
-				additionalItems: {
-					$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-				}
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
 			}
 		],
+		additionalItems: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
 		description: "JSON-LD Context."
 	},
 	type: {
@@ -67,6 +67,10 @@ var properties = {
 		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."
@@ -75,9 +79,9 @@ var properties = {
 		type: "string",
 		description: "The extension."
 	},
-	metadata: {
+	annotationObject: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata for the blob as JSON-LD."
+		description: "The annotation object for the blob as JSON-LD."
 	},
 	blob: {
 		type: "string",
@@ -89,7 +93,8 @@ var required = [
 	"type",
 	"id",
 	"dateCreated",
-	"blobSize"
+	"blobSize",
+	"blobHash"
 ];
 var additionalProperties = false;
 var description = "Interface describing a blob storage entry.";

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

@@ -8,39 +8,39 @@ import type { IBlobStorageEntryList } from "./IBlobStorageEntryList";
  */
 export interface IBlobStorageComponent extends IComponent {
     /**
-     * Create the blob with some metadata.
+     * Create the blob with some annotation.
      * @param blob The data for the blob in base64 format.
      * @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 annotationObject Data for the custom annotation 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, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, namespace?: string, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(blob: string, encodingFormat?: string, fileExtension?: string, annotationObject?: IJsonLdNodeObject, namespace?: string, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
-     * Get the blob and metadata.
+     * Get the blob and annotation.
      * @param id The id of the blob to get in urn format.
-     * @param includeContent Include the content, or just get the metadata.
+     * @param includeContent Include the content, or just get the annotation.
      * @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.
+     * @returns The data and annotation 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<IBlobStorageEntry>;
     /**
-     * Update the blob with metadata.
-     * @param id The id of the blob metadata to update.
+     * Update the blob with annotation.
+     * @param id The id of the blob annotation 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 annotationObject Data for the custom annotation object 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, encodingFormat?: string, fileExtension?: string, metadata?: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    update(id: string, encodingFormat?: string, fileExtension?: string, annotationObject?: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<void>;
     /**
      * Remove the blob.
      * @param id The id of the blob to remove in urn format.

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

@@ -7,7 +7,11 @@ export interface IBlobStorageEntry {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof BlobStorageTypes.ContextRoot | [typeof BlobStorageTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    "@context": [
+        typeof BlobStorageTypes.ContextRoot,
+        typeof BlobStorageTypes.ContextRootCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
     /**
      * JSON-LD Type.
      */
@@ -28,6 +32,10 @@ export interface IBlobStorageEntry {
      * 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.
      */
@@ -37,9 +45,9 @@ export interface IBlobStorageEntry {
      */
     fileExtension?: string;
     /**
-     * The metadata for the blob as JSON-LD.
+     * The annotation object for the blob as JSON-LD.
      */
-    metadata?: IJsonLdNodeObject;
+    annotationObject?: IJsonLdNodeObject;
     /**
      * The blob in base64 format, included if the includeContent flag was set in the request.
      */

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

@@ -8,7 +8,11 @@ export interface IBlobStorageEntryList {
     /**
      * JSON-LD Context.
      */
-    "@context": typeof BlobStorageTypes.ContextRoot | [typeof BlobStorageTypes.ContextRoot, ...IJsonLdContextDefinitionElement[]];
+    "@context": [
+        typeof BlobStorageTypes.ContextRoot,
+        typeof BlobStorageTypes.ContextRootCommon,
+        ...IJsonLdContextDefinitionElement[]
+    ];
     /**
      * JSON-LD Type.
      */

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

@@ -20,9 +20,9 @@ export interface IBlobStorageCreateRequest {
          */
         fileExtension?: string;
         /**
-         * Custom metadata to associate with the blob as JSON-LD.
+         * Custom annotation object to associate with the blob as JSON-LD.
          */
-        metadata?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
         /**
          * The namespace to store the data in, defaults to component configured namespace.
          */

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

@@ -23,7 +23,7 @@ export interface IBlobStorageGetRequest {
      */
     query?: {
         /**
-         * Include the content in the response, otherwise only metadata is returned.
+         * Include the content in the response, otherwise only annotation is returned.
          * @default false
          */
         includeContent?: boolean;

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

@@ -25,8 +25,8 @@ export interface IBlobStorageUpdateRequest {
          */
         fileExtension?: string;
         /**
-         * Custom metadata to associate with the blob as JSON-LD.
+         * Custom annotation to associate with the blob as JSON-LD.
          */
-        metadata?: IJsonLdNodeObject;
+        annotationObject?: IJsonLdNodeObject;
     };
 }

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

@@ -3,9 +3,13 @@
  */
 export declare const BlobStorageTypes: {
     /**
-     * The context root for the auditable item blob storage types.
+     * 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/";
     /**
      * Represents blob storage entry.
      */

package/docs/changelog.md

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

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -10,9 +10,9 @@ Interface describing an blob storage component.
 
 ### create()
 
-> **create**(`blob`, `encodingFormat`?, `fileExtension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat`?, `fileExtension`?, `annotationObject`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
-Create the blob with some metadata.
+Create the blob with some annotation.
 
 #### Parameters
 
@@ -34,11 +34,11 @@ Mime type for the blob, will be detected if left undefined.
 
 Extension for the blob, will be detected if left undefined.
 
-##### metadata?
+##### annotationObject?
 
 `IJsonLdNodeObject`
 
-Data for the custom metadata as JSON-LD.
+Data for the custom annotation as JSON-LD.
 
 ##### namespace?
 
@@ -70,7 +70,7 @@ The id of the stored blob in urn format.
 
 > **get**(`id`, `includeContent`, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
-Get the blob and metadata.
+Get the blob and annotation.
 
 #### Parameters
 
@@ -84,7 +84,7 @@ The id of the blob to get in urn format.
 
 `boolean`
 
-Include the content, or just get the metadata.
+Include the content, or just get the annotation.
 
 ##### userIdentity?
 
@@ -102,7 +102,7 @@ The node identity to use with storage operations.
 
 `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
-The data and metadata for the blob if it can be found.
+The data and annotation for the blob if it can be found.
 
 #### Throws
 
@@ -112,9 +112,9 @@ Not found error if the blob cannot be found.
 
 ### update()
 
-> **update**(`id`, `encodingFormat`?, `fileExtension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat`?, `fileExtension`?, `annotationObject`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
-Update the blob with metadata.
+Update the blob with annotation.
 
 #### Parameters
 
@@ -122,7 +122,7 @@ Update the blob with metadata.
 
 `string`
 
-The id of the blob metadata to update.
+The id of the blob annotation to update.
 
 ##### encodingFormat?
 
@@ -136,11 +136,11 @@ Mime type for the blob, will be detected if left undefined.
 
 Extension for the blob, will be detected if left undefined.
 
-##### metadata?
+##### annotationObject?
 
 `IJsonLdNodeObject`
 
-Data for the custom metadata as JSON-LD.
+Data for the custom annotation object as JSON-LD.
 
 ##### userIdentity?
 

package/docs/reference/interfaces/IBlobStorageCreateRequest.md

@@ -28,11 +28,11 @@ The mime type of the blob, will be detected if left undefined.
 
 The extension of the blob, will be detected if left undefined.
 
-#### metadata?
+#### annotationObject?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-Custom metadata to associate with the blob as JSON-LD.
+Custom annotation object to associate with the blob as JSON-LD.
 
 #### namespace?
 

package/docs/reference/interfaces/IBlobStorageEntry.md

@@ -6,7 +6,7 @@ Interface describing a blob storage entry.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/blob-storage/"` \| \[`"https://schema.twindev.org/blob-storage/"`, `...IJsonLdContextDefinitionElement[]`\]
+> **@context**: \[`"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -52,6 +52,14 @@ The size of the data in the blob.
 
 ***
 
+### blobHash
+
+> **blobHash**: `string`
+
+The hash of the data in the blob.
+
+***
+
 ### encodingFormat?
 
 > `optional` **encodingFormat**: `string`
@@ -68,11 +76,11 @@ The extension.
 
 ***
 
-### metadata?
+### annotationObject?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-The metadata for the blob as JSON-LD.
+The annotation object for the blob as JSON-LD.
 
 ***
 

package/docs/reference/interfaces/IBlobStorageEntryList.md

@@ -6,7 +6,7 @@ Interface describing an blob storage entry list.
 
 ### @context
 
-> **@context**: `"https://schema.twindev.org/blob-storage/"` \| \[`"https://schema.twindev.org/blob-storage/"`, `...IJsonLdContextDefinitionElement[]`\]
+> **@context**: \[`"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -40,7 +40,7 @@ The query parameters.
 
 > `optional` **includeContent**: `boolean`
 
-Include the content in the response, otherwise only metadata is returned.
+Include the content in the response, otherwise only annotation is returned.
 
 ##### Default
 

package/docs/reference/interfaces/IBlobStorageUpdateRequest.md

@@ -36,8 +36,8 @@ The mime type of the blob, will be detected if left undefined.
 
 The extension of the blob, will be detected if left undefined.
 
-#### metadata?
+#### annotationObject?
 
-> `optional` **metadata**: `IJsonLdNodeObject`
+> `optional` **annotationObject**: `IJsonLdNodeObject`
 
-Custom metadata to associate with the blob as JSON-LD.
+Custom annotation to associate with the blob as JSON-LD.

package/docs/reference/variables/BlobStorageTypes.md

@@ -10,7 +10,13 @@ The types of blob storage data.
 
 > `readonly` **ContextRoot**: `"https://schema.twindev.org/blob-storage/"` = `"https://schema.twindev.org/blob-storage/"`
 
-The context root for the auditable item blob storage types.
+The context root for the blob storage types.
+
+### ContextRootCommon
+
+> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The context root for the common types.
 
 ### Entry
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.1-next.22",
+	"version": "0.0.1-next.24",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",