@zapier/zapier-sdk 0.13.9 → 0.15.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @zapier/zapier-sdk
 
+## 0.15.0
+
+### Minor Changes
+
+- f92bc07: Route all API requests through new service.
+
+## 0.14.0
+
+### Minor Changes
+
+- 3f2f104: - Introduce a `services` layer for reusability between plugins
+  - `listInputFieldChoices` now supports returning static choices if they exist
+
 ## 0.13.9
 
 ### Patch Changes

package/dist/api/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAGjB,MAAM,SAAS,CAAC;AA4cjB,eAAO,MAAM,eAAe,GAAI,SAAS,gBAAgB,KAAG,SAW3D,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/api/client.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EACV,SAAS,EACT,gBAAgB,EAGjB,MAAM,SAAS,CAAC;AAwejB,eAAO,MAAM,eAAe,GAAI,SAAS,gBAAgB,KAAG,SAW3D,CAAC"}

package/dist/api/client.js

@@ -8,11 +8,18 @@ import { getAuthorizationHeader } from "./auth";
 import { createDebugLogger, createDebugFetch } from "./debug";
 import { pollUntilComplete } from "./polling";
 import { getTokenFromEnvOrConfig } from "../auth";
+import { getZapierBaseUrl } from "../utils/url-utils";
 import { ZapierApiError, ZapierAuthenticationError, ZapierValidationError, ZapierNotFoundError, } from "../types/errors";
