@favish/staffbase-utils 0.1.0 → 0.1.1

package/README.md

@@ -3,19 +3,77 @@
 Shared internal/host utilities for Staffbase widgets. Tree-shakeable subpath
 modules; import only what you use.
 
+## Install
+
+```bash
+pnpm add @favish/staffbase-utils
+```
+
+Widgets that enforce a `minimumReleaseAge` supply-chain cooldown should exempt the
+`@favish/*` scope so freshly published versions install immediately. In the
+widget's `pnpm-workspace.yaml`:
+
+```yaml
+minimumReleaseAge: 1440
+minimumReleaseAgeExclude:
+  - '@favish/*'
+```
+
 ## Modules
 
-- `@favish/staffbase-utils/log` — `logError`, `logWarn`, `logDebug`, `setLoggingEnabled`
+| Subpath | Exports |
+| --- | --- |
+| `@favish/staffbase-utils/log` | `logError`, `logWarn`, `logDebug`, `setLoggingEnabled` |
+
+More modules (`/env`, `/device`, `/html`, `/links`, `/widgets`) are added per the
+delivery roadmap; each is its own subpath so consumers only bundle what they import.
 
 ## Logging
 
-The library never reads env flags directly (webview-safe). Enable console output
-once at widget startup with your own flag:
+The library never reads env flags directly (webview-safe: a bundled `process.env`
+reference would crash inside Staffbase mobile webviews). Enable console output once
+at widget startup with your own flag:
 
 ```ts
 import { setLoggingEnabled } from '@favish/staffbase-utils/log'
 
 setLoggingEnabled(import.meta.env.VITE_SHOW_CONSOLE_ERRORS === 'true')
+// or, for REACT_APP_-style widgets:
+// setLoggingEnabled(process.env.REACT_APP_SHOW_CONSOLE_ERRORS === 'true')
+```
+
+Disabled by default, so production stays silent. `logError`/`logWarn`/`logDebug`
+forward to the matching `console` method only while enabled.
+
+## Releasing
+
+Publishing runs through GitHub Actions with npm **Trusted Publishing (OIDC)** — no
+tokens, no OTP — same as `@favish/staffbase-drawer` and `@favish/staffbase-cli`.
+
+Trigger the `Release` workflow (`.github/workflows/release.yml`) manually and pick a
+bump type:
+
+```bash
+gh workflow run release.yml -f release_type=patch   # or minor / major / none
+```
+
+(or run it from the GitHub Actions tab). The workflow runs the quality gate
+(type-check, lint, test, build), bumps + tags the version, publishes to npm with
+provenance, and pushes the version commit + tag back to `main`. Use
+`release_type=none` to publish the current `package.json` version as-is.
+
+CI (`.github/workflows/ci.yml`) runs the same quality gate on every push and PR to
+`main`.
+
+## Development
+
+```bash
+pnpm install      # installs deps and runs the full verify+build via `prepare`
+pnpm test         # jest
+pnpm run type-check
+pnpm run lint
+pnpm run build    # vite library build -> dist/
 ```
 
-Disabled by default, so production stays silent.
+Conventions: one exported symbol per file; types under `src/types/`; ESM + CJS
+outputs per module (`*.es.mjs` / `*.cjs.js`) with generated `.d.ts`.

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@favish/staffbase-utils",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Shared internal/host utilities for Staffbase widgets",
   "author": "Favish <dev@favish.com>",
-  "packageManager": "pnpm@11.5.0",
   "license": "UNLICENSED",
-  "type": "module",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "exports": {
     "./log": {
       "types": "./dist/src/log/index.d.ts",
@@ -14,25 +14,9 @@
       "require": "./dist/log.cjs.js"
     }
   },
-  "scripts": {
-    "build": "vite build",
-    "check:all": "pnpm run format && pnpm run lint:fix && pnpm run type-check && pnpm run test",
-    "format": "prettier --write \"src/**/*\" --list-different",
-    "lint": "eslint ./src",
-    "lint:fix": "eslint ./src --fix",
-    "prepare": "pnpm run format && pnpm run type-check && pnpm run lint:fix && pnpm run build",
-    "prepublishOnly": "pnpm run test",
-    "publish:major": "pnpm run prepare && pnpm version major && pnpm publish",
-    "publish:minor": "pnpm run prepare && pnpm version minor && pnpm publish",
-    "publish:patch": "pnpm run prepare && pnpm version patch && pnpm publish",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "type-check": "tsc --pretty --noEmit",
-    "type-check:watch": "tsc --pretty --noEmit --watch"
-  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/favish/staffbase-utils"
+    "url": "git+https://github.com/favish/staffbase-utils.git"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -43,8 +27,12 @@
     "react-dom": "^18.0.0 || ^19.0.0"
   },
   "peerDependenciesMeta": {
-    "react": { "optional": true },
-    "react-dom": { "optional": true }
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@eslint/eslintrc": "^3.3.5",
@@ -69,5 +57,19 @@
     "typescript-eslint": "^8.60.0",
     "vite": "^8.0.14",
     "vite-plugin-dts": "^5.0.1"
+  },
+  "scripts": {
+    "build": "vite build",
+    "check:all": "pnpm run format && pnpm run lint:fix && pnpm run type-check && pnpm run test",
+    "format": "prettier --write \"src/**/*\" --list-different",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint ./src --fix",
+    "publish:major": "pnpm run prepare && pnpm version major && pnpm publish",
+    "publish:minor": "pnpm run prepare && pnpm version minor && pnpm publish",
+    "publish:patch": "pnpm run prepare && pnpm version patch && pnpm publish",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "type-check": "tsc --pretty --noEmit",
+    "type-check:watch": "tsc --pretty --noEmit --watch"
   }
-}
+}