@geekmidas/manifest 9.3.0 → 9.4.0

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @geekmidas/manifest
 
+## 9.4.0
+
+### Minor Changes
+
+- [#334](https://github.com/geekmidas/toolbox/pull/334) [`b03c43d`](https://github.com/geekmidas/toolbox/commit/b03c43dfd2c86b1daa7f0a47f43e5fb2e518518b) Thanks [@geekmidas](https://github.com/geekmidas)! - Crons report to an uptime monitor with `.uptime()`, which replaces `.monitor()`
+
+  **Breaking:** `.monitor()` is removed from functions, crons, endpoints and `EndpointFactory`, along with the monitor hooks in the endpoint adaptors. The manifest's `monitoring` field is removed from routes, functions and crons.
+
+  A monitor only adds something a cron can't report itself: that it didn't run. A function or endpoint runs when it's called, so no ping is ever due, and its failures are already logged where they happen. So uptime is now set on crons alone:
+
+  ```ts
+  export const nightlyReport = c
+    .schedule("cron(0 8 * * MON-FRI)")
+    .uptime(heartbeat.betterStack("MONITORING_URL"))
+    .handle(async () => {});
+  ```
+
+  Calling `.uptime()` again replaces the monitor. `gkm build` records it on the cron's manifest entry as `uptime`, with the period the heartbeat should expect, derived from the schedule by `cronPeriod`:
+
+  ```ts
+  uptime: { type: 'heartbeat', provider: 'betterStack', env: 'MONITORING_URL', period: 259200 }
+  ```
+
+  `MonitorInfo` in `@geekmidas/manifest` is replaced by `UptimeInfo`.
+
 ## 9.3.0
 
 ### Minor Changes

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/**\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\nexport * from './cron';\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 cron's uptime monitor, set with `.uptime()`, so infrastructure can create\n * what it reports to, e.g. a heartbeat whose URL it sets in `env`.\n */\nexport interface UptimeInfo {\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\t/**\n\t * The longest gap between runs of the cron's schedule, in seconds: how\n\t * often the monitor should expect to hear from it (see `cronPeriod`).\n\t */\n\tperiod: number;\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, always the six-field AWS form, e.g. `cron(0 12 * * ? *)`. */\n\tschedule: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n\t/** Set with `.uptime()`; absent when the cron has none. */\n\tuptime?: UptimeInfo;\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\nexport * from './cron';\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

@@ -29,16 +29,21 @@ 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`.
+ * A cron's uptime monitor, set with `.uptime()`, so infrastructure can create
+ * what it reports to, e.g. a heartbeat whose URL it sets in `env`.
  */
-interface MonitorInfo {
+interface UptimeInfo {
   /** 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;
+  /**
+   * The longest gap between runs of the cron's schedule, in seconds: how
+   * often the monitor should expect to hear from it (see `cronPeriod`).
+   */
+  period: number;
 }
 /** A single HTTP route. */
 interface RouteInfo {
@@ -54,8 +59,6 @@ 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 {
@@ -64,20 +67,18 @@ 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 {
   name: string;
   handler: string;
-  /** Schedule expression, e.g. `rate(1 day)` or `cron(0 12 * * ? *)`. */
+  /** Schedule, always the six-field AWS form, e.g. `cron(0 12 * * ? *)`. */
   schedule: string;
   timeout?: number;
   memorySize?: number;
   environment?: readonly string[];
-  /** Monitors set with `.monitor()`; absent when there are none. */
-  monitoring?: readonly MonitorInfo[];
+  /** Set with `.uptime()`; absent when the cron has none. */
+  uptime?: UptimeInfo;
 }
 /** An event subscriber function (topic/queue resolved by `transport`). */
 interface SubscriberInfo {
@@ -130,5 +131,5 @@ interface Manifest {
   topics?: ManifestField<TopicInfo>;
 }
 //#endregion
-export { CronConversion, CronConversionWarning, CronDialect, CronField, CronInfo, CronPeriodError, FunctionInfo, InvalidCronExpressionError, Manifest, ManifestField, MonitorInfo, ParsedCron, QueueInfo, RouteInfo, SubscriberInfo, TopicInfo, UnconvertibleCronExpressionError, cronPeriod, flattenManifestField, parseCron, toAwsCron, toUnixCron };
+export { CronConversion, CronConversionWarning, CronDialect, CronField, CronInfo, CronPeriodError, FunctionInfo, InvalidCronExpressionError, Manifest, ManifestField, ParsedCron, QueueInfo, RouteInfo, SubscriberInfo, TopicInfo, UnconvertibleCronExpressionError, UptimeInfo, cronPeriod, flattenManifestField, parseCron, toAwsCron, toUnixCron };
 //# 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;AAWJ;AAUA;AAkBA;AAWA;AAaA;AAkBA;AASA;AAiBiB,KAlHL,aAkHa,CAAA,CAAA,CAAA,GAAA,SAjHb,CAiHa,EAAA,GAhHtB,QAgHsB,CAhHb,MAgHa,CAAA,MAAA,EAAA,SAhHW,CAgHX,EAAA,CAAA,CAAA;;AACF,iBA9GP,oBA8GO,CAAA,CAAA,CAAA,CAAA,KAAA,EA7Gf,aA6Ge,CA7GD,CA6GC,CAAA,GAAA,SAAA,CAAA,EA5GpB,CA4GoB,EAAA;;;;;AAEd,UAnGQ,WAAA,CAmGR;EAAa;EACqB,IAA5B,EAAA,MAAA;EAAa;EACK,QAAvB,CAAA,EAAA,MAAA;EAAa;EACU,GAAvB,CAAA,EAAA,MAAA;AAAa;;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"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;AAwBA;;;;;;AAEW;AAGX;;;;;AAEI;AAWJ;AAeA;AAgBA;AASA;AAaA;AAkBA;AASA;AAiBiB,KAnHL,aAmHa,CAAA,CAAA,CAAA,GAAA,SAlHb,CAkHa,EAAA,GAjHtB,QAiHsB,CAjHb,MAiHa,CAAA,MAAA,EAAA,SAjHW,CAiHX,EAAA,CAAA,CAAA;;AACF,iBA/GP,oBA+GO,CAAA,CAAA,CAAA,CAAA,KAAA,EA9Gf,aA8Ge,CA9GD,CA8GC,CAAA,GAAA,SAAA,CAAA,EA7GpB,CA6GoB,EAAA;;;;;AAEd,UApGQ,UAAA,CAoGR;EAAa;EACqB,IAA5B,EAAA,MAAA;EAAa;EACK,QAAvB,CAAA,EAAA,MAAA;EAAa;EACU,GAAvB,CAAA,EAAA,MAAA;EAAa;;;;;;;UAxFN,SAAA;;;;;;;;;;;;;;;UAgBA,YAAA;;;;;;;;UASA,QAAA;;;;;;;;;WASP;;;UAIO,cAAA;;;;;;;;;;;;;;;;;UAkBA,SAAA;;;;;;;;UASA,SAAA;;;;;;;;;;;;;;;;UAiBA,QAAA;UACR,cAAc;cACV,cAAc;UAClB,cAAc;gBACR,cAAc;WACnB,cAAc;WACd,cAAc"}

package/dist/index.d.mts

@@ -29,16 +29,21 @@ 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`.
+ * A cron's uptime monitor, set with `.uptime()`, so infrastructure can create
+ * what it reports to, e.g. a heartbeat whose URL it sets in `env`.
  */
-interface MonitorInfo {
+interface UptimeInfo {
   /** 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;
+  /**
+   * The longest gap between runs of the cron's schedule, in seconds: how
+   * often the monitor should expect to hear from it (see `cronPeriod`).
+   */
+  period: number;
 }
 /** A single HTTP route. */
 interface RouteInfo {
@@ -54,8 +59,6 @@ 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 {
@@ -64,20 +67,18 @@ 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 {
   name: string;
   handler: string;
-  /** Schedule expression, e.g. `rate(1 day)` or `cron(0 12 * * ? *)`. */
+  /** Schedule, always the six-field AWS form, e.g. `cron(0 12 * * ? *)`. */
   schedule: string;
   timeout?: number;
   memorySize?: number;
   environment?: readonly string[];
-  /** Monitors set with `.monitor()`; absent when there are none. */
-  monitoring?: readonly MonitorInfo[];
+  /** Set with `.uptime()`; absent when the cron has none. */
+  uptime?: UptimeInfo;
 }
 /** An event subscriber function (topic/queue resolved by `transport`). */
 interface SubscriberInfo {
@@ -130,5 +131,5 @@ interface Manifest {
   topics?: ManifestField<TopicInfo>;
 }
 //#endregion
-export { CronConversion, CronConversionWarning, CronDialect, CronField, CronInfo, CronPeriodError, FunctionInfo, InvalidCronExpressionError, Manifest, ManifestField, MonitorInfo, ParsedCron, QueueInfo, RouteInfo, SubscriberInfo, TopicInfo, UnconvertibleCronExpressionError, cronPeriod, flattenManifestField, parseCron, toAwsCron, toUnixCron };
+export { CronConversion, CronConversionWarning, CronDialect, CronField, CronInfo, CronPeriodError, FunctionInfo, InvalidCronExpressionError, Manifest, ManifestField, ParsedCron, QueueInfo, RouteInfo, SubscriberInfo, TopicInfo, UnconvertibleCronExpressionError, UptimeInfo, cronPeriod, flattenManifestField, parseCron, toAwsCron, toUnixCron };
 //# 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;AAWJ;AAUA;AAkBA;AAWA;AAaA;AAkBA;AASA;AAiBiB,KAlHL,aAkHa,CAAA,CAAA,CAAA,GAAA,SAjHb,CAiHa,EAAA,GAhHtB,QAgHsB,CAhHb,MAgHa,CAAA,MAAA,EAAA,SAhHW,CAgHX,EAAA,CAAA,CAAA;;AACF,iBA9GP,oBA8GO,CAAA,CAAA,CAAA,CAAA,KAAA,EA7Gf,aA6Ge,CA7GD,CA6GC,CAAA,GAAA,SAAA,CAAA,EA5GpB,CA4GoB,EAAA;;;;;AAEd,UAnGQ,WAAA,CAmGR;EAAa;EACqB,IAA5B,EAAA,MAAA;EAAa;EACK,QAAvB,CAAA,EAAA,MAAA;EAAa;EACU,GAAvB,CAAA,EAAA,MAAA;AAAa;;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"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;AAwBA;;;;;;AAEW;AAGX;;;;;AAEI;AAWJ;AAeA;AAgBA;AASA;AAaA;AAkBA;AASA;AAiBiB,KAnHL,aAmHa,CAAA,CAAA,CAAA,GAAA,SAlHb,CAkHa,EAAA,GAjHtB,QAiHsB,CAjHb,MAiHa,CAAA,MAAA,EAAA,SAjHW,CAiHX,EAAA,CAAA,CAAA;;AACF,iBA/GP,oBA+GO,CAAA,CAAA,CAAA,CAAA,KAAA,EA9Gf,aA8Ge,CA9GD,CA8GC,CAAA,GAAA,SAAA,CAAA,EA7GpB,CA6GoB,EAAA;;;;;AAEd,UApGQ,UAAA,CAoGR;EAAa;EACqB,IAA5B,EAAA,MAAA;EAAa;EACK,QAAvB,CAAA,EAAA,MAAA;EAAa;EACU,GAAvB,CAAA,EAAA,MAAA;EAAa;;;;;;;UAxFN,SAAA;;;;;;;;;;;;;;;UAgBA,YAAA;;;;;;;;UASA,QAAA;;;;;;;;;WASP;;;UAIO,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/**\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\nexport * from './cron';\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 cron's uptime monitor, set with `.uptime()`, so infrastructure can create\n * what it reports to, e.g. a heartbeat whose URL it sets in `env`.\n */\nexport interface UptimeInfo {\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\t/**\n\t * The longest gap between runs of the cron's schedule, in seconds: how\n\t * often the monitor should expect to hear from it (see `cronPeriod`).\n\t */\n\tperiod: number;\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, always the six-field AWS form, e.g. `cron(0 12 * * ? *)`. */\n\tschedule: string;\n\ttimeout?: number;\n\tmemorySize?: number;\n\tenvironment?: readonly string[];\n\t/** Set with `.uptime()`; absent when the cron has none. */\n\tuptime?: UptimeInfo;\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\nexport * from './cron';\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.3.0",
+  "version": "9.4.0",
   "type": "module",
   "exports": {
     ".": {

package/src/index.ts

@@ -37,16 +37,21 @@ export function flattenManifestField<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`.
+ * A cron's uptime monitor, set with `.uptime()`, so infrastructure can create
+ * what it reports to, e.g. a heartbeat whose URL it sets in `env`.
  */
-export interface MonitorInfo {
+export interface UptimeInfo {
 	/** 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;
+	/**
+	 * The longest gap between runs of the cron's schedule, in seconds: how
+	 * often the monitor should expect to hear from it (see `cronPeriod`).
+	 */
+	period: number;
 }
 
 /** A single HTTP route. */
@@ -63,8 +68,6 @@ 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. */
@@ -74,21 +77,19 @@ 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. */
 export interface CronInfo {
 	name: string;
 	handler: string;
-	/** Schedule expression, e.g. `rate(1 day)` or `cron(0 12 * * ? *)`. */
+	/** Schedule, always the six-field AWS form, e.g. `cron(0 12 * * ? *)`. */
 	schedule: string;
 	timeout?: number;
 	memorySize?: number;
 	environment?: readonly string[];
-	/** Monitors set with `.monitor()`; absent when there are none. */
-	monitoring?: readonly MonitorInfo[];
+	/** Set with `.uptime()`; absent when the cron has none. */
+	uptime?: UptimeInfo;
 }
 
 /** An event subscriber function (topic/queue resolved by `transport`). */