@birtalanrobert/context 0.1.0 → 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,116 @@
+# Changelog
+
+Each package carries its own version. A release publishes only the packages
+whose version is not yet on the registry; `pnpm release` asks npm and skips the
+rest.
+
+## 1.0.0
+
+The version numbers become meaningful.
+
+Until now every package shared one version and all twelve were republished
+together. That does not survive contact with per-package releases while the
+major is `0`: under semver a `^0.2.0` range excludes `0.3.0`, so changing one
+package and releasing only it leaves every dependent pinned to the old copy —
+and npm resolves that by installing both. Two copies of `observability` means
+two distinct `MORTAR_LOGGER` symbols, and dependency injection stops working
+with an error that names neither.
+
+At `1.x` a caret range accepts later minors, so a package can be released on
+its own and its dependents pick it up on their next install. From here:
+
+- **patch** — a fix that changes no signature
+- **minor** — anything added
+- **major** — anything removed or changed in shape
+
+### Added
+
+- **`DatabaseModule` can run migrations at boot** — `migrationsRun: true`.
+
+  Guarded by a Postgres advisory lock, so several replicas starting at once are
+  safe: one applies while the others wait, then find nothing pending. TypeORM
+  takes no lock of its own, and without one the second replica to reach a
+  `CREATE TABLE` fails and that container crash-loops. Also exported directly
+  as `runMigrationsWithLock` for release-step scripts.
+
+- **`LoggerModule` provides `NestLoggerAdapter` and `LoggingInterceptor`.**
+  Both were exported but never registered, so `app.get(NestLoggerAdapter)` and
+  `{ provide: APP_INTERCEPTOR, useExisting: LoggingInterceptor }` — the two
+  documented ways to use them — both failed. Constructing them by hand still
+  works.
+
+- **`PUBLIC_ROUTE_KEY` and `PublicRoute()` in `@birtalanrobert/http`**, and the
+  health controller now carries them. `@birtalanrobert/auth` re-exports the key
+  as `PUBLIC_KEY`, unchanged, so `PermissionsGuard` and `@Public()` behave
+  exactly as before — but a globally registered guard no longer 401s the
+  readiness probe, which previously left pods that never joined the load
+  balancer.
+
+- **`auditEntities` and `idempotencyEntities`**, so every package that ships
+  entities exports them as an array the same way it exports its migrations.
+
+### Fixed
+
+- **A circular import between `logger.module.ts` and the two classes it now
+  provides** left `MORTAR_LOGGER` `undefined` at decorator evaluation time, so
+  `@Inject(MORTAR_LOGGER)` silently degraded to reflected-type injection and
+  Nest reported that it could not resolve `Function`. The tokens moved to a
+  leaf module. Under CommonJS this class of bug fails at wiring time, never at
+  build time.
+
+### Testing
+
+`@nestjs/testing` and `unplugin-swc` are now dev dependencies, and the Nest
+modules are exercised by building a real container rather than by inspecting
+the `DynamicModule` object. Every defect above was invisible to a test that
+asserts on `module.providers` and obvious to one that calls `moduleRef.get()`.
+
+## 0.2.0
+
+Composing the packages into a real application surfaced three problems that
+package-level tests could not.
+
+### Added
+
+- **`forRootAsync` on every configurable module** — `LoggerModule`,
+  `DatabaseModule`, `RedisModule`, `HttpModule`, `TenancyModule`, `AuthModule`,
+  `IdempotencyModule` and `JobsModule`.
+
+  Previously each module took its options synchronously, which meant a consumer
+  had to read `process.env` at import time — before anything had validated it —
+  to configure a database URL or a Redis connection. That defeats having a
+  configuration layer at all. Options can now come from any provider, including
+  the validated config.
+
+- **`ConfigModule.token()`**, so a wiring site can write
+  `inject: [ConfigModule.token()]` rather than importing the raw symbol.
+
+- **`AsyncModuleOptions<T>`** in `@birtalanrobert/context`: the shared shape for
+  the above.
+
+### Fixed
+
+- **`HttpModule` and `TenancyModule` no longer hold module options in static
+  fields.** Both middlewares now receive their options through dependency
+  injection. The previous arrangement meant a second `forRoot()` call silently
+  overwrote the first — which is exactly what happens when a test suite builds
+  more than one application in a process.
+
+- **`@birtalanrobert/http` accepts `class-validator` 0.15**, which is current.
+  The peer range previously stopped at 0.14 and produced an unmet-peer warning
+  on every install.
+
+- **Internal dependencies publish as `^x.y.z` rather than an exact pin.** Exact
+  pins across a family released together make npm install several copies of the
+  same package as soon as two versions coexist in one tree.
+
+### Note on compatibility
+
+`HttpModule.contextOptions` and `TenancyModule.resolvers` are no longer present
+as static properties. They were declared `private` and were never part of the
+documented surface — TypeScript consumers could not reach them — but a
+JavaScript consumer reading them would break. Nothing else changed shape.
+
+## 0.1.0
+
+First release.

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export type { AsyncModuleOptions } from './module-options';
 export type { Actor, ContextSource, RequestContext } from './types';
 export { contextSnapshot, createContext, elapsedMs, getActor, getAttribute, getContext, getCorrelationId, getLocale, getRequestId, getTenantId, requireActor, requireContext, requireTenantId, runInChildContext, runInContext, runWithContext, setAttribute, setContextValues, type CreateContextOptions, } from './context';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EACL,eAAe,EACf,aAAa,EACb,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,SAAS,EACT,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,KAAK,oBAAoB,GAC1B,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC3D,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EACL,eAAe,EACf,aAAa,EACb,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,UAAU,EACV,gBAAgB,EAChB,SAAS,EACT,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,KAAK,oBAAoB,GAC1B,MAAM,WAAW,CAAC"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AACA,qCAoBmB;AAnBjB,0GAAA,eAAe,OAAA;AACf,wGAAA,aAAa,OAAA;AACb,oGAAA,SAAS,OAAA;AACT,mGAAA,QAAQ,OAAA;AACR,uGAAA,YAAY,OAAA;AACZ,qGAAA,UAAU,OAAA;AACV,2GAAA,gBAAgB,OAAA;AAChB,oGAAA,SAAS,OAAA;AACT,uGAAA,YAAY,OAAA;AACZ,sGAAA,WAAW,OAAA;AACX,uGAAA,YAAY,OAAA;AACZ,yGAAA,cAAc,OAAA;AACd,0GAAA,eAAe,OAAA;AACf,4GAAA,iBAAiB,OAAA;AACjB,uGAAA,YAAY,OAAA;AACZ,yGAAA,cAAc,OAAA;AACd,uGAAA,YAAY,OAAA;AACZ,2GAAA,gBAAgB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,qCAoBmB;AAnBjB,0GAAA,eAAe,OAAA;AACf,wGAAA,aAAa,OAAA;AACb,oGAAA,SAAS,OAAA;AACT,mGAAA,QAAQ,OAAA;AACR,uGAAA,YAAY,OAAA;AACZ,qGAAA,UAAU,OAAA;AACV,2GAAA,gBAAgB,OAAA;AAChB,oGAAA,SAAS,OAAA;AACT,uGAAA,YAAY,OAAA;AACZ,sGAAA,WAAW,OAAA;AACX,uGAAA,YAAY,OAAA;AACZ,yGAAA,cAAc,OAAA;AACd,0GAAA,eAAe,OAAA;AACf,4GAAA,iBAAiB,OAAA;AACjB,uGAAA,YAAY,OAAA;AACZ,yGAAA,cAAc,OAAA;AACd,uGAAA,YAAY,OAAA;AACZ,2GAAA,gBAAgB,OAAA"}

