@smileid/usesmileid-nodejs 12.0.0

package/dist/helpers/multipart.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Multipart/form-data serialization (spec §5.3).
+ *
+ * Built by hand (rather than via the platform FormData) so the exact wire bytes
+ * are known: this lets the golden-fixture tests assert the precise structure
+ * and keeps JSON object parts free of the spurious `filename="blob"` the
+ * platform adds.
+ *
+ * Rules applied here:
+ *  - scalar fields → plain text part;
+ *  - object / array fields (consent, user_details, partner_params, metadata) →
+ *    one part, body = JSON, Content-Type: application/json;
+ *  - single binary fields → one binary part with a filename + content type;
+ *  - binary arrays (liveness_images) → one repeated part per image, same name.
+ */
+/** A scalar text part (e.g. country, id_type). */
+export interface ScalarPart {
+    kind: 'scalar';
+    name: string;
+    value: string;
+}
+/** A JSON object/array part with Content-Type: application/json. */
+export interface JsonPart {
+    kind: 'json';
+    name: string;
+    /** Pre-serialized JSON string. */
+    json: string;
+}
+/** A binary part with a filename and content type. */
+export interface BinaryPart {
+    kind: 'binary';
+    name: string;
+    filename: string;
+    contentType: string;
+    bytes: Buffer;
+}
+export type MultipartPart = ScalarPart | JsonPart | BinaryPart;
+/** The serialized body plus the Content-Type header value carrying the boundary. */
+export interface SerializedMultipart {
+    body: Buffer;
+    contentType: string;
+}
+/**
+ * Strip characters from a caller-supplied filename that would break part
+ * framing (RFC 7578): CR, LF, and double quotes.
+ */
+export declare function sanitizeFilename(filename: string): string;
+/** Serialize parts into a multipart/form-data body (spec §5.3). */
+export declare function buildMultipart(parts: MultipartPart[]): SerializedMultipart;

package/dist/helpers/multipart.js

