@abyss-project/tools 1.0.3 → 1.1.1

package/dist/types/interface/models/{rcb.dto.d.ts → extraction.dto.d.ts}

@@ -1,14 +1,17 @@
-export type RcbExtractionMode = 'auto' | 'hint' | 'template';
-export type RcbProcessingMode = 'sync' | 'queue';
-export type RcbExtractionStatus = 'pending' | 'completed' | 'failed' | 'cached';
-export type RcbFeedbackIssueType = 'missing_record' | 'wrong_sign' | 'wrong_amount' | 'wrong_date' | 'wrong_description' | 'duplicate' | 'other';
-export type RcbFeedbackStatus = 'open' | 'triaged' | 'fixed' | 'closed';
-export type RcbUsageEventType = '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 IRcbBankHint {
+import { ExtractionWarningCode } from '../../../types/enum/extraction-warning.enum';
+import { ExtractionFeedbackIssueType } from '../../../types/enum/extraction-feedback-issue-type.enum';
+import type { IFieldValue, IExecutionManifest, IGlobalConfidence } 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 IRcbTransaction {
+export interface IExtractionTransaction {
     date?: string;
     description?: string;
     amount?: number;
@@ -18,7 +21,7 @@ export interface IRcbTransaction {
     reference?: string;
     [k: string]: unknown;
 }
-export interface IRcbExtractionMetadata {
+export interface IExtractionMetadata {
     iban?: string;
     bic?: string;
     bank?: string;
@@ -30,7 +33,7 @@ export interface IRcbExtractionMetadata {
     currency?: string;
     [k: string]: unknown;
 }
-export interface IRcbFile {
+export interface IExtractionFile {
     id: string;
     userId: string;
     applicationId: string | null;
@@ -50,45 +53,53 @@ export interface IRcbFile {
     createdAt: string;
     updatedAt: string;
 }
-export declare enum RcbWarningCode {
-    NO_RECORDS = "no_records",
-    NO_IBAN = "no_iban",
-    NO_BALANCES = "no_balances",
-    BALANCE_MISMATCH = "balance_mismatch"
-}
-export interface IRcbWarning {
-    code: RcbWarningCode;
+export { ExtractionWarningCode };
+export interface IExtractionWarning {
+    code: ExtractionWarningCode;
     data?: {
         actualCents?: number;
         expectedCents?: number;
         currency?: string;
+        type?: string;
+        message?: string;
     };
 }
-export interface IRcbExtraction {
+export interface IExtraction {
     id: string;
     fileId: string;
-    mode: RcbExtractionMode;
+    mode: ExtractionMode;
     hintBank: string | null;
     hintVersion: string | null;
     templateId: string | null;
     templateVersion: number | null;
-    status: RcbExtractionStatus;
+    status: ExtractionStatus;
     strategyUsed: string | null;
     confidence: number | null;
     recordsCount: number | null;
     balanceValidated: boolean | null;
     durationMs: number | null;
     error: string | null;
-    recordsJson: IRcbTransaction[] | null;
-    metadataJson: IRcbExtractionMetadata | null;
-    warningsJson: IRcbWarning[] | 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;
     createdAt: string;
 }
-export interface IRcbTemplate {
+export interface IExtractionTemplate {
     id: string;
     userId: string;
     name: string;
@@ -97,7 +108,7 @@ export interface IRcbTemplate {
     createdAt: string;
     updatedAt: string;
 }
-export interface IRcbTemplateZone {
+export interface IExtractionTemplateZone {
     name: string;
     page: number;
     x: number;
@@ -105,7 +116,7 @@ export interface IRcbTemplateZone {
     w: number;
     h: number;
 }
-export interface IRcbTemplateDsl {
+export interface IExtractionTemplateDsl {
     regex_iban?: string;
     regex_bic?: string;
     period?: {
@@ -122,9 +133,9 @@ export interface IRcbTemplateDsl {
         sign_rule?: 'explicit' | 'keyword';
     };
     skip_patterns?: string[];
-    zones?: IRcbTemplateZone[];
+    zones?: IExtractionTemplateZone[];
 }
-export interface IRcbTemplateVersion {
+export interface IExtractionTemplateVersion {
     id: string;
     templateId: string;
     version: number;
@@ -132,16 +143,19 @@ export interface IRcbTemplateVersion {
     comment: string | null;
     createdAt: string;
 }
-export interface IRcbFeedback {
+export interface IExtractionFeedback {
     id: string;
     extractionId: string;
     userId: string;
-    issueType: RcbFeedbackIssueType;
+    issueType: ExtractionFeedbackIssueType;
+    fieldKey: string | null;
+    expectedValue: string | null;
     description: string | null;
-    status: RcbFeedbackStatus;
+    supportTicketId: string | null;
+    status: ExtractionFeedbackStatus;
     createdAt: string;
 }
-export interface IRcbWebhookDelivery {
+export interface IExtractionWebhookDelivery {
     id: string;
     userId: string | null;
     organizationId: string | null;
@@ -159,7 +173,7 @@ export interface IRcbWebhookDelivery {
     createdAt: string;
     updatedAt: string;
 }
-export declare enum RcbWebhookEvent {
+export declare enum ExtractionWebhookEvent {
     EXTRACT_COMPLETED = "rcb.extract.completed",
     EXTRACT_FAILED = "rcb.extract.failed",
     EXTRACT_LOW_CONFIDENCE = "rcb.extract.low-confidence",
@@ -172,8 +186,8 @@ export declare enum RcbWebhookEvent {
     EXPORT_COMPLETED = "rcb.export.completed",
     EXPORT_FAILED = "rcb.export.failed"
 }
-export declare const RCB_WEBHOOK_EVENTS: RcbWebhookEvent[];
-export interface IRcbWebhook {
+export declare const EXTRACTION_WEBHOOK_EVENTS: ExtractionWebhookEvent[];
+export interface IExtractionWebhook {
     id: string;
     userId: string | null;
     organizationId: string | null;
@@ -184,22 +198,12 @@ export interface IRcbWebhook {
     isEnabled: boolean;
     name: string;
     description: string;
-    scopes: RcbWebhookEvent[];
+    scopes: ExtractionWebhookEvent[];
     consecutiveFailures: number;
     createdAt: string;
     updatedAt: string;
 }
-export interface IRcbQuota {
-    userId: string;
-    tier: string;
-    monthlyExtractCap: number | null;
-    monthlyExtractedCap: number | null;
-    monthlyBytesCap: number | null;
-    queueOnlyAboveCount: number | null;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface IRcbBankVersion {
+export interface IExtractionBankVersion {
     id: string;
     bank: string;
     version: string;
@@ -212,3 +216,15 @@ export interface IRcbBankVersion {
     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;AA+E3E,sGA/EA,+CAAqB,OA+EA;AA9E9B,iHAAsG;AAQ7F,4GARA,iEAA2B,OAQA;AAwOpC,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

@@ -14,6 +14,7 @@ export * from './retrospective-card.dto';
 export * from './retrospective-member.dto';
 export * from './short-link.dto';
 export * from './short-link-click.dto';
+export * from './beam.dto';
 export * from './board.dto';
 export * from './board-activity.dto';
 export * from './board-card.dto';
@@ -28,4 +29,6 @@ export * from './board-label.dto';
 export * from './team.dto';
 export * from './tag.dto';
 export * from './content-share.dto';
-export * from './rcb.dto';
+export * from './extraction.dto';
+export * from './extraction-plan.dto';
+export * from './extraction-spatial-template.dto';

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

@@ -30,6 +30,7 @@ __exportStar(require("./retrospective-card.dto"), exports);
 __exportStar(require("./retrospective-member.dto"), exports);
 __exportStar(require("./short-link.dto"), exports);
 __exportStar(require("./short-link-click.dto"), exports);
+__exportStar(require("./beam.dto"), exports);
 __exportStar(require("./board.dto"), exports);
 __exportStar(require("./board-activity.dto"), exports);
 __exportStar(require("./board-card.dto"), exports);
@@ -44,5 +45,7 @@ __exportStar(require("./board-label.dto"), exports);
 __exportStar(require("./team.dto"), exports);
 __exportStar(require("./tag.dto"), exports);
 __exportStar(require("./content-share.dto"), exports);
-__exportStar(require("./rcb.dto"), exports);
+__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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,8CAA4B;AAC5B,uDAAqC;AACrC,oDAAkC;AAClC,mDAAiC;AACjC,2DAAyC;AACzC,6CAA2B;AAC3B,6CAA2B;AAC3B,sDAAoC;AACpC,8DAA4C;AAC5C,2DAAyC;AACzC,6DAA2C;AAC3C,mDAAiC;AACjC,yDAAuC;AACvC,8CAA4B;AAC5B,uDAAqC;AACrC,mDAAiC;AACjC,6DAA2C;AAC3C,iEAA+C;AAC/C,2DAAyC;AACzC,4DAA0C;AAC1C,yDAAuC;AACvC,0DAAwC;AACxC,qDAAmC;AACnC,oDAAkC;AAClC,6CAA2B;AAC3B,4CAA0B;AAC1B,sDAAoC;AACpC,4CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/models/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,qDAAmC;AACnC,gDAA8B;AAC9B,8CAA4B;AAC5B,uDAAqC;AACrC,oDAAkC;AAClC,mDAAiC;AACjC,2DAAyC;AACzC,6CAA2B;AAC3B,6CAA2B;AAC3B,sDAAoC;AACpC,8DAA4C;AAC5C,2DAAyC;AACzC,6DAA2C;AAC3C,mDAAiC;AACjC,yDAAuC;AACvC,6CAA2B;AAC3B,8CAA4B;AAC5B,uDAAqC;AACrC,mDAAiC;AACjC,6DAA2C;AAC3C,iEAA+C;AAC/C,2DAAyC;AACzC,4DAA0C;AAC1C,yDAAuC;AACvC,0DAAwC;AACxC,qDAAmC;AACnC,oDAAkC;AAClC,6CAA2B;AAC3B,4CAA0B;AAC1B,sDAAoC;AACpC,mDAAiC;AACjC,wDAAsC;AACtC,oEAAkD"}

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

@@ -3,6 +3,8 @@ export interface IOrganization {
     id?: string;
     name: string;
     slug: string;
+    kind?: 'standard' | 'family';
+    kindSyncedAt?: string | null;
     updatedAt?: Date;
     createdAt?: Date;
     projects?: IProject[];

package/dist/utils/{rcb-webhook.utils.d.ts → extraction-webhook.utils.d.ts}

@@ -1,8 +1,8 @@
 /// <reference types="node" />
 /// <reference types="node" />
-export interface VerifyRcbWebhookInput {
+export interface VerifyExtractionWebhookInput {
     rawBody: string | Buffer;
     signatureHeader: string | undefined;
     secret: string;
 }
-export declare function verifyRcbWebhook(input: VerifyRcbWebhookInput): boolean;
+export declare function verifyExtractionWebhook(input: VerifyExtractionWebhookInput): boolean;

package/dist/utils/{rcb-webhook.utils.js → extraction-webhook.utils.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyRcbWebhook = void 0;
-function verifyRcbWebhook(input) {
+exports.verifyExtractionWebhook = void 0;
+function verifyExtractionWebhook(input) {
     if (!input.signatureHeader || !input.secret)
         return false;
     const crypto = require('crypto');
@@ -14,5 +14,5 @@ function verifyRcbWebhook(input) {
         return false;
     return crypto.timingSafeEqual(Buffer.from(provided, 'hex'), Buffer.from(computed, 'hex'));
 }
-exports.verifyRcbWebhook = verifyRcbWebhook;
-//# sourceMappingURL=rcb-webhook.utils.js.map
+exports.verifyExtractionWebhook = verifyExtractionWebhook;
+//# 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,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;AAXD,0DAWC"}

package/dist/utils/index.d.ts

@@ -3,4 +3,4 @@ export * from './board.utils';
 export * from './shape.utils';
 export * from './icons.utils';
 export * from './enum.utils';
-export * from './rcb-webhook.utils';
+export * from './extraction-webhook.utils';

package/dist/utils/index.js

@@ -19,5 +19,5 @@ __exportStar(require("./board.utils"), exports);
 __exportStar(require("./shape.utils"), exports);
 __exportStar(require("./icons.utils"), exports);
 __exportStar(require("./enum.utils"), exports);
-__exportStar(require("./rcb-webhook.utils"), exports);
+__exportStar(require("./extraction-webhook.utils"), exports);
 //# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abyss-project/tools",
-  "version": "1.0.3",
+  "version": "1.1.1",
   "description": "Core package to interact with Abyss-Project Tools",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/api/abyss.admin.api.ts

@@ -10,12 +10,6 @@ import {
   IGetProjectContentSummaryAdminResponse,
 } from '..';
 
-export const deleteUserAbyssAdmin = async (
-  userId: string,
-): Promise<void> => {
-  await AbyssToolsCore.axios.delete(`abyss/admin/user/${userId}`);
-};
-
 export const activateUserServiceAbyssAdmin = async (
   body: IActivateUserServiceAbyssAdminBody,
 ): Promise<IActivateUserServiceAbyssAdminResponse> => {
@@ -38,12 +32,6 @@ export const syncOrganizationAbyssAdmin = async (
   ).data;
 };
 
-export const deleteOrganizationAbyssAdmin = async (
-  organizationId: string,
-): Promise<void> => {
-  await AbyssToolsCore.axios.delete(`abyss/admin/organization/${organizationId}`);
-};
-
 export const syncProjectAbyssAdmin = async (
   body: ISyncProjectAbyssAdminBody,
 ): Promise<ISyncProjectAbyssAdminResponse> => {
@@ -55,12 +43,6 @@ export const syncProjectAbyssAdmin = async (
   ).data;
 };
 
-export const deleteProjectAbyssAdmin = async (
-  projectId: string,
-): Promise<void> => {
-  await AbyssToolsCore.axios.delete(`abyss/admin/project/${projectId}`);
-};
-
 export const getProjectContentSummary = async (
   params: IGetProjectContentSummaryAdminParams,
 ): Promise<IGetProjectContentSummaryAdminResponse> => {