@abyss-project/extract 0.0.0-stage → 1.0.0

package/dist/types/interface/models/extraction.dto.d.ts

@@ -0,0 +1,255 @@
+import { ExtractionWarningCode } from '../../../types/enum/extraction-warning.enum';
+import { ExtractionFeedbackIssueType } from '../../../types/enum/extraction-feedback-issue-type.enum';
+import { DocumentType } from '../../../types/enum/document-type.enum';
+import { FileScanStatus } from '../../enum/file-scan-status.enum';
+import type { IFieldValue, IExecutionManifest, IGlobalConfidence, IExecutionTrace } from './extraction-plan.dto';
+export { ExtractionFeedbackIssueType };
+export type ExtractionMode = 'auto' | 'hint' | 'template';
+export type ProcessingMode = 'sync' | 'queue';
+export type ExtractionStatus = 'pending' | 'completed' | 'failed' | 'cached';
+export type ExtractionFeedbackStatus = 'open' | 'triaged' | 'fixed' | 'closed';
+export type ExtractionUsageEventType = 'extract.sync.success' | 'extract.sync.cached' | 'extract.sync.failed' | 'extract.queue.enqueued' | 'extract.queue.success' | 'extract.queue.cached' | 'extract.queue.failed' | 'template.run.success' | 'template.run.failed';
+export interface IExtractionBankHint {
+    bank: string;
+    version?: string;
+}
+export interface IExtractionTransaction {
+    date?: string;
+    description?: string;
+    amount?: number;
+    balance?: number;
+    valueDate?: string;
+    bookingDate?: string;
+    reference?: string;
+    [k: string]: unknown;
+}
+export interface IExtractionMetadata {
+    iban?: string;
+    bic?: string;
+    bank?: string;
+    accountHolder?: string;
+    periodStart?: string;
+    periodEnd?: string;
+    openingBalance?: number;
+    closingBalance?: number;
+    currency?: string;
+    [k: string]: unknown;
+}
+export interface IPayslipMetadata {
+    netCents?: number;
+    grossCents?: number;
+    netTaxableCents?: number;
+    pasRatePct?: number;
+    pasAmountCents?: number;
+    period?: string;
+    employer?: string;
+    currency?: string;
+}
+export interface IExtractionFile {
+    id: string;
+    userId: string;
+    applicationId: string | null;
+    pdfHash: string;
+    pdfSizeBytes: number;
+    pdfMimeType: string;
+    pdfPageCount: number | null;
+    pdfFilename: string | null;
+    applicationFileId: string | null;
+    userExternalId: string | null;
+    userMetadata: Record<string, unknown> | null;
+    detectedBank: string | null;
+    detectedVersion: string | null;
+    detectedIban: string | null;
+    detectedBic: string | null;
+    detectedCurrency: string | null;
+    scanStatus: FileScanStatus | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export { ExtractionWarningCode };
+export interface IExtractionWarning {
+    code: ExtractionWarningCode;
+    data?: {
+        actualCents?: number;
+        expectedCents?: number;
+        currency?: string;
+        type?: string;
+        message?: string;
+        fieldKey?: string;
+        confidence?: number;
+        floor?: number;
+    };
+}
+export interface IExtraction {
+    id: string;
+    fileId: string;
+    mode: ExtractionMode;
+    hintBank: string | null;
+    hintVersion: string | null;
+    templateId: string | null;
+    templateVersion: number | null;
+    status: ExtractionStatus;
+    strategyUsed: string | null;
+    confidence: number | null;
+    recordsCount: number | null;
+    balanceValidated: boolean | null;
+    durationMs: number | null;
+    error: string | null;
+    recordsJson: IExtractionTransaction[] | null;
+    metadataJson: IExtractionMetadata | null;
+    warningsJson: IExtractionWarning[] | null;
+    tags: string[] | null;
+    note: string | null;
+    shareToken: string | null;
+    shareExpiresAt: string | null;
+    documentType: string | null;
+    documentTypeConfidence: number | null;
+    fieldsJson: Record<string, IFieldValue> | null;
+    improvementConsent: boolean;
+    usableForTraining: boolean;
+    supportTicketId: string | null;
+    trainingFileId: string | null;
+    usedOcr: boolean;
+    ocrPageCount: number;
+    executionManifest?: IExecutionManifest | null;
+    globalConfidence?: IGlobalConfidence | null;
+    executionTrace?: IExecutionTrace | null;
+    createdAt: string;
+}
+export interface IExtractionTemplate {
+    id: string;
+    userId: string | null;
+    organizationId: string | null;
+    projectId: string | null;
+    createdByUserId: string | null;
+    name: string;
+    description: string | null;
+    documentType: DocumentType | null;
+    isActive: boolean;
+    lastUsedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface IExtractionTemplateZone {
+    name: string;
+    page: number;
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+}
+export interface IExtractionTemplateDsl {
+    regex_iban?: string;
+    regex_bic?: string;
+    period?: {
+        regex: string;
+    };
+    balance?: {
+        opening_regex?: string;
+        closing_regex?: string;
+    };
+    transactions?: {
+        row_pattern: string;
+        date_format?: string;
+        amount_locale?: 'fr' | 'en';
+        sign_rule?: 'explicit' | 'keyword';
+    };
+    skip_patterns?: string[];
+    zones?: IExtractionTemplateZone[];
+}
+export interface IExtractionTemplateVersion {
+    id: string;
+    templateId: string;
+    version: number;
+    templateJson: Record<string, unknown>;
+    comment: string | null;
+    witnessFileId: string | null;
+    witnessSizeBytes: number | null;
+    witnessFilename: string | null;
+    createdAt: string;
+}
+export interface IExtractionFeedback {
+    id: string;
+    extractionId: string;
+    userId: string;
+    issueType: ExtractionFeedbackIssueType;
+    fieldKey: string | null;
+    expectedValue: string | null;
+    description: string | null;
+    supportTicketId: string | null;
+    status: ExtractionFeedbackStatus;
+    createdAt: string;
+}
+export interface IExtractionWebhookDelivery {
+    id: string;
+    userId: string | null;
+    organizationId: string | null;
+    projectId: string | null;
+    createdByUserId: string | null;
+    webhookId: string | null;
+    jobId: string | null;
+    event: string;
+    url: string;
+    payloadJson: Record<string, unknown>;
+    attempts: number;
+    lastStatus: number | null;
+    lastError: string | null;
+    deliveredAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export declare enum ExtractionWebhookEvent {
+    EXTRACT_COMPLETED = "rcb.extract.completed",
+    EXTRACT_FAILED = "rcb.extract.failed",
+    EXTRACT_LOW_CONFIDENCE = "rcb.extract.low-confidence",
+    EXTRACT_BALANCE_KO = "rcb.extract.balance-ko",
+    FILE_ARCHIVED = "rcb.file.archived",
+    SHARE_MINTED = "rcb.share.minted",
+    SHARE_REVOKED = "rcb.share.revoked",
+    FEEDBACK_SUBMITTED = "rcb.feedback.submitted",
+    JOB_FAILED = "rcb.job.failed",
+    EXPORT_COMPLETED = "rcb.export.completed",
+    EXPORT_FAILED = "rcb.export.failed"
+}
+export declare const EXTRACTION_WEBHOOK_EVENTS: ExtractionWebhookEvent[];
+export interface IExtractionWebhook {
+    id: string;
+    userId: string | null;
+    organizationId: string | null;
+    projectId: string | null;
+    createdByUserId: string | null;
+    webhookUrl: string;
+    webhookSecret: string;
+    isEnabled: boolean;
+    name: string;
+    description: string;
+    scopes: ExtractionWebhookEvent[];
+    consecutiveFailures: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface IExtractionBankVersion {
+    id: string;
+    bank: string;
+    version: string;
+    validFrom: string | null;
+    validTo: string | null;
+    detectorJson: Record<string, unknown>;
+    parserKind: string;
+    configJson: Record<string, unknown>;
+    isActive: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+export declare enum ExtractionSettingsScopeKind {
+    USER = "user",
+    ORG = "org"
+}
+export interface IExtractionSettings {
+    id: string;
+    userId: string | null;
+    organizationId: string | null;
+    improvementDefault: boolean;
+    createdAt: string;
+    updatedAt: string;
+}

package/dist/types/interface/models/extraction.dto.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractionSettingsScopeKind = exports.EXTRACTION_WEBHOOK_EVENTS = exports.ExtractionWebhookEvent = exports.ExtractionWarningCode = exports.ExtractionFeedbackIssueType = void 0;
+const extraction_warning_enum_1 = require("../../../types/enum/extraction-warning.enum");
+Object.defineProperty(exports, "ExtractionWarningCode", { enumerable: true, get: function () { return extraction_warning_enum_1.ExtractionWarningCode; } });
+const extraction_feedback_issue_type_enum_1 = require("../../../types/enum/extraction-feedback-issue-type.enum");
+Object.defineProperty(exports, "ExtractionFeedbackIssueType", { enumerable: true, get: function () { return extraction_feedback_issue_type_enum_1.ExtractionFeedbackIssueType; } });
+var ExtractionWebhookEvent;
+(function (ExtractionWebhookEvent) {
+    ExtractionWebhookEvent["EXTRACT_COMPLETED"] = "rcb.extract.completed";
+    ExtractionWebhookEvent["EXTRACT_FAILED"] = "rcb.extract.failed";
+    ExtractionWebhookEvent["EXTRACT_LOW_CONFIDENCE"] = "rcb.extract.low-confidence";
+    ExtractionWebhookEvent["EXTRACT_BALANCE_KO"] = "rcb.extract.balance-ko";
+    ExtractionWebhookEvent["FILE_ARCHIVED"] = "rcb.file.archived";
+    ExtractionWebhookEvent["SHARE_MINTED"] = "rcb.share.minted";
+    ExtractionWebhookEvent["SHARE_REVOKED"] = "rcb.share.revoked";
+    ExtractionWebhookEvent["FEEDBACK_SUBMITTED"] = "rcb.feedback.submitted";
+    ExtractionWebhookEvent["JOB_FAILED"] = "rcb.job.failed";
+    ExtractionWebhookEvent["EXPORT_COMPLETED"] = "rcb.export.completed";
+    ExtractionWebhookEvent["EXPORT_FAILED"] = "rcb.export.failed";
+})(ExtractionWebhookEvent || (exports.ExtractionWebhookEvent = ExtractionWebhookEvent = {}));
+exports.EXTRACTION_WEBHOOK_EVENTS = Object.values(ExtractionWebhookEvent);
+var ExtractionSettingsScopeKind;
+(function (ExtractionSettingsScopeKind) {
+    ExtractionSettingsScopeKind["USER"] = "user";
+    ExtractionSettingsScopeKind["ORG"] = "org";
+})(ExtractionSettingsScopeKind || (exports.ExtractionSettingsScopeKind = ExtractionSettingsScopeKind = {}));
+//# sourceMappingURL=extraction.dto.js.map

package/dist/types/interface/models/extraction.dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction.dto.js","sourceRoot":"","sources":["../../../../src/types/interface/models/extraction.dto.ts"],"names":[],"mappings":";;;AAKA,yFAAoF;AA8G3E,sGA9GA,+CAAqB,OA8GA;AA7G9B,iHAAsG;AAW7F,4GAXA,iEAA2B,OAWA;AAuTpC,IAAY,sBAYX;AAZD,WAAY,sBAAsB;IAChC,qEAA2C,CAAA;IAC3C,+DAAqC,CAAA;IACrC,+EAAqD,CAAA;IACrD,uEAA6C,CAAA;IAC7C,6DAAmC,CAAA;IACnC,2DAAiC,CAAA;IACjC,6DAAmC,CAAA;IACnC,uEAA6C,CAAA;IAC7C,uDAA6B,CAAA;IAC7B,mEAAyC,CAAA;IACzC,6DAAmC,CAAA;AACrC,CAAC,EAZW,sBAAsB,sCAAtB,sBAAsB,QAYjC;AAEY,QAAA,yBAAyB,GACpC,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;AAuCxC,IAAY,2BAGX;AAHD,WAAY,2BAA2B;IACrC,4CAAa,CAAA;IACb,0CAAW,CAAA;AACb,CAAC,EAHW,2BAA2B,2CAA3B,2BAA2B,QAGtC"}

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

@@ -0,0 +1,3 @@
+export * from './extraction.dto';
+export * from './extraction-plan.dto';
+export * from './extraction-spatial-template.dto';

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

@@ -0,0 +1,20 @@
+"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.dto"), exports);
+__exportStar(require("./extraction-plan.dto"), exports);
+__exportStar(require("./extraction-spatial-template.dto"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,wDAAsC;AACtC,oEAAkD"}

package/dist/utils/enum.utils.d.ts

@@ -0,0 +1 @@
+export type ValueOf<T> = T[keyof T];

package/dist/utils/enum.utils.js

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

package/dist/utils/enum.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum.utils.js","sourceRoot":"","sources":["../../src/utils/enum.utils.ts"],"names":[],"mappings":""}

package/dist/utils/error.utils.d.ts

@@ -0,0 +1,15 @@
+import { Code, ErrorType } from '../types';
+type ErrorParams = {
+    code: Code;
+    type: ErrorType;
+    message?: string;
+};
+export declare class ServiceException extends Error {
+    private readonly code;
+    private readonly type;
+    getCode(): Code;
+    getType(): ErrorType;
+    constructor(params: ErrorParams);
+}
+export declare const handleError: (error: Error | ErrorParams, _params?: ErrorParams) => Error;
+export {};

package/dist/utils/error.utils.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleError = exports.ServiceException = void 0;
+class ServiceException extends Error {
+    getCode() {
+        return this.code;
+    }
+    getType() {
+        return this.type;
+    }
+    constructor(params) {
+        super(params.message);
+        this.code = params.code;
+        this.type = params.type;
+    }
+}
+exports.ServiceException = ServiceException;
+const handleError = (error, _params) => {
+    if (error instanceof Error) {
+        return error;
+    }
+    return new ServiceException(error);
+};
+exports.handleError = handleError;
+//# sourceMappingURL=error.utils.js.map

package/dist/utils/error.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.utils.js","sourceRoot":"","sources":["../../src/utils/error.utils.ts"],"names":[],"mappings":";;;AAIA,MAAa,gBAAiB,SAAQ,KAAK;IAKzC,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,YAAY,MAAmB;QAC7B,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IAC1B,CAAC;CACF;AAlBD,4CAkBC;AAEM,MAAM,WAAW,GAAG,CAAC,KAA0B,EAAE,OAAqB,EAAS,EAAE;IACtF,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC,CAAC;AALW,QAAA,WAAW,eAKtB"}

package/dist/utils/extraction-webhook.utils.d.ts

@@ -0,0 +1,6 @@
+export interface VerifyExtractionWebhookInput {
+    rawBody: string | Buffer;
+    signatureHeader: string | undefined;
+    secret: string;
+}
+export declare function verifyExtractionWebhook(input: VerifyExtractionWebhookInput): boolean;

package/dist/utils/extraction-webhook.utils.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifyExtractionWebhook = verifyExtractionWebhook;
+function verifyExtractionWebhook(input) {
+    if (!input.signatureHeader || !input.secret)
+        return false;
+    const crypto = require('crypto');
+    const provided = input.signatureHeader.replace(/^sha256=/, '');
+    const computed = crypto
+        .createHmac('sha256', input.secret)
+        .update(input.rawBody)
+        .digest('hex');
+    if (provided.length !== computed.length)
+        return false;
+    return crypto.timingSafeEqual(Buffer.from(provided, 'hex'), Buffer.from(computed, 'hex'));
+}
+//# sourceMappingURL=extraction-webhook.utils.js.map

package/dist/utils/extraction-webhook.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extraction-webhook.utils.js","sourceRoot":"","sources":["../../src/utils/extraction-webhook.utils.ts"],"names":[],"mappings":";;AAkBA,0DAWC;AAXD,SAAgB,uBAAuB,CAAC,KAAmC;IACzE,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IAE1D,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjC,MAAM,QAAQ,GAAG,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC/D,MAAM,QAAQ,GAAW,MAAM;SAC5B,UAAU,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC;SAClC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC;SACrB,MAAM,CAAC,KAAK,CAAC,CAAC;IACjB,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM;QAAE,OAAO,KAAK,CAAC;IACtD,OAAO,MAAM,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;AAC5F,CAAC"}

package/dist/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './error.utils';
+export * from './enum.utils';
+export * from './extraction-webhook.utils';

package/dist/utils/index.js

@@ -0,0 +1,20 @@
+"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("./error.utils"), exports);
+__exportStar(require("./enum.utils"), exports);
+__exportStar(require("./extraction-webhook.utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,+CAA6B;AAC7B,6DAA2C"}

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@abyss-project/extract",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Core package to interact with AbyssExtract",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts"
+  },
+  "scripts": {
+    "lint": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --fix",
+    "lint:check": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --max-warnings 0",
+    "tsc": "tsc",
+    "build": "tsc",
+    "prepublishOnly": "tsc && node ../../scripts/check-sdk-surface.cjs",
+    "dev": "tsc --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/abyss-group/abyss-tools/abyss-tools"
+  },
+  "keywords": [],
+  "author": "scylla",
+  "license": "ISC",
+  "engines": {
+    "node": ">=19.8"
+  },
+  "dependencies": {
+    "axios": "^1.6.0",
+    "axios-retry": "^4.5.0",
+    "date-fns": "^2.30.0",
+    "dayjs": "^1.10.7",
+    "jsonwebtoken": "^8.5.1",
+    "reflect-metadata": "^0.1.13",
+    "ts-node": "^10.4.0",
+    "ts-node-dev": "^1.1.1",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@types/express-serve-static-core": "^4.19.6",
+    "@types/jsonwebtoken": "^8.5.0",
+    "@types/node": "^20.11.0",
+    "@types/uuid": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "8.71.0",
+    "@typescript-eslint/parser": "8.71.0",
+    "eslint": "^8.57.1",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-filenames-simple": "^0.7.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "prettier": "2.3.1",
+    "tsc-watch": "^4.6.2",
+    "typescript": "5.9.3"
+  }
+}

package/src/api/extraction-plan-preset.api.test.ts

@@ -0,0 +1,24 @@
+// Type-level compile test for the extraction-plan-preset api surface.
+// No jest runner in this SDK package; compile guard only.
+// Run: npx tsc --noEmit (from packages/abyss_extract_core).
+
+import * as api from './extraction-plan-preset.api';
+
+// All seven functions must be exported.
+const _listModes: typeof api.listModes = api.listModes;
+const _listPresets: typeof api.listExtractionPlanPresets = api.listExtractionPlanPresets;
+const _getPreset: typeof api.getExtractionPlanPreset = api.getExtractionPlanPreset;
+const _createPreset: typeof api.createExtractionPlanPreset = api.createExtractionPlanPreset;
+const _updatePreset: typeof api.updateExtractionPlanPreset = api.updateExtractionPlanPreset;
+const _deletePreset: typeof api.deleteExtractionPlanPreset = api.deleteExtractionPlanPreset;
+const _setDefault: typeof api.setDefaultExtractionPlanPreset = api.setDefaultExtractionPlanPreset;
+
+void _listModes;
+void _listPresets;
+void _getPreset;
+void _createPreset;
+void _updatePreset;
+void _deletePreset;
+void _setDefault;
+
+export {};

package/src/api/extraction-plan-preset.api.ts

@@ -0,0 +1,97 @@
+// ──────────────────────────────────────────────
+// Extraction Plan Preset API (V2-P1).
+//
+// GET  /extract/modes            — list registered providers + interpreters.
+// GET  /extract/plans            — list plan presets (system + scoped).
+// GET  /extract/plans/:id        — get a single preset.
+// POST /extract/plans            — create a preset.
+// PUT  /extract/plans/:id        — update a preset.
+// DELETE /extract/plans/:id      — delete a preset.
+// POST /extract/plans/:id/default — set as scope default.
+// ──────────────────────────────────────────────
+
+import { AbyssExtractCore } from '..';
+import type { ICreatePlanPresetBody, IUpdatePlanPresetBody, IListPlanPresetQuery } from '../types';
+import type {
+  IListModesResponse,
+  IListPlanPresetsResponse,
+  IGetPlanPresetResponse,
+  IDeletePlanPresetResponse,
+} from '../types';
+
+const DEFAULT_API_KEY_HEADER = 'abyss-api-key';
+
+function authHeader(apiKey?: string): Record<string, string> {
+  return apiKey ? { [DEFAULT_API_KEY_HEADER]: apiKey } : {};
+}
+
+export const listModes = async (apiKey?: string): Promise<IListModesResponse> =>
+  (
+    await AbyssExtractCore.axios.get<IListModesResponse>(`extract/modes`, {
+      headers: authHeader(apiKey),
+    })
+  ).data;
+
+export const listExtractionPlanPresets = async (
+  query: IListPlanPresetQuery = {},
+  apiKey?: string,
+): Promise<IListPlanPresetsResponse> =>
+  (
+    await AbyssExtractCore.axios.get<IListPlanPresetsResponse>(`extract/plans`, {
+      params: query,
+      headers: authHeader(apiKey),
+    })
+  ).data;
+
+export const getExtractionPlanPreset = async (
+  id: string,
+  apiKey?: string,
+): Promise<IGetPlanPresetResponse> =>
+  (
+    await AbyssExtractCore.axios.get<IGetPlanPresetResponse>(`extract/plans/${id}`, {
+      headers: authHeader(apiKey),
+    })
+  ).data;
+
+export const createExtractionPlanPreset = async (
+  body: ICreatePlanPresetBody,
+  apiKey?: string,
+): Promise<IGetPlanPresetResponse> =>
+  (
+    await AbyssExtractCore.axios.post<IGetPlanPresetResponse>(`extract/plans`, body, {
+      headers: authHeader(apiKey),
+    })
+  ).data;
+
+export const updateExtractionPlanPreset = async (
+  id: string,
+  body: IUpdatePlanPresetBody,
+  apiKey?: string,
+): Promise<IGetPlanPresetResponse> =>
+  (
+    await AbyssExtractCore.axios.put<IGetPlanPresetResponse>(`extract/plans/${id}`, body, {
+      headers: authHeader(apiKey),
+    })
+  ).data;
+
+export const deleteExtractionPlanPreset = async (
+  id: string,
+  apiKey?: string,
+): Promise<IDeletePlanPresetResponse> =>
+  (
+    await AbyssExtractCore.axios.delete<IDeletePlanPresetResponse>(`extract/plans/${id}`, {
+      headers: authHeader(apiKey),
+    })
+  ).data;
+
+export const setDefaultExtractionPlanPreset = async (
+  id: string,
+  apiKey?: string,
+): Promise<IGetPlanPresetResponse> =>
+  (
+    await AbyssExtractCore.axios.post<IGetPlanPresetResponse>(
+      `extract/plans/${id}/default`,
+      {},
+      { headers: authHeader(apiKey) },
+    )
+  ).data;