@abyss-project/tools 2.6.0 → 2.8.0

package/src/types/interface/models/extraction-plan.dto.ts

@@ -8,9 +8,10 @@
 import { ProviderKind, CostTier } from '../../enum/provider-kind.enum';
 import { InterpreterKind } from '../../enum/interpreter-kind.enum';
 import { CombineStrategy } from '../../enum/combine-strategy.enum';
+import { ExtractionStepStatus } from '../../enum/extraction-step-status.enum';
 
 // Re-export for consumers that import from this barrel.
-export { ProviderKind, CostTier, InterpreterKind, CombineStrategy };
+export { ProviderKind, CostTier, InterpreterKind, CombineStrategy, ExtractionStepStatus };
 
 // ─── Plan building blocks ──────────────────────────────────────────────────
 
@@ -180,15 +181,53 @@ export interface IExecutionManifest {
   createdAt: string;
 }
 
+// ─── Execution trace (P1) ──────────────────────────────────────────────────
+
+/** Per-IO metadata in the persisted trace skeleton. The full payload is fetched lazily. */
+export interface IStepIo {
+  slot: 'providerOutput' | 'interpreterOutput';
+  bytes: number;
+  sha256: string;
+  preview: string;
+  status: 'pending' | 'ready' | 'skipped';
+  applicationFileId: string | null;
+}
+
+/** One executed / gate-skipped / failed pass, with timing, status and IO refs. */
+export interface IStepTrace {
+  index: number;
+  providerId: string;
+  providerVersion: string;
+  interpreterId: string;
+  interpreterVersion: string;
+  documentType: string | null;
+  status: ExtractionStepStatus;
+  startedAtMs: number;
+  durationMs: number;
+  ocrPageCount: number;
+  fieldsContributed: number;
+  errorMessage: string | null;
+  io: IStepIo[];
+}
+
+/**
+ * Per-pass execution trace skeleton persisted in extractions.executionTrace and
+ * surfaced by GET /extractions/:id. Full IO payloads are fetched lazily via
+ * sdk.extract.extractions.stepIo.
+ */
+export interface IExecutionTrace {
+  steps: IStepTrace[];
+  totalDurationMs: number;
+  artifactStatus: 'pending' | 'ready';
+}
+
 // ─── Plan presets ──────────────────────────────────────────────────────────
 
 /** A saved extraction plan preset (DB row + virtual system presets). */
 export interface IExtractionPlanPreset {
   id: string;
   name: string;
-  scope:
-    | { kind: 'user'; userId: string }
-    | { kind: 'org'; organizationId: string };
+  scope: { kind: 'user'; userId: string } | { kind: 'org'; organizationId: string };
   plan: IExtractionPlan;
   isDefault: boolean;
   system: boolean;

package/src/types/interface/models/extraction.dto.ts

@@ -7,7 +7,12 @@ import { ExtractionWarningCode } from '../../../types/enum/extraction-warning.en
 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 } from './extraction-plan.dto';
+import type {
+  IFieldValue,
+  IExecutionManifest,
+  IGlobalConfidence,
+  IExecutionTrace,
+} from './extraction-plan.dto';
 
 // Re-export so consumers can import ExtractionFeedbackIssueType from the DTO barrel.
 export { ExtractionFeedbackIssueType };
@@ -163,6 +168,11 @@ export interface IExtraction {
    * Surfaced where available; optional/absent otherwise. ADDITIVE, optional.
    */
   globalConfidence?: IGlobalConfidence | null;
+  /**
+   * Per-pass execution trace skeleton (timing/status/impl + lazy IO refs) — P1.
+   * Present on plan-path rows; absent on legacy paths. ADDITIVE, optional.
+   */
+  executionTrace?: IExecutionTrace | null;
   createdAt: string;
 }
 

package/src/types/interface/models/index.ts

@@ -7,7 +7,6 @@ export * from './atlas-group.dto';
 export * from './atlas-page.dto';
 export * from './atlas-page-content.dto';
 export * from './draw.dto';
-export * from './memo.dto';
 export * from './retrospective.dto';
 export * from './retrospective-section.dto';
 export * from './retrospective-card.dto';
@@ -35,3 +34,4 @@ export * from './extraction-spatial-template.dto';
 export * from './probe-scan.dto';
 export * from './probe-webhook.dto';
 export * from './probe-webhook-delivery.dto';
+export * from './upload-session.dto';

package/src/types/interface/models/project.dto.ts

@@ -1,6 +1,5 @@
 import { IAtlas } from './atlas.dto';
 import { IDraw } from './draw.dto';
-import { IMemo } from './memo.dto';
 import { IOrganization } from './organization.dto';
 import { IRetrospective } from './retrospective.dto';
 import { IShortLink } from './short-link.dto';
