runline 0.11.6 → 0.13.0

package/dist/plugins/googleDocs/src/shared.js

@@ -1,10 +1,65 @@
+import * as t from "typebox";
 import { googleAccessToken } from "../../_shared/googleAuth.js";
+import { RawGoogleObject } from "../../_shared/googleSchemas.js";
 export const SCOPES = [
     "https://www.googleapis.com/auth/documents",
     "https://www.googleapis.com/auth/drive.file",
 ];
 export const DOCS_BASE = "https://docs.googleapis.com/v1";
 export const DRIVE_BASE = "https://www.googleapis.com/drive/v3";
+export const STRICT_OBJECT = { additionalProperties: false };
+export const DocumentInput = {
+    document: t.String({ minLength: 1, description: "Document ID or URL" }),
+};
+export const SegmentInput = {
+    segmentId: t.Optional(t.String({ description: 'Segment ID, or "body" for the main body' })),
+    tabId: t.Optional(t.String({ minLength: 1 })),
+};
+export const RangeInput = {
+    startIndex: t.Integer({ minimum: 0 }),
+    endIndex: t.Integer({ minimum: 0 }),
+    ...SegmentInput,
+};
+export const TableLocationInput = {
+    tableStartIndex: t.Integer({ minimum: 0 }),
+    rowIndex: t.Integer({ minimum: 0 }),
+    columnIndex: t.Integer({ minimum: 0 }),
+    ...SegmentInput,
+};
+export const LocationInput = {
+    locationKind: t.Optional(t.Union([t.Literal("location"), t.Literal("endOfSegmentLocation")])),
+    index: t.Optional(t.Integer({ minimum: 0 })),
+    ...SegmentInput,
+};
+export const LOCATION_REQUIREMENT = [
+    {
+        required: ["index"],
+        not: {
+            required: ["locationKind"],
+            properties: { locationKind: { const: "endOfSegmentLocation" } },
+        },
+    },
+    {
+        required: ["locationKind"],
+        properties: { locationKind: { const: "endOfSegmentLocation" } },
+        not: { required: ["index"] },
+    },
+];
+export const HexColor = t.String({
+    pattern: "^#?(?:[0-9a-fA-F]{3}|[0-9a-fA-F]{6})$",
+});
+export const PositivePoints = t.Number({ minimum: 0 });
+export const WriteControl = t.Object({
+    requiredRevisionId: t.Optional(t.String({ minLength: 1 })),
+    targetRevisionId: t.Optional(t.String({ minLength: 1 })),
+}, {
+    additionalProperties: false,
+    oneOf: [
+        { required: ["requiredRevisionId"] },
+        { required: ["targetRevisionId"] },
+    ],
+});
+export { RawGoogleObject };
 export async function accessToken(ctx) {
     return googleAccessToken(ctx, "googleDocs", SCOPES);
 }

package/dist/plugins/googleDocs/src/structure.js

