@splitin/verification-adapter-sdk 0.1.0-beta.0

package/dist/index.d.ts

@@ -0,0 +1,302 @@
+import { P as ProviderConfigurationSchemaV1, J as JsonSchema2020, V as VerificationAdapterV1, a as ProviderManifestV1, b as ProviderRuntimeContext } from './contracts-5VqcOmjU.js';
+export { A as ActorContext, C as CANONICAL_STATUSES, E as ENGINE_CONTRACT_VERSION, L as LAUNCH_PRESENTATIONS, N as NormalizedProviderEvent, c as NormalizedProviderSnapshot, O as OpenTelemetryHooks, d as PROVIDER_ENVIRONMENTS, e as PROVIDER_MANIFEST_SCHEMA_URN, f as PROVIDER_OPERATIONS, g as ProtectedActionDenial, h as ProviderAddressInput, i as ProviderAssociatedPersonInput, j as ProviderAttemptCommand, k as ProviderAttemptResult, l as ProviderCapabilities, m as ProviderError, n as ProviderErrorCode, o as ProviderErrorOptions, p as ProviderHealthObservation, q as ProviderHttpClient, r as ProviderLaunchEnvelope, s as ProviderOperation, t as ProviderOperationPendingError, u as ProviderOperationResult, v as ProviderOrganizationInput, w as ProviderRateBudget, x as ProviderRedactionCommand, y as ProviderRedactionResult, z as ProviderRelationshipInput, B as ProviderRequiredInformationError, D as ProviderResourceCommand, F as ProviderResourceType, G as ProviderResumeCommand, H as ProviderRetryCommand, I as ProviderSafeLogger, K as ProviderUnavailableError, S as STANDARD_PACKAGE_CODES, M as STANDARD_RELATIONSHIP_KINDS, Q as STANDARD_WEBHOOK_PROTOCOLS, R as SafeProviderFailure, T as SafeProviderFailureEnvelope, U as StandardPackageCode, W as StandardRelationshipKind, X as StandardWebhookProtocol, Y as TERMINAL_STATUSES, Z as TerminalVerificationStatus, _ as TraceSpan, $ as VERIFICATION_ADAPTER_CONTRACT_VERSION, a0 as VerificationAttemptLimitError, a1 as VerificationCanonicalStatus, a2 as VerificationLaunchPresentation, a3 as VerificationLauncherKey, a4 as VerificationPackageCode, a5 as VerificationProviderCode, a6 as VerificationProviderEnvironment, a7 as VerifiedWebhookEnvelope, a8 as WebhookProtocolId, a9 as assertPackageCode, aa as compareSemver, ab as isCanonicalStatus, ac as isCountryCode, ad as isCustomPackageCode, ae as isLauncherKey, af as isOpaqueSubjectReference, ag as isPackageCode, ah as isProviderCode, ai as isResourceType, aj as isSemver, ak as isStandardPackageCode, al as isTerminalStatus, am as isWebhookProtocol, an as majorsCompatible, ao as metadataContainsForbiddenIdentifier, ap as toSafeProviderFailure } from './contracts-5VqcOmjU.js';
+export { AdapterConformanceOptions, AdapterConformanceScenarioFactory, ConformanceResult, ProviderConformanceScenario, assertProviderTypesDoNotEscape, canonicalStatusRank, providerConformanceScenarios, runAdapterConformance, runAdapterConformanceScenarios, validateManifestOnly } from './conformance.js';
+export { FakeScenario, FakeVerificationAdapter, IncompleteVerificationAdapter, createFakeAdapterForScenario, fakeProviderManifest } from './fakes.js';
+
+declare const providerManifestV1JsonSchema: {
+    readonly $schema: "https://json-schema.org/draft/2020-12/schema";
+    readonly $id: "urn:splitin:verification:provider-manifest:v1";
+    readonly title: "Verification Provider Manifest V1";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: readonly ["contractVersion", "adapterVersion", "engineCompatibility", "provider", "displayName", "supportedPackages", "supportedCountries", "environments", "capabilities", "launcherKeys", "launchPresentations", "configurationSchemaVersion", "configurationSchema", "webhook", "dataPolicy", "retry", "cancellation", "redaction", "apiHosts", "testedApiVersions"];
+    readonly properties: {
+        readonly contractVersion: {
+            readonly const: "1.0.0";
+        };
+        readonly adapterVersion: {
+            readonly type: "string";
+            readonly pattern: "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?$";
+        };
+        readonly engineCompatibility: {
+            readonly type: "string";
+            readonly pattern: "^\\d+\\.\\d+\\.\\d+(?:-[0-9A-Za-z.-]+)?$";
+        };
+        readonly provider: {
+            readonly type: "string";
+            readonly pattern: "^[a-z][a-z0-9_]{1,63}$";
+        };
+        readonly displayName: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly description: {
+            readonly type: "string";
+        };
+        readonly supportedPackages: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly type: "string";
+                readonly anyOf: readonly [{
+                    readonly enum: readonly ["human_idv", "business_kyb", "associated_person_idv", "ownership_review"];
+                }, {
+                    readonly pattern: "^[a-z0-9][a-z0-9-]{0,32}(?:\\.[a-z0-9][a-z0-9_-]{0,63}){1,6}$";
+                }];
+            };
+        };
+        readonly supportedCountries: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly type: "string";
+                readonly pattern: "^[A-Z]{2}$";
+            };
+        };
+        readonly environments: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly enum: readonly ["sandbox", "production"];
+            };
+        };
+        readonly capabilities: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["presentations", "canResume", "canRetry", "canCancel", "canRedact"];
+            readonly properties: {
+                readonly presentations: {
+                    readonly type: "array";
+                    readonly minItems: 1;
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly enum: readonly ["embedded", "hosted", "qr", "none"];
+                    };
+                };
+                readonly canResume: {
+                    readonly type: "boolean";
+                };
+                readonly canRetry: {
+                    readonly type: "boolean";
+                };
+                readonly canCancel: {
+                    readonly type: "boolean";
+                };
+                readonly canRedact: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly launcherKeys: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly type: "string";
+                readonly pattern: "^[a-z][a-z0-9_]{1,63}$";
+            };
+        };
+        readonly launchPresentations: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly enum: readonly ["embedded", "hosted", "qr", "none"];
+            };
+        };
+        readonly configurationSchemaVersion: {
+            readonly type: "string";
+            readonly minLength: 1;
+        };
+        readonly configurationSchema: {
+            readonly $ref: "#/$defs/jsonSchema2020";
+        };
+        readonly webhook: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["protocol", "eventFamilies"];
+            readonly properties: {
+                readonly protocol: {
+                    readonly type: "string";
+                    readonly minLength: 1;
+                    readonly maxLength: 128;
+                };
+                readonly eventFamilies: {
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                };
+                readonly toleranceSeconds: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                };
+            };
+        };
+        readonly dataPolicy: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["classifications", "prohibitedPersistence", "rawPayloadPersistence", "browserSecretPersistence", "governmentIdentifierPersistence"];
+            readonly properties: {
+                readonly classifications: {
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                };
+                readonly prohibitedPersistence: {
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                };
+                readonly rawPayloadPersistence: {
+                    readonly const: false;
+                };
+                readonly browserSecretPersistence: {
+                    readonly const: false;
+                };
+                readonly governmentIdentifierPersistence: {
+                    readonly const: false;
+                };
+            };
+        };
+        readonly retry: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["sameResourceWhenResumable", "newAttemptAfterTerminal"];
+            readonly properties: {
+                readonly sameResourceWhenResumable: {
+                    readonly type: "boolean";
+                };
+                readonly newAttemptAfterTerminal: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly cancellation: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["supported", "terminal"];
+            readonly properties: {
+                readonly supported: {
+                    readonly type: "boolean";
+                };
+                readonly terminal: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly redaction: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly required: readonly ["supported", "asynchronous"];
+            readonly properties: {
+                readonly supported: {
+                    readonly type: "boolean";
+                };
+                readonly asynchronous: {
+                    readonly type: "boolean";
+                };
+                readonly notApplicable: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly apiHosts: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly type: "string";
+                readonly pattern: "^[a-z0-9.-]+$";
+            };
+        };
+        readonly testedApiVersions: {
+            readonly type: "array";
+            readonly minItems: 1;
+            readonly uniqueItems: true;
+            readonly items: {
+                readonly type: "string";
+                readonly minLength: 1;
+            };
+        };
+    };
+    readonly $defs: {
+        readonly jsonSchema2020: {
+            readonly type: "object";
+            readonly required: readonly ["$schema", "type", "additionalProperties", "required", "properties"];
+            readonly properties: {
+                readonly $schema: {
+                    readonly const: "https://json-schema.org/draft/2020-12/schema";
+                };
+                readonly type: {
+                    readonly const: "object";
+                };
+                readonly additionalProperties: {
+                    readonly const: false;
+                };
+                readonly required: {
+                    readonly type: "array";
+                    readonly uniqueItems: true;
+                    readonly items: {
+                        readonly type: "string";
+                        readonly minLength: 1;
+                    };
+                };
+                readonly properties: {
+                    readonly type: "object";
+                };
+            };
+        };
+    };
+};
+declare const emptyConfigurationSchema: ProviderConfigurationSchemaV1;
+declare function secretStringProperty(minLength?: number): JsonSchema2020;
+declare function plainStringProperty(minLength?: number): JsonSchema2020;
+
+declare const REQUIRED_ADAPTER_METHODS: readonly ["validateConfiguration", "createAttempt", "resumeAttempt", "retrieveAttempt", "retryAttempt", "cancelAttempt", "redactSubject", "verifyWebhook", "normalizeWebhook"];
+declare function defineProviderManifest(input: ProviderManifestV1): Readonly<ProviderManifestV1>;
+declare function assertProviderManifest(manifest: ProviderManifestV1): void;
+declare function assertAdapterConformsToManifest(adapter: VerificationAdapterV1): void;
+declare function createAllowlistedHttp(allowedHosts: readonly string[], fetchImpl: typeof fetch, timeoutMs?: number): {
+    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
+};
+declare function createDefaultRuntime<T extends object>(environment: ProviderRuntimeContext<T>['environment'], configuration: T, options?: Partial<ProviderRuntimeContext<T>> & {
+    allowedHosts?: string[];
+}): ProviderRuntimeContext<T>;
+declare const silentLogger: Readonly<{
+    info: () => undefined;
+    warn: () => undefined;
+    error: () => undefined;
+}>;
+
+declare class FakeClock {
+    private epochMs;
+    constructor(epochMs?: number);
+    now: () => Date;
+    advance(ms: number): void;
+}
+declare function deterministicId(prefix: string, seed: string): string;
+declare function createControlledFetch(handler: (input: Request) => Promise<Response> | Response): typeof fetch;
+declare function signHmacSha256Hex(secret: string, payload: Uint8Array): Promise<string>;
+declare function sha256Hex(payload: Uint8Array): Promise<string>;
+declare function bytesToHex(value: Uint8Array): string;
+declare function createSignedWebhookFixture(input: {
+    protocol: 'stripe_v1_hmac' | 'persona_hmac_sha256' | 'none';
+    secret: string;
+    body: string;
+    now?: Date;
+}): Promise<Request>;
+declare function denySecretLogging(value: string): void;
+
+export { FakeClock, JsonSchema2020, ProviderConfigurationSchemaV1, ProviderManifestV1, ProviderRuntimeContext, REQUIRED_ADAPTER_METHODS, VerificationAdapterV1, assertAdapterConformsToManifest, assertProviderManifest, bytesToHex, createAllowlistedHttp, createControlledFetch, createDefaultRuntime, createSignedWebhookFixture, defineProviderManifest, denySecretLogging, deterministicId, emptyConfigurationSchema, plainStringProperty, providerManifestV1JsonSchema, secretStringProperty, sha256Hex, signHmacSha256Hex, silentLogger };

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":["index.d.ts"],"names":[],"mappings":"AAAA"}