@abyss-project/link 0.0.0-stage → 1.0.0

package/src/constants/tests/link-forbidden-slugs.spec.ts

@@ -0,0 +1,103 @@
+import {
+  isForbiddenLinkSlug,
+  LINK_FORBIDDEN_SLUG_PREFIXES,
+  LINK_FORBIDDEN_SLUGS,
+  LINK_RESOURCE_PREFIXES,
+  LINK_SLUG_PATTERN,
+  LinkResourceProduct,
+  MAX_LINK_SLUG_LENGTH,
+  MIN_LINK_SLUG_LENGTH,
+} from '../..';
+
+describe('LINK_RESOURCE_PREFIXES', () => {
+  it('maps the eight products of spec §3.5 to their prefix', () => {
+    expect(LINK_RESOURCE_PREFIXES).toEqual({
+      [LinkResourceProduct.BEAM]: 'b',
+      [LinkResourceProduct.ATLAS]: 'a',
+      [LinkResourceProduct.DRAW]: 'd',
+      [LinkResourceProduct.RETROSPECTIVE]: 'r',
+      [LinkResourceProduct.FORM]: 'f',
+      [LinkResourceProduct.EXTRACT]: 'e',
+      [LinkResourceProduct.CLOUD]: 'c',
+      [LinkResourceProduct.MEMORIES]: 'm',
+    });
+  });
+
+  it('gives Spotlight no prefix: a campaign token has no Link address', () => {
+    expect(Object.keys(LINK_RESOURCE_PREFIXES)).not.toContain(LinkResourceProduct.SPOTLIGHT);
+  });
+
+  it('never gives two products the same prefix, and every prefix is lowercase', () => {
+    const prefixes = Object.values(LINK_RESOURCE_PREFIXES);
+    expect(new Set(prefixes).size).toBe(prefixes.length);
+    prefixes.forEach((prefix) => expect(prefix).toBe(prefix.toLowerCase()));
+  });
+});
+
+describe('LINK_FORBIDDEN_SLUGS', () => {
+  it.each(Object.values(LINK_RESOURCE_PREFIXES))('forbids the resource prefix %s', (prefix) => {
+    expect(LINK_FORBIDDEN_SLUGS).toContain(prefix);
+    expect(isForbiddenLinkSlug(prefix)).toBe(true);
+    expect(isForbiddenLinkSlug(prefix.toUpperCase())).toBe(true);
+  });
+
+  it('holds the host paths of spec §3.5, in lowercase', () => {
+    expect(LINK_FORBIDDEN_SLUGS).toEqual(
+      expect.arrayContaining([
+        'api',
+        'assets',
+        'static',
+        'health',
+        'admin',
+        'login',
+        'favicon.ico',
+        'robots.txt',
+        '.well-known',
+      ]),
+    );
+    LINK_FORBIDDEN_SLUGS.forEach((slug) => expect(slug).toBe(slug.toLowerCase()));
+  });
+
+  it('forbids every slug starting with _ or abyss', () => {
+    expect(LINK_FORBIDDEN_SLUG_PREFIXES).toEqual(['_', 'abyss']);
+  });
+});
+
+describe('isForbiddenLinkSlug', () => {
+  it.each([
+    '_x',
+    '_',
+    'API',
+    'Api',
+    'Abyss-team',
+    'ABYSS',
+    'abyssal',
+    '.well-known',
+    'Favicon.ico',
+    'LOGIN',
+  ])('forbids %s', (slug) => {
+    expect(isForbiddenLinkSlug(slug)).toBe(true);
+  });
+
+  it.each(['abc', 'my-link', 'apis', 'x_abyss', 'B2B', 'admins'])('allows %s', (slug) => {
+    expect(isForbiddenLinkSlug(slug)).toBe(false);
+  });
+});
+
+describe('LINK_SLUG_PATTERN', () => {
+  it('accepts 3 to 50 characters of [a-zA-Z0-9_-]', () => {
+    expect(MIN_LINK_SLUG_LENGTH).toBe(3);
+    expect(MAX_LINK_SLUG_LENGTH).toBe(50);
+    expect(LINK_SLUG_PATTERN.test('a'.repeat(MIN_LINK_SLUG_LENGTH))).toBe(true);
+    expect(LINK_SLUG_PATTERN.test('a'.repeat(MAX_LINK_SLUG_LENGTH))).toBe(true);
+    expect(LINK_SLUG_PATTERN.test('My_Link-42')).toBe(true);
+  });
+
+  it('refuses a slug too short, too long or with another character', () => {
+    expect(LINK_SLUG_PATTERN.test('a'.repeat(MIN_LINK_SLUG_LENGTH - 1))).toBe(false);
+    expect(LINK_SLUG_PATTERN.test('a'.repeat(MAX_LINK_SLUG_LENGTH + 1))).toBe(false);
+    expect(LINK_SLUG_PATTERN.test('my.link')).toBe(false);
+    expect(LINK_SLUG_PATTERN.test('my/link')).toBe(false);
+    expect(LINK_SLUG_PATTERN.test('lien-été')).toBe(false);
+  });
+});