@@ -1,4 +1,5 @@
-import { buildLocation, compact, extractDocumentId, location, runBatchUpdate, } from "./shared.js";
+import * as t from "typebox";
+import { buildLocation, compact, DocumentInput, extractDocumentId, LOCATION_REQUIREMENT, LocationInput, location, PositivePoints, RangeInput, runBatchUpdate, SegmentInput, STRICT_OBJECT, } from "./shared.js";
 function range(p) {
     return compact({
         segmentId: p.segmentId && p.segmentId !== "body" ? p.segmentId : "",
@@ -12,14 +13,9 @@ function point(value) {
 }
 export function registerStructureActions(rl) {
     rl.registerAction("document.insertPageBreak", {
+        access: "write",
         description: "Insert a page break at an index or at the end of a segment.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            locationKind: { type: "string", required: false },
-            index: { type: "number", required: false },
-            segmentId: { type: "string", required: false },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({ ...DocumentInput, ...LocationInput }, { ...STRICT_OBJECT, anyOf: LOCATION_REQUIREMENT }),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -30,15 +26,13 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.createNamedRange", {
+        access: "write",
         description: "Create a named range over a span of text (useful for later programmatic edits).",
-        inputSchema: {
-            document: { type: "string", required: true },
-            name: { type: "string", required: true },
-            startIndex: { type: "number", required: true },
-            endIndex: { type: "number", required: true },
-            segmentId: { type: "string", required: false },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            name: t.String({ minLength: 1 }),
+            ...RangeInput,
+        }, STRICT_OBJECT),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -51,17 +45,17 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.deleteNamedRange", {
+        access: "write",
         description: "Delete named range(s). Pass one of `namedRangeId` or `name`; the latter deletes every range sharing that name.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            namedRangeId: { type: "string", required: false },
-            name: { type: "string", required: false },
-            tabIds: {
-                type: "array",
-                required: false,
-                description: "Optional tab IDs for tabsCriteria.",
-            },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            namedRangeId: t.Optional(t.String({ minLength: 1 })),
+            name: t.Optional(t.String({ minLength: 1 })),
+            tabIds: t.Optional(t.Array(t.String({ minLength: 1 }), { minItems: 1 })),
+        }, {
+            ...STRICT_OBJECT,
+            oneOf: [{ required: ["namedRangeId"] }, { required: ["name"] }],
+        }),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -77,14 +71,9 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.createHeader", {
+        access: "write",
         description: "Create a DEFAULT header attached to a SectionBreak.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            locationKind: { type: "string", required: false },
-            index: { type: "number", required: false },
-            segmentId: { type: "string", required: false },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({ ...DocumentInput, ...LocationInput }, { ...STRICT_OBJECT, anyOf: LOCATION_REQUIREMENT }),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -106,11 +95,13 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.deleteHeader", {
+        access: "write",
         description: "Delete a header by ID.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            headerId: { type: "string", required: true },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            headerId: t.String({ minLength: 1 }),
+            tabId: t.Optional(t.String({ minLength: 1 })),
+        }, STRICT_OBJECT),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -120,14 +111,9 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.createFooter", {
+        access: "write",
         description: "Create a DEFAULT footer attached to a SectionBreak.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            locationKind: { type: "string", required: false },
-            index: { type: "number", required: false },
-            segmentId: { type: "string", required: false },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({ ...DocumentInput, ...LocationInput }, { ...STRICT_OBJECT, anyOf: LOCATION_REQUIREMENT }),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -149,11 +135,13 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.deleteFooter", {
+        access: "write",
         description: "Delete a footer by ID.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            footerId: { type: "string", required: true },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            footerId: t.String({ minLength: 1 }),
+            tabId: t.Optional(t.String({ minLength: 1 })),
+        }, STRICT_OBJECT),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -163,12 +151,13 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.deletePositionedObject", {
+        access: "write",
         description: "Delete a positioned object (inline image, floating image, etc.) by its objectId.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            objectId: { type: "string", required: true },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            objectId: t.String({ minLength: 1 }),
+            tabId: t.Optional(t.String({ minLength: 1 })),
+        }, STRICT_OBJECT),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -181,18 +170,9 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.createFootnote", {
+        access: "write",
         description: "Create a footnote reference at a location or at the end of the document body.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            locationKind: {
-                type: "string",
-                required: false,
-                description: "location (default; requires index) | endOfSegmentLocation",
-            },
-            index: { type: "number", required: false },
-            segmentId: { type: "string", required: false },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({ ...DocumentInput, ...LocationInput }, { ...STRICT_OBJECT, anyOf: LOCATION_REQUIREMENT }),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -203,18 +183,21 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.replaceNamedRangeContent", {
+        access: "write",
         description: "Replace the content of a named range by ID or name with text.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            text: { type: "string", required: true },
-            namedRangeId: { type: "string", required: false },
-            namedRangeName: { type: "string", required: false },
-            tabIds: {
-                type: "array",
-                required: false,
-                description: "Optional tab IDs for tabsCriteria.",
-            },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            text: t.String(),
+            namedRangeId: t.Optional(t.String({ minLength: 1 })),
+            namedRangeName: t.Optional(t.String({ minLength: 1 })),
+            tabIds: t.Optional(t.Array(t.String({ minLength: 1 }), { minItems: 1 })),
+        }, {
+            ...STRICT_OBJECT,
+            oneOf: [
+                { required: ["namedRangeId"] },
+                { required: ["namedRangeName"] },
+            ],
+        }),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -234,33 +217,30 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.updateSectionStyle", {
+        access: "write",
         description: "Update section style over a range, such as margins or column properties.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            startIndex: { type: "number", required: true },
