[P.B extension] Publish fw-lite-extension types to npm as fw-lite-extension-types

platform.bible-extension/.eslintignore

@@ -1,3 +1,6 @@
+# Types publishing
+release-types
+
 # #region shared with https://github.com/paranext/paranext-multi-extension-template/blob/main/.eslintignore
 
 # Please keep this file in sync with .prettierignore and .stylelintignore

platform.bible-extension/.eslintrc.js

@@ -137,7 +137,7 @@ module.exports = {
       },
     },
     {
-      files: ['./lib/*', './webpack/*'],
+      files: ['./lib/*', './scripts/*', './webpack/*'],
       rules: {
         // These files are scripts not running in Platform.Bible, so they can't use the logger
         'no-console': 'off',

platform.bible-extension/README.md

@@ -152,6 +152,43 @@ To build the extension once:
 
 `npm run build`
 
+## Publishing the types package to npm
+
+The `fw-lite-extension-types` npm package exposes the TypeScript types from `src/types/fw-lite-extension.d.ts` so that other Platform.Bible extensions can consume the `EntryService` network object and other public types from this extension.
+
+### Prerequisites
+
+Set the `NPM_TOKEN` environment variable to a valid npm access token that has publish rights to the `fw-lite-extension-types` package:
+
+```bash
+export NPM_TOKEN=<your-npm-token>
+```
+
+The token is read from `release-types/.npmrc` and is never stored in source control.
+
+### Bump the types package version
+
+Run the following from the `platform.bible-extension` directory, replacing `<version>` with the desired semver version (e.g. `patch`, `minor`, `major`, or a full version string like `1.0.0`):
+
+```bash
+npm run types:bump -- <version>
+```
+
+This updates the `version` field in `release-types/package.json`. Commit the updated `release-types/package.json` and open a PR.
+
+### Publish the types package
+
+Once the version bump is merged, publish from the `platform.bible-extension` directory:
+
+```bash
+npm run types:publish
+```
+
+This command:
+
+1. Copies `src/types/fw-lite-extension.d.ts` and `src/types/enums.ts` into `release-types/` (`types:sync`)
+2. Publishes the `release-types/` directory to the npm registry as `fw-lite-extension-types`
+
 <!--
 ## To package for distribution
 

platform.bible-extension/package.json

@@ -29,7 +29,10 @@
     "core:stop": "npm --prefix ../../paranext-core stop",
     "core:install": "npm --prefix ../../paranext-core install",
     "core:pull": "git -C ../../paranext-core pull --ff-only",
-    "core:update": "npm run core:pull && npm run core:install"
+    "core:update": "npm run core:pull && npm run core:install",
+    "types:sync": "node scripts/sync-types.js",
+    "types:bump": "cd ./release-types && npm version --no-git-tag-version",
+    "types:publish": "npm run types:sync && npm publish ./release-types"
   },
   "browserslist": [],
   "peerDependencies": {

platform.bible-extension/release-types/.gitignore

@@ -0,0 +1,3 @@
+# Synced from src/types/ by `npm run types:sync` — do not edit directly
+fw-lite-extension.d.ts
+enums.ts

platform.bible-extension/release-types/.npmrc

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${NPM_TOKEN}

platform.bible-extension/release-types/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "fw-lite-extension-types",
+  "version": "0.0.1",
+  "description": "TypeScript types for the fw-lite-extension Platform.Bible extension",
+  "author": "SIL Global",
+  "license": "MIT",
+  "types": "fw-lite-extension.d.ts",
+  "files": [
+    "fw-lite-extension.d.ts",
+    "enums.ts"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}

platform.bible-extension/scripts/sync-types.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+// Copies the types files from src/types/ into release-types/ ready for publishing.
+const fs = require('fs');
+const path = require('path');
+
+const srcDir = path.join(__dirname, '..', 'src', 'types');
+const destDir = path.join(__dirname, '..', 'release-types');
+const files = ['fw-lite-extension.d.ts', 'enums.ts'];
+
+files.forEach((file) => {
+  const src = path.join(srcDir, file);
+  const dest = path.join(destDir, file);
+  fs.copyFileSync(src, dest);
+  console.log(`Copied ${file} → release-types/${file}`);
+});

platform.bible-extension/tsconfig.lint.json

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig",
-  "include": [".eslintrc.js", "*.ts", "*.js", "lib", "src", "webpack"]
+  "include": [".eslintrc.js", "*.ts", "*.js", "lib", "scripts", "src", "webpack"]
 }