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

package/dist/types/blobStorageRoutes.d.ts

@@ -1,5 +1,5 @@
-import type { ICreatedResponse, IHttpRequestContext, INoContentResponse, IRestRoute, IRestRouteResponseOptions, ITag } from "@twin.org/api-models";
-import type { IBlobStorageCreateRequest, IBlobStorageGetContentRequest, IBlobStorageGetContentResponse, IBlobStorageGetRequest, IBlobStorageGetResponse, IBlobStorageRemoveRequest, IBlobStorageUpdateRequest } from "@twin.org/blob-storage-models";
+import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type IRestRouteResponseOptions, type ITag } from "@twin.org/api-models";
+import { type IBlobStorageCreateRequest, type IBlobStorageGetContentRequest, type IBlobStorageGetContentResponse, type IBlobStorageGetRequest, type IBlobStorageGetResponse, type IBlobStorageListRequest, type IBlobStorageListResponse, type IBlobStorageRemoveRequest, type IBlobStorageUpdateRequest } from "@twin.org/blob-storage-models";
 /**
  * The tag to associate with the routes.
  */
@@ -8,9 +8,15 @@ export declare const tagsBlobStorage: ITag[];
  * The REST routes for blob storage.
  * @param baseRouteName Prefix to prepend to the paths.
  * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @param options Additional options for the routes.
+ * @param options.typeName Optional type name to use in the routes, defaults to Blob Storage.
+ * @param options.tagName Optional name to use in OpenAPI spec for tag.
  * @returns The generated routes.
  */
-export declare function generateRestRoutesBlobStorage(baseRouteName: string, componentName: string): IRestRoute[];
+export declare function generateRestRoutesBlobStorage(baseRouteName: string, componentName: string, options?: {
+    typeName?: string;
+    tagName?: string;
+}): IRestRoute[];
 /**
  * Create a blob in storage.
  * @param httpRequestContext The request context for the API.
@@ -51,3 +57,11 @@ export declare function blobStorageUpdate(httpRequestContext: IHttpRequestContex
  * @returns The response object with additional http response properties.
  */
 export declare function blobStorageRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IBlobStorageRemoveRequest): Promise<INoContentResponse>;
+/**
+ * List the entries from blob storage.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function blobStorageList(httpRequestContext: IHttpRequestContext, componentName: string, request: IBlobStorageListRequest): Promise<IBlobStorageListResponse>;

package/dist/types/blobStorageService.d.ts

@@ -1,6 +1,7 @@
-import { type IBlobStorageComponent } from "@twin.org/blob-storage-models";
+import { type IBlobStorageComponent, type IBlobStorageEntry, type IBlobStorageEntryList } from "@twin.org/blob-storage-models";
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IBlobStorageServiceConfig } from "./models/IBlobStorageServiceConfig";
+import { SortDirection, type EntityCondition } from "@twin.org/entity";
+import type { IBlobStorageServiceConstructorOptions } from "./models/IBlobStorageServiceConstructorOptions";
 /**
  * Service for performing blob storage operations to a connector.
  */
@@ -15,55 +16,62 @@ export declare class BlobStorageService implements IBlobStorageComponent {
     readonly CLASS_NAME: string;
     /**
      * Create a new instance of BlobStorageService.
-     * @param options The dependencies for the service.
-     * @param options.metadataEntityStorageType The type of the storage connector for the metadata, defaults to "blob-metadata".
-     * @param options.vaultConnectorType The type of the vault connector for encryption, if undefined no encryption will be performed.
-     * @param options.config The configuration for the service.
+     * @param options The options for the service.
      */
-    constructor(options?: {
-        metadataEntityStorageType?: string;
-        vaultConnectorType?: string;
-        config?: IBlobStorageServiceConfig;
-    });
+    constructor(options?: IBlobStorageServiceConstructorOptions);
     /**
      * 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.
+     * Get the blob entry.
      * @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 metadata and data for the blob if it can be found.
+     * @param userIdentity The user identity to use with storage operations.
+     * @param nodeIdentity The node identity to use with storage operations.
+     * @returns The entry and data 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 id The id of the blob entry 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 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.
      */
-    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/entities/blobStorageEntry.d.ts

@@ -0,0 +1,46 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Class representing entry for the blob storage.
+ */
+export declare class BlobStorageEntry {
+    /**
+     * 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 length 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 user identity that created the blob.
+     */
+    userIdentity?: string;
+    /**
+     * The node identity that created the blob.
+     */
+    nodeIdentity?: string;
+}

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./blobStorageRoutes";
 export * from "./blobStorageService";
-export * from "./entities/blobMetadata";
+export * from "./entities/blobStorageEntry";
 export * from "./models/IBlobStorageServiceConfig";
+export * from "./models/IBlobStorageServiceConstructorOptions";
 export * from "./restEntryPoints";
 export * from "./schema";

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

@@ -12,4 +12,12 @@ export interface IBlobStorageServiceConfig {
      * Defaults to the first entry in the factory if not provided.
      */
     defaultNamespace?: string;
+    /**
+     * Include the node identity when performing storage operations, defaults to true.
+     */
+    includeNodeIdentity?: boolean;
+    /**
+     * Include the user identity when performing storage operations, defaults to true.
+     */
+    includeUserIdentity?: boolean;
 }

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

@@ -0,0 +1,19 @@
+import type { IBlobStorageServiceConfig } from "./IBlobStorageServiceConfig";
+/**
+ * Options for the Blob Storage Service constructor.
+ */
+export interface IBlobStorageServiceConstructorOptions {
+    /**
+     * The type of the storage connector for the metadata.
+     * @default blob-storage-entry
+     */
+    entryEntityStorageType?: string;
+    /**
+     * The type of the vault connector for encryption, if undefined no encryption will be performed.
+     */
+    vaultConnectorType?: string;
+    /**
+     * The configuration for the service.
+     */
+    config?: IBlobStorageServiceConfig;
+}

package/dist/types/restEntryPoints.d.ts

@@ -1,2 +1,7 @@
 import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+/**
+ * These are dummy entry points for the blob storage service.
+ * In reality your application would create its own entry points based on the
+ * blob types it wants to store, using a custom defaultBaseRoute.
+ */
 export declare const restEntryPoints: IRestRouteEntryPoint[];

package/docs/changelog.md

@@ -1,5 +1,37 @@
 # @twin.org/blob-storage-service - Changelog
 
-## v0.0.1-next.3
+## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.29...blob-storage-service-v0.0.1-next.30) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#12](https://github.com/twinfoundation/blob-storage/issues/12)) ([cae8110](https://github.com/twinfoundation/blob-storage/commit/cae8110681847a1ac4fcac968b8196694e49c320))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
+  * devDependencies
+    * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.28...blob-storage-service-v0.0.1-next.29) (2025-03-28)
+
+
+### Bug Fixes
+
+* Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/blob-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+  * devDependencies
+    * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## v0.0.1-next.28
 
 - Initial Release