@abyss-project/link 0.0.0-stage → 1.1.0

package/dist/utils/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./error.utils"), exports);
+__exportStar(require("./enum.utils"), exports);
+__exportStar(require("./link-slug.utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,+CAA6B;AAC7B,oDAAkC"}

package/dist/utils/link-slug.utils.d.ts

@@ -0,0 +1 @@
+export declare const isForbiddenLinkSlug: (slug: string) => boolean;

package/dist/utils/link-slug.utils.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isForbiddenLinkSlug = void 0;
+const link_constants_1 = require("../constants/link.constants");
+const isForbiddenLinkSlug = (slug) => {
+    const key = slug.toLowerCase();
+    return (link_constants_1.LINK_FORBIDDEN_SLUGS.includes(key) ||
+        link_constants_1.LINK_FORBIDDEN_SLUG_PREFIXES.some((prefix) => key.startsWith(prefix)));
+};
+exports.isForbiddenLinkSlug = isForbiddenLinkSlug;
+//# sourceMappingURL=link-slug.utils.js.map

package/dist/utils/link-slug.utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-slug.utils.js","sourceRoot":"","sources":["../../src/utils/link-slug.utils.ts"],"names":[],"mappings":";;;AAAA,gEAAiG;AAG1F,MAAM,mBAAmB,GAAG,CAAC,IAAY,EAAW,EAAE;IAC3D,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAC/B,OAAO,CACL,qCAAoB,CAAC,QAAQ,CAAC,GAAG,CAAC;QAClC,6CAA4B,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CACtE,CAAC;AACJ,CAAC,CAAC;AANW,QAAA,mBAAmB,uBAM9B"}

package/jest.config.cjs

@@ -0,0 +1,9 @@
+/** @type {import('jest').Config} */
+module.exports = {
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  testMatch: ['**/tests/**/*.spec.ts'],
+  modulePathIgnorePatterns: ['dist'],
+};

package/package.json

@@ -1,6 +1,64 @@
 {
   "name": "@abyss-project/link",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.1.0",
+  "description": "Core package to interact with AbyssLink",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts"
+  },
+  "scripts": {
+    "lint": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --fix",
+    "lint:check": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --max-warnings 0",
+    "tsc": "tsc",
+    "build": "tsc",
+    "test": "jest",
+    "prepublishOnly": "tsc && node ../../scripts/check-sdk-surface.cjs",
+    "dev": "tsc --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/abyss-group/abyss-link.git"
+  },
+  "keywords": [],
+  "author": "scylla",
+  "license": "ISC",
+  "engines": {
+    "node": ">=19.8"
+  },
+  "dependencies": {
+    "axios": "^1.6.0",
+    "axios-retry": "^4.5.0",
+    "date-fns": "^2.30.0",
+    "dayjs": "^1.10.7",
+    "jsonwebtoken": "^8.5.1",
+    "reflect-metadata": "^0.1.13",
+    "ts-node": "^10.4.0",
+    "ts-node-dev": "^1.1.1",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@types/express-serve-static-core": "^4.19.6",
+    "@types/jest": "^29.5.14",
+    "@types/jsonwebtoken": "^8.5.0",
+    "@types/node": "^20.11.0",
+    "@types/uuid": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "8.71.0",
+    "@typescript-eslint/parser": "8.71.0",
+    "eslint": "^8.57.1",
+    "eslint-config-airbnb-base": "^14.2.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-filenames-simple": "^0.7.0",
+    "eslint-plugin-import": "^2.23.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "jest": "^29.7.0",
+    "prettier": "2.3.1",
+    "ts-jest": "^29.4.15",
+    "tsc-watch": "^4.6.2",
+    "typescript": "5.9.3"
+  }
+}

package/src/api/abyss.admin.api.ts

@@ -0,0 +1,39 @@
+import {
+  AbyssLinkCore,
+  IActivateUserServiceAbyssAdminBody,
+  IActivateUserServiceAbyssAdminResponse,
+  ISyncOrganizationAbyssAdminBody,
+  ISyncOrganizationAbyssAdminResponse,
+  ISyncProjectAbyssAdminBody,
+  ISyncProjectAbyssAdminResponse,
+} from '..';
+
+export const activateUserServiceAbyssAdmin = async (
+  body: IActivateUserServiceAbyssAdminBody,
+): Promise<IActivateUserServiceAbyssAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<IActivateUserServiceAbyssAdminResponse>(
+      `abyss/admin/user/activate-service`,
+      body,
+    )
+  ).data;
+};
+
+export const syncOrganizationAbyssAdmin = async (
+  body: ISyncOrganizationAbyssAdminBody,
+): Promise<ISyncOrganizationAbyssAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<ISyncOrganizationAbyssAdminResponse>(
+      `abyss/admin/organization/sync`,
+      body,
+    )
+  ).data;
+};
+
+export const syncProjectAbyssAdmin = async (
+  body: ISyncProjectAbyssAdminBody,
+): Promise<ISyncProjectAbyssAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<ISyncProjectAbyssAdminResponse>(`abyss/admin/project/sync`, body)
+  ).data;
+};

package/src/api/index.ts

@@ -0,0 +1,4 @@
+export * from './abyss.admin.api';
+export * from './link.api';
+export * from './link.admin.api';
+export * from './link.public.api';

package/src/api/link.admin.api.ts

@@ -0,0 +1,168 @@
+import {
+  AbyssLinkCore,
+  ICreateLinkAdminBody,
+  ICreateLinkAdminResponse,
+  IDeleteCampaignTokenLinkAdminParams,
+  IDeleteCampaignTokenLinkAdminResponse,
+  IDeleteLinkAdminParams,
+  IDeleteLinkAdminResponse,
+  IGetByOriginLinkAdminQuery,
+  IGetByOriginLinkAdminResponse,
+  IGetCampaignStatsLinkAdminParams,
+  IGetCampaignStatsLinkAdminQuery,
+  IGetCampaignStatsLinkAdminResponse,
+  IGetLinkAdminParams,
+  IGetLinkAdminResponse,
+  IGetLinkStatsQuery,
+  IGetStatsByOriginLinkAdminResponse,
+  IGetVisitsLinkAdminParams,
+  IGetVisitsLinkAdminQuery,
+  IGetVisitsLinkAdminResponse,
+  IListCampaignTokensLinkAdminQuery,
+  IListCampaignTokensLinkAdminResponse,
+  ILinkOrigin,
+  IPaginateLinkAdminQuery,
+  IPaginateLinkAdminResponse,
+  IRecordCampaignViewLinkAdminBody,
+  IRecordCampaignViewLinkAdminResponse,
+  ISetProtectionLinkAdminBody,
+  ISetProtectionLinkAdminParams,
+  ISetProtectionLinkAdminResponse,
+  IUpdateLinkAdminBody,
+  IUpdateLinkAdminParams,
+  IUpdateLinkAdminResponse,
+} from '..';
+
+export const paginateLinkAdmin = async (
+  query: IPaginateLinkAdminQuery,
+): Promise<IPaginateLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IPaginateLinkAdminResponse>(`admin/link/paginate`, {
+      params: query,
+    })
+  ).data;
+};
+
+export const getLinkAdmin = async (params: IGetLinkAdminParams): Promise<IGetLinkAdminResponse> => {
+  return (await AbyssLinkCore.axios.get<IGetLinkAdminResponse>(`admin/link/${params.linkId}`)).data;
+};
+
+export const getVisitsLinkAdmin = async (
+  params: IGetVisitsLinkAdminParams,
+  query: IGetVisitsLinkAdminQuery = {},
+): Promise<IGetVisitsLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetVisitsLinkAdminResponse>(
+      `admin/link/${params.linkId}/visits`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const getCampaignStatsLinkAdmin = async (
+  params: IGetCampaignStatsLinkAdminParams,
+  query: IGetCampaignStatsLinkAdminQuery,
+): Promise<IGetCampaignStatsLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetCampaignStatsLinkAdminResponse>(
+      `admin/link/${params.linkId}/campaign-stats`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const setProtectionLinkAdmin = async (
+  params: ISetProtectionLinkAdminParams,
+  body: ISetProtectionLinkAdminBody,
+): Promise<ISetProtectionLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.put<ISetProtectionLinkAdminResponse>(
+      `admin/link/${params.linkId}/protection`,
+      body,
+    )
+  ).data;
+};
+
+export const updateLinkAdmin = async (
+  params: IUpdateLinkAdminParams,
+  body: IUpdateLinkAdminBody,
+): Promise<IUpdateLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.put<IUpdateLinkAdminResponse>(`admin/link/${params.linkId}`, body)
+  ).data;
+};
+
+export const deleteLinkAdmin = async (
+  params: IDeleteLinkAdminParams,
+): Promise<IDeleteLinkAdminResponse> => {
+  return (await AbyssLinkCore.axios.delete<IDeleteLinkAdminResponse>(`admin/link/${params.linkId}`))
+    .data;
+};
+
+/**
+ * A RESOURCE address or a campaign token for a product resource, free on Link's lines. A RESOURCE
+ * is one per origin: a second call returns the same link.
+ */
+export const createLinkAdmin = async (
+  body: ICreateLinkAdminBody,
+): Promise<ICreateLinkAdminResponse> => {
+  return (await AbyssLinkCore.axios.post<ICreateLinkAdminResponse>(`admin/link`, body)).data;
+};
+
+/** The RESOURCE address of a product resource; 404 when the product minted none. */
+export const getByOriginLinkAdmin = async (
+  origin: IGetByOriginLinkAdminQuery,
+): Promise<IGetByOriginLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetByOriginLinkAdminResponse>(`admin/link/origin`, {
+      params: origin,
+    })
+  ).data;
+};
+
+/** The statistics of a product resource's RESOURCE address over `range` (30 days by default). */
+export const getStatsByOriginLinkAdmin = async (
+  origin: ILinkOrigin,
+  range: IGetLinkStatsQuery = {},
+): Promise<IGetStatsByOriginLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetStatsByOriginLinkAdminResponse>(`admin/link/origin/stats`, {
+      params: { ...origin, ...range },
+    })
+  ).data;
+};
+
+/** Records a page view attributed to a campaign token; 404 for an unknown token. */
+export const recordCampaignViewLinkAdmin = async (
+  body: IRecordCampaignViewLinkAdminBody,
+): Promise<IRecordCampaignViewLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<IRecordCampaignViewLinkAdminResponse>(
+      `admin/link/campaign-view`,
+      body,
+    )
+  ).data;
+};
+
+/** The campaign tokens of a product resource, oldest first. */
+export const listCampaignTokensLinkAdmin = async (
+  origin: IListCampaignTokensLinkAdminQuery,
+): Promise<IListCampaignTokensLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IListCampaignTokensLinkAdminResponse>(
+      `admin/link/campaign-token`,
+      { params: origin },
+    )
+  ).data;
+};
+
+/** Deletes a campaign token; 404 for any other link. */
+export const deleteCampaignTokenLinkAdmin = async (
+  params: IDeleteCampaignTokenLinkAdminParams,
+): Promise<IDeleteCampaignTokenLinkAdminResponse> => {
+  return (
+    await AbyssLinkCore.axios.delete<IDeleteCampaignTokenLinkAdminResponse>(
+      `admin/link/campaign-token/${params.linkId}`,
+    )
+  ).data;
+};

package/src/api/link.api.ts

@@ -0,0 +1,158 @@
+import {
+  AbyssLinkCore,
+  ICountOrganizationLinkParams,
+  ICountOrganizationLinkQuery,
+  ICountOrganizationLinkResponse,
+  ICreateForOrganizationLinkBody,
+  ICreateForOrganizationLinkParams,
+  ICreateLinkBody,
+  ICreateLinkResponse,
+  IDeleteLinkParams,
+  IDeleteLinkResponse,
+  IGetByOriginLinkQuery,
+  IGetByOriginLinkResponse,
+  IGetLinkParams,
+  IGetLinkResponse,
+  IGetLinkStatsParams,
+  IGetLinkStatsQuery,
+  IGetLinkStatsResponse,
+  IGetLinkVisitsParams,
+  IGetLinkVisitsQuery,
+  IGetLinkVisitsResponse,
+  IGetStatsByOriginLinkQuery,
+  IGetStatsByOriginLinkResponse,
+  IPaginateLinkQuery,
+  IPaginateLinkResponse,
+  IPaginateOrganizationLinkParams,
+  IPaginateOrganizationLinkQuery,
+  IPaginateProjectLinkParams,
+  ITransferLinkBody,
+  ITransferLinkParams,
+  ITransferLinkResponse,
+  IUpdateLinkBody,
+  IUpdateLinkParams,
+  IUpdateLinkResponse,
+} from '..';
+
+/** The caller's own SHORTENED links. */
+export const paginateLink = async (query: IPaginateLinkQuery): Promise<IPaginateLinkResponse> => {
+  return (await AbyssLinkCore.axios.get<IPaginateLinkResponse>(`link/paginate`, { params: query }))
+    .data;
+};
+
+export const paginateProjectLink = async (
+  params: IPaginateProjectLinkParams,
+  query: IPaginateLinkQuery,
+): Promise<IPaginateLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IPaginateLinkResponse>(
+      `link/project/${params.projectId}/paginate`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const paginateOrganizationLink = async (
+  params: IPaginateOrganizationLinkParams,
+  query: IPaginateOrganizationLinkQuery,
+): Promise<IPaginateLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IPaginateLinkResponse>(
+      `link/organization/${params.organizationId}/paginate`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const countOrganizationLink = async (
+  params: ICountOrganizationLinkParams,
+  query: ICountOrganizationLinkQuery = {},
+): Promise<ICountOrganizationLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<ICountOrganizationLinkResponse>(
+      `link/organization/${params.organizationId}/count`,
+      { params: query },
+    )
+  ).data;
+};
+
+export const getLink = async (params: IGetLinkParams): Promise<IGetLinkResponse> => {
+  return (await AbyssLinkCore.axios.get<IGetLinkResponse>(`link/${params.linkId}`)).data;
+};
+
+export const createLink = async (body: ICreateLinkBody): Promise<ICreateLinkResponse> => {
+  return (await AbyssLinkCore.axios.post<ICreateLinkResponse>(`link`, body)).data;
+};
+
+export const createForOrganizationLink = async (
+  params: ICreateForOrganizationLinkParams,
+  body: ICreateForOrganizationLinkBody,
+): Promise<ICreateLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<ICreateLinkResponse>(
+      `link/organization/${params.organizationId}`,
+      body,
+    )
+  ).data;
+};
+
+export const updateLink = async (
+  params: IUpdateLinkParams,
+  body: IUpdateLinkBody,
+): Promise<IUpdateLinkResponse> => {
+  return (await AbyssLinkCore.axios.put<IUpdateLinkResponse>(`link/${params.linkId}`, body)).data;
+};
+
+export const deleteLink = async (params: IDeleteLinkParams): Promise<IDeleteLinkResponse> => {
+  return (await AbyssLinkCore.axios.delete<IDeleteLinkResponse>(`link/${params.linkId}`)).data;
+};
+
+export const transferLink = async (
+  params: ITransferLinkParams,
+  body: ITransferLinkBody,
+): Promise<ITransferLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<ITransferLinkResponse>(`link/${params.linkId}/transfer`, body)
+  ).data;
+};
+
+export const getStatsLink = async (
+  params: IGetLinkStatsParams,
+  query: IGetLinkStatsQuery = {},
+): Promise<IGetLinkStatsResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetLinkStatsResponse>(`link/${params.linkId}/stats`, {
+      params: query,
+    })
+  ).data;
+};
+
+export const getVisitsLink = async (
+  params: IGetLinkVisitsParams,
+  query: IGetLinkVisitsQuery = {},
+): Promise<IGetLinkVisitsResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetLinkVisitsResponse>(`link/${params.linkId}/visits`, {
+      params: query,
+    })
+  ).data;
+};
+
+/** The RESOURCE address of a product resource, from EDIT on the resource. */
+export const getByOriginLink = async (
+  query: IGetByOriginLinkQuery,
+): Promise<IGetByOriginLinkResponse> => {
+  return (await AbyssLinkCore.axios.get<IGetByOriginLinkResponse>(`link/origin`, { params: query }))
+    .data;
+};
+
+/** The statistics of a product resource's RESOURCE address, from EDIT on the resource. */
+export const getStatsByOriginLink = async (
+  query: IGetStatsByOriginLinkQuery,
+): Promise<IGetStatsByOriginLinkResponse> => {
+  return (
+    await AbyssLinkCore.axios.get<IGetStatsByOriginLinkResponse>(`link/origin/stats`, {
+      params: query,
+    })
+  ).data;
+};

