@anchrd/colab-sdk 0.1.9 → 0.1.11

package/dist/validation/validation.d.ts

@@ -2,59 +2,6 @@ import { z } from "zod";
 export declare const validationBoardId: "node_0000000000000000000000VA1D";
 export declare const ValidationBoardId: z.ZodLiteral<"node_0000000000000000000000VA1D">;
 export type ValidationBoardId = z.infer<typeof ValidationBoardId>;
-export declare const TicketColumn: z.ZodObject<{
-    columnId: z.ZodTemplateLiteral<`column_${string}`>;
-    name: z.ZodNullable<z.ZodString>;
-    type: z.ZodNullable<z.ZodEnum<{
-        backlog: "backlog";
-        open: "open";
-        progress: "progress";
-        done: "done";
-        discarded: "discarded";
-        blocked: "blocked";
-        archive: "archive";
-    }>>;
-}, z.core.$strip>;
-export type TicketColumn = z.infer<typeof TicketColumn>;
-export declare const TicketMove: z.ZodObject<{
-    from: z.ZodNullable<z.ZodObject<{
-        columnId: z.ZodTemplateLiteral<`column_${string}`>;
-        name: z.ZodNullable<z.ZodString>;
-        type: z.ZodNullable<z.ZodEnum<{
-            backlog: "backlog";
-            open: "open";
-            progress: "progress";
-            done: "done";
-            discarded: "discarded";
-            blocked: "blocked";
-            archive: "archive";
-        }>>;
-    }, z.core.$strip>>;
-    to: z.ZodObject<{
-        columnId: z.ZodTemplateLiteral<`column_${string}`>;
-        name: z.ZodNullable<z.ZodString>;
-        type: z.ZodNullable<z.ZodEnum<{
-            backlog: "backlog";
-            open: "open";
-            progress: "progress";
-            done: "done";
-            discarded: "discarded";
-            blocked: "blocked";
-            archive: "archive";
-        }>>;
-    }, z.core.$strip>;
-    movedBy: z.ZodObject<{
-        userId: z.ZodString;
-        name: z.ZodNullable<z.ZodString>;
-        kind: z.ZodNullable<z.ZodEnum<{
-            machine: "machine";
-            human: "human";
-        }>>;
-    }, z.core.$strip>;
-    movedAt: z.ZodISODateTime;
-    comment: z.ZodNullable<z.ZodString>;
-}, z.core.$strip>;
-export type TicketMove = z.infer<typeof TicketMove>;
 export declare const TicketSubject: z.ZodObject<{
     nodeId: z.ZodTemplateLiteral<`node_${string}`>;
     kind: z.ZodEnum<{
@@ -64,7 +11,7 @@ export declare const TicketSubject: z.ZodObject<{
         table: "table";
         board: "board";
         task: "task";
-        dashboard: "dashboard";
+        gadget: "gadget";
     }>;
     name: z.ZodString;
     path: z.ZodObject<{
@@ -89,7 +36,7 @@ export declare const TicketSubjectRef: z.ZodObject<{
         table: "table";
         board: "board";
         task: "task";
-        dashboard: "dashboard";
+        gadget: "gadget";
     }>;
     path: z.ZodObject<{
         section: z.ZodEnum<{

package/dist/validation/validation.js

@@ -1,8 +1,7 @@
 import { z } from "zod";
-import { ColumnId, ColumnType } from "../columns/columns.js";
-import { NodeId, NodeKind, NodePath, NodePerson } from "../nodes/nodes.js";
-// The validation (#47, Seiten › Validierung, E33, E48, E67): one board per Colab, a ticket per
-// document, table and file, and the history of every ticket. The board is a node with a fixed id
+import { NodeId, NodeKind, NodePath } from "../nodes/nodes.js";
+// The validation (#47, Seiten › Validierung, E33, E48, E67): one board per Colab and a ticket per
+// document, table and file; a ticket's history stands in its versions (E117). The board is a node with a fixed id
 // that stands in no area of the tree; its tickets are tasks whose node is the one they validate. A
 // node's own status is `NodeValidation` in `nodes.ts`, beside the node it describes.
 // ⚠️ The board's fixed id: the same in every Colab, made on its first use (`ensureValidationBoard`
@@ -11,24 +10,6 @@ export const validationBoardId = "node_0000000000000000000000VA1D";
 export const ValidationBoardId = z
     .literal(validationBoardId)
     .describe("The validation board, the same id in every Colab.");
-// A column a ticket left or entered. Its name and type as they stand now; both null when the
-// company has removed the column since.
-export const TicketColumn = z.object({
-    columnId: ColumnId,
-    name: z.string().nullable(),
-    type: ColumnType.nullable(),
-});
-// One line of a ticket's history ("Verlauf"): every move, by Colab's bookkeeping or by hand.
-export const TicketMove = z.object({
-    // Null for the line that opened the ticket.
-    from: TicketColumn.nullable(),
-    to: TicketColumn,
-    // Who moved it; for a move of the bookkeeping, whoever wrote the change that caused it.
-    movedBy: NodePerson,
-    movedAt: z.iso.datetime(),
-    // What the mover wrote with it, null without a word.
-    comment: z.string().nullable(),
-});
 // The node a ticket validates, as the caller can read it.
 export const TicketSubject = z.object({
     nodeId: NodeId,

package/dist/versions/versions.d.ts

@@ -1,7 +1,103 @@
 import { z } from "zod";
 export declare const VersionId: z.ZodTemplateLiteral<`version_${string}`>;
 export type VersionId = z.infer<typeof VersionId>;
-export declare const versionKinds: readonly ["document", "table", "file"];
+export declare const versionKinds: readonly ["document", "table", "file", "task"];
+export declare const MoveColumn: z.ZodObject<{
+    columnId: z.ZodTemplateLiteral<`column_${string}`>;
+    name: z.ZodNullable<z.ZodString>;
+    type: z.ZodNullable<z.ZodEnum<{
+        backlog: "backlog";
+        open: "open";
+        progress: "progress";
+        done: "done";
+        discarded: "discarded";
+        blocked: "blocked";
+        archive: "archive";
+    }>>;
+}, z.core.$strip>;
+export type MoveColumn = z.infer<typeof MoveColumn>;
+export declare const VersionMove: z.ZodObject<{
+    from: z.ZodNullable<z.ZodObject<{
+        columnId: z.ZodTemplateLiteral<`column_${string}`>;
+        name: z.ZodNullable<z.ZodString>;
+        type: z.ZodNullable<z.ZodEnum<{
+            backlog: "backlog";
+            open: "open";
+            progress: "progress";
+            done: "done";
+            discarded: "discarded";
+            blocked: "blocked";
+            archive: "archive";
+        }>>;
+    }, z.core.$strip>>;
+    to: z.ZodObject<{
+        columnId: z.ZodTemplateLiteral<`column_${string}`>;
+        name: z.ZodNullable<z.ZodString>;
+        type: z.ZodNullable<z.ZodEnum<{
+            backlog: "backlog";
+            open: "open";
+            progress: "progress";
+            done: "done";
+            discarded: "discarded";
+            blocked: "blocked";
+            archive: "archive";
+        }>>;
+    }, z.core.$strip>;
+    comment: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+export type VersionMove = z.infer<typeof VersionMove>;
+export declare const taskVersionChanges: readonly ["title", "text", "assignee", "dates", "labels", "parent", "dependencies", "waiting", "fields"];
+export declare const TaskVersionChange: z.ZodEnum<{
+    fields: "fields";
+    title: "title";
+    text: "text";
+    dates: "dates";
+    assignee: "assignee";
+    labels: "labels";
+    parent: "parent";
+    dependencies: "dependencies";
+    waiting: "waiting";
+}>;
+export type TaskVersionChange = z.infer<typeof TaskVersionChange>;
+export declare const TaskMove: z.ZodObject<{
+    from: z.ZodNullable<z.ZodObject<{
+        columnId: z.ZodTemplateLiteral<`column_${string}`>;
+        name: z.ZodNullable<z.ZodString>;
+        type: z.ZodNullable<z.ZodEnum<{
+            backlog: "backlog";
+            open: "open";
+            progress: "progress";
+            done: "done";
+            discarded: "discarded";
+            blocked: "blocked";
+            archive: "archive";
+        }>>;
+    }, z.core.$strip>>;
+    to: z.ZodObject<{
+        columnId: z.ZodTemplateLiteral<`column_${string}`>;
+        name: z.ZodNullable<z.ZodString>;
+        type: z.ZodNullable<z.ZodEnum<{
+            backlog: "backlog";
+            open: "open";
+            progress: "progress";
+            done: "done";
+            discarded: "discarded";
+            blocked: "blocked";
+            archive: "archive";
+        }>>;
+    }, z.core.$strip>;
+    comment: z.ZodNullable<z.ZodString>;
+    movedBy: z.ZodObject<{
+        userId: z.ZodString;
+        name: z.ZodNullable<z.ZodString>;
+        kind: z.ZodNullable<z.ZodEnum<{
+            machine: "machine";
+            human: "human";
+        }>>;
+    }, z.core.$strip>;
+    movedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type TaskMove = z.infer<typeof TaskMove>;
 export declare const NodeVersionListInput: z.ZodObject<{
     nodeId: z.ZodTemplateLiteral<`node_${string}`>;
     cursor: z.ZodOptional<z.ZodString>;
@@ -37,6 +133,46 @@ export declare const NodeVersion: z.ZodObject<{
     restoredFrom: z.ZodNullable<z.ZodNumber>;
     current: z.ZodBoolean;
     size: z.ZodNumber;
+    move: z.ZodNullable<z.ZodObject<{
+        from: z.ZodNullable<z.ZodObject<{
+            columnId: z.ZodTemplateLiteral<`column_${string}`>;
+            name: z.ZodNullable<z.ZodString>;
+            type: z.ZodNullable<z.ZodEnum<{
+                backlog: "backlog";
+                open: "open";
+                progress: "progress";
+                done: "done";
+                discarded: "discarded";
+                blocked: "blocked";
+                archive: "archive";
+            }>>;
+        }, z.core.$strip>>;
+        to: z.ZodObject<{
+            columnId: z.ZodTemplateLiteral<`column_${string}`>;
+            name: z.ZodNullable<z.ZodString>;
+            type: z.ZodNullable<z.ZodEnum<{
+                backlog: "backlog";
+                open: "open";
+                progress: "progress";
+                done: "done";
+                discarded: "discarded";
+                blocked: "blocked";
+                archive: "archive";
+            }>>;
+        }, z.core.$strip>;
+        comment: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+    changes: z.ZodNullable<z.ZodArray<z.ZodEnum<{
+        fields: "fields";
+        title: "title";
+        text: "text";
+        dates: "dates";
+        assignee: "assignee";
+        labels: "labels";
+        parent: "parent";
+        dependencies: "dependencies";
+        waiting: "waiting";
+    }>>>;
 }, z.core.$strip>;
 export type NodeVersion = z.infer<typeof NodeVersion>;
 export declare const NodeVersionList: z.ZodObject<{
@@ -58,6 +194,46 @@ export declare const NodeVersionList: z.ZodObject<{
         restoredFrom: z.ZodNullable<z.ZodNumber>;
         current: z.ZodBoolean;
         size: z.ZodNumber;
+        move: z.ZodNullable<z.ZodObject<{
+            from: z.ZodNullable<z.ZodObject<{
+                columnId: z.ZodTemplateLiteral<`column_${string}`>;
+                name: z.ZodNullable<z.ZodString>;
+                type: z.ZodNullable<z.ZodEnum<{
+                    backlog: "backlog";
+                    open: "open";
+                    progress: "progress";
+                    done: "done";
+                    discarded: "discarded";
+                    blocked: "blocked";
+                    archive: "archive";
+                }>>;
+            }, z.core.$strip>>;
+            to: z.ZodObject<{
+                columnId: z.ZodTemplateLiteral<`column_${string}`>;
+                name: z.ZodNullable<z.ZodString>;
+                type: z.ZodNullable<z.ZodEnum<{
+                    backlog: "backlog";
+                    open: "open";
+                    progress: "progress";
+                    done: "done";
+                    discarded: "discarded";
+                    blocked: "blocked";
+                    archive: "archive";
+                }>>;
+            }, z.core.$strip>;
+            comment: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>>;
+        changes: z.ZodNullable<z.ZodArray<z.ZodEnum<{
+            fields: "fields";
+            title: "title";
+            text: "text";
+            dates: "dates";
+            assignee: "assignee";
+            labels: "labels";
+            parent: "parent";
+            dependencies: "dependencies";
+            waiting: "waiting";
+        }>>>;
     }, z.core.$strip>>;
     nextCursor: z.ZodNullable<z.ZodString>;
     rev: z.ZodNumber;
@@ -81,6 +257,46 @@ export declare const NodeVersionDetail: z.ZodObject<{
     restoredFrom: z.ZodNullable<z.ZodNumber>;
     current: z.ZodBoolean;
     size: z.ZodNumber;
+    move: z.ZodNullable<z.ZodObject<{
+        from: z.ZodNullable<z.ZodObject<{
+            columnId: z.ZodTemplateLiteral<`column_${string}`>;
+            name: z.ZodNullable<z.ZodString>;
+            type: z.ZodNullable<z.ZodEnum<{
+                backlog: "backlog";
+                open: "open";
+                progress: "progress";
+                done: "done";
+                discarded: "discarded";
+                blocked: "blocked";
+                archive: "archive";
+            }>>;
+        }, z.core.$strip>>;
+        to: z.ZodObject<{
+            columnId: z.ZodTemplateLiteral<`column_${string}`>;
+            name: z.ZodNullable<z.ZodString>;
+            type: z.ZodNullable<z.ZodEnum<{
+                backlog: "backlog";
+                open: "open";
+                progress: "progress";
+                done: "done";
+                discarded: "discarded";
+                blocked: "blocked";
+                archive: "archive";
+            }>>;
+        }, z.core.$strip>;
+        comment: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>>;
+    changes: z.ZodNullable<z.ZodArray<z.ZodEnum<{
+        fields: "fields";
+        title: "title";
+        text: "text";
+        dates: "dates";
+        assignee: "assignee";
+        labels: "labels";
+        parent: "parent";
+        dependencies: "dependencies";
+        waiting: "waiting";
+    }>>>;
     secret: z.ZodOptional<z.ZodLiteral<true>>;
     locked: z.ZodOptional<z.ZodBoolean>;
     content: z.ZodNullable<z.ZodString>;
@@ -95,6 +311,22 @@ export declare const NodeVersionDetail: z.ZodObject<{
             chip: "chip";
         }>;
     }, z.core.$strict>>>;
+    fields: z.ZodNullable<z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        type: z.ZodEnum<{
+            number: "number";
+            date: "date";
+            list: "list";
+            link: "link";
+            text: "text";
+            checklist: "checklist";
+            select: "select";
+        }>;
+        value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodArray<z.ZodString>, z.ZodArray<z.ZodObject<{
+            text: z.ZodString;
+            done: z.ZodBoolean;
+        }, z.core.$strip>>]>;
+    }, z.core.$strip>>>;
     rev: z.ZodNumber;
 }, z.core.$strip>;
 export type NodeVersionDetail = z.infer<typeof NodeVersionDetail>;

package/dist/versions/versions.js

@@ -1,19 +1,56 @@
 import { z } from "zod";
+import { CardFieldType, CardFieldValue } from "../card-kinds/card-kinds.js";
+import { ColumnId, ColumnType } from "../columns/columns.js";
 import { idSchema } from "../ids/ids.js";
 import { Limit as PageSize } from "../list-input.js";
 import { NodeId, NodePerson, SecretFields } from "../nodes/nodes.js";
 import { Rev } from "../primitives/primitives.js";
 import { TableColumn } from "../tables/tables.js";
-// Versions of documents, tables and files (#38, Funktionen › Freigeben und Versionen, E37, E70): the
-// inputs of `intelligence_node_version_list`, `_get` and `_create`, and their answers. Content is
-// written by the tools of its kind (#39, #40, #41); these three only read the history and restore.
+// Versions of documents, tables, files and tasks (#38, #637, Funktionen › Freigeben und Versionen, E37,
+// E70, E117): the inputs of `intelligence_node_version_list`, `_get` and `_create`, and their answers.
+// Content is written by the tools of its kind (#39, #40, #41, #42); these three only read the history
+// and restore. A task's versions are its history: every move to another column is one of its own.
 // Every answer carries the node's `rev`, the state the next save sends back (E70); people see the
 // version number, never the rev.
 export const VersionId = idSchema("version").describe("The version's id, `version_…`.");
-// The kinds that have versions (E37): the same three that are validated.
-export const versionKinds = ["document", "table", "file"];
+// The kinds that have versions (E37, E117): the three that are validated, and tasks.
+export const versionKinds = ["document", "table", "file", "task"];
+// A column a task left or entered (E117): its name and type as they stand now; both null when the
+// board's column has been removed since.
+export const MoveColumn = z.object({
+    columnId: ColumnId,
+    name: z.string().nullable(),
+    type: ColumnType.nullable(),
+});
+// A task's move in one of its versions (E117): from where to where, and what the mover wrote with
+// it. `from` is null for the version that made the task, in the column it was made in.
+export const VersionMove = z.object({
+    from: MoveColumn.nullable(),
+    to: MoveColumn,
+    comment: z.string().nullable(),
+});
+// What a task's version changed besides a move (E117): the words the history names, in this order.
+// The fields of a card kind (#638) come later as their own entries.
+export const taskVersionChanges = [
+    "title",
+    "text",
+    "assignee",
+    "dates",
+    "labels",
+    "parent",
+    "dependencies",
+    "waiting",
+    "fields",
+];
+export const TaskVersionChange = z.enum(taskVersionChanges);
+// The last move of a task (E117): what the ticket of the validation shows in its bar ("Neu → Offen ·
+// Operator · 3. Okt."), read from its versions.
+export const TaskMove = VersionMove.extend({
+    movedBy: NodePerson,
+    movedAt: z.iso.datetime(),
+});
 export const NodeVersionListInput = z.strictObject({
-    nodeId: NodeId.describe("The document, table or file whose versions to list."),
+    nodeId: NodeId.describe("The document, table, file or task whose versions to list."),
     cursor: z
         .string()
         .max(100)
@@ -22,12 +59,12 @@ export const NodeVersionListInput = z.strictObject({
     limit: PageSize.optional().describe("How many versions one page holds, 1 to 100. Leaving it out gives 50."),
 });
 export const NodeVersionGetInput = z.strictObject({
-    nodeId: NodeId.describe("The document, table or file the version belongs to."),
+    nodeId: NodeId.describe("The document, table, file or task the version belongs to."),
     versionId: VersionId.describe("The version to read, from intelligence_node_version_list. A version of another node answers not_found."),
 });
 export const NodeVersionCreateInput = z.strictObject({
-    nodeId: NodeId.describe("The document, table or file to restore an earlier state of."),
-    fromVersionId: VersionId.describe("The version whose content becomes the newest version again. Nothing is deleted: the versions after it stay, and the new one says which number it was restored from."),
+    nodeId: NodeId.describe("The document, table, file or task to restore an earlier state of."),
+    fromVersionId: VersionId.describe("The version whose content becomes the newest version again. Nothing is deleted: the versions after it stay, and the new one says which number it was restored from. For a task only its text comes back, never its column or assignee."),
     rev: Rev,
 });
 // One entry of the history.
@@ -48,6 +85,11 @@ export const NodeVersion = z.object({
     current: z.boolean(),
     // Bytes of the content (UTF-8 for text, the object for a file).
     size: z.number().int(),
+    // Only for a task (E117): the move this version is, null for a save that did not move it.
+    move: VersionMove.nullable(),
+    // Only for a task (E117): what else this version changed, an empty list for none; null for every
+    // other kind.
+    changes: z.array(TaskVersionChange).nullable(),
 });
 export const NodeVersionList = z.object({
     items: z.array(NodeVersion),
@@ -56,12 +98,17 @@ export const NodeVersionList = z.object({
     rev: z.number().int(),
 });
 export const NodeVersionDetail = NodeVersion.extend({
-    // The text of a document (Markdown) or a table; null for a file, whose bytes come with #41.
+    // The text of a document or a task (Markdown) or a table; null for a file, whose bytes come with #41.
     content: z.string().nullable(),
     // Only for a file: its media type.
     mediaType: z.string().nullable(),
     // Only for a table: its columns with their types in this version (#40).
     columns: z.array(TableColumn).nullable(),
+    // Only for a task of a card kind (#638): the values of its fields in this version, by the field's
+    // name and type, a field removed since then included; null for every other version.
+    fields: z
+        .array(z.object({ name: z.string(), type: CardFieldType, value: CardFieldValue }))
+        .nullable(),
     // The node's revision now: after a restore the one the next save sends.
     rev: z.number().int(),
     // A version of a secret node (#357): `content` and `columns` are null while it is `locked` for

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anchrd/colab-sdk",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "Types, Zod schemas and the service client of Colab, the contract between its UI, backends and outside services.",
   "type": "module",
   "license": "UNLICENSED",