kiosks-core

Shared core library for the KIOSKS project's backend services: TypeORM entities, DI-registered services/clients, Express middlewares, DTOs, enums, and OpenTelemetry helpers. Consumed by kiosks (and other kiosks backend services) as @slabcode/kiosks-core.

Scripts

• npm run build — format (prettier) + tsc + tsc-alias. Compiles to dist/ (JS) and types/ (declarations), both gitignored.
• npm run pack — cleans dist//types/, builds, and runs npm pack to produce a local .tgz. Use this to test a change in a consumer (e.g. kiosks) before publishing anything, without touching the registry at all:

  npm run pack
  cd ../kiosks && npm install ../kiosks-core/slabcode-kiosks-core-<version>.tgz

  This adds a temporary "file:../kiosks-core/<tarball>.tgz" dependency in the consumer's package.json — swap it back to a real registry version once you actually publish.
• npm run deploy — build + npm publish. Publishes a normal stable release under the latest dist-tag. Use this for changes that are ready for production.
• npm run deploy:preview — build + npm publish --tag preview. Publishes under the preview dist-tag instead of latest, so existing consumers' ^x.y.z ranges (and a bare npm install @slabcode/kiosks-core) never resolve to it. Use this while a change (e.g. a new pinpad brand integration, see kiosks/README.md) is still being validated and shouldn't reach other services through a routine deploy.

Publishing a change

1. Bump version in package.json:
   • Stable change, ready for production: a normal semver bump (e.g. 3.1.0 → 3.1.1).
   • Change still under validation / not production-ready yet: a prerelease version (e.g. 3.1.1-<feature>.0).
2. Make sure you have a .npmrc (gitignored, not in the repo) configured with the private registry credentials. Ask a teammate who has published before if you don't have one set up.
3. Run npm run deploy for a stable release, or npm run deploy:preview for a preview/prerelease.
4. Verify with npm dist-tag ls @slabcode/kiosks-core that latest only moved if you intended it to.
5. In each consumer repo (kiosks, etc.), update the @slabcode/kiosks-core dependency in package.json:
   • Stable release: bump to a normal ^x.y.z range.
   • Preview release: pin the exact version, no ^ (e.g. "3.1.1-<feature>.0"), so it doesn't move on its own with a routine npm install and only the repo/branch that needs it uses it. Once the change is validated, re-publish as a stable release and switch the consumer back to a ^ range.
6. Run npm install in the consumer to pick up the change.