@twin.org/auditable-item-stream-service 0.0.3-next.2 → 0.0.3-next.21

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,33 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
      * @returns The class name of the component.
      */
     className(): string;
+    /**
+     * Register all AIS metrics with the telemetry component.
+     */
+    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 Nothing.
+     */
+    close(id: string): Promise<void>;
+    /**
+     * Update a stream.
+     * @param stream The stream to update, does not update entries.
+     * @returns Nothing.
+     */
+    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,23 +55,15 @@ 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.
@@ -82,7 +80,10 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
      * @param limit Limit the number of entities to return.
      * @returns The entities, which can be partial if a limited keys list was provided.
      */
-    query(conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemStream, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemStream)[], cursor?: string, limit?: number): Promise<IAuditableItemStreamList>;
+    query(conditions?: IComparator[], orderBy?: keyof Pick<IAuditableItemStream, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemStream)[], cursor?: string, limit?: number): Promise<{
+        entries: IAuditableItemStreamList;
+        cursor?: string;
+    }>;
     /**
      * Create an entry in the stream.
      * @param streamId The id of the stream to update.
@@ -127,7 +128,7 @@ export declare class AuditableItemStreamService implements IAuditableItemStreamC
     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.
@@ -138,17 +139,20 @@ 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;
         limit?: number;
         cursor?: string;
         order?: SortDirection;
-    }): Promise<IAuditableItemStreamEntryList>;
+    }): Promise<{
+        entries: IAuditableItemStreamEntryList;
+        cursor?: string;
+    }>;
     /**
      * 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.
@@ -158,18 +162,21 @@ 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;
         cursor?: string;
         order?: SortDirection;
-    }): Promise<IAuditableItemStreamEntryObjectList>;
+    }): Promise<{
+        entries: IAuditableItemStreamEntryObjectList;
+        cursor?: string;
+    }>;
     /**
-     * Remove the verifiable storage for the stream and entries.
-     * @param streamId The id of the stream to remove the storage from.
+     * Remove the proof for the stream and entries.
+     * @param streamId The id of the stream to remove the proof from.
      * @returns Nothing.
      * @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.
      */
@@ -28,13 +29,21 @@ export declare class AuditableItemStream {
      */
     annotationObject?: IJsonLdNodeObject;
     /**
-     * The counter for the entry index.
+     * The number of items in the stream.
      */
-    indexCounter: number;
+    numberOfItems: number;
     /**
      * 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/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;
 }