-            endIndex: { type: "number", required: true },
-            marginTopPt: { type: "number", required: false },
-            marginBottomPt: { type: "number", required: false },
-            marginLeftPt: { type: "number", required: false },
-            marginRightPt: { type: "number", required: false },
-            columnSeparatorStyle: {
-                type: "string",
-                required: false,
-                description: "NONE | BETWEEN_EACH_COLUMN",
-            },
-            contentDirection: {
-                type: "string",
-                required: false,
-                description: "LEFT_TO_RIGHT | RIGHT_TO_LEFT",
-            },
-            fields: {
-                type: "string",
-                required: false,
-                description: "Field mask. Defaults to fields implied by supplied properties.",
-            },
-            segmentId: { type: "string", required: false },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            ...RangeInput,
+            marginTopPt: t.Optional(PositivePoints),
+            marginBottomPt: t.Optional(PositivePoints),
+            marginLeftPt: t.Optional(PositivePoints),
+            marginRightPt: t.Optional(PositivePoints),
+            columnSeparatorStyle: t.Optional(t.Union([t.Literal("NONE"), t.Literal("BETWEEN_EACH_COLUMN")])),
+            contentDirection: t.Optional(t.Union([t.Literal("LEFT_TO_RIGHT"), t.Literal("RIGHT_TO_LEFT")])),
+            fields: t.Optional(t.String({ minLength: 1 })),
+        }, {
+            ...STRICT_OBJECT,
+            anyOf: [
+                { required: ["marginTopPt"] },
+                { required: ["marginBottomPt"] },
+                { required: ["marginLeftPt"] },
+                { required: ["marginRightPt"] },
+                { required: ["columnSeparatorStyle"] },
+                { required: ["contentDirection"] },
+                { required: ["fields"] },
+            ],
+        }),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -303,18 +283,14 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.insertSectionBreak", {
+        access: "write",
         description: "Insert a section break at the given location.",
-        inputSchema: {
-            document: { type: "string", required: true },
-            index: { type: "number", required: true },
-            sectionType: {
-                type: "string",
-                required: false,
-                description: "CONTINUOUS | NEXT_PAGE. Default CONTINUOUS.",
-            },
-            segmentId: { type: "string", required: false },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            index: t.Integer({ minimum: 0 }),
+            sectionType: t.Optional(t.Union([t.Literal("CONTINUOUS"), t.Literal("NEXT_PAGE")])),
+            ...SegmentInput,
+        }, STRICT_OBJECT),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);
@@ -329,18 +305,30 @@ export function registerStructureActions(rl) {
         },
     });
     rl.registerAction("document.updateDocumentStyle", {
+        access: "write",
         description: "Update document-level style (page size, margins, page numbers, default direction).",
-        inputSchema: {
-            document: { type: "string", required: true },
-            pageMarginTopPt: { type: "number", required: false },
-            pageMarginBottomPt: { type: "number", required: false },
-            pageMarginLeftPt: { type: "number", required: false },
-            pageMarginRightPt: { type: "number", required: false },
-            pageSizeWidthPt: { type: "number", required: false },
-            pageSizeHeightPt: { type: "number", required: false },
-            useCustomHeaderFooterMargins: { type: "boolean", required: false },
-            tabId: { type: "string", required: false },
-        },
+        inputSchema: t.Object({
+            ...DocumentInput,
+            pageMarginTopPt: t.Optional(PositivePoints),
+            pageMarginBottomPt: t.Optional(PositivePoints),
+            pageMarginLeftPt: t.Optional(PositivePoints),
+            pageMarginRightPt: t.Optional(PositivePoints),
+            pageSizeWidthPt: t.Optional(PositivePoints),
+            pageSizeHeightPt: t.Optional(PositivePoints),
+            useCustomHeaderFooterMargins: t.Optional(t.Boolean()),
+            tabId: t.Optional(t.String({ minLength: 1 })),
+        }, {
+            ...STRICT_OBJECT,
+            anyOf: [
+                { required: ["pageMarginTopPt"] },
+                { required: ["pageMarginBottomPt"] },
+                { required: ["pageMarginLeftPt"] },
+                { required: ["pageMarginRightPt"] },
+                { required: ["pageSizeWidthPt"] },
+                { required: ["pageSizeHeightPt"] },
+                { required: ["useCustomHeaderFooterMargins"] },
+            ],
+        }),
         async execute(input, ctx) {
             const p = (input ?? {});
             const documentId = extractDocumentId(p.document);