@abyss-project/tools 1.0.0 → 1.0.3

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

@@ -1,37 +1,49 @@
-import { QueryPaginate } from '../type-message/base-paginate';
-
-export type ICreateForProjectDrawParams = {
-  projectId: string;
-};
-export type ICreateDrawBody = {
-  title: string;
-  content: string;
-};
-
-export type IUpdateDrawParams = {
-  drawId: string;
-};
-export type IUpdateDrawBody = {
-  title?: string;
-  archived?: boolean;
-  content?: string;
-  enablePublicReadAccess?: boolean;
-  enablePublicWriteAccess?: boolean;
-};
-
-export type IGetDrawParams = {
-  drawId: string;
-};
-
-export type IDeleteDrawParams = {
-  drawId: string;
-};
-
-export type IPaginateDrawQuery = {
-  title?: string;
-  archived?: boolean;
-} & QueryPaginate;
-
-export type IPaginateProjectDrawParams = {
-  projectId: string;
-};
+import { ContentShareScope } from '../../../enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export type ICreateForOrganizationDrawParams = {
+  organizationId: string;
+};
+export type ICreateDrawBody = {
+  title: string;
+  content: string;
+};
+
+export type IUpdateDrawParams = {
+  drawId: string;
+};
+export type IUpdateDrawBody = {
+  title?: string;
+  archived?: boolean;
+  content?: string;
+};
+
+export type IGetDrawParams = {
+  drawId: string;
+};
+
+export type IDeleteDrawParams = {
+  drawId: string;
+};
+
+export type IPaginateDrawQuery = {
+  title?: string;
+  archived?: boolean;
+  scope?: ContentShareScope;
+  teamId?: string;
+  projectId?: string;
+  adminView?: boolean;
+  sharedWithMe?: boolean;
+} & QueryPaginate;
+
+export type IPaginateProjectDrawParams = {
+  projectId: string;
+};
+
+export type IPaginateOrganizationDrawParams = {
+  organizationId: string;
+};
+
+export type ICountOrganizationDrawParams = {
+  organizationId: string;
+};

package/src/types/interface/api/requests/index.ts

@@ -1,26 +1,28 @@
-export * from './abyss.admin.request';
-export * from './atlas.request';
-export * from './atlas.public.request';
-export * from './atlas-document.request';
-export * from './atlas-group.request';
-export * from './atlas-page.request';
-export * from './board.request';
-export * from './board-card.request';
-export * from './board-card-checklist.request';
-export * from './board-card-comment.request';
-export * from './board-card-document.request';
-export * from './board-column.request';
-export * from './board-label.request';
-export * from './draw.request';
-export * from './draw.public.request';
-export * from './memo.request';
-export * from './retrospective.request';
-export * from './retrospective.public.request';
-export * from './retrospective-card.request';
-export * from './retrospective-member.request';
-export * from './retrospective-section.request';
-export * from './short-link.request';
-export * from './short-link.public.request';
-export * from './short-link.admin.request';
-export * from './metrics.request';
-export * from './user-tag.request';
+export * from './abyss.admin.request';
+export * from './atlas.request';
+export * from './atlas.public.request';
+export * from './atlas-document.request';
+export * from './atlas-group.request';
+export * from './atlas-page.request';
+export * from './board.request';
+export * from './board-card.request';
+export * from './board-card-checklist.request';
+export * from './board-card-comment.request';
+export * from './board-card-document.request';
+export * from './board-column.request';
+export * from './board-label.request';
+export * from './draw.request';
+export * from './draw.public.request';
+export * from './memo.request';
+export * from './retrospective.request';
+export * from './retrospective.public.request';
+export * from './retrospective-card.request';
+export * from './retrospective-member.request';
+export * from './retrospective-section.request';
+export * from './short-link.request';
+export * from './short-link.public.request';
+export * from './short-link.admin.request';
+export * from './metrics.request';
+export * from './tag.request';
+export * from './transfer.request';
+export * from './rcb.request';

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

@@ -1,35 +1,49 @@
-import { QueryPaginate } from '../type-message/base-paginate';
-
-export type ICreateForProjectMemoParams = {
-  projectId: 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;
-} & QueryPaginate;
-
-export type IPaginateProjectMemoParams = {
-  projectId: string;
-};
+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/requests/metrics.request.ts

@@ -1,3 +1,7 @@
-export interface IGetOrganizationToolsMetricsParams {
-  organizationId: string;
-}
+export interface IGetOrganizationToolsMetricsParams {
+  organizationId: string;
+}
+
+export interface IGetProjectToolsMetricsParams {
+  projectId: string;
+}

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

