@breadstone/archipel-platform-esigning 0.0.2

package/README.md

@@ -0,0 +1,38 @@
+# @breadstone/archipel-platform-esigning
+
+Provider-agnostic e-signing infrastructure for NestJS applications.
+
+## Features
+
+- Abstract e-signing provider contract for multiple backends
+- Built-in internal e-signing provider (no external dependency required)
+- Ready-to-use adapter architecture for DocuSign, Adobe Sign, Dropbox Sign, and signNow
+- Dynamic module registration with configurable provider selection
+- Normalized models for signing requests, signers, documents, fields, and webhook events
+- Persistence port for optional state tracking
+
+## Usage
+
+```typescript
+import { EsigningModule } from '@breadstone/archipel-platform-esigning';
+import { InternalEsigningProvider } from '@breadstone/archipel-platform-esigning';
+
+@Module({
+  imports: [
+    EsigningModule.register({
+      provider: InternalEsigningProvider,
+      isGlobal: true,
+    }),
+  ],
+})
+export class AppModule {}
+```
+
+## Provider Architecture
+
+Each provider implements the `EsigningClientPort` abstract class. External providers are available as separate entry points:
+
+- `@breadstone/archipel-platform-esigning/docusign`
+- `@breadstone/archipel-platform-esigning/adobe-sign`
+- `@breadstone/archipel-platform-esigning/dropbox-sign`
+- `@breadstone/archipel-platform-esigning/signnow`

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@breadstone/archipel-platform-esigning",
+  "version": "0.0.2",
+  "description": "Provider-agnostic e-signing infrastructure for NestJS with support for DocuSign, Adobe Sign, Dropbox Sign, signNow, and a built-in internal provider.",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/RueDeRennes/archipel",
+    "directory": "libs/platform-esigning"
+  },
+  "keywords": [
+    "nestjs",
+    "esigning",
+    "e-signature",
+    "docusign",
+    "adobe-sign",
+    "dropbox-sign",
+    "signnow",
+    "digital-signature",
+    "archipel"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "files": [
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "README.md"
+  ],
+  "dependencies": {
+    "@breadstone/archipel-platform-core": "0.0.2",
+    "@nestjs/common": "11.1.18",
+    "tslib": "2.8.1"
+  },
+  "devDependencies": {
+    "vitest": "4.1.2"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./docusign": "./src/docusign/index.js",
+    "./docusign/index": "./src/docusign/index.js",
+    "./adobe-sign": "./src/adobe-sign/index.js",
+    "./adobe-sign/index": "./src/adobe-sign/index.js",
+    "./dropbox-sign": "./src/dropbox-sign/index.js",
+    "./dropbox-sign/index": "./src/dropbox-sign/index.js",
+    "./signnow": "./src/signnow/index.js",
+    "./signnow/index": "./src/signnow/index.js"
+  }
+}

package/src/EsigningModule.d.ts

@@ -0,0 +1,46 @@
+import { type IConfigRegistryEntry } from '@breadstone/archipel-platform-core';
+import { type DynamicModule, type Type } from '@nestjs/common';
+import { EsigningClientPort } from './contracts/EsigningClientPort';
+import { EsigningPersistencePort } from './contracts/EsigningPersistencePort';
+/**
+ * Configuration options for the {@link EsigningModule}.
+ *
+ * @public
+ */
+export interface IEsigningModuleOptions {
+    /**
+     * Concrete implementation of the {@link EsigningClientPort}.
+     * For example, `InternalEsigningProvider`, `DocuSignClient`, `AdobeSignClient`, etc.
+     */
+    provider: Type<EsigningClientPort>;
+    /**
+     * Provider-specific configuration entries to register with the config module.
+     */
+    configEntries?: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
+    /**
+     * Concrete implementation of the {@link EsigningPersistencePort}.
+     * Required when the application needs to persist signing request state.
+     */
+    persistence?: Type<EsigningPersistencePort>;
+    /**
+     * When `true` the module is registered globally.
+     */
+    isGlobal?: boolean;
+}
+/**
+ * NestJS module providing generic e-signing infrastructure.
+ * Exposes a configurable signing client and optional persistence tracking.
+ * The specific e-signing provider is selected via the options.
+ *
+ * @public
+ */
+export declare class EsigningModule {
+    /**
+     * Configures the module with the specified options.
+     *
+     * @public
+     * @param options - The module configuration options.
+     * @returns Dynamic module definition.
+     */
+    static register(options: IEsigningModuleOptions): DynamicModule;
+}

