@anchrd/colab-sdk 0.0.0-stage → 0.1.0

package/dist/versions/versions.js

@@ -0,0 +1,70 @@
+import { z } from "zod";
+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.
+// 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"];
+export const NodeVersionListInput = z.strictObject({
+    nodeId: NodeId.describe("The document, table or file whose versions to list."),
+    cursor: z
+        .string()
+        .max(100)
+        .optional()
+        .describe("The nextCursor of the previous page, unchanged. Leaving it out starts at the newest."),
+    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."),
+    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."),
+    rev: Rev,
+});
+// One entry of the history.
+export const NodeVersion = z.strictObject({
+    versionId: VersionId,
+    nodeId: NodeId,
+    // Counts from 1 per node; what people read ("Version 6").
+    number: z.number().int(),
+    // When the version began, and when its editing session last saved into it.
+    createdAt: z.iso.datetime(),
+    updatedAt: z.iso.datetime(),
+    createdBy: NodePerson,
+    // The OAuth client the author wrote through, null in the browser and for a machine's own token.
+    appHandle: z.string().nullable(),
+    // The number this version restored ("Zurückgesetzt 6 → 3"); null for an ordinary save.
+    restoredFrom: z.number().int().nullable(),
+    // The newest version, the one the node shows ("Aktuell").
+    current: z.boolean(),
+    // Bytes of the content (UTF-8 for text, the object for a file).
+    size: z.number().int(),
+});
+export const NodeVersionList = z.strictObject({
+    items: z.array(NodeVersion),
+    nextCursor: z.string().nullable(),
+    // The node's revision now, to send with a restore.
+    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.
+    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(),
+    // 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
+    // this caller.
+    ...SecretFields,
+});

package/package.json

@@ -1,6 +1,29 @@
 {
   "name": "@anchrd/colab-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Types, Zod schemas and the service client of Colab, the contract between its UI, backends and outside services.",
+  "type": "module",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anchrd/colab.git",
+    "directory": "packages/sdk"
+  },
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/sdk.d.ts",
+      "default": "./dist/sdk.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/sdk.js",
+  "types": "./dist/sdk.d.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "ulid": "^3.0.2",
+    "zod": "^4.4.3"
+  }
+}