@twin.org/auditable-item-stream-service 0.0.3-next.9 → 0.9.0

package/dist/types/auditableItemStreamRoutes.d.ts

@@ -1,5 +1,5 @@
 import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type ITag } from "@twin.org/api-models";
-import { type IAuditableItemStreamCreateEntryRequest, type IAuditableItemStreamCreateRequest, type IAuditableItemStreamDeleteEntryRequest, type IAuditableItemStreamDeleteRequest, type IAuditableItemStreamGetEntryObjectRequest, type IAuditableItemStreamGetEntryObjectResponse, type IAuditableItemStreamGetEntryRequest, type IAuditableItemStreamGetEntryResponse, type IAuditableItemStreamGetRequest, type IAuditableItemStreamGetResponse, type IAuditableItemStreamListEntriesRequest, type IAuditableItemStreamListEntriesResponse, type IAuditableItemStreamListEntryObjectsRequest, type IAuditableItemStreamListEntryObjectsResponse, type IAuditableItemStreamListRequest, type IAuditableItemStreamListResponse, type IAuditableItemStreamUpdateEntryRequest, type IAuditableItemStreamUpdateRequest } from "@twin.org/auditable-item-stream-models";
+import { type IAuditableItemStreamListEntriesNoStreamRequest, type IAuditableItemStreamListEntryObjectsNoStreamRequest, type IAuditableItemStreamCloseRequest, type IAuditableItemStreamCreateEntryRequest, type IAuditableItemStreamCreateRequest, type IAuditableItemStreamDeleteEntryRequest, type IAuditableItemStreamDeleteRequest, type IAuditableItemStreamGetEntryObjectRequest, type IAuditableItemStreamGetEntryObjectResponse, type IAuditableItemStreamGetEntryRequest, type IAuditableItemStreamGetEntryResponse, type IAuditableItemStreamGetRequest, type IAuditableItemStreamGetResponse, type IAuditableItemStreamListEntriesRequest, type IAuditableItemStreamListEntriesResponse, type IAuditableItemStreamListEntryObjectsRequest, type IAuditableItemStreamListEntryObjectsResponse, type IAuditableItemStreamListRequest, type IAuditableItemStreamListResponse, type IAuditableItemStreamRemoveProofRequest, type IAuditableItemStreamUpdateEntryRequest, type IAuditableItemStreamUpdateRequest } from "@twin.org/auditable-item-stream-models";
 /**
  * The tag to associate with the routes.
  */
