@abyss-project/tools 1.0.0 → 1.0.3

package/src/types/enum/rcb-bank.enum.ts

@@ -0,0 +1,137 @@
+// ──────────────────────────────────────────────
+// RCB — Formal catalogue of supported banks and versions.
+//
+// Mirrors the server-side registry (BANK_VERSIONS in abyss-tools/apps/api).
+// Use these enums whenever you reference a bank or version in hint mode,
+// UI dropdowns, or per-bank metrics. Adding a bank?
+//   1. Add the entry to BANK_VERSIONS in apps/api.
+//   2. Add the matching id here. CI will catch any mismatch.
+// ──────────────────────────────────────────────
+
+/**
+ * Stable id of a bank+version profile. The wire-format string used in
+ * `hint.bank` (POST /rcb/extract mode=hint) and returned in
+ * extraction.strategy_used.
+ */
+export enum RcbBankVersionId {
+  BNP_CONNEXIS_DEFAULT = 'bnp-connexis-default',
+  BNP_PARIBAS_DEFAULT = 'bnp-paribas-default',
+  SOCIETE_GENERALE_DEFAULT = 'societe-generale-default',
+  CREDIT_AGRICOLE_DEFAULT = 'credit-agricole-default',
+  LCL_DEFAULT = 'lcl-default',
+  BOURSORAMA_DEFAULT = 'boursorama-default',
+  SPENDESK_DEFAULT = 'spendesk-default',
+  LA_BANQUE_POSTALE_DEFAULT = 'la-banque-postale-default',
+  CAISSE_EPARGNE_DEFAULT = 'caisse-epargne-default',
+  THEMIS_DEFAULT = 'themis-default',
+  CIC_EBICS_DEFAULT = 'cic-ebics-default',
+  CIC_DEFAULT = 'cic-default',
+  CREDIT_MUTUEL_DEFAULT = 'credit-mutuel-default',
+  N26_DEFAULT = 'n26-default',
+  REVOLUT_DEFAULT = 'revolut-default',
+  HSBC_DEFAULT = 'hsbc-default',
+  HSBC_UK_DEFAULT = 'hsbc-uk-default',
+  WISE_DEFAULT = 'wise-default',
+  CREDIT_DU_NORD_DEFAULT = 'cdn-default',
+  BRED_DEFAULT = 'bred-default',
+  QONTO_DEFAULT = 'qonto-default',
+  SHINE_DEFAULT = 'shine-default',
+  SWAN_DEFAULT = 'swan-default',
+  ROTHSCHILD_DEFAULT = 'rothschild-default',
+  FINOM_DEFAULT = 'finom-default',
+  TIIME_DEFAULT = 'tiime-default',
+  UBS_DEFAULT = 'ubs-default',
+  CAIXA_DEFAULT = 'caixa-default',
+  CDE_NET_DEFAULT = 'cde-net-default',
+  DELUBAC_DEFAULT = 'delubac-default',
+  AIRWALLEX_DEFAULT = 'airwallex-default',
+  PAYPAL_DEFAULT = 'paypal-default',
+  VIVA_WALLET_DEFAULT = 'viva-wallet-default',
+  PALATINE_DEFAULT = 'palatine-default',
+  NATIXIS_DEFAULT = 'natixis-default',
+  JPMORGAN_DEFAULT = 'jpmorgan-default',
+  LA_NEF_V1 = 'la-nef-v1',
+  LA_NEF_V2 = 'la-nef-v2',
+}
+
+/**
+ * Display catalogue — one entry per supported (bank, version) pair.
+ * Drives dropdowns, "supported banks" pages, and customer docs.
+ */
+export interface RcbBankCatalogueEntry {
+  id: RcbBankVersionId;
+  bank: string;
+  version: string;
+  country: 'FR' | 'UK' | 'CH' | 'US' | 'PT' | 'EU' | 'INTL';
+  type: 'retail' | 'business' | 'neobank' | 'fintech' | 'corporate';
+}
+
+export const RCB_BANK_CATALOGUE: ReadonlyArray<RcbBankCatalogueEntry> = [
+  // ─── French retail / business ─────────────
+  { id: RcbBankVersionId.BNP_CONNEXIS_DEFAULT,      bank: 'BNP Connexis',             version: 'default', country: 'FR', type: 'business' },
+  { id: RcbBankVersionId.BNP_PARIBAS_DEFAULT,       bank: 'BNP Paribas',              version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.SOCIETE_GENERALE_DEFAULT,  bank: 'Société Générale',         version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.CREDIT_AGRICOLE_DEFAULT,   bank: 'Crédit Agricole',          version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.LCL_DEFAULT,               bank: 'LCL',                      version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.BOURSORAMA_DEFAULT,        bank: 'Boursorama',               version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.LA_BANQUE_POSTALE_DEFAULT, bank: 'La Banque Postale',        version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.CAISSE_EPARGNE_DEFAULT,    bank: "Caisse d'Épargne",         version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.CIC_EBICS_DEFAULT,         bank: 'CIC',                      version: 'ebics',   country: 'FR', type: 'business' },
+  { id: RcbBankVersionId.CIC_DEFAULT,               bank: 'CIC',                      version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.CREDIT_MUTUEL_DEFAULT,     bank: 'Crédit Mutuel',            version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.BRED_DEFAULT,              bank: 'BRED',                     version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.CREDIT_DU_NORD_DEFAULT,    bank: 'Crédit du Nord',           version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.CDE_NET_DEFAULT,           bank: 'CDE Net',                  version: 'default', country: 'FR', type: 'business' },
+  { id: RcbBankVersionId.DELUBAC_DEFAULT,           bank: 'Delubac',                  version: 'default', country: 'FR', type: 'business' },
+  { id: RcbBankVersionId.PALATINE_DEFAULT,          bank: 'Palatine',                 version: 'default', country: 'FR', type: 'business' },
+  { id: RcbBankVersionId.NATIXIS_DEFAULT,           bank: 'Natixis',                  version: 'default', country: 'FR', type: 'corporate' },
+  { id: RcbBankVersionId.THEMIS_DEFAULT,            bank: 'Themis Banque',            version: 'default', country: 'FR', type: 'business' },
+  { id: RcbBankVersionId.ROTHSCHILD_DEFAULT,        bank: 'Rothschild Martin Maurel', version: 'default', country: 'FR', type: 'corporate' },
+  { id: RcbBankVersionId.LA_NEF_V1,                 bank: 'La Nef',                   version: 'v1',      country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.LA_NEF_V2,                 bank: 'La Nef',                   version: 'v2',      country: 'FR', type: 'retail' },
+
+  // ─── Neobanks / fintech ───────────────────
+  { id: RcbBankVersionId.QONTO_DEFAULT,             bank: 'Qonto',                    version: 'default', country: 'FR', type: 'neobank' },
+  { id: RcbBankVersionId.SHINE_DEFAULT,             bank: 'Shine',                    version: 'default', country: 'FR', type: 'neobank' },
+  { id: RcbBankVersionId.FINOM_DEFAULT,             bank: 'Finom',                    version: 'default', country: 'EU', type: 'neobank' },
+  { id: RcbBankVersionId.TIIME_DEFAULT,             bank: 'Tiime',                    version: 'default', country: 'FR', type: 'neobank' },
+  { id: RcbBankVersionId.SPENDESK_DEFAULT,          bank: 'Spendesk',                 version: 'default', country: 'FR', type: 'fintech' },
+  { id: RcbBankVersionId.SWAN_DEFAULT,              bank: 'Swan',                     version: 'default', country: 'FR', type: 'fintech' },
+  { id: RcbBankVersionId.N26_DEFAULT,               bank: 'N26',                      version: 'default', country: 'EU', type: 'neobank' },
+  { id: RcbBankVersionId.REVOLUT_DEFAULT,           bank: 'Revolut',                  version: 'default', country: 'EU', type: 'neobank' },
+  { id: RcbBankVersionId.WISE_DEFAULT,              bank: 'Wise',                     version: 'default', country: 'INTL', type: 'fintech' },
+  { id: RcbBankVersionId.PAYPAL_DEFAULT,            bank: 'PayPal',                   version: 'default', country: 'INTL', type: 'fintech' },
+  { id: RcbBankVersionId.AIRWALLEX_DEFAULT,         bank: 'Airwallex',                version: 'default', country: 'INTL', type: 'fintech' },
+  { id: RcbBankVersionId.VIVA_WALLET_DEFAULT,       bank: 'Viva Wallet',              version: 'default', country: 'EU', type: 'fintech' },
+
+  // ─── International retail / corporate ─────
+  { id: RcbBankVersionId.HSBC_DEFAULT,              bank: 'HSBC',                     version: 'default', country: 'FR', type: 'retail' },
+  { id: RcbBankVersionId.HSBC_UK_DEFAULT,           bank: 'HSBC UK',                  version: 'default', country: 'UK', type: 'retail' },
+  { id: RcbBankVersionId.UBS_DEFAULT,               bank: 'UBS',                      version: 'default', country: 'CH', type: 'corporate' },
+  { id: RcbBankVersionId.CAIXA_DEFAULT,             bank: 'Caixa',                    version: 'default', country: 'PT', type: 'retail' },
+  { id: RcbBankVersionId.JPMORGAN_DEFAULT,          bank: 'JPMorgan',                 version: 'default', country: 'US', type: 'corporate' },
+];
+
+/**
+ * Lookup by id (typed). Returns undefined for unknown ids — callers should
+ * treat that as "use auto mode" rather than crash.
+ */
+export function getRcbBankCatalogueEntry(
+  id: string,
+): RcbBankCatalogueEntry | undefined {
+  return RCB_BANK_CATALOGUE.find((e) => e.id === id);
+}
+
+/**
+ * Group catalogue entries by the bank display name. Useful for UIs that
+ * show "BNP Paribas" once with a sub-menu listing all supported versions.
+ */
+export function groupRcbCatalogueByBank(): Map<string, RcbBankCatalogueEntry[]> {
+  const out = new Map<string, RcbBankCatalogueEntry[]>();
+  for (const entry of RCB_BANK_CATALOGUE) {
+    const list = out.get(entry.bank) ?? [];
+    list.push(entry);
+    out.set(entry.bank, list);
+  }
+  return out;
+}

