@abyss-project/tools 1.0.5 → 1.2.0

package/src/types/tests/beam.dto.spec.ts

@@ -0,0 +1,61 @@
+import { BeamVisibility } from '../enum/beam.enum';
+import type { IBeamTransfer, IBeamFile, IBeamRecipient } from '../interface/models/beam.dto';
+
+describe('beam DTOs', () => {
+  it('exposes the BeamVisibility enum with PUBLIC and RESTRICTED only', () => {
+    expect(BeamVisibility.PUBLIC).toBe('PUBLIC');
+    expect(BeamVisibility.RESTRICTED).toBe('RESTRICTED');
+    expect(Object.values(BeamVisibility).sort()).toEqual(['PUBLIC', 'RESTRICTED']);
+  });
+
+  it('IBeamTransfer carries ownership + transfer fields', () => {
+    const transfer: IBeamTransfer = {
+      id: 't1',
+      slug: 'abcdefghij',
+      manageTokenHash: null,
+      userId: 'u1',
+      organizationId: null,
+      projectId: null,
+      createdByUserId: 'u1',
+      visibility: BeamVisibility.PUBLIC,
+      passwordHash: null,
+      title: 'My transfer',
+      message: null,
+      isActive: true,
+      expiresAt: null,
+      maxDownloads: null,
+      downloadCount: 0,
+      lastDownloadedAt: null,
+      totalSizeOctet: 0,
+      fileCount: 0,
+    };
+    expect(transfer.slug).toHaveLength(10);
+  });
+
+  it('IBeamFile and IBeamRecipient carry their row fields', () => {
+    const file: IBeamFile = {
+      id: 'f1',
+      transferId: 't1',
+      storageFileId: 'sf1',
+      thumbnailStorageFileId: null,
+      name: 'photo.png',
+      mimeType: 'image/png',
+      sizeOctet: 123,
+      isImage: true,
+      width: 800,
+      height: 600,
+      downloadCount: 0,
+      position: 0,
+    };
+    const recipient: IBeamRecipient = {
+      id: 'r1',
+      transferId: 't1',
+      email: 'a@b.dev',
+      locale: 'fr',
+      sentAt: null,
+      firstOpenedAt: null,
+    };
+    expect(file.isImage).toBe(true);
+    expect(recipient.email).toBe('a@b.dev');
+  });
+});

package/src/types/tests/beam.request-response.spec.ts

@@ -0,0 +1,43 @@
+import { BeamVisibility } from '../enum/beam.enum';
+import type {
+  ICreateBeamBody,
+  IUpdateBeamBody,
+  IPaginateBeamQuery,
+} from '../interface/api/requests/beam.request';
+import type {
+  ICreateBeamResponse,
+  IPaginateBeamResponse,
+} from '../interface/api/responses/beam.response';
+
+describe('beam request/response types', () => {
+  it('ICreateBeamBody accepts the finalize metadata bundle', () => {
+    const body: ICreateBeamBody = {
+      title: 'Pictures',
+      message: 'enjoy',
+      visibility: BeamVisibility.PUBLIC,
+      expiresInDays: 7,
+      password: 'secret',
+      maxDownloads: 100,
+    };
+    expect(body.visibility).toBe(BeamVisibility.PUBLIC);
+  });
+
+  it('IUpdateBeamBody allows nulling expiry and maxDownloads', () => {
+    const body: IUpdateBeamBody = { expiresAt: null, maxDownloads: null, isActive: false };
+    expect(body.expiresAt).toBeNull();
+  });
+
+  it('IPaginateBeamQuery extends pagination with filters', () => {
+    const q: IPaginateBeamQuery = { page: 1, limit: 10, title: 'pic', isActive: true };
+    expect(q.page).toBe(1);
+  });
+
+  it('responses wrap the transfer payload', () => {
+    const created: ICreateBeamResponse = { data: { beamTransfer: { id: 't1' } as never } };
+    const page: IPaginateBeamResponse = {
+      data: { maxPages: 1, currentPage: 1, totalItems: 0, data: [] },
+    };
+    expect(created.data.beamTransfer.id).toBe('t1');
+    expect(page.data.totalItems).toBe(0);
+  });
+});

package/src/utils/board.utils.ts

