zapier-platform-cli 17.3.0 → 17.4.0

package/src/utils/build.js

@@ -64,12 +64,10 @@ const findRequiredFiles = async (workingDir, entryPoints) => {
     platform: 'node',
     metafile: true,
     logLevel: 'warning',
-    external: [
-      '../test/userapp',
-      'zapier-platform-core/src/http-middlewares/before/sanatize-headers', // appears in zapier-platform-legacy-scripting-runner/index.js
-      './request-worker', // appears in zapier-platform-legacy-scripting-runner/zfactory.js
-      './xhr-sync-worker.js', // appears in jsdom/living/xmlhttprequest.js
-    ],
+    logOverride: {
+      'require-resolve-not-external': 'silent',
+    },
+    external: ['../test/userapp'],
     format,
     // Setting conditions to an empty array to exclude 'module' condition,
     // which Node.js doesn't use. https://esbuild.github.io/api/#conditions
@@ -220,44 +218,6 @@ const openZip = (outputPath) => {
   return zip;
 };
 
-const looksLikeWorkspaceRoot = async (dir) => {
-  if (fs.existsSync(path.join(dir, 'pnpm-workspace.yaml'))) {
-    return true;
-  }
-
-  const packageJsonPath = path.join(dir, 'package.json');
-  if (!fs.existsSync(packageJsonPath)) {
-    return false;
-  }
-
-  let packageJson;
-  try {
-    packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
-  } catch (err) {
-    return false;
-  }
-
-  return packageJson?.workspaces != null;
-};
-
-// Traverses up the directory tree to find the workspace root. The workspace
-// root directory either contains pnpm-workspace.yaml or a package.json file
-// with a "workspaces" field. Returns the absolute path to the workspace root
-// directory, or null if not found.
-const findWorkspaceRoot = async (workingDir) => {
-  let dir = workingDir;
-  for (let i = 0; i < 500; i++) {
-    if (await looksLikeWorkspaceRoot(dir)) {
-      return dir;
-    }
-    if (dir === '/' || dir.match(/^[a-z]:\\$/i)) {
-      break;
-    }
-    dir = path.dirname(dir);
-  }
-  return null;
-};
-
 const getNearestNodeModulesDir = (workingDir, relPath) => {
   if (path.basename(relPath) === 'package.json') {
     const nmDir = path.resolve(
@@ -266,7 +226,7 @@ const getNearestNodeModulesDir = (workingDir, relPath) => {
       'node_modules',
     );
     return fs.existsSync(nmDir) ? path.relative(workingDir, nmDir) : null;
-  } else {
+  } else if (relPath.includes('node_modules')) {
     let dir = path.dirname(relPath);
     for (let i = 0; i < 100; i++) {
       if (dir.endsWith(`${path.sep}node_modules`)) {
@@ -278,8 +238,49 @@ const getNearestNodeModulesDir = (workingDir, relPath) => {
       }
       dir = nextDir;
     }
-    return null;
   }
+
+  let dir = path.dirname(relPath);
+  for (let i = 0; i < 100; i++) {
+    const nmDir = path.join(dir, 'node_modules');
+    if (fs.existsSync(path.resolve(workingDir, nmDir))) {
+      return nmDir;
+    }
+    const nextDir = path.dirname(dir);
+    if (nextDir === dir) {
+      break;
+    }
+    dir = nextDir;
+  }
+
+  return null;
+};
+
+const countLeadingDoubleDots = (relPath) => {
+  const parts = relPath.split(path.sep);
+  for (let i = 0; i < parts.length; i++) {
+    if (parts[i] !== '..') {
+      return i;
+    }
+  }
+  return 0;
+};
+
+// Join all relPaths with workingDir and return the common ancestor directory.
+const findCommonAncestor = (workingDir, relPaths) => {
+  let maxLeadingDoubleDots = 0;
+  for (const relPath of relPaths) {
+    maxLeadingDoubleDots = Math.max(
+      maxLeadingDoubleDots,
+      countLeadingDoubleDots(relPath),
+    );
+  }
+
+  let commonAncestor = workingDir;
+  for (let i = 0; i < maxLeadingDoubleDots; i++) {
+    commonAncestor = path.dirname(commonAncestor);
+  }
+  return commonAncestor;
 };
 
 const writeBuildZipDumbly = async (workingDir, zip) => {
@@ -322,11 +323,14 @@ const writeBuildZipSmartly = async (workingDir, zip) => {
     ]),
   ).sort();
 
-  const workspaceRoot = (await findWorkspaceRoot(workingDir)) || workingDir;
+  const zipRoot = findCommonAncestor(workingDir, relPaths) || workingDir;
 
-  if (workspaceRoot !== workingDir) {
-    const appDirRelPath = path.relative(workspaceRoot, workingDir);
-    const linkNames = ['zapierwrapper.js', 'index.js'];
+  if (zipRoot !== workingDir) {
+    const appDirRelPath = path.relative(zipRoot, workingDir);
+    // zapierwrapper.js and index.js are entry points.
+    // 'config' is the default directory that the 'config' npm package expects
+    // to find config files at the root directory.
+    const linkNames = ['zapierwrapper.js', 'index.js', 'config'];
     for (const name of linkNames) {
       if (fs.existsSync(path.join(workingDir, name))) {
         zip.symlink(name, path.join(appDirRelPath, name), 0o644);
@@ -343,8 +347,8 @@ const writeBuildZipSmartly = async (workingDir, zip) => {
   // Write required files to the zip
   for (const relPath of relPaths) {
     const absPath = path.resolve(workingDir, relPath);
-    const nameInZip = path.relative(workspaceRoot, absPath);
-    if (nameInZip === 'package.json' && workspaceRoot !== workingDir) {
+    const nameInZip = path.relative(zipRoot, absPath);
+    if (nameInZip === 'package.json' && zipRoot !== workingDir) {
       // Ignore workspace root's package.json
       continue;
     }
@@ -381,7 +385,7 @@ const writeBuildZipSmartly = async (workingDir, zip) => {
         symlink.parentPath,
         symlink.name,
       );
-      const nameInZip = path.relative(workspaceRoot, absPath);
+      const nameInZip = path.relative(zipRoot, absPath);
       const targetInZip = path.relative(
         symlink.parentPath,
         fs.realpathSync(absPath),
@@ -548,6 +552,11 @@ const testBuildZip = async (zipPath) => {
             `You may have to add it to ${colors.bold.underline('includeInBuild')} ` +
             `in your ${colors.bold.underline('.zapierapprc')} file.`,
         );
+      } else if (error.message) {
+        // Hide the unzipped temporary directory
+        error.message = error.message
+          .replaceAll(`file://${testDir}/`, '')
+          .replaceAll(`${testDir}/`, '');
       }
       throw error;
     }

package/src/utils/codegen.js

@@ -23,19 +23,30 @@ const obj = (...properties) =>
       .join('')}}
   `.trim();
 
-const exportStatement = (obj) => `
-module.exports = ${obj}`;
+// TypeScript version of obj that supports satisfies clause
+const objTS = (type, ...properties) =>
+  `
+    {${properties
+      .map((p) => (p.startsWith('/') ? `\n\n${p}\n` : p + ','))
+      .join('')}}
+  `.trim() + ` satisfies ${type}`;
+
+const exportStatement = (obj, language) =>
+  language === 'typescript'
+    ? `export default ${obj}`
+    : `module.exports = ${obj}`;
 
 /**
  * @param {string} key could be a variable name or string value
  * @param {string | undefined} value can either be a variable or actual string. or could be missing, in which case the input is treated as a variable
+ * @param {string | undefined} satisfiesType if provided, the property will be typed with the given type
  */
-const objProperty = (key, value) => {
+const objProperty = (key, value, satisfiesType) => {
   if (value === undefined) {
     return `${key}`;
   }
   // wrap key in quotes here in case the key isn't a valid property. prettier will remove if needed
-  return `'${key}': ${value}`;
+  return `'${key}': ${value}${satisfiesType ? ` satisfies ${satisfiesType}` : ''}`;
 };
 
 const variableAssignmentDeclaration = (varName, value) =>
@@ -157,6 +168,13 @@ const file = (...statements) =>
     ${statements.join('\n\n')}
 `.trim();
 
+const fileTS = (typesToImport = [], ...statements) =>
+  `
+    import type { ${typesToImport.join(', ')} } from 'zapier-platform-core';
+
+    ${statements.join('\n\n')}
+`.trim();
+
 module.exports = {
   arr,
   assignmentStatement,
@@ -166,11 +184,13 @@ module.exports = {
   exportStatement,
   fatArrowReturnFunctionDeclaration,
   file,
+  fileTS,
   functionDeclaration,
   ifStatement,
   interpLiteral,
   obj,
   objProperty,
+  objTS,
   RESPONSE_VAR,
   returnStatement,
   strLiteral,

package/src/utils/files.js

@@ -207,9 +207,14 @@ function* walkDir(dir) {
   const entries = fs.readdirSync(dir, { withFileTypes: true });
   for (const entry of entries) {
     if (entry.isDirectory()) {
-      const subDir = path.join(entry.parentPath, entry.name);
+      const subDir = path.join(dir, entry.name);
       yield* walkDir(subDir);
     } else if (entry.isFile() || entry.isSymbolicLink()) {
+      if (!entry.parentPath) {
+        // dirent.parentPath is only available since Node.js 18.20, 20.12, and
+        // 21.4. Re-assigning it so the caller can use dirent.parentPath.
+        entry.parentPath = dir;
+      }
       yield entry;
     }
   }
@@ -223,10 +228,15 @@ function* walkDirLimitedLevels(dir, maxLevels, currentLevel = 1) {
   for (const entry of entries) {
     if (entry.isDirectory()) {
       if (currentLevel < maxLevels) {
-        const subDir = path.join(entry.parentPath, entry.name);
+        const subDir = path.join(dir, entry.name);
         yield* walkDirLimitedLevels(subDir, maxLevels, currentLevel + 1);
       }
     } else if (entry.isFile() || entry.isSymbolicLink()) {
+      if (!entry.parentPath) {
+        // dirent.parentPath is only available since Node.js 18.20, 20.12, and
+        // 21.4. Re-assigning it so the caller can use dirent.parentPath.
+        entry.parentPath = dir;
+      }
       yield entry;
     }
   }

package/src/utils/zapierwrapper.js

@@ -31,7 +31,7 @@ const copyZapierWrapper = async (corePackageDir, appDir) => {
     );
   }
 
-  const wrapperText = (await readFile(wrapperPath, 'utf8')).replace(
+  const wrapperText = (await readFile(wrapperPath, 'utf8')).replaceAll(
     '{REPLACE_ME_PACKAGE_NAME}',
     appPackageJson.name,
   );

package/src/generators/templates/index-esm.template.ts

@@ -1,24 +0,0 @@
-import zapier, { defineApp } from 'zapier-platform-core';
-
-import packageJson from '../package.json' with { type: 'json' };
-
-import MovieCreate from './creates/movie.js';
-import MovieTrigger from './triggers/movie.js';
-import authentication from './authentication.js';
-import { addBearerHeader } from './middleware.js';
-
-export default defineApp({
-  version: packageJson.version,
-  platformVersion: zapier.version,
-
-  authentication,
-  beforeRequest: [addBearerHeader],
-
-  triggers: {
-    [MovieTrigger.key]: MovieTrigger,
-  },
-
-  creates: {
-    [MovieCreate.key]: MovieCreate,
-  },
-});

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

@@ -1,3 +0,0 @@
-# TypeScript Template
-
-An TypeScript template for Zapier Integrations.

package/src/generators/templates/typescript/src/authentication.ts

@@ -1,48 +0,0 @@
-import type { Authentication } from 'zapier-platform-core';
-
-import { API_URL, SCOPES } from './constants.js';
-
-export default {
-  type: 'oauth2',
-  test: { url: `${API_URL}/me` },
-  connectionLabel: '{{email}}', // Set this from the test data.
-  oauth2Config: {
-    authorizeUrl: {
-      url: `${API_URL}/oauth/authorize`,
-      params: {
-        client_id: '{{process.env.CLIENT_ID}}',
-        response_type: 'code',
-        scope: SCOPES.join(' '),
-        redirect_uri: '{{bundle.inputData.redirect_uri}}',
-        state: '{{bundle.inputData.state}}',
-      },
-    },
-    getAccessToken: {
-      url: `${API_URL}/oauth/access-token`,
-      method: 'POST',
-      headers: {
-        'content-type': 'application/x-www-form-urlencoded',
-      },
-      body: {
-        client_id: '{{process.env.CLIENT_ID}}',
-        client_secret: '{{process.env.CLIENT_SECRET}}',
-        code: '{{bundle.inputData.code}}',
-        grant_type: 'authorization_code',
-        redirect_uri: '{{bundle.inputData.redirect_uri}}',
-      },
-    },
-    refreshAccessToken: {
-      url: `${API_URL}/oauth/refresh-token`,
-      method: 'POST',
-      headers: {
-        'content-type': 'application/x-www-form-urlencoded',
-      },
-      body: {
-        client_id: '{{process.env.CLIENT_ID}}',
-        client_secret: '{{process.env.CLIENT_SECRET}}',
-        refresh_token: '{{bundle.authData.refresh_token}}',
-        grant_type: 'refresh_token',
-      },
-    },
-  },
-} satisfies Authentication;

package/src/generators/templates/typescript/src/constants.ts

@@ -1,3 +0,0 @@
-export const API_URL = 'https://auth-json-server.zapier-staging.com';
-
-export const SCOPES = ['movies:read', 'movies:write'];

package/src/generators/templates/typescript/src/creates/movie.ts

@@ -1,43 +0,0 @@
-import {
-  defineInputFields,
-  defineCreate,
-  type CreatePerform,
-  type InferInputData,
-} from 'zapier-platform-core';
-import { API_URL } from '../constants.js';
-
-const inputFields = defineInputFields([
-  { key: 'title', required: true },
-  { key: 'year', type: 'integer' },
-]);
-
-const perform = (async (z, bundle) => {
-  const response = await z.request({
-    method: 'POST',
-    url: `${API_URL}/movies`,
-    body: {
-      title: bundle.inputData.title,
-      year: bundle.inputData.year,
-    },
-  });
-  return response.data;
-}) satisfies CreatePerform<InferInputData<typeof inputFields>>;
-
-export default defineCreate({
-  key: 'movie',
-  noun: 'Movie',
-
-  display: {
-    label: 'Create Movie',
-    description: 'Creates a new movie.',
-  },
-
-  operation: {
-    perform,
-    inputFields,
-    sample: {
-      id: '1',
-      title: 'example',
-    },
-  },
-});

package/src/generators/templates/typescript/src/middleware.ts

@@ -1,11 +0,0 @@
-import type { BeforeRequestMiddleware } from 'zapier-platform-core';
-
-export const addBearerHeader: BeforeRequestMiddleware = (request, z, bundle) => {
-  if (bundle.authData.access_token && !request.headers?.Authorization) {
-    request.headers = {
-      ...request.headers,
-      Authorization: `Bearer ${bundle.authData.access_token}`,
-    }
-  }
-  return request;
-};

package/src/generators/templates/typescript/src/test/creates.test.ts

@@ -1,21 +0,0 @@
-import { createAppTester, tools } from 'zapier-platform-core';
-import { describe, test, expect } from 'vitest';
-
-import App from '../index';
-
-const appTester = createAppTester(App);
-tools.env.inject();
-
-describe('movie', () => {
-  test('create a movie', async () => {
-    const bundle = {
-      inputData: { title: 'hello', year: 2020 },
-      authData: { access_token: 'a_token' },
-    };
-    const result = await appTester(App.creates.movie.operation.perform, bundle);
-    expect(result).toMatchObject({
-      title: 'hello',
-      year: 2020,
-    });
-  });
-});

package/src/generators/templates/typescript/src/test/triggers.test.ts

@@ -1,25 +0,0 @@
-import { createAppTester, tools } from 'zapier-platform-core';
-import { describe, test, expect } from 'vitest';
-
-import App from '../index';
-
-const appTester = createAppTester(App);
-tools.env.inject();
-
-describe('movie', () => {
-  test('list movies', async () => {
-    const bundle = { inputData: {}, authData: { access_token: 'a_token' } };
-    const results = (await appTester(
-      App.triggers.movie.operation.perform,
-      bundle
-    )) as Array<object>;
-
-    expect(results.length).toBeGreaterThan(0);
-
-    const firstMovie = results[0];
-    expect(firstMovie).toMatchObject({
-      id: '1',
-      title: 'title 1',
-    });
-  });
-});

package/src/generators/templates/typescript/src/triggers/movie.ts

@@ -1,29 +0,0 @@
-import {
-  defineTrigger,
-  type PollingTriggerPerform,
-} from 'zapier-platform-core';
-import { API_URL } from '../constants.js';
-
-const perform = (async (z, bundle) => {
-  const response = await z.request(`${API_URL}/movies`);
-  return response.data;
-}) satisfies PollingTriggerPerform;
-
-export default defineTrigger({
-  key: 'movie',
-  noun: 'Movie',
-
-  display: {
-    label: 'New Movie',
-    description: 'Triggers when a new movie is created.',
-  },
-
-  operation: {
-    type: 'polling',
-    perform,
-    sample: {
-      id: '1',
-      title: 'example',
-    },
-  },
-});

package/src/generators/templates/typescript/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "resolveJsonModule": true,
-    "esModuleInterop": true,
-    "noUncheckedIndexedAccess": true,
-    "isolatedModules": true,
-    "skipLibCheck": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "strict": true
-  },
-  "include": ["./src/**/*.ts"],
-  "exclude": ["./**/*.test.ts"]
-}