Registry / devops / zapier-platform-schema

zapier-platform-schema

JSON →
library19.0.0jsnpmunverified

Schema definition for CLI apps in the Zapier Developer Platform, providing JSON Schema-based validation for integration configuration, triggers, actions, searches, and authentication schemes. Current stable version is 19.0.0. Releases follow the platform CLI updates. Differentiates by being the official schema used by Zapier's platform CLI tooling, with rigorous versioning and exported schema artifacts.

devops
npm install zapier-platform-schema
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · ZAPIER-PLATFORM-SC
Z
zapier-platform-schema
devopsjavascriptv19.0.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

default
✓ import schema from 'zapier-platform-schema'
✗ const schema = require('zapier-platform-schema')
Package exports a default object representing the full schema. CJS require works but TypeScript may prefer default import.
AppSchema
✓ import { AppSchema } from 'zapier-platform-schema'
✗ const { AppSchema } = require('zapier-platform-schema')
Named export available since earlier versions. TypeScript definitions included.
FieldSchema
✓ import { FieldSchema } from 'zapier-platform-schema'
✗ import FieldSchema from 'zapier-platform-schema'
Named export, not default. Ensure correct destructuring.
types
✓ import { types } from 'zapier-platform-schema'
Named export providing type constants.

Demonstrates importing the default schema and using it to validate an app definition object.

import schema from 'zapier-platform-schema' const appDefinition = { title: 'My App', version: '1.0.0', platformVersion: '19.0.0', } const validator = schema.validate(appDefinition) console.log(validator.valid ? 'Valid!' : 'Invalid:', validator.errors)
Debug
Known issues
breakingRemoved deprecated 'withoutPrefix' option from all schema fields.
fix
Remove usage of 'withoutPrefix' from field definitions.
affects: >=18.0.0
deprecatedThe 'zapier-platform-core' package formerly depended on 'zapier-platform-schema' directly; now it's a peer dependency.
fix
Ensure both packages are installed and compatible.
affects: >=15.0.0
gotchaSchema validation uses JSON Schema Draft 07; unsupported keywords may cause silent failures.
fix
Refer to JSON Schema Draft 07 specification; avoid draft-04 or earlier keywords.
affects: >=0.0.0
Errors
Common errors & fixes
Error: Cannot find module 'zapier-platform-schema'
Package not installed or not in node_modules.
fix
Run `npm install zapier-platform-schema` or `yarn add zapier-platform-schema`.
TypeError: schema.validate is not a function
Using default import incorrectly (e.g., importing named export instead of default).
fix
Ensure default import: `import schema from 'zapier-platform-schema'`.
ValidationError: 'fields' must be an array
Provided a string or object instead of array for fields in a trigger/action.
fix
Ensure fields property is an array of field objects.
Upgrade
Version history
19.0.0latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
23 hits · last 30 days
node
20
Resources
githubhttps://github.com/zapier/zapier-platform ↗
packagezapier-platform-schema ↗
homepagehttps://platform.zapier.com/ ↗
zapier-platform-schema — npm install zapier-platform-schema · libregistry