package/src/EsigningModule.js

@@ -0,0 +1,58 @@
+"use strict";
+// #region Imports
+var EsigningModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EsigningModule = void 0;
+const tslib_1 = require("tslib");
+const archipel_platform_core_1 = require("@breadstone/archipel-platform-core");
+const common_1 = require("@nestjs/common");
+const EsigningClientPort_1 = require("./contracts/EsigningClientPort");
+const EsigningPersistencePort_1 = require("./contracts/EsigningPersistencePort");
+const EsigningService_1 = require("./services/EsigningService");
+// #endregion
+/**
+ * NestJS module providing generic e-signing infrastructure.
+ * Exposes a configurable signing client and optional persistence tracking.
+ * The specific e-signing provider is selected via the options.
+ *
+ * @public
+ */
+let EsigningModule = EsigningModule_1 = class EsigningModule {
+    // #region Methods
+    /**
+     * Configures the module with the specified options.
+     *
+     * @public
+     * @param options - The module configuration options.
+     * @returns Dynamic module definition.
+     */
+    static register(options) {
+        const providers = [
+            {
+                provide: EsigningClientPort_1.EsigningClientPort,
+                useClass: options.provider,
+            },
+            EsigningService_1.EsigningService,
+            ...(options.persistence
+                ? [
+                    {
+                        provide: EsigningPersistencePort_1.EsigningPersistencePort,
+                        useClass: options.persistence,
+                    },
+                ]
+                : []),
+        ];
+        return {
+            global: options.isGlobal ?? false,
+            module: EsigningModule_1,
+            imports: [archipel_platform_core_1.ConfigModule.register('platform-esigning', options.configEntries ?? [])],
+            providers: providers,
+            exports: [EsigningClientPort_1.EsigningClientPort, EsigningService_1.EsigningService],
+        };
+    }
+};
+exports.EsigningModule = EsigningModule;
+exports.EsigningModule = EsigningModule = EsigningModule_1 = tslib_1.__decorate([
+    (0, common_1.Module)({})
+], EsigningModule);
+//# sourceMappingURL=EsigningModule.js.map

package/src/adobe-sign/env.d.ts

@@ -0,0 +1,11 @@
+import { type IConfigRegistryEntry } from '@breadstone/archipel-platform-core';
+/** Adobe Sign integration key. */
+export declare const ADOBE_SIGN_INTEGRATION_KEY: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Adobe Sign client secret. */
+export declare const ADOBE_SIGN_CLIENT_SECRET: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Adobe Sign base URL. */
+export declare const ADOBE_SIGN_BASE_URL: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Adobe Sign webhook client ID for verification. */
+export declare const ADOBE_SIGN_WEBHOOK_CLIENT_ID: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Configuration entries required by the Adobe Sign e-signing provider. */
+export declare const ADOBE_SIGN_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;

package/src/adobe-sign/env.js

@@ -0,0 +1,28 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADOBE_SIGN_CONFIG_ENTRIES = exports.ADOBE_SIGN_WEBHOOK_CLIENT_ID = exports.ADOBE_SIGN_BASE_URL = exports.ADOBE_SIGN_CLIENT_SECRET = exports.ADOBE_SIGN_INTEGRATION_KEY = void 0;
+const archipel_platform_core_1 = require("@breadstone/archipel-platform-core");
+// #endregion
+// ──────────────────────────────────────────────────────────────
+// Adobe Sign
+// ──────────────────────────────────────────────────────────────
+/** Adobe Sign integration key. */
+exports.ADOBE_SIGN_INTEGRATION_KEY = (0, archipel_platform_core_1.createConfigKey)('ADOBE_SIGN_INTEGRATION_KEY');
+/** Adobe Sign client secret. */
+exports.ADOBE_SIGN_CLIENT_SECRET = (0, archipel_platform_core_1.createConfigKey)('ADOBE_SIGN_CLIENT_SECRET');
+/** Adobe Sign base URL. */
+exports.ADOBE_SIGN_BASE_URL = (0, archipel_platform_core_1.createConfigKey)('ADOBE_SIGN_BASE_URL');
+/** Adobe Sign webhook client ID for verification. */
+exports.ADOBE_SIGN_WEBHOOK_CLIENT_ID = (0, archipel_platform_core_1.createConfigKey)('ADOBE_SIGN_WEBHOOK_CLIENT_ID');
+// ──────────────────────────────────────────────────────────────
+// Registry entries
+// ──────────────────────────────────────────────────────────────
+/** Configuration entries required by the Adobe Sign e-signing provider. */
+exports.ADOBE_SIGN_CONFIG_ENTRIES = [
+    { key: exports.ADOBE_SIGN_INTEGRATION_KEY, required: true, description: 'Adobe Sign integration key.' },
+    { key: exports.ADOBE_SIGN_CLIENT_SECRET, required: true, description: 'Adobe Sign client secret.' },
+    { key: exports.ADOBE_SIGN_BASE_URL, required: true, description: 'Adobe Sign base URL.' },
+    { key: exports.ADOBE_SIGN_WEBHOOK_CLIENT_ID, required: false, description: 'Adobe Sign webhook client ID for verification.' },
+];
+//# sourceMappingURL=env.js.map

