@hostwebhook/node-types 1.52.7 → 1.52.8

package/dist/index.d.ts

@@ -19,6 +19,8 @@ export { DISCORD_OPERATIONS, DISCORD_OPERATION_SPECS, isDiscordOperation, } from
 export type { DiscordOperation, DiscordParamSpec, DiscordOperationSpec, } from './discord-operations';
 export { SLACK_OPERATIONS, SLACK_OPERATION_SPECS, isSlackOperation, } from './slack-operations';
 export type { SlackOperation, SlackParamSpec, SlackOperationSpec, } from './slack-operations';
+export { SHEETS_OPERATIONS, SHEETS_OPERATION_SPECS, isSheetsOperation, } from './sheets-operations';
+export type { SheetsOperation, SheetsParamSpec, SheetsOperationSpec, } from './sheets-operations';
 export { GOOGLE_CONTACTS_OPERATIONS, GOOGLE_CONTACTS_OPERATIONS_V1, GOOGLE_CONTACTS_OPERATIONS_V2, GOOGLE_CONTACTS_OPERATION_SPECS, GOOGLE_CONTACTS_OPERATION_GROUPS, GOOGLE_CONTACTS_DEFAULT_PERSON_FIELDS, isGoogleContactsOperation, } from './google-contacts-operations';
 export type { GoogleContactsOperation, GoogleContactsParamSpec, GoogleContactsOperationSpec, GoogleContactsOperationGroup, } from './google-contacts-operations';
 export type { CredentialTypeRegistration, CredentialType } from './credentials';

package/dist/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCredentialType = exports.getCredentialType = exports.credentialTypeValues = exports.CREDENTIAL_TYPE_VALUES = exports.CREDENTIAL_TYPES = exports.isGoogleContactsOperation = exports.GOOGLE_CONTACTS_DEFAULT_PERSON_FIELDS = exports.GOOGLE_CONTACTS_OPERATION_GROUPS = exports.GOOGLE_CONTACTS_OPERATION_SPECS = exports.GOOGLE_CONTACTS_OPERATIONS_V2 = exports.GOOGLE_CONTACTS_OPERATIONS_V1 = exports.GOOGLE_CONTACTS_OPERATIONS = exports.isSlackOperation = exports.SLACK_OPERATION_SPECS = exports.SLACK_OPERATIONS = exports.isDiscordOperation = exports.DISCORD_OPERATION_SPECS = exports.DISCORD_OPERATIONS = exports.isWhatsAppOperation = exports.WHATSAPP_OPERATIONS = exports.isTelegramOperation = exports.TELEGRAM_OPERATIONS = exports.isDriveOperation = exports.DRIVE_OPERATIONS = exports.isGoogleCalendarOperation = exports.GOOGLE_CALENDAR_OPERATIONS = exports.isGmailOperation = exports.GMAIL_OPERATIONS = exports.NODE_TYPE_TO_PREFIX = exports.PREFIX_TO_NODE_TYPE = exports.NODE_STATE_KEYS = exports.NODE_COLORS = exports.NODE_DETAIL_PATHS = exports.getNodeRegistryEntry = exports.NODE_REGISTRY = exports.getNodeDispatchConfig = exports.getAllNodeCollections = exports.NODE_DISPATCH = exports.resolveNodeId = exports.PREFIX_TO_TYPE = exports.NODE_UI = exports.ALL_NODE_TYPES = exports.isNodeType = exports.isTerminal = exports.canSendToNodes = exports.canReceiveFromNodes = exports.canReceiveFrom = exports.NODE_CONNECTIONS = exports.iterableMeta = exports.singleMeta = void 0;
+exports.CREDENTIAL_TYPE_VALUES = exports.CREDENTIAL_TYPES = exports.isGoogleContactsOperation = exports.GOOGLE_CONTACTS_DEFAULT_PERSON_FIELDS = exports.GOOGLE_CONTACTS_OPERATION_GROUPS = exports.GOOGLE_CONTACTS_OPERATION_SPECS = exports.GOOGLE_CONTACTS_OPERATIONS_V2 = exports.GOOGLE_CONTACTS_OPERATIONS_V1 = exports.GOOGLE_CONTACTS_OPERATIONS = exports.isSheetsOperation = exports.SHEETS_OPERATION_SPECS = exports.SHEETS_OPERATIONS = exports.isSlackOperation = exports.SLACK_OPERATION_SPECS = exports.SLACK_OPERATIONS = exports.isDiscordOperation = exports.DISCORD_OPERATION_SPECS = exports.DISCORD_OPERATIONS = exports.isWhatsAppOperation = exports.WHATSAPP_OPERATIONS = exports.isTelegramOperation = exports.TELEGRAM_OPERATIONS = exports.isDriveOperation = exports.DRIVE_OPERATIONS = exports.isGoogleCalendarOperation = exports.GOOGLE_CALENDAR_OPERATIONS = exports.isGmailOperation = exports.GMAIL_OPERATIONS = exports.NODE_TYPE_TO_PREFIX = exports.PREFIX_TO_NODE_TYPE = exports.NODE_STATE_KEYS = exports.NODE_COLORS = exports.NODE_DETAIL_PATHS = exports.getNodeRegistryEntry = exports.NODE_REGISTRY = exports.getNodeDispatchConfig = exports.getAllNodeCollections = exports.NODE_DISPATCH = exports.resolveNodeId = exports.PREFIX_TO_TYPE = exports.NODE_UI = exports.ALL_NODE_TYPES = exports.isNodeType = exports.isTerminal = exports.canSendToNodes = exports.canReceiveFromNodes = exports.canReceiveFrom = exports.NODE_CONNECTIONS = exports.iterableMeta = exports.singleMeta = void 0;
+exports.isCredentialType = exports.getCredentialType = exports.credentialTypeValues = void 0;
 var types_1 = require("./types");
 Object.defineProperty(exports, "singleMeta", { enumerable: true, get: function () { return types_1.singleMeta; } });
 Object.defineProperty(exports, "iterableMeta", { enumerable: true, get: function () { return types_1.iterableMeta; } });
