@shopify/app-bridge-types
v0.7.1
Published
Companion types library for the Shopify App Bridge script
Keywords
Readme
@shopify/app-bridge-types
Join our team and work on libraries like this one.
This is a companion library with TypeScript types for Shopify App Bridge.
Installation
You can install Shopify App Bridge Types by using NPM:
npm install --save-dev @shopify/app-bridge-typesDevelopment
How Types are Generated
The types in this package are downloaded from the Shopify CDN during the build step:
- The App Bridge team publishes the type definitions to
https://cdn.shopify.com/shopifycloud/app-bridge.d.ts - During build,
scripts/build.mjsfetches the.d.tsfile from the CDN and writes it todist/index.d.ts - The downloaded types are then published to npm
Releasing a New Version
To release a new version of the types package:
- Ensure the updated types have been published to the CDN
- Run
pnpm changesetfrom the root of the repository - Select
@shopify/app-bridge-typesto bump its version - Commit your changes
- CI will automatically handle building and publishing the updated package
