@abdssamie/convex-checkpoints 0.1.2 → 0.1.7

package/README.md

@@ -29,34 +29,7 @@ export default app;
 
 ## Usage
 
-Define your checkpoint registry in app code and expose wrapper functions from
-your own app modules. That keeps auth, permission checks, and business rules
-close to the rest of your application code.
-
-Expose checkpoint submissions as Convex mutations by default. Mutations are the
-right fit when recording a checkpoint, updating Convex data, reading Convex
-data, or scheduling follow-up work from a handler.
-
-Use an action only when the submit path needs external, non-transactional work,
-such as calling a third-party API, sending an email directly, using Node APIs,
-or doing longer-running processing. For most integrations, keep the checkpoint
-submission in a mutation and schedule an internal action from the checkpoint
-handler:
-
-```ts
-checkpoints.on("user.signup", async (ctx, payload) => {
-  await ctx.scheduler.runAfter(0, internal.emails.sendWelcome, {
-    userId: payload.userId,
-  });
-});
-```
-
-Actions are not database transactions, so design retries and idempotency
-explicitly when external systems are involved.
-
-The registry gives you typed checkpoint names and payloads while writing
-handlers and submit calls. Your exported Convex functions are still the runtime
-boundary where you validate input and enforce permissions.
+There are two steps: define your checkpoint registry with handlers, then expose submit mutations for your app to call.
 
 ```ts
 // convex/checkpoints.ts
@@ -66,10 +39,11 @@ import { v } from "convex/values";
 import { ConvexCheckpoints } from "@abdssamie/convex-checkpoints";
 
 export const checkpoints = new ConvexCheckpoints<{
-  "user.signup": { userId: string };
+  "user.signup": { userId: string; email: string };
   "post.created": { userId: string; postId: string; title: string };
 }>(components.convexCheckpoints);
 
+// Handlers run when a checkpoint is first recorded (deduplicated by idempotencyKey)
 checkpoints.on("user.signup", async (ctx, payload) => {
   await ctx.scheduler.runAfter(30 * 60 * 1000, internal.emails.welcome, {
     userId: payload.userId,
@@ -89,6 +63,7 @@ checkpoints.on("post.created", async (ctx, payload) => {
   }
 });
 
+// Submit mutations — called from your app code
 export const submitPostCreated = mutation({
   args: {
     userId: v.string(),

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@abdssamie/convex-checkpoints",
   "description": "A Convex component for event-driven user checkpoints.",
-  "repository": "github:abdssamie/convex-checkpoints",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/Abdssamie/convex-checkpoints.git"
+  },
   "homepage": "https://github.com/abdssamie/convex-checkpoints#readme",
   "bugs": {
     "url": "https://github.com/abdssamie/convex-checkpoints/issues"
   },
-  "version": "0.1.2",
+  "version": "0.1.7",
   "license": "Apache-2.0",
   "keywords": [
     "convex",
@@ -15,6 +18,25 @@
     "checkpoints"
   ],
   "type": "module",
+  "scripts": {
+    "dev": "convex dev --start 'npm run dev:build'",
+    "dev:frontend": "cd example && vite",
+    "dev:build": "chokidar 'tsconfig*.json' 'src/**/*.ts' -i '**/*.test.ts' -c 'npm run build:codegen' --initial",
+    "predev": "convex init && npm run build:codegen",
+    "build": "tsc --project ./tsconfig.build.json",
+    "build:codegen": "npx convex codegen --component-dir ./src/component && npm run build",
+    "build:clean": "rm -rf dist *.tsbuildinfo && npm run build:codegen",
+    "typecheck": "tsc --noEmit && tsc -p example && tsc -p example/convex",
+    "lint": "eslint .",
+    "test": "vitest run --typecheck",
+    "test:watch": "vitest --typecheck --clearScreen false",
+    "test:debug": "vitest --inspect-brk --no-file-parallelism",
+    "test:coverage": "vitest run --coverage --coverage.reporter=text",
+    "preversion": "npm ci && npm run build:clean && npm run test && npm run lint && npm run typecheck",
+    "alpha": "npm version prerelease --preid alpha && npm publish --tag alpha && git push --follow-tags",
+    "release": "npm version patch && npm publish && git push --follow-tags",
+    "version": "(npm whoami || npm login) && vim -c 'normal o' -c 'normal o## '$npm_package_version CHANGELOG.md && prettier -w CHANGELOG.md && git add CHANGELOG.md"
+  },
   "files": [
     "dist",
     "src"
@@ -72,23 +94,10 @@
   },
   "types": "./dist/client/index.d.ts",
   "module": "./dist/client/index.js",
-  "scripts": {
-    "dev": "convex dev --start 'npm run dev:build'",
-    "dev:frontend": "cd example && vite",
-    "dev:build": "chokidar 'tsconfig*.json' 'src/**/*.ts' -i '**/*.test.ts' -c 'npm run build:codegen' --initial",
-    "predev": "convex init && npm run build:codegen",
-    "build": "tsc --project ./tsconfig.build.json",
-    "build:codegen": "npx convex codegen --component-dir ./src/component && npm run build",
-    "build:clean": "rm -rf dist *.tsbuildinfo && npm run build:codegen",
-    "typecheck": "tsc --noEmit && tsc -p example && tsc -p example/convex",
-    "lint": "eslint .",
-    "test": "vitest run --typecheck",
-    "test:watch": "vitest --typecheck --clearScreen false",
-    "test:debug": "vitest --inspect-brk --no-file-parallelism",
-    "test:coverage": "vitest run --coverage --coverage.reporter=text",
-    "preversion": "npm ci && npm run build:clean && npm run test && npm run lint && npm run typecheck",
-    "alpha": "npm version prerelease --preid alpha && npm publish --tag alpha && git push --follow-tags",
-    "release": "npm version patch && npm publish && git push --follow-tags",
-    "version": "(npm whoami || npm login) && vim -c 'normal o' -c 'normal o## '$npm_package_version CHANGELOG.md && prettier -w CHANGELOG.md && git add CHANGELOG.md"
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "@tailwindcss/oxide"
+    ]
   }
-}
+}