@@ -55,6 +56,10 @@ var slack_operations_1 = require("./slack-operations");
 Object.defineProperty(exports, "SLACK_OPERATIONS", { enumerable: true, get: function () { return slack_operations_1.SLACK_OPERATIONS; } });
 Object.defineProperty(exports, "SLACK_OPERATION_SPECS", { enumerable: true, get: function () { return slack_operations_1.SLACK_OPERATION_SPECS; } });
 Object.defineProperty(exports, "isSlackOperation", { enumerable: true, get: function () { return slack_operations_1.isSlackOperation; } });
+var sheets_operations_1 = require("./sheets-operations");
+Object.defineProperty(exports, "SHEETS_OPERATIONS", { enumerable: true, get: function () { return sheets_operations_1.SHEETS_OPERATIONS; } });
+Object.defineProperty(exports, "SHEETS_OPERATION_SPECS", { enumerable: true, get: function () { return sheets_operations_1.SHEETS_OPERATION_SPECS; } });
+Object.defineProperty(exports, "isSheetsOperation", { enumerable: true, get: function () { return sheets_operations_1.isSheetsOperation; } });
 var google_contacts_operations_1 = require("./google-contacts-operations");
 Object.defineProperty(exports, "GOOGLE_CONTACTS_OPERATIONS", { enumerable: true, get: function () { return google_contacts_operations_1.GOOGLE_CONTACTS_OPERATIONS; } });
 Object.defineProperty(exports, "GOOGLE_CONTACTS_OPERATIONS_V1", { enumerable: true, get: function () { return google_contacts_operations_1.GOOGLE_CONTACTS_OPERATIONS_V1; } });