@@ -0,0 +1,267 @@
+// ──────────────────────────────────────────────
+// RCB API requests.
+// ──────────────────────────────────────────────
+
+import {
+  RcbExtractionMode,
+  RcbFeedbackIssueType,
+  RcbFeedbackStatus,
+  RcbProcessingMode,
+  IRcbBankHint,
+} from '../../models/rcb.dto';
+
+// ─── EXTRACT ─────────────────────────────────
+
+export interface IExtractRcbBody {
+  /** Inline PDF buffer — multipart upload only. SDK helpers wrap this. */
+  pdf?: Buffer | Uint8Array;
+  storage_file_id?: string;
+  mode: RcbExtractionMode;
+  hint?: IRcbBankHint;
+  template_id?: string;
+  template?: Record<string, unknown>;
+  pdf_filename?: string;
+  user_external_id?: string;
+  user_metadata?: Record<string, unknown>;
+  archive?: boolean;
+  force?: boolean;
+  processing?: RcbProcessingMode;
+}
+
+export interface IExtractBulkRcbBody {
+  items: Array<{
+    storage_file_id?: string;
+    pdf_base64?: string;
+    mode: RcbExtractionMode;
+    hint?: IRcbBankHint;
+    template_id?: string;
+    template?: Record<string, unknown>;
+    pdf_filename?: string;
+    user_external_id?: string;
+    user_metadata?: Record<string, unknown>;
+    archive?: boolean;
+    force?: boolean;
+  }>;
+}
+
+// ─── DETECT ──────────────────────────────────
+
+export interface IDetectBulkRcbBody {
+  items: Array<{ pdf_base64: string; pdf_filename?: string }>;
+}
+
+// ─── FILES ───────────────────────────────────
+
+export interface IListFilesRcbQuery {
+  hash?: string;
+  external_id?: string;
+  application_file_id?: string;
+  bank?: string;
+  from?: string;
+  to?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface IGetFileRcbParams {
+  fileId: string;
+}
+
+export interface IPatchFileRcbBody {
+  user_external_id?: string | null;
+  user_metadata?: Record<string, unknown> | null;
+}
+
+// ─── EXTRACTIONS ─────────────────────────────
+
+export interface IGetExtractionRcbParams {
+  extractionId: string;
+}
+
+export interface IPatchExtractionRcbBody {
+  tags?: string[] | null;
+  note?: string | null;
+}
+
+export interface ISearchExtractionRecordsRcbQuery {
+  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 IExportExtractionRcbQuery {
+  format: 'csv' | 'json';
+  delimiter?: ',' | ';' | '\t';
+}
+
+export interface IAsyncExportExtractionRcbBody {
+  format: 'csv' | 'json';
+  delimiter?: ',' | ';' | '\t';
+}
+
+// ─── TEMPLATES ───────────────────────────────
+
+export interface ICreateTemplateRcbBody {
+  name: string;
+  description?: string;
+  template_json: Record<string, unknown>;
+  comment?: string;
+}
+
+export interface IUpdateTemplateRcbBody {
+  template_json: Record<string, unknown>;
+  comment?: string;
+}
+
+export interface IPatchTemplateMetaRcbBody {
+  name?: string;
+  description?: string | null;
+  is_active?: boolean;
+}
+
+// ─── FEEDBACK ────────────────────────────────
+
+export interface ICreateFeedbackRcbBody {
+  extraction_id: string;
+  issue_type: RcbFeedbackIssueType;
+  description?: string;
+}
+
+export interface IPatchFeedbackRcbBody {
+  status: RcbFeedbackStatus;
+}
+
+export interface IListFeedbackRcbQuery {
+  extraction_id?: string;
+  status?: RcbFeedbackStatus;
+  issue_type?: RcbFeedbackIssueType;
+  limit?: number;
+  offset?: number;
+}
+
+// ─── USAGE ───────────────────────────────────
+
+export interface IListUsageRcbQuery {
+  application_id?: string;
+  event_type?: string;
+  from?: string;
+  to?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface ISummaryUsageRcbQuery {
+  from?: string;
+  to?: string;
+}
+
+// ─── WEBHOOK DELIVERIES ─────────────────────
+
+export interface IListWebhookDeliveriesRcbQuery {
+  job_id?: string;
+  event?: string;
+  delivered?: boolean;
+  from?: string;
+  to?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface IReplayWebhookDeliveryRcbBody {
+  url?: string;
+  secret?: string;
+}
+
+// ─── SHARE ───────────────────────────────────
+
+export interface IMintShareExtractionRcbBody {
+  expires_in_days?: number;
+}
+
+// ─── ADMIN: CATALOGUE ────────────────────────
+
+export interface IUpsertBankVersionAdminRcbBody {
+  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 IToggleBankVersionActiveAdminRcbBody {
+  is_active: boolean;
+}
+
+export interface IUpsertQuotaAdminRcbBody {
+  tier?: string;
+  monthly_extract_cap?: number | null;
+  monthly_extracted_cap?: number | null;
+  monthly_bytes_cap?: number | null;
+  queue_only_above_count?: number | null;
+}
+
+export interface IDetectorReplayAdminRcbBody {
+  detected_bank?: string;
+  from?: string;
+  to?: string;
+  limit?: number;
+}
+
+export interface IListRequestLogAdminRcbQuery {
+  since_ms?: number;
+  status_min?: number;
+  status_max?: number;
+  user_id?: string;
+  path_prefix?: string;
+  limit?: number;
+}
+
+// ─── WEBHOOK SUBSCRIPTIONS ──────────────────
+
+import type { RcbWebhookEvent } from '../../models/rcb.dto';
+
+export interface IRcbWebhookScopeQuery {
+  organization_id?: string;
+  project_id?: string;
+}
+
+export interface IPaginateRcbWebhookQuery extends IRcbWebhookScopeQuery {
+  name?: string;
+  event?: RcbWebhookEvent;
+  isEnabled?: boolean;
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateRcbWebhookBody {
+  webhookUrl: string;
+  name?: string;
+  description?: string;
+  isEnabled?: boolean;
+  scopes: RcbWebhookEvent[];
+}
+
+export interface IUpdateRcbWebhookBody {
+  webhookUrl?: string;
+  name?: string;
+  description?: string;
+  isEnabled?: boolean;
+  scopes?: RcbWebhookEvent[];
+}
+
+// ─── SHARED FILES (content_share-backed) ────
+
+export interface IListSharedFilesRcbQuery extends IRcbWebhookScopeQuery {
+  limit?: number;
+  offset?: number;
+}

package/src/types/interface/api/requests/retrospective-card.request.ts

@@ -1,38 +1,38 @@
-export interface IGetRetrospectiveCardParams {
-  retrospectiveId: string;
-  retrospectiveCardId: string;
-}
-
-export interface IPaginateRetrospectiveCardParams {
-  retrospectiveId: string;
-}
-export interface IPaginateRetrospectiveCardQuery {
-  page?: number;
-  limit?: number;
-}
-
-export type ICreateRetrospectiveCardParams = {
-  retrospectiveId: string;
-};
-
-export interface ICreateRetrospectiveCardBody {
-  content: string;
-  positionX: number;
-  positionY: number;
-}
-
-export interface IUpdateRetrospectiveCardParams {
-  retrospectiveId: string;
-  retrospectiveCardId: string;
-}
-
-export interface IUpdateRetrospectiveCardBody {
-  content?: string;
-  positionX?: number;
-  positionY?: number;
-}
-
-export interface IDeleteRetrospectiveCardParams {
-  retrospectiveId: string;
-  retrospectiveCardId: string;
-}
+export interface IGetRetrospectiveCardParams {
+  retrospectiveId: string;
+  retrospectiveCardId: string;
+}
+
+export interface IPaginateRetrospectiveCardParams {
+  retrospectiveId: string;
+}
+export interface IPaginateRetrospectiveCardQuery {
+  page?: number;
+  limit?: number;
+}
+
+export type ICreateRetrospectiveCardParams = {
+  retrospectiveId: string;
+};
+
+export interface ICreateRetrospectiveCardBody {
+  content: string;
+  positionX: number;
+  positionY: number;
+}
+
+export interface IUpdateRetrospectiveCardParams {
+  retrospectiveId: string;
+  retrospectiveCardId: string;
+}
+
+export interface IUpdateRetrospectiveCardBody {
+  content?: string;
+  positionX?: number;
+  positionY?: number;
+}
+
+export interface IDeleteRetrospectiveCardParams {
+  retrospectiveId: string;
+  retrospectiveCardId: string;
+}

package/src/types/interface/api/requests/retrospective-member.request.ts

@@ -1,20 +1,20 @@
-export interface IGetRetrospectiveMemberParams {
-  retrospectiveId: string;
-  retrospectiveMemberId: string;
-}
-
-export interface IListRetrospectiveMemberParams {
-  retrospectiveId: string;
-}
-
-export type IJoinRetrospectiveMemberParams = {
-  retrospectiveId: string;
-};
-
-export type IUpdateRetrospectiveMemberParams = {
-  retrospectiveId: string;
-};
-export interface IUpdateRetrospectiveMemberBody {
-  alias?: string;
-  unmasked?: boolean;
-}
+export interface IGetRetrospectiveMemberParams {
+  retrospectiveId: string;
+  retrospectiveMemberId: string;
+}
+
+export interface IListRetrospectiveMemberParams {
+  retrospectiveId: string;
+}
+
+export type IJoinRetrospectiveMemberParams = {
+  retrospectiveId: string;
+};
+
+export type IUpdateRetrospectiveMemberParams = {
+  retrospectiveId: string;
+};
+export interface IUpdateRetrospectiveMemberBody {
+  alias?: string;
+  unmasked?: boolean;
+}