package/src/types/index.ts

@@ -1,5 +1,5 @@
-export * from './interface';
-export * from './enum';
-export * from './draw.type';
-
-export type ValueOf<T> = T[keyof T];
+export * from './interface';
+export * from './enum';
+export * from './draw.type';
+
+export type ValueOf<T> = T[keyof T];

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

@@ -1,5 +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';
+export * from './requests';
+export * from './responses';
+export * from './type-message/response';
+export * from './type-message/api-error';
+export * from './type-message/base-paginate';

package/src/types/interface/api/requests/abyss.admin.request.ts

@@ -1,16 +1,20 @@
-export interface IActivateUserServiceAbyssAdminBody {
-  userId: string;
-}
-
-export interface ISyncOrganizationAbyssAdminBody {
-  id: string;
-  name: string;
-  slug: string;
-}
-
-export interface ISyncProjectAbyssAdminBody {
-  id: string;
-  name: string;
-  userId: string;
-  organizationId: string;
-}
+export interface IActivateUserServiceAbyssAdminBody {
+  userId: string;
+}
+
+export interface ISyncOrganizationAbyssAdminBody {
+  id: string;
+  name: string;
+  slug: string;
+}
+
+export interface ISyncProjectAbyssAdminBody {
+  id: string;
+  name: string;
+  createdByUserId: string;
+  organizationId: string;
+}
+
+export type IGetProjectContentSummaryAdminParams = {
+  projectId: string;
+};