-const SubdomainConfigMap = {
-    // e.g. https://relay.zapier.com
-    relay: {
+const pathConfig = {
+    // e.g. /relay -> https://sdkapi.zapier.com/api/v0/sdk/relay/...
+    "/relay": {
         authHeader: "X-Relay-Authorization",
+        pathPrefix: "/api/v0/sdk/relay",
+    },
+    // e.g. /zapier -> https://sdkapi.zapier.com/api/v0/sdk/zapier/...
+    "/zapier": {
+        authHeader: "Authorization",
+        pathPrefix: "/api/v0/sdk/zapier",
     },
 };
 class ZapierApiClient {
@@ -223,37 +230,53 @@ class ZapierApiClient {
             return { message: fallbackMessage };
         }
     }
-    // Check if this is a path that needs subdomain routing
-    // e.g. /relay/workflows -> relay.zapier.com/workflows
-    applySubdomainBehavior(path) {
-        const pathSegments = path.split("/").filter(Boolean);
-        if (pathSegments.length > 0 && pathSegments[0] in SubdomainConfigMap) {
-            // Transform paths to use subdomain routing
-            // /prefix/domain/path -> prefix.zapier.com/domain/path
-            const domainPrefix = pathSegments[0];
-            const subdomainConfig = SubdomainConfigMap[domainPrefix];
+    // Apply any special routing logic for configured paths.
+    applyPathConfiguration(path) {
+        // Find matching path configuration.
+        const matchingPathKey = Object.keys(pathConfig).find((configPath) => path === configPath || path.startsWith(configPath + "/"));
+        const config = matchingPathKey ? pathConfig[matchingPathKey] : undefined;
+        // Check if baseUrl is a Zapier-inferred base URL.
+        const zapierBaseUrl = getZapierBaseUrl(this.options.baseUrl);
+        // Let's remain compatible with a base URL that is set to a Zapier-inferred
+        // domain, rather than requiring the base URL to go to our proxy. Later, the
+        // proxy will be removed, so this should make that transition easier.
+        if (zapierBaseUrl === this.options.baseUrl) {
+            // If baseUrl is already the Zapier base URL, use sdkapi subdomain.
             const originalBaseUrl = new URL(this.options.baseUrl);
-            const finalBaseUrl = `https://${domainPrefix}.${originalBaseUrl.hostname}`;
-            const pathWithoutPrefix = "/" + pathSegments.slice(1).join("/");
-            return { url: new URL(pathWithoutPrefix, finalBaseUrl), subdomainConfig };
+            const finalBaseUrl = `https://sdkapi.${originalBaseUrl.hostname}`;
+            // Only prepend pathPrefix if there's a matching config with pathPrefix.
+            let finalPath = path;
+            if (config &&
+                "pathPrefix" in config &&
+                config.pathPrefix &&
+                matchingPathKey) {
+                // Strip the matching path key, and use the pathPrefix instead.
+                const pathWithoutPrefix = path.slice(matchingPathKey.length) || "/";
+                finalPath = `${config.pathPrefix}${pathWithoutPrefix}`;
+            }
+            return {
+                url: new URL(finalPath, finalBaseUrl),
+                pathConfig: config,
+            };
         }
+        // For a base URL that isn't a Zapier-inferred domain, use the whole base URL.
         return {
             url: new URL(path, this.options.baseUrl),
-            subdomainConfig: undefined,
+            pathConfig: config,
         };
     }
     // Helper to build full URLs and return routing info
     buildUrl(path, searchParams) {
-        const { url, subdomainConfig } = this.applySubdomainBehavior(path);
+        const { url, pathConfig: config } = this.applyPathConfiguration(path);
         if (searchParams) {
             Object.entries(searchParams).forEach(([key, value]) => {
                 url.searchParams.set(key, value);
             });
         }
-        return { url: url.toString(), subdomainConfig };
+        return { url: url.toString(), pathConfig: config };
     }
     // Helper to build headers
-    async buildHeaders(options = {}, subdomainConfig) {
+    async buildHeaders(options = {}, pathConfig) {
         const headers = new Headers(options.headers ?? {});
         // Even if auth is not required, we still want to add it in case it adds
         // useful context to the API. The session is a good example of this. Auth
@@ -261,7 +284,7 @@ class ZapierApiClient {
         // session!
         const authToken = await this.getAuthToken();
         if (authToken) {
-            const authHeaderName = subdomainConfig?.authHeader || "Authorization";
+            const authHeaderName = pathConfig?.authHeader || "Authorization";
             headers.set(authHeaderName, getAuthorizationHeader(authToken));
         }
         // If we know auth is required, and we don't have a token, throw an error
@@ -307,8 +330,8 @@ class ZapierApiClient {
         if (fetchOptions?.body && typeof fetchOptions.body === "object") {
             fetchOptions.body = JSON.stringify(fetchOptions.body);
         }
-        const { url, subdomainConfig } = this.buildUrl(path, fetchOptions?.searchParams);
-        const builtHeaders = await this.buildHeaders(fetchOptions, subdomainConfig);
+        const { url, pathConfig } = this.buildUrl(path, fetchOptions?.searchParams);
+        const builtHeaders = await this.buildHeaders(fetchOptions, pathConfig);
         const inputHeaders = new Headers(fetchOptions?.headers ?? {});
         const mergedHeaders = new Headers();
         builtHeaders.forEach((value, key) => {

package/dist/index.cjs

@@ -1295,7 +1295,7 @@ var listAppsPlugin = ({ context }) => {
       const searchParams2 = {};
       searchParams2.term = options.search;
       const searchEnvelope = await api.get(
-        "/api/v4/implementations-meta/search/",
+        "/zapier/api/v4/implementations-meta/search/",
         {
           searchParams: searchParams2
         }
@@ -1335,7 +1335,7 @@ var listAppsPlugin = ({ context }) => {
       };
     }
     const implementationsEnvelope = await api.get(
-      "/api/v4/implementations-meta/lookup/",
+      "/zapier/api/v4/implementations-meta/lookup/",
       {
         searchParams
       }
@@ -1621,7 +1621,7 @@ var listActionsPlugin = ({ context }) => {
       selected_apis: selectedApi
     };
     const data = await api.get(
-      "/api/v4/implementations/",
+      "/zapier/api/v4/implementations/",
       {
         searchParams,
         customErrorHandler: ({ status }) => {
@@ -1812,6 +1812,64 @@ var RootFieldItemSchema = zod.z.union([
   FieldsetItemSchema
 ]);
 
+// src/services/implementations.ts
+async function fetchImplementationNeeds({
+  api,
+  selectedApi,
+  action,
+  actionType,
+  authenticationId,
+  inputs
+}) {
+  const request = {
+    selected_api: selectedApi,
+    action,
+    type_of: actionType,
+    params: inputs || {}
+  };
+  if (authenticationId !== null) {
+    request.authentication_id = authenticationId;
+  }
+  const response = await api.post(
+    "/zapier/api/v4/implementations/needs/",
+    request
+  );
+  if (!response.success) {
+    throw new ZapierApiError(
+      `Failed to get input fields: ${response.errors?.join(", ") || "Unknown error"}`
+    );
+  }
+  return response;
+}
+async function fetchImplementationChoices({
+  api,
+  actionId,
+  inputFieldId,
+  authenticationId,
+  inputs,
+  page
+}) {
+  const request = {
+    action_id: actionId,
+    input_field_id: inputFieldId,
+    page,
+    params: inputs || {}
+  };
+  if (authenticationId !== null) {
+    request.authentication_id = authenticationId;
+  }
+  const response = await api.post(
+    "/zapier/api/v4/implementations/choices/",
+    request
+  );
+  if (!response.success) {
+    throw new ZapierApiError(
+      `Failed to get input field choices: ${response.errors?.join(", ") || "Unknown error"}`
+    );
+  }
+  return response;
+}
+
 // src/plugins/listInputFields/index.ts
 function getInputFieldTypeFromNeed(need) {
   if (need.list) {
@@ -1915,7 +1973,13 @@ var listInputFieldsPlugin = ({ sdk, context }) => {
   const listInputFields = createPaginatedFunction(
     async function listInputFieldsPage(options) {
       const { api, getVersionedImplementationId } = context;
-      const { appKey, actionKey, actionType, authenticationId, inputs } = options;
+      const {
+        appKey,
+        actionKey,
+        actionType,
+        authenticationId = null,
+        inputs
+      } = options;
       const selectedApi = await getVersionedImplementationId(appKey);
       if (!selectedApi) {
         throw new ZapierConfigurationError(
@@ -1928,24 +1992,14 @@ var listInputFieldsPlugin = ({ sdk, context }) => {
         actionType,
         actionKey
       });
-      const needsRequest = {
-        selected_api: selectedApi,
+      const needsData = await fetchImplementationNeeds({
+        api,
+        selectedApi,
         action: action.key,
-        type_of: actionType,
-        params: inputs || {}
-      };
-      if (authenticationId !== null) {
-        needsRequest.authentication_id = authenticationId;
-      }
-      const needsData = await api.post(
-        "/api/v4/implementations/needs/",
-        needsRequest
-      );
-      if (!needsData.success) {
-        throw new ZapierApiError(
-          `Failed to get action fields: ${needsData.errors?.join(", ") || "Unknown error"}`
-        );
-      }
+        actionType,
+        authenticationId,
+        inputs
+      });
       const rootFieldset = transformNeedsToFields(needsData.needs || []);
       return {
         data: rootFieldset,
@@ -2070,7 +2124,7 @@ var listAuthenticationsPlugin = ({ context }) => {
         searchParams.offset = options.cursor;
       }
       const data = await api.get(
-        "/api/v4/authentications/",
+        "/zapier/api/v4/authentications/",
         {
           searchParams,
           customErrorHandler: ({ status }) => {
@@ -2210,7 +2264,7 @@ var getAuthenticationPlugin = ({ context }) => {
     const { api } = context;
     const { authenticationId } = options;
     const data = await api.get(
-      `/api/v4/authentications/${authenticationId}/`,
+      `/zapier/api/v4/authentications/${authenticationId}/`,
       {
         customErrorHandler: ({ status }) => {
           if (status === 401) {
@@ -2403,11 +2457,11 @@ async function executeAction(actionOptions) {
     data: runRequestData
   };
   const runData = await api.post(
-    "/api/actions/v1/runs",
+    "/zapier/api/actions/v1/runs",
     runRequest
   );
   const runId = runData.data.id;
-  return await api.poll(`/api/actions/v1/runs/${runId}`, {
+  return await api.poll(`/zapier/api/actions/v1/runs/${runId}`, {
     successStatus: 200,
     pendingStatus: 202,
     resultExtractor: (result) => result.data
@@ -2688,7 +2742,7 @@ async function getPreferredManifestEntryKey({
   }
   if (locator.implementationName) {
     try {
-      const implementationsEnvelope = await api.get(`/api/v4/implementations-meta/lookup/`, {
+      const implementationsEnvelope = await api.get(`/zapier/api/v4/implementations-meta/lookup/`, {
         searchParams: {
           selected_apis: locator.implementationName
         }
@@ -2715,7 +2769,7 @@ async function listAppsForSlugsPage({
     searchParams.offset = cursor;
   }
   const implementationsEnvelope = await api.get(
-    "/api/v4/implementations-meta/lookup/",
+    "/zapier/api/v4/implementations-meta/lookup/",
     {
       searchParams
     }
@@ -2954,9 +3008,12 @@ var UserProfileItemSchema = withFormatter(
 // src/plugins/getProfile/index.ts
 var getProfilePlugin = ({ context }) => {
   const getProfile = createFunction(async function getProfile2() {
-    const profile = await context.api.get("/api/v4/profile/", {
-      authRequired: true
-    });
+    const profile = await context.api.get(
+      "/zapier/api/v4/profile/",
+      {
+        authRequired: true
+      }
+    );
     const { user_id: _unusedUserId, ...data } = profile;
     return {
       data: {
@@ -3283,11 +3340,63 @@ async function getTokenFromEnvOrConfig(options = {}) {
   return getTokenFromCliLogin(options);
 }
 
+// src/utils/url-utils.ts
+function getZapierBaseUrl(baseUrl) {
+  if (!baseUrl) {
+    return void 0;
+  }
+  try {
+    const url = new URL(baseUrl);
+    const hostname = url.hostname;
+    const hostParts = hostname.split(".");
+    if (hostParts.length < 2) {
+      return void 0;
+    }
+    const hasZapierPart = hostParts.some(
+      (part) => part === "zapier" || part.startsWith("zapier-")
+    );
+    if (!hasZapierPart) {
+      return void 0;
+    }
+    const rootDomain = hostParts.slice(-2).join(".");
+    return `${url.protocol}//${rootDomain}`;
+  } catch {
+    return void 0;
+  }
+}
+function getTrackingBaseUrl({
+  trackingBaseUrl,
+  baseUrl
+}) {
+  if (trackingBaseUrl) {
+    return trackingBaseUrl;
+  }
+  if (process.env.ZAPIER_TRACKING_BASE_URL) {
+    return process.env.ZAPIER_TRACKING_BASE_URL;
+  }
+  if (baseUrl) {
+    const zapierBaseUrl = getZapierBaseUrl(baseUrl);
+    if (zapierBaseUrl) {
+      return zapierBaseUrl;
+    }
+  }
+  if (baseUrl) {
+    return baseUrl;
+  }
+  return ZAPIER_BASE_URL;
+}
+
 // src/api/client.ts
-var SubdomainConfigMap = {
-  // e.g. https://relay.zapier.com
-  relay: {
-    authHeader: "X-Relay-Authorization"
+var pathConfig = {
+  // e.g. /relay -> https://sdkapi.zapier.com/api/v0/sdk/relay/...
+  "/relay": {
+    authHeader: "X-Relay-Authorization",
+    pathPrefix: "/api/v0/sdk/relay"
+  },
+  // e.g. /zapier -> https://sdkapi.zapier.com/api/v0/sdk/zapier/...
+  "/zapier": {
+    authHeader: "Authorization",
+    pathPrefix: "/api/v0/sdk/zapier"
   }
 };
 var ZapierApiClient = class {
@@ -3476,39 +3585,47 @@ var ZapierApiClient = class {
       return { message: fallbackMessage };
     }
   }
-  // Check if this is a path that needs subdomain routing
-  // e.g. /relay/workflows -> relay.zapier.com/workflows
-  applySubdomainBehavior(path) {
-    const pathSegments = path.split("/").filter(Boolean);
-    if (pathSegments.length > 0 && pathSegments[0] in SubdomainConfigMap) {
-      const domainPrefix = pathSegments[0];
-      const subdomainConfig = SubdomainConfigMap[domainPrefix];
+  // Apply any special routing logic for configured paths.
+  applyPathConfiguration(path) {
+    const matchingPathKey = Object.keys(pathConfig).find(
+      (configPath) => path === configPath || path.startsWith(configPath + "/")
+    );
+    const config = matchingPathKey ? pathConfig[matchingPathKey] : void 0;
+    const zapierBaseUrl = getZapierBaseUrl(this.options.baseUrl);
+    if (zapierBaseUrl === this.options.baseUrl) {
       const originalBaseUrl = new URL(this.options.baseUrl);
-      const finalBaseUrl = `https://${domainPrefix}.${originalBaseUrl.hostname}`;
-      const pathWithoutPrefix = "/" + pathSegments.slice(1).join("/");
-      return { url: new URL(pathWithoutPrefix, finalBaseUrl), subdomainConfig };
+      const finalBaseUrl = `https://sdkapi.${originalBaseUrl.hostname}`;
+      let finalPath = path;
+      if (config && "pathPrefix" in config && config.pathPrefix && matchingPathKey) {
+        const pathWithoutPrefix = path.slice(matchingPathKey.length) || "/";
+        finalPath = `${config.pathPrefix}${pathWithoutPrefix}`;
+      }
+      return {
+        url: new URL(finalPath, finalBaseUrl),
+        pathConfig: config
+      };
     }
     return {
       url: new URL(path, this.options.baseUrl),
-      subdomainConfig: void 0
+      pathConfig: config
     };
   }
   // Helper to build full URLs and return routing info
   buildUrl(path, searchParams) {
-    const { url, subdomainConfig } = this.applySubdomainBehavior(path);
+    const { url, pathConfig: config } = this.applyPathConfiguration(path);
     if (searchParams) {
       Object.entries(searchParams).forEach(([key, value]) => {
         url.searchParams.set(key, value);
       });
     }
-    return { url: url.toString(), subdomainConfig };
+    return { url: url.toString(), pathConfig: config };
   }
   // Helper to build headers
-  async buildHeaders(options = {}, subdomainConfig) {
+  async buildHeaders(options = {}, pathConfig2) {
     const headers = new Headers(options.headers ?? {});
     const authToken = await this.getAuthToken();
     if (authToken) {
-      const authHeaderName = subdomainConfig?.authHeader || "Authorization";
+      const authHeaderName = pathConfig2?.authHeader || "Authorization";
       headers.set(authHeaderName, getAuthorizationHeader(authToken));
     }
     if (options.authRequired) {
@@ -3555,13 +3672,10 @@ var ZapierApiClient = class {
     if (fetchOptions?.body && typeof fetchOptions.body === "object") {
       fetchOptions.body = JSON.stringify(fetchOptions.body);
     }
-    const { url, subdomainConfig } = this.buildUrl(
-      path,
-      fetchOptions?.searchParams
-    );
+    const { url, pathConfig: pathConfig2 } = this.buildUrl(path, fetchOptions?.searchParams);
     const builtHeaders = await this.buildHeaders(
       fetchOptions,
-      subdomainConfig
+      pathConfig2
     );
     const inputHeaders = new Headers(fetchOptions?.headers ?? {});
     const mergedHeaders = new Headers();
@@ -3855,43 +3969,62 @@ function transformNeedChoicesToInputFieldChoiceItem(choice) {
 }
 var listInputFieldChoicesPlugin = ({ context, sdk }) => {
   const listInputFieldChoices = createPaginatedFunction(async function listInputFieldChoicesPage(options) {
-    const { api } = context;
+    const { api, getVersionedImplementationId } = context;
     const {
       appKey,
       actionType,
       actionKey,
       inputFieldKey,
-      authenticationId,
+      authenticationId = null,
       inputs,
       page,
       cursor
     } = options;
-    const actionResult = await sdk.getAction({ appKey, actionType, actionKey });
-    const actionId = actionResult.data.id;
-    if (!actionId) {
-      throw new ZapierApiError(
-        `Action ${actionKey} does not have an ID - cannot retrieve input field choices`
+    const selectedApi = await getVersionedImplementationId(appKey);
+    if (!selectedApi) {
+      throw new ZapierConfigurationError(
+        "No current_implementation_id found for app",
+        { configType: "current_implementation_id" }
       );
     }
-    const requestPage = cursor ? parseInt(cursor, 10) : page ?? 0;
-    const choicesRequest = {
-      action_id: actionId,
-      input_field_id: inputFieldKey,
-      page: requestPage,
-      params: inputs || {}
-    };
-    if (authenticationId !== null) {
-      choicesRequest.authentication_id = authenticationId;
-    }
-    const choicesData = await api.post(
-      "/api/v4/implementations/choices/",
-      choicesRequest
+    const { data: action } = await sdk.getAction({
+      appKey,
+      actionType,
+      actionKey
+    });
+    const needsData = await fetchImplementationNeeds({
+      api,
+      selectedApi,
+      action: action.key,
+      actionType,
+      authenticationId,
+      inputs
+    });
+    const targetNeed = needsData.needs?.find(
+      (need) => need.key === inputFieldKey
     );
-    if (!choicesData.success) {
+    if (targetNeed?.choices && targetNeed.choices.length > 0) {
+      return {
+        data: targetNeed.choices.map(
+          transformNeedChoicesToInputFieldChoiceItem
+        ),
+        nextCursor: void 0
+      };
+    }
+    if (!action.id) {
       throw new ZapierApiError(
-        `Failed to get input field choices: ${choicesData.errors?.join(", ") || "Unknown error"}`
+        `Action ${actionKey} does not have an ID - cannot retrieve input field choices`
       );
     }
+    const requestPage = cursor ? parseInt(cursor, 10) : page ?? 0;
+    const choicesData = await fetchImplementationChoices({
+      api,
+      actionId: action.id,
+      inputFieldId: inputFieldKey,
+      authenticationId,
+      inputs,
+      page: requestPage
+    });
     const choices = (choicesData.choices || []).map(
       transformNeedChoicesToInputFieldChoiceItem
     );
@@ -4089,7 +4222,7 @@ function getCpuTime() {
 
 // package.json
 var package_default = {
-  version: "0.13.9"};
+  version: "0.15.0"};
 
 // src/plugins/eventEmission/builders.ts
 function createBaseEvent(context = {}) {
@@ -4159,52 +4292,6 @@ function buildErrorEventWithContext(data, context = {}) {
   };
 }
 
-// src/utils/url-utils.ts
-function getZapierBaseUrl(baseUrl) {
-  if (!baseUrl) {
-    return void 0;
-  }
-  try {
-    const url = new URL(baseUrl);
-    const hostname = url.hostname;
-    const hostParts = hostname.split(".");
-    if (hostParts.length < 2) {
-      return void 0;
-    }
-    const hasZapierPart = hostParts.some(
-      (part) => part === "zapier" || part.startsWith("zapier-")
-    );
-    if (!hasZapierPart) {
-      return void 0;
-    }
-    const rootDomain = hostParts.slice(-2).join(".");
-    return `${url.protocol}//${rootDomain}`;
-  } catch {
-    return void 0;
-  }
-}
-function getTrackingBaseUrl({
-  trackingBaseUrl,
-  baseUrl
-}) {
-  if (trackingBaseUrl) {
-    return trackingBaseUrl;
-  }
-  if (process.env.ZAPIER_TRACKING_BASE_URL) {
-    return process.env.ZAPIER_TRACKING_BASE_URL;
-  }
-  if (baseUrl) {
-    const zapierBaseUrl = getZapierBaseUrl(baseUrl);
-    if (zapierBaseUrl) {
-      return zapierBaseUrl;
-    }
-  }
-  if (baseUrl) {
-    return baseUrl;
-  }
-  return ZAPIER_BASE_URL;
-}
-
 // src/plugins/eventEmission/index.ts
 var APPLICATION_LIFECYCLE_EVENT_SUBJECT = "platform.sdk.ApplicationLifecycleEvent";
 var ERROR_OCCURRED_EVENT_SUBJECT = "platform.sdk.ErrorOccurredEvent";