monorise 0.1.0 → 1.1.0-dev.0

package/dist/sst/.sst/platform/src/components/aws/cron-v2.d.ts

@@ -0,0 +1,325 @@
+import { ComponentResourceOptions, Output } from "@pulumi/pulumi";
+import { Component, Transform } from "../component";
+import { Function, FunctionArgs, FunctionArn } from "./function.js";
+import { Input } from "../input.js";
+import { iam, scheduler } from "@pulumi/aws";
+import { Task } from "./task";
+import { Workflow } from "./workflow.js";
+export interface CronV2Args {
+    /**
+     * The function that'll be executed when the cron job runs.
+     * @deprecated Use `function` instead.
+     *
+     * @example
+     *
+     * ```ts
+     * {
+     *   job: "src/cron.handler"
+     * }
+     * ```
+     *
+     * You can pass in the full function props.
+     *
+     * ```ts
+     * {
+     *   job: {
+     *     handler: "src/cron.handler",
+     *     timeout: "60 seconds"
+     *   }
+     * }
+     * ```
+     *
+     * You can also pass in a function ARN.
+     *
+     * ```ts
+     * {
+     *   job: "arn:aws:lambda:us-east-1:000000000000:function:my-sst-app-jayair-MyFunction",
+     * }
+     * ```
+     */
+    job?: Input<string | Workflow | Function | FunctionArgs | FunctionArn>;
+    /**
+     * The function that'll be executed when the cron job runs.
+     *
+     * @example
+     *
+     * ```ts
+     * {
+     *   function: "src/cron.handler"
+     * }
+     * ```
+     *
+     * You can pass in the full function props.
+     *
+     * ```ts
+     * {
+     *   function: {
+     *     handler: "src/cron.handler",
+     *     timeout: "60 seconds"
+     *   }
+     * }
+     * ```
+     *
+     * You can also pass in a function ARN.
+     *
+     * ```ts
+     * {
+     *   function: "arn:aws:lambda:us-east-1:000000000000:function:my-sst-app-jayair-MyFunction",
+     * }
+     * ```
+     */
+    function?: Input<string | Workflow | Function | FunctionArgs | FunctionArn>;
+    /**
+     * The task that'll be executed when the cron job runs.
+     *
+     * @example
+     *
+     * For example, let's say you have a task.
+     *
+     * ```js title="sst.config.ts"
+     * const cluster = new sst.aws.Cluster("MyCluster");
+     * const task = new sst.aws.Task("MyTask", { cluster });
+     * ```
+     *
+     * You can then pass in the task to the cron job.
+     *
+     * ```js title="sst.config.ts"
+     * new sst.aws.CronV2("MyCronJob", {
+     *   task,
+     *   schedule: "rate(1 minute)"
+     * });
+     * ```
+     *
+     */
+    task?: Task;
+    /**
+     * The event that'll be passed to the function or task.
+     *
+     * @example
+     * ```ts
+     * {
+     *   event: {
+     *     foo: "bar",
+     *   }
+     * }
+     * ```
+     *
+     * For Lambda functions, the event will be passed to the function as an event.
+     *
+     * ```ts
+     * function handler(event) {
+     *   console.log(event.foo);
+     * }
+     * ```
+     *
+     * For ECS Fargate tasks, the event will be passed to the task as the `SST_EVENT`
+     * environment variable.
+     *
+     * ```ts
+     * const event = JSON.parse(process.env.SST_EVENT);
+     * console.log(event.foo);
+     * ```
+     */
+    event?: Input<any>;
+    /**
+     * The schedule for the cron job.
+     *
+     * :::note
+     * The cron job continues to run even after you exit `sst dev`.
+     * :::
+     *
+     * @example
+     *
+     * You can use a [rate expression](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudwatchevents-expressions.html).
+     *
+     * ```ts
+     * {
+     *   schedule: "rate(5 minutes)"
+     *   // schedule: "rate(1 minute)"
+     *   // schedule: "rate(5 minutes)"
+     *   // schedule: "rate(1 hour)"
+     *   // schedule: "rate(5 hours)"
+     *   // schedule: "rate(1 day)"
+     *   // schedule: "rate(5 days)"
+     * }
+     * ```
+     * Or a [cron expression](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html#eb-cron-expressions).
+     *
+     * ```ts
+     * {
+     *   schedule: "cron(15 10 * * ? *)", // 10:15 AM (UTC) every day
+     * }
+     * ```
+     *
+     * Or an [at expression](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html#one-time) for a one-time schedule.
+     *
+     * ```ts
+     * {
+     *   schedule: "at(2025-06-01T10:00:00)",
+     * }
+     * ```
+     */
+    schedule: Input<`rate(${string})` | `cron(${string})` | `at(${string})`>;
+    /**
+     * The IANA timezone for the cron schedule. When set, the cron expression is
+     * evaluated in this timezone, with automatic DST handling.
+     *
+     * @default `"UTC"`
+     * @example
+     * ```ts
+     * {
+     *   timezone: "America/New_York"
+     * }
+     * ```
+     */
+    timezone?: Input<string>;
+    /**
+     * Configures whether the cron job is enabled. When disabled, the cron job won't run.
+     * @default true
+     * @example
+     * ```ts
+     * {
+     *   enabled: false
+     * }
+     * ```
+     */
+    enabled?: Input<boolean>;
+    /**
+     * The number of retry attempts for failed invocations. Between 0 and 185.
+     *
+     * @default `0`
+     * @example
+     * ```ts
+     * {
+     *   retries: 3
+     * }
+     * ```
+     */
+    retries?: Input<number>;
+    /**
+     * The ARN of an SQS queue to use as a dead-letter queue. When all retry
+     * attempts are exhausted, failed events are sent to this queue.
+     *
+     * @example
+     * ```ts
+     * {
+     *   dlq: myQueue.arn
+     * }
+     * ```
+     */
+    dlq?: Input<string>;
+    /**
+     * [Transform](/docs/components#transform) how this component creates its underlying resources.
+     */
+    transform?: {
+        /**
+         * Transform the EventBridge Scheduler Schedule resource.
+         */
+        schedule?: Transform<scheduler.ScheduleArgs>;
+        /**
+         * Transform the IAM Role resource.
+         */
+        role?: Transform<iam.RoleArgs>;
+    };
+}
+/**
+ * The `CronV2` component lets you add cron jobs to your app
+ * using [Amazon EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/what-is-scheduler.html). The cron job can invoke a `Function` or a container `Task`.
+ *
+ * @example
+ * #### Cron job function
+ *
+ * Pass in a `schedule` and a `function` that'll be executed.
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.CronV2("MyCronJob", {
+ *   function: "src/cron.handler",
+ *   schedule: "rate(1 minute)"
+ * });
+ * ```
+ *
+ * #### Cron job container task
+ *
+ * Create a container task and pass in a `schedule` and a `task` that'll be executed.
+ *
+ * ```ts title="sst.config.ts" {5}
+ * const cluster = new sst.aws.Cluster("MyCluster");
+ * const task = new sst.aws.Task("MyTask", { cluster });
+ *
+ * new sst.aws.CronV2("MyCronJob", {
+ *   task,
+ *   schedule: "rate(1 day)"
+ * });
+ * ```
+ *
+ * #### Set a timezone
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.CronV2("MyCronJob", {
+ *   function: "src/cron.handler",
+ *   schedule: "cron(15 10 * * ? *)",
+ *   timezone: "America/New_York"
+ * });
+ * ```
+ *
+ * #### Configure retries
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.CronV2("MyCronJob", {
+ *   function: "src/cron.handler",
+ *   schedule: "rate(1 minute)",
+ *   retries: 3
+ * });
+ * ```
+ *
+ * #### One-time schedule
+ *
+ * ```ts title="sst.config.ts"
+ * new sst.aws.CronV2("MyCronJob", {
+ *   function: "src/cron.handler",
+ *   schedule: "at(2025-06-01T10:00:00)"
+ * });
+ * ```
+ *
+ * #### Customize the function
+ *
+ * ```js title="sst.config.ts"
+ * new sst.aws.CronV2("MyCronJob", {
+ *   schedule: "rate(1 minute)",
+ *   function: {
+ *     handler: "src/cron.handler",
+ *     timeout: "60 seconds"
+ *   }
+ * });
+ * ```
+ */
+export declare class CronV2 extends Component {
+    private _name;
+    private fn?;
+    private _schedule;
+    private _role;
+    constructor(name: string, args: CronV2Args, opts?: ComponentResourceOptions);
+    /**
+     * The underlying [resources](/docs/components/#nodes) this component creates.
+     */
+    get nodes(): {
+        /**
+         * The AWS Lambda Function that'll be invoked when the cron job runs.
+         * @deprecated Use `nodes.function` instead.
+         */
+        readonly job: Output<Function>;
+        /**
+         * The AWS Lambda Function that'll be invoked when the cron job runs.
+         */
+        readonly function: Output<Function>;
+        /**
+         * The EventBridge Scheduler Schedule resource.
+         */
+        schedule: import("@pulumi/aws/scheduler/schedule").Schedule;
+        /**
+         * The IAM Role resource.
+         */
+        role: import("@pulumi/aws/iam/role").Role;
+    };
+}
+//# sourceMappingURL=cron-v2.d.ts.map