package/src/types/interface/api/requests/atlas-document.request.ts

@@ -1,32 +1,32 @@
-import { QueryPaginate } from '..';
-
-export type IGetUploadPreSignedUrlAtlasDocumentParams = {
-  atlasId: string;
-  atlasPageId: string;
-};
-export type IGetUploadPreSignedUrlAtlasDocumentBody = {
-  name: string;
-};
-
-export type IGetAtlasDocumentParams = {
-  atlasId: string;
-  atlasDocumentId: string;
-};
-
-export type IDeleteAtlasDocumentParams = {
-  atlasId: string;
-  atlasDocumentId: string;
-};
-
-export type IPaginateAtlasDocumentParams = {
-  atlasId: string;
-};
-
-export type IPaginateAtlasDocumentQuery = QueryPaginate & {
-  atlasPageId?: string;
-};
-
-export type IListAtlasDocumentParams = {
-  atlasId: string;
-  atlasPageId: string;
-};
+import { QueryPaginate } from '..';
+
+export type IGetUploadPreSignedUrlAtlasDocumentParams = {
+  atlasId: string;
+  atlasPageId: string;
+};
+export type IGetUploadPreSignedUrlAtlasDocumentBody = {
+  name: string;
+};
+
+export type IGetAtlasDocumentParams = {
+  atlasId: string;
+  atlasDocumentId: string;
+};
+
+export type IDeleteAtlasDocumentParams = {
+  atlasId: string;
+  atlasDocumentId: string;
+};
+
+export type IPaginateAtlasDocumentParams = {
+  atlasId: string;
+};
+
+export type IPaginateAtlasDocumentQuery = QueryPaginate & {
+  atlasPageId?: string;
+};
+
+export type IListAtlasDocumentParams = {
+  atlasId: string;
+  atlasPageId: string;
+};

package/src/types/interface/api/requests/atlas-group.request.ts

