@convex-dev/crons 0.0.1 → 0.1.0

package/README.md

@@ -1,12 +1,14 @@
 # Crons Convex Component
 
+[![npm version](https://badge.fury.io/js/@convex-dev%2Fcrons.svg)](https://badge.fury.io/js/@convex-dev%2Fcrons)
+
 This Convex component provides functionality for registering and managing cron
 jobs at runtime. Convex comes with built-in support for cron jobs but they must
 be statically defined at deployment time. This library allows for dynamic
 registration of cron jobs at runtime.
 
-It supports intervals in ms as well as cron schedules with the same format as
-the unix `cron` command:
+It supports intervals in milliseconds as well as cron schedules with the same
+format as the unix `cron` command:
 
 ```
  *  *  *  *  *  *
@@ -20,31 +22,119 @@ the unix `cron` command:
  └───────────────── second (0 - 59, optional)
 ```
 
-See `example/convex/example.ts` for a simple example of how to use this library.
+### Design
+
+The design of this component is based on the Cronvex demo app that's described in
+[this Stack post](https://stack.convex.dev/cron-jobs).
+
+### Convex App
+
+You'll need a Convex App to use the component. Run `npm create convex` or
+follow any of the [Convex quickstarts](https://docs.convex.dev/home) to set one up.
+
+## Installation
+
+Install the component package:
+
+```ts
+npm install @convex-dev/crons
+```
+
+Create a `convex.config.ts` file in your app's `convex/` folder and install the component by calling `use`:
 
-The component must first be defined in convex.config.ts:
+```ts
+// convex/convex.config.js
+import { defineApp } from "convex/server";
+import crons from "@convex-dev/crons/convex.config";
 
-```typescript
 const app = defineApp();
-app.use(component, { name: "crons" });
+app.use(crons);
+
+export default app;
 ```
 
-and can then be used from Convex functions via the `Crons` wrapper class:
+## Usage
+
+A `Crons` wrapper can be instantiated within your Convex code as:
+
+```ts
+import { components } from "./_generated/api";
+import { Crons } from "@convex-dev/crons";
 
-```typescript
 const crons = new Crons(components.crons);
+```
+
+The `Crons` wrapper class provides the following methods:
+
+- `register(ctx, schedule, fn, args, name?)`: Registers a new cron job.
+- `get(ctx, { name | id })`: Gets a cron job by name or ID.
+- `list(ctx)`: Lists all cron jobs.
+- `delete(ctx, { name | id })`: Deletes a cron job by name or ID.
+
+Example usage:
+
+```ts
+import { v } from "convex/values";
+import { internalMutation } from "./_generated/server";
+import { internal } from "./_generated/api";
+
+// Dummy function that we're going to schedule.
+export const logStuff = internalMutation({
+  args: {
+    message: v.string(),
+  },
+  handler: async (_ctx, args) => {
+    console.log(args.message);
+  },
+});
+
+// Run a bunch of cron operations as a test. Note that this function runs as a
+// transaction and cleans up after itself so you won't actually see these crons
+// showing up in the database while it's in progress.
+export const doSomeStuff = internalMutation({
+  handler: async (ctx) => {
+    // Register some crons.
+    const namedCronId = await crons.register(
+      ctx,
+      { kind: "interval", ms: 3600000 },
+      internal.example.logStuff,
+      { message: "Hourly cron test" },
+      "hourly-test"
+    );
+    console.log("Registered new cron job with ID:", namedCronId);
+    const unnamedCronId = await crons.register(
+      ctx,
+      { kind: "cron", cronspec: "0 * * * *" },
+      internal.example.logStuff,
+      { message: "Minutely cron test" }
+    );
+    console.log("Registered new cron job with ID:", unnamedCronId);
 
-// ...
+    // Get the cron job by name.
+    const cronByName = await crons.get(ctx, { name: "hourly-test" });
+    console.log("Retrieved cron job by name:", cronByName);
 
-if ((await crons.get(ctx, { name: "daily" })) === null) {
-  await crons.register(
-    ctx,
-    { kind: "cron", cronspec: "0 0 * * *" },
-    internal.example.logStuff,
-    { message: "daily cron" },
-    "daily"
-  );
-}
+    // Get the cron job by ID.
+    const cronById = await crons.get(ctx, { id: unnamedCronId });
+    console.log("Retrieved cron job by ID:", cronById);
+
+    // List all cron jobs.
+    const allCrons = await crons.list(ctx);
+    console.log("All cron jobs:", allCrons);
+
+    // Delete the cron jobs.
+    await crons.delete(ctx, { name: "hourly-test" });
+    console.log("Deleted cron job by name:", "hourly-test");
+    await crons.delete(ctx, { id: unnamedCronId });
+    console.log("Deleted cron job by ID:", unnamedCronId);
+
+    // Verify deletion.
+    const deletedCronByName = await crons.get(ctx, { name: "hourly-test" });
+    console.log("Deleted cron job (should be null):", deletedCronByName);
+    const deletedCronById = await crons.get(ctx, { id: unnamedCronId });
+    console.log("Deleted cron job (should be null):", deletedCronById);
+  },
+});
 ```
 
 If you'd like to statically define cronjobs like in the built-in `crons.ts`
@@ -52,5 +142,128 @@ Convex feature you can do so via an init script that idempotently registers a
 cron with a given name. e.g., in an `init.ts` file that gets run on every
 deploy via `convex dev --run init`.
 
-The design of this component is based on the Cronvex demo app that's described in
-[this Stack post](https://stack.convex.dev/cron-jobs).
+```ts
+// Register a daily cron job. This could be called from an init script to make
+// sure it's always registered, like the built-in crons in Convex.
+export const registerDailyCron = internalMutation({
+  handler: async (ctx) => {
+    if ((await crons.get(ctx, { name: "daily" })) === null) {
+      await crons.register(
+        ctx,
+        { kind: "cron", cronspec: "0 0 * * *" },
+        internal.example.logStuff,
+        {
+          message: "daily cron",
+        },
+        "daily"
+      );
+    }
+  },
+});
+```
+
+Crons are created transactionally and will be guaranteed to exist after the
+mutation that creates them has run. It's thus possible to write workflows like
+the following that schedules a cron and then deletes itself as soon as it runs,
+without any additional error handling about the cron not existing.
+
+```ts
+// This will schedule a cron job to run every 10 seconds but then delete itself
+// the first time it runs.
+export const selfDeletingCron = internalMutation({
+  handler: async (ctx) => {
+    const cronId = await crons.register(
+      ctx,
+      { kind: "interval", ms: 10000 },
+      internal.example.deleteSelf,
+      { name: "self-deleting-cron" },
+      "self-deleting-cron"
+    );
+
+    console.log("Registered self-deleting cron job with ID:", cronId);
+  },
+});
+
+// Worker function that deletes a cron job.
+export const deleteSelf = internalMutation({
+  args: { name: v.string() },
+  handler: async (ctx, { name }) => {
+    console.log("Self-deleting cron job running. Name:", name);
+    await crons.delete(ctx, { name });
+    console.log("Self-deleting cron job has been deleted. Name:", name);
+  },
+});
+```
+
+# 🧑‍🏫 What is Convex?
+
+[Convex](https://convex.dev) is a hosted backend platform with a
+built-in database that lets you write your
+[database schema](https://docs.convex.dev/database/schemas) and
+[server functions](https://docs.convex.dev/functions) in
+[TypeScript](https://docs.convex.dev/typescript). Server-side database
+[queries](https://docs.convex.dev/functions/query-functions) automatically
+[cache](https://docs.convex.dev/functions/query-functions#caching--reactivity) and
+[subscribe](https://docs.convex.dev/client/react#reactivity) to data, powering a
+[realtime `useQuery` hook](https://docs.convex.dev/client/react#fetching-data) in our
+[React client](https://docs.convex.dev/client/react). There are also clients for
+[Python](https://docs.convex.dev/client/python),
+[Rust](https://docs.convex.dev/client/rust),
+[ReactNative](https://docs.convex.dev/client/react-native), and
+[Node](https://docs.convex.dev/client/javascript), as well as a straightforward
+[HTTP API](https://docs.convex.dev/http-api/).
+
+The database supports
+[NoSQL-style documents](https://docs.convex.dev/database/document-storage) with
+[opt-in schema validation](https://docs.convex.dev/database/schemas),
+[relationships](https://docs.convex.dev/database/document-ids) and
+[custom indexes](https://docs.convex.dev/database/indexes/)
+(including on fields in nested objects).
+
+The
+[`query`](https://docs.convex.dev/functions/query-functions) and
+[`mutation`](https://docs.convex.dev/functions/mutation-functions) server functions have transactional,
+low latency access to the database and leverage our
+[`v8` runtime](https://docs.convex.dev/functions/runtimes) with
+[determinism guardrails](https://docs.convex.dev/functions/runtimes#using-randomness-and-time-in-queries-and-mutations)
+to provide the strongest ACID guarantees on the market:
+immediate consistency,
+serializable isolation, and
+automatic conflict resolution via
+[optimistic multi-version concurrency control](https://docs.convex.dev/database/advanced/occ) (OCC / MVCC).
+
+The [`action` server functions](https://docs.convex.dev/functions/actions) have
+access to external APIs and enable other side-effects and non-determinism in
+either our
+[optimized `v8` runtime](https://docs.convex.dev/functions/runtimes) or a more
+[flexible `node` runtime](https://docs.convex.dev/functions/runtimes#nodejs-runtime).
+
+Functions can run in the background via
+[scheduling](https://docs.convex.dev/scheduling/scheduled-functions) and
+[cron jobs](https://docs.convex.dev/scheduling/cron-jobs).
+
+Development is cloud-first, with
+[hot reloads for server function](https://docs.convex.dev/cli#run-the-convex-dev-server) editing via the
+[CLI](https://docs.convex.dev/cli),
+[preview deployments](https://docs.convex.dev/production/hosting/preview-deployments),
+[logging and exception reporting integrations](https://docs.convex.dev/production/integrations/),
+There is a
+[dashboard UI](https://docs.convex.dev/dashboard) to
+[browse and edit data](https://docs.convex.dev/dashboard/deployments/data),
+[edit environment variables](https://docs.convex.dev/production/environment-variables),
+[view logs](https://docs.convex.dev/dashboard/deployments/logs),
+[run server functions](https://docs.convex.dev/dashboard/deployments/functions), and more.
+
+There are built-in features for
+[reactive pagination](https://docs.convex.dev/database/pagination),
+[file storage](https://docs.convex.dev/file-storage),
+[reactive text search](https://docs.convex.dev/text-search),
+[vector search](https://docs.convex.dev/vector-search),
+[https endpoints](https://docs.convex.dev/functions/http-actions) (for webhooks),
+[snapshot import/export](https://docs.convex.dev/database/import-export/),
+[streaming import/export](https://docs.convex.dev/production/integrations/streaming-import-export), and
+[runtime validation](https://docs.convex.dev/database/schemas#validators) for
+[function arguments](https://docs.convex.dev/functions/args-validation) and
+[database data](https://docs.convex.dev/database/schemas#schema-validation).
+
+Everything scales automatically, and it’s [free to start](https://www.convex.dev/plans).

package/dist/commonjs/client/index.d.ts

@@ -41,7 +41,7 @@ export declare class Crons {
      *
      * @param identifier - Either the ID or name of the cron job.
      */
-    del(ctx: RunMutationCtx, identifier: {
+    delete(ctx: RunMutationCtx, identifier: {
         id: string;
     } | {
         name: string;

package/dist/commonjs/client/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,YAAY,EAEZ,4BAA4B,EAC7B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,GAAG,EAAE,MAAM,gCAAgC,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEjE,YAAY,EAAE,QAAQ,EAAE,CAAC;AAqCzB,qBAAa,KAAK;IACJ,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC;IAEjD;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,CAAC,SAAS,4BAA4B,EACnD,GAAG,EAAE,cAAc,EACnB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;IASlB;;;;OAIG;IACG,IAAI,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUjD;;;;;OAKG;IACG,GAAG,CACP,GAAG,EAAE,WAAW,EAChB,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAa3B;;;;OAIG;IACG,GAAG,CACP,GAAG,EAAE,cAAc,EACnB,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,IAAI,CAAC;CAGjB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,YAAY,EAEZ,4BAA4B,EAC7B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,GAAG,EAAE,MAAM,gCAAgC,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEjE,YAAY,EAAE,QAAQ,EAAE,CAAC;AAqCzB,qBAAa,KAAK;IACJ,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC;IAEjD;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,CAAC,SAAS,4BAA4B,EACnD,GAAG,EAAE,cAAc,EACnB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;IASlB;;;;OAIG;IACG,IAAI,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUjD;;;;;OAKG;IACG,GAAG,CACP,GAAG,EAAE,WAAW,EAChB,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAa3B;;;;OAIG;IACG,MAAM,CACV,GAAG,EAAE,cAAc,EACnB,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,IAAI,CAAC;CAGjB"}

package/dist/commonjs/client/index.js

@@ -92,7 +92,7 @@ export class Crons {
      *
      * @param identifier - Either the ID or name of the cron job.
      */
-    async del(ctx, identifier) {
+    async delete(ctx, identifier) {
         return ctx.runMutation(this.component.public.del, { identifier });
     }
 }

package/dist/commonjs/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAErD,OAAO,EACL,oBAAoB,GAIrB,MAAM,eAAe,CAAC;AAOvB,2EAA2E;AAE3E,yCAAyC;AACzC,EAAE;AACF,6EAA6E;AAC7E,2BAA2B;AAC3B,EAAE;AACF,oBAAoB;AACpB,oBAAoB;AACpB,oBAAoB;AACpB,mEAAmE;AACnE,qCAAqC;AACrC,+CAA+C;AAC/C,oCAAoC;AACpC,sCAAsC;AACtC,gDAAgD;AAChD,EAAE;AACF,kEAAkE;AAClE,EAAE;AACF,8EAA8E;AAC9E,gFAAgF;AAChF,4EAA4E;AAC5E,sCAAsC;AACtC,EAAE;AACF,6CAA6C;AAC7C,MAAM;AACN,4DAA4D;AAC5D,0BAA0B;AAC1B,WAAW;AACX,+CAA+C;AAC/C,iCAAiC;AACjC,iCAAiC;AACjC,cAAc;AACd,OAAO;AACP,IAAI;AACJ,MAAM,OAAO,KAAK;IACI;IAApB,YAAoB,SAA6B;QAA7B,cAAS,GAAT,SAAS,CAAoB;IAAG,CAAC;IAErD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,CACZ,GAAmB,EACnB,QAAkB,EAClB,IAAO,EACP,IAAqB,EACrB,IAAa;QAEb,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE;YACrD,IAAI;YACJ,QAAQ;YACR,cAAc,EAAE,MAAM,oBAAoB,CAAC,IAAI,CAAC;YAChD,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,GAAgB;QACzB,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACjE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,GAAG,IAAI;YACP,cAAc,EAAE,IAAI,CAAC,cAEpB;SACF,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,GAAgB,EAChB,UAA6C;QAE7C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QAC3E,IAAI,IAAI,KAAK,IAAI,EAAE;YACjB,OAAO,IAAI,CAAC;SACb;QACD,OAAO;YACL,GAAG,IAAI;YACP,cAAc,EAAE,IAAI,CAAC,cAEpB;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CACP,GAAmB,EACnB,UAA6C;QAE7C,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;IACpE,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAErD,OAAO,EACL,oBAAoB,GAIrB,MAAM,eAAe,CAAC;AAOvB,2EAA2E;AAE3E,yCAAyC;AACzC,EAAE;AACF,6EAA6E;AAC7E,2BAA2B;AAC3B,EAAE;AACF,oBAAoB;AACpB,oBAAoB;AACpB,oBAAoB;AACpB,mEAAmE;AACnE,qCAAqC;AACrC,+CAA+C;AAC/C,oCAAoC;AACpC,sCAAsC;AACtC,gDAAgD;AAChD,EAAE;AACF,kEAAkE;AAClE,EAAE;AACF,8EAA8E;AAC9E,gFAAgF;AAChF,4EAA4E;AAC5E,sCAAsC;AACtC,EAAE;AACF,6CAA6C;AAC7C,MAAM;AACN,4DAA4D;AAC5D,0BAA0B;AAC1B,WAAW;AACX,+CAA+C;AAC/C,iCAAiC;AACjC,iCAAiC;AACjC,cAAc;AACd,OAAO;AACP,IAAI;AACJ,MAAM,OAAO,KAAK;IACI;IAApB,YAAoB,SAA6B;QAA7B,cAAS,GAAT,SAAS,CAAoB;IAAG,CAAC;IAErD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,CACZ,GAAmB,EACnB,QAAkB,EAClB,IAAO,EACP,IAAqB,EACrB,IAAa;QAEb,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE;YACrD,IAAI;YACJ,QAAQ;YACR,cAAc,EAAE,MAAM,oBAAoB,CAAC,IAAI,CAAC;YAChD,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,GAAgB;QACzB,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACjE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,GAAG,IAAI;YACP,cAAc,EAAE,IAAI,CAAC,cAEpB;SACF,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,GAAgB,EAChB,UAA6C;QAE7C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QAC3E,IAAI,IAAI,KAAK,IAAI,EAAE;YACjB,OAAO,IAAI,CAAC;SACb;QACD,OAAO;YACL,GAAG,IAAI;YACP,cAAc,EAAE,IAAI,CAAC,cAEpB;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,GAAmB,EACnB,UAA6C;QAE7C,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;IACpE,CAAC;CACF"}

package/dist/esm/client/index.d.ts

@@ -41,7 +41,7 @@ export declare class Crons {
      *
      * @param identifier - Either the ID or name of the cron job.
      */
-    del(ctx: RunMutationCtx, identifier: {
+    delete(ctx: RunMutationCtx, identifier: {
         id: string;
     } | {
         name: string;

package/dist/esm/client/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,YAAY,EAEZ,4BAA4B,EAC7B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,GAAG,EAAE,MAAM,gCAAgC,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEjE,YAAY,EAAE,QAAQ,EAAE,CAAC;AAqCzB,qBAAa,KAAK;IACJ,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC;IAEjD;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,CAAC,SAAS,4BAA4B,EACnD,GAAG,EAAE,cAAc,EACnB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;IASlB;;;;OAIG;IACG,IAAI,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUjD;;;;;OAKG;IACG,GAAG,CACP,GAAG,EAAE,WAAW,EAChB,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAa3B;;;;OAIG;IACG,GAAG,CACP,GAAG,EAAE,cAAc,EACnB,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,IAAI,CAAC;CAGjB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAEL,YAAY,EAEZ,4BAA4B,EAC7B,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,GAAG,EAAE,MAAM,gCAAgC,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,YAAY,CAAC;AAEjE,YAAY,EAAE,QAAQ,EAAE,CAAC;AAqCzB,qBAAa,KAAK;IACJ,OAAO,CAAC,SAAS;gBAAT,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC;IAEjD;;;;;;;;;;;OAWG;IACG,QAAQ,CAAC,CAAC,SAAS,4BAA4B,EACnD,GAAG,EAAE,cAAc,EACnB,QAAQ,EAAE,QAAQ,EAClB,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,EACrB,IAAI,CAAC,EAAE,MAAM,GACZ,OAAO,CAAC,MAAM,CAAC;IASlB;;;;OAIG;IACG,IAAI,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUjD;;;;;OAKG;IACG,GAAG,CACP,GAAG,EAAE,WAAW,EAChB,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAa3B;;;;OAIG;IACG,MAAM,CACV,GAAG,EAAE,cAAc,EACnB,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,GAC5C,OAAO,CAAC,IAAI,CAAC;CAGjB"}

package/dist/esm/client/index.js

@@ -92,7 +92,7 @@ export class Crons {
      *
      * @param identifier - Either the ID or name of the cron job.
      */
-    async del(ctx, identifier) {
+    async delete(ctx, identifier) {
         return ctx.runMutation(this.component.public.del, { identifier });
     }
 }

package/dist/esm/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAErD,OAAO,EACL,oBAAoB,GAIrB,MAAM,eAAe,CAAC;AAOvB,2EAA2E;AAE3E,yCAAyC;AACzC,EAAE;AACF,6EAA6E;AAC7E,2BAA2B;AAC3B,EAAE;AACF,oBAAoB;AACpB,oBAAoB;AACpB,oBAAoB;AACpB,mEAAmE;AACnE,qCAAqC;AACrC,+CAA+C;AAC/C,oCAAoC;AACpC,sCAAsC;AACtC,gDAAgD;AAChD,EAAE;AACF,kEAAkE;AAClE,EAAE;AACF,8EAA8E;AAC9E,gFAAgF;AAChF,4EAA4E;AAC5E,sCAAsC;AACtC,EAAE;AACF,6CAA6C;AAC7C,MAAM;AACN,4DAA4D;AAC5D,0BAA0B;AAC1B,WAAW;AACX,+CAA+C;AAC/C,iCAAiC;AACjC,iCAAiC;AACjC,cAAc;AACd,OAAO;AACP,IAAI;AACJ,MAAM,OAAO,KAAK;IACI;IAApB,YAAoB,SAA6B;QAA7B,cAAS,GAAT,SAAS,CAAoB;IAAG,CAAC;IAErD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,CACZ,GAAmB,EACnB,QAAkB,EAClB,IAAO,EACP,IAAqB,EACrB,IAAa;QAEb,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE;YACrD,IAAI;YACJ,QAAQ;YACR,cAAc,EAAE,MAAM,oBAAoB,CAAC,IAAI,CAAC;YAChD,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,GAAgB;QACzB,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACjE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,GAAG,IAAI;YACP,cAAc,EAAE,IAAI,CAAC,cAEpB;SACF,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,GAAgB,EAChB,UAA6C;QAE7C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QAC3E,IAAI,IAAI,KAAK,IAAI,EAAE;YACjB,OAAO,IAAI,CAAC;SACb;QACD,OAAO;YACL,GAAG,IAAI;YACP,cAAc,EAAE,IAAI,CAAC,cAEpB;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CACP,GAAmB,EACnB,UAA6C;QAE7C,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;IACpE,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/index.ts"],"names":[],"mappings":"AAAA,qDAAqD;AAErD,OAAO,EACL,oBAAoB,GAIrB,MAAM,eAAe,CAAC;AAOvB,2EAA2E;AAE3E,yCAAyC;AACzC,EAAE;AACF,6EAA6E;AAC7E,2BAA2B;AAC3B,EAAE;AACF,oBAAoB;AACpB,oBAAoB;AACpB,oBAAoB;AACpB,mEAAmE;AACnE,qCAAqC;AACrC,+CAA+C;AAC/C,oCAAoC;AACpC,sCAAsC;AACtC,gDAAgD;AAChD,EAAE;AACF,kEAAkE;AAClE,EAAE;AACF,8EAA8E;AAC9E,gFAAgF;AAChF,4EAA4E;AAC5E,sCAAsC;AACtC,EAAE;AACF,6CAA6C;AAC7C,MAAM;AACN,4DAA4D;AAC5D,0BAA0B;AAC1B,WAAW;AACX,+CAA+C;AAC/C,iCAAiC;AACjC,iCAAiC;AACjC,cAAc;AACd,OAAO;AACP,IAAI;AACJ,MAAM,OAAO,KAAK;IACI;IAApB,YAAoB,SAA6B;QAA7B,cAAS,GAAT,SAAS,CAAoB;IAAG,CAAC;IAErD;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,QAAQ,CACZ,GAAmB,EACnB,QAAkB,EAClB,IAAO,EACP,IAAqB,EACrB,IAAa;QAEb,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE;YACrD,IAAI;YACJ,QAAQ;YACR,cAAc,EAAE,MAAM,oBAAoB,CAAC,IAAI,CAAC;YAChD,IAAI;SACL,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,GAAgB;QACzB,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACjE,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC1B,GAAG,IAAI;YACP,cAAc,EAAE,IAAI,CAAC,cAEpB;SACF,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,CACP,GAAgB,EAChB,UAA6C;QAE7C,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;QAC3E,IAAI,IAAI,KAAK,IAAI,EAAE;YACjB,OAAO,IAAI,CAAC;SACb;QACD,OAAO;YACL,GAAG,IAAI;YACP,cAAc,EAAE,IAAI,CAAC,cAEpB;SACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACV,GAAmB,EACnB,UAA6C;QAE7C,OAAO,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;IACpE,CAAC;CACF"}

package/package.json

@@ -1,8 +1,21 @@
 {
   "name": "@convex-dev/crons",
-  "version": "0.0.1",
   "description": "Convex component for scheduling periodic jobs.",
+  "repository": "github:get-convex/crons",
+  "homepage": "https://github.com/get-convex/crons#readme",
+  "bugs": {
+    "email": "support@convex.dev",
+    "url": "https://github.com/get-convex/crons/issues"
+  },
+  "version": "0.1.0",
   "license": "Apache-2.0",
+  "keywords": [
+    "convex",
+    "component",
+    "crons",
+    "cron",
+    "scheduler"
+  ],
   "type": "module",
   "scripts": {
     "build": "npm run build:esm && npm run build:cjs",
@@ -29,7 +42,7 @@
         "default": "./dist/commonjs/client/index.js"
       }
     },
-    "./convex.config.js": {
+    "./convex.config": {
       "import": {
         "@convex-dev/component-source": "./src/component/convex.config.ts",
         "types": "./dist/esm/component/convex.config.d.ts",
@@ -38,7 +51,7 @@
     }
   },
   "dependencies": {
-    "convex": "^1.16.1",
+    "convex": "1.16.2",
     "cron-parser": "^4.9.0"
   },
   "devDependencies": {

package/src/client/index.ts

@@ -119,7 +119,7 @@ export class Crons {
    *
    * @param identifier - Either the ID or name of the cron job.
    */
-  async del(
+  async delete(
     ctx: RunMutationCtx,
     identifier: { id: string } | { name: string }
   ): Promise<null> {

package/dist/commonjs/component/index.d.ts

@@ -1,135 +0,0 @@
-/**
- * Schedule a mutation or action to run on a recurring basis.
- *
- * Like the unix command `cron`, Sunday is 0, Monday is 1, etc.
- *
- * ```
- *  *  *  *  *  *  *
- *  ┬  ┬  ┬  ┬  ┬  ┬
- *  │  │  │  │  │  |
- *  │  │  │  │  │  └── day of week (0 - 7, 1L - 7L) (0 or 7 is Sun)
- *  │  │  │  │  └───── month (1 - 12)
- *  │  │  │  └──────── day of month (1 - 31, L)
- *  │  │  └─────────── hour (0 - 23)
- *  │  └────────────── minute (0 - 59)
- *  └───────────────── second (0 - 59, optional)
- * ```
- *
- * @param name - Optional unique name for the cron job. Will throw if a name is
- * provided and a cron with the same name already exists.
- * @param cronspec - Cron string like `"15 7 * * *"` (Every day at 7:15 UTC)
- * @param functionHandle - A {@link FunctionHandle} string for the function to schedule.
- * @param args - The arguments to the function.
- * @returns The ID of the cron job.
- */
-export declare const registerCron: import("convex/server").RegisteredMutation<"public", {
-    name?: string | undefined;
-    functionHandle: string;
-    args: any;
-    cronspec: string;
-}, Promise<import("convex/values").GenericId<"crons">>>;
-/**
- * Schedule a mutation or action to run on the given interval.
- *
- * @param name - Optional unique name for the cron job. Will throw if a name is
- * provided and a cron with the same name already exists.
- * @param ms - The time in ms between runs for this scheduled job, >= 1000.
- * @param functionHandle - A {@link FunctionHandle} string for the function to schedule.
- * @param args - Any arguments to the function.
- * @returns The ID of the cron job.
- */
-export declare const registerInterval: import("convex/server").RegisteredMutation<"public", {
-    name?: string | undefined;
-    functionHandle: string;
-    args: any;
-    ms: number;
-}, Promise<import("convex/values").GenericId<"crons">>>;
-/**
- * List all user space cron jobs.
- *
- * @returns List of `cron` table rows.
- */
-export declare const list: import("convex/server").RegisteredQuery<"public", {}, Promise<{
-    _id: import("convex/values").GenericId<"crons">;
-    _creationTime: number;
-    name?: string | undefined;
-    schedulerJobId?: import("convex/values").GenericId<"_scheduled_functions"> | undefined;
-    executionJobId?: import("convex/values").GenericId<"_scheduled_functions"> | undefined;
-    functionHandle: string;
-    args: any;
-    schedule: {
-        kind: "interval";
-        ms: number;
-    } | {
-        kind: "cron";
-        cronspec: string;
-    };
-}[]>>;
-/**
- * Get an existing cron job by id.
- *
- * @param id  - ID of the cron job.
- * @returns Cron job document.
- */
-export declare const get: import("convex/server").RegisteredQuery<"public", {
-    id: import("convex/values").GenericId<"crons">;
-}, Promise<{
-    _id: import("convex/values").GenericId<"crons">;
-    _creationTime: number;
-    name?: string | undefined;
-    schedulerJobId?: import("convex/values").GenericId<"_scheduled_functions"> | undefined;
-    executionJobId?: import("convex/values").GenericId<"_scheduled_functions"> | undefined;
-    functionHandle: string;
-    args: any;
-    schedule: {
-        kind: "interval";
-        ms: number;
-    } | {
-        kind: "cron";
-        cronspec: string;
-    };
-} | null>>;
-/**
- * Get an existing cron job by name.
- *
- * @param name  - Name of the cron job.
- * @returns Cron job document.
- */
-export declare const getByName: import("convex/server").RegisteredQuery<"public", {
-    name: string;
-}, Promise<{
-    _id: import("convex/values").GenericId<"crons">;
-    _creationTime: number;
-    name?: string | undefined;
-    schedulerJobId?: import("convex/values").GenericId<"_scheduled_functions"> | undefined;
-    executionJobId?: import("convex/values").GenericId<"_scheduled_functions"> | undefined;
-    functionHandle: string;
-    args: any;
-    schedule: {
-        kind: "interval";
-        ms: number;
-    } | {
-        kind: "cron";
-        cronspec: string;
-    };
-} | null>>;
-/**
- * Delete and deschedule a cron job by id.
- *
- * @param id - ID of the cron job.
- */
-export declare const del: import("convex/server").RegisteredMutation<"public", {
-    id: import("convex/values").GenericId<"crons">;
-}, Promise<void>>;
-/**
- * Delete and deschedule a cron job by name.
- *
- * @param name - Name of the cron job.
- */
-export declare const delByName: import("convex/server").RegisteredMutation<"public", {
-    name: string;
-}, Promise<void>>;
-export declare const rescheduler: import("convex/server").RegisteredMutation<"internal", {
-    id: import("convex/values").GenericId<"crons">;
-}, Promise<void>>;
-//# sourceMappingURL=index.d.ts.map

package/dist/commonjs/component/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/component/index.ts"],"names":[],"mappings":"AAgCA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,YAAY;;;;;uDAgBvB,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB;;;;;uDAgB3B,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;KAKf,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;UAOd,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;UAUpB,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,GAAG;;iBAWd,CAAC;AAEH;;;;GAIG;AACH,eAAO,MAAM,SAAS;;iBAcpB,CAAC;AAiGH,eAAO,MAAM,WAAW;;iBA6EtB,CAAC"}