package/dist/sheets-operations.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Google Sheets operation enum + form schema — single source of truth across
+ * the API, Dashboard, and Message Broker. Used by:
+ *   - sheetsAction entity / DTO (api): operation field + validation
+ *   - dashboard SheetsAction detail page: the whole operation form
+ *
+ * The api already accepts these six; the dashboard's own `SheetsAction` type
+ * only listed four (it never learned about appendOrUpdateRow and
+ * createSpreadsheet), which is exactly the drift this enum removes.
+ */
+export declare const SHEETS_OPERATIONS: readonly ["appendRow", "updateRow", "appendOrUpdateRow", "readRange", "getRows", "createSpreadsheet"];
+export type SheetsOperation = (typeof SHEETS_OPERATIONS)[number];
+/** Type guard — useful when validating untrusted input (DTOs, AI tool calls). */
+export declare function isSheetsOperation(value: unknown): value is SheetsOperation;
+/**
+ * Per-operation form schema, same idea as SLACK_OPERATION_SPECS and
+ * GOOGLE_CONTACTS_OPERATION_SPECS: the detail page renders it with one loop
+ * instead of a branch per operation.
+ *
+ * Two things make this node's schema different from the others, and both are
+ * deliberate:
+ *
+ * 1. **The values are top-level entity fields, not an `operationConfig`
+ *    record.** `name` here is the property on the sheetsAction document
+ *    (`spreadsheetId`, `sheetName`, …), and `columnMapping` is a complex field.
+ *    A renderer copied from Contacts would write to the wrong place.
+ * 2. **Half the fields are discovered at run time.** The column list comes from
+ *    the chosen sheet's header row, fetched live. So the schema names the
+ *    *picker* rather than carrying options — the same trick Discord's
+ *    `channel` / `guild` / `role` types use.
+ */
+export interface SheetsParamSpec {
+    /** Field key — the property name on the sheetsAction document. */
+    name: string;
+    /** UI label. Empty string where the control has never shown one. */
+    label: string;
+    /**
+     * Param type for form rendering.
+     *
+     * - `string` — one-line input with `{{payload.x}}` templating.
+     * - `spreadsheet` — the spreadsheet picker **plus** the "or paste ID / URL"
+     *   input that sits under it. They are one field with two ways in, not two
+     *   fields, and the paste box extracts the id out of a full URL.
+     * - `sheetTab` — the tab picker for the chosen spreadsheet. Picking a tab
+     *   clears `columnMapping`, because the headers just changed.
+     * - `headerColumn` — a dropdown of the sheet's live header row.
+     * - `columnMapping` — the header-to-template editor. It owns the three
+     *   states of the header fetch (loading, loaded, failed), which is what
+     *   used to be six copies of the same conditional in the page.
+     */
+    type: 'string' | 'spreadsheet' | 'sheetTab' | 'headerColumn' | 'columnMapping';
+    /** Required by the operation. Metadata — the form does not gate on it. */
+    required?: boolean;
+    /** Help text under the control. Absent where the form shows none. */
+    description?: string;
+    /** Hint shown inside the input. */
+    placeholder?: string;
+    /**
+     * Section this field is rendered inside. Fields without one share the first
+     * section with the operation picker; the mapping fields sit in a second
+     * section whose title changes per operation ("Columns to Append",
+     * "Update Row", "Match & Upsert").
+     */
+    section?: string;
+    /** `columnMapping` only — the line shown while no column has been added. */
+    emptyText?: string;
+}
+export interface SheetsOperationSpec {
+    /** UI label for the operation picker. */
+    label: string;
+    /** Sub-line under the label in the picker. */
+    description: string;
+    /** googleapis call the operation maps to (sheets v4). */
+    apiMethod: string;
+    /** Parameter schema. Order matters for form rendering. */
+    params: SheetsParamSpec[];
+}
+export declare const SHEETS_OPERATION_SPECS: Record<SheetsOperation, SheetsOperationSpec>;

package/dist/sheets-operations.js

