@twin.org/immutable-proof-service 0.0.1-next.3 → 0.0.1-next.30

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

@@ -27,7 +27,7 @@ export declare class ImmutableProof {
      */
     proofObjectHash: string;
     /**
-     * The immutable storage id.
+     * The verifiable storage id.
      */
-    immutableStorageId?: string;
+    verifiableStorageId?: string;
 }

package/dist/types/immutableProofService.d.ts

@@ -1,6 +1,6 @@
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import { type IImmutableProofVerification, type IImmutableProof, type IImmutableProofComponent } from "@twin.org/immutable-proof-models";
-import type { IImmutableProofServiceConfig } from "./models/IImmutableProofServiceConfig";
+import { type IImmutableProof, type IImmutableProofComponent, type IImmutableProofVerification } from "@twin.org/immutable-proof-models";
+import type { IImmutableProofServiceConstructorOptions } from "./models/IImmutableProofServiceConstructorOptions";
 /**
  * Class for performing immutable proof operations.
  */
@@ -16,48 +16,36 @@ export declare class ImmutableProofService implements IImmutableProofComponent {
     /**
      * Create a new instance of ImmutableProofService.
      * @param options The dependencies for the immutable proof connector.
-     * @param options.config The configuration for the connector.
-     * @param options.vaultConnectorType The vault connector type, defaults to "vault".
-     * @param options.immutableProofEntityStorageType The entity storage for proofs, defaults to "immutable-proof".
-     * @param options.immutableStorageType The immutable storage, defaults to "immutable-storage".
-     * @param options.identityConnectorType The identity connector type, defaults to "identity".
      */
-    constructor(options?: {
-        vaultConnectorType?: string;
-        immutableProofEntityStorageType?: string;
-        immutableStorageType?: string;
-        config?: IImmutableProofServiceConfig;
-        identityConnectorType?: string;
-    });
+    constructor(options?: IImmutableProofServiceConstructorOptions);
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
+     * Create a new proof.
+     * @param document The document to create the proof for.
      * @param userIdentity The identity to create the immutable proof operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The id of the new authentication proof.
+     * @returns The id of the new proof.
      */
-    create(proofObject: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(document: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
-     * Get an authentication proof.
+     * Get a proof.
      * @param id The id of the proof to get.
      * @returns The proof.
      * @throws NotFoundError if the proof is not found.
      */
     get(id: string): Promise<IImmutableProof>;
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    verify(id: string, proofObject: IJsonLdNodeObject): Promise<IImmutableProofVerification>;
+    verify(id: string): Promise<IImmutableProofVerification>;
     /**
-     * Remove the immutable storage for the proof.
+     * Remove the verifiable storage for the proof.
      * @param id The id of the proof to remove the storage from.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      * @throws NotFoundError if the proof is not found.
      */
-    removeImmutable(id: string, nodeIdentity?: string): Promise<void>;
+    removeVerifiable(id: string, nodeIdentity?: string): Promise<void>;
 }

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
+export * from "./entities/immutableProof";
 export * from "./immutableProofRoutes";
 export * from "./immutableProofService";
-export * from "./entities/immutableProof";
 export * from "./models/IImmutableProofServiceConfig";
+export * from "./models/IImmutableProofServiceConstructorOptions";
 export * from "./restEntryPoints";
 export * from "./schema";

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

@@ -3,13 +3,8 @@
  */
 export interface IImmutableProofServiceConfig {
     /**
-     * The assertion method id to use for the stream.
-     * @default immutable-proof
+     * The verification method id to use for the proof.
+     * @default immutable-proof-assertion
      */
-    assertionMethodId?: string;
-    /**
-     * The key to use in the proof config.
-     * @default immutable-proof
-     */
-    proofConfigKeyId?: string;
+    verificationMethodId?: string;
 }

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

@@ -0,0 +1,34 @@
+import type { IImmutableProofServiceConfig } from "./IImmutableProofServiceConfig";
+/**
+ * Options for the immutable proof service constructor.
+ */
+export interface IImmutableProofServiceConstructorOptions {
+    /**
+     * The entity storage for proofs.
+     * @default immutable-proof
+     */
+    immutableProofEntityStorageType?: string;
+    /**
+     * The verifiable storage.
+     * @default verifiable-storage
+     */
+    verifiableStorageType?: string;
+    /**
+     * The identity connector type.
+     * @default identity
+     */
+    identityConnectorType?: string;
+    /**
+     * The background task connector type.
+     * @default background-task
+     */
+    backgroundTaskConnectorType?: string;
+    /**
+     * The event bus component type, defaults to no event bus.
+     */
+    eventBusComponentType?: string;
+    /**
+     * The configuration for the connector.
+     */
+    config?: IImmutableProofServiceConfig;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/immutable-proof-service - Changelog
 
-## v0.0.1-next.3
+## v0.0.1-next.30
 
 - Initial Release