@@ -1,57 +1,57 @@
-import { differenceInCalendarDays, isBefore } from 'date-fns';
-import { BoardColumnType, IBoardCard } from '../types';
-
-const BOARD_COLUMN_TYPE_STARTED = [BoardColumnType.DOING, BoardColumnType.DONE];
-const BOARD_COLUMN_TYPE_DONE = [BoardColumnType.DONE];
-
-export const isCardStartDateLate = (
-  boardCard: IBoardCard,
-  boardColumnType: BoardColumnType,
-): boolean => {
-  if (!boardCard.startDate) {
-    return false;
-  }
-  return (
-    isBefore(new Date(boardCard.startDate), new Date()) &&
-    !BOARD_COLUMN_TYPE_STARTED.includes(boardColumnType)
-  );
-};
-
-export const isAlmostCardStartDateLate = (
-  boardCard: IBoardCard,
-  boardColumnType: BoardColumnType,
-): boolean => {
-  if (!boardCard.startDate) {
-    return false;
-  }
-  return (
-    !isCardStartDateLate(boardCard, boardColumnType) &&
-    differenceInCalendarDays(new Date(boardCard.startDate), new Date()) <= 2
-  );
-};
-
-export const isCardEndDateLate = (
-  boardCard: IBoardCard,
-  boardColumnType: BoardColumnType,
-): boolean => {
-  if (!boardCard.endDate) {
-    return false;
-  }
-  return (
-    isBefore(new Date(boardCard.endDate), new Date()) &&
-    !BOARD_COLUMN_TYPE_DONE.includes(boardColumnType)
-  );
-};
-
-export const isAlmostCardEndDateLate = (
-  boardCard: IBoardCard,
-  boardColumnType: BoardColumnType,
-): boolean => {
-  if (!boardCard.endDate) {
-    return false;
-  }
-  return (
-    !isCardEndDateLate(boardCard, boardColumnType) &&
-    Math.abs(differenceInCalendarDays(new Date(boardCard.endDate), new Date())) <= 2
-  );
-};
+import { differenceInCalendarDays, isBefore } from 'date-fns';
+import { BoardColumnType, IBoardCard } from '../types';
+
+const BOARD_COLUMN_TYPE_STARTED = [BoardColumnType.DOING, BoardColumnType.DONE];
+const BOARD_COLUMN_TYPE_DONE = [BoardColumnType.DONE];
+
+export const isCardStartDateLate = (
+  boardCard: IBoardCard,
+  boardColumnType: BoardColumnType,
+): boolean => {
+  if (!boardCard.startDate) {
+    return false;
+  }
+  return (
+    isBefore(new Date(boardCard.startDate), new Date()) &&
+    !BOARD_COLUMN_TYPE_STARTED.includes(boardColumnType)
+  );
+};
+
+export const isAlmostCardStartDateLate = (
+  boardCard: IBoardCard,
+  boardColumnType: BoardColumnType,
+): boolean => {
+  if (!boardCard.startDate) {
+    return false;
+  }
+  return (
+    !isCardStartDateLate(boardCard, boardColumnType) &&
+    differenceInCalendarDays(new Date(boardCard.startDate), new Date()) <= 2
+  );
+};
+
+export const isCardEndDateLate = (
+  boardCard: IBoardCard,
+  boardColumnType: BoardColumnType,
+): boolean => {
+  if (!boardCard.endDate) {
+    return false;
+  }
+  return (
+    isBefore(new Date(boardCard.endDate), new Date()) &&
+    !BOARD_COLUMN_TYPE_DONE.includes(boardColumnType)
+  );
+};
+
+export const isAlmostCardEndDateLate = (
+  boardCard: IBoardCard,
+  boardColumnType: BoardColumnType,
+): boolean => {
+  if (!boardCard.endDate) {
+    return false;
+  }
+  return (
+    !isCardEndDateLate(boardCard, boardColumnType) &&
+    Math.abs(differenceInCalendarDays(new Date(boardCard.endDate), new Date())) <= 2
+  );
+};

package/src/utils/enum.utils.ts

@@ -1,5 +1,5 @@
-export const enumToArray = (enums: Record<string, string>): string[] => {
-  return Object.keys(enums).map((type) => {
-    return enums[type];
-  });
-};
+export const enumToArray = (enums: Record<string, string>): string[] => {
+  return Object.keys(enums).map((type) => {
+    return enums[type];
+  });
+};

package/src/utils/error.utils.ts

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

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

