@c9up/ream 0.2.3 → 0.2.5

package/src/session/drivers/CookieDriver.ts

@@ -7,7 +7,7 @@ import type { SessionDriver } from '../Session.js'
  * Requires a secret for encryption.
  */
 export class CookieDriver implements SessionDriver {
-  private signer: CookieSigner
+  #signer: CookieSigner
 
   constructor(secret: string) {
     if (!secret) {
@@ -15,12 +15,12 @@ export class CookieDriver implements SessionDriver {
         'CookieDriver requires a secret for session encryption. Set session.secret in your config.',
       )
     }
-    this.signer = new CookieSigner(secret)
+    this.#signer = new CookieSigner(secret)
   }
 
   async read(sessionId: string): Promise<Record<string, unknown> | null> {
     if (!sessionId) return null
-    const decrypted = this.signer.decrypt(sessionId)
+    const decrypted = this.#signer.decrypt(sessionId)
     if (!decrypted) return null
     try {
       return JSON.parse(decrypted)
@@ -43,6 +43,6 @@ export class CookieDriver implements SessionDriver {
 
   /** Encode session data for cookie storage (encrypted). */
   encode(data: Record<string, unknown>): string {
-    return this.signer.encrypt(JSON.stringify(data))
+    return this.#signer.encrypt(JSON.stringify(data))
   }
 }

package/src/types/index.ts

@@ -1,10 +1,97 @@
 /**
- * The interfaces an application or a package augments.
+ * The interfaces an application or a package augments — `@c9up/ream/types`.
  *
  * Resolving from the container and picking an auth guard are both string
- * lookups; without a shared interface to augment, every call site casts. This
- * is the module those interfaces live in — `@c9up/ream/types`.
+ * lookups; without a shared interface to augment, every call site casts.
+ *
+ * The augmentable interfaces are DECLARED here rather than re-exported from a
+ * neighbouring file, and that is load-bearing: TypeScript augments the module
+ * that declares an interface, so a re-export makes
+ * `declare module '@c9up/ream/types' { interface Authenticators { … } }` a
+ * duplicate declaration instead of an augmentation. warden hit exactly that.
+ */
+
+import type { Application } from '../Application.js'
+import type { ConfigStore } from '../ConfigLoader.js'
+import type { Console } from '../console/Console.js'
+import type { Kernel } from '../console/Kernel.js'
+import type { Emitter } from '../events/Emitter.js'
+import type { HttpContext } from '../http/HttpContext.js'
+import type { MiddlewareRegistry } from '../middleware/Pipeline.js'
+import type { MigrationRegistry } from '../migrations/MigrationRegistry.js'
+import type { Router } from '../router/Router.js'
+import type { CookieSigner } from '../security/CookieSigner.js'
+import type { SignedUrl } from '../security/SignedUrl.js'
+import type { Server } from '../server/Server.js'
+
+/**
+ * Guard name → what `auth.use(name)` hands back.
+ *
+ * Empty here, and deliberately: ream owns no auth package, so it cannot know
+ * the guards an app configured. The auth package fills it in:
+ *
+ * ```ts
+ * declare module '@c9up/ream/types' {
+ *   interface Authenticators {
+ *     session: SessionGuard
+ *   }
+ * }
+ * ```
+ *
+ * Until something augments it, `keyof Authenticators` is `never` and `use()`
+ * falls through to its `unknown` signature — the previous behaviour kept as
+ * the floor rather than the ceiling.
+ */
+/**
+ * An EMPTY INTERFACE is the whole mechanism here, not an oversight. Rewritten
+ * as `type Authenticators = {}` the declaration stops being augmentable:
+ * `declare module '@c9up/ream/types' { interface Authenticators { … } }`
+ * becomes a duplicate identifier instead of a merge, and warden cannot type
+ * `ctx.auth.use()`. That is exactly what shipped in 0.2.3, where the formatter
+ * had rewritten it.
+ */
+// biome-ignore lint/suspicious/noEmptyInterface: it must stay an interface to be augmentable — see above
+export interface Authenticators {}
+
+/** A guard name this application knows about. */
+export type AuthenticatorName = keyof Authenticators
+
+/**
+ * The container's known bindings.
+ *
+ * Ream core registers the entries below; anything else — `auth` (warden),
+ * `logger` (spectrum), `db` (atlas) — reaches this interface by augmentation
+ * from the package that owns it, which is why it is open rather than a closed
+ * union.
  */
+export interface ContainerBindings {
+  /** The application instance. */
+  app: Application
+  /** Absolute path to the application root. */
+  appRoot: string
+  /** The config store built from `config/*.ts`. */
+  config: ConfigStore
+  /** The console application (AdonisJS calls its equivalent `ace`). */
+  console: Console
+  /** The console kernel that dispatches commands. */
+  consoleKernel: Kernel
+  /** The event emitter. */
+  emitter: Emitter
+  /** Cookie/value signing and encryption, backed by `APP_KEY`. */
+  encryption: CookieSigner
+  /** The `HttpContext` class itself — for `HttpContext.getOrFail()` style access. */
+  HttpContext: typeof HttpContext
+  /** Named middleware registered by the app kernel. */
+  middleware: MiddlewareRegistry
+  /** Migration sources contributed by data packages (atlas, eon, ...). */
+  migrations: MigrationRegistry
+  /** The HTTP router. */
+  router: Router
+  /** The HTTP server. */
+  server: Server
+  /** Signed-URL generation and verification. */
+  signedUrl: SignedUrl
+}
 
-export type { AuthenticatorName, Authenticators } from './authenticators.js'
-export type { ContainerBinding, ContainerBindings } from './container.js'
+/** A token this container knows how to resolve. */
+export type ContainerBinding = keyof ContainerBindings

package/dist/types/authenticators.d.ts

@@ -1,24 +0,0 @@
-/**
- * Guard name → what `auth.use(name)` hands back.
- *
- * Empty here, and deliberately: ream owns no auth package, so it cannot know
- * the guards an app configured. The auth package fills it in, exactly as
- * AdonisJS does with `Authenticators`:
- *
- * ```ts
- * declare module '@c9up/ream/types' {
- *   interface Authenticators {
- *     session: SessionGuard
- *     jwt: JwtGuard
- *   }
- * }
- * ```
- *
- * Until something augments it, `keyof Authenticators` is `never` and `use()`
- * falls through to its `unknown` signature — the behaviour ream had before,
- * kept as the floor rather than as the ceiling.
- */
-export type Authenticators = {};
-/** A guard name this application knows about. */
-export type AuthenticatorName = keyof Authenticators;
-//# sourceMappingURL=authenticators.d.ts.map

package/dist/types/authenticators.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"authenticators.d.ts","sourceRoot":"","sources":["../../src/types/authenticators.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,cAAc,GAAG,EAAE,CAAA;AAE/B,iDAAiD;AACjD,MAAM,MAAM,iBAAiB,GAAG,MAAM,cAAc,CAAA"}

package/dist/types/authenticators.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=authenticators.js.map

package/dist/types/authenticators.js.map

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

package/dist/types/container.d.ts

@@ -1,64 +0,0 @@
-/**
- * The container's known bindings, as a type.
- *
- * Resolving from the container is a string lookup, so without a shared
- * interface every `container.make('router')` returns `unknown` and every app
- * casts. AdonisJS solves it with an augmentable `ContainerBindings`, and every
- * package in its ecosystem adds its own token to it:
- *
- * ```ts
- * declare module '@c9up/ream/types' {
- *   interface ContainerBindings {
- *     auth: AuthManager
- *   }
- * }
- * ```
- *
- * Ream core registers the entries below; anything else — `auth` (warden),
- * `logger` (spectrum), `db` (atlas) — reaches this interface by augmentation
- * from the package that owns it, which is why the interface is open rather
- * than a closed union.
- */
-import type { Application } from '../Application.js';
-import type { ConfigStore } from '../ConfigLoader.js';
-import type { Console } from '../console/Console.js';
-import type { Kernel } from '../console/Kernel.js';
-import type { Emitter } from '../events/Emitter.js';
-import type { HttpContext } from '../http/HttpContext.js';
-import type { MiddlewareRegistry } from '../middleware/Pipeline.js';
-import type { MigrationRegistry } from '../migrations/MigrationRegistry.js';
-import type { Router } from '../router/Router.js';
-import type { CookieSigner } from '../security/CookieSigner.js';
-import type { SignedUrl } from '../security/SignedUrl.js';
-import type { Server } from '../server/Server.js';
-export interface ContainerBindings {
-    /** The application instance. */
-    app: Application;
-    /** Absolute path to the application root. */
-    appRoot: string;
-    /** The config store built from `config/*.ts`. */
-    config: ConfigStore;
-    /** The console application (AdonisJS calls its equivalent `ace`). */
-    console: Console;
-    /** The console kernel that dispatches commands. */
-    consoleKernel: Kernel;
-    /** The event emitter. */
-    emitter: Emitter;
-    /** Cookie/value signing and encryption, backed by `APP_KEY`. */
-    encryption: CookieSigner;
-    /** The `HttpContext` class itself — for `HttpContext.getOrFail()` style access. */
-    HttpContext: typeof HttpContext;
-    /** Named middleware registered by the app kernel. */
-    middleware: MiddlewareRegistry;
-    /** Migration sources contributed by data packages (atlas, eon, ...). */
-    migrations: MigrationRegistry;
-    /** The HTTP router. */
-    router: Router;
-    /** The HTTP server. */
-    server: Server;
-    /** Signed-URL generation and verification. */
-    signedUrl: SignedUrl;
-}
-/** A token this container knows how to resolve. */
-export type ContainerBinding = keyof ContainerBindings;
-//# sourceMappingURL=container.d.ts.map

package/dist/types/container.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"container.d.ts","sourceRoot":"","sources":["../../src/types/container.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAA;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAA;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAA;AAC3E,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AACzD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAA;AAEjD,MAAM,WAAW,iBAAiB;IAChC,gCAAgC;IAChC,GAAG,EAAE,WAAW,CAAA;IAChB,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAA;IACf,iDAAiD;IACjD,MAAM,EAAE,WAAW,CAAA;IACnB,qEAAqE;IACrE,OAAO,EAAE,OAAO,CAAA;IAChB,mDAAmD;IACnD,aAAa,EAAE,MAAM,CAAA;IACrB,yBAAyB;IACzB,OAAO,EAAE,OAAO,CAAA;IAChB,gEAAgE;IAChE,UAAU,EAAE,YAAY,CAAA;IACxB,mFAAmF;IACnF,WAAW,EAAE,OAAO,WAAW,CAAA;IAC/B,qDAAqD;IACrD,UAAU,EAAE,kBAAkB,CAAA;IAC9B,wEAAwE;IACxE,UAAU,EAAE,iBAAiB,CAAA;IAC7B,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,8CAA8C;IAC9C,SAAS,EAAE,SAAS,CAAA;CACrB;AAED,mDAAmD;AACnD,MAAM,MAAM,gBAAgB,GAAG,MAAM,iBAAiB,CAAA"}

package/dist/types/container.js

@@ -1,23 +0,0 @@
-/**
- * The container's known bindings, as a type.
- *
- * Resolving from the container is a string lookup, so without a shared
- * interface every `container.make('router')` returns `unknown` and every app
- * casts. AdonisJS solves it with an augmentable `ContainerBindings`, and every
- * package in its ecosystem adds its own token to it:
- *
- * ```ts
- * declare module '@c9up/ream/types' {
- *   interface ContainerBindings {
- *     auth: AuthManager
- *   }
- * }
- * ```
- *
- * Ream core registers the entries below; anything else — `auth` (warden),
- * `logger` (spectrum), `db` (atlas) — reaches this interface by augmentation
- * from the package that owns it, which is why the interface is open rather
- * than a closed union.
- */
-export {};
-//# sourceMappingURL=container.js.map

package/dist/types/container.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"container.js","sourceRoot":"","sources":["../../src/types/container.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG"}

package/src/types/authenticators.ts

@@ -1,24 +0,0 @@
-/**
- * Guard name → what `auth.use(name)` hands back.
- *
- * Empty here, and deliberately: ream owns no auth package, so it cannot know
- * the guards an app configured. The auth package fills it in, exactly as
- * AdonisJS does with `Authenticators`:
- *
- * ```ts
- * declare module '@c9up/ream/types' {
- *   interface Authenticators {
- *     session: SessionGuard
- *     jwt: JwtGuard
- *   }
- * }
- * ```
- *
- * Until something augments it, `keyof Authenticators` is `never` and `use()`
- * falls through to its `unknown` signature — the behaviour ream had before,
- * kept as the floor rather than as the ceiling.
- */
-export type Authenticators = {}
-
-/** A guard name this application knows about. */
-export type AuthenticatorName = keyof Authenticators

package/src/types/container.ts

@@ -1,66 +0,0 @@
-/**
- * The container's known bindings, as a type.
- *
- * Resolving from the container is a string lookup, so without a shared
- * interface every `container.make('router')` returns `unknown` and every app
- * casts. AdonisJS solves it with an augmentable `ContainerBindings`, and every
- * package in its ecosystem adds its own token to it:
- *
- * ```ts
- * declare module '@c9up/ream/types' {
- *   interface ContainerBindings {
- *     auth: AuthManager
- *   }
- * }
- * ```
- *
- * Ream core registers the entries below; anything else — `auth` (warden),
- * `logger` (spectrum), `db` (atlas) — reaches this interface by augmentation
- * from the package that owns it, which is why the interface is open rather
- * than a closed union.
- */
-
-import type { Application } from '../Application.js'
-import type { ConfigStore } from '../ConfigLoader.js'
-import type { Console } from '../console/Console.js'
-import type { Kernel } from '../console/Kernel.js'
-import type { Emitter } from '../events/Emitter.js'
-import type { HttpContext } from '../http/HttpContext.js'
-import type { MiddlewareRegistry } from '../middleware/Pipeline.js'
-import type { MigrationRegistry } from '../migrations/MigrationRegistry.js'
-import type { Router } from '../router/Router.js'
-import type { CookieSigner } from '../security/CookieSigner.js'
-import type { SignedUrl } from '../security/SignedUrl.js'
-import type { Server } from '../server/Server.js'
-
-export interface ContainerBindings {
-  /** The application instance. */
-  app: Application
-  /** Absolute path to the application root. */
-  appRoot: string
-  /** The config store built from `config/*.ts`. */
-  config: ConfigStore
-  /** The console application (AdonisJS calls its equivalent `ace`). */
-  console: Console
-  /** The console kernel that dispatches commands. */
-  consoleKernel: Kernel
-  /** The event emitter. */
-  emitter: Emitter
-  /** Cookie/value signing and encryption, backed by `APP_KEY`. */
-  encryption: CookieSigner
-  /** The `HttpContext` class itself — for `HttpContext.getOrFail()` style access. */
-  HttpContext: typeof HttpContext
-  /** Named middleware registered by the app kernel. */
-  middleware: MiddlewareRegistry
-  /** Migration sources contributed by data packages (atlas, eon, ...). */
-  migrations: MigrationRegistry
-  /** The HTTP router. */
-  router: Router
-  /** The HTTP server. */
-  server: Server
-  /** Signed-URL generation and verification. */
-  signedUrl: SignedUrl
-}
-
-/** A token this container knows how to resolve. */
-export type ContainerBinding = keyof ContainerBindings