package/src/index.ts

@@ -0,0 +1,109 @@
+import axios from 'axios';
+import axiosRetry, { IAxiosRetryConfig, isNetworkOrIdempotentRequestError } from 'axios-retry';
+
+export * from './api';
+export * from './types';
+export * from './utils';
+export * from './constants';
+
+import * as abyssAdminApi from './api/abyss.admin.api';
+
+const DEFAULT_BASE_URL = 'https://link-api.abyss-project.fr/api/';
+
+export const API_KEY_HEADER = 'abyss-api-key';
+export const ADMIN_TOKEN_HEADER = 'abyss-admin-token';
+
+const NUMBER_RETRY_API = 10;
+const BASE_DELAY_BETWEEN_RETRY = 5000;
+const RETRY_CODES = [
+  502, // Bad Gateway
+  503, // Service Unavailable
+];
+
+type CoreConfig = {
+  token?: string;
+  apiKey?: string;
+  adminToken?: string;
+  baseURL?: string;
+};
+
+type AbyssLinkCoreSDK = {
+  abyss: {
+    admin: {
+      activateUserService: typeof abyssAdminApi.activateUserServiceAbyssAdmin;
+      syncOrganization: typeof abyssAdminApi.syncOrganizationAbyssAdmin;
+      syncProject: typeof abyssAdminApi.syncProjectAbyssAdmin;
+    };
+  };
+};
+
+export class AbyssLinkCore {
+  private static config = {
+    token: '',
+    apiKey: '',
+    adminToken: '',
+    baseURL: DEFAULT_BASE_URL,
+  };
+  static axios = axios.create({
+    baseURL: this.config.baseURL,
+    withCredentials: true,
+  });
+
+  private static _sdk: AbyssLinkCoreSDK | null = null;
+
+  public static get sdk(): AbyssLinkCoreSDK {
+    if (!AbyssLinkCore._sdk) {
+      AbyssLinkCore._sdk = AbyssLinkCore.buildSDK();
+    }
+    return AbyssLinkCore._sdk;
+  }
+
+  private static buildSDK(): AbyssLinkCoreSDK {
+    return {
+      abyss: {
+        admin: {
+          activateUserService: abyssAdminApi.activateUserServiceAbyssAdmin,
+          syncOrganization: abyssAdminApi.syncOrganizationAbyssAdmin,
+          syncProject: abyssAdminApi.syncProjectAbyssAdmin,
+        },
+      },
+    };
+  }
+
+  public static enableAxiosRetry(axiosRetryConfig?: IAxiosRetryConfig): void {
+    axiosRetry(AbyssLinkCore.axios, {
+      retries: NUMBER_RETRY_API,
+      retryDelay: (retryCount) => retryCount * BASE_DELAY_BETWEEN_RETRY,
+      retryCondition: (error) =>
+        isNetworkOrIdempotentRequestError(error) ||
+        RETRY_CODES.includes(error.response?.status || 502),
+      ...axiosRetryConfig,
+    });
+  }
+
+  public static setConfig(config: CoreConfig): void {
+    AbyssLinkCore._sdk = null;
+
+    AbyssLinkCore.config = { ...AbyssLinkCore.config, ...config };
+
+    if (config.baseURL) {
+      AbyssLinkCore.axios.defaults.baseURL = config.baseURL;
+    }
+
+    if (config.token) {
+      AbyssLinkCore.axios.defaults.headers.common.Authorization = `Bearer ${config.token}`;
+    }
+
+    if (config.apiKey) {
+      AbyssLinkCore.axios.defaults.headers.common[API_KEY_HEADER] = `${config.apiKey}`;
+    }
+
+    if (config.adminToken) {
+      AbyssLinkCore.axios.defaults.headers.common[ADMIN_TOKEN_HEADER] = `${config.adminToken}`;
+    }
+  }
+
+  public static getConfig(): CoreConfig {
+    return AbyssLinkCore.config;
+  }
+}

