@devvit/scheduler 0.11.17-next-2025-05-29-56029c461.0

package/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2023 Reddit Inc.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

package/README.md

@@ -0,0 +1,5 @@
+# @devvit/scheduler
+
+Contains a Scheduler client for use with the Devvit framework.
+
+Sign up for Reddit's Developer Platform [here!](https://developers.reddit.com)

package/SchedulerClient.d.ts

@@ -0,0 +1,10 @@
+import type { Scheduler as SchedulerPlugin } from '@devvit/protos';
+import type { ScheduledCronJob, ScheduledCronJobOptions, ScheduledJob, ScheduledJobOptions, Scheduler } from './types/scheduler.js';
+export declare class SchedulerClient implements Scheduler {
+    #private;
+    constructor(schedulerPlugin: SchedulerPlugin);
+    runJob(job: ScheduledJobOptions | ScheduledCronJobOptions): Promise<string>;
+    cancelJob(jobId: string): Promise<void>;
+    listJobs(): Promise<(ScheduledJob | ScheduledCronJob)[]>;
+}
+//# sourceMappingURL=SchedulerClient.d.ts.map

package/SchedulerClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SchedulerClient.d.ts","sourceRoot":"","sources":["../src/SchedulerClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAY,SAAS,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAK7E,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EACvB,YAAY,EACZ,mBAAmB,EACnB,SAAS,EACV,MAAM,sBAAsB,CAAC;AAE9B,qBAAa,eAAgB,YAAW,SAAS;;gBAGnC,eAAe,EAAE,eAAe;IAItC,MAAM,CAAC,GAAG,EAAE,mBAAmB,GAAG,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;IAgB3E,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASvC,QAAQ,IAAI,OAAO,CAAC,CAAC,YAAY,GAAG,gBAAgB,CAAC,EAAE,CAAC;CAsC/D"}

package/SchedulerClient.js

@@ -0,0 +1,69 @@
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _SchedulerClient_instances, _SchedulerClient_schedulerPlugin, _SchedulerClient_metadata_get;
+import { getContext } from '@devvit/server';
+import { assertNonNull } from '@devvit/shared-types/NonNull.js';
+export class SchedulerClient {
+    constructor(schedulerPlugin) {
+        _SchedulerClient_instances.add(this);
+        _SchedulerClient_schedulerPlugin.set(this, void 0);
+        __classPrivateFieldSet(this, _SchedulerClient_schedulerPlugin, schedulerPlugin, "f");
+    }
+    async runJob(job) {
+        const response = await __classPrivateFieldGet(this, _SchedulerClient_schedulerPlugin, "f").Schedule({
+            action: {
+                type: job.name,
+                data: job.data,
+            },
+            cron: 'cron' in job ? job.cron : undefined,
+            when: 'runAt' in job ? job.runAt : undefined,
+        }, __classPrivateFieldGet(this, _SchedulerClient_instances, "a", _SchedulerClient_metadata_get));
+        return response.id;
+    }
+    async cancelJob(jobId) {
+        await __classPrivateFieldGet(this, _SchedulerClient_schedulerPlugin, "f").Cancel({
+            id: jobId,
+        }, __classPrivateFieldGet(this, _SchedulerClient_instances, "a", _SchedulerClient_metadata_get));
+    }
+    async listJobs() {
+        const response = await __classPrivateFieldGet(this, _SchedulerClient_schedulerPlugin, "f").List(
+        /**
+         * after and before are required for this API to work
+         * so we hardcode after to Unix epoch and before to 10 years from now
+         * https://reddit.atlassian.net/browse/DX-3060
+         */
+        {
+            after: new Date(0),
+            before: new Date(Date.now() + 10 * 365 * 86400 * 1000),
+        }, __classPrivateFieldGet(this, _SchedulerClient_instances, "a", _SchedulerClient_metadata_get));
+        return response.actions.map((action) => {
+            assertNonNull(action.request?.action, 'Scheduled job is malformed');
+            if ('when' in action.request && action.request.when != null) {
+                return {
+                    id: action.id,
+                    name: action.request.action.type,
+                    runAt: action.request.when,
+                    data: action.request.action.data,
+                };
+            }
+            return {
+                id: action.id,
+                name: action.request.action.type,
+                cron: action.request.cron ?? '',
+                data: action.request.action,
+            };
+        });
+    }
+}
+_SchedulerClient_schedulerPlugin = new WeakMap(), _SchedulerClient_instances = new WeakSet(), _SchedulerClient_metadata_get = function _SchedulerClient_metadata_get() {
+    return getContext().debug.metadata;
+};