package/dist/sst/.sst/platform/src/components/aws/cron-v2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cron-v2.d.ts","sourceRoot":"","sources":["../../../../../../.sst/platform/src/components/aws/cron-v2.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,wBAAwB,EAAU,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAa,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,WAAW,UAAU;IACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;IACvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;IAC5E;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,QAAQ,EAAE,KAAK,CAAC,QAAQ,MAAM,GAAG,GAAG,QAAQ,MAAM,GAAG,GAAG,MAAM,MAAM,GAAG,CAAC,CAAC;IACzE;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACzB;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACxB;;;;;;;;;;OAUG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,QAAQ,CAAC,EAAE,SAAS,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC7C;;WAEG;QACH,IAAI,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;KAChC,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsEG;AACH,qBAAa,MAAO,SAAQ,SAAS;IACnC,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,EAAE,CAAC,CAAkB;IAC7B,OAAO,CAAC,SAAS,CAAqB;IACtC,OAAO,CAAC,KAAK,CAAW;gBAEZ,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,wBAAwB;IAgN3E;;OAEG;IACH,IAAW,KAAK;QAGZ;;;WAGG;;QAQH;;WAEG;;QAQH;;WAEG;;QAEH;;WAEG;;MAGN;CACF"}

package/dist/sst/.sst/platform/src/components/aws/cron.d.ts

