@focusbc/bbs-lib 0.0.11 → 0.0.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@focusbc/bbs-lib",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "BBS map rendering library (deck.gl + @focusbc/map-rendering)",
   "type": "module",
   "main": "./dist/index.js",

package/readme.md

@@ -49,214 +49,3 @@ overlay.rightClick().subscribe(({ shape, lat, lng }) => {
 
 overlay.setContext(newContext)
 ```
-
----
-
-## Development
-
-Install dependencies and build from the `bbs-lib/` directory:
-
-```bash
-yarn install
-yarn build
-```
-
-From the repository root:
-
-```bash
-yarn bbs-lib build
-```
-
-`yarn build` produces two outputs under `dist/`:
-
-| Output | Used by |
-|--------|---------|
-| `dist/index.js` (+ types) | npm consumers (`import '@focusbc/bbs-lib'`) |
-| `dist/browser/bbs-lib.js` | Browser `import()` — uploaded to Cloud Storage and served by the Integration API |
-
-Only `dist/**/*` and this README are published to npm. The `demo/` and `sandbox/` folders are not included in the npm package.
-
----
-
-## Local testing
-
-### Sandbox (library development)
-
-The `sandbox/` folder bundles the **local library source** and is meant for day-to-day development.
-
-1. Copy `sandbox/config.example.ts` to `sandbox/config.ts` and set `INTEGRATION_API_BASE` and `BBS_API_KEY`.
-2. Start the Integration API locally.
-3. Build and serve:
-
-```bash
-yarn sandbox:build
-npx --yes serve sandbox -p 5173
-# or: yarn sandbox:watch  (rebuild on save)
-```
-
-### Client demo
-
-The client-facing reference lives in [`demo/`](demo/). It loads the pre-built browser bundle from the deployed Integration API — no local library build. See [`demo/README.md`](demo/README.md).
-
-```bash
-yarn demo:serve   # http://localhost:5174
-```
-
----
-
-## How the library is delivered
-
-There are **two separate publish paths**. They share the same source but target different consumers:
-
-```txt
-yarn build
-  ├── dist/index.js          →  npm publish  →  apps using a bundler
-  └── dist/browser/bbs-lib.js  →  gcloud upload  →  GCS bucket  →  Integration API /bbs-lib/*
-                                                      ↑
-                                              config/environments.sh
-```
-
-| Path | Command | Destination | Who uses it |
-|------|---------|-------------|-------------|
-| **npm package** | `yarn release:lib` (includes `npm publish`) | [npm registry](https://www.npmjs.com/package/@focusbc/bbs-lib) | Teams importing the library in their own build |
-| **Browser bundle** | `yarn upload:browser` (or part of `release:lib`) | Cloud Storage bucket for staging or production | The [`demo/`](demo/) and any client doing `import(url)` without a bundler |
-
-The browser bundle is **not** loaded from Cloud Storage directly. The Integration API exposes it anonymously at `/bbs-lib/latest/bbs-lib.js` and reads from the bucket configured in its own deployment (`integration-api/appsettings.*.json`).
-
----
-
-## Upload environments — `config/environments.sh`
-
-This file is the **single place to define where the browser bundle is uploaded**. It is used by:
-
-- `scripts/upload-browser-bundle.sh` (`yarn upload:browser`)
-- `scripts/release-lib.sh` (`yarn release:lib`)
-
-It does **not** affect:
-
-- The npm registry
-- The client [`demo/`](demo/) configuration (that lives in `demo/index.html`)
-- Which bucket the Integration API reads from at runtime (that is `Storage.BucketName` in `integration-api/appsettings.<Environment>.json`)
-
-### What it contains
-
-```bash
-BBS_LIB_DEFAULT_ENVIRONMENT=staging          # used when BBS_LIB_ENVIRONMENT is not set
-
-BBS_LIB_STAGING_BUCKET=vv-tenant-uefa-transition-stg
-BBS_LIB_PRODUCTION_BUCKET=vv-tenant-uefa-prd
-```
-
-The bucket names **must match** `Storage.BucketName` in the corresponding Integration API appsettings file. If they diverge, uploads will succeed but the API will serve stale or missing files.
-
-### Choosing staging vs production
-
-By default, all uploads go to **staging**:
-
-```bash
-yarn upload:browser          # → gs://vv-tenant-uefa-transition-stg/bbs-lib/...
-yarn release:lib             # → npm + staging bucket
-```
-
-To target **production**:
-
-```bash
-BBS_LIB_ENVIRONMENT=production yarn upload:browser
-BBS_LIB_ENVIRONMENT=production yarn release:lib
-```
-
-Each command uploads to **one** environment only. There is no automatic dual upload.
-
-### Where files land in the bucket
-
-After upload, objects are written to:
-
-```txt
-gs://<bucket>/bbs-lib/latest/bbs-lib.js              ← demo loads this via the API
-gs://<bucket>/bbs-lib/latest/bbs-lib.js.map
-gs://<bucket>/bbs-lib/versions/<package-version>/bbs-lib.js
-gs://<bucket>/bbs-lib/versions/<package-version>/bbs-lib.js.map
-```
-
-### Advanced overrides
-
-These take precedence over `BBS_LIB_ENVIRONMENT` (rarely needed):
-
-```bash
-BBS_LIB_BUCKET=vv-tenant-uefa-prd yarn upload:browser
-BBS_LIB_BUCKET_URI=gs://vv-tenant-uefa-prd/bbs-lib yarn upload:browser
-```
-
-If a previous release exported `BBS_LIB_BUCKET_URI` in your shell, run `unset BBS_LIB_BUCKET_URI` before uploading, or pass the target explicitly.
-
----
-
-## Releasing
-
-### Prerequisites
-
-1. Access to publish `@focusbc/bbs-lib` under the `@focusbc` npm scope.
-2. [Google Cloud CLI](https://cloud.google.com/sdk) installed and authenticated (`gcloud auth login`).
-3. Permission to decrypt/encrypt with the KMS key used by `auxiliary/scripts/decrypt_file.sh`.
-4. `bbs-lib/.npmrc.enc` present (encrypted npm token — the only credential file committed to the repo).
-
-### Full release — `yarn release:lib`
-
-Runs `scripts/release-lib.sh`. From `bbs-lib/`:
-
-```bash
-yarn release:lib          # patch bump (default): 0.0.5 → 0.0.6
-yarn release:lib minor    # minor bump
-yarn release:lib major    # major bump
-```
-
-From the repository root: `yarn release:bbs-lib`
-
-**What the script does, in order:**
-
-1. Decrypts `bbs-lib/.npmrc.enc` into a temporary `.npmrc`.
-2. Bumps the version in `package.json` (`--no-git-tag-version`).
-3. Runs `yarn build` (TypeScript + browser bundle).
-4. Publishes to npm (`npm publish --access public`).
-5. Uploads `dist/browser/bbs-lib.js` to the bucket defined in [`config/environments.sh`](config/environments.sh) (staging by default).
-6. Re-encrypts and removes the temporary `.npmrc`.
-
-If the script fails **after** the version bump, check `package.json` before retrying — the version may already have been incremented locally.
-
-### Upload browser bundle only — `yarn upload:browser`
-
-Use this when you need to refresh the hosted JS **without** publishing a new npm version:
-
-```bash
-yarn build
-yarn upload:browser
-```
-
-Same environment selection as above (`BBS_LIB_ENVIRONMENT=production` for production).
-
-### Recommended workflow
-
-```txt
-1. Develop and test locally     →  sandbox/
-2. Full release to staging      →  yarn release:lib
-3. Verify the client demo       →  yarn demo:serve  (demo points at staging API)
-4. Promote bundle to production →  BBS_LIB_ENVIRONMENT=production yarn upload:browser
-                                   (or yarn release:lib if you also need a new npm version)
-5. Deploy Integration API       →  only if API code changed (e.g. /bbs-lib endpoint)
-```
-
-Steps 2 and 4 upload to Cloud Storage. Step 5 is only needed when the Integration API itself changed — the demo loads the bundle through the already-deployed API.
-
----
-
-## Folder reference
-
-| Path | Purpose |
-|------|---------|
-| `src/` | Library source |
-| `dist/` | Build output (npm + browser bundle) |
-| `demo/` | Client-facing static demo — see [`demo/README.md`](demo/README.md) |
-| `sandbox/` | Internal dev page bundling local source |
-| [`config/environments.sh`](config/environments.sh) | Browser bundle upload targets (staging / production buckets) |
-| `scripts/release-lib.sh` | Full release pipeline |
-| `scripts/upload-browser-bundle.sh` | Browser bundle upload only |