package/dist/module-options.d.ts

@@ -0,0 +1,20 @@
+/**
+ * The standard shape for configuring a module from other providers.
+ *
+ * Every mortar module that takes options offers `forRootAsync`, because the
+ * options almost always come from validated configuration — and a module that
+ * can only be configured synchronously forces its consumer to read
+ * `process.env` directly at import time, which defeats having a config layer
+ * at all.
+ *
+ * Declared here rather than duplicated because it is a type, erased at
+ * runtime, and every mortar package already depends on this one.
+ */
+export interface AsyncModuleOptions<TOptions> {
+    /** Modules whose providers the factory injects. Rarely needed for globals. */
+    imports?: unknown[];
+    /** Tokens passed to the factory, in order. */
+    inject?: unknown[];
+    useFactory: (...args: never[]) => TOptions | Promise<TOptions>;
+}
+//# sourceMappingURL=module-options.d.ts.map

package/dist/module-options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-options.d.ts","sourceRoot":"","sources":["../src/module-options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,kBAAkB,CAAC,QAAQ;IAC1C,8EAA8E;IAC9E,OAAO,CAAC,EAAE,OAAO,EAAE,CAAC;IACpB,8CAA8C;IAC9C,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;IACnB,UAAU,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,EAAE,KAAK,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAChE"}

package/dist/module-options.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=module-options.js.map

package/dist/module-options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-options.js","sourceRoot":"","sources":["../src/module-options.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@birtalanrobert/context",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "AsyncLocalStorage request context",
   "license": "AGPL-3.0-only",
   "type": "commonjs",
@@ -14,7 +14,8 @@
     "!src/**/__tests__",
     "README.md",
     "LICENSE",
-    "NOTICE"
+    "NOTICE",
+    "CHANGELOG.md"
   ],
   "exports": {
     ".": {

package/src/index.ts

@@ -1,3 +1,4 @@
+export type { AsyncModuleOptions } from './module-options';
 export type { Actor, ContextSource, RequestContext } from './types';
 export {
   contextSnapshot,

package/src/module-options.ts

@@ -0,0 +1,19 @@
+/**
+ * The standard shape for configuring a module from other providers.
+ *
+ * Every mortar module that takes options offers `forRootAsync`, because the
+ * options almost always come from validated configuration — and a module that
+ * can only be configured synchronously forces its consumer to read
+ * `process.env` directly at import time, which defeats having a config layer
+ * at all.
+ *
+ * Declared here rather than duplicated because it is a type, erased at
+ * runtime, and every mortar package already depends on this one.
+ */
+export interface AsyncModuleOptions<TOptions> {
+  /** Modules whose providers the factory injects. Rarely needed for globals. */
+  imports?: unknown[];
+  /** Tokens passed to the factory, in order. */
+  inject?: unknown[];
+  useFactory: (...args: never[]) => TOptions | Promise<TOptions>;
+}