@abyss-project/beam 0.0.0-stage → 1.0.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/enum.utils.ts

@@ -0,0 +1 @@
+export type ValueOf<T> = T[keyof T];

package/src/utils/error.utils.ts

@@ -0,0 +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);
+};

package/src/utils/index.ts

@@ -0,0 +1,2 @@
+export * from './error.utils';
+export * from './enum.utils';

package/tsconfig.check.json

@@ -0,0 +1,15 @@
+{
+  // Perimetre de VERIFICATION, distinct de celui du build.
+  //
+  // `tsconfig.json` exclut `src/**/*.spec.ts` parce qu'il sert a emettre `dist/`, ou une spec
+  // n'a rien a faire. Mais eslint s'appuie sur ce meme fichier via `parserOptions.project` :
+  // les cinq specs du paquet sortaient donc en « Parsing error: that TSConfig does not include
+  // this file », mesure du 2026-09-09, et n'etaient lintees par personne.
+  //
+  // Ce fichier sert uniquement a eslint. Il n'emet rien et ne change pas ce que `build` produit.
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true
+  },
+  "exclude": ["./dist/**/*"]
+}

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "compilerOptions": {
+    "incremental": false,
+    "target": "es2021",
+    "lib": [
+      "dom",
+      "es2021"
+    ],
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "module": "commonjs",
+    "rootDir": "src",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "allowJs": true,
+    "declaration": true,
+    "sourceMap": true,
+    "outDir": "./dist",
+    "removeComments": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictPropertyInitialization": false,
+    "skipLibCheck": true
+  },
+  "include": [
+    "./src"
+  ],
+  "exclude": [
+    "./dist/**/*",
+    "./src/**/*.spec.ts"
+  ]
+}