@@ -1,45 +1,45 @@
-export interface IGetAtlasGroupParams {
-  atlasId: string;
-  atlasGroupId: string;
-}
-
-export interface IPaginateAtlasGroupParams {
-  atlasId: string;
-}
-
-export interface IPaginateAtlasGroupQuery {
-  name?: string;
-  parentAtlasGroupId?: string;
-  page?: number;
-  limit?: number;
-}
-
-export interface ICreateAtlasGroupParams {
-  atlasId: string;
-}
-export interface ICreateAtlasGroupBody {
-  name: string;
-  description?: string | null;
-  icon?: string | null;
-  color?: string | null;
-  parentAtlasGroupId?: string | null;
-  position?: number;
-}
-
-export interface IUpdateAtlasGroupParams {
-  atlasId: string;
-  atlasGroupId: string;
-}
-export interface IUpdateAtlasGroupBody {
-  name?: string;
-  description?: string | null;
-  icon?: string | null;
-  color?: string | null;
-  parentAtlasGroupId?: string | null;
-  position?: number;
-}
-
-export interface IDeleteAtlasGroupParams {
-  atlasId: string;
-  atlasGroupId: string;
-}
+export interface IGetAtlasGroupParams {
+  atlasId: string;
+  atlasGroupId: string;
+}
+
+export interface IPaginateAtlasGroupParams {
+  atlasId: string;
+}
+
+export interface IPaginateAtlasGroupQuery {
+  name?: string;
+  parentAtlasGroupId?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateAtlasGroupParams {
+  atlasId: string;
+}
+export interface ICreateAtlasGroupBody {
+  name: string;
+  description?: string | null;
+  icon?: string | null;
+  color?: string | null;
+  parentAtlasGroupId?: string | null;
+  position?: number;
+}
+
+export interface IUpdateAtlasGroupParams {
+  atlasId: string;
+  atlasGroupId: string;
+}
+export interface IUpdateAtlasGroupBody {
+  name?: string;
+  description?: string | null;
+  icon?: string | null;
+  color?: string | null;
+  parentAtlasGroupId?: string | null;
+  position?: number;
+}
+
+export interface IDeleteAtlasGroupParams {
+  atlasId: string;
+  atlasGroupId: string;
+}

package/src/types/interface/api/requests/atlas-page.request.ts

@@ -1,84 +1,84 @@
-export interface IGetAtlasPageParams {
-  atlasId: string;
-  atlasPageId: string;
-}
-
-export interface IGetAtlasPageBySlugParams {
-  atlasId: string;
-  slug: string;
-}
-
-export interface IPaginateAtlasPageParams {
-  atlasId: string;
-}
-
-export interface IPaginateAtlasPageQuery {
-  title?: string;
-  slug?: string;
-  atlasGroupId?: string;
-  page?: number;
-  limit?: number;
-}
-
-export interface ICreateAtlasPageParams {
-  atlasId: string;
-}
-
-export interface ICreateAtlasPageBody {
-  title: string;
-  icon?: string | null;
-  color?: string | null;
-  atlasGroupId?: string | null;
-  position?: number;
-  content?: string;
-}
-
-export interface IUpdateAtlasPageParams {
-  atlasId: string;
-  atlasPageId: string;
-}
-
-export interface IUpdateAtlasPageBody {
-  title?: string;
-  icon?: string | null;
-  color?: string | null;
-  atlasGroupId?: string | null;
-  position?: number;
-}
-
-export interface IDeleteAtlasPageParams {
-  atlasId: string;
-  atlasPageId: string;
-}
-
-export interface IUpdateAtlasPageContentParams {
-  atlasId: string;
-  atlasPageId: string;
-}
-export interface IUpdateAtlasPageContentBody {
-  diff: string;
-}
-
-export interface IGetAtlasPageContentHistoryParams {
-  atlasId: string;
-  atlasPageId: string;
-}
-export interface IGetAtlasPageContentHistoryQuery {
-  page?: number;
-  limit?: number;
-}
-
-export interface IRestoreAtlasPageContentParams {
-  atlasId: string;
-  atlasPageId: string;
-  version: number;
-}
-
-export interface ISearchAtlasContentParams {
-  atlasId: string;
-}
-export interface ISearchAtlasContentQuery {
-  query: string;
-  page?: number;
-  limit?: number;
-}
+export interface IGetAtlasPageParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+
+export interface IGetAtlasPageBySlugParams {
+  atlasId: string;
+  slug: string;
+}
+
+export interface IPaginateAtlasPageParams {
+  atlasId: string;
+}
+
+export interface IPaginateAtlasPageQuery {
+  title?: string;
+  slug?: string;
+  atlasGroupId?: string;
+  page?: number;
+  limit?: number;
+}
+
+export interface ICreateAtlasPageParams {
+  atlasId: string;
+}
+
+export interface ICreateAtlasPageBody {
+  title: string;
+  icon?: string | null;
+  color?: string | null;
+  atlasGroupId?: string | null;
+  position?: number;
+  content?: string;
+}
+
+export interface IUpdateAtlasPageParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+
+export interface IUpdateAtlasPageBody {
+  title?: string;
+  icon?: string | null;
+  color?: string | null;
+  atlasGroupId?: string | null;
+  position?: number;
+}
+
+export interface IDeleteAtlasPageParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+
+export interface IUpdateAtlasPageContentParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+export interface IUpdateAtlasPageContentBody {
+  diff: string;
+}
+
+export interface IGetAtlasPageContentHistoryParams {
+  atlasId: string;
+  atlasPageId: string;
+}
+export interface IGetAtlasPageContentHistoryQuery {
+  page?: number;
+  limit?: number;
+}
+
+export interface IRestoreAtlasPageContentParams {
+  atlasId: string;
+  atlasPageId: string;
+  version: number;
+}
+
+export interface ISearchAtlasContentParams {
+  atlasId: string;
+}
+export interface ISearchAtlasContentQuery {
+  query: string;
+  page?: number;
+  limit?: number;
+}

package/src/types/interface/api/requests/atlas.public.request.ts

@@ -1,21 +1,21 @@
-export interface IGetAtlasPublicParams {
-  publicAccessToken: string;
-}
-
-export type ISSEAtlasPublicParams = {
-  publicAccessToken: string;
-};
-
-export interface IGetPageAtlasPublicParams {
-  publicAccessToken: string;
-  atlasPageId: string;
-}
-
-export interface ISearchContentAtlasPublicParams {
-  publicAccessToken: string;
-}
-export interface ISearchContentAtlasPublicQuery {
-  query: string;
-  page?: number;
-  limit?: number;
-}
+export interface IGetAtlasPublicParams {
+  publicAccessToken: string;
+}
+
+export type ISSEAtlasPublicParams = {
+  publicAccessToken: string;
+};
+
+export interface IGetPageAtlasPublicParams {
+  publicAccessToken: string;
+  atlasPageId: string;
+}
+
+export interface ISearchContentAtlasPublicParams {
+  publicAccessToken: string;
+}
+export interface ISearchContentAtlasPublicQuery {
+  query: string;
+  page?: number;
+  limit?: number;
+}

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

@@ -1,40 +1,52 @@
-export interface IGetAtlasParams {
-  atlasId: string;
-}
-
-export interface IPaginateProjectAtlasParams {
-  projectId: string;
-}
-
-export interface IPaginateAtlasQuery {
-  title?: string;
-  page?: number;
-  limit?: number;
-}
-
-export interface ICreateForProjectAtlasParams {
-  projectId: string;
-}
-
-export interface ICreateAtlasBody {
-  title: string;
-  description?: string | null;
-}
-
-export interface IUpdateAtlasParams {
-  atlasId: string;
-}
-export interface IUpdateAtlasBody {
-  title?: string;
-  description?: string | null;
-  enablePublicAccess?: boolean;
-  transferToProjectId?: string | null;
-}
-
-export interface IDeleteAtlasParams {
-  atlasId: string;
-}
-
-export type ISSEAtlasParams = {
-  atlasId: string;
-};
+import { ContentShareScope } from '../../../enum';
+import { QueryPaginate } from '../type-message/base-paginate';
+
+export interface IGetAtlasParams {
+  atlasId: string;
+}
+
+export interface IPaginateProjectAtlasParams {
+  projectId: string;
+}
+
+export type IPaginateAtlasQuery = {
+  title?: string;
+  scope?: ContentShareScope;
+  teamId?: string;
+  projectId?: string;
+  adminView?: boolean;
+  sharedWithMe?: boolean;
+} & QueryPaginate;
+
+export interface ICreateForOrganizationAtlasParams {
+  organizationId: string;
+}
+
+export interface ICreateAtlasBody {
+  title: string;
+  description?: string | null;
+}
+
+export interface IUpdateAtlasParams {
+  atlasId: string;
+}
+export interface IUpdateAtlasBody {
+  title?: string;
+  description?: string | null;
+}
+
+export interface IDeleteAtlasParams {
+  atlasId: string;
+}
+
+export type ISSEAtlasParams = {
+  atlasId: string;
+};
+
+export type IPaginateOrganizationAtlasParams = {
+  organizationId: string;
+};
+
+export type ICountOrganizationAtlasParams = {
+  organizationId: string;
+};