@@ -20,6 +19,5 @@ export interface IProject {
   draws?: IDraw[];
   retrospectives?: IRetrospective[];
   atlases?: IAtlas[];
-  memos?: IMemo[];
   shortLinks?: IShortLink[];
 }

package/src/types/interface/models/upload-session.dto.ts

@@ -0,0 +1,24 @@
+/**
+ * SP3 — transparent multipart upload.
+ *
+ * Mirrors @abyss-project/storage's `UploadSession` (the return type of
+ * `initiateUpload`) as a LOCAL type instead of importing storage's own type,
+ * decoupling abyss-tools's public API contract from storage's package
+ * boundary — a front consumer of @abyss-project/tools should not need to
+ * also depend on @abyss-project/storage just to type a presign response
+ * (same mirroring rationale as abyss-memories's `IUploadSession`, abyss-form's
+ * `IUploadSession` and abyss-cloud's `IUploadSession`).
+ *
+ * `kind: 'single'` — size at or below storage's single-shot threshold:
+ * `token` is the one-shot pre-signed upload URL to PUT the whole file to.
+ * `kind: 'multipart'` — above the threshold: `multipartToken` identifies the
+ * multipart session and `partSizeOctet` is the fixed part size the front must
+ * chunk the file into (see @abyss-project/storage's `uploadWithSession`).
+ *
+ * Shared by every presign response DTO that proxies a *UploadUrl service
+ * method's `UploadSession` result as-is: board-card-document upload and
+ * atlas-document upload.
+ */
+export type IUploadSession =
+  | { kind: 'single'; token: string }
+  | { kind: 'multipart'; multipartToken: string; partSizeOctet: number };

package/src/types/interface/models/user.dto.ts

@@ -2,7 +2,6 @@ import { IAtlas } from './atlas.dto';
 import { IBoard } from './board.dto';
 import { IBoardCardComment } from './board-card-comment.dto';
 import { IDraw } from './draw.dto';
-import { IMemo } from './memo.dto';
 import { IProject } from './project.dto';
 import { IRetrospective } from './retrospective.dto';
 import { IShortLink } from './short-link.dto';
@@ -24,7 +23,6 @@ export interface IUser {
   draws?: IDraw[];
   retrospectives?: IRetrospective[];
   atlases?: IAtlas[];
-  memos?: IMemo[];
   shortLinks?: IShortLink[];
   boardCardComments?: IBoardCardComment[];
 }

package/src/api/memo.api.ts

@@ -1,97 +0,0 @@
-import { AbyssToolsCore } from '..';
-import {
-  ICreateMemoBody,
-  ICreateMemoResponse,
-  ICreateForOrganizationMemoParams,
-  IDeleteMemoParams,
-  IDeleteMemoResponse,
-  IGetMemoParams,
-  IGetMemoResponse,
-  IPaginateMemoQuery,
-  IPaginateMemoResponse,
-  IPaginateProjectMemoParams,
-  IPaginateOrganizationMemoParams,
-  IUpdateMemoBody,
-  IUpdateMemoParams,
-  IUpdateMemoResponse,
-  ITransferContentBody,
-  ITransferMemoResponse,
-  ICountOrganizationResponse,
-} from '../types';
-
-export const paginateMemo = async (query: IPaginateMemoQuery): Promise<IPaginateMemoResponse> => {
-  return (await AbyssToolsCore.axios.get<IPaginateMemoResponse>(`memo/paginate`, { params: query }))
-    .data;
-};
-
-export const paginateProjectMemo = async (
-  params: IPaginateProjectMemoParams,
-  query: IPaginateMemoQuery,
-): Promise<IPaginateMemoResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IPaginateMemoResponse>(`project/${params.projectId}/memo/paginate`, {
-      params: query,
-    })
-  ).data;
-};
-
-export const getMemo = async (params: IGetMemoParams): Promise<IGetMemoResponse> => {
-  return (await AbyssToolsCore.axios.get<IGetMemoResponse>(`memo/${params.memoId}`)).data;
-};
-
-export const deleteMemo = async (params: IDeleteMemoParams): Promise<IDeleteMemoResponse> => {
-  return (await AbyssToolsCore.axios.delete<IDeleteMemoResponse>(`memo/${params.memoId}`)).data;
-};
-
-export const updateMemo = async (
-  params: IUpdateMemoParams,
-  body: IUpdateMemoBody,
-): Promise<IUpdateMemoResponse> => {
-  return (await AbyssToolsCore.axios.put<IUpdateMemoResponse>(`memo/${params.memoId}`, body)).data;
-};
-
-export const createMemo = async (body: ICreateMemoBody): Promise<ICreateMemoResponse> => {
-  return (await AbyssToolsCore.axios.post<ICreateMemoResponse>(`memo`, body)).data;
-};
-
-export const paginateOrganizationMemo = async (
-  params: IPaginateOrganizationMemoParams,
-  query: IPaginateMemoQuery,
-): Promise<IPaginateMemoResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<IPaginateMemoResponse>(
-      `organization/${params.organizationId}/memo/paginate`,
-      { params: query },
-    )
-  ).data;
-};
-
-export const createForOrganizationMemo = async (
-  params: ICreateForOrganizationMemoParams,
-  body: ICreateMemoBody,
-): Promise<ICreateMemoResponse> => {
-  return (await AbyssToolsCore.axios.post<ICreateMemoResponse>(`memo/organization/${params.organizationId}`, body))
-    .data;
-};
-
-export const transferMemo = async (
-  params: { memoId: string },
-  body: ITransferContentBody,
-): Promise<ITransferMemoResponse> => {
-  return (
-    await AbyssToolsCore.axios.post<ITransferMemoResponse>(
-      `memo/${params.memoId}/transfer`,
-      body,
-    )
-  ).data;
-};
-
-export const countOrganizationMemo = async (
-  params: { organizationId: string },
-): Promise<ICountOrganizationResponse> => {
-  return (
-    await AbyssToolsCore.axios.get<ICountOrganizationResponse>(
-      `memo/organization/${params.organizationId}/count`,
-    )
-  ).data;
-};