package/src/tests/sdk-surface.spec.ts

@@ -0,0 +1,63 @@
+import { AbyssLinkCore, ADMIN_TOKEN_HEADER } from '..';
+
+const USER_ID = '11111111-1111-4111-8111-111111111111';
+const ORGANIZATION_ID = '22222222-2222-4222-8222-222222222222';
+const PROJECT_ID = '33333333-3333-4333-8333-333333333333';
+
+describe('AbyssLinkCore SDK surface', () => {
+  let post: jest.SpyInstance;
+
+  beforeEach(() => {
+    post = jest.spyOn(AbyssLinkCore.axios, 'post').mockResolvedValue({ data: { data: {} } });
+  });
+
+  afterEach(() => {
+    jest.restoreAllMocks();
+  });
+
+  it('exposes exactly the three abyss.admin calls', () => {
+    expect(Object.keys(AbyssLinkCore.sdk)).toEqual(['abyss']);
+    expect(Object.keys(AbyssLinkCore.sdk.abyss)).toEqual(['admin']);
+    expect(Object.keys(AbyssLinkCore.sdk.abyss.admin).sort()).toEqual([
+      'activateUserService',
+      'syncOrganization',
+      'syncProject',
+    ]);
+  });
+
+  it('activates a user with POST abyss/admin/user/activate-service', async () => {
+    const body = { userId: USER_ID };
+    await AbyssLinkCore.sdk.abyss.admin.activateUserService(body);
+    expect(post).toHaveBeenCalledWith('abyss/admin/user/activate-service', body);
+  });
+
+  it('syncs an organization with POST abyss/admin/organization/sync', async () => {
+    const body = { id: ORGANIZATION_ID, name: 'Org', slug: 'org' };
+    await AbyssLinkCore.sdk.abyss.admin.syncOrganization(body);
+    expect(post).toHaveBeenCalledWith('abyss/admin/organization/sync', body);
+  });
+
+  it('syncs a project with POST abyss/admin/project/sync', async () => {
+    const body = {
+      id: PROJECT_ID,
+      name: 'Project',
+      createdByUserId: null,
+      organizationId: ORGANIZATION_ID,
+    };
+    await AbyssLinkCore.sdk.abyss.admin.syncProject(body);
+    expect(post).toHaveBeenCalledWith('abyss/admin/project/sync', body);
+  });
+
+  it('returns the response body', async () => {
+    post.mockResolvedValueOnce({ data: { data: { user: { id: USER_ID, isAdmin: false } } } });
+    await expect(
+      AbyssLinkCore.sdk.abyss.admin.activateUserService({ userId: USER_ID }),
+    ).resolves.toEqual({ data: { user: { id: USER_ID, isAdmin: false } } });
+  });
+
+  it('sends the admin token and the base URL given to setConfig', () => {
+    AbyssLinkCore.setConfig({ adminToken: 'admin-token', baseURL: 'http://localhost:10144/api/' });
+    expect(AbyssLinkCore.axios.defaults.headers.common[ADMIN_TOKEN_HEADER]).toBe('admin-token');
+    expect(AbyssLinkCore.axios.defaults.baseURL).toBe('http://localhost:10144/api/');
+  });
+});

package/src/types/enum/api-error.enum.ts

@@ -0,0 +1,18 @@
+export enum ErrorType {
+  apiError = 'api_error',
+  authError = 'authentication_error',
+  resourceError = 'resource_error',
+}
+
+export enum Code {
+  // HTTP Error
+  tokenFailure = 'token_authentication_failure',
+  authenticationFailure = 'authentication_credentials_failure',
+  accessNotAllowed = 'access_not_allowed',
+  notFound = 'not_found',
+  validationError = 'resource_validation_error',
+  constraintError = 'resource_constraint_error',
+  internalServerError = 'internal_server_error',
+  serviceUnavailable = 'service_unavailable',
+  invalidData = 'invalid_data',
+}

package/src/types/enum/index.ts

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

package/src/types/enum/link.enum.ts