package/getScheduler.d.ts

@@ -0,0 +1,3 @@
+import { SchedulerClient } from './SchedulerClient.js';
+export declare function getScheduler(): SchedulerClient;
+//# sourceMappingURL=getScheduler.d.ts.map

package/getScheduler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getScheduler.d.ts","sourceRoot":"","sources":["../src/getScheduler.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAIvD,wBAAgB,YAAY,IAAI,eAAe,CAM9C"}

package/getScheduler.js

@@ -0,0 +1,10 @@
+import { SchedulerDefinition } from '@devvit/protos';
+import { getDevvitConfig } from '@devvit/server/get-devvit-config.js';
+import { SchedulerClient } from './SchedulerClient.js';
+let schedulerPlugin;
+export function getScheduler() {
+    if (!schedulerPlugin) {
+        schedulerPlugin = getDevvitConfig().use(SchedulerDefinition);
+    }
+    return new SchedulerClient(schedulerPlugin);
+}

package/index.d.ts

@@ -0,0 +1,3 @@
+export { getScheduler } from './getScheduler.js';
+export type { SchedulerClient } from './SchedulerClient.js';
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC"}

package/index.js

@@ -0,0 +1 @@
+export { getScheduler } from './getScheduler.js';

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@devvit/scheduler",
+  "version": "0.11.17-next-2025-05-29-56029c461.0",
+  "license": "BSD-3-Clause",
+  "repository": {
+    "type": "git",
+    "url": "https://developers.reddit.com/"
+  },
+  "type": "module",
+  "main": "./index.js",
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf .turbo coverage dist",
+    "clobber": "yarn clean && rm -rf node_modules",
+    "dev": "tsc -w",
+    "lint": "redlint .",
+    "lint:fix": "yarn lint --fix",
+    "prepublishOnly": "publish-package-json",
+    "test": "yarn test:types && yarn lint",
+    "test:types": "tsc --noEmit"
+  },
+  "types": "./index.d.ts",
+  "dependencies": {
+    "@devvit/protos": "0.11.17-next-2025-05-29-56029c461.0",
+    "@devvit/shared-types": "0.11.17-next-2025-05-29-56029c461.0"
+  },
+  "peerDependencies": {
+    "@devvit/server": "*"
+  },
+  "devDependencies": {
+    "@devvit/repo-tools": "0.11.17-next-2025-05-29-56029c461.0",
+    "@devvit/server": "0.11.17-next-2025-05-29-56029c461.0",
+    "@devvit/tsconfig": "0.11.17-next-2025-05-29-56029c461.0",
+    "eslint": "9.11.1",
+    "typescript": "5.8.3"
+  },
+  "publishConfig": {
+    "directory": "dist"
+  },
+  "source": "./src/index.ts",
+  "gitHead": "5b71a6e7c2128ed851dcc90ec38b6f475fef42b1"
+}

package/types/scheduler.d.ts

