@zapier/zapier-sdk-core 0.12.0 → 0.13.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @zapier/zapier-sdk-core
 
+## 0.13.0
+
+### Minor Changes
+
+- eb48f58: Adopt canonical resource-shaped `ActionRunContext` for the
+  `POST /api/v0/approvals` request body.
+
+  The inline `RequestContext` / `ActionRunContext` / `HttpRequestContext`
+  Zod mirrors in `create-approval.ts` are deleted in favor of importing
+  the canonical `RequestContextSchema` directly from `@zapier/policy-context`
+  (now a runtime dependency). Action identity is now carried in a single
+  canonical `resource` field of the form
+  `action/{selected_api}/{action_type}/{action_key}`; the legacy
+  `{selected_api, action_type, action_key}` triple is still accepted on
+  input during the migration window and normalized to the canonical shape
+  before storage. No wire-level breaking change for existing callers.
+
 ## 0.12.0
 
 ### Minor Changes

package/openapi.yaml

@@ -230,30 +230,30 @@ components:
       properties:
         scheme:
           type: string
-          description: URL scheme (e.g. https)
+          description: URL scheme, e.g. "https"
         host:
           type: string
-          description: Hostname
+          description: Hostname, e.g. "api.example.com"
         port:
-          type: number
-          description: Port number
+          type: integer
+          description: Port number (defaults to 443 for https, 80 for http)
         path:
           type: string
-          description: URL path
+          description: URL path, e.g. "/v1/foo"
         query:
           type: object
           additionalProperties:
             type: array
             items:
               type: string
-          description: Query parameters
+          description: Query parameters as key to string array mapping
       required:
         - scheme
         - host
         - port
         - path
         - query
-      description: Parsed URL components
+      description: Parsed URL components for policy condition matching
     HttpRequestContext:
       type: object
       properties:
@@ -264,6 +264,7 @@ components:
           description: Context type discriminator
         method:
           type: string
+          maxLength: 10
           description: HTTP method
         url:
           $ref: "#/components/schemas/ParsedUrl"
@@ -276,21 +277,38 @@ components:
           type:
             - string
             - "null"
+          maxLength: 65536
           description: Raw body string
         body_json:
-          description: Parsed JSON body
+          description: Parsed JSON body (if applicable)
         connection_id:
           type: string
+          maxLength: 255
           description: Zapier connection ID used for this request
         reason:
           type: string
-          description: Human-readable reason
+          maxLength: 1024
+          description: Optional human-readable reason for the request
       required:
         - request_type
         - method
         - url
         - headers
         - body
+        - body_json
+    action_type:
+      type: string
+      enum:
+        - filter
+        - read
+        - read_bulk
+        - run
+        - search
+        - search_and_write
+        - search_or_write
+        - write
+      description: "Legacy: canonical Zapier action type. Prefer `resource`."
+      deprecated: true
     ActionRunContext:
       type: object
       properties:
@@ -299,41 +317,50 @@ components:
           enum:
             - action_run
           description: Context type discriminator
+        resource:
+          type: string
+          maxLength: 1024
+          description: Canonical action resource, e.g. action/Slack@1.0.0/write/send_message
         selected_api:
           type: string
-          description: Selected API identifier
+          maxLength: 255
+          deprecated: true
+          description: "Legacy: app identifier, e.g. Slack@1.0.0. Prefer `resource`."
         action_type:
-          type: string
-          description: Action type
+          $ref: "#/components/schemas/action_type"
         action_key:
           type: string
-          description: Action key
+          maxLength: 255
+          deprecated: true
+          description: "Legacy: action key, e.g. send_message. Prefer `resource`."
         connection_id:
           type: string
-          description: Zapier connection ID
+          maxLength: 255
+          description: Zapier connection ID used for this request
         inputs:
           description: Action input parameters
         reason:
           type: string
-          description: Human-readable reason
+          maxLength: 1024
+          description: Optional human-readable reason for the request
       required:
         - request_type
-        - selected_api
-        - action_type
-        - action_key
+      description: Action run context. The canonical shape carries the action identity in a single `resource` field of the form `action/{selected_api}/{action_type}/{action_key}`. The legacy `{selected_api, action_type, action_key}` shape is also accepted on input during the migration window — approvalsapi normalizes it to the canonical form before storage.
+    RequestContext:
+      anyOf:
+        - $ref: "#/components/schemas/HttpRequestContext"
+        - $ref: "#/components/schemas/ActionRunContext"
+      description: Union of request context shapes, keyed on `request_type`.
+      discriminator:
+        propertyName: request_type
+        mapping:
+          http_request: "#/components/schemas/HttpRequestContext"
+          action_run: "#/components/schemas/ActionRunContext"
     CreateApprovalBody:
       type: object
       properties:
         context:
-          oneOf:
-            - $ref: "#/components/schemas/HttpRequestContext"
-            - $ref: "#/components/schemas/ActionRunContext"
-          discriminator:
-            propertyName: request_type
-            mapping:
-              http_request: "#/components/schemas/HttpRequestContext"
-              action_run: "#/components/schemas/ActionRunContext"
-          description: The request context for the approval — either an HTTP request context or an action run context
+          $ref: "#/components/schemas/RequestContext"
       required:
         - context
     CreateClientCredentialsResponse:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zapier/zapier-sdk-core",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Core schemas and TypeScript types for the Zapier SDK API",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Zapier, Inc.",
@@ -88,6 +88,7 @@
     "LICENSE"
   ],
   "dependencies": {
+    "@zapier/policy-context": "1.1.0",
     "zod": "4.3.6"
   },
   "devDependencies": {