@insureco/docman 1.0.0

package/dist/types-xbeSIrNB.d.ts

@@ -0,0 +1,185 @@
+interface DocmanClientConfig {
+    /** Base URL of the docman service (e.g. from DOCMAN_URL env var) */
+    readonly baseUrl: string;
+    /** Async function that returns a valid Bearer token (Bio-ID client_credentials) */
+    readonly accessTokenFn?: () => Promise<string>;
+    /** Internal service key for service-to-service auth */
+    readonly internalKey?: string;
+    /** Max retry attempts on network/5xx errors (default: 2) */
+    readonly retries?: number;
+    /** Request timeout in milliseconds (default: 15000) */
+    readonly timeoutMs?: number;
+}
+interface HtmlTemplate {
+    readonly _id: string;
+    readonly name: string;
+    readonly description?: string;
+    readonly org: string;
+    readonly html: string;
+    readonly landscape: boolean;
+    readonly variables: readonly string[];
+    readonly isSystem: boolean;
+    readonly archived: boolean;
+    readonly createdBy: string;
+    readonly updatedBy?: string;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+interface CreateHtmlTemplateOptions {
+    readonly name: string;
+    readonly description?: string;
+    readonly html: string;
+    readonly landscape?: boolean;
+    readonly isSystem?: boolean;
+}
+interface UpdateHtmlTemplateOptions {
+    readonly name?: string;
+    readonly description?: string;
+    readonly html?: string;
+    readonly landscape?: boolean;
+    readonly isSystem?: boolean;
+}
+interface HtmlTemplateListQuery extends ListQuery {
+    readonly archived?: boolean;
+}
+interface PdfField {
+    readonly name: string;
+    readonly type: string;
+    readonly required: boolean;
+}
+interface TemplateCoordinates {
+    readonly customer?: string;
+    readonly agent?: string;
+}
+interface PdfTemplate {
+    readonly _id: string;
+    readonly name: string;
+    readonly description?: string;
+    readonly org: string;
+    readonly storageKey: string;
+    readonly fields: readonly PdfField[];
+    readonly pages: number;
+    readonly coordinates?: TemplateCoordinates;
+    readonly isSystem: boolean;
+    readonly archived: boolean;
+    readonly createdBy: string;
+    readonly updatedBy?: string;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+interface CreatePdfTemplateOptions {
+    readonly name?: string;
+    readonly description?: string;
+    readonly coordinates?: TemplateCoordinates;
+    readonly isSystem?: boolean;
+}
+interface UpdatePdfTemplateOptions {
+    readonly name?: string;
+    readonly description?: string;
+    readonly coordinates?: TemplateCoordinates;
+    readonly isSystem?: boolean;
+}
+interface PdfTemplateListQuery extends ListQuery {
+    readonly archived?: boolean;
+}
+interface TemplateGroupItem {
+    readonly templateId: string;
+    readonly templateType: 'pdf' | 'html';
+}
+interface TemplateGroup {
+    readonly _id: string;
+    readonly name: string;
+    readonly org: string;
+    readonly templates: readonly TemplateGroupItem[];
+    readonly terms?: string;
+    readonly coordinates?: TemplateCoordinates;
+    readonly createdBy: string;
+    readonly updatedBy?: string;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+interface CreateTemplateGroupOptions {
+    readonly name: string;
+    readonly templates: readonly TemplateGroupItem[];
+    readonly terms?: string;
+    readonly coordinates?: TemplateCoordinates;
+}
+interface UpdateTemplateGroupOptions {
+    readonly name?: string;
+    readonly templates?: readonly TemplateGroupItem[];
+    readonly terms?: string;
+    readonly coordinates?: TemplateCoordinates;
+}
+interface SourceTemplate {
+    readonly templateId: string;
+    readonly templateType: 'pdf' | 'html';
+}
+interface DocmanDocument {
+    readonly _id: string;
+    readonly name: string;
+    readonly description?: string;
+    readonly org: string;
+    readonly storageKey: string;
+    readonly version: number;
+    readonly sourceTemplates: readonly SourceTemplate[];
+    readonly templateData?: Record<string, unknown>;
+    readonly pages: number;
+    readonly sizeBytes: number;
+    readonly deliveryMode: 'managed' | 'passthrough';
+    readonly shareToken: string;
+    readonly createdBy: string;
+    readonly createdAt: string;
+    readonly updatedAt: string;
+}
+interface DocumentVersion {
+    readonly _id: string;
+    readonly version: number;
+    readonly pages: number;
+    readonly sizeBytes: number;
+    readonly createdAt: string;
+    readonly createdBy: string;
+}
+interface GenerateOptions {
+    /** Template IDs to render and merge into the final document */
+    readonly templateIds: readonly string[];
+    /** Data passed to Handlebars templates and PDF form fields */
+    readonly data: Record<string, unknown>;
+    /** Human-readable document name (used for storage and display) */
+    readonly name: string;
+    readonly description?: string;
+}
+interface GenerateResult {
+    readonly documentId: string;
+    readonly version: number;
+    /** Presigned S3 URL (1-hour TTL) */
+    readonly downloadUrl: string;
+    /** Public share URL: /d/:shareToken */
+    readonly publicUrl: string;
+    readonly pages: number;
+    readonly sizeBytes: number;
+}
+interface ListQuery {
+    readonly page?: number;
+    readonly limit?: number;
+}
+interface ListMeta {
+    readonly total: number;
+    readonly page: number;
+    readonly limit: number;
+}
+interface ListResult<T> {
+    readonly data: readonly T[];
+    readonly meta: ListMeta;
+}
+interface PageRange {
+    readonly start: number;
+    readonly end: number;
+}
+interface SplitPart {
+    readonly index: number;
+    readonly range: PageRange;
+    readonly buffer: Buffer;
+    readonly sizeBytes: number;
+}
+
+export type { CreateHtmlTemplateOptions as C, DocmanClientConfig as D, GenerateOptions as G, HtmlTemplate as H, ListResult as L, PdfTemplate as P, SplitPart as S, TemplateGroup as T, UpdateHtmlTemplateOptions as U, HtmlTemplateListQuery as a, CreatePdfTemplateOptions as b, PdfTemplateListQuery as c, PdfField as d, UpdatePdfTemplateOptions as e, CreateTemplateGroupOptions as f, ListQuery as g, UpdateTemplateGroupOptions as h, GenerateResult as i, DocmanDocument as j, DocumentVersion as k, PageRange as l, ListMeta as m, SourceTemplate as n, TemplateCoordinates as o, TemplateGroupItem as p };

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@insureco/docman",
+  "version": "1.0.0",
+  "description": "SDK for the iec-docman document generation service",
+  "license": "PRIVATE",
+  "type": "module",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./testing": {
+      "types": "./dist/mock.d.ts",
+      "import": "./dist/mock.mjs",
+      "require": "./dist/mock.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.5.0",
+    "vitest": "^2.0.0"
+  },
+  "publishConfig": {
+    "access": "restricted"
+  }
+}