App SDK Overview
the installed integration SDK is a TypeScript-first npm library that serves as a foundation for every BoxNCase app. It includes helpers built for React and serverless functions, like AWS Lambda or Next.JS
You can find the installed integration SDK on npm and integration reference.
Installation
Install the installed integration SDK by running the following command:
Illustrative pseudocode: bracketed placeholders must be supplied by your installed integration; they are not literal package names or API identifiers. Use the runtime integration contract.
# Preferred - with pnpm
pnpm add [INSTALLED_INTEGRATION_SDK]
# With npm and yarn
npm i [INSTALLED_INTEGRATION_SDK]
yarn add [INSTALLED_INTEGRATION_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
the installed integration SDK uses semver. We track its releases and changelogs on integration reference.
Hint: See migration from 0.x to 1.x for more information.
Requirements
- BoxNCase support: 3.22 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 |
|---|---|
| the installed integration SDK | react, react-dom |
| the installed integration SDK | react, react-dom, next |
| the installed integration SDK | next, graphql |
| the installed integration SDK | next, graphql |
| the installed integration SDK | graphql |
| the installed integration SDK | graphql |
| the installed integration SDK | - |
| the installed integration SDK | - |
| the installed integration SDK | - |
| the installed integration SDK | - |
| the installed integration SDK | - |
| the installed integration SDK | redis |
| the installed integration SDK | @vercel/kv |
| the installed integration SDK | @aws-sdk/client-dynamodb, @aws-sdk/lib-dynamodb, dynamodb-toolbox |
EncryptedMetadataManager from the installed integration SDK 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 BoxNCase apps using the installed integration SDK, you may want to check out the following resources: