xpt-shared-types 1.13.0 → 1.15.0

package/README.md

@@ -110,11 +110,19 @@ edits are picked up after `yarn build` with no publish step.
 
 `prepublishOnly` runs `yarn build`, so `dist/` cannot go stale.
 
+Publishing runs in GitHub Actions ([`.github/workflows/publish.yml`](.github/workflows/publish.yml))
+using npm trusted publishing, so no npm token or 2FA prompt is involved.
+
 1. `yarn sync` and commit, if schemas changed
-2. `npm login`
-3. `yarn version --patch`
-4. `npm publish`
-5. `git push --follow-tags`
+2. `yarn version --patch` (or `--minor`), which commits and tags `vX.Y.Z`
+3. `git push --follow-tags`
+
+The workflow fires on the `v*` tag, refuses to run if the tag and
+`package.json` version disagree, then builds and publishes.
+
+The trusted publisher on npmjs.com is linked to user `otemu`, repository
+`xpt-shared-types`, workflow `publish.yml`, no environment. Renaming the
+workflow file breaks publishing until that link is recreated.
 
 ## License
 

package/dist/manual/notification.d.ts

@@ -12,7 +12,7 @@
  * on the server and a glyph on the client — the `Record`s below fail to
  * compile until the group is chosen.
  */
-export declare const NOTIFICATION_TYPES: readonly ["match_ready", "match_result", "match_dispute", "tournament_registered", "tournament_status", "tournament_eliminated", "tournament_placement", "tournament_withdrawn", "tournament_roster", "tournament_join_request", "tournament_join_approved", "tournament_join_declined", "tournament_join_expired", "team_invite", "team_kicked", "team_captaincy", "team_joined", "friend_request", "friend_request_accepted", "xp_earned", "wallet_credit", "wallet_debit"];
+export declare const NOTIFICATION_TYPES: readonly ["match_ready", "match_result", "match_dispute", "tournament_registered", "tournament_status", "tournament_eliminated", "tournament_placement", "tournament_withdrawn", "tournament_roster", "tournament_join_request", "tournament_join_approved", "tournament_join_declined", "tournament_join_expired", "tournament_announcement", "team_invite", "team_kicked", "team_captaincy", "team_joined", "friend_request", "friend_request_accepted", "xp_earned", "wallet_credit", "wallet_debit"];
 export type NotificationType = (typeof NOTIFICATION_TYPES)[number];
 /** The in-app toggles on the notification settings page, one per group. */
 export declare const NOTIFICATION_GROUPS: readonly ["matchAlerts", "tournamentUpdates", "teamSocial", "accountRewards"];

package/dist/manual/notification.js

@@ -31,6 +31,8 @@ exports.NOTIFICATION_TYPES = [
     'tournament_join_approved',
     'tournament_join_declined',
     'tournament_join_expired',
+    // a free-text message from the XPT team to every entrant of a tournament
+    'tournament_announcement',
     // teamSocial
     'team_invite',
     'team_kicked',
@@ -69,6 +71,7 @@ exports.NOTIFICATION_TYPE_GROUP = {
     tournament_join_approved: 'tournamentUpdates',
     tournament_join_declined: 'tournamentUpdates',
     tournament_join_expired: 'tournamentUpdates',
+    tournament_announcement: 'tournamentUpdates',
     team_invite: 'teamSocial',
     team_kicked: 'teamSocial',
     team_captaincy: 'teamSocial',

package/package.json

@@ -1,26 +1,26 @@
-{
-  "name": "xpt-shared-types",
-  "version": "1.13.0",
-  "description": "Shared types and data for XPT projects",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist",
-    "src",
-    "scripts"
-  ],
-  "scripts": {
-    "sync": "node scripts/sync-from-strapi.js",
-    "build": "tsc",
-    "prepublishOnly": "yarn build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/otemu/xpt-shared-types"
-  },
-  "author": "",
-  "license": "MIT",
-  "devDependencies": {
-    "typescript": "^5.0.0"
-  }
-}
+{
+  "name": "xpt-shared-types",
+  "version": "1.15.0",
+  "description": "Shared types and data for XPT projects",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "src",
+    "scripts"
+  ],
+  "scripts": {
+    "sync": "node scripts/sync-from-strapi.js",
+    "build": "tsc",
+    "prepublishOnly": "yarn build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/otemu/xpt-shared-types"
+  },
+  "author": "",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

package/scripts/overlay-local.mjs

@@ -0,0 +1,32 @@
+/**
+ * Copies this package (package.json + dist) over the consumers' installed copy,
+ * so both apps see an unpublished build. This is what has been done by hand
+ * for every local iteration; a plain `yarn install` in either app reverts it.
+ *
+ *   yarn build && node scripts/overlay-local.mjs
+ */
+import { cpSync, existsSync, rmSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const here = dirname(fileURLToPath(import.meta.url));
+const root = resolve(here, '..');
+const consumers = ['xpt-strapi', 'xpt-client'].map((name) =>
+  resolve(root, '..', name, 'node_modules', 'xpt-shared-types')
+);
+
+if (!existsSync(join(root, 'dist', 'index.js'))) {
+  console.error('dist/ is missing - run `yarn build` first');
+  process.exit(1);
+}
+
+for (const target of consumers) {
+  if (!existsSync(dirname(target))) {
+    console.warn(`skip ${target} (no node_modules)`);
+    continue;
+  }
+  rmSync(join(target, 'dist'), { recursive: true, force: true });
+  cpSync(join(root, 'dist'), join(target, 'dist'), { recursive: true });
+  cpSync(join(root, 'package.json'), join(target, 'package.json'));
+  console.log(`overlaid ${target}`);
+}

package/src/index.ts

@@ -1,23 +1,23 @@
-// Generated from the Strapi schemas — see scripts/sync-from-strapi.js
-export * from './generated';
-
-// Hand-written contract primitives (response envelopes, Populated, media)
-export * from './contracts';
-
-// Hand-written types with no Strapi content type behind them
-export * from './manual';
-
-// Bracket shape — shared by the backend generator and Storybook fixtures
-export * from './bracket';
-
-// Game/platform/account catalogue — the game -> platform -> account chain,
-// applied identically by the backend resolver and the client's pickers
-export * from './gameCatalogue';
-
-// Stream links — one pasted URL parsed the same way by the backend that stores
-// the derived columns and the client that embeds the player
-export * from './stream';
-
-// Data
-export * from './data/countriesList';
-export * from './data/gameGenres';
+// Generated from the Strapi schemas — see scripts/sync-from-strapi.js
+export * from './generated';
+
+// Hand-written contract primitives (response envelopes, Populated, media)
+export * from './contracts';
+
+// Hand-written types with no Strapi content type behind them
+export * from './manual';
+
+// Bracket shape — shared by the backend generator and Storybook fixtures
+export * from './bracket';
+
+// Game/platform/account catalogue — the game -> platform -> account chain,
+// applied identically by the backend resolver and the client's pickers
+export * from './gameCatalogue';
+
+// Stream links — one pasted URL parsed the same way by the backend that stores
+// the derived columns and the client that embeds the player
+export * from './stream';
+
+// Data
+export * from './data/countriesList';
+export * from './data/gameGenres';

package/src/manual/country.ts

@@ -1,6 +1,6 @@
-export interface Country {
-  countryName: string;
-  alpha2: string;
-  alpha3: string;
-  numeric: string;
-}
+export interface Country {
+  countryName: string;
+  alpha2: string;
+  alpha3: string;
+  numeric: string;
+}

package/src/manual/notification.ts

@@ -29,6 +29,8 @@ export const NOTIFICATION_TYPES = [
   'tournament_join_approved',
   'tournament_join_declined',
   'tournament_join_expired',
+  // a free-text message from the XPT team to every entrant of a tournament
+  'tournament_announcement',
   // teamSocial
   'team_invite',
   'team_kicked',
@@ -77,6 +79,7 @@ export const NOTIFICATION_TYPE_GROUP: Record<
     tournament_join_approved: 'tournamentUpdates',
     tournament_join_declined: 'tournamentUpdates',
     tournament_join_expired: 'tournamentUpdates',
+    tournament_announcement: 'tournamentUpdates',
     team_invite: 'teamSocial',
     team_kicked: 'teamSocial',
     team_captaincy: 'teamSocial',

package/scripts/sync-from-strapi.js

@@ -1,281 +0,0 @@
-/* eslint-disable no-console */
-/**
- * Generates the shared API contract from the Strapi content-type schemas.
- *
- * `schema.json` is the source of truth — not `types/generated/contentTypes.d.ts`,
- * which is gitignored in xpt-strapi and only exists after `strapi develop` has run.
- *
- *   node scripts/sync-from-strapi.js [pathToStrapiRepo]
- *
- * Output is committed to this repo; run this whenever a content type changes.
- */
-const fs = require('fs');
-const path = require('path');
-
-const STRAPI_ROOT =
-  process.argv[2] ||
-  process.env.XPT_STRAPI_PATH ||
-  path.resolve(__dirname, '../../xpt-strapi');
-const OUT = path.resolve(__dirname, '../src/generated');
-
-const BANNER = [
-  '// AUTO-GENERATED by scripts/sync-from-strapi.js — DO NOT EDIT MANUALLY.',
-  '// Source: xpt-strapi/src/**/content-types/**/schema.json',
-  '// Regenerate with: yarn sync',
-  '',
-].join('\n');
-
-// ── helpers ────────────────────────────────────────────────────────────────
-/** Quote a property name only when it is not a bare identifier. */
-const prop = (name) =>
-  /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name) ? name : JSON.stringify(name);
-
-const pascal = (s) =>
-  String(s)
-    .replace(/[_-]+([a-zA-Z0-9])/g, (_, c) => c.toUpperCase())
-    .replace(/^([a-z])/, (_, c) => c.toUpperCase())
-    .replace(/[^A-Za-z0-9]/g, '');
-
-/** api::tournament-participant.tournament-participant -> TournamentParticipant */
-function modelNameFromUid(uid) {
-  if (uid === 'plugin::users-permissions.user') return 'User';
-  if (uid === 'plugin::users-permissions.role') return 'UserRole';
-  if (uid === 'plugin::upload.file') return 'StrapiMedia';
-  const m = /^api::[^.]+\.(.+)$/.exec(uid);
-  return m ? pascal(m[1]) : null;
-}
-
-const SCALARS = {
-  string: 'string',
-  text: 'string',
-  richtext: 'string',
-  uid: 'string',
-  email: 'string',
-  password: 'string',
-  datetime: 'string',
-  date: 'string',
-  time: 'string',
-  biginteger: 'string', // Strapi serialises bigint as string
-  integer: 'number',
-  float: 'number',
-  decimal: 'number',
-  boolean: 'boolean',
-  json: 'unknown',
-  blocks: 'BlocksContent',
-};
-
-// ── collect schemas ────────────────────────────────────────────────────────
-function findSchemas(root) {
-  const out = [];
-  const roots = [
-    path.join(root, 'src', 'api'),
-    path.join(root, 'src', 'extensions'),
-  ];
-  for (const base of roots) {
-    if (!fs.existsSync(base)) continue;
-    for (const dir of fs.readdirSync(base)) {
-      const ctDir = path.join(base, dir, 'content-types');
-      if (!fs.existsSync(ctDir)) continue;
-      for (const ct of fs.readdirSync(ctDir)) {
-        const file = path.join(ctDir, ct, 'schema.json');
-        if (fs.existsSync(file)) out.push(file);
-      }
-    }
-  }
-  return out.sort();
-}
-
-const files = findSchemas(STRAPI_ROOT);
-if (!files.length) {
-  console.error(
-    'No schema.json found under ' +
-      STRAPI_ROOT +
-      '. Pass the xpt-strapi path as an argument.'
-  );
-  process.exit(1);
-}
-
-const collected = [];
-for (const file of files) {
-  const raw = JSON.parse(fs.readFileSync(file, 'utf8'));
-  const info = raw.info || {};
-  const singular = info.singularName || path.basename(path.dirname(file));
-  // The users-permissions extension augments the plugin's own user model.
-  const isUserExt = file.split(path.sep).includes('users-permissions');
-  collected.push({
-    name: isUserExt ? 'User' : pascal(singular),
-    singular: isUserExt ? 'user' : singular,
-    attributes: raw.attributes || {},
-  });
-}
-
-// Merge any model declared more than once (e.g. the user extension).
-const byName = new Map();
-for (const m of collected) {
-  if (byName.has(m.name)) {
-    Object.assign(byName.get(m.name).attributes, m.attributes);
-  } else {
-    byName.set(m.name, m);
-  }
-}
-const allModels = [...byName.values()].sort((a, b) =>
-  a.name.localeCompare(b.name)
-);
-
-// ── enums ──────────────────────────────────────────────────────────────────
-const enums = [];
-for (const m of allModels) {
-  for (const [field, def] of Object.entries(m.attributes)) {
-    if (def.type !== 'enumeration' || !Array.isArray(def.enum)) continue;
-    enums.push({
-      name: m.name + pascal(field),
-      values: def.enum,
-      model: m.name,
-      field,
-    });
-  }
-}
-enums.sort((a, b) => a.name.localeCompare(b.name));
-
-let enumsOut = BANNER + '\n';
-for (const e of enums) {
-  enumsOut +=
-    '/** `' +
-    e.model +
-    '.' +
-    e.field +
-    '` */\nexport type ' +
-    e.name +
-    ' =\n' +
-    e.values.map((v) => '  | ' + JSON.stringify(v)).join('\n') +
-    ';\n\n';
-}
-enumsOut +=
-  '/** Readability alias for `tournament.currentStatus`. */\n' +
-  'export type TournamentStatus = TournamentCurrentStatus;\n';
-
-// ── models (read shapes) ───────────────────────────────────────────────────
-const enumLookup = new Map(enums.map((e) => [e.model + '.' + e.field, e.name]));
-const usedEnums = new Set();
-
-function readTypeFor(model, field, def) {
-  if (def.type === 'enumeration') {
-    return enumLookup.get(model.name + '.' + field) || 'string';
-  }
-  if (def.type === 'media') {
-    return def.multiple ? 'StrapiMedia[]' : 'StrapiMedia';
-  }
-  if (def.type === 'relation') {
-    const target = modelNameFromUid(def.target);
-    if (!target) return 'unknown';
-    const many =
-      def.relation === 'oneToMany' || def.relation === 'manyToMany';
-    return many ? target + '[]' : target;
-  }
-  return SCALARS[def.type] || 'unknown';
-}
-
-let modelsBody = '';
-for (const m of allModels) {
-  const lines = [];
-  for (const [field, def] of Object.entries(m.attributes)) {
-    // `private` attributes are never returned by the content API.
-    if (def.private) continue;
-    const t = readTypeFor(m, field, def);
-    if (def.type === 'enumeration') usedEnums.add(t);
-    // Everything except id/documentId is optional, because nothing else is
-    // guaranteed on the wire:
-    //   - relations and media appear only when the query populates them;
-    //   - any scalar disappears when the query uses `fields`, which this
-    //     codebase does pervasively — so even a schema-`required` field like
-    //     user.email is absent from most responses.
-    // The base model is therefore the minimum guarantee; use `Populated<T, K>`
-    // at a call site to record what that particular query actually returned.
-    // Strapi also sends `null` rather than omitting an unset nullable value,
-    // so single-valued optionals are `?: T | null`. Lists come back as `[]`.
-    const isList = t.endsWith('[]');
-    const rendered = isList ? t : t + ' | null';
-    lines.push('  ' + prop(field) + '?: ' + rendered + ';');
-  }
-  modelsBody +=
-    '/** `' +
-    m.singular +
-    '` */\nexport interface ' +
-    m.name +
-    ' extends StrapiDocument {\n' +
-    lines.join('\n') +
-    '\n}\n\n';
-}
-
-const enumImportList = [...usedEnums]
-  .filter((e) => !e.endsWith('[]'))
-  .sort()
-  .map((e) => '  ' + e + ',')
-  .join('\n');
-
-const modelsOut =
-  BANNER +
-  "\nimport type {\n  BlocksContent,\n  StrapiDocument,\n  StrapiMedia,\n  UserRole,\n} from '../contracts';\n" +
-  (enumImportList ? 'import type {\n' + enumImportList + "\n} from './enums';\n" : '') +
-  '\n' +
-  modelsBody;
-
-// ── inputs (write shapes) ──────────────────────────────────────────────────
-// Write payloads differ structurally from read shapes: relations are sent as
-// documentIds or connect/set/disconnect, media as numeric file ids.
-let inputsBody = '';
-for (const m of allModels) {
-  const lines = [];
-  for (const [field, def] of Object.entries(m.attributes)) {
-    if (def.private) continue;
-    let t;
-    if (def.type === 'relation') {
-      const many =
-        def.relation === 'oneToMany' || def.relation === 'manyToMany';
-      t = many ? 'RelationInput | RelationInput[]' : 'RelationInput';
-    } else if (def.type === 'media') {
-      t = def.multiple ? 'MediaInput[]' : 'MediaInput';
-    } else if (def.type === 'enumeration') {
-      t = enumLookup.get(m.name + '.' + field) || 'string';
-    } else {
-      t = SCALARS[def.type] || 'unknown';
-    }
-    lines.push('  ' + prop(field) + '?: ' + t + ';');
-  }
-  inputsBody +=
-    '/** Write payload for `' +
-    m.singular +
-    '`. */\nexport interface ' +
-    m.name +
-    'Input {\n' +
-    lines.join('\n') +
-    '\n}\n\n';
-}
-
-const inputsOut =
-  BANNER +
-  "\nimport type {\n  BlocksContent,\n  MediaInput,\n  RelationInput,\n} from '../contracts';\n" +
-  (enumImportList ? 'import type {\n' + enumImportList + "\n} from './enums';\n" : '') +
-  '\n' +
-  inputsBody;
-
-// ── write ──────────────────────────────────────────────────────────────────
-fs.mkdirSync(OUT, { recursive: true });
-fs.writeFileSync(path.join(OUT, 'enums.ts'), enumsOut);
-fs.writeFileSync(path.join(OUT, 'models.ts'), modelsOut);
-fs.writeFileSync(path.join(OUT, 'inputs.ts'), inputsOut);
-fs.writeFileSync(
-  path.join(OUT, 'index.ts'),
-  BANNER +
-    "\nexport * from './enums';\nexport * from './models';\nexport * from './inputs';\n"
-);
-
-console.log(
-  'Generated ' +
-    allModels.length +
-    ' models and ' +
-    enums.length +
-    ' enums from ' +
-    files.length +
-    ' schemas.'
-);