wirejs-resources 0.1.169 → 0.1.171

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export * from './types/index.js';
 export * from './derived-types.js';
 export * from './services/realtime.js';
 export * from './resources/background-job.js';
+export * from './resources/cron-job.js';
 export * from './resources/key-value-store.js';
 export * from './resources/endpoint.js';
 export * from './resources/system-attribute.js';

package/dist/index.js

@@ -12,6 +12,7 @@ export * from './types/index.js';
 export * from './derived-types.js';
 export * from './services/realtime.js';
 export * from './resources/background-job.js';
+export * from './resources/cron-job.js';
 export * from './resources/key-value-store.js';
 export * from './resources/endpoint.js';
 export * from './resources/system-attribute.js';

package/dist/overrides.d.ts

@@ -1,5 +1,6 @@
 import type { AuthenticationService } from "./services/authentication";
 import type { BackgroundJob } from "./resources/background-job";
+import type { CronJob } from "./resources/cron-job";
 import type { DistributedTable } from "./resources/distributed-table";
 import type { Endpoint } from "./resources/endpoint";
 import type { FileService } from "./services/file";
@@ -13,6 +14,7 @@ import type { Setting } from "./resources/setting";
 export declare const overrides: {
     AuthenticationService?: typeof AuthenticationService;
     BackgroundJob?: typeof BackgroundJob;
+    CronJob?: typeof CronJob;
     DistributedTable?: typeof DistributedTable;
     Endpoint?: typeof Endpoint;
     FileService?: typeof FileService;

package/dist/resources/cron-job.d.ts

@@ -0,0 +1,28 @@
+import { Resource } from '../resource.js';
+/**
+ * A function that will be executed in the background on a recurring schedule
+ * defined by a cron expression.
+ *
+ * These MUST be created at the top-level of your application. I.e., they cannot be created
+ * dynamically in response to an API request or other event.
+ *
+ * A `CronJob` can also invoke an existing {@link BackgroundJob} from its handler.
+ *
+ * ## WARNINGS
+ *
+ * 1. These jobs execute in a completely different environment that the one that defines it.
+ * DO NOT depend on global variables, closures, or other process state that is not lazily
+ * created or constructed in-place by the script.
+ * 2. In local development, **timeouts are not enforced.** (Yet.)
+ */
+export declare class CronJob extends Resource {
+    static registeredJobs: Map<string, {
+        schedule: string;
+        handler: () => Promise<void>;
+    }>;
+    readonly schedule: string;
+    constructor(scope: Resource | string, id: string, options: {
+        schedule: string;
+        handler: () => Promise<void>;
+    });
+}

package/dist/resources/cron-job.js

@@ -0,0 +1,29 @@
+import { Resource } from '../resource.js';
+/**
+ * A function that will be executed in the background on a recurring schedule
+ * defined by a cron expression.
+ *
+ * These MUST be created at the top-level of your application. I.e., they cannot be created
+ * dynamically in response to an API request or other event.
+ *
+ * A `CronJob` can also invoke an existing {@link BackgroundJob} from its handler.
+ *
+ * ## WARNINGS
+ *
+ * 1. These jobs execute in a completely different environment that the one that defines it.
+ * DO NOT depend on global variables, closures, or other process state that is not lazily
+ * created or constructed in-place by the script.
+ * 2. In local development, **timeouts are not enforced.** (Yet.)
+ */
+export class CronJob extends Resource {
+    static registeredJobs = new Map();
+    schedule;
+    constructor(scope, id, options) {
+        super(scope, id);
+        this.schedule = options.schedule;
+        CronJob.registeredJobs.set(this.absoluteId, {
+            schedule: options.schedule,
+            handler: options.handler,
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "wirejs-resources",
-	"version": "0.1.169",
+	"version": "0.1.171",
 	"description": "Basic services and server-side resources for wirejs apps",
 	"type": "module",
 	"main": "./dist/index.js",