@@ -44,7 +44,15 @@ export declare function auditableItemStreamUpdate(httpRequestContext: IHttpReque
  */
 export declare function auditableItemStreamDelete(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamDeleteRequest): Promise<INoContentResponse>;
 /**
- * Query the stream.
+ * Close the stream.
+ * @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 auditableItemStreamClose(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamCloseRequest): Promise<INoContentResponse>;
+/**
+ * List all streams.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -60,7 +68,7 @@ export declare function auditableItemStreamList(httpRequestContext: IHttpRequest
  */
 export declare function auditableItemStreamCreateEntry(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamCreateEntryRequest): Promise<ICreatedResponse>;
 /**
- * Get the stream.
+ * Delete an entry from the stream.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -92,7 +100,7 @@ export declare function auditableItemStreamGetEntry(httpRequestContext: IHttpReq
  */
 export declare function auditableItemStreamGetEntryObject(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamGetEntryObjectRequest): Promise<IAuditableItemStreamGetEntryObjectResponse>;
 /**
- * Query the stream.
+ * List the entries for a stream.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
@@ -100,10 +108,34 @@ export declare function auditableItemStreamGetEntryObject(httpRequestContext: IH
  */
 export declare function auditableItemStreamListEntries(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamListEntriesRequest): Promise<IAuditableItemStreamListEntriesResponse>;
 /**
- * Query the stream objects.
+ * List entries across all streams.
+ * @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 auditableItemStreamListEntriesNoStream(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamListEntriesNoStreamRequest): Promise<IAuditableItemStreamListEntriesResponse>;
+/**
+ * List the entry objects for a stream.
  * @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 auditableItemStreamListEntryObjects(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamListEntryObjectsRequest): Promise<IAuditableItemStreamListEntryObjectsResponse>;
+/**
+ * List entry objects across all streams.
+ * @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 auditableItemStreamListEntryObjectsNoStream(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamListEntryObjectsNoStreamRequest): Promise<IAuditableItemStreamListEntryObjectsResponse>;
+/**
+ * Remove the proof from a stream.
+ * @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 auditableItemStreamRemoveProof(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemStreamRemoveProofRequest): Promise<INoContentResponse>;

package/dist/types/auditableItemStreamService.d.ts

@@ -1,4 +1,4 @@
-import { type IAuditableItemStream, type IAuditableItemStreamComponent, type IAuditableItemStreamEntry, type IAuditableItemStreamEntryList, type IAuditableItemStreamEntryObjectList, type IAuditableItemStreamList } from "@twin.org/auditable-item-stream-models";
+import { type IAuditableItemStream, type IAuditableItemStreamBase, type IAuditableItemStreamComponent, type IAuditableItemStreamEntry, type IAuditableItemStreamEntryList, type IAuditableItemStreamEntryObjectList, type IAuditableItemStreamList } from "@twin.org/auditable-item-stream-models";
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { SortDirection, type IComparator } from "@twin.org/entity";
 import type { IAuditableItemStreamServiceConstructorOptions } from "./models/IAuditableItemStreamServiceConstructorOptions.js";
@@ -20,27 +20,34 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
      * @returns The class name of the component.
      */
     className(): string;
+    /**
+     * Register all AIS metrics with the telemetry component.
+     * @returns A promise that resolves when the metrics have been registered.
+     */
+    start(): Promise<void>;
     /**
      * Create a new stream.
      * @param stream The stream to create.
-     * @param stream.annotationObject The object for the stream as JSON-LD.
-     * @param stream.entries Entries to store in the stream.
-     * @param options Options for creating the stream.
-     * @param options.immutableInterval After how many entries do we add immutable checks, defaults to service configured value.
-     * A value of 0 will disable integrity checks, 1 will be every item, or any other integer for an interval.
      * @returns The id of the new stream item.
      */
-    create(stream: {
-        annotationObject?: IJsonLdNodeObject;
-        entries?: {
-            entryObject: IJsonLdNodeObject;
-        }[];
-    }, options?: {
-        immutableInterval?: number;
-    }): Promise<string>;
+    create(stream: IAuditableItemStreamBase): Promise<string>;
+    /**
+     * Close a stream.
+     * @param id The id of the stream to close.
+     * @returns A promise that resolves when the stream has been closed.
+     */
+    close(id: string): Promise<void>;
+    /**
+     * Update a stream.
+     * @param stream The stream to update, does not update entries.
+     * @returns A promise that resolves when the stream has been updated.
+     */
+    update(stream: Pick<IAuditableItemStream, "@context" | "type" | "id" | "annotationObject">): Promise<void>;
     /**
      * Get a stream header without the entries.
      * @param id The id of the stream to get.
+     * @param cursor Cursor to use for next chunk of entries.
+     * @param limit Limit the number of entries to return, only applicable if includeEntries is true.
      * @param options Additional options for the get operation.
      * @param options.includeEntries Whether to include the entries, defaults to false.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
@@ -49,27 +56,19 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
      * @returns The stream and entries if found.
      * @throws NotFoundError if the stream is not found
      */
-    get(id: string, options?: {
+    get(id: string, cursor?: string, limit?: number, options?: {
         includeEntries?: boolean;
         includeDeleted?: boolean;
         verifyStream?: boolean;
         verifyEntries?: boolean;
-    }): Promise<IAuditableItemStream>;
-    /**
-     * Update a stream.
-     * @param stream The stream to update.
-     * @param stream.id The id of the stream to update.
-     * @param stream.annotationObject The object for the stream as JSON-LD.
-     * @returns Nothing.
-     */
-    update(stream: {
-        id: string;
-        annotationObject?: IJsonLdNodeObject;
-    }): Promise<void>;
+    }): Promise<{
+        stream: IAuditableItemStream;
+        cursor?: string;
+    }>;
     /**
      * Delete the stream.
      * @param id The id of the stream to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the stream has been removed.
      */
     remove(id: string): Promise<void>;
     /**
@@ -118,19 +117,19 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
      * @param streamId The id of the stream to update.
      * @param entryId The id of the entry to update.
      * @param entryObject The object for the entry as JSON-LD.
-     * @returns Nothing.
+     * @returns A promise that resolves when the entry has been updated.
      */
     updateEntry(streamId: string, entryId: string, entryObject: IJsonLdNodeObject): Promise<void>;
     /**
      * Delete from the stream.
      * @param streamId The id of the stream to remove from.
      * @param entryId The id of the entry to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the entry has been removed.
      */
     removeEntry(streamId: string, entryId: string): Promise<void>;
     /**
      * Get the entries for the stream.
-     * @param streamId The id of the stream to get.
+     * @param streamId The id of the stream to get, if undefined returns all matching entries.
      * @param options Additional options for the get operation.
      * @param options.conditions The conditions to filter the stream.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
@@ -141,7 +140,7 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
      * @returns The stream and entries if found.
      * @throws NotFoundError if the stream is not found.
      */
-    getEntries(streamId: string, options?: {
+    getEntries(streamId?: string, options?: {
         conditions?: IComparator[];
         includeDeleted?: boolean;
         verifyEntries?: boolean;
@@ -154,7 +153,7 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
     }>;
     /**
      * Get the entry objects for the stream.
-     * @param streamId The id of the stream to get.
+     * @param streamId The id of the stream to get, if undefined returns all matching entries.
      * @param options Additional options for the get operation.
      * @param options.conditions The conditions to filter the stream.
      * @param options.includeDeleted Whether to include deleted entries, defaults to false.
@@ -164,7 +163,7 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
      * @returns The stream and entries if found.
      * @throws NotFoundError if the stream is not found.
      */
-    getEntryObjects(streamId: string, options?: {
+    getEntryObjects(streamId?: string, options?: {
         conditions?: IComparator[];
         includeDeleted?: boolean;
         limit?: number;
@@ -175,10 +174,10 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
         cursor?: string;
     }>;
     /**
-     * Remove the verifiable storage for the stream and entries.
-     * @param streamId The id of the stream to remove the storage from.
-     * @returns Nothing.
+     * Remove the proof for the stream and entries.
+     * @param streamId The id of the stream to remove the proof from.
+     * @returns A promise that resolves when the proof has been removed.
      * @throws NotFoundError if the vertex is not found.
      */
-    removeVerifiable(streamId: string): Promise<void>;
+    removeProof(streamId: string): Promise<void>;
 }

package/dist/types/entities/auditableItemStream.d.ts

@@ -1,3 +1,4 @@
+import type { AuditableItemStreamModes } from "@twin.org/auditable-item-stream-models";
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 /**
  * Class describing the auditable item stream.
@@ -18,7 +19,7 @@ export declare class AuditableItemStream {
     /**
      * The identity of the organization which controls the stream.
      */
-    organizationIdentity?: string;
+    organizationIdentity: string;
     /**
      * The identity of the user which created the stream.
      */
@@ -35,6 +36,14 @@ export declare class AuditableItemStream {
      * After how many entries do we add immutable checks.
      */
     immutableInterval: number;
+    /**
+     * Is the stream closed for entry updates.
+     */
+    closed?: boolean;
+    /**
+     * The operation mode for the stream.
+     */
+    mode?: AuditableItemStreamModes;
     /**
      * The immutable proof id.
      */

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

@@ -9,4 +9,8 @@ export interface IAuditableItemStreamServiceConfig {
      * @default 10
      */
     defaultImmutableInterval?: number;
+    /**
+     * The timeout in milliseconds to wait when acquiring a mutex lock, defaults to the Mutex default of 5000ms.
+     */
+    mutexTimeoutMs?: number;
 }

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

@@ -22,6 +22,10 @@ export interface IAuditableItemStreamServiceConstructorOptions {
      * The event bus component type, defaults to no event bus.
      */
     eventBusComponentType?: string;
+    /**
+     * The component type for the optional telemetry component used for event metrics.
+     */
+    telemetryComponentType?: string;
     /**
      * The configuration for the connector.
      */

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

@@ -19,4 +19,8 @@ export interface IAuditableItemStreamServiceContext {
      * The immutable check interval.
      */
     immutableInterval: number;
+    /**
+     * The identity of the organization which controls the stream.
+     */
+    organizationIdentity: string;
 }

package/dist/types/restEntryPoints.d.ts

@@ -1,2 +1,5 @@
 import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+/**
+ * The REST route entry points for the auditable item stream service.
+ */
 export declare const restEntryPoints: IRestRouteEntryPoint[];