@@ -0,0 +1,83 @@
+import type { JSONObject } from '@devvit/shared-types/json.js';
+export type ScheduledJob = {
+    /** ID of the scheduled job. Use this with scheduler.cancelJob to cancel the job. */
+    id: string;
+    /** The name of the scheduled job type */
+    name: string;
+    /** Additional data passed in by the scheduler client */
+    data: JSONObject | undefined;
+    /** The Date of when this job should run */
+    runAt: Date;
+};
+export type ScheduledCronJob = {
+    /** ID of the scheduled job. Use this with scheduler.cancelJob to cancel the job. */
+    id: string;
+    /** The name of the scheduled job type */
+    name: string;
+    /** Additional data passed in by the scheduler client */
+    data?: JSONObject | undefined;
+    /** The cron string of when this job should run */
+    cron: string;
+};
+export type ScheduledJobOptions<T extends JSONObject | undefined = JSONObject | undefined> = {
+    /** The name of the scheduled job type */
+    name: string;
+    /** Additional data passed in by the scheduler client */
+    data?: T;
+    /** The Date of when this job should run */
+    runAt: Date;
+};
+export type ScheduledCronJobOptions<T extends JSONObject | undefined = JSONObject | undefined> = {
+    /** The name of the scheduled job type */
+    name: string;
+    /** Additional data passed in by the scheduler client */
+    data?: T;
+    /** The cron string of when this job should run */
+    cron: string;
+};
+/**
+ * Schedule a new job to run at a specific time or on a cron schedule
+ * @param job The job to schedule
+ * @returns {string} The id of the scheduled job
+ */
+export type RunJob<Data extends JSONObject | undefined> = (job: ScheduledJobOptions<Data> | ScheduledCronJobOptions<Data>) => Promise<string>;
+/**
+ * Cancel a scheduled job
+ * @param jobId The id of the job to cancel
+ */
+export type CancelJob = (jobId: string) => Promise<void>;
+/**
+ * The Scheduler client lets you schedule new jobs or cancel existing jobs.
+ * You must have the `scheduler` enabled in `Devvit.configure` to use this client.
+ */
+export type Scheduler = {
+    /**
+     * Schedule a new job to run at a specific time or on a cron schedule
+     * @param job The job to schedule
+     * @returns {} The id of the scheduled job
+     */
+    runJob: <Data extends JSONObject | undefined>(job: ScheduledJobOptions<Data> | ScheduledCronJobOptions<Data>) => Promise<string>;
+    /**
+     * Cancel a scheduled job
+     * @param jobId The id of the job to cancel
+     */
+    cancelJob: CancelJob;
+    /**
+     * Gets the list of all scheduled jobs.
+     */
+    listJobs: () => Promise<(ScheduledJob | ScheduledCronJob)[]>;
+};
+export type ScheduledJobEvent<T extends JSONObject | undefined> = {
+    /** The name of the scheduled job */
+    name: string;
+    /** Additional data passed in by the scheduler client */
+    data: T;
+};
+export type ScheduledJobHandler<Data extends JSONObject | undefined = JSONObject | undefined> = (event: ScheduledJobEvent<Data>) => void | Promise<void>;
+export type ScheduledJobType<Data extends JSONObject | undefined> = {
+    /** The name of the scheduled job type */
+    name: string;
+    /** The function that will be called when the job is scheduled to run */
+    onRun: ScheduledJobHandler<Data>;
+};
+//# sourceMappingURL=scheduler.d.ts.map

package/types/scheduler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scheduler.d.ts","sourceRoot":"","sources":["../../src/types/scheduler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,MAAM,YAAY,GAAG;IACzB,oFAAoF;IACpF,EAAE,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,2CAA2C;IAC3C,KAAK,EAAE,IAAI,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,oFAAoF;IACpF,EAAE,EAAE,MAAM,CAAC;IACX,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,IAAI,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;IAC9B,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,IAAI;IAC3F,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,2CAA2C;IAC3C,KAAK,EAAE,IAAI,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,IAAI;IAC/F,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,MAAM,CAAC,IAAI,SAAS,UAAU,GAAG,SAAS,IAAI,CACxD,GAAG,EAAE,mBAAmB,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,IAAI,CAAC,KAC3D,OAAO,CAAC,MAAM,CAAC,CAAC;AACrB;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEzD;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;;;OAIG;IACH,MAAM,EAAE,CAAC,IAAI,SAAS,UAAU,GAAG,SAAS,EAC1C,GAAG,EAAE,mBAAmB,CAAC,IAAI,CAAC,GAAG,uBAAuB,CAAC,IAAI,CAAC,KAC3D,OAAO,CAAC,MAAM,CAAC,CAAC;IACrB;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC,CAAC,YAAY,GAAG,gBAAgB,CAAC,EAAE,CAAC,CAAC;CAC9D,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,UAAU,GAAG,SAAS,IAAI;IAChE,oCAAoC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,IAAI,SAAS,UAAU,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,IAAI,CAC9F,KAAK,EAAE,iBAAiB,CAAC,IAAI,CAAC,KAC3B,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,UAAU,GAAG,SAAS,IAAI;IAClE,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,KAAK,EAAE,mBAAmB,CAAC,IAAI,CAAC,CAAC;CAClC,CAAC"}

package/types/scheduler.js

@@ -0,0 +1 @@
+export {};