package/src/adobe-sign/index.d.ts

@@ -0,0 +1 @@
+export { ADOBE_SIGN_BASE_URL, ADOBE_SIGN_CLIENT_SECRET, ADOBE_SIGN_CONFIG_ENTRIES, ADOBE_SIGN_INTEGRATION_KEY, ADOBE_SIGN_WEBHOOK_CLIENT_ID, } from './env';

package/src/adobe-sign/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADOBE_SIGN_WEBHOOK_CLIENT_ID = exports.ADOBE_SIGN_INTEGRATION_KEY = exports.ADOBE_SIGN_CONFIG_ENTRIES = exports.ADOBE_SIGN_CLIENT_SECRET = exports.ADOBE_SIGN_BASE_URL = void 0;
+var env_1 = require("./env");
+Object.defineProperty(exports, "ADOBE_SIGN_BASE_URL", { enumerable: true, get: function () { return env_1.ADOBE_SIGN_BASE_URL; } });
+Object.defineProperty(exports, "ADOBE_SIGN_CLIENT_SECRET", { enumerable: true, get: function () { return env_1.ADOBE_SIGN_CLIENT_SECRET; } });
+Object.defineProperty(exports, "ADOBE_SIGN_CONFIG_ENTRIES", { enumerable: true, get: function () { return env_1.ADOBE_SIGN_CONFIG_ENTRIES; } });
+Object.defineProperty(exports, "ADOBE_SIGN_INTEGRATION_KEY", { enumerable: true, get: function () { return env_1.ADOBE_SIGN_INTEGRATION_KEY; } });
+Object.defineProperty(exports, "ADOBE_SIGN_WEBHOOK_CLIENT_ID", { enumerable: true, get: function () { return env_1.ADOBE_SIGN_WEBHOOK_CLIENT_ID; } });
+//# sourceMappingURL=index.js.map

package/src/contracts/EsigningClientPort.d.ts

@@ -0,0 +1,66 @@
+import type { ICreateSigningRequest } from '../models/ICreateSigningRequest';
+import type { ICreateSigningSessionRequest } from '../models/ICreateSigningSessionRequest';
+import type { IEsigningWebhookEvent } from '../models/IEsigningWebhookEvent';
+import type { ISignedDocument } from '../models/ISignedDocument';
+import type { ISigningRequest } from '../models/ISigningRequest';
+import type { ISigningSession } from '../models/ISigningSession';
+/**
+ * Abstract port for e-signing provider clients.
+ * Each provider (DocuSign, Adobe Sign, Dropbox Sign, signNow, Internal) must implement
+ * this contract so that the consuming application can switch providers without changing business logic.
+ *
+ * @public
+ */
+export declare abstract class EsigningClientPort {
+    /** Unique identifier of the provider implementation. */
+    abstract readonly providerId: string;
+    /**
+     * Create a new signing request (envelope/agreement).
+     *
+     * @public
+     * @param request - The signing request creation input.
+     * @returns The created signing request with provider-assigned identifiers.
+     */
+    abstract createSigningRequest(request: ICreateSigningRequest): Promise<ISigningRequest>;
+    /**
+     * Generate a signing session (signing link/URL) for a specific signer.
+     *
+     * @public
+     * @param request - The session creation input.
+     * @returns The signing session with the signing URL.
+     */
+    abstract createSigningSession(request: ICreateSigningSessionRequest): Promise<ISigningSession>;
+    /**
+     * Retrieve the current status and details of a signing request.
+     *
+     * @public
+     * @param signingRequestId - The provider-specific signing request identifier.
+     * @returns The signing request with current status.
+     */
+    abstract getSigningRequest(signingRequestId: string): Promise<ISigningRequest>;
+    /**
+     * Retrieve the final signed documents for a completed signing request.
+     *
+     * @public
+     * @param signingRequestId - The provider-specific signing request identifier.
+     * @returns Array of signed documents with their content.
+     */
+    abstract getSignedDocuments(signingRequestId: string): Promise<Array<ISignedDocument>>;
+    /**
+     * Cancel an in-progress signing request.
+     *
+     * @public
+     * @param signingRequestId - The provider-specific signing request identifier.
+     * @param reason - Optional reason for cancellation.
+     */
+    abstract cancelSigningRequest(signingRequestId: string, reason?: string): Promise<void>;
+    /**
+     * Verify a webhook payload signature and return a normalized event.
+     *
+     * @public
+     * @param payload - Raw webhook body.
+     * @param signature - Webhook signature header value.
+     * @returns Normalized webhook event.
+     */
+    abstract verifyWebhook(payload: string | Buffer, signature: string): Promise<IEsigningWebhookEvent>;
+}