@@ -1,30 +1,30 @@
-// ──────────────────────────────────────────────
-// RCB webhook signature verification (server-side helper for receivers).
-//
-// AbyssTools RCB queue signs every webhook delivery with HMAC-SHA256 of
-// the raw JSON body using the secret provided at extract time. Receivers
-// compare the X-RCB-Signature header (format `sha256=<hex>`) against the
-// same computation. Constant-time compare prevents timing attacks.
-//
-// Lazy-requires `crypto` so the SDK stays browser-compatible when this
-// utility is never invoked (browsers won't receive webhooks anyway).
-// ──────────────────────────────────────────────
-
-export interface VerifyRcbWebhookInput {
-  rawBody: string | Buffer;
-  signatureHeader: string | undefined;
-  secret: string;
-}
-
-export function verifyRcbWebhook(input: VerifyRcbWebhookInput): boolean {
-  if (!input.signatureHeader || !input.secret) return false;
-  // eslint-disable-next-line @typescript-eslint/no-var-requires
-  const crypto = require('crypto');
-  const provided = input.signatureHeader.replace(/^sha256=/, '');
-  const computed: string = 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'));
-}
+// ──────────────────────────────────────────────
+// Extraction webhook signature verification (server-side helper for receivers).
+//
+// AbyssTools extraction queue signs every webhook delivery with HMAC-SHA256 of
+// the raw JSON body using the secret provided at extract time. Receivers
+// compare the X-RCB-Signature header (format `sha256=<hex>`) against the
+// same computation. Constant-time compare prevents timing attacks.
+//
+// Lazy-requires `crypto` so the SDK stays browser-compatible when this
+// utility is never invoked (browsers won't receive webhooks anyway).
+// ──────────────────────────────────────────────
+
+export interface VerifyExtractionWebhookInput {
+  rawBody: string | Buffer;
+  signatureHeader: string | undefined;
+  secret: string;
+}
+
+export function verifyExtractionWebhook(input: VerifyExtractionWebhookInput): boolean {
+  if (!input.signatureHeader || !input.secret) return false;
+  // eslint-disable-next-line @typescript-eslint/no-var-requires
+  const crypto = require('crypto');
+  const provided = input.signatureHeader.replace(/^sha256=/, '');
+  const computed: string = 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'));
+}

package/src/utils/icons.utils.ts

