@deliverd/sdk 0.13.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -284,9 +284,29 @@ context.reanchor // one paragraph to say back to yourse
284
284
  ```
285
285
 
286
286
  `task.context()` is what to read instead of the history: the objective, where
287
- this task stands, what is settled, what is still open. `task.graph()` is the
288
- whole tree. `deliverd.tasks.list({ status: "active" })` lists objectives; side
289
- tasks are reached through the one they belong to.
287
+ this task stands, what is settled, what is still open, and the reports already
288
+ published for it. `task.graph()` is the whole tree.
289
+ `deliverd.tasks.list({ status: "active" })` lists objectives; side tasks are
290
+ reached through the one they belong to.
291
+
292
+ A status report is written from that context and kept with the task:
293
+
294
+ ```ts
295
+ const context = await task.context();
296
+ const html = renderStatus(context); // your own: objective, state, decisions, what is open
297
+
298
+ const [existing] = context.reports; // newest first
299
+ if (existing) {
300
+ await deliverd.reports.update(existing.id, { content: html, changeSummary: "This week" });
301
+ } else {
302
+ await deliverd.reports.publish({ title: "SSO rollout: status", content: html, taskId: task.id });
303
+ }
304
+ ```
305
+
306
+ The report is then listed on the task's page and in its context, so the next
307
+ status report is a new version of it rather than a second one. A later
308
+ publish naming another `taskId` moves it there; leaving `taskId` out keeps it
309
+ where it is. It needs `tasks:read` on the key.
290
310
 
291
311
  A finding of kind `decision` is a suggestion until a person confirms it.
292
312
  `task.requestDecisionApproval(findingId)` puts it to somebody. Only a person
package/dist/dev.js CHANGED
@@ -889,6 +889,8 @@ function developmentTasks(options) {
889
889
  .filter((c) => c.outcome !== null)
890
890
  .map((c) => ({ id: c.id, title: c.title, summary: c.result?.summary ?? null, outcome: c.outcome })),
891
891
  },
892
+ // Development mode publishes nothing, so no task has a report to name.
893
+ reports: [],
892
894
  reanchor: [
893
895
  `Objective: ${root.objective}`,
894
896
  isSideTask ? `You are in a side task: ${t.title}. Its goal: ${t.objective}` : null,
@@ -43,7 +43,7 @@
43
43
  * **Add the version here when you publish it, not before.** An entry is a
44
44
  * claim that `npm install @deliverd/sdk@x` works today.
45
45
  */
46
- export declare const PUBLISHED_TO_NPM: readonly ["0.1.0", "0.2.0", "0.3.0", "0.4.0", "0.5.0", "0.6.0", "0.6.1", "0.6.2", "0.7.0", "0.7.1", "0.8.0", "0.8.1", "0.8.2", "0.9.0", "0.10.0", "0.11.0", "0.11.1", "0.12.0"];
46
+ export declare const PUBLISHED_TO_NPM: readonly ["0.1.0", "0.2.0", "0.3.0", "0.4.0", "0.5.0", "0.6.0", "0.6.1", "0.6.2", "0.7.0", "0.7.1", "0.8.0", "0.8.1", "0.8.2", "0.9.0", "0.10.0", "0.11.0", "0.11.1", "0.12.0", "0.13.0"];
47
47
  /**
48
48
  * A fingerprint of what each *published* version recorded.
49
49
  *
@@ -1 +1 @@
1
- {"version":3,"file":"released.d.ts","sourceRoot":"","sources":["../src/released.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,gBAAgB,iLAmBnB,CAAC;AAEX;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAmDzC,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAmwKtD,CAAC"}
1
+ {"version":3,"file":"released.d.ts","sourceRoot":"","sources":["../src/released.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,gBAAgB,2LAoBnB,CAAC;AAEX;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAwDzC,CAAC;AAEF,eAAO,MAAM,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAy+LtD,CAAC"}