@@ -0,0 +1,34 @@
+/** The three sorts of link (spec §2). Stored as is in `links.kind`. */
+export enum LinkKind {
+  /** Owned by a user, served by Link at `<host>/<slug>`, billed on ABYSS_LINK. */
+  SHORTENED = 'SHORTENED',
+  /** Owned by a product, served by Link at `<host>/<prefix>/<code>`, never listed, never billed. */
+  RESOURCE = 'RESOURCE',
+  /** Owned by a user, no Link address: a token the target product (Spotlight) reads from its query string. */
+  CAMPAIGN_TOKEN = 'CAMPAIGN_TOKEN',
+}
+
+/** Where a visit was recorded. Stored as is in `link_visits.source`. */
+export enum LinkVisitSource {
+  /** A 302 served by the Link host. */
+  REDIRECT = 'REDIRECT',
+  /** A page view a product reported for a campaign token. */
+  CAMPAIGN_VIEW = 'CAMPAIGN_VIEW',
+}
+
+/**
+ * The product a RESOURCE or CAMPAIGN_TOKEN link belongs to (`links.originService`).
+ * Link's own list, not main's `AbyssService`: a Link product is not a billing service, and
+ * Atlas, Draw and Retrospective are tools of AbyssWorkspace, not services.
+ */
+export enum LinkResourceProduct {
+  BEAM = 'BEAM',
+  SPOTLIGHT = 'SPOTLIGHT',
+  ATLAS = 'ATLAS',
+  DRAW = 'DRAW',
+  RETROSPECTIVE = 'RETROSPECTIVE',
+  FORM = 'FORM',
+  EXTRACT = 'EXTRACT',
+  CLOUD = 'CLOUD',
+  MEMORIES = 'MEMORIES',
+}

package/src/types/index.ts

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

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

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

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

@@ -0,0 +1,17 @@
+export interface IActivateUserServiceAbyssAdminBody {
+  userId: string;
+}
+
+export interface ISyncOrganizationAbyssAdminBody {
+  id: string;
+  name: string;
+  slug: string;
+}
+
+export interface ISyncProjectAbyssAdminBody {
+  id: string;
+  name: string;
+  /** null when the author's account was deleted: the project outlives it (#199). */
+  createdByUserId: string | null;
+  organizationId: string;
+}

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

@@ -0,0 +1 @@
+export * from './abyss.admin.request';

package/src/types/interface/api/responses/abyss.admin.response.ts

@@ -0,0 +1,17 @@
+import { IUser, IOrganization, IProject } from '../..';
+import { IResponse } from '../type-message/response';
+
+export interface IActivateUserServiceAbyssAdminData {
+  user: IUser;
+}
+export type IActivateUserServiceAbyssAdminResponse = IResponse<IActivateUserServiceAbyssAdminData>;
+
+export interface ISyncOrganizationAbyssAdminData {
+  organization: IOrganization;
+}
+export type ISyncOrganizationAbyssAdminResponse = IResponse<ISyncOrganizationAbyssAdminData>;
+
+export interface ISyncProjectAbyssAdminData {
+  project: IProject;
+}
+export type ISyncProjectAbyssAdminResponse = IResponse<ISyncProjectAbyssAdminData>;

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

@@ -0,0 +1 @@
+export * from './abyss.admin.response';

package/src/types/interface/api/type-message/api-error.ts

@@ -0,0 +1,7 @@
+import { Code, ErrorType } from '../../../enum';
+
+export interface IApiError {
+  code: Code;
+  type: ErrorType;
+  message?: string;
+}

package/src/types/interface/api/type-message/base-paginate.ts

@@ -0,0 +1,11 @@
+export interface BasePaginate<T> {
+  maxPages: number;
+  currentPage: number;
+  data: T[];
+  totalItems: number;
+}
+
+export interface QueryPaginate {
+  page?: number;
+  limit?: number;
+}

package/src/types/interface/api/type-message/response.ts

@@ -0,0 +1,6 @@
+import { IApiError } from './api-error';
+
+export interface IResponse<T> {
+  data: T;
+  error?: IApiError | Error;
+}

package/src/types/interface/index.ts

@@ -0,0 +1,2 @@
+export * from './models';
+export * from './api';

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

@@ -0,0 +1,4 @@
+export * from './user.dto';
+export * from './organization.dto';
+export * from './project.dto';
+export * from './link.dto';

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

