@twin.org/immutable-proof-service 0.0.1-next.1

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

@@ -0,0 +1,33 @@
+/**
+ * Class describing the immutable proof.
+ */
+export declare class ImmutableProof {
+    /**
+     * The id of the proof.
+     */
+    id: string;
+    /**
+     * The identity of the node which controls the proof.
+     */
+    nodeIdentity: string;
+    /**
+     * The identity of the user which created the proof.
+     */
+    userIdentity: string;
+    /**
+     * The date/time of when the proof was created.
+     */
+    dateCreated: string;
+    /**
+     * The associated id for the item.
+     */
+    proofObjectId?: string;
+    /**
+     * The associated hash for the item.
+     */
+    proofObjectHash: string;
+    /**
+     * The immutable storage id.
+     */
+    immutableStorageId?: string;
+}

package/dist/types/immutableProofRoutes.d.ts

@@ -0,0 +1,37 @@
+import type { ICreatedResponse, IHttpRequestContext, IRestRoute, ITag } from "@twin.org/api-models";
+import { type IImmutableProofCreateRequest, type IImmutableProofGetRequest, type IImmutableProofGetResponse, type IImmutableProofVerifyRequest, type IImmutableProofVerifyResponse } from "@twin.org/immutable-proof-models";
+/**
+ * The tag to associate with the routes.
+ */
+export declare const tagsImmutableProof: ITag[];
+/**
+ * The REST routes for immutable proof.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesImmutableProof(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * Create a proof.
+ * @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 immutableProofCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IImmutableProofCreateRequest): Promise<ICreatedResponse>;
+/**
+ * Get the proof.
+ * @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 immutableProofGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IImmutableProofGetRequest): Promise<IImmutableProofGetResponse>;
+/**
+ * Verify the proof.
+ * @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 immutableProofVerify(httpRequestContext: IHttpRequestContext, componentName: string, request: IImmutableProofVerifyRequest): Promise<IImmutableProofVerifyResponse>;

package/dist/types/immutableProofService.d.ts

@@ -0,0 +1,66 @@
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { ImmutableProofFailure, type IImmutableProof, type IImmutableProofComponent } from "@twin.org/immutable-proof-models";
+import type { IImmutableProofServiceConfig } from "./models/IImmutableProofServiceConfig";
+/**
+ * Class for performing immutable proof operations.
+ */
+export declare class ImmutableProofService implements IImmutableProofComponent {
+    /**
+     * The namespace for the service.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * 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-proof".
+     * @param options.identityConnectorType The identity connector type, defaults to "identity".
+     */
+    constructor(options?: {
+        vaultConnectorType?: string;
+        immutableProofEntityStorageType?: string;
+        immutableStorageType?: string;
+        config?: IImmutableProofServiceConfig;
+        identityConnectorType?: string;
+    });
+    /**
+     * Create a new authentication proof.
+     * @param proofObject The object for the proof as JSON-LD.
+     * @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.
+     */
+    create(proofObject: IJsonLdNodeObject, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    /**
+     * Get an authentication 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.
+     * @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<{
+        verified: boolean;
+        failure?: ImmutableProofFailure;
+    }>;
+    /**
+     * Remove the immutable 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>;
+}

package/dist/types/index.d.ts

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

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

@@ -0,0 +1,15 @@
+/**
+ * Configuration for the immutable proof service.
+ */
+export interface IImmutableProofServiceConfig {
+    /**
+     * The assertion method id to use for the stream.
+     * @default immutable-proof
+     */
+    assertionMethodId?: string;
+    /**
+     * The key to use in the proof config.
+     * @default immutable-proof
+     */
+    proofConfigKeyId?: string;
+}

package/dist/types/restEntryPoints.d.ts

@@ -0,0 +1,2 @@
+import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+export declare const restEntryPoints: IRestRouteEntryPoint[];

package/dist/types/schema.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Initialize the schema for the immutable proof entity storage connector.
+ */
+export declare function initSchema(): void;

package/docs/changelog.md

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

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/immutable-proof-service - Examples