package/src/contracts/EsigningClientPort.js

@@ -0,0 +1,16 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EsigningClientPort = void 0;
+// #endregion
+/**
+ * Abstract port for e-signing provider clients.
+ * Each provider (DocuSign, Adobe Sign, Dropbox Sign, signNow, Internal) must implement
+ * this contract so that the consuming application can switch providers without changing business logic.
+ *
+ * @public
+ */
+class EsigningClientPort {
+}
+exports.EsigningClientPort = EsigningClientPort;
+//# sourceMappingURL=EsigningClientPort.js.map

package/src/contracts/EsigningPersistencePort.d.ts

@@ -0,0 +1,31 @@
+import type { ISigningRequest } from '../models/ISigningRequest';
+/**
+ * Abstract port for persisting signing request state.
+ * Implement this port in the consuming application to track signing requests in a database.
+ *
+ * @public
+ */
+export declare abstract class EsigningPersistencePort {
+    /**
+     * Persist a newly created signing request.
+     *
+     * @public
+     * @param signingRequest - The signing request to persist.
+     */
+    abstract onSigningRequestCreated(signingRequest: ISigningRequest): Promise<void>;
+    /**
+     * Update persisted state when a signing request status changes.
+     *
+     * @public
+     * @param signingRequestId - The provider-specific signing request identifier.
+     * @param status - The new status of the signing request.
+     */
+    abstract onSigningRequestStatusChanged(signingRequestId: string, status: string): Promise<void>;
+    /**
+     * Update persisted state when a signing request is cancelled.
+     *
+     * @public
+     * @param signingRequestId - The provider-specific signing request identifier.
+     */
+    abstract onSigningRequestCancelled(signingRequestId: string): Promise<void>;
+}

package/src/contracts/EsigningPersistencePort.js

@@ -0,0 +1,15 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EsigningPersistencePort = void 0;
+// #endregion
+/**
+ * Abstract port for persisting signing request state.
+ * Implement this port in the consuming application to track signing requests in a database.
+ *
+ * @public
+ */
+class EsigningPersistencePort {
+}
+exports.EsigningPersistencePort = EsigningPersistencePort;
+//# sourceMappingURL=EsigningPersistencePort.js.map

package/src/contracts/index.d.ts

@@ -0,0 +1,2 @@
+export { EsigningClientPort } from './EsigningClientPort';
+export { EsigningPersistencePort } from './EsigningPersistencePort';

package/src/contracts/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EsigningPersistencePort = exports.EsigningClientPort = void 0;
+var EsigningClientPort_1 = require("./EsigningClientPort");
+Object.defineProperty(exports, "EsigningClientPort", { enumerable: true, get: function () { return EsigningClientPort_1.EsigningClientPort; } });
+var EsigningPersistencePort_1 = require("./EsigningPersistencePort");
+Object.defineProperty(exports, "EsigningPersistencePort", { enumerable: true, get: function () { return EsigningPersistencePort_1.EsigningPersistencePort; } });
+//# sourceMappingURL=index.js.map

package/src/docusign/env.d.ts