@@ -0,0 +1,67 @@
+"use strict";
+/**
+ * Multipart/form-data serialization (spec §5.3).
+ *
+ * Built by hand (rather than via the platform FormData) so the exact wire bytes
+ * are known: this lets the golden-fixture tests assert the precise structure
+ * and keeps JSON object parts free of the spurious `filename="blob"` the
+ * platform adds.
+ *
+ * Rules applied here:
+ *  - scalar fields → plain text part;
+ *  - object / array fields (consent, user_details, partner_params, metadata) →
+ *    one part, body = JSON, Content-Type: application/json;
+ *  - single binary fields → one binary part with a filename + content type;
+ *  - binary arrays (liveness_images) → one repeated part per image, same name.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sanitizeFilename = sanitizeFilename;
+exports.buildMultipart = buildMultipart;
+const node_crypto_1 = require("node:crypto");
+const index_js_1 = require("../errors/index.js");
+const CRLF = '\r\n';
+/** RFC 7230 media-type shape, e.g. image/jpeg or application/json. */
+const SAFE_CONTENT_TYPE = /^[!#$%&'*+.^_`|~0-9A-Za-z-]+\/[!#$%&'*+.^_`|~0-9A-Za-z-]+$/;
+/**
+ * Strip characters from a caller-supplied filename that would break part
+ * framing (RFC 7578): CR, LF, and double quotes.
+ */
+function sanitizeFilename(filename) {
+    return filename.replace(/[\r\n"]/g, '_');
+}
+/** Reject content types that cannot be interpolated into a part header safely. */
+function assertSafeContentType(contentType) {
+    if (!SAFE_CONTENT_TYPE.test(contentType)) {
+        throw new index_js_1.ValidationError({
+            message: `Invalid content type for a multipart part: ${JSON.stringify(contentType)}.`,
+        });
+    }
+}
+/** Serialize parts into a multipart/form-data body (spec §5.3). */
+function buildMultipart(parts) {
+    const boundary = `----smileidFormBoundary${(0, node_crypto_1.randomBytes)(16).toString('hex')}`;
+    const segments = [];
+    for (const part of parts) {
+        let header = `--${boundary}${CRLF}`;
+        if (part.kind === 'binary') {
+            assertSafeContentType(part.contentType);
+            header += `Content-Disposition: form-data; name="${part.name}"; filename="${sanitizeFilename(part.filename)}"${CRLF}`;
+            header += `Content-Type: ${part.contentType}${CRLF}${CRLF}`;
+            segments.push(Buffer.from(header, 'utf8'), part.bytes, Buffer.from(CRLF, 'utf8'));
+        }
+        else if (part.kind === 'json') {
+            header += `Content-Disposition: form-data; name="${part.name}"${CRLF}`;
+            header += `Content-Type: application/json${CRLF}${CRLF}`;
+            segments.push(Buffer.from(header + part.json + CRLF, 'utf8'));
+        }
+        else {
+            header += `Content-Disposition: form-data; name="${part.name}"${CRLF}${CRLF}`;
+            segments.push(Buffer.from(header + part.value + CRLF, 'utf8'));
+        }
+    }
+    segments.push(Buffer.from(`--${boundary}--${CRLF}`, 'utf8'));
+    return {
+        body: Buffer.concat(segments),
+        contentType: `multipart/form-data; boundary=${boundary}`,
+    };
+}

package/dist/helpers/poll.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Polling helper for verifications.waitUntilComplete (spec §6.9).
+ *
+ * Repeatedly calls the retrieve function until the job completes or the
+ * deadline passes. Defaults (interval 2s, timeout 60s) are SDK choices.
+ *
+ * A job is complete once its status is neither `processing` nor `not_found`,
+ * so the helper returns the terminal decision itself (`clear`, `block`,
+ * `attention` or `error`).
+ */
+import type { JobStatus, WaitOptions } from '../generated/models/index.js';
+/** Wait until a job reaches a terminal decision, or raise {@link TimeoutError}. */
+export declare function waitUntilComplete(retrieve: () => Promise<JobStatus>, opts?: WaitOptions, sleep?: (ms: number) => Promise<void>): Promise<JobStatus>;

package/dist/helpers/poll.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * Polling helper for verifications.waitUntilComplete (spec §6.9).
+ *
+ * Repeatedly calls the retrieve function until the job completes or the
+ * deadline passes. Defaults (interval 2s, timeout 60s) are SDK choices.
+ *
+ * A job is complete once its status is neither `processing` nor `not_found`,
+ * so the helper returns the terminal decision itself (`clear`, `block`,
+ * `attention` or `error`).
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitUntilComplete = waitUntilComplete;
+const index_js_1 = require("../errors/index.js");
+/** Wait until a job reaches a terminal decision, or raise {@link TimeoutError}. */
+async function waitUntilComplete(retrieve, opts = {}, sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms))) {
+    const interval = opts.interval ?? 2000;
+    const timeout = opts.timeout ?? 60000;
+    const treatNotFoundAsPending = opts.treatNotFoundAsPending ?? true;
+    const deadline = Date.now() + timeout;
+    for (;;) {
+        const status = await retrieve();
+        if (status.isComplete)
+            return status;
+        if (status.isNotFound && !treatNotFoundAsPending)
+            return status;
+        if (Date.now() >= deadline) {
+            throw new index_js_1.TimeoutError({
+                message: `Timed out after ${timeout}ms waiting for job to complete.`,
+            });
+        }
+        opts.signal?.throwIfAborted();
+        await sleep(interval);
+    }
+}

package/dist/helpers/validation.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Client-side validation performed before a request is sent (spec §5.1, §6.6, §6.11).
+ *
+ * These raise {@link ValidationError} (a subtype of InvalidRequestError) so a
+ * bad call fails fast without a network round trip.
+ */
+import type { AuthenticationParams, ReportFraudParams, UserDetails } from '../generated/models/index.js';
+/**
+ * URLs given to the SDK must be absolute https URLs (fleet standard). Applies
+ * to the base URL (which additionally may not carry a query or fragment) and
+ * to callback URLs, both at construction and per request.
+ */
+export declare function assertHttpsUrl(value: string, label: string, opts?: {
+    forbidQueryAndFragment?: boolean;
+}): void;
+/** user_details must carry at least one of email / phone_number (spec §5.1). */
+export declare function validateUserDetails(userDetails: UserDetails): void;
+/**
+ * report_fraud conditional rules (spec §6.11):
+ * - reason is required when isFraud is true;
+ * - notes is required when isFraud is false OR reason is OTHER.
+ */
+export declare function validateReportFraud(params: ReportFraudParams): void;
+/**
+ * authentication image rule (spec §6.6): unless useEnrolledImage is true,
+ * selfieImage and livenessImages are both required.
+ */
+export declare function validateAuthentication(params: AuthenticationParams): void;

package/dist/helpers/validation.js

@@ -0,0 +1,86 @@
+"use strict";
+/**
+ * Client-side validation performed before a request is sent (spec §5.1, §6.6, §6.11).
+ *
+ * These raise {@link ValidationError} (a subtype of InvalidRequestError) so a
+ * bad call fails fast without a network round trip.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertHttpsUrl = assertHttpsUrl;
+exports.validateUserDetails = validateUserDetails;
+exports.validateReportFraud = validateReportFraud;
+exports.validateAuthentication = validateAuthentication;
+const index_js_1 = require("../errors/index.js");
+/**
+ * URLs given to the SDK must be absolute https URLs (fleet standard). Applies
+ * to the base URL (which additionally may not carry a query or fragment) and
+ * to callback URLs, both at construction and per request.
+ */
+function assertHttpsUrl(value, label, opts = {}) {
+    let url;
+    try {
+        url = new URL(value);
+    }
+    catch {
+        throw new index_js_1.ValidationError({ message: `${label} must be an absolute https URL.` });
+    }
+    if (url.protocol !== 'https:') {
+        throw new index_js_1.ValidationError({ message: `${label} must use https.` });
+    }
+    if (opts.forbidQueryAndFragment && (url.search !== '' || url.hash !== '')) {
+        throw new index_js_1.ValidationError({
+            message: `${label} must not contain a query string or fragment.`,
+        });
+    }
+}
+/** user_details must carry at least one of email / phone_number (spec §5.1). */
+function validateUserDetails(userDetails) {
+    const hasEmail = typeof userDetails.email === 'string' && userDetails.email.length > 0;
+    const hasPhone = typeof userDetails.phoneNumber === 'string' && userDetails.phoneNumber.length > 0;
+    if (!hasEmail && !hasPhone) {
+        throw new index_js_1.ValidationError({
+            message: 'userDetails requires at least one of email or phoneNumber.',
+        });
+    }
+}
+/**
+ * report_fraud conditional rules (spec §6.11):
+ * - reason is required when isFraud is true;
+ * - notes is required when isFraud is false OR reason is OTHER.
+ */
+function validateReportFraud(params) {
+    const hasNotes = typeof params.notes === 'string' && params.notes.length > 0;
+    if (params.isFraud && !params.reason) {
+        throw new index_js_1.ValidationError({
+            message: 'reason is required when isFraud is true.',
+        });
+    }
+    if (!params.isFraud && !hasNotes) {
+        throw new index_js_1.ValidationError({
+            message: 'notes is required when isFraud is false.',
+        });
+    }
+    if (params.reason === 'OTHER' && !hasNotes) {
+        throw new index_js_1.ValidationError({
+            message: 'notes is required when reason is OTHER.',
+        });
+    }
+    if (typeof params.notes === 'string' && params.notes.length > 500) {
+        throw new index_js_1.ValidationError({ message: 'notes must be at most 500 characters.' });
+    }
+}
+/**
+ * authentication image rule (spec §6.6): unless useEnrolledImage is true,
+ * selfieImage and livenessImages are both required.
+ */
+function validateAuthentication(params) {
+    if (params.useEnrolledImage === true)
+        return;
+    const hasSelfie = params.selfieImage !== undefined && params.selfieImage !== null;
+    const hasLiveness = Array.isArray(params.livenessImages) && params.livenessImages.length > 0;
+    if (!hasSelfie || !hasLiveness) {
+        throw new index_js_1.ValidationError({
+            message: 'selfieImage and livenessImages are required unless useEnrolledImage is true.',
+        });
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @smileid/usesmileid-nodejs — the official Smile ID server-side SDK for JavaScript/TypeScript.
+ *
+ * ```ts
+ * import { SmileID, Consent } from '@smileid/usesmileid-nodejs';
+ * ```
+ */
+export { VERSION } from './version.js';
+export { SmileID } from './client/client.js';
+export type { SmileIDConfig, FetchLike } from './client/config.js';
+export { Consent } from './helpers/consent.js';
+export type { ConsentGrantedArgs } from './helpers/consent.js';
+export { AcceptedResponse, JobStatus } from './generated/models/index.js';
+export type { Environment, BinaryInput, RequestOptions, WaitOptions, Consent as ConsentType, UserDetails, PartnerParams, MetadataItem, EnhancedKycParams, DocumentVerificationParams, EnhancedDocumentVerificationParams, BiometricKycParams, RegistrationParams, AuthenticationParams, CompareParams, ComparisonImageType, ReplayParams, FraudReason, ReportFraudParams, FlagFraudParams, ClearFraudParams, BankCodesParams, BankCodesResponse, SupportedIdTypesParams, SupportedIdTypesResponse, SupportedDocumentsParams, SupportedDocumentsResponse, IdStatusParams, IdStatusResponse, } from './generated/models/index.js';
+export { SmileIDError, InvalidRequestError, AuthenticationError, PaymentRequiredError, PermissionError, NotFoundError, ConflictError, PayloadTooLargeError, RateLimitError, APIError, ConnectionError, UnexpectedResponseError, TimeoutError, ValidationError, } from './errors/index.js';
+export type { SmileIDErrorFields } from './errors/index.js';

package/dist/index.js

@@ -0,0 +1,38 @@
+"use strict";
+/**
+ * @smileid/usesmileid-nodejs — the official Smile ID server-side SDK for JavaScript/TypeScript.
+ *
+ * ```ts
+ * import { SmileID, Consent } from '@smileid/usesmileid-nodejs';
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidationError = exports.TimeoutError = exports.UnexpectedResponseError = exports.ConnectionError = exports.APIError = exports.RateLimitError = exports.PayloadTooLargeError = exports.ConflictError = exports.NotFoundError = exports.PermissionError = exports.PaymentRequiredError = exports.AuthenticationError = exports.InvalidRequestError = exports.SmileIDError = exports.JobStatus = exports.AcceptedResponse = exports.Consent = exports.SmileID = exports.VERSION = void 0;
+var version_js_1 = require("./version.js");
+Object.defineProperty(exports, "VERSION", { enumerable: true, get: function () { return version_js_1.VERSION; } });
+// Client + configuration.
+var client_js_1 = require("./client/client.js");
+Object.defineProperty(exports, "SmileID", { enumerable: true, get: function () { return client_js_1.SmileID; } });
+// Builders.
+var consent_js_1 = require("./helpers/consent.js");
+Object.defineProperty(exports, "Consent", { enumerable: true, get: function () { return consent_js_1.Consent; } });
+// Response models.
+var index_js_1 = require("./generated/models/index.js");
+Object.defineProperty(exports, "AcceptedResponse", { enumerable: true, get: function () { return index_js_1.AcceptedResponse; } });
+Object.defineProperty(exports, "JobStatus", { enumerable: true, get: function () { return index_js_1.JobStatus; } });
+// Error hierarchy.
+var index_js_2 = require("./errors/index.js");
+Object.defineProperty(exports, "SmileIDError", { enumerable: true, get: function () { return index_js_2.SmileIDError; } });
+Object.defineProperty(exports, "InvalidRequestError", { enumerable: true, get: function () { return index_js_2.InvalidRequestError; } });
+Object.defineProperty(exports, "AuthenticationError", { enumerable: true, get: function () { return index_js_2.AuthenticationError; } });
+Object.defineProperty(exports, "PaymentRequiredError", { enumerable: true, get: function () { return index_js_2.PaymentRequiredError; } });
+Object.defineProperty(exports, "PermissionError", { enumerable: true, get: function () { return index_js_2.PermissionError; } });
+Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return index_js_2.NotFoundError; } });
+Object.defineProperty(exports, "ConflictError", { enumerable: true, get: function () { return index_js_2.ConflictError; } });
+Object.defineProperty(exports, "PayloadTooLargeError", { enumerable: true, get: function () { return index_js_2.PayloadTooLargeError; } });
+Object.defineProperty(exports, "RateLimitError", { enumerable: true, get: function () { return index_js_2.RateLimitError; } });
+Object.defineProperty(exports, "APIError", { enumerable: true, get: function () { return index_js_2.APIError; } });
+Object.defineProperty(exports, "ConnectionError", { enumerable: true, get: function () { return index_js_2.ConnectionError; } });
+Object.defineProperty(exports, "UnexpectedResponseError", { enumerable: true, get: function () { return index_js_2.UnexpectedResponseError; } });
+Object.defineProperty(exports, "TimeoutError", { enumerable: true, get: function () { return index_js_2.TimeoutError; } });
+Object.defineProperty(exports, "ValidationError", { enumerable: true, get: function () { return index_js_2.ValidationError; } });

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "12.0.0";

package/dist/version.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '12.0.0';

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@smileid/usesmileid-nodejs",
+  "version": "12.0.0",
+  "description": "Official Smile ID server-side SDK for JavaScript/TypeScript — V3 APIs.",
+  "private": false,
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "prebuild": "rm -rf dist",
+    "build": "tsc",
+    "lint": "eslint .",
+    "test": "npm run build && node --test $(find dist -name '*.test.js')"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/smileidentity/smileid-sdk-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/smileidentity/smileid-sdk-js/issues"
+  },
+  "homepage": "https://github.com/smileidentity/smileid-sdk-js#readme",
+  "keywords": [
+    "smile",
+    "identity",
+    "kyc",
+    "sdk"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.js",
+    "!dist/**/*.test.d.ts",
+    "!dist/testing"
+  ],
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "eslint": "^9.39.2",
+    "globals": "^16.0.0",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.18.0"
+  }
+}