@@ -0,0 +1,154 @@
+"use strict";
+/**
+ * Google Sheets operation enum + form schema — single source of truth across
+ * the API, Dashboard, and Message Broker. Used by:
+ *   - sheetsAction entity / DTO (api): operation field + validation
+ *   - dashboard SheetsAction detail page: the whole operation form
+ *
+ * The api already accepts these six; the dashboard's own `SheetsAction` type
+ * only listed four (it never learned about appendOrUpdateRow and
+ * createSpreadsheet), which is exactly the drift this enum removes.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SHEETS_OPERATION_SPECS = exports.SHEETS_OPERATIONS = void 0;
+exports.isSheetsOperation = isSheetsOperation;
+exports.SHEETS_OPERATIONS = [
+    'appendRow',
+    'updateRow',
+    'appendOrUpdateRow',
+    'readRange',
+    'getRows',
+    'createSpreadsheet',
+];
+/** Type guard — useful when validating untrusted input (DTOs, AI tool calls). */
+function isSheetsOperation(value) {
+    return (typeof value === 'string' &&
+        exports.SHEETS_OPERATIONS.includes(value));
+}
+/* Fields most operations share. The spreadsheet and its tab are the same two
+   controls everywhere they appear — createSpreadsheet is the only operation
+   that shows neither, because there is no document yet to point at. */
+const spreadsheet = () => ({
+    name: 'spreadsheetId',
+    label: 'Select Spreadsheet',
+    type: 'spreadsheet',
+    required: true,
+});
+const sheetTab = () => ({
+    name: 'sheetName',
+    label: 'Sheet Name',
+    type: 'sheetTab',
+    required: true,
+});
+/** The mapping editor, whose label, section and empty line change per op. */
+const columnMapping = (over = {}) => ({
+    name: 'columnMapping',
+    label: 'Columns to Update',
+    type: 'columnMapping',
+    emptyText: 'No columns selected. Add columns to update.',
+    ...over,
+});
+/** Which row to touch: the column to search in, and the value to look for. */
+const matchFields = (section) => [
+    {
+        name: 'matchColumn',
+        label: 'Match Column',
+        type: 'headerColumn',
+        required: true,
+        description: 'Select the column to find the row to update',
+        section,
+    },
+    {
+        /* No static placeholder or description: both are built from the chosen
+           column at render time ({{payload.<column>}} and 'Template to match
+           against "<column>"'), so the schema cannot carry them. */
+        name: 'matchValueTemplate',
+        label: 'Match Value',
+        type: 'string',
+        required: true,
+        section,
+    },
+];
+exports.SHEETS_OPERATION_SPECS = {
+    appendRow: {
+        label: 'Append Row',
+        description: 'Add a new row at the bottom',
+        apiMethod: 'spreadsheets.values.batchUpdate',
+        params: [
+            spreadsheet(),
+            sheetTab(),
+            columnMapping({
+                /* The append editor has never carried a label of its own — the section
+                   title above it already says "Columns to Append". */
+                label: '',
+                section: 'Columns to Append',
+                emptyText: 'No columns selected. Add columns to populate in the new row.',
+            }),
+        ],
+    },
+    updateRow: {
+        label: 'Update Row',
+        description: 'Update cells in a specific range',
+        apiMethod: 'spreadsheets.values.batchUpdate',
+        params: [
+            spreadsheet(),
+            sheetTab(),
+            ...matchFields('Update Row'),
+            columnMapping({ section: 'Update Row' }),
+        ],
+    },
+    appendOrUpdateRow: {
+        label: 'Append or Update',
+        description: 'Update if row exists, append if not',
+        apiMethod: 'spreadsheets.values.batchUpdate',
+        /* Same fields as updateRow — only the section title differs. The label
+           inside still reads "Columns to Update", which is what the page has always
+           shown. */
+        params: [
+            spreadsheet(),
+            sheetTab(),
+            ...matchFields('Match & Upsert'),
+            columnMapping({ section: 'Match & Upsert' }),
+        ],
+    },
+    readRange: {
+        label: 'Read Range',
+        description: 'Read cells from a specific range',
+        apiMethod: 'spreadsheets.values.get',
+        params: [
+            spreadsheet(),
+            sheetTab(),
+            {
+                name: 'rangeTemplate',
+                label: 'Range Template',
+                type: 'string',
+                required: true,
+                placeholder: 'e.g. A2:D100',
+            },
+        ],
+    },
+    getRows: {
+        label: 'Get Rows',
+        description: 'Read all rows with headers as keys',
+        apiMethod: 'spreadsheets.values.get',
+        params: [spreadsheet(), sheetTab()],
+    },
+    createSpreadsheet: {
+        label: 'Create Spreadsheet',
+        description: 'Create a new Google Sheets spreadsheet',
+        apiMethod: 'spreadsheets.create',
+        /* `sheetName` means the **new document's title** here, not a tab — the one
+           field in this node that changes meaning *and* control between
+           operations. The api uses it for both the file name and its first tab. */
+        params: [
+            {
+                name: 'sheetName',
+                label: 'Spreadsheet Title',
+                type: 'string',
+                required: true,
+                placeholder: 'My New Spreadsheet',
+                description: 'Name of the new spreadsheet. Supports {{payload.field}} templates.',
+            },
+        ],
+    },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hostwebhook/node-types",
-  "version": "1.52.7",
+  "version": "1.52.8",
   "description": "Shared node type definitions, connection rules, and dispatch config for HostWebhook",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",