@zapier/zapier-sdk 0.122.2 → 0.124.0

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # @zapier/zapier-sdk
 
+## 0.124.0
+
+### Minor Changes
+
+- be5d20b: Added `createSdk`'s `imports` option. To build your own SDK on
+  `zapierSdkPlugin`, pass your options as a typed provider:
+
+  ```ts
+  createSdk(zapierSdkPlugin, {
+    imports: [defineProperty(sdkOptionsPluginRef, { value: options })],
+  });
+  ```
+
+  Use `imports`, not `configuration`, for SDK options and core options.
+  `configuration` keeps working, but its values are untyped and unchecked, so
+  avoid it unless the ids are only known at runtime.
+
+  `zapierSdkPlugin` now provides `zapierCoreOptions` by default, so an SDK built
+  on it reports Zapier errors and deprecation notices without passing
+  `CORE_OPTIONS_ID`. To use different core options, pass your own
+  `defineProperty(coreOptionsPluginRef, { value })` in `imports`, which takes
+  precedence.
+
+  Added the `coreOptionsPluginRef` export.
+
+  Deprecated the id constants `SDK_OPTIONS_ID`, `CORE_OPTIONS_ID`, `API_ID`,
+  `RESOLVE_CREDENTIALS_ID`, `CONNECTIONS_ID`, `EVENT_EMISSION_ID`, and
+  `MANIFEST_ID`. Pass the matching stand-in instead (`sdkOptionsPluginRef`,
+  `coreOptionsPluginRef`, `apiPluginRef`, and so on), or read its `.id`. The
+  constants keep working.
+
+### Patch Changes
+
+- Updated dependencies [be5d20b]
+  - @zapier/kitcore@0.23.0
+
+## 0.123.0
+
+### Minor Changes
+
+- 69f19ce: Removed the `sendHttpRequest` option from the deprecated `createZapierApi`. If it is still passed, it is ignored and requests go through the SDK's built-in transport. To replace the network layer, build an SDK with `createSdk` and add a hook (`defineHook` from `@zapier/kitcore`) that wraps `dispatchHttpRequestPlugin`. Routing and authentication run before your hook, deprecation notices are read from the response it returns, and the SDK's retries wrap it, so it can be called more than once per request (set `maxNetworkRetries: 0` to turn retries off).
+
+  Request routing and deprecation notices also changed:
+  - Request paths where a query string or fragment immediately follows a route key (e.g. `/relay?x=1`) now resolve against the configured routes instead of falling through unrouted.
+  - The `api:deprecation_notice` event now fires on every response that carries a notice rather than once per logical call: a request retried on a 429 or 5xx, and a request that goes through the approval flow, can emit more than one event. The console warning still prints once per notice id, so a different notice on one of those extra responses prints its own warning.
+  - The `path` field on `api:rate_limit_retry` now reports the request path as passed (e.g. `/tables/api/v1/tables`) rather than the fully resolved URL.
+
 ## 0.122.2
 
 ### Patch Changes