App SDK Overview
@saleor/app-sdk is a TypeScript-first npm library that serves as a foundation for every Saleor app. It includes helpers built for React and serverless functions, like AWS Lambda or Next.JS
You can find @saleor/app-sdk on npm and GitHub.
Installation​
Install @saleor/app-sdk by running the following command:
# Preferred - with pnpm
pnpm add @saleor/app-sdk
# With npm and yarn
npm i @saleor/app-sdk
yarn add @saleor/app-sdk
Platforms support​
Utilities for server-side operations support multiple platforms. Currently, we support:
- Next.js (Pages)
- Next.js (App Router)
- AWS Lambda (Serverless functions)
- FetchAPI (Deno, Cloudflare Workers, etc)
Versioning​
@saleor/app-sdk uses semver. We track its releases and changelogs on GitHub.
Hint: See migration from 0.x to 1.x for more information.
Requirements​
- Saleor support: 3.20 and higher (it may work in older versions, but it's not guaranteed).
- Next.js support: 14 and higher
Peer Dependencies​
The SDK has several optional peer dependencies. Install only what you need based on which entry points you use:
| Entry Point | Required Peer Dependencies |
|---|---|
@saleor/app-sdk/app-bridge | react, react-dom |
@saleor/app-sdk/app-bridge/next | react, react-dom, next |
@saleor/app-sdk/handlers/next | next, graphql |
@saleor/app-sdk/handlers/next-app-router | next, graphql |
@saleor/app-sdk/handlers/fetch-api | graphql |
@saleor/app-sdk/handlers/aws-lambda | graphql |
@saleor/app-sdk/settings-manager | - |
@saleor/app-sdk/APL | - |
@saleor/app-sdk/APL/env | - |
@saleor/app-sdk/APL/file | - |
@saleor/app-sdk/APL/upstash | - |
@saleor/app-sdk/APL/saleor-cloud | - |
@saleor/app-sdk/APL/redis | redis |
@saleor/app-sdk/APL/vercel-kv | @vercel/kv |
@saleor/app-sdk/APL/dynamodb | @aws-sdk/client-dynamodb, @aws-sdk/lib-dynamodb, dynamodb-toolbox |
EncryptedMetadataManager from @saleor/app-sdk/settings-manager uses Node.js crypto by default. For browser usage, provide custom encryptionMethod and decryptionMethod, or use MetadataManager without encryption.
Learn more​
If you are interested in building Saleor apps using @saleor/app-sdk, you may want to check out the following resources: