@anchrd/colab-sdk 0.1.3 → 0.1.5

package/dist/files/files.d.ts

@@ -7,11 +7,13 @@ export declare const fileFormatExtensions: Record<FileFormat, readonly string[]>
 export declare function fileFormatOf(name: string): FileFormat | null;
 export declare const uploadTicketHeader = "x-colab-upload-ticket";
 export declare const uploadTicketLifetimeMs: number;
+export declare const SourceUrl: z.ZodString;
 export declare const FileCreateInput: z.ZodObject<{
     parentId: z.ZodNullable<z.ZodTemplateLiteral<`node_${string}`>>;
-    name: z.ZodString;
-    mediaType: z.ZodString;
-    size: z.ZodNumber;
+    name: z.ZodOptional<z.ZodString>;
+    mediaType: z.ZodOptional<z.ZodString>;
+    size: z.ZodOptional<z.ZodNumber>;
+    sourceUrl: z.ZodOptional<z.ZodString>;
     idempotencyKey: z.ZodString;
 }, z.core.$strict>;
 export type FileCreateInput = z.infer<typeof FileCreateInput>;
@@ -56,5 +58,7 @@ export declare const FileDetail: z.ZodObject<{
     rev: z.ZodNumber;
     text: z.ZodNullable<z.ZodString>;
     contentUrl: z.ZodURL;
+    sourceUrl: z.ZodOptional<z.ZodString>;
+    fetchedAt: z.ZodOptional<z.ZodISODateTime>;
 }, z.core.$strict>;
 export type FileDetail = z.infer<typeof FileDetail>;

package/dist/files/files.js

@@ -92,13 +92,48 @@ const FileName = z
     .string()
     .max(200)
     .describe("The file's name with its extension, like Preisliste.pdf. It is the name the download carries; on a new file it is also the node's name.");
-export const FileCreateInput = z.strictObject({
+// The address Colab fetches a file from itself (#556, E105). Only its shape is checked here; which
+// addresses are allowed (https, public hosts, no redirect elsewhere) is decided where it is fetched.
+export const SourceUrl = z
+    .string()
+    .trim()
+    .min(1)
+    .max(2048)
+    .describe("The https address of a public document on the web, like a PDF of a study. Colab downloads it itself and stores it like an upload; leave name optional and send no mediaType or size, Colab reads both from the answer. Only public hosts, at most 100 MB.");
+export const FileCreateInput = z
+    .strictObject({
     // ⚠️ Required and nullable (trap C015): null is the top level of Shared, like a folder.
     parentId: NodeId.nullable().describe("The folder to put the file in, one you can write to; null puts it on the top level of Shared, visible to you until you share it."),
-    name: FileName,
-    mediaType: MediaType,
-    size: Size,
+    // Required for an upload, optional with `sourceUrl`; the refinement below says so.
+    name: FileName.optional(),
+    mediaType: MediaType.optional(),
+    size: Size.optional(),
+    sourceUrl: SourceUrl.optional(),
     idempotencyKey: IdempotencyKey,
+})
+    // An upload names its file, type and size; a file from an address is measured by Colab (#556).
+    .superRefine((input, ctx) => {
+    if (input.sourceUrl === undefined) {
+        for (const field of ["name", "mediaType", "size"]) {
+            if (input[field] === undefined) {
+                ctx.addIssue({
+                    code: "custom",
+                    path: [field],
+                    message: `An upload needs ${field}; or send sourceUrl and Colab fetches the file itself.`,
+                });
+            }
+        }
+        return;
+    }
+    for (const field of ["mediaType", "size"]) {
+        if (input[field] !== undefined) {
+            ctx.addIssue({
+                code: "custom",
+                path: [field],
+                message: `With sourceUrl Colab reads ${field} from the answer; leave it out.`,
+            });
+        }
+    }
 });
 export const FileUpdateInput = z.strictObject({
     fileId: FileId.describe("The file to upload a new version of."),
@@ -136,4 +171,7 @@ export const FileDetail = z.strictObject({
     text: z.string().nullable(),
     // Where the bytes are read, with a session or a token and the right to read the file.
     contentUrl: z.url(),
+    // Only on a version Colab fetched from an address (#556): the address asked for and when.
+    sourceUrl: z.string().optional(),
+    fetchedAt: z.iso.datetime().optional(),
 });

package/dist/grammar/grammar.d.ts

@@ -34,7 +34,7 @@ export declare const resources: {
     readonly secret: "secrets";
 };
 export declare const actions: readonly ["list", "get", "create", "update", "archive", "restore", "purge"];
-export declare const verbs: readonly ["invite", "resend", "disable", "enable", "rotate", "share", "move", "start", "complete", "test", "revoke", "remove", "unlock"];
+export declare const verbs: readonly ["invite", "resend", "disable", "enable", "rotate", "share", "move", "start", "complete", "test", "revoke", "remove", "unlock", "publish", "schedule", "unpublish"];
 export type Package = (typeof packages)[number];
 export type Resource = keyof typeof resources;
 export type Action = (typeof actions)[number] | (typeof verbs)[number];

package/dist/grammar/grammar.js

@@ -78,6 +78,12 @@ export const verbs = [
     // (#357, E94), decided by the orchestrator: `intelligence_node_unlock`. Not `get` (it changes who
     // may read) and not `create` of a resource (the release is no thing anybody lists or names).
     "unlock",
+    // A connector's post at a CMS goes live, goes live later, or goes back off the site (#557, named by
+    // the ticket): `emdash_post_publish`, `_schedule`, `_unpublish`. Not `update`: each is its own right,
+    // so a role may write drafts without being able to publish them.
+    "publish",
+    "schedule",
+    "unpublish",
 ];
 export function isPackage(word) {
     return packages.includes(word);

package/dist/runs/runs.d.ts

@@ -108,6 +108,9 @@ export declare const RunItem: z.ZodObject<{
     values: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodNull]>>>;
     summaries: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>>;
     reports: z.ZodNullable<z.ZodNumber>;
+    rights: z.ZodObject<{
+        complete: z.ZodBoolean;
+    }, z.core.$strict>;
 }, z.core.$strict>;
 export type RunItem = z.infer<typeof RunItem>;
 export declare const RunList: z.ZodObject<{
@@ -148,6 +151,9 @@ export declare const RunList: z.ZodObject<{
         values: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodNull]>>>;
         summaries: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>>;
         reports: z.ZodNullable<z.ZodNumber>;
+        rights: z.ZodObject<{
+            complete: z.ZodBoolean;
+        }, z.core.$strict>;
     }, z.core.$strict>>;
     nextCursor: z.ZodNullable<z.ZodString>;
 }, z.core.$strict>;
@@ -240,5 +246,8 @@ export declare const RunDetail: z.ZodObject<{
     values: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodNumber, z.ZodString, z.ZodNull]>>>;
     summaries: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodNullable<z.ZodString>>>;
     reports: z.ZodNullable<z.ZodNumber>;
+    rights: z.ZodObject<{
+        complete: z.ZodBoolean;
+    }, z.core.$strict>;
 }, z.core.$strict>;
 export type RunDetail = z.infer<typeof RunDetail>;

package/dist/runs/runs.js

@@ -105,6 +105,10 @@ export const RunItem = z.strictObject({
     summaries: z.record(z.string(), z.string().nullable()).nullable(),
     // A dashboard's count of values and summaries that carry a report; null for a process (#164).
     reports: z.number().int().nullable(),
+    // `complete`: whether the caller may close this run with intelligence_run_complete, by the same
+    // check the tool makes (E107): write on a process board or dashboard; on the validation the holder
+    // of validator or an admin in admin mode. The UI shows "Lauf beenden" by it.
+    rights: z.strictObject({ complete: z.boolean() }),
 });
 export const RunList = z.strictObject({
     items: z.array(RunItem),

package/package.json

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