@twin.org/immutable-proof-service 0.0.1-next.14 → 0.0.1-next.16

package/dist/cjs/index.cjs

@@ -1,5 +1,6 @@
 'use strict';
 
+var entity = require('@twin.org/entity');
 var core = require('@twin.org/core');
 var immutableProofModels = require('@twin.org/immutable-proof-models');
 var standardsW3cDid = require('@twin.org/standards-w3c-did');
@@ -11,7 +12,73 @@ var entityStorageModels = require('@twin.org/entity-storage-models');
 var identityModels = require('@twin.org/identity-models');
 var immutableStorageModels = require('@twin.org/immutable-storage-models');
 var vaultModels = require('@twin.org/vault-models');
-var entity = require('@twin.org/entity');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class describing the immutable proof.
+ */
+exports.ImmutableProof = class ImmutableProof {
+    /**
+     * The id of the proof.
+     */
+    id;
+    /**
+     * The identity of the node which controls the proof.
+     */
+    nodeIdentity;
+    /**
+     * The identity of the user which created the proof.
+     */
+    userIdentity;
+    /**
+     * The date/time of when the proof was created.
+     */
+    dateCreated;
+    /**
+     * The associated id for the item.
+     */
+    proofObjectId;
+    /**
+     * The associated hash for the item.
+     */
+    proofObjectHash;
+    /**
+     * The immutable storage id.
+     */
+    immutableStorageId;
+};
+__decorate([
+    entity.property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], exports.ImmutableProof.prototype, "id", undefined);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.ImmutableProof.prototype, "nodeIdentity", undefined);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.ImmutableProof.prototype, "userIdentity", undefined);
+__decorate([
+    entity.property({ type: "string", format: "date-time", sortDirection: entity.SortDirection.Descending }),
+    __metadata("design:type", String)
+], exports.ImmutableProof.prototype, "dateCreated", undefined);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.ImmutableProof.prototype, "proofObjectId", undefined);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.ImmutableProof.prototype, "proofObjectHash", undefined);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.ImmutableProof.prototype, "immutableStorageId", undefined);
+exports.ImmutableProof = __decorate([
+    entity.entity()
+], exports.ImmutableProof);
 
 /**
  * The source used when communicating about these routes.
@@ -350,13 +417,6 @@ class ImmutableProofService {
     /**
      * 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".
-     * @param options.backgroundTaskConnectorType The background task connector type, defaults to "background-task".
-     * @param options.eventBusComponentType The event bus component type, defaults to no event bus.
      */
     constructor(options) {
         this._vaultConnector = vaultModels.VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
@@ -642,73 +702,6 @@ class ImmutableProofService {
     }
 }
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class describing the immutable proof.
- */
-exports.ImmutableProof = class ImmutableProof {
-    /**
-     * The id of the proof.
-     */
-    id;
-    /**
-     * The identity of the node which controls the proof.
-     */
-    nodeIdentity;
-    /**
-     * The identity of the user which created the proof.
-     */
-    userIdentity;
-    /**
-     * The date/time of when the proof was created.
-     */
-    dateCreated;
-    /**
-     * The associated id for the item.
-     */
-    proofObjectId;
-    /**
-     * The associated hash for the item.
-     */
-    proofObjectHash;
-    /**
-     * The immutable storage id.
-     */
-    immutableStorageId;
-};
-__decorate([
-    entity.property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], exports.ImmutableProof.prototype, "id", void 0);
-__decorate([
-    entity.property({ type: "string" }),
-    __metadata("design:type", String)
-], exports.ImmutableProof.prototype, "nodeIdentity", void 0);
-__decorate([
-    entity.property({ type: "string" }),
-    __metadata("design:type", String)
-], exports.ImmutableProof.prototype, "userIdentity", void 0);
-__decorate([
-    entity.property({ type: "string", format: "date-time", sortDirection: entity.SortDirection.Descending }),
-    __metadata("design:type", String)
-], exports.ImmutableProof.prototype, "dateCreated", void 0);
-__decorate([
-    entity.property({ type: "string" }),
-    __metadata("design:type", String)
-], exports.ImmutableProof.prototype, "proofObjectId", void 0);
-__decorate([
-    entity.property({ type: "string" }),
-    __metadata("design:type", String)
-], exports.ImmutableProof.prototype, "proofObjectHash", void 0);
-__decorate([
-    entity.property({ type: "string" }),
-    __metadata("design:type", String)
-], exports.ImmutableProof.prototype, "immutableStorageId", void 0);
-exports.ImmutableProof = __decorate([
-    entity.entity()
-], exports.ImmutableProof);
-
 const restEntryPoints = [
     {
         name: "immutable-proof",

package/dist/esm/index.mjs

@@ -1,3 +1,4 @@
+import { property, SortDirection, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
 import { Guards, ComponentFactory, StringHelper, Is, Validation, Converter, RandomHelper, ObjectHelper, Urn, GeneralError, NotFoundError, JsonHelper } from '@twin.org/core';
 import { ImmutableProofTypes, ImmutableProofFailure, ImmutableProofTopics } from '@twin.org/immutable-proof-models';
 import { DidContexts, DidTypes, DidCryptoSuites } from '@twin.org/standards-w3c-did';
@@ -9,7 +10,73 @@ import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 import { IdentityConnectorFactory } from '@twin.org/identity-models';
 import { ImmutableStorageConnectorFactory, ImmutableStorageTypes } from '@twin.org/immutable-storage-models';
 import { VaultConnectorFactory } from '@twin.org/vault-models';
-import { property, SortDirection, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class describing the immutable proof.
+ */
+let ImmutableProof = class ImmutableProof {
+    /**
+     * The id of the proof.
+     */
+    id;
+    /**
+     * The identity of the node which controls the proof.
+     */
+    nodeIdentity;
+    /**
+     * The identity of the user which created the proof.
+     */
+    userIdentity;
+    /**
+     * The date/time of when the proof was created.
+     */
+    dateCreated;
+    /**
+     * The associated id for the item.
+     */
+    proofObjectId;
+    /**
+     * The associated hash for the item.
+     */
+    proofObjectHash;
+    /**
+     * The immutable storage id.
+     */
+    immutableStorageId;
+};
+__decorate([
+    property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], ImmutableProof.prototype, "id", undefined);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], ImmutableProof.prototype, "nodeIdentity", undefined);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], ImmutableProof.prototype, "userIdentity", undefined);
+__decorate([
+    property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
+    __metadata("design:type", String)
+], ImmutableProof.prototype, "dateCreated", undefined);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], ImmutableProof.prototype, "proofObjectId", undefined);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], ImmutableProof.prototype, "proofObjectHash", undefined);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], ImmutableProof.prototype, "immutableStorageId", undefined);
+ImmutableProof = __decorate([
+    entity()
+], ImmutableProof);
 
 /**
  * The source used when communicating about these routes.
@@ -348,13 +415,6 @@ class ImmutableProofService {
     /**
      * 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".
-     * @param options.backgroundTaskConnectorType The background task connector type, defaults to "background-task".
-     * @param options.eventBusComponentType The event bus component type, defaults to no event bus.
      */
     constructor(options) {
         this._vaultConnector = VaultConnectorFactory.get(options?.vaultConnectorType ?? "vault");
@@ -640,73 +700,6 @@ class ImmutableProofService {
     }
 }
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class describing the immutable proof.
- */
-let ImmutableProof = class ImmutableProof {
-    /**
-     * The id of the proof.
-     */
-    id;
-    /**
-     * The identity of the node which controls the proof.
-     */
-    nodeIdentity;
-    /**
-     * The identity of the user which created the proof.
-     */
-    userIdentity;
-    /**
-     * The date/time of when the proof was created.
-     */
-    dateCreated;
-    /**
-     * The associated id for the item.
-     */
-    proofObjectId;
-    /**
-     * The associated hash for the item.
-     */
-    proofObjectHash;
-    /**
-     * The immutable storage id.
-     */
-    immutableStorageId;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], ImmutableProof.prototype, "id", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], ImmutableProof.prototype, "nodeIdentity", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], ImmutableProof.prototype, "userIdentity", void 0);
-__decorate([
-    property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
-    __metadata("design:type", String)
-], ImmutableProof.prototype, "dateCreated", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], ImmutableProof.prototype, "proofObjectId", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], ImmutableProof.prototype, "proofObjectHash", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], ImmutableProof.prototype, "immutableStorageId", void 0);
-ImmutableProof = __decorate([
-    entity()
-], ImmutableProof);
-
 const restEntryPoints = [
     {
         name: "immutable-proof",

package/dist/types/immutableProofService.d.ts

@@ -1,6 +1,6 @@
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IImmutableProof, type IImmutableProofComponent, type IImmutableProofVerification } from "@twin.org/immutable-proof-models";
-import type { IImmutableProofServiceConfig } from "./models/IImmutableProofServiceConfig";
+import type { IImmutableProofServiceConstructorOptions } from "./models/IImmutableProofServiceConstructorOptions";
 /**
  * Class for performing immutable proof operations.
  */
@@ -16,23 +16,8 @@ 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".
-     * @param options.backgroundTaskConnectorType The background task connector type, defaults to "background-task".
-     * @param options.eventBusComponentType The event bus component type, defaults to no event bus.
      */
-    constructor(options?: {
-        vaultConnectorType?: string;
-        immutableProofEntityStorageType?: string;
-        immutableStorageType?: string;
-        identityConnectorType?: string;
-        backgroundTaskConnectorType?: string;
-        eventBusComponentType?: string;
-        config?: IImmutableProofServiceConfig;
-    });
+    constructor(options?: IImmutableProofServiceConstructorOptions);
     /**
      * Create a new authentication proof.
      * @param proofObject The object for the proof as JSON-LD.

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/IImmutableProofServiceConstructorOptions.d.ts

@@ -0,0 +1,39 @@
+import type { IImmutableProofServiceConfig } from "./IImmutableProofServiceConfig";
+/**
+ * Options for the immutable proof service constructor.
+ */
+export interface IImmutableProofServiceConstructorOptions {
+    /**
+     * The vault connector type.
+     * @default vault
+     */
+    vaultConnectorType?: string;
+    /**
+     * The entity storage for proofs.
+     * @default immutable-proof
+     */
+    immutableProofEntityStorageType?: string;
+    /**
+     * The immutable storage.
+     * @default immutable-storage
+     */
+    immutableStorageType?: 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.14
+## v0.0.1-next.16
 
 - Initial Release

package/docs/reference/classes/ImmutableProofService.md

@@ -16,37 +16,11 @@ Create a new instance of ImmutableProofService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The dependencies for the immutable proof connector.
-
-• **options.vaultConnectorType?**: `string`
-
-The vault connector type, defaults to "vault".
-
-• **options.immutableProofEntityStorageType?**: `string`
-
-The entity storage for proofs, defaults to "immutable-proof".
-
-• **options.immutableStorageType?**: `string`
-
-The immutable storage, defaults to "immutable-storage".
-
-• **options.identityConnectorType?**: `string`
-
-The identity connector type, defaults to "identity".
-
-• **options.backgroundTaskConnectorType?**: `string`
-
-The background task connector type, defaults to "background-task".
+[`IImmutableProofServiceConstructorOptions`](../interfaces/IImmutableProofServiceConstructorOptions.md)
 
-• **options.eventBusComponentType?**: `string`
-
-The event bus component type, defaults to no event bus.
-
-• **options.config?**: [`IImmutableProofServiceConfig`](../interfaces/IImmutableProofServiceConfig.md)
-
-The configuration for the connector.
+The dependencies for the immutable proof connector.
 
 #### Returns
 
@@ -82,15 +56,21 @@ Create a new authentication proof.
 
 #### Parameters
 
-• **proofObject**: `IJsonLdNodeObject`
+##### proofObject
+
+`IJsonLdNodeObject`
 
 The object for the proof as JSON-LD.
 
-• **userIdentity?**: `string`
+##### userIdentity?
+
+`string`
 
 The identity to create the immutable proof operation with.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 
@@ -114,7 +94,9 @@ Get an authentication proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to get.
 
@@ -142,7 +124,9 @@ Verify an authentication proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to verify.
 
@@ -170,11 +154,15 @@ Remove the immutable storage for the proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to remove the storage from.
 
-• **nodeIdentity?**: `string`
+##### nodeIdentity?
+
+`string`
 
 The node identity to use for vault operations.
 

package/docs/reference/functions/generateRestRoutesImmutableProof.md

@@ -6,11 +6,15 @@ The REST routes for immutable proof.
 
 ## Parameters
 
-• **baseRouteName**: `string`
+### baseRouteName
+
+`string`
 
 Prefix to prepend to the paths.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes stored in the ComponentFactory.
 

package/docs/reference/functions/immutableProofCreate.md

@@ -6,15 +6,21 @@ Create a proof.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IImmutableProofCreateRequest`
+### request
+
+`IImmutableProofCreateRequest`
 
 The request.
 

package/docs/reference/functions/immutableProofGet.md

@@ -6,15 +6,21 @@ Get the proof.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IImmutableProofGetRequest`
+### request
+
+`IImmutableProofGetRequest`
 
 The request.
 

package/docs/reference/functions/immutableProofVerify.md

@@ -6,15 +6,21 @@ Verify the proof.
 
 ## Parameters
 
-• **httpRequestContext**: `IHttpRequestContext`
+### httpRequestContext
+
+`IHttpRequestContext`
 
 The request context for the API.
 
-• **componentName**: `string`
+### componentName
+
+`string`
 
 The name of the component to use in the routes.
 
-• **request**: `IImmutableProofVerifyRequest`
+### request
+
+`IImmutableProofVerifyRequest`
 
 The request.
 

package/docs/reference/index.md

@@ -8,6 +8,7 @@
 ## Interfaces
 
 - [IImmutableProofServiceConfig](interfaces/IImmutableProofServiceConfig.md)
+- [IImmutableProofServiceConstructorOptions](interfaces/IImmutableProofServiceConstructorOptions.md)
 
 ## Variables
 

package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md

@@ -0,0 +1,89 @@
+# Interface: IImmutableProofServiceConstructorOptions
+
+Options for the immutable proof service constructor.
+
+## Properties
+
+### vaultConnectorType?
+
+> `optional` **vaultConnectorType**: `string`
+
+The vault connector type.
+
+#### Default
+
+```ts
+vault
+```
+
+***
+
+### immutableProofEntityStorageType?
+
+> `optional` **immutableProofEntityStorageType**: `string`
+
+The entity storage for proofs.
+
+#### Default
+
+```ts
+immutable-proof
+```
+
+***
+
+### immutableStorageType?
+
+> `optional` **immutableStorageType**: `string`
+
+The immutable storage.
+
+#### Default
+
+```ts
+immutable-storage
+```
+
+***
+
+### identityConnectorType?
+
+> `optional` **identityConnectorType**: `string`
+
+The identity connector type.
+
+#### Default
+
+```ts
+identity
+```
+
+***
+
+### backgroundTaskConnectorType?
+
+> `optional` **backgroundTaskConnectorType**: `string`
+
+The background task connector type.
+
+#### Default
+
+```ts
+background-task
+```
+
+***
+
+### eventBusComponentType?
+
+> `optional` **eventBusComponentType**: `string`
+
+The event bus component type, defaults to no event bus.
+
+***
+
+### config?
+
+> `optional` **config**: [`IImmutableProofServiceConfig`](IImmutableProofServiceConfig.md)
+
+The configuration for the connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.1-next.14",
+	"version": "0.0.1-next.16",
 	"description": "Immutable proof contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -24,23 +24,23 @@
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/event-bus-models": "next",
 		"@twin.org/identity-models": "next",
-		"@twin.org/immutable-proof-models": "0.0.1-next.14",
-		"@twin.org/immutable-proof-task": "0.0.1-next.14",
+		"@twin.org/immutable-proof-models": "0.0.1-next.16",
+		"@twin.org/immutable-proof-task": "0.0.1-next.16",
 		"@twin.org/immutable-storage-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-models": "next",
 		"@twin.org/web": "next",
-		"jsonschema": "1.4.1"
+		"jsonschema": "1.5.0"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},