@webpieces/http-routing 0.3.364 → 0.3.366

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webpieces/http-routing",
-  "version": "0.3.364",
+  "version": "0.3.366",
   "description": "Decorator-based routing with auto-wiring for WebPieces",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -22,9 +22,9 @@
   },
   "dependencies": {
     "@inversifyjs/binding-decorators": "1.1.5",
-    "@webpieces/core-context": "0.3.364",
-    "@webpieces/core-util": "0.3.364",
-    "@webpieces/gcp-identity": "0.3.364",
+    "@webpieces/core-context": "0.3.366",
+    "@webpieces/core-util": "0.3.366",
+    "@webpieces/gcp-identity": "0.3.366",
     "inversify": "7.10.4",
     "jsonwebtoken": "9.0.2",
     "minimatch": "10.0.1"

package/src/AppModules.d.ts

@@ -0,0 +1,58 @@
+import { ContainerModule } from 'inversify';
+import { ContextKey } from '@webpieces/core-util';
+import { WebpiecesRouter } from './WebpiecesRouter';
+/**
+ * RouteModule - a reusable, named group of routes + filters, configured onto the
+ * {@link WebpiecesRouter}. This is the TypeScript analog of a Java WebPieces "RouteModule":
+ * instead of one anonymous `(router) => { ... }` block, each cohesive group of routes/filters
+ * lives in its own named class, and an app composes several of them.
+ *
+ * A RouteModule holds business logic (it configures the router), so it is an interface — the
+ * same category as {@link Routes} / {@link Filter}, NOT a data-only class (per the webpieces
+ * guidelines).
+ *
+ * ```ts
+ * export class AuthRoutes implements RouteModule {
+ *   configure(router: WebpiecesRouter): void {
+ *     router.addFilter(new FilterDefinition(1800, LogApiFilter, '*'));
+ *     router.addRoutes(AuthApi, AuthController);
+ *   }
+ * }
+ * ```
+ */
+export interface RouteModule {
+    /** Declare this group's routes + filters via {@link WebpiecesRouter.addRoutes} / addFilter. */
+    configure(router: WebpiecesRouter): void;
+}
+/**
+ * AppModules - an app's COMPLETE server-surface declaration in one object: its DI binding modules,
+ * its route groups, and its own context-key headers. It replaces the old split of a
+ * `ContainerModule[]` + a `ContextKey[]` + an inline `(router) => void` callback threaded through
+ * the bootstrap in separate arguments.
+ *
+ * Apps implement this on a class with a static `create()` factory, so the real server AND its
+ * tests build the SAME object (tests then tweak it / pass a test override module):
+ *
+ * ```ts
+ * export class MyAppModules implements AppModules {
+ *   static create(): MyAppModules { return new MyAppModules(); }
+ *   getBindingModules(): ContainerModule[] { return [InversifyModule]; }
+ *   getRoutingModules(): RouteModule[] { return [new AppRoutes()]; }
+ *   getHeaders(): ContextKey[] { return AppHeaders.getAllHeaders(); }
+ * }
+ *
+ * // server.ts
+ * await bootstrapServer(new BootstrapOptions(8200, 'my-svr'), MyAppModules.create());
+ * ```
+ *
+ * AppModules is a provider interface (it hands back the app's pieces), the same category as the
+ * former WebAppMeta — hence an interface, not a data-only class.
+ */
+export interface AppModules {
+    /** App-specific DI ContainerModules (beyond the standard company/framework set). */
+    getBindingModules(): ContainerModule[];
+    /** The route groups to configure onto the router, in order. */
+    getRoutingModules(): RouteModule[];
+    /** This app's own context keys, registered into the global HeaderRegistry at startup. */
+    getHeaders(): ContextKey[];
+}

package/src/AppModules.js

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

package/src/AppModules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AppModules.js","sourceRoot":"","sources":["../../../../../packages/http/http-routing/src/AppModules.ts"],"names":[],"mappings":"","sourcesContent":["import { ContainerModule } from 'inversify';\nimport { ContextKey } from '@webpieces/core-util';\nimport { WebpiecesRouter } from './WebpiecesRouter';\n\n/**\n * RouteModule - a reusable, named group of routes + filters, configured onto the\n * {@link WebpiecesRouter}. This is the TypeScript analog of a Java WebPieces \"RouteModule\":\n * instead of one anonymous `(router) => { ... }` block, each cohesive group of routes/filters\n * lives in its own named class, and an app composes several of them.\n *\n * A RouteModule holds business logic (it configures the router), so it is an interface — the\n * same category as {@link Routes} / {@link Filter}, NOT a data-only class (per the webpieces\n * guidelines).\n *\n * ```ts\n * export class AuthRoutes implements RouteModule {\n *   configure(router: WebpiecesRouter): void {\n *     router.addFilter(new FilterDefinition(1800, LogApiFilter, '*'));\n *     router.addRoutes(AuthApi, AuthController);\n *   }\n * }\n * ```\n */\nexport interface RouteModule {\n    /** Declare this group's routes + filters via {@link WebpiecesRouter.addRoutes} / addFilter. */\n    configure(router: WebpiecesRouter): void;\n}\n\n/**\n * AppModules - an app's COMPLETE server-surface declaration in one object: its DI binding modules,\n * its route groups, and its own context-key headers. It replaces the old split of a\n * `ContainerModule[]` + a `ContextKey[]` + an inline `(router) => void` callback threaded through\n * the bootstrap in separate arguments.\n *\n * Apps implement this on a class with a static `create()` factory, so the real server AND its\n * tests build the SAME object (tests then tweak it / pass a test override module):\n *\n * ```ts\n * export class MyAppModules implements AppModules {\n *   static create(): MyAppModules { return new MyAppModules(); }\n *   getBindingModules(): ContainerModule[] { return [InversifyModule]; }\n *   getRoutingModules(): RouteModule[] { return [new AppRoutes()]; }\n *   getHeaders(): ContextKey[] { return AppHeaders.getAllHeaders(); }\n * }\n *\n * // server.ts\n * await bootstrapServer(new BootstrapOptions(8200, 'my-svr'), MyAppModules.create());\n * ```\n *\n * AppModules is a provider interface (it hands back the app's pieces), the same category as the\n * former WebAppMeta — hence an interface, not a data-only class.\n */\nexport interface AppModules {\n    /** App-specific DI ContainerModules (beyond the standard company/framework set). */\n    getBindingModules(): ContainerModule[];\n    /** The route groups to configure onto the router, in order. */\n    getRoutingModules(): RouteModule[];\n    /** This app's own context keys, registered into the global HeaderRegistry at startup. */\n    getHeaders(): ContextKey[];\n}\n"]}

package/src/index.d.ts

@@ -11,6 +11,7 @@ export { FilterChain } from './FilterChain';
 export { MethodMeta } from './MethodMeta';
 export { RouteHandler } from './RouteHandler';
 export { FilterMatcher, HttpFilter } from './FilterMatcher';
+export { AppModules, RouteModule } from './AppModules';
 export { ApiFactory } from './ApiFactory';
 export { ApiClient, ApiClientProxy } from './ApiClient';
 export { AuthConfig, AuthValues, SharedSecrets } from './AuthConfig';

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/http/http-routing/src/index.ts"],"names":[],"mappings":";;;;AAAA,0DAA0D;AAC1D,kDA8B8B;AA7B1B,oGAAA,OAAO,OAAA;AACP,qGAAA,QAAQ,OAAA;AACR,2GAAA,cAAc,OAAA;AACd,iHAAA,oBAAoB,OAAA;AACpB,mGAAA,MAAM,OAAA;AACN,oGAAA,OAAO,OAAA;AACP,qGAAA,QAAQ,OAAA;AACR,6GAAA,gBAAgB,OAAA;AAChB,gGAAA,GAAG,OAAA;AACH,mGAAA,MAAM,OAAA;AACN,kGAAA,KAAK,OAAA;AACL,uGAAA,UAAU,OAAA;AACV,yGAAA,YAAY,OAAA;AACZ,sGAAA,SAAS,OAAA;AACT,wGAAA,WAAW,OAAA;AACX,wGAAA,WAAW,OAAA;AACX,2HAAA,8BAA8B,OAAA;AAC9B,uGAAA,UAAU,OAAA;AACV,0GAAA,aAAa,OAAA;AACb,oHAAA,uBAAuB,OAAA;AACvB,yGAAA,YAAY,OAAA;AACZ,qGAAA,QAAQ,OAAA;AACR,0GAAA,aAAa,OAAA;AACb,0GAAA,aAAa,OAAA;AAEb,2EAA2E;AAC3E,oCAAoC;AACpC,2GAAA,cAAc,OAAA;AACd,6GAAA,gBAAgB,OAAA;AAIpB,+CAA+C;AAC/C,2CAGsB;AAFlB,wGAAA,UAAU,OAAA;AACV,mHAAA,qBAAqB,OAAA;AAGzB,iFAAiF;AACjF,wDAA4G;AAAnG,gHAAA,gBAAgB,OAAA;AAAE,6HAAA,6BAA6B,OAAA;AAAE,gHAAA,gBAAgB,OAAA;AAC1E,gGAAgG;AAChG,wDAIiC;AAH7B,yHAAA,yBAAyB,OAAA;AACzB,sIAAA,sCAAsC,OAAA;AACtC,oHAAA,oBAAoB,OAAA;AAGxB,yDAAmE;AAA1D,sHAAA,iBAAiB,OAAA;AAE1B,qBAAqB;AACrB,2CAKsB;AAFlB,6GAAA,eAAe,OAAA;AACf,8GAAA,gBAAgB,OAAA;AAGpB,sFAAsF;AACtF,+FAA+F;AAC/F,wDAAsD;AAA7C,2GAAA,WAAW,OAAA;AAEpB,qFAAqF;AACrF,mCAAuD;AAA9C,gGAAA,MAAM,OAAA;AAAE,oGAAA,UAAU,OAAA;AAC3B,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AAErB,oFAAoF;AACpF,sFAAsF;AAEtF,kBAAkB;AAClB,iDAA4D;AAAnD,8GAAA,aAAa,OAAA;AAItB,yCAAwD;AAA/C,sGAAA,SAAS,OAAA;AAElB,mFAAmF;AACnF,iEAAiE;AACjE,oFAAoF;AACpF,4FAA4F;AAC5F,2CAAqE;AAA5D,wGAAA,UAAU,OAAA;AAAE,wGAAA,UAAU,OAAA;AAAE,2GAAA,aAAa,OAAA;AAC9C,yCAAgD;AAAvC,oGAAA,OAAO,OAAA;AAAE,qGAAA,QAAQ,OAAA;AAC1B,6DAA4D;AAAnD,0HAAA,mBAAmB,OAAA;AAC5B,0FAA0F;AAC1F,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AAEvB,kEAAkE;AAElE,0FAA0F;AAC1F,qDAAoG;AAA3F,kHAAA,eAAe,OAAA;AAAE,yHAAA,sBAAsB,OAAA;AAEhD,8FAA8F;AAC9F,kGAAkG;AAClG,+CAAmE;AAA1D,4GAAA,YAAY,OAAA;AAAE,mHAAA,mBAAmB,OAAA;AAE1C,uBAAuB;AACvB,qDAA4E;AAAnE,kHAAA,eAAe,OAAA;AAAE,yHAAA,sBAAsB,OAAA","sourcesContent":["// Re-export API decorators from core-util for convenience\nexport {\n    ApiPath,\n    Endpoint,\n    Authentication,\n    AuthenticationConfig,\n    Public,\n    AuthJwt,\n    AuthOidc,\n    AuthSharedSecret,\n    Rpc,\n    PubSub,\n    Queue,\n    getApiPath,\n    getEndpoints,\n    isApiPath,\n    getAuthMeta,\n    getAuthMode,\n    assertEveryEndpointHasAuthMode,\n    getApiKind,\n    assertApiKind,\n    assertPubSubConventions,\n    getQueueName,\n    AuthMeta,\n    RouteMetadata,\n    METADATA_KEYS,\n    ValidateImplementation,\n    // @DocumentDesign moved to core-util (design-root marker, browser + Node);\n    // re-exported here for back-compat.\n    DocumentDesign,\n    isDocumentDesign,\n} from '@webpieces/core-util';\nexport type { AuthMode, ApiKind } from '@webpieces/core-util';\n\n// Server-side routing decorators and utilities\nexport {\n    SourceFile,\n    ROUTING_METADATA_KEYS,\n} from './decorators';\n\n// DI provider decorators moved to core-context; re-exported here for back-compat\nexport { provideSingleton, provideSingletonDefaultForApi, provideTransient } from '@webpieces/core-context';\n// Framework-only DI registry (packages/** framework classes use these; see frameworkProvide.ts)\nexport {\n    provideFrameworkSingleton,\n    provideFrameworkSingletonDefaultForApi,\n    buildFrameworkModule,\n} from '@webpieces/core-context';\n\nexport { ApiRoutingFactory, ClassType } from './ApiRoutingFactory';\n\n// Core routing types\nexport {\n    Routes,\n    RouteBuilder,\n    RouteDefinition,\n    FilterDefinition,\n} from './WebAppMeta';\n\n// The transport-neutral request type (defined in core-context; this is http-routing's\n// public request — a transport adapter builds one and the chain reads it from RequestContext).\nexport { HttpRequest } from '@webpieces/core-context';\n\n// Filter-chain primitives (absorbed from the former @webpieces/http-filters package)\nexport { Filter, WpResponse, Service } from './Filter';\nexport { FilterChain } from './FilterChain';\nexport { MethodMeta } from './MethodMeta';\nexport { RouteHandler } from './RouteHandler';\n\n// RouteBuilderImpl (the route table + chain composer) is now INTERNAL — it is never\n// handed to upper layers. The express layer consumes ApiFactory.apiClients() instead.\n\n// Filter matching\nexport { FilterMatcher, HttpFilter } from './FilterMatcher';\n\n// The public API-surface abstraction: declare routes/filters, get them back as ApiClient[].\nexport { ApiFactory } from './ApiFactory';\nexport { ApiClient, ApiClientProxy } from './ApiClient';\n\n// Auth: the app-provided, container-bound pieces the framework AuthFilter injects.\n//  - AuthConfig: shared-secret STATE (@AuthSharedSecret values).\n//  - JwtHook / OidcHook: OPTIONAL verification mechanisms (bind only what you use).\n//  - DefaultOidcVerifier: the built-in Google OIDC verifier used when no OidcHook is bound.\nexport { AuthConfig, AuthValues, SharedSecrets } from './AuthConfig';\nexport { JwtHook, OidcHook } from './AuthHooks';\nexport { DefaultOidcVerifier } from './DefaultOidcVerifier';\n// DefaultJwtHook: batteries-included HS256 JwtHook — `new DefaultJwtHook(secret)` and go.\nexport { DefaultJwtHook } from './DefaultJwtHook';\n\n// Above-boundary context setup shared by every transport adapter.\n\n// Node-only router (the express-free heart: container + filter chain + in-process client)\nexport { WebpiecesRouter, WebpiecesRouterFactory, WebpiecesRouterOptions } from './WebpiecesRouter';\n\n// The ONE transport-free startup sequence (headers → logging → router → routes) → ApiFactory.\n// Reusable by any company/app and any framework adapter; a company wraps it with its own headers.\nexport { setupRuntime, RuntimeSetupOptions } from './setupRuntime';\n\n// Server configuration\nexport { WebpiecesConfig, WEBPIECES_CONFIG_TOKEN } from './WebpiecesConfig';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/http/http-routing/src/index.ts"],"names":[],"mappings":";;;;AAAA,0DAA0D;AAC1D,kDA8B8B;AA7B1B,oGAAA,OAAO,OAAA;AACP,qGAAA,QAAQ,OAAA;AACR,2GAAA,cAAc,OAAA;AACd,iHAAA,oBAAoB,OAAA;AACpB,mGAAA,MAAM,OAAA;AACN,oGAAA,OAAO,OAAA;AACP,qGAAA,QAAQ,OAAA;AACR,6GAAA,gBAAgB,OAAA;AAChB,gGAAA,GAAG,OAAA;AACH,mGAAA,MAAM,OAAA;AACN,kGAAA,KAAK,OAAA;AACL,uGAAA,UAAU,OAAA;AACV,yGAAA,YAAY,OAAA;AACZ,sGAAA,SAAS,OAAA;AACT,wGAAA,WAAW,OAAA;AACX,wGAAA,WAAW,OAAA;AACX,2HAAA,8BAA8B,OAAA;AAC9B,uGAAA,UAAU,OAAA;AACV,0GAAA,aAAa,OAAA;AACb,oHAAA,uBAAuB,OAAA;AACvB,yGAAA,YAAY,OAAA;AACZ,qGAAA,QAAQ,OAAA;AACR,0GAAA,aAAa,OAAA;AACb,0GAAA,aAAa,OAAA;AAEb,2EAA2E;AAC3E,oCAAoC;AACpC,2GAAA,cAAc,OAAA;AACd,6GAAA,gBAAgB,OAAA;AAIpB,+CAA+C;AAC/C,2CAGsB;AAFlB,wGAAA,UAAU,OAAA;AACV,mHAAA,qBAAqB,OAAA;AAGzB,iFAAiF;AACjF,wDAA4G;AAAnG,gHAAA,gBAAgB,OAAA;AAAE,6HAAA,6BAA6B,OAAA;AAAE,gHAAA,gBAAgB,OAAA;AAC1E,gGAAgG;AAChG,wDAIiC;AAH7B,yHAAA,yBAAyB,OAAA;AACzB,sIAAA,sCAAsC,OAAA;AACtC,oHAAA,oBAAoB,OAAA;AAGxB,yDAAmE;AAA1D,sHAAA,iBAAiB,OAAA;AAE1B,qBAAqB;AACrB,2CAKsB;AAFlB,6GAAA,eAAe,OAAA;AACf,8GAAA,gBAAgB,OAAA;AAGpB,sFAAsF;AACtF,+FAA+F;AAC/F,wDAAsD;AAA7C,2GAAA,WAAW,OAAA;AAEpB,qFAAqF;AACrF,mCAAuD;AAA9C,gGAAA,MAAM,OAAA;AAAE,oGAAA,UAAU,OAAA;AAC3B,6CAA4C;AAAnC,0GAAA,WAAW,OAAA;AACpB,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,+CAA8C;AAArC,4GAAA,YAAY,OAAA;AAErB,oFAAoF;AACpF,sFAAsF;AAEtF,kBAAkB;AAClB,iDAA4D;AAAnD,8GAAA,aAAa,OAAA;AAOtB,yCAAwD;AAA/C,sGAAA,SAAS,OAAA;AAElB,mFAAmF;AACnF,iEAAiE;AACjE,oFAAoF;AACpF,4FAA4F;AAC5F,2CAAqE;AAA5D,wGAAA,UAAU,OAAA;AAAE,wGAAA,UAAU,OAAA;AAAE,2GAAA,aAAa,OAAA;AAC9C,yCAAgD;AAAvC,oGAAA,OAAO,OAAA;AAAE,qGAAA,QAAQ,OAAA;AAC1B,6DAA4D;AAAnD,0HAAA,mBAAmB,OAAA;AAC5B,0FAA0F;AAC1F,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AAEvB,kEAAkE;AAElE,0FAA0F;AAC1F,qDAAoG;AAA3F,kHAAA,eAAe,OAAA;AAAE,yHAAA,sBAAsB,OAAA;AAEhD,8FAA8F;AAC9F,kGAAkG;AAClG,+CAAmE;AAA1D,4GAAA,YAAY,OAAA;AAAE,mHAAA,mBAAmB,OAAA;AAE1C,uBAAuB;AACvB,qDAA4E;AAAnE,kHAAA,eAAe,OAAA;AAAE,yHAAA,sBAAsB,OAAA","sourcesContent":["// Re-export API decorators from core-util for convenience\nexport {\n    ApiPath,\n    Endpoint,\n    Authentication,\n    AuthenticationConfig,\n    Public,\n    AuthJwt,\n    AuthOidc,\n    AuthSharedSecret,\n    Rpc,\n    PubSub,\n    Queue,\n    getApiPath,\n    getEndpoints,\n    isApiPath,\n    getAuthMeta,\n    getAuthMode,\n    assertEveryEndpointHasAuthMode,\n    getApiKind,\n    assertApiKind,\n    assertPubSubConventions,\n    getQueueName,\n    AuthMeta,\n    RouteMetadata,\n    METADATA_KEYS,\n    ValidateImplementation,\n    // @DocumentDesign moved to core-util (design-root marker, browser + Node);\n    // re-exported here for back-compat.\n    DocumentDesign,\n    isDocumentDesign,\n} from '@webpieces/core-util';\nexport type { AuthMode, ApiKind } from '@webpieces/core-util';\n\n// Server-side routing decorators and utilities\nexport {\n    SourceFile,\n    ROUTING_METADATA_KEYS,\n} from './decorators';\n\n// DI provider decorators moved to core-context; re-exported here for back-compat\nexport { provideSingleton, provideSingletonDefaultForApi, provideTransient } from '@webpieces/core-context';\n// Framework-only DI registry (packages/** framework classes use these; see frameworkProvide.ts)\nexport {\n    provideFrameworkSingleton,\n    provideFrameworkSingletonDefaultForApi,\n    buildFrameworkModule,\n} from '@webpieces/core-context';\n\nexport { ApiRoutingFactory, ClassType } from './ApiRoutingFactory';\n\n// Core routing types\nexport {\n    Routes,\n    RouteBuilder,\n    RouteDefinition,\n    FilterDefinition,\n} from './WebAppMeta';\n\n// The transport-neutral request type (defined in core-context; this is http-routing's\n// public request — a transport adapter builds one and the chain reads it from RequestContext).\nexport { HttpRequest } from '@webpieces/core-context';\n\n// Filter-chain primitives (absorbed from the former @webpieces/http-filters package)\nexport { Filter, WpResponse, Service } from './Filter';\nexport { FilterChain } from './FilterChain';\nexport { MethodMeta } from './MethodMeta';\nexport { RouteHandler } from './RouteHandler';\n\n// RouteBuilderImpl (the route table + chain composer) is now INTERNAL — it is never\n// handed to upper layers. The express layer consumes ApiFactory.apiClients() instead.\n\n// Filter matching\nexport { FilterMatcher, HttpFilter } from './FilterMatcher';\n\n// The app's server-surface declaration: DI binding modules + route groups + headers.\nexport { AppModules, RouteModule } from './AppModules';\n\n// The public API-surface abstraction: declare routes/filters, get them back as ApiClient[].\nexport { ApiFactory } from './ApiFactory';\nexport { ApiClient, ApiClientProxy } from './ApiClient';\n\n// Auth: the app-provided, container-bound pieces the framework AuthFilter injects.\n//  - AuthConfig: shared-secret STATE (@AuthSharedSecret values).\n//  - JwtHook / OidcHook: OPTIONAL verification mechanisms (bind only what you use).\n//  - DefaultOidcVerifier: the built-in Google OIDC verifier used when no OidcHook is bound.\nexport { AuthConfig, AuthValues, SharedSecrets } from './AuthConfig';\nexport { JwtHook, OidcHook } from './AuthHooks';\nexport { DefaultOidcVerifier } from './DefaultOidcVerifier';\n// DefaultJwtHook: batteries-included HS256 JwtHook — `new DefaultJwtHook(secret)` and go.\nexport { DefaultJwtHook } from './DefaultJwtHook';\n\n// Above-boundary context setup shared by every transport adapter.\n\n// Node-only router (the express-free heart: container + filter chain + in-process client)\nexport { WebpiecesRouter, WebpiecesRouterFactory, WebpiecesRouterOptions } from './WebpiecesRouter';\n\n// The ONE transport-free startup sequence (headers → logging → router → routes) → ApiFactory.\n// Reusable by any company/app and any framework adapter; a company wraps it with its own headers.\nexport { setupRuntime, RuntimeSetupOptions } from './setupRuntime';\n\n// Server configuration\nexport { WebpiecesConfig, WEBPIECES_CONFIG_TOKEN } from './WebpiecesConfig';\n"]}

package/src/setupRuntime.d.ts

@@ -1,27 +1,25 @@
 import { ContainerModule } from 'inversify';
 import { ContextKey, LoggerFactory } from '@webpieces/core-util';
 import { WebpiecesConfig } from './WebpiecesConfig';
-import { WebpiecesRouter } from './WebpiecesRouter';
+import { AppModules } from './AppModules';
 import { ApiFactory } from './ApiFactory';
 /**
- * RuntimeSetupOptions - inputs to {@link setupRuntime}. Data-only structure (a class, per the
- * webpieces guidelines). A company/app layer supplies its own header tiers + logger + modules;
- * the framework runs the canonical startup sequence and hands back a transport-free ApiFactory.
+ * RuntimeSetupOptions - the environment/wiring inputs to {@link setupRuntime} (everything NOT
+ * declared by the app's {@link AppModules}): the logging backend, the company/platform header
+ * tiers, the test-override module, and config. Data-only structure (a class, per the webpieces
+ * guidelines). The app's own binding modules + route groups + headers come from the AppModules
+ * passed alongside.
  *
  * Header tiers mirror {@link HeaderRegistry.configure}: platform defaults + org/company keys +
- * this-service keys.
+ * this-service keys (the this-service keys are AppModules.getHeaders()).
  */
 export declare class RuntimeSetupOptions {
     /** Logging backend to install (LogManager.setFactory). */
     readonly loggerFactory: LoggerFactory;
-    /** This service's own context keys. */
-    readonly svrHeaders: ContextKey[];
     /** Org/company-wide shared context keys (the company layer passes these in). */
     readonly companyHeaders: ContextKey[];
     /** Include the webpieces platform default headers. */
     readonly platformHeaders: boolean;
-    /** App DI ContainerModules to load. */
-    readonly modules: ContainerModule[];
     /** A single DI module loaded LAST so tests can rebind bindings to mocks. */
     readonly appOverrides?: ContainerModule | undefined;
     /** Optional WebpiecesConfig (e.g. recording flags); defaults to a fresh one. */
@@ -29,14 +27,10 @@ export declare class RuntimeSetupOptions {
     constructor(
     /** Logging backend to install (LogManager.setFactory). */
     loggerFactory: LoggerFactory, 
-    /** This service's own context keys. */
-    svrHeaders?: ContextKey[], 
     /** Org/company-wide shared context keys (the company layer passes these in). */
     companyHeaders?: ContextKey[], 
     /** Include the webpieces platform default headers. */
     platformHeaders?: boolean, 
-    /** App DI ContainerModules to load. */
-    modules?: ContainerModule[], 
     /** A single DI module loaded LAST so tests can rebind bindings to mocks. */
     appOverrides?: ContainerModule | undefined, 
     /** Optional WebpiecesConfig (e.g. recording flags); defaults to a fresh one. */
@@ -49,11 +43,11 @@ export declare class RuntimeSetupOptions {
  *
  *   1. HeaderRegistry.configure  (filters read it at construction; logging masks off it)
  *   2. LogManager.setFactory     (fails fast unless the registry is configured first)
- *   3. build the router + DI container
- *   4. run the caller's `configureRoutes(router)` block (addRoutes/addFilter)
+ *   3. build the router + DI container (from appModules.getBindingModules())
+ *   4. configure each appModules.getRoutingModules() onto the router (addRoutes/addFilter)
  *
  * and returns the built {@link ApiFactory} — `apiClients()` for a transport to bind, or
  * `createApiClient()` for in-process tests. There is NO express (or any transport) here; a
  * transport adapter (e.g. WebpiecesExpressRouter in @webpieces/http-server) serves the result.
  */
-export declare function setupRuntime(options: RuntimeSetupOptions, configureRoutes: (router: WebpiecesRouter) => void): Promise<ApiFactory>;
+export declare function setupRuntime(options: RuntimeSetupOptions, appModules: AppModules): Promise<ApiFactory>;

package/src/setupRuntime.js

@@ -6,41 +6,35 @@ const core_util_1 = require("@webpieces/core-util");
 const WebpiecesConfig_1 = require("./WebpiecesConfig");
 const WebpiecesRouter_1 = require("./WebpiecesRouter");
 /**
- * RuntimeSetupOptions - inputs to {@link setupRuntime}. Data-only structure (a class, per the
- * webpieces guidelines). A company/app layer supplies its own header tiers + logger + modules;
- * the framework runs the canonical startup sequence and hands back a transport-free ApiFactory.
+ * RuntimeSetupOptions - the environment/wiring inputs to {@link setupRuntime} (everything NOT
+ * declared by the app's {@link AppModules}): the logging backend, the company/platform header
+ * tiers, the test-override module, and config. Data-only structure (a class, per the webpieces
+ * guidelines). The app's own binding modules + route groups + headers come from the AppModules
+ * passed alongside.
  *
  * Header tiers mirror {@link HeaderRegistry.configure}: platform defaults + org/company keys +
- * this-service keys.
+ * this-service keys (the this-service keys are AppModules.getHeaders()).
  */
 class RuntimeSetupOptions {
     loggerFactory;
-    svrHeaders;
     companyHeaders;
     platformHeaders;
-    modules;
     appOverrides;
     config;
     constructor(
     /** Logging backend to install (LogManager.setFactory). */
     loggerFactory, 
-    /** This service's own context keys. */
-    svrHeaders = [], 
     /** Org/company-wide shared context keys (the company layer passes these in). */
     companyHeaders = [], 
     /** Include the webpieces platform default headers. */
     platformHeaders = true, 
-    /** App DI ContainerModules to load. */
-    modules = [], 
     /** A single DI module loaded LAST so tests can rebind bindings to mocks. */
     appOverrides, 
     /** Optional WebpiecesConfig (e.g. recording flags); defaults to a fresh one. */
     config) {
         this.loggerFactory = loggerFactory;
-        this.svrHeaders = svrHeaders;
         this.companyHeaders = companyHeaders;
         this.platformHeaders = platformHeaders;
-        this.modules = modules;
         this.appOverrides = appOverrides;
         this.config = config;
     }
@@ -53,26 +47,28 @@ exports.RuntimeSetupOptions = RuntimeSetupOptions;
  *
  *   1. HeaderRegistry.configure  (filters read it at construction; logging masks off it)
  *   2. LogManager.setFactory     (fails fast unless the registry is configured first)
- *   3. build the router + DI container
- *   4. run the caller's `configureRoutes(router)` block (addRoutes/addFilter)
+ *   3. build the router + DI container (from appModules.getBindingModules())
+ *   4. configure each appModules.getRoutingModules() onto the router (addRoutes/addFilter)
  *
  * and returns the built {@link ApiFactory} — `apiClients()` for a transport to bind, or
  * `createApiClient()` for in-process tests. There is NO express (or any transport) here; a
  * transport adapter (e.g. WebpiecesExpressRouter in @webpieces/http-server) serves the result.
  */
-async function setupRuntime(options, configureRoutes) {
-    // 1. Register the global HeaderRegistry FIRST.
-    core_util_1.HeaderRegistry.configure(options.svrHeaders, options.companyHeaders, options.platformHeaders);
+async function setupRuntime(options, appModules) {
+    // 1. Register the global HeaderRegistry FIRST (this service's own keys come from AppModules).
+    core_util_1.HeaderRegistry.configure(appModules.getHeaders(), options.companyHeaders, options.platformHeaders);
     // 2. Install the logging backend ONCE, before anything else logs.
     core_util_1.LogManager.setFactory(options.loggerFactory);
     // 3. Build the node-only router + DI container.
     const router = await WebpiecesRouter_1.WebpiecesRouterFactory.create({
-        appBindings: [...options.modules],
+        appBindings: [...appModules.getBindingModules()],
         appOverrides: options.appOverrides,
         config: options.config ?? new WebpiecesConfig_1.WebpiecesConfig(),
     });
-    // 4. Let the caller declare its routes + filters, then hand back the consumer surface.
-    configureRoutes(router);
+    // 4. Let each route group declare its routes + filters, then hand back the consumer surface.
+    for (const routeModule of appModules.getRoutingModules()) {
+        routeModule.configure(router);
+    }
     return router;
 }
 //# sourceMappingURL=setupRuntime.js.map

package/src/setupRuntime.js.map

@@ -1 +1 @@
-{"version":3,"file":"setupRuntime.js","sourceRoot":"","sources":["../../../../../packages/http/http-routing/src/setupRuntime.ts"],"names":[],"mappings":";;;AA+CA,oCAoBC;AAlED,oDAA6F;AAC7F,uDAAoD;AACpD,uDAA4E;AAG5E;;;;;;;GAOG;AACH,MAAa,mBAAmB;IAGR;IAEA;IAEA;IAEA;IAEA;IAEA;IAEA;IAdpB;IACI,0DAA0D;IAC1C,aAA4B;IAC5C,uCAAuC;IACvB,aAA2B,EAAE;IAC7C,gFAAgF;IAChE,iBAA+B,EAAE;IACjD,sDAAsD;IACtC,kBAA2B,IAAI;IAC/C,uCAAuC;IACvB,UAA6B,EAAE;IAC/C,4EAA4E;IAC5D,YAA8B;IAC9C,gFAAgF;IAChE,MAAwB;QAZxB,kBAAa,GAAb,aAAa,CAAe;QAE5B,eAAU,GAAV,UAAU,CAAmB;QAE7B,mBAAc,GAAd,cAAc,CAAmB;QAEjC,oBAAe,GAAf,eAAe,CAAgB;QAE/B,YAAO,GAAP,OAAO,CAAwB;QAE/B,iBAAY,GAAZ,YAAY,CAAkB;QAE9B,WAAM,GAAN,MAAM,CAAkB;IACzC,CAAC;CACP;AAjBD,kDAiBC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,YAAY,CAC9B,OAA4B,EAC5B,eAAkD;IAElD,+CAA+C;IAC/C,0BAAc,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAE9F,kEAAkE;IAClE,sBAAU,CAAC,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAE7C,gDAAgD;IAChD,MAAM,MAAM,GAAG,MAAM,wCAAsB,CAAC,MAAM,CAAC;QAC/C,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;QACjC,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI,iCAAe,EAAE;KAClD,CAAC,CAAC;IAEH,uFAAuF;IACvF,eAAe,CAAC,MAAM,CAAC,CAAC;IACxB,OAAO,MAAM,CAAC;AAClB,CAAC","sourcesContent":["import { ContainerModule } from 'inversify';\nimport { ContextKey, HeaderRegistry, LoggerFactory, LogManager } from '@webpieces/core-util';\nimport { WebpiecesConfig } from './WebpiecesConfig';\nimport { WebpiecesRouter, WebpiecesRouterFactory } from './WebpiecesRouter';\nimport { ApiFactory } from './ApiFactory';\n\n/**\n * RuntimeSetupOptions - inputs to {@link setupRuntime}. Data-only structure (a class, per the\n * webpieces guidelines). A company/app layer supplies its own header tiers + logger + modules;\n * the framework runs the canonical startup sequence and hands back a transport-free ApiFactory.\n *\n * Header tiers mirror {@link HeaderRegistry.configure}: platform defaults + org/company keys +\n * this-service keys.\n */\nexport class RuntimeSetupOptions {\n    constructor(\n        /** Logging backend to install (LogManager.setFactory). */\n        public readonly loggerFactory: LoggerFactory,\n        /** This service's own context keys. */\n        public readonly svrHeaders: ContextKey[] = [],\n        /** Org/company-wide shared context keys (the company layer passes these in). */\n        public readonly companyHeaders: ContextKey[] = [],\n        /** Include the webpieces platform default headers. */\n        public readonly platformHeaders: boolean = true,\n        /** App DI ContainerModules to load. */\n        public readonly modules: ContainerModule[] = [],\n        /** A single DI module loaded LAST so tests can rebind bindings to mocks. */\n        public readonly appOverrides?: ContainerModule,\n        /** Optional WebpiecesConfig (e.g. recording flags); defaults to a fresh one. */\n        public readonly config?: WebpiecesConfig,\n    ) {}\n}\n\n/**\n * setupRuntime - the ONE canonical, TRANSPORT-FREE startup sequence, reusable by any company/app\n * AND any framework adapter (express, fastify, a serverless handler, ...). It runs, in the correct\n * fail-fast order:\n *\n *   1. HeaderRegistry.configure  (filters read it at construction; logging masks off it)\n *   2. LogManager.setFactory     (fails fast unless the registry is configured first)\n *   3. build the router + DI container\n *   4. run the caller's `configureRoutes(router)` block (addRoutes/addFilter)\n *\n * and returns the built {@link ApiFactory} — `apiClients()` for a transport to bind, or\n * `createApiClient()` for in-process tests. There is NO express (or any transport) here; a\n * transport adapter (e.g. WebpiecesExpressRouter in @webpieces/http-server) serves the result.\n */\nexport async function setupRuntime(\n    options: RuntimeSetupOptions,\n    configureRoutes: (router: WebpiecesRouter) => void,\n): Promise<ApiFactory> {\n    // 1. Register the global HeaderRegistry FIRST.\n    HeaderRegistry.configure(options.svrHeaders, options.companyHeaders, options.platformHeaders);\n\n    // 2. Install the logging backend ONCE, before anything else logs.\n    LogManager.setFactory(options.loggerFactory);\n\n    // 3. Build the node-only router + DI container.\n    const router = await WebpiecesRouterFactory.create({\n        appBindings: [...options.modules],\n        appOverrides: options.appOverrides,\n        config: options.config ?? new WebpiecesConfig(),\n    });\n\n    // 4. Let the caller declare its routes + filters, then hand back the consumer surface.\n    configureRoutes(router);\n    return router;\n}\n"]}
+{"version":3,"file":"setupRuntime.js","sourceRoot":"","sources":["../../../../../packages/http/http-routing/src/setupRuntime.ts"],"names":[],"mappings":";;;AA8CA,oCAsBC;AAnED,oDAA6F;AAC7F,uDAAoD;AACpD,uDAA2D;AAI3D;;;;;;;;;GASG;AACH,MAAa,mBAAmB;IAGR;IAEA;IAEA;IAEA;IAEA;IAVpB;IACI,0DAA0D;IAC1C,aAA4B;IAC5C,gFAAgF;IAChE,iBAA+B,EAAE;IACjD,sDAAsD;IACtC,kBAA2B,IAAI;IAC/C,4EAA4E;IAC5D,YAA8B;IAC9C,gFAAgF;IAChE,MAAwB;QARxB,kBAAa,GAAb,aAAa,CAAe;QAE5B,mBAAc,GAAd,cAAc,CAAmB;QAEjC,oBAAe,GAAf,eAAe,CAAgB;QAE/B,iBAAY,GAAZ,YAAY,CAAkB;QAE9B,WAAM,GAAN,MAAM,CAAkB;IACzC,CAAC;CACP;AAbD,kDAaC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,YAAY,CAC9B,OAA4B,EAC5B,UAAsB;IAEtB,8FAA8F;IAC9F,0BAAc,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAEnG,kEAAkE;IAClE,sBAAU,CAAC,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;IAE7C,gDAAgD;IAChD,MAAM,MAAM,GAAG,MAAM,wCAAsB,CAAC,MAAM,CAAC;QAC/C,WAAW,EAAE,CAAC,GAAG,UAAU,CAAC,iBAAiB,EAAE,CAAC;QAChD,YAAY,EAAE,OAAO,CAAC,YAAY;QAClC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,IAAI,iCAAe,EAAE;KAClD,CAAC,CAAC;IAEH,6FAA6F;IAC7F,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,iBAAiB,EAAE,EAAE,CAAC;QACvD,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC","sourcesContent":["import { ContainerModule } from 'inversify';\nimport { ContextKey, HeaderRegistry, LoggerFactory, LogManager } from '@webpieces/core-util';\nimport { WebpiecesConfig } from './WebpiecesConfig';\nimport { WebpiecesRouterFactory } from './WebpiecesRouter';\nimport { AppModules } from './AppModules';\nimport { ApiFactory } from './ApiFactory';\n\n/**\n * RuntimeSetupOptions - the environment/wiring inputs to {@link setupRuntime} (everything NOT\n * declared by the app's {@link AppModules}): the logging backend, the company/platform header\n * tiers, the test-override module, and config. Data-only structure (a class, per the webpieces\n * guidelines). The app's own binding modules + route groups + headers come from the AppModules\n * passed alongside.\n *\n * Header tiers mirror {@link HeaderRegistry.configure}: platform defaults + org/company keys +\n * this-service keys (the this-service keys are AppModules.getHeaders()).\n */\nexport class RuntimeSetupOptions {\n    constructor(\n        /** Logging backend to install (LogManager.setFactory). */\n        public readonly loggerFactory: LoggerFactory,\n        /** Org/company-wide shared context keys (the company layer passes these in). */\n        public readonly companyHeaders: ContextKey[] = [],\n        /** Include the webpieces platform default headers. */\n        public readonly platformHeaders: boolean = true,\n        /** A single DI module loaded LAST so tests can rebind bindings to mocks. */\n        public readonly appOverrides?: ContainerModule,\n        /** Optional WebpiecesConfig (e.g. recording flags); defaults to a fresh one. */\n        public readonly config?: WebpiecesConfig,\n    ) {}\n}\n\n/**\n * setupRuntime - the ONE canonical, TRANSPORT-FREE startup sequence, reusable by any company/app\n * AND any framework adapter (express, fastify, a serverless handler, ...). It runs, in the correct\n * fail-fast order:\n *\n *   1. HeaderRegistry.configure  (filters read it at construction; logging masks off it)\n *   2. LogManager.setFactory     (fails fast unless the registry is configured first)\n *   3. build the router + DI container (from appModules.getBindingModules())\n *   4. configure each appModules.getRoutingModules() onto the router (addRoutes/addFilter)\n *\n * and returns the built {@link ApiFactory} — `apiClients()` for a transport to bind, or\n * `createApiClient()` for in-process tests. There is NO express (or any transport) here; a\n * transport adapter (e.g. WebpiecesExpressRouter in @webpieces/http-server) serves the result.\n */\nexport async function setupRuntime(\n    options: RuntimeSetupOptions,\n    appModules: AppModules,\n): Promise<ApiFactory> {\n    // 1. Register the global HeaderRegistry FIRST (this service's own keys come from AppModules).\n    HeaderRegistry.configure(appModules.getHeaders(), options.companyHeaders, options.platformHeaders);\n\n    // 2. Install the logging backend ONCE, before anything else logs.\n    LogManager.setFactory(options.loggerFactory);\n\n    // 3. Build the node-only router + DI container.\n    const router = await WebpiecesRouterFactory.create({\n        appBindings: [...appModules.getBindingModules()],\n        appOverrides: options.appOverrides,\n        config: options.config ?? new WebpiecesConfig(),\n    });\n\n    // 4. Let each route group declare its routes + filters, then hand back the consumer surface.\n    for (const routeModule of appModules.getRoutingModules()) {\n        routeModule.configure(router);\n    }\n    return router;\n}\n"]}