package/src/constants/memo.constants.ts

@@ -1,3 +0,0 @@
-export const MIN_MEMO_TITLE_LENGTH = 3;
-export const MAX_MEMO_TITLE_LENGTH = 100;
-export const MAX_MEMO_CONTENT_LENGTH = 10000;

package/src/types/interface/api/requests/memo.request.ts

@@ -1,49 +0,0 @@
-import { ContentShareScope } from '../../../enum';
-import { QueryPaginate } from '../type-message/base-paginate';
-
-export type ICreateForOrganizationMemoParams = {
-  organizationId: string;
-};
-export type ICreateMemoBody = {
-  title: string;
-  content: string;
-};
-
-export type IUpdateMemoParams = {
-  memoId: string;
-};
-export type IUpdateMemoBody = {
-  title?: string;
-  content?: string;
-  archived?: boolean;
-};
-
-export type IGetMemoParams = {
-  memoId: string;
-};
-
-export type IDeleteMemoParams = {
-  memoId: string;
-};
-
-export type IPaginateMemoQuery = {
-  title?: string;
-  archived?: boolean;
-  scope?: ContentShareScope;
-  teamId?: string;
-  projectId?: string;
-  adminView?: boolean;
-  sharedWithMe?: boolean;
-} & QueryPaginate;
-
-export type IPaginateProjectMemoParams = {
-  projectId: string;
-};
-
-export type IPaginateOrganizationMemoParams = {
-  organizationId: string;
-};
-
-export type ICountOrganizationMemoParams = {
-  organizationId: string;
-};

package/src/types/interface/api/responses/memo.response.ts

@@ -1,32 +0,0 @@
-import { BasePaginate } from '../type-message/base-paginate';
-import { IResponse } from '../type-message/response';
-import { IMemo } from '../../models/memo.dto';
-import { SharePermission } from '../../../enum/content-share.enum';
-
-export interface IGetMemoData {
-  memo: IMemo;
-  sharePermission?: SharePermission | null;
-}
-export type IGetMemoResponse = IResponse<IGetMemoData>;
-
-export interface IUpdateMemoData {
-  memo: IMemo;
-}
-export type IUpdateMemoResponse = IResponse<IUpdateMemoData>;
-
-export interface ICreateMemoData {
-  memo: IMemo;
-}
-export type ICreateMemoResponse = IResponse<ICreateMemoData>;
-
-export interface IDeleteMemoData {}
-export type IDeleteMemoResponse = IResponse<IDeleteMemoData>;
-
-export type IPaginateMemoResponse = IResponse<BasePaginate<IMemo>>;
-
-export interface ICountOrganizationMemoData {
-  total: number;
-  orphan?: number;
-  unshared?: number;
-}
-export type ICountOrganizationMemoResponse = IResponse<ICountOrganizationMemoData>;

package/src/types/interface/models/memo.dto.ts

@@ -1,23 +0,0 @@
-import { IOrganization } from './organization.dto';
-import { IProject } from './project.dto';
-import { IEntityTag } from './tag.dto';
-import { IUser } from './user.dto';
-
-export interface IMemo {
-  id: string;
-  title: string;
-  content: string;
-  userId: string | null;
-  projectId: string | null;
-  organizationId: string | null;
-  createdByUserId: string | null;
-  archivedAt?: Date | null;
-  updatedAt?: Date;
-  createdAt?: Date;
-
-  // Association
-  user?: IUser | null;
-  project?: IProject | null;
-  organization?: IOrganization | null;
-  entityTags?: IEntityTag[];
-}