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

package/dist/cjs/index.cjs

@@ -81,9 +81,9 @@ var properties = {
 		type: "string",
 		description: "The extension."
 	},
-	annotationObject: {
+	metadata: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The annotation object for the blob as JSON-LD."
+		description: "The metadata for the blob as JSON-LD."
 	},
 	blob: {
 		type: "string",

package/dist/esm/index.mjs

@@ -79,9 +79,9 @@ var properties = {
 		type: "string",
 		description: "The extension."
 	},
-	annotationObject: {
+	metadata: {
 		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The annotation object for the blob as JSON-LD."
+		description: "The metadata for the blob as JSON-LD."
 	},
 	blob: {
 		type: "string",

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 annotation.
+     * Create the blob with some metadata.
      * @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 annotationObject Data for the custom annotation as JSON-LD.
+     * @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, encodingFormat?: string, fileExtension?: string, annotationObject?: 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 annotation.
+     * 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 annotation.
+     * @param includeContent Include the content, or just get the metadata.
      * @param userIdentity The user identity to use with storage operations.
      * @param nodeIdentity The node identity to use with storage operations.
-     * @returns The data and annotation for the blob if it can be found.
+     * @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<IBlobStorageEntry>;
     /**
-     * Update the blob with annotation.
-     * @param id The id of the blob annotation to update.
+     * Update the blob with metadata.
+     * @param id The id of the blob metadata to update.
      * @param encodingFormat Mime type for the blob, will be detected if left undefined.
      * @param fileExtension Extension for the blob, will be detected if left undefined.
-     * @param annotationObject Data for the custom annotation object as JSON-LD.
+     * @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, encodingFormat?: string, fileExtension?: string, annotationObject?: 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.

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

@@ -45,9 +45,9 @@ export interface IBlobStorageEntry {
      */
     fileExtension?: string;
     /**
-     * The annotation object for the blob as JSON-LD.
+     * The metadata for the blob as JSON-LD.
      */
-    annotationObject?: IJsonLdNodeObject;
+    metadata?: IJsonLdNodeObject;
     /**
      * The blob in base64 format, included if the includeContent flag was set in the request.
      */

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

@@ -20,9 +20,9 @@ export interface IBlobStorageCreateRequest {
          */
         fileExtension?: string;
         /**
-         * Custom annotation object to associate with the blob as JSON-LD.
+         * Custom metadata to associate with the blob as JSON-LD.
          */
-        annotationObject?: IJsonLdNodeObject;
+        metadata?: 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 annotation is returned.
+         * Include the content in the response, otherwise only metadata is returned.
          * @default false
          */
         includeContent?: boolean;

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

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

package/docs/changelog.md

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

package/docs/reference/interfaces/IBlobStorageComponent.md

@@ -10,9 +10,9 @@ Interface describing an blob storage component.
 
 ### create()
 
-> **create**(`blob`, `encodingFormat`?, `fileExtension`?, `annotationObject`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`blob`, `encodingFormat`?, `fileExtension`?, `metadata`?, `namespace`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
-Create the blob with some annotation.
+Create the blob with some metadata.
 
 #### 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.
 
-##### annotationObject?
+##### metadata?
 
 `IJsonLdNodeObject`
 
-Data for the custom annotation as JSON-LD.
+Data for the custom metadata 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 annotation.
+Get the blob and metadata.
 
 #### Parameters
 
@@ -84,7 +84,7 @@ The id of the blob to get in urn format.
 
 `boolean`
 
-Include the content, or just get the annotation.
+Include the content, or just get the metadata.
 
 ##### userIdentity?
 
@@ -102,7 +102,7 @@ The node identity to use with storage operations.
 
 `Promise`\<[`IBlobStorageEntry`](IBlobStorageEntry.md)\>
 
-The data and annotation for the blob if it can be found.
+The data and metadata 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`?, `annotationObject`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **update**(`id`, `encodingFormat`?, `fileExtension`?, `metadata`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
 
-Update the blob with annotation.
+Update the blob with metadata.
 
 #### Parameters
 
@@ -122,7 +122,7 @@ Update the blob with annotation.
 
 `string`
 
-The id of the blob annotation to update.
+The id of the blob metadata 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.
 
-##### annotationObject?
+##### metadata?
 
 `IJsonLdNodeObject`
 
-Data for the custom annotation object as JSON-LD.
+Data for the custom metadata 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.
 
-#### annotationObject?
+#### metadata?
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **metadata**: `IJsonLdNodeObject`
 
-Custom annotation object to associate with the blob as JSON-LD.
+Custom metadata to associate with the blob as JSON-LD.
 
 #### namespace?
 

package/docs/reference/interfaces/IBlobStorageEntry.md

@@ -76,11 +76,11 @@ The extension.
 
 ***
 
-### annotationObject?
+### metadata?
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **metadata**: `IJsonLdNodeObject`
 
-The annotation object for the blob as JSON-LD.
+The metadata for the blob as JSON-LD.
 
 ***
 

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -40,7 +40,7 @@ The query parameters.
 
 > `optional` **includeContent**: `boolean`
 
-Include the content in the response, otherwise only annotation is returned.
+Include the content in the response, otherwise only metadata 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.
 
-#### annotationObject?
+#### metadata?
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **metadata**: `IJsonLdNodeObject`
 
-Custom annotation to associate with the blob as JSON-LD.
+Custom metadata to associate with the blob as JSON-LD.

package/package.json

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