zapier-platform-cli 18.4.0 → 18.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "18.4.0",
+  "version": "18.5.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",
@@ -41,7 +41,7 @@
     "ignore": "7.0.5",
     "inquirer": "8.2.5",
     "jscodeshift": "^17.3.0",
-    "lodash": "4.17.23",
+    "lodash": "4.18.1",
     "luxon": "3.7.1",
     "marked": "15.0.12",
     "marked-terminal": "7.3.0",

package/src/app-templates.js

@@ -20,6 +20,7 @@ module.exports = [
   // features
   'dynamic-dropdown',
   'files',
+  'line-items',
   'middleware',
   'resource',
   'rest-hooks',

package/src/generators/index.js

@@ -217,6 +217,7 @@ const TEMPLATE_ROUTES = {
   'digest-auth': writeForAuthTemplate,
   'dynamic-dropdown': writeForStandaloneTemplate,
   files: writeForStandaloneTemplate,
+  'line-items': writeForStandaloneTemplate,
   minimal: writeForMinimalTemplate,
   'oauth1-trello': writeForAuthTemplate,
   oauth2: writeForAuthTemplate,
@@ -246,12 +247,12 @@ const ProjectGeneratorPromise = createGeneratorClass((Generator) => {
       this.destinationRoot(path.resolve(this.options.path));
 
       const jsFilter = filter(['*.js', '*.json', '*.ts'], { restore: true });
-      this.queueTransformStream([
+      this.queueTransformStream(
         { disabled: true },
         jsFilter,
         prettier({ singleQuote: true }),
         jsFilter.restore,
-      ]);
+      );
     }
 
     async prompting() {

package/src/generators/templates/README.template.md

@@ -1,34 +1,34 @@
 # <%= name %>
 
-This Zapier integration project is generated by the `zapier init` CLI command.
+This Zapier integration project is generated by the `zapier-platform init` CLI command.
 
 These are what you normally do next:
 
 ```bash
 # Install dependencies
-npm install  # or you can use pnpm or yarn
+npm install --ignore-scripts  # or you can use pnpm or yarn
 
 # Run tests
-zapier test
+zapier-platform test
 
 # Register the integration on Zapier if you haven't
-zapier register "App Title"
+zapier-platform register "App Title"
 
 # Or you can link to an existing integration on Zapier
-zapier link
+zapier-platform link
 
 # Push it to Zapier
-zapier push
+zapier-platform push
 ```
 
-Then, to add more features, you can use the `zapier scaffold` command, for example:
+Then, to add more features, you can use the `zapier-platform scaffold` command, for example:
 
 ```bash
 # Add a trigger
-zapier scaffold trigger contact
+zapier-platform scaffold trigger contact
 
 # Add an action
-zapier scaffold create contact
+zapier-platform scaffold create contact
 ``` 
 
 Find out more on the latest docs: https://docs.zapier.com/platform

package/src/generators/templates/line-items/README.md

@@ -0,0 +1,16 @@
+# line-items
+
+An example integration demonstrating line item support. Line items are fields
+with a `children` property that represent structured, repeating data — like rows
+in a spreadsheet or items in an order.
+
+## Testing with `zapier-platform invoke`
+
+```bash
+# Non-interactive with JSON input
+zapier-platform invoke create order --non-interactive \
+  -i '{"name": "My Order", "line_items": [{"product_name": "Pens", "quantity": "12", "price": "1.50"}]}'
+
+# Interactive mode — use the line item editing UI
+zapier-platform invoke create order -i '{"name": "My Order"}'
+```

package/src/generators/templates/line-items/creates/order.js

@@ -0,0 +1,67 @@
+const perform = async (z, bundle) => {
+  const response = await z.request({
+    url: 'https://httpbin.zapier-tooling.com/post',
+    method: 'POST',
+    body: {
+      name: bundle.inputData.name,
+      line_items: bundle.inputData.line_items,
+    },
+  });
+
+  return response.data;
+};
+
+module.exports = {
+  key: 'order',
+  noun: 'Order',
+  display: {
+    label: 'Create Order',
+    description: 'Creates a new order with line items.',
+  },
+  operation: {
+    inputFields: [
+      { key: 'name', required: true, type: 'string', label: 'Order Name' },
+      {
+        key: 'line_items',
+        label: 'Line Items',
+        children: [
+          {
+            key: 'product_name',
+            type: 'string',
+            label: 'Product Name',
+            required: true,
+          },
+          {
+            key: 'quantity',
+            type: 'integer',
+            label: 'Quantity',
+            required: true,
+          },
+          { key: 'price', type: 'number', label: 'Unit Price' },
+        ],
+      },
+    ],
+    perform,
+    sample: {
+      id: 1,
+      name: 'Stationery Order',
+      line_items: [
+        { product_name: 'Pens', quantity: 12, price: 1.5 },
+        { product_name: 'Notebooks', quantity: 3, price: 8.99 },
+      ],
+    },
+    outputFields: [
+      { key: 'id', label: 'ID' },
+      { key: 'name', label: 'Order Name' },
+      {
+        key: 'line_items',
+        label: 'Line Items',
+        children: [
+          { key: 'product_name', label: 'Product Name' },
+          { key: 'quantity', label: 'Quantity' },
+          { key: 'price', label: 'Unit Price' },
+        ],
+      },
+    ],
+  },
+};

package/src/generators/templates/line-items/index.js

@@ -0,0 +1,12 @@
+const order = require('./creates/order');
+
+const App = {
+  version: require('./package.json').version,
+  platformVersion: require('zapier-platform-core').version,
+
+  creates: {
+    [order.key]: order,
+  },
+};
+
+module.exports = App;

package/src/generators/templates/line-items/test/creates.test.js

@@ -0,0 +1,30 @@
+/* globals describe, expect, test */
+
+const zapier = require('zapier-platform-core');
+
+const App = require('../index');
+const appTester = zapier.createAppTester(App);
+zapier.tools.env.inject();
+
+describe('creates', () => {
+  test('create order with line items', async () => {
+    const bundle = {
+      inputData: {
+        name: 'Test Order',
+        line_items: [
+          { product_name: 'Pens', quantity: 12, price: 1.5 },
+          { product_name: 'Notebooks', quantity: 3, price: 8.99 },
+        ],
+      },
+    };
+    const result = await appTester(
+      App.creates.order.operation.perform,
+      bundle,
+    );
+    const body = JSON.parse(result.data);
+    expect(body.name).toBe('Test Order');
+    expect(body.line_items).toHaveLength(2);
+    expect(body.line_items[0].product_name).toBe('Pens');
+    expect(body.line_items[1].quantity).toBe(3);
+  });
+});

package/src/oclif/commands/invoke/action.js

@@ -1,4 +1,5 @@
 const debug = require('debug')('zapier:invoke');
+const _ = require('lodash');
 
 const { startSpinner, endSpinner } = require('../../../utils/display');
 const { customLogger } = require('./logger');
@@ -71,8 +72,9 @@ const invokeAction = async (command, context) => {
     await promptForFields(command, context, inputFields, invokeAction);
   }
 
-  // Preserve original inputData as inputDataRaw before type resolution
-  const inputDataRaw = { ...context.inputData };
+  // Preserve original inputData as inputDataRaw before type resolution (deep
+  // copy needed because resolveInputDataTypes mutates nested objects in-place)
+  const inputDataRaw = _.cloneDeep(context.inputData);
   let inputData;
   if (context.remote) {
     // Let the remote server resolve input data types

package/src/oclif/commands/invoke/index.js

@@ -146,10 +146,12 @@ class InvokeCommand extends BaseCommand {
     context.appId = (await getLinkedAppConfig(null, false))?.id;
     context.deployKey = (await readCredentials(false))[AUTH_KEY];
 
+    const hasAuth = Boolean(context.appDefinition.authentication);
+
     if (
       context.authId === '-' ||
       context.authId === '' ||
-      (context.remote && !context.authId)
+      (context.remote && !context.authId && hasAuth)
     ) {
       if (context.nonInteractive) {
         throw new Error(
@@ -159,6 +161,12 @@ class InvokeCommand extends BaseCommand {
       context.authId = (await promptForAuthentication(this)).toString();
     }
 
+    if (context.remote && !context.authId && !hasAuth) {
+      // The remote invoke API requires authentication_id in the POST body,
+      // but the server accepts 0 for apps without authentication configured.
+      context.authId = '0';
+    }
+
     if (context.authId) {
       context.authId = parseInt(context.authId);
       if (isNaN(context.authId)) {
@@ -482,7 +490,6 @@ The \`--debug\` flag will show you the HTTP request logs and any console logs yo
 The following is a non-exhaustive list of current limitations in local and relay mode. We may support them in the future.
 
 - Hook triggers, including REST hook subscribe/unsubscribe
-- Line items
 - Output hydration
 - File upload
 - Function-based connection label

package/src/oclif/commands/invoke/input-types.js

@@ -57,7 +57,8 @@ const parseDecimal = (s) => {
     }
   }
   const cleaned = chars.join('').replace(/[.,-]$/, '');
-  return parseFloat(cleaned);
+  const result = parseFloat(cleaned);
+  return isNaN(result) ? 0 : result;
 };
 
 /**
@@ -232,7 +233,14 @@ const resolveInputDataTypes = (inputData, inputFields, timezone) => {
     }
   }
 
-  // TODO: Handle line items (fields with "children")
+  // Handle line items (fields with "children")
+  for (const field of inputFields) {
+    if (field.children && field.children.length && Array.isArray(inputData[field.key])) {
+      for (const item of inputData[field.key]) {
+        resolveInputDataTypes(item, field.children, timezone);
+      }
+    }
+  }
 
   return inputData;
 };

package/src/oclif/commands/invoke/prompts.js

@@ -71,10 +71,43 @@ const getLabelForDynamicDropdown = (obj, preferredKey, fallbackKey) => {
  */
 const getMissingRequiredInputFields = (inputData, inputFields) => {
   return inputFields.filter(
-    (f) => f.required && !f.default && !inputData[f.key],
+    (f) =>
+      f.required &&
+      !f.default &&
+      (inputData[f.key] == null || inputData[f.key] === ''),
   );
 };
 
+/**
+ * Finds required child fields (line items) that are missing values in any row.
+ * @param {Object} inputData - The current input data
+ * @param {Array<Object>} inputFields - Array of field definitions
+ * @returns {Array<Object>} Array of required child fields missing in at least one row
+ */
+const getMissingRequiredChildFields = (inputData, inputFields) => {
+  const missing = [];
+  for (const field of inputFields) {
+    if (!field.children || !field.children.length) {
+      continue;
+    }
+    const items = inputData[field.key];
+    if (!Array.isArray(items)) {
+      continue;
+    }
+    const requiredChildren = field.children.filter(
+      (c) => c.required && c.type !== 'copy' && !c.default,
+    );
+    for (const item of items) {
+      for (const c of requiredChildren) {
+        if (item[c.key] == null || item[c.key] === '') {
+          missing.push(c);
+        }
+      }
+    }
+  }
+  return missing;
+};
+
 /**
  * Fetches choices for a dynamic dropdown field.
  * @param {import('../../ZapierBaseCommand')} command - The command instance for prompting
@@ -324,7 +357,8 @@ const promptForField = async (command, context, field, invokeAction) => {
     let nextPagingToken = null;
 
     while (
-      !answer ||
+      answer == null ||
+      answer === '' ||
       answer === '__next_page__' ||
       answer === '__prev_page__'
     ) {
@@ -378,8 +412,12 @@ const promptForField = async (command, context, field, invokeAction) => {
     }
     return answer;
   } else if (field.type === 'boolean') {
-    const yes = await command.confirm(message, false, !field.required, true);
-    return yes ? 'yes' : 'no';
+    if (field.required) {
+      const yes = await command.confirm(message, false, false, true);
+      return yes ? 'yes' : 'no';
+    } else {
+      return await command.prompt(message + ' (yes/no)', { useStderr: true });
+    }
   } else {
     return await command.prompt(message, { useStderr: true });
   }
@@ -400,6 +438,7 @@ const promptOrErrorForRequiredInputFields = async (
   inputFields,
   invokeAction,
 ) => {
+  // Check top-level required fields
   const missingFields = getMissingRequiredInputFields(
     context.inputData,
     inputFields,
@@ -420,6 +459,49 @@ const promptOrErrorForRequiredInputFields = async (
       );
     }
   }
+
+  // Check required child fields (line items) per row
+  const missingChildFields = getMissingRequiredChildFields(
+    context.inputData,
+    inputFields,
+  );
+  if (missingChildFields.length) {
+    if (context.nonInteractive || context.meta.isFillingDynamicDropdown) {
+      throw new Error(
+        "You're in non-interactive mode, so you must at least specify these required fields with --inputData: \n" +
+          missingChildFields
+            .map((f) => '* ' + formatFieldDisplay(f))
+            .join('\n'),
+      );
+    }
+    // Prompt per row for missing child fields
+    for (const field of inputFields) {
+      if (!field.children || !field.children.length) {
+        continue;
+      }
+      const items = context.inputData[field.key];
+      if (!Array.isArray(items)) {
+        continue;
+      }
+      const requiredChildren = field.children.filter(
+        (c) => c.required && c.type !== 'copy' && !c.default,
+      );
+      for (let i = 0; i < items.length; i++) {
+        for (const c of requiredChildren) {
+          if (items[i][c.key] == null || items[i][c.key] === '') {
+            const label = field.label || field.key;
+            console.error(`\n${label} (row ${i + 1}):`);
+            items[i][c.key] = await promptForField(
+              command,
+              context,
+              c,
+              invokeAction,
+            );
+          }
+        }
+      }
+    }
+  }
 };
 
 /**
@@ -451,8 +533,22 @@ const promptForInputFieldEdit = async (
       } else {
         name = f.key;
       }
-      if (context.inputData[f.key]) {
-        name += ` [current: "${context.inputData[f.key]}"]`;
+      const currentValue = context.inputData[f.key];
+      if (currentValue != null && currentValue !== '') {
+        if (Array.isArray(currentValue)) {
+          const MAX_LEN = 60;
+          const csv = currentValue
+            .map((item) => `{${Object.values(item).join(',')}}`)
+            .join(', ');
+          const count = `(${currentValue.length} ${currentValue.length === 1 ? 'item' : 'items'})`;
+          if (csv.length <= MAX_LEN) {
+            name += ` [${csv}] ${count}`;
+          } else {
+            name += ` [${csv.slice(0, MAX_LEN)}...] ${count}`;
+          }
+        } else {
+          name += ` [current: "${currentValue}"]`;
+        }
       } else if (f.default) {
         name += ` [default: "${f.default}"]`;
       }
@@ -479,12 +575,143 @@ const promptForInputFieldEdit = async (
     }
 
     const field = inputFields.find((f) => f.key === fieldKey);
-    context.inputData[fieldKey] = await promptForField(
-      command,
-      context,
-      field,
-      invokeAction,
+    if (field.children && field.children.length) {
+      await promptForLineItemEdit(command, context, field, invokeAction);
+    } else {
+      context.inputData[fieldKey] = await promptForField(
+        command,
+        context,
+        field,
+        invokeAction,
+      );
+    }
+  }
+};
+
+/**
+ * Prompts the user to add a new line item row by prompting for each child field.
+ * @param {import('../../ZapierBaseCommand')} command - The command instance
+ * @param {Object} context - The execution context
+ * @param {Object} field - The parent field definition with children
+ * @param {Function} invokeAction - Function to invoke actions
+ * @returns {Promise<Object>} The new row object
+ */
+const promptForNewLineItemRow = async (
+  command,
+  context,
+  field,
+  invokeAction,
+) => {
+  const row = {};
+  for (const child of field.children) {
+    if (child.default) {
+      row[child.key] = child.default;
+    }
+    if (child.required) {
+      row[child.key] = await promptForField(
+        command,
+        context,
+        child,
+        invokeAction,
+      );
+    }
+  }
+  return row;
+};
+
+/**
+ * Sub-menu for editing line item rows: add, edit, remove rows.
+ * @param {import('../../ZapierBaseCommand')} command - The command instance
+ * @param {Object} context - The execution context (inputData will be mutated)
+ * @param {Object} field - The parent field definition with children
+ * @param {Function} invokeAction - Function to invoke actions
+ * @returns {Promise<void>}
+ */
+const promptForLineItemEdit = async (command, context, field, invokeAction) => {
+  if (!Array.isArray(context.inputData[field.key])) {
+    context.inputData[field.key] = [];
+  }
+  const items = context.inputData[field.key];
+  const label = field.label || field.key;
+
+  while (true) {
+    const choices = [
+      { name: '>>> BACK <<<', short: 'BACK', value: '__back__' },
+      { name: '>>> ADD ITEM <<<', value: '__add__' },
+    ];
+    for (let i = 0; i < items.length; i++) {
+      const parts = Object.entries(items[i])
+        .map(([k, v]) => `${k}: ${JSON.stringify(v)}`)
+        .join(', ');
+      choices.push({
+        name: parts ? `[${i}] {${parts}}` : `[${i}] Empty item - select to edit`,
+        value: `__select_${i}`,
+      });
+    }
+
+    const action = await command.promptWithList(
+      `${label} [${items.length} ${items.length === 1 ? 'item' : 'items'}]:`,
+      choices,
+      { useStderr: true },
     );
+
+    if (action === '__back__') {
+      break;
+    } else if (action === '__add__') {
+      const row = await promptForNewLineItemRow(
+        command,
+        context,
+        field,
+        invokeAction,
+      );
+      items.push(row);
+    } else if (action.startsWith('__select_')) {
+      const idx = parseInt(action.slice(9));
+      // Sub-menu loop for editing/deleting the selected item
+      while (true) {
+        const editChoices = [
+          { name: '>>> BACK <<<', short: 'BACK', value: '__back__' },
+        ];
+        for (const child of field.children) {
+          const current = items[idx] && items[idx][child.key];
+          let choiceName;
+          if (child.label) {
+            choiceName = `${child.label} (${child.key})`;
+          } else {
+            choiceName = child.key;
+          }
+          if (current != null) {
+            choiceName += ` [current: "${current}"]`;
+          }
+          editChoices.push({ name: choiceName, value: child.key });
+        }
+        editChoices.push({
+          name: '>>> DELETE ITEM <<<',
+          value: '__delete__',
+        });
+
+        const editAction = await command.promptWithList(
+          'Edit or delete the item?',
+          editChoices,
+          { useStderr: true },
+        );
+
+        if (editAction === '__back__') {
+          break;
+        } else if (editAction === '__delete__') {
+          items.splice(idx, 1);
+          break;
+        } else {
+          const child = field.children.find((c) => c.key === editAction);
+          items[idx][editAction] = await promptForField(
+            command,
+            context,
+            child,
+            invokeAction,
+          );
+        }
+      }
+    }
   }
 };
 

package/src/oclif/commands/invoke/remote.js

@@ -37,22 +37,48 @@ const fetchInputFields = async (context) => {
       },
     },
   );
-  return responseData.needs.map((need) => {
-    return {
-      key: need.key,
-      type: FIELD_TYPE_MAP[need.type] || need.type,
-      required: need.required,
-      default: need.default,
-      choices: need.choices,
-      label: need.label,
-      helpText: need.help_text,
-      inputFormat: need.input_format,
-      dynamic: need.prefill,
-      list: need.list,
-      placeholder: need.placeholder,
-      alterDynamicFields: need.alter_dynamic_fields ?? false,
-    };
+  const mapNeed = (need) => ({
+    key: need.key,
+    type: FIELD_TYPE_MAP[need.type] || need.type,
+    required: need.required,
+    default: need.default,
+    choices: need.choices,
+    label: need.label,
+    helpText: need.help_text,
+    inputFormat: need.input_format,
+    dynamic: need.prefill,
+    list: need.list,
+    placeholder: need.placeholder,
+    alterDynamicFields: need.alter_dynamic_fields ?? false,
   });
+
+  // Group child fields (those with parent_key) under their parent
+  const parentKeys = new Set(
+    responseData.needs.filter((n) => n.parent_key).map((n) => n.parent_key),
+  );
+  const fields = [];
+  const childrenByParent = {};
+  for (const need of responseData.needs) {
+    if (need.parent_key) {
+      if (!childrenByParent[need.parent_key]) {
+        childrenByParent[need.parent_key] = [];
+      }
+      childrenByParent[need.parent_key].push(mapNeed(need));
+    } else {
+      fields.push(mapNeed(need));
+    }
+  }
+  // Add parent fields for any parent_key that doesn't have a corresponding
+  // top-level field in the response, then attach children
+  for (const parentKey of parentKeys) {
+    let parent = fields.find((f) => f.key === parentKey);
+    if (!parent) {
+      parent = { key: parentKey };
+      fields.push(parent);
+    }
+    parent.children = childrenByParent[parentKey];
+  }
+  return fields;
 };
 
 const fetchChoices = async (context, inputFieldKey) => {