package/src/api/link.public.api.ts

@@ -0,0 +1,19 @@
+import {
+  AbyssLinkCore,
+  IUnlockLinkPublicBody,
+  IUnlockLinkPublicParams,
+  IUnlockLinkPublicResponse,
+} from '..';
+
+/** Unlocks a shortened link protected by a password: the right password answers its destination. */
+export const unlockLinkPublic = async ({
+  slug,
+  ...body
+}: IUnlockLinkPublicParams & IUnlockLinkPublicBody): Promise<IUnlockLinkPublicResponse> => {
+  return (
+    await AbyssLinkCore.axios.post<IUnlockLinkPublicResponse>(
+      `link/public/${encodeURIComponent(slug)}/unlock`,
+      body,
+    )
+  ).data;
+};

package/src/constants/index.ts

@@ -0,0 +1 @@
+export * from './link.constants';

package/src/constants/link.constants.ts

@@ -0,0 +1,66 @@
+import { LinkResourceProduct } from '../types/enum/link.enum';
+
+/** Products that own a RESOURCE address. Spotlight only receives campaign tokens, which have no Link address. */
+export type LinkPrefixedProduct = Exclude<LinkResourceProduct, LinkResourceProduct.SPOTLIGHT>;
+
+/** First segment of a RESOURCE address, `<host>/<prefix>/<code>` (spec §3.5). Compared in lowercase (R10). */
+export const LINK_RESOURCE_PREFIXES: Readonly<Record<LinkPrefixedProduct, string>> = {
+  [LinkResourceProduct.BEAM]: 'b',
+  [LinkResourceProduct.ATLAS]: 'a',
+  [LinkResourceProduct.DRAW]: 'd',
+  [LinkResourceProduct.RETROSPECTIVE]: 'r',
+  [LinkResourceProduct.FORM]: 'f',
+  [LinkResourceProduct.EXTRACT]: 'e',
+  [LinkResourceProduct.CLOUD]: 'c',
+  [LinkResourceProduct.MEMORIES]: 'm',
+};
+
+/** A SHORTENED slug starting with one of these (lowercase) is refused. */
+export const LINK_FORBIDDEN_SLUG_PREFIXES: readonly string[] = ['_', 'abyss'];
+
+/** SHORTENED slugs refused at manual creation, in lowercase: every resource prefix and the host's own paths. */
+export const LINK_FORBIDDEN_SLUGS: readonly string[] = [
+  ...Object.values(LINK_RESOURCE_PREFIXES),
+  'api',
+  'assets',
+  'static',
+  'health',
+  'admin',
+  'login',
+  'favicon.ico',
+  'robots.txt',
+  '.well-known',
+];
+
+export const MIN_LINK_SLUG_LENGTH = 3;
+export const MAX_LINK_SLUG_LENGTH = 50;
+export const LINK_SLUG_PATTERN = /^[a-zA-Z0-9_-]{3,50}$/;
+
+export const MIN_LINK_PASSWORD_LENGTH = 4;
+export const MAX_LINK_PASSWORD_LENGTH = 128;
+
+/** Base62 code of a RESOURCE address, compared exactly (R10). */
+export const LINK_RESOURCE_CODE_LENGTH = 10;
+/** Base62 campaign token. */
+export const LINK_CAMPAIGN_TOKEN_LENGTH = 12;
+/** Campaign tokens a product resource (a Spotlight project) holds at most (O5). */
+export const LINK_CAMPAIGN_TOKENS_PER_PROJECT = 50;
+/** The query parameter carrying a campaign token on the product's page: `?lnk=<token>`. */
+export const CAMPAIGN_TOKEN_QUERY_PARAM = 'lnk';
+
+/** Raw visits are kept this long (O2); daily aggregates live as long as the link. */
+export const LINK_VISIT_RETENTION_DAYS = 90;
+
+/** Schemes a link may target. */
+export const LINK_ALLOWED_URL_SCHEMES = ['http', 'https'] as const;
+/** Length of the slug drawn when a SHORTENED link is created without one. */
+export const LINK_GENERATED_SLUG_LENGTH = 6;
+export const MAX_LINK_TARGET_URL_LENGTH = 2048;
+export const MAX_LINK_TITLE_LENGTH = 255;
+export const MAX_LINK_DESCRIPTION_LENGTH = 1000;
+export const MIN_LINK_MAX_CLICKS = 1;
+
+export const MIN_LINK_PAGE = 1;
+export const MIN_LINK_LIMIT = 1;
+export const MAX_LINK_LIMIT = 100;
+export const DEFAULT_LINK_LIMIT = 20;

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