@zapier/zapier-sdk 0.44.0 → 0.45.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @zapier/zapier-sdk
 
+## 0.45.0
+
+### Minor Changes
+
+- 15dce25: `registryPlugin` is now deprecated, because `getRegistry` is built into the SDK and added after each plugin is added. Plugins will always be registered; there is no need to call `createZapierSdkWithoutRegistry`, add custom plugins, and then `.addPlugin(registryPlugin)`. Because of this, `createZapierSdkWithoutRegistry` is now deprecated, and calling it will still give you an SDK with `getRegistry` on it. Calling `addPlugin(registryPlugin)` on that SDK is a no-op.
+
 ## 0.44.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -545,6 +545,10 @@ function createAppsProxy(options) {
 }
 var appsPlugin = (sdk) => {
   return {
+    // Cast: ZapierSdkApps is augmented by user-generated .d.ts files to
+    // give specific types like `slack: SlackAppWithFactory`. At runtime
+    // the Proxy intercepts any property access, so the augmented entries
+    // always resolve correctly even though TS can't see that statically.
     apps: createAppsProxy({ sdk }),
     context: {
       meta: {
@@ -7877,119 +7881,75 @@ var updateTableRecordsPlugin = (sdk) => {
   };
 };
 
-// src/plugins/registry/index.ts
-var registryPlugin = (sdk) => {
-  const metaKeys = Object.keys(sdk.context.meta || {});
-  const categoryDefinitions = {
-    account: {
-      title: "Account"
-    },
-    app: {
-      title: "App",
-      titlePlural: "Apps"
-    },
-    connection: {
-      title: "Connection"
-    },
-    action: {
-      title: "Action"
-    },
-    "client-credentials": {
-      title: "Client Credentials",
-      titlePlural: "Client Credentials"
-    },
-    table: {
-      title: "Table"
-    },
-    http: {
-      title: "HTTP Request"
-    },
-    utility: {
-      title: "Utility",
-      titlePlural: "Utilities"
-    },
-    other: {
-      title: "Other"
-    }
-  };
-  const functions = metaKeys.filter((key) => {
+// src/registry.ts
+var categoryDefinitions = {
+  account: { title: "Account" },
+  app: { title: "App", titlePlural: "Apps" },
+  connection: { title: "Connection" },
+  action: { title: "Action" },
+  "client-credentials": {
+    title: "Client Credentials",
+    titlePlural: "Client Credentials"
+  },
+  table: { title: "Table" },
+  http: { title: "HTTP Request" },
+  utility: { title: "Utility", titlePlural: "Utilities" },
+  other: { title: "Other" }
+};
+var knownCategories = Object.keys(categoryDefinitions);
+function buildRegistry({
+  sdk,
+  meta,
+  packageFilter
+}) {
+  const functions = Object.keys(meta).filter((key) => {
     const property = sdk[key];
-    if (typeof property === "function") {
-      return true;
-    }
+    if (typeof property === "function") return true;
     const [rootKey] = key.split(".");
     const rootProperty = sdk[rootKey];
-    if (typeof rootProperty === "object" && rootProperty !== null) {
-      return true;
-    }
-    return false;
+    return typeof rootProperty === "object" && rootProperty !== null;
   }).map((key) => {
-    const meta = sdk.context.meta[key];
+    const m = meta[key];
     return {
       name: key,
-      description: meta.description,
-      type: meta.type,
-      itemType: meta.itemType,
-      returnType: meta.returnType,
-      inputSchema: meta.inputSchema,
-      inputParameters: meta.inputParameters,
-      outputSchema: meta.outputSchema,
-      categories: meta.categories || [],
-      resolvers: meta.resolvers,
-      formatter: meta.formatter,
-      packages: meta.packages,
-      // Auto-infer confirm: "delete" from type: "delete" (all deletes should confirm)
-      confirm: meta.confirm ?? (meta.type === "delete" ? "delete" : void 0),
-      deprecation: meta.deprecation,
-      aliases: meta.aliases,
-      supportsJsonOutput: meta.supportsJsonOutput ?? true
+      description: m.description,
+      type: m.type,
+      itemType: m.itemType,
+      returnType: m.returnType,
+      inputSchema: m.inputSchema,
+      inputParameters: m.inputParameters,
+      outputSchema: m.outputSchema,
+      categories: m.categories || [],
+      resolvers: m.resolvers,
+      formatter: m.formatter,
+      packages: m.packages,
+      confirm: m.confirm ?? (m.type === "delete" ? "delete" : void 0),
+      deprecation: m.deprecation,
+      aliases: m.aliases,
+      supportsJsonOutput: m.supportsJsonOutput ?? true
     };
   }).sort((a, b) => a.name.localeCompare(b.name));
-  const knownCategories = Object.keys(categoryDefinitions);
-  const registryCache = /* @__PURE__ */ new Map();
-  function getRegistry(options) {
-    const packageFilter = options?.package;
-    const cacheKey = packageFilter || "__all__";
-    if (registryCache.has(cacheKey)) {
-      return registryCache.get(cacheKey);
-    }
-    const filteredFunctions = packageFilter ? functions.filter(
-      (f) => (
-        // Include if packages is undefined (belongs to all packages) or includes the specified package
-        !f.packages || f.packages.includes(packageFilter)
-      )
-    ) : functions;
-    const filteredCategories = knownCategories.sort((a, b) => {
-      if (a === "other") return 1;
-      if (b === "other") return -1;
-      const titleA = categoryDefinitions[a].title;
-      const titleB = categoryDefinitions[b].title;
-      return titleA.localeCompare(titleB);
-    }).map((categoryKey) => {
-      const categoryFunctions = filteredFunctions.filter(
-        (f) => f.categories.includes(categoryKey) || // If the category is "other" and the function is not in any other category, include it
-        categoryKey === "other" && !f.categories.some((c) => knownCategories.includes(c))
-      ).map((f) => f.name).sort();
-      const definition = categoryDefinitions[categoryKey];
-      const title = definition.title;
-      return {
-        key: categoryKey,
-        title,
-        titlePlural: definition.titlePlural ?? `${title}s`,
-        functions: categoryFunctions
-      };
-    }).filter((category) => category.functions.length > 0);
-    const result = {
-      functions: filteredFunctions,
-      categories: filteredCategories
+  const filteredFunctions = packageFilter ? functions.filter((f) => !f.packages || f.packages.includes(packageFilter)) : functions;
+  const filteredCategories = knownCategories.slice().sort((a, b) => {
+    if (a === "other") return 1;
+    if (b === "other") return -1;
+    return categoryDefinitions[a].title.localeCompare(
+      categoryDefinitions[b].title
+    );
+  }).map((categoryKey) => {
+    const categoryFunctions = filteredFunctions.filter(
+      (f) => f.categories.includes(categoryKey) || categoryKey === "other" && !f.categories.some((c) => knownCategories.includes(c))
+    ).map((f) => f.name).sort();
+    const definition = categoryDefinitions[categoryKey];
+    return {
+      key: categoryKey,
+      title: definition.title,
+      titlePlural: definition.titlePlural ?? `${definition.title}s`,
+      functions: categoryFunctions
     };
-    registryCache.set(cacheKey, result);
-    return result;
-  }
-  return {
-    getRegistry
-  };
-};
+  }).filter((category) => category.functions.length > 0);
+  return { functions: filteredFunctions, categories: filteredCategories };
+}
 
 // src/plugins/deprecated/authentications.ts
 var listAuthenticationsPlugin = (sdk) => ({
@@ -8990,13 +8950,28 @@ function createSdk() {
 }
 function buildSdk(properties, context) {
   const frozenContext = Object.freeze(context);
-  return {
+  const registryCache = /* @__PURE__ */ new Map();
+  const sdk = {
     ...properties,
     get context() {
       return frozenContext;
     },
     getContext: () => frozenContext,
     // runtime compat shim, not in types
+    getRegistry(options) {
+      const cacheKey = options?.package ?? "__all__";
+      if (!registryCache.has(cacheKey)) {
+        registryCache.set(
+          cacheKey,
+          buildRegistry({
+            sdk,
+            meta: frozenContext.meta,
+            packageFilter: options?.package
+          })
+        );
+      }
+      return registryCache.get(cacheKey);
+    },
     addPlugin(plugin) {
       const pluginResult = plugin({
         ...properties,
@@ -9027,12 +9002,16 @@ function buildSdk(properties, context) {
       );
     }
   };
+  return sdk;
 }
 function createZapierSdkWithoutRegistry(options = {}) {
-  return createSdk().addPlugin(createOptionsPlugin(options)).addPlugin(eventEmissionPlugin).addPlugin(apiPlugin).addPlugin(manifestPlugin).addPlugin(capabilitiesPlugin).addPlugin(connectionsPlugin).addPlugin(listAppsPlugin).addPlugin(getAppPlugin).addPlugin(listActionsPlugin).addPlugin(getActionPlugin).addPlugin(listInputFieldsPlugin).addPlugin(getInputFieldsSchemaPlugin).addPlugin(listInputFieldChoicesPlugin).addPlugin(runActionPlugin).addPlugin(listConnectionsPlugin).addPlugin(getConnectionPlugin).addPlugin(findFirstConnectionPlugin).addPlugin(findUniqueConnectionPlugin).addPlugin(listAuthenticationsPlugin).addPlugin(getAuthenticationPlugin).addPlugin(findFirstAuthenticationPlugin).addPlugin(findUniqueAuthenticationPlugin).addPlugin(listClientCredentialsPlugin).addPlugin(createClientCredentialsPlugin).addPlugin(deleteClientCredentialsPlugin).addPlugin(fetchPlugin).addPlugin(requestPlugin).addPlugin(listTablesPlugin).addPlugin(getTablePlugin).addPlugin(deleteTablePlugin).addPlugin(createTablePlugin).addPlugin(listTableFieldsPlugin).addPlugin(createTableFieldsPlugin).addPlugin(deleteTableFieldsPlugin).addPlugin(getTableRecordPlugin).addPlugin(listTableRecordsPlugin).addPlugin(createTableRecordsPlugin).addPlugin(deleteTableRecordsPlugin).addPlugin(updateTableRecordsPlugin).addPlugin(appsPlugin).addPlugin(getProfilePlugin);
+  logDeprecation(
+    "createZapierSdkWithoutRegistry is deprecated; use createZapierSdk instead. getRegistry is now available on every sdk."
+  );
+  return createZapierSdk(options);
 }
 function createZapierSdk(options = {}) {
-  return createZapierSdkWithoutRegistry(options).addPlugin(registryPlugin);
+  return createSdk().addPlugin(createOptionsPlugin(options)).addPlugin(eventEmissionPlugin).addPlugin(apiPlugin).addPlugin(manifestPlugin).addPlugin(capabilitiesPlugin).addPlugin(connectionsPlugin).addPlugin(listAppsPlugin).addPlugin(getAppPlugin).addPlugin(listActionsPlugin).addPlugin(getActionPlugin).addPlugin(listInputFieldsPlugin).addPlugin(getInputFieldsSchemaPlugin).addPlugin(listInputFieldChoicesPlugin).addPlugin(runActionPlugin).addPlugin(listConnectionsPlugin).addPlugin(getConnectionPlugin).addPlugin(findFirstConnectionPlugin).addPlugin(findUniqueConnectionPlugin).addPlugin(listAuthenticationsPlugin).addPlugin(getAuthenticationPlugin).addPlugin(findFirstAuthenticationPlugin).addPlugin(findUniqueAuthenticationPlugin).addPlugin(listClientCredentialsPlugin).addPlugin(createClientCredentialsPlugin).addPlugin(deleteClientCredentialsPlugin).addPlugin(fetchPlugin).addPlugin(requestPlugin).addPlugin(listTablesPlugin).addPlugin(getTablePlugin).addPlugin(deleteTablePlugin).addPlugin(createTablePlugin).addPlugin(listTableFieldsPlugin).addPlugin(createTableFieldsPlugin).addPlugin(deleteTableFieldsPlugin).addPlugin(getTableRecordPlugin).addPlugin(listTableRecordsPlugin).addPlugin(createTableRecordsPlugin).addPlugin(deleteTableRecordsPlugin).addPlugin(updateTableRecordsPlugin).addPlugin(appsPlugin).addPlugin(getProfilePlugin);
 }
 var BaseSdkOptionsSchema = zod.z.object({
   credentials: CredentialsSchema.optional().describe(
@@ -9076,6 +9055,14 @@ var BaseSdkOptionsSchema = zod.z.object({
   // Use credentials instead
 });
 
+// src/plugins/registry/index.ts
+var registryPlugin = () => {
+  logDeprecation(
+    "registryPlugin is deprecated and a no-op; getRegistry is now built into every sdk. Remove .addPlugin(registryPlugin)."
+  );
+  return {};
+};
+
 exports.ActionKeyPropertySchema = ActionKeyPropertySchema;
 exports.ActionPropertySchema = ActionPropertySchema;
 exports.ActionTimeoutMsPropertySchema = ActionTimeoutMsPropertySchema;