@abyss-project/extract 0.0.0-stage → 1.0.0

package/dist/types/enum/index.js

@@ -0,0 +1,29 @@
+"use strict";
+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 });
+__exportStar(require("./api-error.enum"), exports);
+__exportStar(require("./document-type.enum"), exports);
+__exportStar(require("./extract-bank.enum"), exports);
+__exportStar(require("./extraction-warning.enum"), exports);
+__exportStar(require("./extract-field-key.enum"), exports);
+__exportStar(require("./extract-field-format.enum"), exports);
+__exportStar(require("./extraction-feedback-issue-type.enum"), exports);
+__exportStar(require("./provider-kind.enum"), exports);
+__exportStar(require("./interpreter-kind.enum"), exports);
+__exportStar(require("./combine-strategy.enum"), exports);
+__exportStar(require("./extraction-step-status.enum"), exports);
+__exportStar(require("./file-scan-status.enum"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/enum/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,uDAAqC;AACrC,sDAAoC;AACpC,4DAA0C;AAC1C,2DAAyC;AACzC,8DAA4C;AAC5C,wEAAsD;AACtD,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,gEAA8C;AAC9C,0DAAwC"}

package/dist/types/enum/interpreter-kind.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum InterpreterKind {
+    ALGORITHMIC = "algorithmic",
+    TEMPLATE = "template",
+    LLM = "llm"
+}

package/dist/types/enum/interpreter-kind.enum.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InterpreterKind = void 0;
+var InterpreterKind;
+(function (InterpreterKind) {
+    InterpreterKind["ALGORITHMIC"] = "algorithmic";
+    InterpreterKind["TEMPLATE"] = "template";
+    InterpreterKind["LLM"] = "llm";
+})(InterpreterKind || (exports.InterpreterKind = InterpreterKind = {}));
+//# sourceMappingURL=interpreter-kind.enum.js.map

package/dist/types/enum/interpreter-kind.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interpreter-kind.enum.js","sourceRoot":"","sources":["../../../src/types/enum/interpreter-kind.enum.ts"],"names":[],"mappings":";;;AAEA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,8CAA2B,CAAA;IAC3B,wCAAqB,CAAA;IACrB,8BAAW,CAAA;AACb,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B"}

package/dist/types/enum/provider-kind.enum.d.ts

@@ -0,0 +1,10 @@
+export declare enum ProviderKind {
+    TEXT = "text",
+    OCR = "ocr",
+    AI = "ai"
+}
+export declare enum CostTier {
+    CHEAP = "cheap",
+    MEDIUM = "medium",
+    EXPENSIVE = "expensive"
+}

package/dist/types/enum/provider-kind.enum.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CostTier = exports.ProviderKind = void 0;
+var ProviderKind;
+(function (ProviderKind) {
+    ProviderKind["TEXT"] = "text";
+    ProviderKind["OCR"] = "ocr";
+    ProviderKind["AI"] = "ai";
+})(ProviderKind || (exports.ProviderKind = ProviderKind = {}));
+var CostTier;
+(function (CostTier) {
+    CostTier["CHEAP"] = "cheap";
+    CostTier["MEDIUM"] = "medium";
+    CostTier["EXPENSIVE"] = "expensive";
+})(CostTier || (exports.CostTier = CostTier = {}));
+//# sourceMappingURL=provider-kind.enum.js.map

package/dist/types/enum/provider-kind.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provider-kind.enum.js","sourceRoot":"","sources":["../../../src/types/enum/provider-kind.enum.ts"],"names":[],"mappings":";;;AAEA,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,6BAAa,CAAA;IACb,2BAAW,CAAA;IACX,yBAAS,CAAA;AACX,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB;AAED,IAAY,QAIX;AAJD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,6BAAiB,CAAA;IACjB,mCAAuB,CAAA;AACzB,CAAC,EAJW,QAAQ,wBAAR,QAAQ,QAInB"}

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './interface';
+export * from './enum';

package/dist/types/index.js

@@ -0,0 +1,19 @@
+"use strict";
+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 });
+__exportStar(require("./interface"), exports);
+__exportStar(require("./enum"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,yCAAuB"}

package/dist/types/interface/api/index.d.ts

@@ -0,0 +1,5 @@
+export * from './requests';
+export * from './responses';
+export * from './type-message/response';
+export * from './type-message/api-error';
+export * from './type-message/base-paginate';

package/dist/types/interface/api/index.js

@@ -0,0 +1,22 @@
+"use strict";
+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 });
+__exportStar(require("./requests"), exports);
+__exportStar(require("./responses"), exports);
+__exportStar(require("./type-message/response"), exports);
+__exportStar(require("./type-message/api-error"), exports);
+__exportStar(require("./type-message/base-paginate"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/interface/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,8CAA4B;AAC5B,0DAAwC;AACxC,2DAAyC;AACzC,+DAA6C"}

package/dist/types/interface/api/requests/extraction.request.d.ts

@@ -0,0 +1,259 @@
+import { ExtractionMode, ExtractionFeedbackIssueType, ExtractionFeedbackStatus, ProcessingMode, IExtractionBankHint } from '../../models/extraction.dto';
+import { DocumentType } from '../../../enum/document-type.enum';
+import type { IExtractionPlan } from '../../models/extraction-plan.dto';
+export interface IExtractionScopeQuery {
+    organization_id?: string;
+    project_id?: string;
+}
+export type IExtractionContentScopeQuery = IExtractionScopeQuery;
+export type IExtractionTemplateScopeQuery = IExtractionScopeQuery;
+export interface IExtractBody {
+    pdf?: Buffer | Uint8Array;
+    storage_file_id?: string;
+    mode: ExtractionMode;
+    hint?: IExtractionBankHint;
+    template_id?: string;
+    template?: Record<string, unknown>;
+    pdf_filename?: string;
+    user_external_id?: string;
+    user_metadata?: Record<string, unknown>;
+    archive?: boolean;
+    force?: boolean;
+    processing?: ProcessingMode;
+    improvementConsent?: boolean;
+    plan?: IExtractionPlan;
+    plan_preset_id?: string;
+}
+export interface IExtractApplicationBody {
+    pdf: Buffer | Uint8Array;
+    mode: Exclude<ExtractionMode, 'template'>;
+    hint?: IExtractionBankHint;
+    pdf_filename?: string;
+    user_external_id?: string;
+    user_metadata?: Record<string, unknown>;
+    archive?: boolean;
+    force?: boolean;
+    improvementConsent?: boolean;
+    plan?: IExtractionPlan;
+}
+export interface IExtractBulkBody {
+    items: Array<{
+        storage_file_id?: string;
+        pdf_base64?: string;
+        mode: ExtractionMode;
+        hint?: IExtractionBankHint;
+        template_id?: string;
+        template?: Record<string, unknown>;
+        pdf_filename?: string;
+        user_external_id?: string;
+        user_metadata?: Record<string, unknown>;
+        archive?: boolean;
+        force?: boolean;
+    }>;
+}
+export interface IDetectBulkBody {
+    items: Array<{
+        pdf_base64: string;
+        pdf_filename?: string;
+    }>;
+}
+export interface IListFilesQuery extends IExtractionContentScopeQuery {
+    hash?: string;
+    external_id?: string;
+    application_file_id?: string;
+    bank?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface IGetFileParams {
+    fileId: string;
+}
+export interface IPatchFileBody {
+    user_external_id?: string | null;
+    user_metadata?: Record<string, unknown> | null;
+}
+export interface IGetExtractionParams {
+    extractionId: string;
+}
+export interface IPatchExtractionBody {
+    tags?: string[] | null;
+    note?: string | null;
+}
+export interface ISearchExtractionRecordsQuery {
+    q?: string;
+    amount_min?: number;
+    amount_max?: number;
+    sign?: 'debit' | 'credit';
+    date_from?: string;
+    date_to?: string;
+    sort?: 'date' | 'amount' | 'description';
+    sort_dir?: 'asc' | 'desc';
+    limit?: number;
+    offset?: number;
+}
+export interface IExportExtractionQuery {
+    format: 'csv' | 'json';
+    delimiter?: ',' | ';' | '\t';
+}
+export interface IAsyncExportExtractionBody {
+    format: 'csv' | 'json';
+    delimiter?: ',' | ';' | '\t';
+}
+export interface IListTemplatesQuery {
+    kind?: 'spatial' | 'dsl';
+    archived?: 'true' | 'false' | 'all';
+    document_type?: DocumentType;
+}
+export interface ICreateTemplateBody {
+    name: string;
+    description?: string;
+    document_type?: DocumentType | null;
+    template_json: Record<string, unknown>;
+    comment?: string;
+    witness_pdf_base64?: string;
+    witness_filename?: string;
+}
+export interface IUpdateTemplateBody {
+    template_json: Record<string, unknown>;
+    comment?: string;
+    witness_pdf_base64?: string;
+    witness_filename?: string;
+}
+export interface IPatchTemplateMetaBody {
+    name?: string;
+    description?: string | null;
+    document_type?: DocumentType | null;
+    is_active?: boolean;
+}
+export interface ISubmitFeedbackExtractionBody {
+    extraction_id: string;
+    issue_type: ExtractionFeedbackIssueType;
+    field_key?: string;
+    expected_value?: string;
+    description?: string;
+}
+export interface IPatchFeedbackBody {
+    status: ExtractionFeedbackStatus;
+}
+export interface IListFeedbackQuery {
+    extraction_id?: string;
+    status?: ExtractionFeedbackStatus;
+    issue_type?: ExtractionFeedbackIssueType;
+    limit?: number;
+    offset?: number;
+}
+export interface IListUsageQuery {
+    application_id?: string;
+    event_type?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface ISummaryUsageQuery {
+    from?: string;
+    to?: string;
+}
+export interface IUsageByConfigQuery {
+    from?: string;
+    to?: string;
+}
+export interface IListWebhookDeliveriesQuery {
+    job_id?: string;
+    event?: string;
+    delivered?: boolean;
+    from?: string;
+    to?: string;
+    limit?: number;
+    offset?: number;
+}
+export interface IReplayWebhookDeliveryBody {
+    url?: string;
+    secret?: string;
+}
+export interface IMintShareExtractionBody {
+    expires_in_days?: number;
+}
+export interface IUpsertBankVersionAdminBody {
+    bank: string;
+    version: string;
+    valid_from?: string | null;
+    valid_to?: string | null;
+    detector_json: Record<string, unknown>;
+    parser_kind: string;
+    config_json: Record<string, unknown>;
+    is_active?: boolean;
+}
+export interface IToggleBankVersionActiveAdminBody {
+    is_active: boolean;
+}
+export interface IDetectorReplayAdminBody {
+    detected_bank?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+}
+export interface IListRequestLogAdminQuery {
+    since_ms?: number;
+    status_min?: number;
+    status_max?: number;
+    user_id?: string;
+    path_prefix?: string;
+    limit?: number;
+}
+import type { ExtractionWebhookEvent } from '../../models/extraction.dto';
+export interface IExtractionWebhookScopeQuery {
+    organization_id?: string;
+    project_id?: string;
+}
+export interface IPaginateExtractionWebhookQuery extends IExtractionWebhookScopeQuery {
+    name?: string;
+    event?: ExtractionWebhookEvent;
+    isEnabled?: boolean;
+    page?: number;
+    limit?: number;
+}
+export interface ICreateExtractionWebhookBody {
+    webhookUrl: string;
+    name?: string;
+    description?: string;
+    isEnabled?: boolean;
+    scopes: ExtractionWebhookEvent[];
+}
+export interface IUpdateExtractionWebhookBody {
+    webhookUrl?: string;
+    name?: string;
+    description?: string;
+    isEnabled?: boolean;
+    scopes?: ExtractionWebhookEvent[];
+}
+export interface IListSharedFilesQuery extends IExtractionWebhookScopeQuery {
+    limit?: number;
+    offset?: number;
+}
+export interface IGetExtractionSettingsQuery {
+    organization_id?: string;
+    project_id?: string;
+}
+export interface IUpsertExtractionSettingsBody {
+    improvement_default: boolean;
+}
+export interface IToggleExtractionTrainingBody {
+    usable: boolean;
+}
+export interface ICreatePlanPresetBody {
+    name: string;
+    plan: IExtractionPlan;
+}
+export interface IUpdatePlanPresetBody {
+    name?: string;
+    plan?: IExtractionPlan;
+}
+export interface ISetDefaultPlanPresetBody {
+}
+export interface IListPlanPresetQuery {
+    organization_id?: string;
+    project_id?: string;
+}

package/dist/types/interface/api/requests/extraction.request.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=extraction.request.js.map

package/dist/types/interface/api/requests/extraction.request.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction.request.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/requests/extraction.request.ts"],"names":[],"mappings":""}

package/dist/types/interface/api/requests/index.d.ts

@@ -0,0 +1 @@
+export * from './extraction.request';

package/dist/types/interface/api/requests/index.js

@@ -0,0 +1,18 @@
+"use strict";
+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 });
+__exportStar(require("./extraction.request"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/interface/api/requests/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/requests/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC"}