@rackbops/docket-types 0.0.1 → 0.1.0

package/README.md

@@ -1,10 +1,14 @@
 # @rackbops/docket-types
 
-The tracker's task types -- reminder, renewal, price, research, scout, wantlist -- built on
-`@rackbops/docket-core`'s contract. Today this package is the scaffold: it exports the type
-identifiers and re-exports `Lane`. The types land with their epics (Lepid-Labs/city-hall#7,
-#11, #13).
+The tracker's task types, built on `@rackbops/docket-core`'s contract. Shipped so far:
+`reminder` (Lepid-Labs/city-hall#7): notify lane, `once` or `calendar`, done and snooze replies.
+The others land with their epics: renewal and price (#11), scout and wantlist (#13), research
+with the runner (E8).
 
 ```ts
-import { TYPE_IDS, isTypeId, type TypeId } from "@rackbops/docket-types"
+import { TASK_TYPES, reminder, TYPE_IDS, isTypeId } from "@rackbops/docket-types"
 ```
+
+`TASK_TYPES` is every shipped type keyed by id, ready for the dispatcher. Every type is declared
+through `defineTaskType`, which refuses a capability outside the grantable set, and a test here
+asserts that over the whole map.

package/dist/index.d.ts

@@ -1,14 +1,18 @@
 /**
  * @rackbops/docket-types -- the tracker's task types, built on @rackbops/docket-core.
  *
- * This is the scaffold (Rackbops/docket#1): the type identifiers and nothing else, so the
- * workspace dependency on docket-core is exercised by the build, the tests and the publish path.
- * The types themselves land with their epics (Lepid-Labs/city-hall#7, #11, #13).
+ * The six categories of the plan (section 1.2) as type identifiers, and the types shipped so far:
+ * `reminder` with the reminder slice (Lepid-Labs/city-hall#7). The others land with their epics
+ * (#11: renewal, price; #13: scout, wantlist; research with E8).
  */
+import type { TaskType } from "@rackbops/docket-core";
 export type { Lane } from "@rackbops/docket-core";
+export { DEFAULT_SNOOZE_MS, type ReminderConfig, reminder, snoozeUntil } from "./reminder.js";
 /** The six task categories the tracker starts with (plan section 1.2), as type identifiers. */
 export declare const TYPE_IDS: readonly ["reminder", "renewal", "price", "research", "scout", "wantlist"];
 export type TypeId = (typeof TYPE_IDS)[number];
 /** True when `value` names a task type. Narrows a string read from storage or the wire. */
 export declare function isTypeId(value: string): value is TypeId;
+/** Every shipped type, keyed by id, ready for the dispatcher's `types`. */
+export declare const TASK_TYPES: Readonly<Record<string, TaskType<unknown>>>;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,YAAY,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AAEjD,+FAA+F;AAC/F,eAAO,MAAM,QAAQ,YAAI,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,CAAU,CAAA;AAElG,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAA;AAE9C,2FAA2F;AAC3F,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAEvD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAGrD,YAAY,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAA;AACjD,OAAO,EAAE,iBAAiB,EAAE,KAAK,cAAc,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE7F,+FAA+F;AAC/F,eAAO,MAAM,QAAQ,YAAI,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,CAAU,CAAA;AAElG,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAA;AAE9C,2FAA2F;AAC3F,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,MAAM,CAEvD;AAED,2EAA2E;AAC3E,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAEjE,CAAA"}

package/dist/index.js

@@ -1,14 +1,20 @@
 /**
  * @rackbops/docket-types -- the tracker's task types, built on @rackbops/docket-core.
  *
- * This is the scaffold (Rackbops/docket#1): the type identifiers and nothing else, so the
- * workspace dependency on docket-core is exercised by the build, the tests and the publish path.
- * The types themselves land with their epics (Lepid-Labs/city-hall#7, #11, #13).
+ * The six categories of the plan (section 1.2) as type identifiers, and the types shipped so far:
+ * `reminder` with the reminder slice (Lepid-Labs/city-hall#7). The others land with their epics
+ * (#11: renewal, price; #13: scout, wantlist; research with E8).
  */
+import { reminder } from "./reminder.js";
+export { DEFAULT_SNOOZE_MS, reminder, snoozeUntil } from "./reminder.js";
 /** The six task categories the tracker starts with (plan section 1.2), as type identifiers. */
 export const TYPE_IDS = ["reminder", "renewal", "price", "research", "scout", "wantlist"];
 /** True when `value` names a task type. Narrows a string read from storage or the wire. */
 export function isTypeId(value) {
     return TYPE_IDS.includes(value);
 }
+/** Every shipped type, keyed by id, ready for the dispatcher's `types`. */
+export const TASK_TYPES = Object.freeze({
+    reminder: reminder,
+});
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,+FAA+F;AAC/F,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,CAAU,CAAA;AAIlG,2FAA2F;AAC3F,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,OAAQ,QAA8B,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACxD,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAGxC,OAAO,EAAE,iBAAiB,EAAuB,QAAQ,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAE7F,+FAA+F;AAC/F,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,UAAU,CAAU,CAAA;AAIlG,2FAA2F;AAC3F,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,OAAQ,QAA8B,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;AACxD,CAAC;AAED,2EAA2E;AAC3E,MAAM,CAAC,MAAM,UAAU,GAAgD,MAAM,CAAC,MAAM,CAAC;IACnF,QAAQ,EAAE,QAA6B;CACxC,CAAC,CAAA"}

package/dist/reminder.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Category 4 (plan section 1.2): "remind me to X at ..." and "every <cadence> remind me ...".
+ * Notify lane, tier 0 only, `once` or `calendar`. The person answers done or snooze; a snooze
+ * makes the dispatcher queue a new occurrence at the requested instant.
+ */
+export interface ReminderConfig {
+    /** What the reminder says. */
+    text: string;
+}
+export declare const DEFAULT_SNOOZE_MS: number;
+/** The snooze a reply asks for: `{ until }` as an instant, `{ minutes }`, or the default hour. */
+export declare function snoozeUntil(payload: unknown, now: Date): Date;
+export declare const reminder: import("@rackbops/docket-core").TaskType<ReminderConfig>;
+//# sourceMappingURL=reminder.d.ts.map

package/dist/reminder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reminder.d.ts","sourceRoot":"","sources":["../src/reminder.ts"],"names":[],"mappings":"AAOA;;;;GAIG;AAEH,MAAM,WAAW,cAAc;IAC7B,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;CACb;AAED,eAAO,MAAM,iBAAiB,QAAc,CAAA;AAE5C,kGAAkG;AAClG,wBAAgB,WAAW,CAAC,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,IAAI,GAAG,IAAI,CAS7D;AAED,eAAO,MAAM,QAAQ,0DA8BnB,CAAA"}

package/dist/reminder.js

@@ -0,0 +1,47 @@
+import { defineTaskType, } from "@rackbops/docket-core";
+export const DEFAULT_SNOOZE_MS = 60 * 60_000;
+/** The snooze a reply asks for: `{ until }` as an instant, `{ minutes }`, or the default hour. */
+export function snoozeUntil(payload, now) {
+    if (typeof payload === "object" && payload !== null) {
+        const p = payload;
+        if (typeof p.until === "string" && !Number.isNaN(Date.parse(p.until)))
+            return new Date(p.until);
+        if (typeof p.minutes === "number" && Number.isFinite(p.minutes) && p.minutes > 0) {
+            return new Date(now.getTime() + p.minutes * 60_000);
+        }
+    }
+    return new Date(now.getTime() + DEFAULT_SNOOZE_MS);
+}
+export const reminder = defineTaskType({
+    id: "reminder",
+    lane: "notify",
+    capabilities: ["notify"],
+    schedule: ["once", "calendar"],
+    intake: {
+        options: [
+            { name: "text", description: "What to be reminded of", required: true, kind: "string" },
+            {
+                name: "at",
+                description: "When, for a one-off reminder (an instant; the bot parses the person's words)",
+                required: false,
+                kind: "datetime",
+            },
+        ],
+    },
+    async run(ctx) {
+        return {
+            notify: { text: ctx.config.text, actions: ["done", "snooze"] },
+            summary: ctx.config.text,
+        };
+    },
+    async onReply(ctx) {
+        if (ctx.reply.kind === "snooze") {
+            const until = snoozeUntil(ctx.reply.payload, ctx.now);
+            return { snoozeUntil: until, summary: `snoozed until ${until.toISOString()}` };
+        }
+        if (ctx.reply.kind === "done")
+            return { summary: "done" };
+        return {};
+    },
+});
+//# sourceMappingURL=reminder.js.map

package/dist/reminder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reminder.js","sourceRoot":"","sources":["../src/reminder.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,GAIf,MAAM,uBAAuB,CAAA;AAa9B,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,GAAG,MAAM,CAAA;AAE5C,kGAAkG;AAClG,MAAM,UAAU,WAAW,CAAC,OAAgB,EAAE,GAAS;IACrD,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACpD,MAAM,CAAC,GAAG,OAAiD,CAAA;QAC3D,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YAAE,OAAO,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAA;QAC/F,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;YACjF,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,OAAO,GAAG,MAAM,CAAC,CAAA;QACrD,CAAC;IACH,CAAC;IACD,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,iBAAiB,CAAC,CAAA;AACpD,CAAC;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,cAAc,CAAiB;IACrD,EAAE,EAAE,UAAU;IACd,IAAI,EAAE,QAAQ;IACd,YAAY,EAAE,CAAC,QAAQ,CAAC;IACxB,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC;IAC9B,MAAM,EAAE;QACN,OAAO,EAAE;YACP,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,wBAAwB,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE;YACvF;gBACE,IAAI,EAAE,IAAI;gBACV,WAAW,EAAE,8EAA8E;gBAC3F,QAAQ,EAAE,KAAK;gBACf,IAAI,EAAE,UAAU;aACjB;SACF;KACF;IACD,KAAK,CAAC,GAAG,CAAC,GAA+B;QACvC,OAAO;YACL,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE;YAC9D,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI;SACzB,CAAA;IACH,CAAC;IACD,KAAK,CAAC,OAAO,CAAC,GAAiC;QAC7C,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;YACrD,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,iBAAiB,KAAK,CAAC,WAAW,EAAE,EAAE,EAAE,CAAA;QAChF,CAAC;QACD,IAAI,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM;YAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAA;QACzD,OAAO,EAAE,CAAA;IACX,CAAC;CACF,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rackbops/docket-types",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "The tracker's task types: reminder, renewal, price, research, scout, wantlist. Built on @rackbops/docket-core.",
   "license": "MIT",
   "repository": {
@@ -29,7 +29,7 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@rackbops/docket-core": "^0.0.1"
+    "@rackbops/docket-core": "^0.1.0"
   },
   "scripts": {
     "build": "tsc",