@shopify/app-bridge-types
v0.5.3
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 Yarn:
yarn add --dev @shopify/app-bridge-typesDevelopment
How Types are Generated
The types in this package are automatically generated from the sandboxes/app-bridge-next source code:
- Types are defined in
sandboxes/app-bridge-next/src/features/ - During build, they're compiled to
sandboxes/app-bridge-next/dist/app-bridge.d.ts - The build script (
scripts/build.mjs) processes and copies these types to thedistfolder - The processed types are then published to npm
Releasing a New Version
To release a new version of the types package:
- Make your changes to the type definitions in
sandboxes/app-bridge-next/src/features/ - 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
The automation ensures that the types stay in sync with the app-bridge-next implementation.
