@korala/api-client 1.5.0 → 1.6.1

package/dist/client.d.ts

@@ -1,3 +1,4 @@
+import { CatalogResource } from './resources/catalog.js';
 import { DocumentsResource } from './resources/documents.js';
 import { FieldsResource } from './resources/fields.js';
 import { SessionsResource } from './resources/sessions.js';
@@ -13,6 +14,7 @@ export interface KoralaClientConfig {
     timeout?: number;
 }
 export declare class KoralaClient {
+    readonly catalog: CatalogResource;
     readonly documents: DocumentsResource;
     readonly signers: SignersResource;
     readonly fields: FieldsResource;

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,qBAAa,YAAY;IACvB,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,MAAM,EAAE,kBAAkB;CAiBvC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,qBAAa,YAAY;IACvB,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,SAAgB,UAAU,EAAE,kBAAkB,CAAC;IAC/C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,SAAgB,SAAS,EAAE,iBAAiB,CAAC;IAC7C,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAE3C,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;gBAEtB,MAAM,EAAE,kBAAkB;CAkBvC"}

package/dist/client.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KoralaClient = void 0;
 const http_js_1 = require("./http.js");
+const catalog_js_1 = require("./resources/catalog.js");
 const documents_js_1 = require("./resources/documents.js");
 const fields_js_1 = require("./resources/fields.js");
 const sessions_js_1 = require("./resources/sessions.js");
@@ -13,6 +14,7 @@ const workflows_js_1 = require("./resources/workflows.js");
 const DEFAULT_BASE_URL = 'https://api.korala.ai/api/v1';
 const DEFAULT_TIMEOUT = 30000;
 class KoralaClient {
+    catalog;
     documents;
     signers;
     fields;
@@ -29,6 +31,7 @@ class KoralaClient {
             baseUrl: config.baseUrl ?? DEFAULT_BASE_URL,
             timeout: config.timeout ?? DEFAULT_TIMEOUT,
         });
+        this.catalog = new catalog_js_1.CatalogResource(this.http);
         this.documents = new documents_js_1.DocumentsResource(this.http);
         this.signers = new signers_js_1.SignersResource(this.http);
         this.fields = new fields_js_1.FieldsResource(this.http);

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-export type { AddFieldDto, AddSignerDto, AuditEventDto, CreateDocumentFromTemplateDto, CreateSignerRoleDto, CreateTemplateDto, CreateTemplateFieldDto, CreateTemplateUploadUrlDto, CreateUploadUrlDto, CreateWebhookDto, CreateWorkflowDefinitionDto, DocumentCompletedEventData, DocumentCreatedEventData, DocumentDeclinedEventData, DocumentDto, DocumentFailedEventData, DocumentSentEventData, DocumentSignedEventData, DocumentViewedEventData, DocumentVoidedEventData, FieldDto, GenerateDocumentDto, GeneratedDocumentDto, PaginatedSessionsDto, PaginatedWorkflowDefinitionsDto, PaginatedWorkflowRunsDto, SessionAccessDto, SessionCheckDto, SessionCheckMatchDto, SessionConfigurationDto, SessionDetailDto, SessionDto, SessionParticipantDto, SessionWorkflowBindingDto, SessionWorkflowDto, SignerDto, StartSessionWorkflowResponseDto, StartWorkflowRunDto, StartWorkflowRunResponseDto, TemplateDto, TemplateFieldDto, TemplateSignerRoleDto, TemplateUploadUrlResponseDto, TemplateWithDetailsDto, TestEventData, UpdateSignerRoleDto, UpdateTemplateDto, UpdateTemplateFieldDto, UpdateWebhookDto, UpdateWorkflowDefinitionDto, UploadUrlResponseDto, WebhookDeliveryDto, WebhookDto, WebhookPayloadDto, WebhookWithSecretDto, WorkflowDefinitionDto, WorkflowRunDto, WorkflowRunWithStepsDto, WorkflowStepRunDto, } from '@korala/public-dtos';
-export { AuthMethod, CheckBlockingMode, CheckKind, CheckStatus, DocumentStatus, FieldType, SessionParticipantRole, SessionResolution, SessionStatus, SessionWorkflowStatus, SignerRole, SignerStatus, SubjectKind, WebhookDeliveryStatus, WebhookEventType, WorkflowRunStatus, WorkflowStepType, } from '@korala/public-dtos';
+export * from '@korala/public-dtos';
 export { KoralaClient, type KoralaClientConfig } from './client.js';
 export type { ValidationError } from './errors.js';
 export { KoralaError, KoralaValidationError } from './errors.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,YAAY,EAEV,WAAW,EAEX,YAAY,EACZ,aAAa,EAEb,6BAA6B,EAC7B,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,0BAA0B,EAE1B,kBAAkB,EAElB,gBAAgB,EAEhB,2BAA2B,EAC3B,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,WAAW,EACX,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,QAAQ,EACR,mBAAmB,EACnB,oBAAoB,EAEpB,oBAAoB,EACpB,+BAA+B,EAC/B,wBAAwB,EACxB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,uBAAuB,EACvB,gBAAgB,EAChB,UAAU,EACV,qBAAqB,EACrB,yBAAyB,EACzB,kBAAkB,EAClB,SAAS,EACT,+BAA+B,EAC/B,mBAAmB,EACnB,2BAA2B,EAC3B,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,4BAA4B,EAC5B,sBAAsB,EACtB,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,sBAAsB,EACtB,gBAAgB,EAChB,2BAA2B,EAC3B,oBAAoB,EACpB,kBAAkB,EAClB,UAAU,EACV,iBAAiB,EACjB,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACd,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,UAAU,EACV,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,cAAc,EACd,SAAS,EACT,sBAAsB,EACtB,iBAAiB,EACjB,aAAa,EACb,qBAAqB,EACrB,UAAU,EACV,YAAY,EACZ,WAAW,EACX,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACpE,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACjE,YAAY,EACV,iCAAiC,EACjC,oBAAoB,EACpB,+BAA+B,EAC/B,mBAAmB,EACnB,qBAAqB,EACrB,6BAA6B,EAC7B,iCAAiC,GAClC,MAAM,yBAAyB,CAAC;AAEjC,YAAY,EACV,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EACV,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,aAAa,EACd,MAAM,qBAAqB,CAAC;AAE7B,4CAA4C;AAC5C,MAAM,MAAM,gBAAgB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,uBAAuB,GACvB,uBAAuB,GACvB,0BAA0B,GAC1B,uBAAuB,GACvB,uBAAuB,GACvB,yBAAyB,GACzB,aAAa,CAAC;AAClB,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,cAAc,qBAAqB,CAAC;AACpC,OAAO,EAAE,YAAY,EAAE,KAAK,kBAAkB,EAAE,MAAM,aAAa,CAAC;AACpE,YAAY,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACjE,YAAY,EACV,iCAAiC,EACjC,oBAAoB,EACpB,+BAA+B,EAC/B,mBAAmB,EACnB,qBAAqB,EACrB,6BAA6B,EAC7B,iCAAiC,GAClC,MAAM,yBAAyB,CAAC;AAEjC,YAAY,EACV,uBAAuB,EACvB,oBAAoB,GACrB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EACV,0BAA0B,EAC1B,wBAAwB,EACxB,yBAAyB,EACzB,uBAAuB,EACvB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,aAAa,EACd,MAAM,qBAAqB,CAAC;AAE7B,4CAA4C;AAC5C,MAAM,MAAM,gBAAgB,GACxB,wBAAwB,GACxB,qBAAqB,GACrB,uBAAuB,GACvB,uBAAuB,GACvB,0BAA0B,GAC1B,uBAAuB,GACvB,uBAAuB,GACvB,yBAAyB,GACzB,aAAa,CAAC;AAClB,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAEjE,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -1,26 +1,24 @@
 "use strict";
 // Client
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyWebhookSignature = exports.KoralaValidationError = exports.KoralaError = exports.KoralaClient = exports.WorkflowStepType = exports.WorkflowRunStatus = exports.WebhookEventType = exports.WebhookDeliveryStatus = exports.SubjectKind = exports.SignerStatus = exports.SignerRole = exports.SessionWorkflowStatus = exports.SessionStatus = exports.SessionResolution = exports.SessionParticipantRole = exports.FieldType = exports.DocumentStatus = exports.CheckStatus = exports.CheckKind = exports.CheckBlockingMode = exports.AuthMethod = void 0;
-// Re-export enums as values (not just types)
-var public_dtos_1 = require("@korala/public-dtos");
-Object.defineProperty(exports, "AuthMethod", { enumerable: true, get: function () { return public_dtos_1.AuthMethod; } });
-Object.defineProperty(exports, "CheckBlockingMode", { enumerable: true, get: function () { return public_dtos_1.CheckBlockingMode; } });
-Object.defineProperty(exports, "CheckKind", { enumerable: true, get: function () { return public_dtos_1.CheckKind; } });
-Object.defineProperty(exports, "CheckStatus", { enumerable: true, get: function () { return public_dtos_1.CheckStatus; } });
-Object.defineProperty(exports, "DocumentStatus", { enumerable: true, get: function () { return public_dtos_1.DocumentStatus; } });
-Object.defineProperty(exports, "FieldType", { enumerable: true, get: function () { return public_dtos_1.FieldType; } });
-Object.defineProperty(exports, "SessionParticipantRole", { enumerable: true, get: function () { return public_dtos_1.SessionParticipantRole; } });
-Object.defineProperty(exports, "SessionResolution", { enumerable: true, get: function () { return public_dtos_1.SessionResolution; } });
-Object.defineProperty(exports, "SessionStatus", { enumerable: true, get: function () { return public_dtos_1.SessionStatus; } });
-Object.defineProperty(exports, "SessionWorkflowStatus", { enumerable: true, get: function () { return public_dtos_1.SessionWorkflowStatus; } });
-Object.defineProperty(exports, "SignerRole", { enumerable: true, get: function () { return public_dtos_1.SignerRole; } });
-Object.defineProperty(exports, "SignerStatus", { enumerable: true, get: function () { return public_dtos_1.SignerStatus; } });
-Object.defineProperty(exports, "SubjectKind", { enumerable: true, get: function () { return public_dtos_1.SubjectKind; } });
-Object.defineProperty(exports, "WebhookDeliveryStatus", { enumerable: true, get: function () { return public_dtos_1.WebhookDeliveryStatus; } });
-Object.defineProperty(exports, "WebhookEventType", { enumerable: true, get: function () { return public_dtos_1.WebhookEventType; } });
-Object.defineProperty(exports, "WorkflowRunStatus", { enumerable: true, get: function () { return public_dtos_1.WorkflowRunStatus; } });
-Object.defineProperty(exports, "WorkflowStepType", { enumerable: true, get: function () { return public_dtos_1.WorkflowStepType; } });
+exports.verifyWebhookSignature = exports.KoralaValidationError = exports.KoralaError = exports.KoralaClient = void 0;
+// Re-export everything from @korala/public-dtos (types + enums) so SDK
+// consumers get every DTO the API exposes without a hand-maintained list.
+__exportStar(require("@korala/public-dtos"), exports);
 var client_js_1 = require("./client.js");
 Object.defineProperty(exports, "KoralaClient", { enumerable: true, get: function () { return client_js_1.KoralaClient; } });
 // Errors

package/dist/resources/catalog.d.ts

@@ -0,0 +1,16 @@
+import type { CatalogFormSummaryDto, CreateTemplateFromCatalogDto, TemplateDto } from '@korala/public-dtos';
+import type { HttpClient } from '../http.js';
+/** Korala-curated standard forms (IRS W-9/W-8 family) you can clone. */
+export declare class CatalogResource {
+    private readonly http;
+    constructor(http: HttpClient);
+    /** List standard forms available to clone into your organization. */
+    listForms(): Promise<CatalogFormSummaryDto[]>;
+    /**
+     * Clone a catalog form version into an org template (seed PDF copied,
+     * mapped fields + signer roles created). Use the returned template with the
+     * normal generate/sign flow.
+     */
+    createTemplate(versionId: string, data?: CreateTemplateFromCatalogDto): Promise<TemplateDto>;
+}
+//# sourceMappingURL=catalog.d.ts.map

package/dist/resources/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../../src/resources/catalog.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qBAAqB,EACrB,4BAA4B,EAC5B,WAAW,EACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE7C,wEAAwE;AACxE,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,qEAAqE;IACrE,SAAS,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAI7C;;;;OAIG;IACH,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,4BAAiC,GACtC,OAAO,CAAC,WAAW,CAAC;CAMxB"}

package/dist/resources/catalog.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogResource = void 0;
+/** Korala-curated standard forms (IRS W-9/W-8 family) you can clone. */
+class CatalogResource {
+    http;
+    constructor(http) {
+        this.http = http;
+    }
+    /** List standard forms available to clone into your organization. */
+    listForms() {
+        return this.http.get('/catalog/forms');
+    }
+    /**
+     * Clone a catalog form version into an org template (seed PDF copied,
+     * mapped fields + signer roles created). Use the returned template with the
+     * normal generate/sign flow.
+     */
+    createTemplate(versionId, data = {}) {
+        return this.http.post(`/catalog/forms/${versionId}/create-template`, data);
+    }
+}
+exports.CatalogResource = CatalogResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@korala/api-client",
-  "version": "1.5.0",
+  "version": "1.6.1",
   "description": "TypeScript API client for Korala document signing API",
   "license": "MIT",
   "homepage": "https://docs.korala.ai",
@@ -30,7 +30,7 @@
   ],
   "dependencies": {
     "@korala/auth": "^1.1.0",
-    "@korala/public-dtos": "^1.5.0"
+    "@korala/public-dtos": "^1.6.0"
   },
   "devDependencies": {
     "typescript": "^5.9.3"