@@ -0,0 +1,13 @@
+import { type IConfigRegistryEntry } from '@breadstone/archipel-platform-core';
+/** DocuSign integration key (client ID). */
+export declare const DOCUSIGN_INTEGRATION_KEY: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** DocuSign secret key (client secret). */
+export declare const DOCUSIGN_SECRET_KEY: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** DocuSign account ID. */
+export declare const DOCUSIGN_ACCOUNT_ID: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** DocuSign base URL (e.g. https://demo.docusign.net for sandbox). */
+export declare const DOCUSIGN_BASE_URL: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** DocuSign webhook HMAC key. */
+export declare const DOCUSIGN_WEBHOOK_HMAC_KEY: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Configuration entries required by the DocuSign e-signing provider. */
+export declare const DOCUSIGN_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;

package/src/docusign/env.js

@@ -0,0 +1,31 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCUSIGN_CONFIG_ENTRIES = exports.DOCUSIGN_WEBHOOK_HMAC_KEY = exports.DOCUSIGN_BASE_URL = exports.DOCUSIGN_ACCOUNT_ID = exports.DOCUSIGN_SECRET_KEY = exports.DOCUSIGN_INTEGRATION_KEY = void 0;
+const archipel_platform_core_1 = require("@breadstone/archipel-platform-core");
+// #endregion
+// ──────────────────────────────────────────────────────────────
+// DocuSign
+// ──────────────────────────────────────────────────────────────
+/** DocuSign integration key (client ID). */
+exports.DOCUSIGN_INTEGRATION_KEY = (0, archipel_platform_core_1.createConfigKey)('DOCUSIGN_INTEGRATION_KEY');
+/** DocuSign secret key (client secret). */
+exports.DOCUSIGN_SECRET_KEY = (0, archipel_platform_core_1.createConfigKey)('DOCUSIGN_SECRET_KEY');
+/** DocuSign account ID. */
+exports.DOCUSIGN_ACCOUNT_ID = (0, archipel_platform_core_1.createConfigKey)('DOCUSIGN_ACCOUNT_ID');
+/** DocuSign base URL (e.g. https://demo.docusign.net for sandbox). */
+exports.DOCUSIGN_BASE_URL = (0, archipel_platform_core_1.createConfigKey)('DOCUSIGN_BASE_URL');
+/** DocuSign webhook HMAC key. */
+exports.DOCUSIGN_WEBHOOK_HMAC_KEY = (0, archipel_platform_core_1.createConfigKey)('DOCUSIGN_WEBHOOK_HMAC_KEY');
+// ──────────────────────────────────────────────────────────────
+// Registry entries
+// ──────────────────────────────────────────────────────────────
+/** Configuration entries required by the DocuSign e-signing provider. */
+exports.DOCUSIGN_CONFIG_ENTRIES = [
+    { key: exports.DOCUSIGN_INTEGRATION_KEY, required: true, description: 'DocuSign integration key (client ID).' },
+    { key: exports.DOCUSIGN_SECRET_KEY, required: true, description: 'DocuSign secret key (client secret).' },
+    { key: exports.DOCUSIGN_ACCOUNT_ID, required: true, description: 'DocuSign account ID.' },
+    { key: exports.DOCUSIGN_BASE_URL, required: true, description: 'DocuSign base URL.' },
+    { key: exports.DOCUSIGN_WEBHOOK_HMAC_KEY, required: false, description: 'DocuSign webhook HMAC key.' },
+];
+//# sourceMappingURL=env.js.map

package/src/docusign/index.d.ts

@@ -0,0 +1 @@
+export { DOCUSIGN_ACCOUNT_ID, DOCUSIGN_BASE_URL, DOCUSIGN_CONFIG_ENTRIES, DOCUSIGN_INTEGRATION_KEY, DOCUSIGN_SECRET_KEY, DOCUSIGN_WEBHOOK_HMAC_KEY, } from './env';

package/src/docusign/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOCUSIGN_WEBHOOK_HMAC_KEY = exports.DOCUSIGN_SECRET_KEY = exports.DOCUSIGN_INTEGRATION_KEY = exports.DOCUSIGN_CONFIG_ENTRIES = exports.DOCUSIGN_BASE_URL = exports.DOCUSIGN_ACCOUNT_ID = void 0;
+var env_1 = require("./env");
+Object.defineProperty(exports, "DOCUSIGN_ACCOUNT_ID", { enumerable: true, get: function () { return env_1.DOCUSIGN_ACCOUNT_ID; } });
+Object.defineProperty(exports, "DOCUSIGN_BASE_URL", { enumerable: true, get: function () { return env_1.DOCUSIGN_BASE_URL; } });
+Object.defineProperty(exports, "DOCUSIGN_CONFIG_ENTRIES", { enumerable: true, get: function () { return env_1.DOCUSIGN_CONFIG_ENTRIES; } });
+Object.defineProperty(exports, "DOCUSIGN_INTEGRATION_KEY", { enumerable: true, get: function () { return env_1.DOCUSIGN_INTEGRATION_KEY; } });
+Object.defineProperty(exports, "DOCUSIGN_SECRET_KEY", { enumerable: true, get: function () { return env_1.DOCUSIGN_SECRET_KEY; } });
+Object.defineProperty(exports, "DOCUSIGN_WEBHOOK_HMAC_KEY", { enumerable: true, get: function () { return env_1.DOCUSIGN_WEBHOOK_HMAC_KEY; } });
+//# sourceMappingURL=index.js.map

package/src/dropbox-sign/env.d.ts

@@ -0,0 +1,9 @@
+import { type IConfigRegistryEntry } from '@breadstone/archipel-platform-core';
+/** Dropbox Sign API key. */
+export declare const DROPBOX_SIGN_API_KEY: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Dropbox Sign client ID. */
+export declare const DROPBOX_SIGN_CLIENT_ID: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Dropbox Sign webhook secret. */
+export declare const DROPBOX_SIGN_WEBHOOK_SECRET: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Configuration entries required by the Dropbox Sign e-signing provider. */
+export declare const DROPBOX_SIGN_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;

package/src/dropbox-sign/env.js

@@ -0,0 +1,25 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DROPBOX_SIGN_CONFIG_ENTRIES = exports.DROPBOX_SIGN_WEBHOOK_SECRET = exports.DROPBOX_SIGN_CLIENT_ID = exports.DROPBOX_SIGN_API_KEY = void 0;
+const archipel_platform_core_1 = require("@breadstone/archipel-platform-core");
+// #endregion
+// ──────────────────────────────────────────────────────────────
+// Dropbox Sign
+// ──────────────────────────────────────────────────────────────
+/** Dropbox Sign API key. */
+exports.DROPBOX_SIGN_API_KEY = (0, archipel_platform_core_1.createConfigKey)('DROPBOX_SIGN_API_KEY');
+/** Dropbox Sign client ID. */
+exports.DROPBOX_SIGN_CLIENT_ID = (0, archipel_platform_core_1.createConfigKey)('DROPBOX_SIGN_CLIENT_ID');
+/** Dropbox Sign webhook secret. */
+exports.DROPBOX_SIGN_WEBHOOK_SECRET = (0, archipel_platform_core_1.createConfigKey)('DROPBOX_SIGN_WEBHOOK_SECRET');
+// ──────────────────────────────────────────────────────────────
+// Registry entries
+// ──────────────────────────────────────────────────────────────
+/** Configuration entries required by the Dropbox Sign e-signing provider. */
+exports.DROPBOX_SIGN_CONFIG_ENTRIES = [
+    { key: exports.DROPBOX_SIGN_API_KEY, required: true, description: 'Dropbox Sign API key.' },
+    { key: exports.DROPBOX_SIGN_CLIENT_ID, required: true, description: 'Dropbox Sign client ID.' },
+    { key: exports.DROPBOX_SIGN_WEBHOOK_SECRET, required: false, description: 'Dropbox Sign webhook secret.' },
+];
+//# sourceMappingURL=env.js.map

package/src/dropbox-sign/index.d.ts

@@ -0,0 +1 @@
+export { DROPBOX_SIGN_API_KEY, DROPBOX_SIGN_CLIENT_ID, DROPBOX_SIGN_CONFIG_ENTRIES, DROPBOX_SIGN_WEBHOOK_SECRET, } from './env';

package/src/dropbox-sign/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DROPBOX_SIGN_WEBHOOK_SECRET = exports.DROPBOX_SIGN_CONFIG_ENTRIES = exports.DROPBOX_SIGN_CLIENT_ID = exports.DROPBOX_SIGN_API_KEY = void 0;
+var env_1 = require("./env");
+Object.defineProperty(exports, "DROPBOX_SIGN_API_KEY", { enumerable: true, get: function () { return env_1.DROPBOX_SIGN_API_KEY; } });
+Object.defineProperty(exports, "DROPBOX_SIGN_CLIENT_ID", { enumerable: true, get: function () { return env_1.DROPBOX_SIGN_CLIENT_ID; } });
+Object.defineProperty(exports, "DROPBOX_SIGN_CONFIG_ENTRIES", { enumerable: true, get: function () { return env_1.DROPBOX_SIGN_CONFIG_ENTRIES; } });
+Object.defineProperty(exports, "DROPBOX_SIGN_WEBHOOK_SECRET", { enumerable: true, get: function () { return env_1.DROPBOX_SIGN_WEBHOOK_SECRET; } });
+//# sourceMappingURL=index.js.map

package/src/env.d.ts

@@ -0,0 +1,9 @@
+import { type IConfigRegistryEntry } from '@breadstone/archipel-platform-core';
+/** Active e-signing provider API key. */
+export declare const ESIGNING_API_KEY: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Active e-signing provider webhook signing secret. */
+export declare const ESIGNING_WEBHOOK_SECRET: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** Active e-signing provider base URL. */
+export declare const ESIGNING_API_BASE_URL: import("@breadstone/archipel-platform-core").IConfigKey<string>;
+/** All configuration entries required by `platform-esigning`. */
+export declare const PLATFORM_ESIGNING_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;

package/src/env.js

@@ -0,0 +1,25 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLATFORM_ESIGNING_CONFIG_ENTRIES = exports.ESIGNING_API_BASE_URL = exports.ESIGNING_WEBHOOK_SECRET = exports.ESIGNING_API_KEY = void 0;
+const archipel_platform_core_1 = require("@breadstone/archipel-platform-core");
+// #endregion
+// ──────────────────────────────────────────────────────────────
+// Generic E-Signing Keys
+// ──────────────────────────────────────────────────────────────
+/** Active e-signing provider API key. */
+exports.ESIGNING_API_KEY = (0, archipel_platform_core_1.createConfigKey)('ESIGNING_API_KEY');
+/** Active e-signing provider webhook signing secret. */
+exports.ESIGNING_WEBHOOK_SECRET = (0, archipel_platform_core_1.createConfigKey)('ESIGNING_WEBHOOK_SECRET');
+/** Active e-signing provider base URL. */
+exports.ESIGNING_API_BASE_URL = (0, archipel_platform_core_1.createConfigKey)('ESIGNING_API_BASE_URL');
+// ──────────────────────────────────────────────────────────────
+// Registry entries
+// ──────────────────────────────────────────────────────────────
+/** All configuration entries required by `platform-esigning`. */
+exports.PLATFORM_ESIGNING_CONFIG_ENTRIES = [
+    { key: exports.ESIGNING_API_KEY, required: false, description: 'Active e-signing provider API key.' },
+    { key: exports.ESIGNING_WEBHOOK_SECRET, required: false, description: 'Active e-signing provider webhook signing secret.' },
+    { key: exports.ESIGNING_API_BASE_URL, required: false, description: 'Active e-signing provider base URL.' },
+];
+//# sourceMappingURL=env.js.map

package/src/errors/EsigningError.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Base error for all e-signing related failures.
+ *
+ * @public
+ */
+export declare class EsigningError extends Error {
+    private readonly _code;
+    constructor(message: string, code: string);
+    /** Machine-readable error code. */
+    get code(): string;
+}

package/src/errors/EsigningError.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EsigningError = void 0;
+/**
+ * Base error for all e-signing related failures.
+ *
+ * @public
+ */
+class EsigningError extends Error {
+    // #endregion
+    // #region Ctor
+    constructor(message, code) {
+        super(message);
+        this.name = 'EsigningError';
+        this._code = code;
+    }
+    // #endregion
+    // #region Properties
+    /** Machine-readable error code. */
+    get code() {
+        return this._code;
+    }
+}
+exports.EsigningError = EsigningError;
+//# sourceMappingURL=EsigningError.js.map

package/src/errors/SigningProviderError.d.ts

@@ -0,0 +1,15 @@
+import { EsigningError } from './EsigningError';
+/**
+ * Thrown when a provider-level operation fails.
+ *
+ * @public
+ */
+export declare class SigningProviderError extends EsigningError {
+    private readonly _providerId;
+    private readonly _cause;
+    constructor(providerId: string, message: string, cause?: unknown);
+    /** Identifier of the provider that failed. */
+    get providerId(): string;
+    /** Original error or cause, if available. */
+    get rootCause(): unknown;
+}