@@ -0,0 +1,117 @@
+import { LinkKind, LinkResourceProduct, LinkVisitSource } from '../../enum/link.enum';
+import { IOrganization } from './organization.dto';
+import { IProject } from './project.dto';
+import { IUser } from './user.dto';
+
+/** The product resource a RESOURCE or CAMPAIGN_TOKEN link belongs to (spec §4). */
+export interface ILinkOrigin {
+  service: LinkResourceProduct;
+  /** Product-defined type, for example `beam_transfer`. */
+  resourceType: string;
+  resourceId: string;
+}
+
+/** A row of `links` (spec §7). Which address columns are set depends on `kind`. */
+export interface ILink {
+  id: string;
+  kind: LinkKind;
+  /** SHORTENED only, case kept as typed. */
+  slug: string | null;
+  /** SHORTENED only: `lower(slug)`, unique, the resolution key. */
+  slugKey: string | null;
+  /** RESOURCE only: a value of `LINK_RESOURCE_PREFIXES`. */
+  prefix: string | null;
+  /** RESOURCE only: base62, `LINK_RESOURCE_CODE_LENGTH` characters. */
+  code: string | null;
+  /** CAMPAIGN_TOKEN only: base62, `LINK_CAMPAIGN_TOKEN_LENGTH` characters. */
+  token: string | null;
+  targetUrl: string;
+  title: string | null;
+  description: string | null;
+  userId: string | null;
+  projectId: string | null;
+  organizationId: string | null;
+  createdByUserId: string | null;
+  /** Null for SHORTENED, set for RESOURCE and CAMPAIGN_TOKEN. */
+  originService: LinkResourceProduct | null;
+  originResourceType: string | null;
+  originResourceId: string | null;
+  isActive: boolean;
+  expiresAt: Date | null;
+  maxClicks: number | null;
+  /** SHORTENED only (scrypt, ADR-0238). */
+  passwordHash: string | null;
+  forwardCampaignParams: boolean;
+  isProtected: boolean;
+  protectedAt: Date | null;
+  protectedByAdminId: string | null;
+  /** Display values refreshed by the daily rollup; never read to decide a resolution. */
+  clickCount: number;
+  uniqueClickCount: number;
+  lastVisitedAt: Date | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+
+  user?: IUser | null;
+  project?: IProject | null;
+  organization?: IOrganization | null;
+}
+
+/** A row of `link_visits` (spec §7). No IP, no full referer, no raw user agent. */
+export interface ILinkVisit {
+  id: string;
+  linkId: string;
+  visitedAt: Date;
+  source: LinkVisitSource;
+  /** `hashVisitor` of the visit's UTC day: comparable within one day only. */
+  visitorHash: string;
+  isBot: boolean;
+  isFirstOfDay: boolean;
+  country: string | null;
+  city: string | null;
+  device: string | null;
+  browser: string | null;
+  os: string | null;
+  language: string | null;
+  refererDomain: string | null;
+  utmSource: string | null;
+  utmMedium: string | null;
+  utmCampaign: string | null;
+  utmTerm: string | null;
+  utmContent: string | null;
+}
+
+/** Visit counts by value, human visits only (spec §3.4). */
+export interface ILinkBreakdowns {
+  countries: Record<string, number>;
+  cities: Record<string, number>;
+  devices: Record<string, number>;
+  browsers: Record<string, number>;
+  oses: Record<string, number>;
+  languages: Record<string, number>;
+  refererDomains: Record<string, number>;
+  utmSources: Record<string, number>;
+  utmMediums: Record<string, number>;
+  utmCampaigns: Record<string, number>;
+}
+
+/** A row of `link_daily_stats`: one per link and UTC day (spec §3.4). */
+export interface ILinkDailyStats extends ILinkBreakdowns {
+  linkId: string;
+  /** UTC day, `YYYY-MM-DD`. */
+  day: string;
+  /** Human visits. */
+  visits: number;
+  /** Distinct visitor hashes of the day. */
+  uniqueVisitors: number;
+  botVisits: number;
+}
+
+/** Statistics of a link over a period. `uniqueVisitors` is the sum of the daily distinct visitors. */
+export interface ILinkStats extends ILinkBreakdowns {
+  visits: number;
+  uniqueVisitors: number;
+  botVisits: number;
+  lastVisitedAt: Date | null;
+  daily: ILinkDailyStats[];
+}

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