@@ -1,9 +1,10 @@
 import { ComponentResourceOptions, Output } from "@pulumi/pulumi";
 import { Component, Transform } from "../component";
-import { FunctionArgs, FunctionArn } from "./function";
+import { Function, FunctionArgs, FunctionArn } from "./function.js";
 import { Input } from "../input.js";
 import { cloudwatch } from "@pulumi/aws";
 import { Task } from "./task";
+import { Workflow } from "./workflow.js";
 export interface CronArgs {
     /**
      * The function that'll be executed when the cron job runs.
@@ -36,7 +37,7 @@ export interface CronArgs {
      * }
      * ```
      */
-    job?: Input<string | FunctionArgs | FunctionArn>;
+    job?: Input<string | Workflow | Function | FunctionArgs | FunctionArn>;
     /**
      * The function that'll be executed when the cron job runs.
      *
@@ -67,7 +68,7 @@ export interface CronArgs {
      * }
      * ```
      */
-    function?: Input<string | FunctionArgs | FunctionArn>;
+    function?: Input<string | Workflow | Function | FunctionArgs | FunctionArn>;
     /**
      * The task that'll be executed when the cron job runs.
      *
@@ -119,7 +120,7 @@ export interface CronArgs {
      * console.log(event.foo);
      * ```
      */
-    event?: Input<Record<string, Input<string>>>;
+    event?: Input<any>;
     /**
      * The schedule for the cron job.
      *
@@ -177,9 +178,17 @@ export interface CronArgs {
     };
 }
 /**
+ * The `Cron` component has been deprecated. Use [`CronV2`](https://sst.dev/docs/component/aws/cron-v2) instead.
+ *
+ * :::caution
+ * This component has been deprecated.
+ * :::
+ *
  * The `Cron` component lets you add cron jobs to your app
  * using [Amazon Event Bus](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html). The cron job can invoke a `Function` or a container `Task`.
  *
+ * @deprecated Use [`CronV2`](https://sst.dev/docs/component/aws/cron-v2) instead.
+ *
  * @example
  * #### Cron job function
  *
@@ -232,11 +241,11 @@ export declare class Cron extends Component {
          * The AWS Lambda Function that'll be invoked when the cron job runs.
          * @deprecated Use `nodes.function` instead.
          */
-        readonly job: Output<sst.aws.Function>;
+        readonly job: Output<Function>;
         /**
          * The AWS Lambda Function that'll be invoked when the cron job runs.
          */
-        readonly function: Output<sst.aws.Function>;
+        readonly function: Output<Function>;
         /**
          * The EventBridge Rule resource.
          */

package/dist/sst/.sst/platform/src/components/aws/cron.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cron.d.ts","sourceRoot":"","sources":["../../../../../../.sst/platform/src/components/aws/cron.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,wBAAwB,EAAU,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAa,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,UAAU,EAAe,MAAM,aAAa,CAAC;AAEtD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAG9B,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;IACjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;IACtD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,EAAE,KAAK,CAAC,QAAQ,MAAM,GAAG,GAAG,QAAQ,MAAM,GAAG,CAAC,CAAC;IACvD;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,IAAI,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAC3C;;WAEG;QACH,MAAM,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;KAChD,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,IAAK,SAAQ,SAAS;IACjC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,EAAE,CAAC,CAAkB;IAC7B,OAAO,CAAC,IAAI,CAAuB;IACnC,OAAO,CAAC,MAAM,CAAyB;gBAE3B,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,wBAAwB;IAyJzE;;OAEG;IACH,IAAW,KAAK;QAGZ;;;WAGG;;QAQH;;WAEG;;QAQH;;WAEG;;QAEH;;WAEG;;MAGN;CACF"}
+{"version":3,"file":"cron.d.ts","sourceRoot":"","sources":["../../../../../../.sst/platform/src/components/aws/cron.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,wBAAwB,EAAU,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAa,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACpE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,UAAU,EAAe,MAAM,aAAa,CAAC;AAEtD,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,MAAM,WAAW,QAAQ;IACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;IACvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,CAAC,CAAC;IAC5E;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACH,QAAQ,EAAE,KAAK,CAAC,QAAQ,MAAM,GAAG,GAAG,QAAQ,MAAM,GAAG,CAAC,CAAC;IACvD;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;IACzB;;OAEG;IACH,SAAS,CAAC,EAAE;QACV;;WAEG;QACH,IAAI,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAC3C;;WAEG;QACH,MAAM,CAAC,EAAE,SAAS,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;KAChD,CAAC;CACH;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,qBAAa,IAAK,SAAQ,SAAS;IACjC,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,EAAE,CAAC,CAAkB;IAC7B,OAAO,CAAC,IAAI,CAAuB;IACnC,OAAO,CAAC,MAAM,CAAyB;gBAE3B,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,wBAAwB;IA0JzE;;OAEG;IACH,IAAW,KAAK;QAGZ;;;WAGG;;QAQH;;WAEG;;QAQH;;WAEG;;QAEH;;WAEG;;MAGN;CACF"}