@anchrd/colab-sdk 0.1.16 → 0.1.18

package/dist/written/written.js

@@ -0,0 +1,90 @@
+import { z } from "zod";
+import { AppId, SessionId } from "../apps/apps.js";
+import { ConnectionId } from "../connections/connections.js";
+import { ConnectorId } from "../connectors/connectors.js";
+import { Warning } from "../error/error.js";
+import { GrantId } from "../grants/grants.js";
+import { InvitationId } from "../invitations/invitations.js";
+import { LinkId } from "../links/links.js";
+import { MachineId } from "../machines/machines.js";
+import { MessageId } from "../messages/messages.js";
+import { Missing, Reached } from "../missing/missing.js";
+import { NodeId, NodeReader } from "../nodes/nodes.js";
+import { CredentialId } from "../operators/operators.js";
+import { RoleId } from "../roles/roles.js";
+import { RunId } from "../runs/runs.js";
+import { FunctionId, InterfaceId, ServiceId } from "../services/services.js";
+import { SsoId } from "../sso/sso.js";
+import { UserId } from "../users/users.js";
+// What a write answers over `/mcp` (E126, #672): what it changed and what that caused, never the
+// object it wrote. The AI sent the object itself; echoing it back filled an Operator's context with
+// every card and document it saved (#617). `/api` keeps the whole object for the UI.
+// One thing a write changed: its id under its resource's name, and where the resource has them the
+// `rev` for the next save (E70) and the version number. A folder, and a node of any kind where the
+// tool is about nodes, is `nodeId`.
+export const Changed = z.object({
+    nodeId: NodeId.optional(),
+    documentId: NodeId.optional(),
+    tableId: NodeId.optional(),
+    fileId: NodeId.optional(),
+    boardId: NodeId.optional(),
+    taskId: NodeId.optional(),
+    gadgetId: NodeId.optional(),
+    runId: RunId.optional(),
+    messageId: MessageId.optional(),
+    // A chat is its node's (#45).
+    chatId: NodeId.optional(),
+    grantId: GrantId.optional(),
+    linkId: LinkId.optional(),
+    // A person or machine in `access`, and the caller's own settings in `intelligence`.
+    userId: UserId.optional(),
+    // The other packages (#743). A machine is `machineId` in `access` and an Operator in `operator`,
+    // its `user_…` id either way.
+    machineId: MachineId.optional(),
+    roleId: RoleId.optional(),
+    // The rights a switch of a role really turned on or off, which a level in the call expands to.
+    permissions: z.array(z.string()).optional(),
+    invitationId: InvitationId.optional(),
+    serviceId: ServiceId.optional(),
+    interfaceId: InterfaceId.optional(),
+    functionId: FunctionId.optional(),
+    appId: AppId.optional(),
+    sessionId: SessionId.optional(),
+    ssoId: SsoId.optional(),
+    connectorId: ConnectorId.optional(),
+    connectionId: ConnectionId.optional(),
+    credentialId: CredentialId.optional(),
+    // The caller's own name for an entry of a create of many (#625).
+    ref: z.string().optional(),
+    rev: z.number().int().optional(),
+    version: z.number().int().optional(),
+});
+// A task that waited only on what this call closed, and now waits on nothing (Nodes › Aufgabe):
+// whoever closed a task moves the next one to Open (E124). `own` marks the caller's: with its `rev`
+// the caller writes it at once, without reading it first.
+export const Unblocked = z.object({
+    taskId: NodeId,
+    title: z.string(),
+    assignee: Reached,
+    rev: z.number().int(),
+    own: z.literal(true).optional(),
+});
+// What the write caused for others; an empty field is left out.
+export const Effects = z.object({
+    // Machines whose Actions changed by it (#334, E124): an Operator among them wakes.
+    woken: z.array(Reached).optional(),
+    // People it put something in front of in their Actions, by mail as their setting says (#50).
+    notified: z.array(Reached).optional(),
+    // Tasks ready now, because the last thing they waited on was closed by this call.
+    unblocked: z.array(Unblocked).optional(),
+    // Nodes whose validation went back to new (#47): their new version is unchecked.
+    validationReset: z.array(NodeId).optional(),
+    // Who reads a moved node now (#36): a move takes the grants of its new folder.
+    readers: z.array(NodeReader).optional(),
+});
+export const Written = z.object({
+    changed: z.array(Changed),
+    effects: Effects.optional(),
+    missing: z.array(Missing).optional(),
+    warnings: z.array(Warning).optional(),
+});

package/package.json

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