@@ -1,96 +1,96 @@
-export const ICON_LIBRARY = {
-  database: '🗄️',
-  server: '🖥️',
-  cloud: '☁️',
-  network: '🌐',
-  router: '📡',
-  security: '🔒',
-  warning: '⚠️',
-  error: '❌',
-  success: '✅',
-  info: 'ℹ️',
-
-  diamond: '💎',
-  gear: '⚙️',
-  tool: '🔧',
-  wrench: '🔨',
-
-  arrowUp: '⬆️',
-  arrowDown: '⬇️',
-  arrowLeft: '⬅️',
-  arrowRight: '➡️',
-  arrowUpRight: '↗️',
-  arrowDownRight: '↘️',
-  arrowDownLeft: '↙️',
-  arrowUpLeft: '↖️',
-
-  start: '🚀',
-  stop: '🛑',
-  pause: '⏸️',
-  play: '▶️',
-  process: '⚡',
-
-  email: '📧',
-  phone: '📞',
-  message: '💬',
-  notification: '🔔',
-
-  document: '📄',
-  folder: '📁',
-  file: '📋',
-  pdf: '📕',
-  image: '🖼️',
-
-  user: '👤',
-  users: '👥',
-  team: '👪',
-  admin: '👨‍💼',
-
-  add: '➕',
-  remove: '➖',
-  edit: '✏️',
-  search: '🔍',
-  filter: '🔽',
-  sort: '📊',
-
-  online: '🟢',
-  offline: '🔴',
-  pending: '🟡',
-  unknown: '⚪',
-
-  circle: '⭕',
-  square: '⬜',
-  triangle: '🔺',
-  star: '⭐',
-  heart: '❤️',
-
-  settings: '⚙️',
-  power: '🔌',
-  battery: '🔋',
-  wifi: '📶',
-  bluetooth: '📲',
-};
-
-export const ICON_CATEGORIES = {
-  technical: ['database', 'server', 'cloud', 'network', 'router', 'security'],
-  status: ['warning', 'error', 'success', 'info', 'online', 'offline', 'pending', 'unknown'],
-  arrows: [
-    'arrowUp',
-    'arrowDown',
-    'arrowLeft',
-    'arrowRight',
-    'arrowUpRight',
-    'arrowDownRight',
-    'arrowDownLeft',
-    'arrowUpLeft',
-  ],
-  process: ['start', 'stop', 'pause', 'play', 'process', 'gear', 'tool', 'wrench'],
-  communication: ['email', 'phone', 'message', 'notification'],
-  files: ['document', 'folder', 'file', 'pdf', 'image'],
-  users: ['user', 'users', 'team', 'admin'],
-  actions: ['add', 'remove', 'edit', 'search', 'filter', 'sort'],
-  shapes: ['circle', 'square', 'triangle', 'star', 'heart', 'diamond'],
-  system: ['settings', 'power', 'battery', 'wifi', 'bluetooth'],
-};
-
-export type IconType = keyof typeof ICON_LIBRARY;
+export const ICON_LIBRARY = {
+  database: '🗄️',
+  server: '🖥️',
+  cloud: '☁️',
+  network: '🌐',
+  router: '📡',
+  security: '🔒',
+  warning: '⚠️',
+  error: '❌',
+  success: '✅',
+  info: 'ℹ️',
+
+  diamond: '💎',
+  gear: '⚙️',
+  tool: '🔧',
+  wrench: '🔨',
+
+  arrowUp: '⬆️',
+  arrowDown: '⬇️',
+  arrowLeft: '⬅️',
+  arrowRight: '➡️',
+  arrowUpRight: '↗️',
+  arrowDownRight: '↘️',
+  arrowDownLeft: '↙️',
+  arrowUpLeft: '↖️',
+
+  start: '🚀',
+  stop: '🛑',
+  pause: '⏸️',
+  play: '▶️',
+  process: '⚡',
+
+  email: '📧',
+  phone: '📞',
+  message: '💬',
+  notification: '🔔',
+
+  document: '📄',
+  folder: '📁',
+  file: '📋',
+  pdf: '📕',
+  image: '🖼️',
+
+  user: '👤',
+  users: '👥',
+  team: '👪',
+  admin: '👨‍💼',
+
+  add: '➕',
+  remove: '➖',
+  edit: '✏️',
+  search: '🔍',
+  filter: '🔽',
+  sort: '📊',
+
+  online: '🟢',
+  offline: '🔴',
+  pending: '🟡',
+  unknown: '⚪',
+
+  circle: '⭕',
+  square: '⬜',
+  triangle: '🔺',
+  star: '⭐',
+  heart: '❤️',
+
+  settings: '⚙️',
+  power: '🔌',
+  battery: '🔋',
+  wifi: '📶',
+  bluetooth: '📲',
+};
+
+export const ICON_CATEGORIES = {
+  technical: ['database', 'server', 'cloud', 'network', 'router', 'security'],
+  status: ['warning', 'error', 'success', 'info', 'online', 'offline', 'pending', 'unknown'],
+  arrows: [
+    'arrowUp',
+    'arrowDown',
+    'arrowLeft',
+    'arrowRight',
+    'arrowUpRight',
+    'arrowDownRight',
+    'arrowDownLeft',
+    'arrowUpLeft',
+  ],
+  process: ['start', 'stop', 'pause', 'play', 'process', 'gear', 'tool', 'wrench'],
+  communication: ['email', 'phone', 'message', 'notification'],
+  files: ['document', 'folder', 'file', 'pdf', 'image'],
+  users: ['user', 'users', 'team', 'admin'],
+  actions: ['add', 'remove', 'edit', 'search', 'filter', 'sort'],
+  shapes: ['circle', 'square', 'triangle', 'star', 'heart', 'diamond'],
+  system: ['settings', 'power', 'battery', 'wifi', 'bluetooth'],
+};
+
+export type IconType = keyof typeof ICON_LIBRARY;

package/src/utils/index.ts

@@ -1,6 +1,6 @@
-export * from './error.utils';
-export * from './board.utils';
-export * from './shape.utils';
-export * from './icons.utils';
-export * from './enum.utils';
-export * from './rcb-webhook.utils';
+export * from './error.utils';
+export * from './board.utils';
+export * from './shape.utils';
+export * from './icons.utils';
+export * from './enum.utils';
+export * from './extraction-webhook.utils';