@geekmidas/manifest 9.1.0 → 9.2.1

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @geekmidas/manifest
 
+## 9.2.1
+
+## 9.2.0
+
+### Minor Changes
+
+- [#312](https://github.com/geekmidas/toolbox/pull/312) [`bccee5d`](https://github.com/geekmidas/toolbox/commit/bccee5d54b3675f284cd7380c8a1293fdfb6afb7) Thanks [@geekmidas](https://github.com/geekmidas)! - The manifest records each construct's monitors
+
+  Functions, crons and routes set with `.monitor()` now carry a `monitoring` list in the build manifest, so infrastructure can provision what they report to without reading the code:
+
+  ```ts
+  {
+    name: 'nightlySync',
+    schedule: 'cron(0 8 * * ? *)',
+    environment: ['MONITORING_URL'],
+    monitoring: [{ type: 'heartbeat', provider: 'betterStack', env: 'MONITORING_URL' }],
+  }
+  ```
+
+  `heartbeat.betterStack()` and `heartbeat.healthchecks()` record their provider; a custom `heartbeat()` records only its `env`, and a hand-written monitor its service name as `type`. A construct without monitors has no `monitoring` field. On the `server` provider, where one route serves the whole app, that route lists the distinct monitors across its endpoints.
+
+  A heartbeat's URL variable is now required rather than optional, so the manifest lists it as `MONITORING_URL` instead of `MONITORING_URL?` and a deploy that does not set it is caught. If it is still missing at runtime, the monitor is skipped with a warning and the run goes on.
+
 ## 9.1.0
 
 ## 9.0.2

package/dist/index.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["field: ManifestField<T> | undefined"],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Deployment manifest types — the build output of `gkm build` that enumerates a\n * project's deployable units (routes, functions, crons, subscribers, queues)\n * with the metadata an infrastructure layer needs to provision them.\n *\n * `gkm build` writes a single TypeScript module per provider\n * (`<out>/manifest/aws.ts`) of the form:\n *\n * ```ts\n * export const manifest = { routes: [...], functions: [...], ... } as const;\n * export type Route = (typeof manifest.routes)[number];\n * // ...derived types\n * ```\n *\n * This is the dependency-free data contract shared between the producer\n * (`@geekmidas/cli`) and consumers (e.g. `@geekmidas/cloud/sst`'s `fromManifest`\n * integrators).\n */\n\n/**\n * A manifest field is either a flat list or, when the build is partitioned\n * (e.g. by authorizer), an object keyed by partition name. Readonly-tolerant so\n * the `as const` generated manifest assigns cleanly.\n */\nexport type ManifestField<T> =\n\t| readonly T[]\n\t| Readonly<Record<string, readonly T[]>>;\n\n/** Flatten a manifest field (array or partitioned) into a plain array. */\nexport function flattenManifestField<T>(\n\tfield: ManifestField<T> | undefined,\n): T[] {\n\tif (!field) return [];\n\treturn Array.isArray(field)\n\t\t? [...field]\n\t\t: Object.values(field as Record<string, readonly T[]>).flat();\n}\n\n/** A single HTTP route. */\nexport interface RouteInfo {\n\t/** Route path, e.g. `/users/{id}`. */\n\tpath: string;\n\t/** HTTP method, e.g. `GET`. */\n\tmethod: string;\n\t/** Bundled handler entrypoint. */\n\thandler: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\t/** Required environment variables (a trailing `?` marks an optional var). */\n\tenvironment?: readonly string[];\n\t/** Authorizer name: `none`, `iam`, or a declared authorizer. */\n\tauthorizer: string;\n}\n\n/** A standalone Lambda function. */\nexport interface FunctionInfo {\n\tname: string;\n\thandler: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/** A scheduled (cron) function. */\nexport interface CronInfo {\n\tname: string;\n\thandler: string;\n\t/** Schedule expression, e.g. `rate(1 day)` or `cron(0 12 * * ? *)`. */\n\tschedule: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/** An event subscriber function (topic/queue resolved by `transport`). */\nexport interface SubscriberInfo {\n\tname: string;\n\thandler: string;\n\tsubscribedEvents: readonly string[];\n\t/** Delivery transport — `topic` (SNS fan-out) or `queue` (SQS). */\n\ttransport?: 'topic' | 'queue';\n\t/** The {@link TopicInfo.name} this subscriber binds to (via `s.topic(topic)`). */\n\ttopic?: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/**\n * A pub/sub topic — fan-out. A *resource* (no handler): it declares the event\n * contract; producers publish via the derived publisher and {@link SubscriberInfo}s\n * bind to it. Infra provisions an SNS topic.\n */\nexport interface TopicInfo {\n\tname: string;\n\t/** The event type names this topic carries. */\n\tevents: readonly string[];\n\t/** Whether the topic is FIFO. */\n\tfifo?: boolean;\n}\n\n/** A queue worker — a queue and its single consumer. */\nexport interface QueueInfo {\n\tname: string;\n\thandler: string;\n\t/** SQS event-source batch size. */\n\tbatchSize?: number;\n\t/** Whether the queue is FIFO. */\n\tfifo?: boolean;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/**\n * The full deployment manifest — the shape of `export const manifest` in a\n * generated `manifest/<provider>.ts`. Each field is a {@link ManifestField}\n * (flat or partitioned).\n */\nexport interface Manifest {\n\troutes: ManifestField<RouteInfo>;\n\tfunctions?: ManifestField<FunctionInfo>;\n\tcrons?: ManifestField<CronInfo>;\n\tsubscribers?: ManifestField<SubscriberInfo>;\n\tqueues?: ManifestField<QueueInfo>;\n\ttopics?: ManifestField<TopicInfo>;\n}\n"],"mappings":";;;AA6BA,SAAgB,qBACfA,OACM;AACN,MAAK,MAAO,QAAO,CAAE;AACrB,QAAO,MAAM,QAAQ,MAAM,GACxB,CAAC,GAAG,KAAM,IACV,OAAO,OAAO,MAAsC,CAAC,MAAM;AAC9D"}
+{"version":3,"file":"index.cjs","names":["field: ManifestField<T> | undefined"],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Deployment manifest types — the build output of `gkm build` that enumerates a\n * project's deployable units (routes, functions, crons, subscribers, queues)\n * with the metadata an infrastructure layer needs to provision them.\n *\n * `gkm build` writes a single TypeScript module per provider\n * (`<out>/manifest/aws.ts`) of the form:\n *\n * ```ts\n * export const manifest = { routes: [...], functions: [...], ... } as const;\n * export type Route = (typeof manifest.routes)[number];\n * // ...derived types\n * ```\n *\n * This is the dependency-free data contract shared between the producer\n * (`@geekmidas/cli`) and consumers (e.g. `@geekmidas/cloud/sst`'s `fromManifest`\n * integrators).\n */\n\n/**\n * A manifest field is either a flat list or, when the build is partitioned\n * (e.g. by authorizer), an object keyed by partition name. Readonly-tolerant so\n * the `as const` generated manifest assigns cleanly.\n */\nexport type ManifestField<T> =\n\t| readonly T[]\n\t| Readonly<Record<string, readonly T[]>>;\n\n/** Flatten a manifest field (array or partitioned) into a plain array. */\nexport function flattenManifestField<T>(\n\tfield: ManifestField<T> | undefined,\n): T[] {\n\tif (!field) return [];\n\treturn Array.isArray(field)\n\t\t? [...field]\n\t\t: Object.values(field as Record<string, readonly T[]>).flat();\n}\n\n/**\n * A monitor set with `.monitor()`, so infrastructure can provision what it\n * reports to, e.g. create a heartbeat and set its URL in `env`.\n */\nexport interface MonitorInfo {\n\t/** The kind of monitor, e.g. `heartbeat`. */\n\ttype: string;\n\t/** The service it reports to, e.g. `betterStack`. Absent for a custom one. */\n\tprovider?: string;\n\t/** The environment variable it reads its target from. */\n\tenv?: string;\n}\n\n/** A single HTTP route. */\nexport interface RouteInfo {\n\t/** Route path, e.g. `/users/{id}`. */\n\tpath: string;\n\t/** HTTP method, e.g. `GET`. */\n\tmethod: string;\n\t/** Bundled handler entrypoint. */\n\thandler: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\t/** Required environment variables (a trailing `?` marks an optional var). */\n\tenvironment?: readonly string[];\n\t/** Authorizer name: `none`, `iam`, or a declared authorizer. */\n\tauthorizer: string;\n\t/** Monitors set with `.monitor()`; absent when there are none. */\n\tmonitoring?: readonly MonitorInfo[];\n}\n\n/** A standalone Lambda function. */\nexport interface FunctionInfo {\n\tname: string;\n\thandler: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n\t/** Monitors set with `.monitor()`; absent when there are none. */\n\tmonitoring?: readonly MonitorInfo[];\n}\n\n/** A scheduled (cron) function. */\nexport interface CronInfo {\n\tname: string;\n\thandler: string;\n\t/** Schedule expression, e.g. `rate(1 day)` or `cron(0 12 * * ? *)`. */\n\tschedule: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n\t/** Monitors set with `.monitor()`; absent when there are none. */\n\tmonitoring?: readonly MonitorInfo[];\n}\n\n/** An event subscriber function (topic/queue resolved by `transport`). */\nexport interface SubscriberInfo {\n\tname: string;\n\thandler: string;\n\tsubscribedEvents: readonly string[];\n\t/** Delivery transport — `topic` (SNS fan-out) or `queue` (SQS). */\n\ttransport?: 'topic' | 'queue';\n\t/** The {@link TopicInfo.name} this subscriber binds to (via `s.topic(topic)`). */\n\ttopic?: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/**\n * A pub/sub topic — fan-out. A *resource* (no handler): it declares the event\n * contract; producers publish via the derived publisher and {@link SubscriberInfo}s\n * bind to it. Infra provisions an SNS topic.\n */\nexport interface TopicInfo {\n\tname: string;\n\t/** The event type names this topic carries. */\n\tevents: readonly string[];\n\t/** Whether the topic is FIFO. */\n\tfifo?: boolean;\n}\n\n/** A queue worker — a queue and its single consumer. */\nexport interface QueueInfo {\n\tname: string;\n\thandler: string;\n\t/** SQS event-source batch size. */\n\tbatchSize?: number;\n\t/** Whether the queue is FIFO. */\n\tfifo?: boolean;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/**\n * The full deployment manifest — the shape of `export const manifest` in a\n * generated `manifest/<provider>.ts`. Each field is a {@link ManifestField}\n * (flat or partitioned).\n */\nexport interface Manifest {\n\troutes: ManifestField<RouteInfo>;\n\tfunctions?: ManifestField<FunctionInfo>;\n\tcrons?: ManifestField<CronInfo>;\n\tsubscribers?: ManifestField<SubscriberInfo>;\n\tqueues?: ManifestField<QueueInfo>;\n\ttopics?: ManifestField<TopicInfo>;\n}\n"],"mappings":";;;AA6BA,SAAgB,qBACfA,OACM;AACN,MAAK,MAAO,QAAO,CAAE;AACrB,QAAO,MAAM,QAAQ,MAAM,GACxB,CAAC,GAAG,KAAM,IACV,OAAO,OAAO,MAAsC,CAAC,MAAM;AAC9D"}

package/dist/index.d.cts

@@ -25,6 +25,18 @@
 type ManifestField<T> = readonly T[] | Readonly<Record<string, readonly T[]>>;
 /** Flatten a manifest field (array or partitioned) into a plain array. */
 declare function flattenManifestField<T>(field: ManifestField<T> | undefined): T[];
+/**
+ * A monitor set with `.monitor()`, so infrastructure can provision what it
+ * reports to, e.g. create a heartbeat and set its URL in `env`.
+ */
+interface MonitorInfo {
+  /** The kind of monitor, e.g. `heartbeat`. */
+  type: string;
+  /** The service it reports to, e.g. `betterStack`. Absent for a custom one. */
+  provider?: string;
+  /** The environment variable it reads its target from. */
+  env?: string;
+}
 /** A single HTTP route. */
 interface RouteInfo {
   /** Route path, e.g. `/users/{id}`. */
@@ -39,6 +51,8 @@ interface RouteInfo {
   environment?: readonly string[];
   /** Authorizer name: `none`, `iam`, or a declared authorizer. */
   authorizer: string;
+  /** Monitors set with `.monitor()`; absent when there are none. */
+  monitoring?: readonly MonitorInfo[];
 }
 /** A standalone Lambda function. */
 interface FunctionInfo {
@@ -47,6 +61,8 @@ interface FunctionInfo {
   timeout?: number;
   memorySize?: number;
   environment?: readonly string[];
+  /** Monitors set with `.monitor()`; absent when there are none. */
+  monitoring?: readonly MonitorInfo[];
 }
 /** A scheduled (cron) function. */
 interface CronInfo {
@@ -57,6 +73,8 @@ interface CronInfo {
   timeout?: number;
   memorySize?: number;
   environment?: readonly string[];
+  /** Monitors set with `.monitor()`; absent when there are none. */
+  monitoring?: readonly MonitorInfo[];
 }
 /** An event subscriber function (topic/queue resolved by `transport`). */
 interface SubscriberInfo {
@@ -110,5 +128,5 @@ interface Manifest {
 }
 //# sourceMappingURL=index.d.ts.map
 //#endregion
-export { CronInfo, FunctionInfo, Manifest, ManifestField, QueueInfo, RouteInfo, SubscriberInfo, TopicInfo, flattenManifestField };
+export { CronInfo, FunctionInfo, Manifest, ManifestField, MonitorInfo, QueueInfo, RouteInfo, SubscriberInfo, TopicInfo, flattenManifestField };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;AAwBA;;;;;;AAEW;AAGX;;;;;AAEI;AAQJ;AAgBA;AASA;AAWA;AAkBA;AASA;AAiBA;;;AACS,KAhGG,aAgGH,CAAA,CAAA,CAAA,GAAA,SA/FG,CA+FH,EAAA,GA9FN,QA8FM,CA9FG,MA8FH,CAAA,MAAA,EAAA,SA9F2B,CA8F3B,EAAA,CAAA,CAAA;;AACI,iBA5FG,oBA4FH,CAAA,CAAA,CAAA,CAAA,KAAA,EA3FL,aA2FK,CA3FS,CA2FT,CAAA,GAAA,SAAA,CAAA,EA1FV,CA0FU,EAAA;;AACJ,UAnFQ,SAAA,CAmFR;EAAa;EACqB,IAA5B,EAAA,MAAA;EAAa;EACK,MAAvB,EAAA,MAAA;EAAa;EACU,OAAvB,EAAA,MAAA;EAAa,OAAA,CAAA,EAAA,MAAA;;;;;;;;UAtEN,YAAA;;;;;;;;UASA,QAAA;;;;;;;;;;UAWA,cAAA;;;;;;;;;;;;;;;;;UAkBA,SAAA;;;;;;;;UASA,SAAA;;;;;;;;;;;;;;;;UAiBA,QAAA;UACR,cAAc;cACV,cAAc;UAClB,cAAc;gBACR,cAAc;WACnB,cAAc;WACd,cAAc"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;AAwBA;;;;;;AAEW;AAGX;;;;;AAEI;AAWJ;AAUA;AAkBA;AAWA;AAaA;AAkBA;AASA;AAiBA;;AACuB,KAnHX,aAmHW,CAAA,CAAA,CAAA,GAAA,SAlHX,CAkHW,EAAA,GAjHpB,QAiHoB,CAjHX,MAiHW,CAAA,MAAA,EAAA,SAjHa,CAiHb,EAAA,CAAA,CAAA;;AACI,iBA/GX,oBA+GW,CAAA,CAAA,CAAA,CAAA,KAAA,EA9GnB,aA8GmB,CA9GL,CA8GK,CAAA,GAAA,SAAA,CAAA,EA7GxB,CA6GwB,EAAA;;;;;AAEZ,UApGE,WAAA,CAoGF;EAAa;EACK,IAAvB,EAAA,MAAA;EAAa;EACU,QAAvB,CAAA,EAAA,MAAA;EAAa;;;;UA5FN,SAAA;;;;;;;;;;;;;;wBAcM;;;UAIN,YAAA;;;;;;;wBAOM;;;UAIN,QAAA;;;;;;;;;wBASM;;;UAIN,cAAA;;;;;;;;;;;;;;;;;UAkBA,SAAA;;;;;;;;UASA,SAAA;;;;;;;;;;;;;;;;UAiBA,QAAA;UACR,cAAc;cACV,cAAc;UAClB,cAAc;gBACR,cAAc;WACnB,cAAc;WACd,cAAc"}

package/dist/index.d.mts

@@ -25,6 +25,18 @@
 type ManifestField<T> = readonly T[] | Readonly<Record<string, readonly T[]>>;
 /** Flatten a manifest field (array or partitioned) into a plain array. */
 declare function flattenManifestField<T>(field: ManifestField<T> | undefined): T[];
+/**
+ * A monitor set with `.monitor()`, so infrastructure can provision what it
+ * reports to, e.g. create a heartbeat and set its URL in `env`.
+ */
+interface MonitorInfo {
+  /** The kind of monitor, e.g. `heartbeat`. */
+  type: string;
+  /** The service it reports to, e.g. `betterStack`. Absent for a custom one. */
+  provider?: string;
+  /** The environment variable it reads its target from. */
+  env?: string;
+}
 /** A single HTTP route. */
 interface RouteInfo {
   /** Route path, e.g. `/users/{id}`. */
@@ -39,6 +51,8 @@ interface RouteInfo {
   environment?: readonly string[];
   /** Authorizer name: `none`, `iam`, or a declared authorizer. */
   authorizer: string;
+  /** Monitors set with `.monitor()`; absent when there are none. */
+  monitoring?: readonly MonitorInfo[];
 }
 /** A standalone Lambda function. */
 interface FunctionInfo {
@@ -47,6 +61,8 @@ interface FunctionInfo {
   timeout?: number;
   memorySize?: number;
   environment?: readonly string[];
+  /** Monitors set with `.monitor()`; absent when there are none. */
+  monitoring?: readonly MonitorInfo[];
 }
 /** A scheduled (cron) function. */
 interface CronInfo {
@@ -57,6 +73,8 @@ interface CronInfo {
   timeout?: number;
   memorySize?: number;
   environment?: readonly string[];
+  /** Monitors set with `.monitor()`; absent when there are none. */
+  monitoring?: readonly MonitorInfo[];
 }
 /** An event subscriber function (topic/queue resolved by `transport`). */
 interface SubscriberInfo {
@@ -110,5 +128,5 @@ interface Manifest {
 }
 //# sourceMappingURL=index.d.ts.map
 //#endregion
-export { CronInfo, FunctionInfo, Manifest, ManifestField, QueueInfo, RouteInfo, SubscriberInfo, TopicInfo, flattenManifestField };
+export { CronInfo, FunctionInfo, Manifest, ManifestField, MonitorInfo, QueueInfo, RouteInfo, SubscriberInfo, TopicInfo, flattenManifestField };
 //# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;AAwBA;;;;;;AAEW;AAGX;;;;;AAEI;AAQJ;AAgBA;AASA;AAWA;AAkBA;AASA;AAiBA;;;AACS,KAhGG,aAgGH,CAAA,CAAA,CAAA,GAAA,SA/FG,CA+FH,EAAA,GA9FN,QA8FM,CA9FG,MA8FH,CAAA,MAAA,EAAA,SA9F2B,CA8F3B,EAAA,CAAA,CAAA;;AACI,iBA5FG,oBA4FH,CAAA,CAAA,CAAA,CAAA,KAAA,EA3FL,aA2FK,CA3FS,CA2FT,CAAA,GAAA,SAAA,CAAA,EA1FV,CA0FU,EAAA;;AACJ,UAnFQ,SAAA,CAmFR;EAAa;EACqB,IAA5B,EAAA,MAAA;EAAa;EACK,MAAvB,EAAA,MAAA;EAAa;EACU,OAAvB,EAAA,MAAA;EAAa,OAAA,CAAA,EAAA,MAAA;;;;;;;;UAtEN,YAAA;;;;;;;;UASA,QAAA;;;;;;;;;;UAWA,cAAA;;;;;;;;;;;;;;;;;UAkBA,SAAA;;;;;;;;UASA,SAAA;;;;;;;;;;;;;;;;UAiBA,QAAA;UACR,cAAc;cACV,cAAc;UAClB,cAAc;gBACR,cAAc;WACnB,cAAc;WACd,cAAc"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;AAwBA;;;;;;AAEW;AAGX;;;;;AAEI;AAWJ;AAUA;AAkBA;AAWA;AAaA;AAkBA;AASA;AAiBA;;AACuB,KAnHX,aAmHW,CAAA,CAAA,CAAA,GAAA,SAlHX,CAkHW,EAAA,GAjHpB,QAiHoB,CAjHX,MAiHW,CAAA,MAAA,EAAA,SAjHa,CAiHb,EAAA,CAAA,CAAA;;AACI,iBA/GX,oBA+GW,CAAA,CAAA,CAAA,CAAA,KAAA,EA9GnB,aA8GmB,CA9GL,CA8GK,CAAA,GAAA,SAAA,CAAA,EA7GxB,CA6GwB,EAAA;;;;;AAEZ,UApGE,WAAA,CAoGF;EAAa;EACK,IAAvB,EAAA,MAAA;EAAa;EACU,QAAvB,CAAA,EAAA,MAAA;EAAa;;;;UA5FN,SAAA;;;;;;;;;;;;;;wBAcM;;;UAIN,YAAA;;;;;;;wBAOM;;;UAIN,QAAA;;;;;;;;;wBASM;;;UAIN,cAAA;;;;;;;;;;;;;;;;;UAkBA,SAAA;;;;;;;;UASA,SAAA;;;;;;;;;;;;;;;;UAiBA,QAAA;UACR,cAAc;cACV,cAAc;UAClB,cAAc;gBACR,cAAc;WACnB,cAAc;WACd,cAAc"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["field: ManifestField<T> | undefined"],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Deployment manifest types — the build output of `gkm build` that enumerates a\n * project's deployable units (routes, functions, crons, subscribers, queues)\n * with the metadata an infrastructure layer needs to provision them.\n *\n * `gkm build` writes a single TypeScript module per provider\n * (`<out>/manifest/aws.ts`) of the form:\n *\n * ```ts\n * export const manifest = { routes: [...], functions: [...], ... } as const;\n * export type Route = (typeof manifest.routes)[number];\n * // ...derived types\n * ```\n *\n * This is the dependency-free data contract shared between the producer\n * (`@geekmidas/cli`) and consumers (e.g. `@geekmidas/cloud/sst`'s `fromManifest`\n * integrators).\n */\n\n/**\n * A manifest field is either a flat list or, when the build is partitioned\n * (e.g. by authorizer), an object keyed by partition name. Readonly-tolerant so\n * the `as const` generated manifest assigns cleanly.\n */\nexport type ManifestField<T> =\n\t| readonly T[]\n\t| Readonly<Record<string, readonly T[]>>;\n\n/** Flatten a manifest field (array or partitioned) into a plain array. */\nexport function flattenManifestField<T>(\n\tfield: ManifestField<T> | undefined,\n): T[] {\n\tif (!field) return [];\n\treturn Array.isArray(field)\n\t\t? [...field]\n\t\t: Object.values(field as Record<string, readonly T[]>).flat();\n}\n\n/** A single HTTP route. */\nexport interface RouteInfo {\n\t/** Route path, e.g. `/users/{id}`. */\n\tpath: string;\n\t/** HTTP method, e.g. `GET`. */\n\tmethod: string;\n\t/** Bundled handler entrypoint. */\n\thandler: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\t/** Required environment variables (a trailing `?` marks an optional var). */\n\tenvironment?: readonly string[];\n\t/** Authorizer name: `none`, `iam`, or a declared authorizer. */\n\tauthorizer: string;\n}\n\n/** A standalone Lambda function. */\nexport interface FunctionInfo {\n\tname: string;\n\thandler: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/** A scheduled (cron) function. */\nexport interface CronInfo {\n\tname: string;\n\thandler: string;\n\t/** Schedule expression, e.g. `rate(1 day)` or `cron(0 12 * * ? *)`. */\n\tschedule: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/** An event subscriber function (topic/queue resolved by `transport`). */\nexport interface SubscriberInfo {\n\tname: string;\n\thandler: string;\n\tsubscribedEvents: readonly string[];\n\t/** Delivery transport — `topic` (SNS fan-out) or `queue` (SQS). */\n\ttransport?: 'topic' | 'queue';\n\t/** The {@link TopicInfo.name} this subscriber binds to (via `s.topic(topic)`). */\n\ttopic?: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/**\n * A pub/sub topic — fan-out. A *resource* (no handler): it declares the event\n * contract; producers publish via the derived publisher and {@link SubscriberInfo}s\n * bind to it. Infra provisions an SNS topic.\n */\nexport interface TopicInfo {\n\tname: string;\n\t/** The event type names this topic carries. */\n\tevents: readonly string[];\n\t/** Whether the topic is FIFO. */\n\tfifo?: boolean;\n}\n\n/** A queue worker — a queue and its single consumer. */\nexport interface QueueInfo {\n\tname: string;\n\thandler: string;\n\t/** SQS event-source batch size. */\n\tbatchSize?: number;\n\t/** Whether the queue is FIFO. */\n\tfifo?: boolean;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/**\n * The full deployment manifest — the shape of `export const manifest` in a\n * generated `manifest/<provider>.ts`. Each field is a {@link ManifestField}\n * (flat or partitioned).\n */\nexport interface Manifest {\n\troutes: ManifestField<RouteInfo>;\n\tfunctions?: ManifestField<FunctionInfo>;\n\tcrons?: ManifestField<CronInfo>;\n\tsubscribers?: ManifestField<SubscriberInfo>;\n\tqueues?: ManifestField<QueueInfo>;\n\ttopics?: ManifestField<TopicInfo>;\n}\n"],"mappings":";;AA6BA,SAAgB,qBACfA,OACM;AACN,MAAK,MAAO,QAAO,CAAE;AACrB,QAAO,MAAM,QAAQ,MAAM,GACxB,CAAC,GAAG,KAAM,IACV,OAAO,OAAO,MAAsC,CAAC,MAAM;AAC9D"}
+{"version":3,"file":"index.mjs","names":["field: ManifestField<T> | undefined"],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Deployment manifest types — the build output of `gkm build` that enumerates a\n * project's deployable units (routes, functions, crons, subscribers, queues)\n * with the metadata an infrastructure layer needs to provision them.\n *\n * `gkm build` writes a single TypeScript module per provider\n * (`<out>/manifest/aws.ts`) of the form:\n *\n * ```ts\n * export const manifest = { routes: [...], functions: [...], ... } as const;\n * export type Route = (typeof manifest.routes)[number];\n * // ...derived types\n * ```\n *\n * This is the dependency-free data contract shared between the producer\n * (`@geekmidas/cli`) and consumers (e.g. `@geekmidas/cloud/sst`'s `fromManifest`\n * integrators).\n */\n\n/**\n * A manifest field is either a flat list or, when the build is partitioned\n * (e.g. by authorizer), an object keyed by partition name. Readonly-tolerant so\n * the `as const` generated manifest assigns cleanly.\n */\nexport type ManifestField<T> =\n\t| readonly T[]\n\t| Readonly<Record<string, readonly T[]>>;\n\n/** Flatten a manifest field (array or partitioned) into a plain array. */\nexport function flattenManifestField<T>(\n\tfield: ManifestField<T> | undefined,\n): T[] {\n\tif (!field) return [];\n\treturn Array.isArray(field)\n\t\t? [...field]\n\t\t: Object.values(field as Record<string, readonly T[]>).flat();\n}\n\n/**\n * A monitor set with `.monitor()`, so infrastructure can provision what it\n * reports to, e.g. create a heartbeat and set its URL in `env`.\n */\nexport interface MonitorInfo {\n\t/** The kind of monitor, e.g. `heartbeat`. */\n\ttype: string;\n\t/** The service it reports to, e.g. `betterStack`. Absent for a custom one. */\n\tprovider?: string;\n\t/** The environment variable it reads its target from. */\n\tenv?: string;\n}\n\n/** A single HTTP route. */\nexport interface RouteInfo {\n\t/** Route path, e.g. `/users/{id}`. */\n\tpath: string;\n\t/** HTTP method, e.g. `GET`. */\n\tmethod: string;\n\t/** Bundled handler entrypoint. */\n\thandler: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\t/** Required environment variables (a trailing `?` marks an optional var). */\n\tenvironment?: readonly string[];\n\t/** Authorizer name: `none`, `iam`, or a declared authorizer. */\n\tauthorizer: string;\n\t/** Monitors set with `.monitor()`; absent when there are none. */\n\tmonitoring?: readonly MonitorInfo[];\n}\n\n/** A standalone Lambda function. */\nexport interface FunctionInfo {\n\tname: string;\n\thandler: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n\t/** Monitors set with `.monitor()`; absent when there are none. */\n\tmonitoring?: readonly MonitorInfo[];\n}\n\n/** A scheduled (cron) function. */\nexport interface CronInfo {\n\tname: string;\n\thandler: string;\n\t/** Schedule expression, e.g. `rate(1 day)` or `cron(0 12 * * ? *)`. */\n\tschedule: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n\t/** Monitors set with `.monitor()`; absent when there are none. */\n\tmonitoring?: readonly MonitorInfo[];\n}\n\n/** An event subscriber function (topic/queue resolved by `transport`). */\nexport interface SubscriberInfo {\n\tname: string;\n\thandler: string;\n\tsubscribedEvents: readonly string[];\n\t/** Delivery transport — `topic` (SNS fan-out) or `queue` (SQS). */\n\ttransport?: 'topic' | 'queue';\n\t/** The {@link TopicInfo.name} this subscriber binds to (via `s.topic(topic)`). */\n\ttopic?: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/**\n * A pub/sub topic — fan-out. A *resource* (no handler): it declares the event\n * contract; producers publish via the derived publisher and {@link SubscriberInfo}s\n * bind to it. Infra provisions an SNS topic.\n */\nexport interface TopicInfo {\n\tname: string;\n\t/** The event type names this topic carries. */\n\tevents: readonly string[];\n\t/** Whether the topic is FIFO. */\n\tfifo?: boolean;\n}\n\n/** A queue worker — a queue and its single consumer. */\nexport interface QueueInfo {\n\tname: string;\n\thandler: string;\n\t/** SQS event-source batch size. */\n\tbatchSize?: number;\n\t/** Whether the queue is FIFO. */\n\tfifo?: boolean;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n}\n\n/**\n * The full deployment manifest — the shape of `export const manifest` in a\n * generated `manifest/<provider>.ts`. Each field is a {@link ManifestField}\n * (flat or partitioned).\n */\nexport interface Manifest {\n\troutes: ManifestField<RouteInfo>;\n\tfunctions?: ManifestField<FunctionInfo>;\n\tcrons?: ManifestField<CronInfo>;\n\tsubscribers?: ManifestField<SubscriberInfo>;\n\tqueues?: ManifestField<QueueInfo>;\n\ttopics?: ManifestField<TopicInfo>;\n}\n"],"mappings":";;AA6BA,SAAgB,qBACfA,OACM;AACN,MAAK,MAAO,QAAO,CAAE;AACrB,QAAO,MAAM,QAAQ,MAAM,GACxB,CAAC,GAAG,KAAM,IACV,OAAO,OAAO,MAAsC,CAAC,MAAM;AAC9D"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geekmidas/manifest",
-  "version": "9.1.0",
+  "version": "9.2.1",
   "type": "module",
   "exports": {
     ".": {

package/src/index.ts

@@ -36,6 +36,19 @@ export function flattenManifestField<T>(
 		: Object.values(field as Record<string, readonly T[]>).flat();
 }
 
+/**
+ * A monitor set with `.monitor()`, so infrastructure can provision what it
+ * reports to, e.g. create a heartbeat and set its URL in `env`.
+ */
+export interface MonitorInfo {
+	/** The kind of monitor, e.g. `heartbeat`. */
+	type: string;
+	/** The service it reports to, e.g. `betterStack`. Absent for a custom one. */
+	provider?: string;
+	/** The environment variable it reads its target from. */
+	env?: string;
+}
+
 /** A single HTTP route. */
 export interface RouteInfo {
 	/** Route path, e.g. `/users/{id}`. */
@@ -50,6 +63,8 @@ export interface RouteInfo {
 	environment?: readonly string[];
 	/** Authorizer name: `none`, `iam`, or a declared authorizer. */
 	authorizer: string;
+	/** Monitors set with `.monitor()`; absent when there are none. */
+	monitoring?: readonly MonitorInfo[];
 }
 
 /** A standalone Lambda function. */
@@ -59,6 +74,8 @@ export interface FunctionInfo {
 	timeout?: number;
 	memorySize?: number;
 	environment?: readonly string[];
+	/** Monitors set with `.monitor()`; absent when there are none. */
+	monitoring?: readonly MonitorInfo[];
 }
 
 /** A scheduled (cron) function. */
@@ -70,6 +87,8 @@ export interface CronInfo {
 	timeout?: number;
 	memorySize?: number;
 	environment?: readonly string[];
+	/** Monitors set with `.monitor()`; absent when there are none. */
+	monitoring?: readonly MonitorInfo[];
 }
 
 /** An event subscriber function (topic/queue resolved by `transport`). */