@@ -0,0 +1,21 @@
+import { IProject } from './project.dto';
+
+export interface IOrganization {
+  id?: string;
+  name: string;
+  slug: string;
+  // Mirror of abyss-main Organization.kind. Drives the family default-share
+  // permission (family → EDIT, else VIEW). Synced by organization.middleware.ts.
+  // Typed as a literal union that mirrors @abyss-project/main's OrganizationKind
+  // enum values 1:1 — this published SDK package intentionally does NOT depend on
+  // @abyss-project/main, so the enum is referenced by value (the api-side model
+  // and middleware narrow this to OrganizationKind, where main IS resolvable).
+  kind?: 'standard' | 'family';
+  // Last refresh of `kind` from abyss-main; drives the TTL (≤5min) sync gate.
+  kindSyncedAt?: string | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  projects?: IProject[];
+}

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

@@ -0,0 +1,16 @@
+import { IOrganization } from './organization.dto';
+import { IUser } from './user.dto';
+
+export interface IProject {
+  id?: string;
+  name: string;
+  // Historical creator of the project, null once their account is deleted. NOT used for access control.
+  createdByUserId: string | null;
+  organizationId: string;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  organization?: IOrganization;
+  user?: IUser;
+}

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

@@ -0,0 +1,19 @@
+import { IProject } from './project.dto';
+
+export interface IUser {
+  id?: string;
+  isAdmin: boolean;
+  // Personal API key mirror from abyss-main (ADR-0037). The lookup hash is the
+  // non-reversible sha256 fingerprint used for local validation; revokedAt marks
+  // a mirrored key that must no longer authenticate.
+  personalApiKeyLookupHash?: string | null;
+  personalApiKeyRevokedAt?: Date | null;
+  // Set when the account was deleted in abyss-main (USER_DELETED, #199): the row stays, marked,
+  // and a session token signed before the deletion no longer authenticates.
+  accountDeletedAt?: Date | null;
+  updatedAt?: Date;
+  createdAt?: Date;
+
+  // Associations
+  projects?: IProject[];
+}

package/src/types/tests/link-enums.spec.ts

@@ -0,0 +1,46 @@
+import {
+  LINK_CAMPAIGN_TOKEN_LENGTH,
+  LINK_CAMPAIGN_TOKENS_PER_PROJECT,
+  LINK_RESOURCE_CODE_LENGTH,
+  LINK_VISIT_RETENTION_DAYS,
+  LinkKind,
+  LinkResourceProduct,
+  LinkVisitSource,
+  MAX_LINK_PASSWORD_LENGTH,
+  MIN_LINK_PASSWORD_LENGTH,
+} from '../..';
+
+describe('link enums: stored values', () => {
+  it('LinkKind has exactly the three kinds of spec §2', () => {
+    expect(Object.values(LinkKind)).toEqual(['SHORTENED', 'RESOURCE', 'CAMPAIGN_TOKEN']);
+  });
+
+  it('LinkVisitSource has exactly REDIRECT and CAMPAIGN_VIEW', () => {
+    expect(Object.values(LinkVisitSource)).toEqual(['REDIRECT', 'CAMPAIGN_VIEW']);
+  });
+
+  it('LinkResourceProduct has exactly the products of spec §3.5 and Spotlight', () => {
+    expect(Object.values(LinkResourceProduct)).toEqual([
+      'BEAM',
+      'SPOTLIGHT',
+      'ATLAS',
+      'DRAW',
+      'RETROSPECTIVE',
+      'FORM',
+      'EXTRACT',
+      'CLOUD',
+      'MEMORIES',
+    ]);
+  });
+});
+
+describe('link limits', () => {
+  it('carries the values of the spec', () => {
+    expect(MIN_LINK_PASSWORD_LENGTH).toBe(4);
+    expect(MAX_LINK_PASSWORD_LENGTH).toBe(128);
+    expect(LINK_RESOURCE_CODE_LENGTH).toBe(10);
+    expect(LINK_CAMPAIGN_TOKEN_LENGTH).toBe(12);
+    expect(LINK_CAMPAIGN_TOKENS_PER_PROJECT).toBe(50);
+    expect(LINK_VISIT_RETENTION_DAYS).toBe(90);
+  });
+});

package/src/utils/enum.utils.ts

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