[ { "path": ".all-contributorsrc", "content": "{\n \"projectName\": \"prisma-appsync\",\n \"projectOwner\": \"maoosi\",\n \"repoType\": \"github\",\n \"repoHost\": \"https://github.com\",\n \"files\": [\n \"README.md\"\n ],\n \"imageSize\": 100,\n \"commit\": true,\n \"types\": {\n \"creator\": {\n \"symbol\": \"πŸ™\",\n \"description\": \"Creator & maintainer\"\n }\n },\n \"contributors\": [\n {\n \"login\": \"maoosi\",\n \"name\": \"Sylvain\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/4679377?v=4\",\n \"profile\": \"https://sylvainsimao.fr\",\n \"contributions\": [\n \"creator\",\n \"code\",\n \"ideas\",\n \"doc\"\n ]\n },\n {\n \"login\": \"Tenrys\",\n \"name\": \"Bell\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/3979239?v=4\",\n \"profile\": \"http://bell.moe\",\n \"contributions\": [\n \"code\",\n \"ideas\"\n ]\n },\n {\n \"login\": \"cipriancaba\",\n \"name\": \"Ciprian Caba\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/695515?v=4\",\n \"profile\": \"http://www.cipriancaba.com\",\n \"contributions\": [\n \"code\",\n \"ideas\"\n ]\n },\n {\n \"login\": \"tomschut\",\n \"name\": \"Tom\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/4933446?v=4\",\n \"profile\": \"https://github.com/tomschut\",\n \"contributions\": [\n \"code\",\n \"ideas\"\n ]\n },\n {\n \"login\": \"ryparker\",\n \"name\": \"Ryan Parker\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/17558268?v=4\",\n \"profile\": \"http://ryanparker.dev\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"cjjenkinson\",\n \"name\": \"Cameron Jenkinson\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/5429478?v=4\",\n \"profile\": \"https://www.cameronjjenkinson.com\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"jeremy-white\",\n \"name\": \"jeremy-white\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/42325631?v=4\",\n \"profile\": \"https://github.com/jeremy-white\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"max-konin\",\n \"name\": \"Max Konin\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/1570356?v=4\",\n \"profile\": \"https://github.com/max-konin\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"michachan\",\n \"name\": \"Michael Chan\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/27760344?v=4\",\n \"profile\": \"https://github.com/michachan\",\n \"contributions\": [\n \"code\"\n ]\n },\n {\n \"login\": \"nhu-mai-101\",\n \"name\": \"Nhu Mai\",\n \"avatar_url\": \"https://avatars.githubusercontent.com/u/84061316?v=4\",\n \"profile\": \"https://www.linkedin.com/in/nhu-mai/\",\n \"contributions\": [\n \"code\"\n ]\n }\n ],\n \"commitConvention\": \"angular\",\n \"contributorsPerLine\": 7,\n \"commitType\": \"docs\"\n}\n" }, { "path": ".eslintrc", "content": "{\n \"root\": true,\n \"extends\": \"@antfu\",\n \"rules\": {\n \"jsonc/indent\": [\"error\", 4, {}],\n \"@typescript-eslint/indent\": [\n \"error\",\n 4,\n {\n \"offsetTernaryExpressions\": true,\n \"ignoredNodes\": [\"TemplateLiteral *\", \"TSTypeParameterInstantiation\"],\n \"SwitchCase\": 1\n }\n ],\n \"@typescript-eslint/consistent-type-definitions\": [\"error\", \"type\"]\n },\n \"globals\": {\n \"$\": true,\n \"chalk\": true,\n \"cd\": true,\n \"argv\": true,\n \"fs\": true,\n \"nothrow\": true\n }\n}\n" }, { "path": ".github/FUNDING.yml", "content": "github: [maoosi]\n" }, { "path": ".github/workflows/unit-tests.yml", "content": "name: Unit Tests\n\non:\n pull_request:\n branches: [main]\n\njobs:\n test:\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout repo\n uses: actions/checkout@v3\n\n - name: Install pnpm\n uses: pnpm/action-setup@v2.2.4\n with:\n version: 7\n\n - name: Use Node.js 16\n uses: actions/setup-node@v3\n with:\n node-version: 16\n cache: \"pnpm\"\n\n - name: Install global dependencies\n run: \"pnpm add -g zx\"\n\n - name: Install project dependencies\n run: \"pnpm install\"\n\n - name: Run tests\n run: \"pnpm run test\"\n" }, { "path": ".gitignore", "content": ".DS_Store\nnode_modules/\n*/**/node_modules/\n\n# Testing\ntests/prisma/generated/\nplayground/\ndebug/\n\n# Dist folder\ndist/\n\n# Docs\ndocs/.vitepress/dist/\ndocs/.vitepress/cache/\ntmp.md\n\n# Boilerplate files\npackages/boilerplate/cdk/*.lock\npackages/boilerplate/cdk/cdk.out\n\n# Log files\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n\n# Editor directories and files\n.idea\n*.suo\n*.ntvs*\n*.njsproj\n*.sln\n*.sw*\n" }, { "path": ".markdownlint.json", "content": "{\n \"default\": true,\n \"no-inline-html\": false,\n \"line-length\": false,\n \"no-trailing-punctuation\": false\n}\n" }, { "path": ".npmignore", "content": ".DS_Store\nnode_modules/\n*/**/node_modules/\n\n# Source files\npackages/\nbin/\ntests/\nplayground/\ndocs/\n.editorconfig\n.eslintrc\n.markdownlint.json\n.prettierignore\n.prettierrc.cjs\ntsconfig.json\n\n# Package cache files\npackage-*.json\npnpm-*.yaml\n\n# Log files\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n.pnpm-debug.log*\n\n# Workspace\npnpm-workspace.yaml\nvite.config.ts\n\n# Installer\ndist/installer\n\n# Editor directories and files\n.idea\n.vscode\n.github\n*.suo\n*.ntvs*\n*.njsproj\n*.sln\n*.sw*\n" }, { "path": ".vscode/extensions.json", "content": "{\n \"recommendations\": [\n \"dbaeumer.vscode-eslint\",\n \"johnpapa.vscode-peacock\"\n ]\n}\n" }, { "path": ".vscode/settings.json", "content": "{\n // Visuals\n \"peacock.color\": \"#1f08f6\",\n \"workbench.colorCustomizations\": {\n \"activityBar.activeBackground\": \"#4b38f9\",\n \"activityBar.activeBorder\": \"#f95745\",\n \"activityBar.background\": \"#4b38f9\",\n \"activityBar.foreground\": \"#e7e7e7\",\n \"activityBar.inactiveForeground\": \"#e7e7e799\",\n \"activityBarBadge.background\": \"#f95745\",\n \"activityBarBadge.foreground\": \"#15202b\",\n \"sash.hoverBorder\": \"#4b38f9\",\n \"statusBar.background\": \"#1f08f6\",\n \"statusBar.foreground\": \"#e7e7e7\",\n \"statusBarItem.hoverBackground\": \"#4b38f9\",\n \"statusBarItem.remoteBackground\": \"#1f08f6\",\n \"statusBarItem.remoteForeground\": \"#e7e7e7\",\n \"titleBar.activeBackground\": \"#1f08f6\",\n \"titleBar.activeForeground\": \"#e7e7e7\",\n \"titleBar.inactiveBackground\": \"#1f08f699\",\n \"titleBar.inactiveForeground\": \"#e7e7e799\",\n \"commandCenter.border\": \"#e7e7e799\"\n },\n\n // ESLint config\n \"eslint.codeAction.showDocumentation\": {\n \"enable\": true\n },\n \"eslint.probe\": [\n \"javascript\",\n \"typescript\",\n \"javascriptreact\",\n \"typescriptreact\",\n \"vue\",\n \"html\",\n \"markdown\",\n \"json\",\n \"jsonc\",\n \"json5\"\n ],\n \"prettier.enable\": false,\n\n // Editor\n \"editor.formatOnSave\": false,\n \"editor.accessibilitySupport\": \"off\",\n \"editor.cursorSmoothCaretAnimation\": \"on\",\n \"editor.find.addExtraSpaceOnTop\": false,\n \"editor.guides.bracketPairs\": \"active\",\n \"editor.inlineSuggest.enabled\": true,\n \"editor.lineNumbers\": \"interval\",\n \"editor.multiCursorModifier\": \"ctrlCmd\",\n \"editor.renderWhitespace\": \"boundary\",\n \"editor.suggestSelection\": \"first\",\n \"editor.tabSize\": 4,\n \"editor.unicodeHighlight.invisibleCharacters\": false,\n \"editor.codeActionsOnSave\": {\n \"source.fixAll\": \"never\",\n \"source.fixAll.eslint\": \"explicit\",\n \"source.organizeImports\": \"never\"\n },\n \"[markdown]\": {\n \"editor.formatOnSave\": false\n },\n \"[prisma]\": {\n \"editor.defaultFormatter\": \"Prisma.prisma\",\n \"editor.formatOnSave\": true\n },\n \"files.eol\": \"\\n\",\n \"typescript.tsdk\": \"node_modules/typescript/lib\",\n\n // Grammarly\n \"grammarly.selectors\": [\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/changelog/1.0.0-rc.1.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/contributing.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/essentials/concept.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/essentials/getting-started.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/advanced/securing-api.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/advanced/extending-api.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"README.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/advanced/hooks.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/changelog/1.0.0-rc.4.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/changelog/1.0.0-rc.5.md\"\n },\n {\n \"language\": \"markdown\",\n \"scheme\": \"file\",\n \"pattern\": \"docs/changelog/1.0.0-rc.6.md\"\n }\n ]\n}\n" }, { "path": "CHANGELOG.md", "content": "# Changelog\n\n[prisma-appsync.vercel.app/changelog/](https://prisma-appsync.vercel.app/changelog/)" }, { "path": "CONTRIBUTING.md", "content": "# Contributing\n\n[prisma-appsync.vercel.app/contributing.html](https://prisma-appsync.vercel.app/contributing.html)" }, { "path": "LICENSE.txt", "content": "BSD 2-Clause License\n\nCopyright (c) 2024, Sylvain Simao \nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." }, { "path": "README.md", "content": "

\n \"Prisma-AppSync\"\n

\n\n# Prisma-AppSync · [![TypeScript](https://img.shields.io/badge/-TypeScript-2D3748?logo=typescript&colorA=0096ff&logoColor=fff)](/packages/client/src/) [![AWS AppSync](https://img.shields.io/badge/-AWS%20AppSync-2D3748?logo=amazon-aws&colorA=EB5F05&logoColor=fff)](https://aws.amazon.com/appsync/) [![Prisma](https://img.shields.io/badge/-Prisma%20Generator-2D3748?logo=prisma&colorA=5B67D8&logoColor=fff)](https://www.prisma.io)\n\n**Prisma-AppSync** turns your [Prisma Schema](https://www.prisma.io) into a fully-featured GraphQL API, tailored for [AWS AppSync](https://aws.amazon.com/appsync/).\n\n## βœ”οΈ Features\n\nπŸ’Ž **Use your β—­ Prisma Schema**
Quickly define your data model and deploy a GraphQL API tailored for AWS AppSync.\n\n⚑️ **Auto-generated CRUD operations**
Using Prisma syntax, with a robust TS Client designed for AWS Lambda Resolvers.\n\nβ›‘ **Pre-configured security**
Built-in XSS protection, query depth limitation, and in-memory rate limiting.\n\nπŸ” **Fine-grained ACL and authorization**
Flexible security options such as API keys, IAM, Cognito, and more.\n\nπŸ”Œ **Fully extendable features**
Customize your GraphQL schema, API resolvers, and data flow as needed.\n\n## πŸš€ Getting started\n\nRun the following command and follow the prompts πŸ™‚\n\n```shell\nnpx create-prisma-appsync-app@latest\n```\n\n## πŸ““ Documentation\n\n[Read the documentation](https://prisma-appsync.vercel.app) to learn how to use Prisma-AppSync.\n\n## πŸ™ Contributors\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"Sylvain\"/
Sylvain
πŸ™ πŸ’» πŸ€” πŸ“–		\"Bell\"/
Bell
πŸ’» πŸ€”		\"Ciprian
Ciprian Caba
πŸ’» πŸ€”		\"Tom\"/
Tom
πŸ’» πŸ€”		\"Ryan
Ryan Parker
πŸ’»		\"Cameron
Cameron Jenkinson
πŸ’»		\"jeremy-white\"/
jeremy-white
πŸ’»
\"Max
Max Konin
πŸ’»		\"Michael
Michael Chan
πŸ’»		\"Nhu
Nhu Mai
πŸ’»
\n\n\n\n\n\n\nWanting to help? Get started with our [contribution guide](https://prisma-appsync.vercel.app/contributing.html) or consider [πŸ’› Github sponsors](https://github.com/sponsors/maoosi).\n\n## 🌟 Sponsors\n\n**Thanks go to these wonderful sponsors!**\n\n[![Kuizto β€” The Everyday Cooking App](https://prisma-appsync.vercel.app/sponsors/kuizto-banner.png \"Kuizto β€” The Everyday Cooking App\")](https://kuizto.co/?utm_source=prisma_appsync&utm_medium=github)\n\n[Kuizto.co](https://kuizto.co/?utm_source=prisma_appsync&utm_medium=github) is a cooking app that adds a unique twist to everyday cooking. Netflix-like feed to explore tailored recipes. Get inspired by others, save to cooklists, plan instantly!\n" }, { "path": "bin/build.mjs", "content": "#!/usr/bin/env zx\n/* eslint-disable no-console */\n/* eslint-disable n/prefer-global/process */\nimport './env.mjs'\n\ntry {\n // cleanup previous generated files\n console.log(chalk.blue('\\n🧹 [chore] cleanup\\n'))\n await $`rm -rf dist`.quiet()\n\n if (!argv?.ignoreGenerator) {\n console.log(chalk.blue('πŸ› οΈ [build] packages/generator'))\n\n // build Prisma-AppSync Generator\n await $`esbuild packages/generator/src/index.ts --bundle --format=cjs --keep-names --platform=node --target=node18 --external:fsevents --external:_http_common --outfile=dist/generator.js --define:import.meta.url='_importMetaUrl' --banner:js=\"const _importMetaUrl=require('url').pathToFileURL(__filename)\"`.quiet()\n }\n\n if (!argv?.ignoreClient) {\n console.log(chalk.blue('πŸ› οΈ [build] packages/client'))\n\n // build Prisma-AppSync Client\n await $`esbuild packages/client/src/index.ts --bundle '--define:process.env.NODE_ENV=\"production\"' --format=cjs --minify --keep-names --platform=node --target=node18 --external:fsevents --external:@prisma/client --outfile=dist/client/index.js --legal-comments=inline`.quiet()\n\n console.log(chalk.blue('πŸ› οΈ [build] packages/client types'))\n\n // build Prisma-AppSync Client TS Declarations\n await $`tsc packages/client/src/*.ts --outDir dist/client/ --declaration --emitDeclarationOnly --esModuleInterop --downlevelIteration`.nothrow().quiet()\n }\n\n if (!argv?.ignoreInstaller) {\n\n if (process.env.COMPILE_MODE === 'preview') {\n console.log(chalk.blue('πŸ› οΈ [build] packages/installer (preview mode)'))\n\n // build installer (preview mode)\n await $`esbuild packages/installer/src/index.ts --bundle '--define:process.env.NODE_ENV=\"production\"' '--define:process.env.COMPILE_MODE=\"preview\"' --format=cjs --minify --keep-names --platform=node --target=node18 --external:fsevents --external:_http_common --outfile=dist/installer/bin/index.js`.quiet()\n }\n else {\n console.log(chalk.blue('πŸ› οΈ [build] packages/installer'))\n\n // build installer (default)\n await $`esbuild packages/installer/src/index.ts --bundle '--define:process.env.NODE_ENV=\"production\"' --format=cjs --minify --keep-names --platform=node --target=node18 --external:fsevents --external:_http_common --outfile=dist/installer/bin/index.js`.quiet()\n }\n }\n\n if (!argv?.ignoreServer) {\n console.log(chalk.blue('πŸ› οΈ [build] packages/server'))\n\n // build server\n await $`esbuild packages/server/src/index.ts --bundle --format=cjs --minify --keep-names --platform=node --target=node18 --external:fsevents --external:@prisma/client --external:amplify-appsync-simulator --external:_http_common --outfile=dist/server/index.js`.quiet()\n\n // build server TS Declarations\n await $`cp packages/server/src/index.d.ts dist/server/index.d.ts && chmod -R 755 dist`.quiet()\n\n // copy server .vtl files into build folder\n await $`cp -R packages/server/src/*.vtl dist/server && chmod -R 755 dist`.quiet()\n }\n}\ncatch (error) {\n console.log(chalk.red(`🚨 [build] error\\n\\n${error}`))\n}\n" }, { "path": "bin/cleans.mjs", "content": "#!/usr/bin/env zx\nimport './env.mjs'\n\nconsole.log(chalk.blue('\\n🧹 [chore] deleting all `node_modules` folders\\n'))\nawait $`find . -name 'node_modules' -type d -prune -exec rm -rf '{}' +`\n\nconsole.log(chalk.blue('🧹 [chore] deleting all `dist` folders\\n'))\nawait $`find . -name 'dist' -type d -prune -exec rm -rf '{}' +`\n\nconsole.log(chalk.blue('🧹 [chore] deleting all `cdk.out` folders\\n'))\nawait $`find . -name 'cdk.out' -type d -prune -exec rm -rf '{}' +`\n\nconsole.log(chalk.blue('🧹 [chore] deleting all `generated` folders\\n'))\nawait $`find . -name 'generated' -type d -prune -exec rm -rf '{}' +`\n\nconsole.log(chalk.blue('🧹 [chore] deleting all `yarn.lock` files\\n'))\nawait $`find . -name 'yarn.lock' -type f -prune -exec rm -rf '{}' +`\n\nconsole.log(chalk.blue('🧹 [chore] deleting all `pnpm-lock.yaml` files\\n'))\nawait $`find . -name 'pnpm-lock.yaml' -type f -prune -exec rm -rf '{}' +`\n\nconsole.log(chalk.blue('\\nπŸ“¦ [install] re-installing all dependencies\\n'))\nawait $`pnpm install`\n" }, { "path": "bin/dev.mjs", "content": "#!/usr/bin/env zx\nimport './env.mjs'\n\n// path\nconst playgroundPath = 'playground'\n\n// reset\nif (argv?.reset) {\n console.log(chalk.blue('\\nπŸ’» [dev] reset `playground` dir'))\n await fs.remove(playgroundPath)\n}\n\n// build project\nawait $`zx bin/build.mjs`\n\n// install\nconst playgroundExists = await fs.pathExists(playgroundPath)\nconsole.log('')\n\nif (!playgroundExists) {\n console.log(chalk.blue('πŸ’» [dev] create `playground` dir'))\n await fs.ensureDir(playgroundPath)\n\n console.log(chalk.blue('πŸ’» [dev] run installer'))\n cd(playgroundPath)\n process.env.INSTALL_MODE = 'contributor'\n await $`node ../dist/installer/bin/index.js`\n}\nelse {\n console.log(chalk.blue('πŸ’» [dev] run prisma generate\\n'))\n cd(playgroundPath)\n await $`npx prisma generate`\n}\n\n// start dev server\nconsole.log(chalk.blue('πŸ’» [dev] start dev server\\n'))\nawait $`yarn dev`\n" }, { "path": "bin/env.mjs", "content": "#!/usr/bin/env zx\n\nprocess.env.FORCE_COLOR = 3\n" }, { "path": "bin/postinstall.mjs", "content": "#!/usr/bin/env zx\nimport './env.mjs'\n\n// set DATABASE_URL env variable to docker instance\nprocess.env.DATABASE_URL = 'postgresql://prisma:prisma@localhost:5433/tests'\n\n// install boilerplate dependencies using Yarn\nconsole.log(chalk.blue('\\nπŸ“¦ [post-install] install cdk boilerplate dependencies\\n'))\nawait $`cd packages/boilerplate/cdk && yarn install`\n" }, { "path": "bin/publish/_pkg.core.cleanse.js", "content": "const fs = require('fs')\nconst path = require('path')\n\n// Define absolute paths for original pkg and temporary pkg.\nconst ORIG_PKG_PATH = path.resolve(__dirname, '../../package.json')\nconst BACKUP_PKG_PATH = path.resolve(__dirname, '../../package-beforePublish.json')\nconst RESTORE_PKG_PATH = path.resolve(__dirname, '../../package-afterPublish.json')\n\n// Obtain original `package.json` contents.\nconst pkgData = require(ORIG_PKG_PATH)\n\n// Write/cache the original `package.json` data to `package-beforePublish.json` file.\nfs.writeFile(BACKUP_PKG_PATH, JSON.stringify(pkgData, null, 4), (err) => {\n if (err)\n throw err\n})\n\n// Write/cache the original `package.json` data to `package-afterPublish.json` file.\nfs.writeFile(RESTORE_PKG_PATH, JSON.stringify(pkgData, null, 4), (err) => {\n if (err)\n throw err\n})\n\n// Remove all scripts from the scripts section.\ndelete pkgData.scripts\n\n// Remove all pkgs from the devDependencies section.\ndelete pkgData.devDependencies\n\n// Remove pnpm engine\ndelete pkgData.engines.pnpm\n\n// Overwrite original `package.json` with new data (i.e. minus the specific data).\nfs.writeFile(ORIG_PKG_PATH, JSON.stringify(pkgData, null, 4), (err) => {\n if (err)\n throw err\n})\n" }, { "path": "bin/publish/_pkg.core.restore.js", "content": "const fs = require('fs')\nconst path = require('path')\n\n// Define absolute paths for original pkg and temporary pkg.\nconst ORIG_PKG_PATH = path.resolve(__dirname, '../../package.json')\nconst BACKUP_PKG_PATH = path.resolve(__dirname, '../../package-beforePublish.json')\nconst RESTORE_PKG_PATH = path.resolve(__dirname, '../../package-afterPublish.json')\n\n// Obtain original/cached contents (with new version) from `package-afterPublish`.\nconst pkgData = `${JSON.stringify(require(RESTORE_PKG_PATH), null, 4)}\\n`\n\n// Write data from `package-afterPublish` back to original `package.json`.\nfs.writeFile(ORIG_PKG_PATH, pkgData, (err) => {\n if (err)\n throw err\n})\n\n// Delete the temporary `package-beforePublish` file.\nfs.unlink(BACKUP_PKG_PATH, (err) => {\n if (err)\n throw err\n})\n\n// Delete the temporary `package-afterPublish` file.\nfs.unlink(RESTORE_PKG_PATH, (err) => {\n if (err)\n throw err\n})\n" }, { "path": "bin/publish/_pkg.installer.cleanse.js", "content": "const fs = require('fs')\nconst path = require('path')\n\n// Define absolute paths for original pkg and temporary pkg.\nconst SRC_PKG_PATH = path.resolve(__dirname, '../../packages/installer/package.json')\nconst DEST_PKG_PATH = path.resolve(__dirname, '../../dist/installer/package.json')\n\n// Obtain original `package.json` contents.\nconst pkgData = require(SRC_PKG_PATH)\n\n// Remove all scripts from the scripts section.\ndelete pkgData.scripts\n\n// Remove all pkgs from the dependencies section.\ndelete pkgData.dependencies\n\n// Remove all pkgs from the devDependencies section.\ndelete pkgData.devDependencies\n\n// Remove private tag\ndelete pkgData.private\n\n// Create new `package.json` with new data (i.e. minus the specific data).\nfs.writeFile(DEST_PKG_PATH, JSON.stringify(pkgData, null, 4), (err) => {\n if (err)\n throw err\n})\n" }, { "path": "bin/publish.mjs", "content": "#!/usr/bin/env zx\n/* eslint-disable @typescript-eslint/no-unused-vars */\n\nimport Listr from 'listr'\nimport prompts from 'prompts'\n\nawait $`zx bin/env.mjs`\n\n$.verbose = false\n\nasync function getPublishConfig() {\n const { tag } = await prompts({\n type: 'select',\n name: 'tag',\n message: 'Select publish tag',\n choices: [\n { title: 'preview', value: 'preview' },\n { title: 'latest', value: 'latest' },\n ],\n initial: 0,\n })\n\n if (!tag)\n process.exit()\n\n let latestPublished = '0.0.9'\n\n try {\n latestPublished = String(await $`npm show prisma-appsync@${tag} version`)?.trim()\n }\n catch (err) {\n try { latestPublished = String(await $`npm show prisma-appsync version`)?.trim() }\n catch (err) {}\n }\n\n const minorPos = latestPublished.lastIndexOf('.')\n\n const possibleFutureVersion = `${latestPublished.slice(0, minorPos)}.${\n parseInt(latestPublished.slice(minorPos + 1)) + 1\n }`\n\n const { publishVersion } = await prompts({\n type: 'text',\n name: 'publishVersion',\n message: `Enter new version for @${tag}? (latest = \"${latestPublished}\")`,\n initial: possibleFutureVersion,\n })\n\n if (!publishVersion || publishVersion === latestPublished)\n process.exit()\n\n const { versionOk } = await prompts({\n type: 'confirm',\n name: 'versionOk',\n message: `Run \"pnpm publish --tag ${tag} --no-git-checks\" with pkg version \"${publishVersion}\"?`,\n initial: false,\n })\n\n return {\n versionOk,\n publishVersion,\n tag,\n }\n}\n\nasync function publishCore({ tag }) {\n console.log('Publishing Core...')\n\n await new Listr([\n {\n title: 'Cleansing package.json',\n task: async () => {\n await $`node bin/publish/_pkg.core.cleanse`\n },\n },\n {\n title: `Publishing on NPM with tag ${tag}`,\n task: async () => await $`pnpm publish --tag ${tag} --no-git-checks`,\n },\n {\n title: 'Restoring package.json',\n task: async () => await $`node bin/publish/_pkg.core.restore`,\n },\n ]).run().catch((err) => {\n console.error(err)\n })\n}\n\nasync function publishInstaller({ tag }) {\n console.log('Publishing Installer...')\n\n await new Listr([\n {\n title: 'Copy + Cleanse package.json',\n task: async () => await $`node bin/publish/_pkg.installer.cleanse`,\n },\n {\n title: 'Publishing on NPM',\n task: async () => await $`cd ./dist/installer/ && pnpm publish --tag ${tag} --no-git-checks`,\n },\n ]).run().catch((err) => {\n console.error(err)\n })\n}\n\nconst publishConfig = await getPublishConfig()\n\nif (publishConfig.versionOk) {\n const corePkgFile = './package.json'\n const installerPkgFile = './packages/installer/package.json'\n\n // change package.json versions\n console.log(`\\nSetting publish version to ${publishConfig.publishVersion}...`)\n const corePkg = await fs.readJson(corePkgFile)\n const installerPkg = await fs.readJson(installerPkgFile)\n corePkg.version = publishConfig.publishVersion\n installerPkg.version = publishConfig.publishVersion\n await fs.writeJson(corePkgFile, corePkg, { spaces: 4 })\n await fs.writeJson(installerPkgFile, installerPkg, { spaces: 4 })\n\n // preview?\n if (publishConfig.tag === 'preview')\n process.env.COMPILE_MODE = \"preview\"\n\n // build + test\n console.log('Building + Testing...')\n await $`zx bin/test.mjs`\n\n // publish packages\n await publishCore(publishConfig)\n await publishInstaller(publishConfig)\n console.log('Done!')\n}\n" }, { "path": "bin/test.mjs", "content": "#!/usr/bin/env zx\n/* eslint-disable no-console */\nimport './env.mjs'\n\n// build\nawait $`zx bin/build.mjs`\n\n// prisma client for tests\nconsole.log(chalk.blue('\\nπŸ§ͺ [test] run prisma generate'))\nawait $`npx prisma generate --schema tests/generator/schemas/crud.prisma`\nawait $`npx prisma generate --schema tests/generator/schemas/@gql.prisma`\n\n// unit tests\nconsole.log(chalk.blue('πŸ§ͺ [test] run unit tests\\n'))\nawait $`VITE_CJS_IGNORE_WARNING=true vitest run tests`\n" }, { "path": "docs/.vitepress/config.ts", "content": "export default {\n title: 'Prisma-AppSync',\n description: 'GraphQL API Generator for AWS and β—­ Prisma',\n\n head: [['link', { rel: 'icon', type: 'image/svg+xml', href: '/logo.svg' }]],\n\n vue: {\n reactivityTransform: true,\n },\n\n lastUpdated: true,\n\n themeConfig: {\n logo: '/logo.svg',\n\n editLink: {\n text: 'Suggest changes to this page',\n pattern: 'https://github.com/maoosi/prisma-appsync/edit/main/docs/:path',\n },\n\n socialLinks: [{ icon: 'github', link: 'https://github.com/maoosi/prisma-appsync' }],\n\n lastUpdatedText: 'Updated Date',\n\n footer: {\n message: 'Released under the BSD 2-Clause License.',\n copyright: 'Copyright Β© 2021-present Sylvain Simao',\n },\n\n nav: [\n { text: 'Documentation', link: '/quick-start/getting-started' },\n { text: 'Changelog', link: '/changelog/1.0.0' },\n { text: 'Support', link: '/support' },\n {\n text: 'Tools',\n items: [\n {\n text: 'AppSync GraphQL Schema Diff',\n link: '/tools/appsync-gql-schema-diff',\n },\n ],\n },\n {\n text: 'Links',\n items: [\n {\n text: 'Report a bug',\n link: 'https://github.com/maoosi/prisma-appsync/issues',\n },\n {\n text: 'Sponsor',\n link: 'https://github.com/sponsors/maoosi',\n },\n {\n text: 'Roadmap',\n link: 'https://github.com/users/maoosi/projects/1',\n },\n ],\n },\n ],\n\n sidebar: [\n {\n text: 'Quick start',\n items: [\n { text: 'Getting started', link: '/quick-start/getting-started' },\n { text: 'Installation', link: '/quick-start/installation' },\n { text: 'Usage', link: '/quick-start/usage' },\n { text: 'Deploy', link: '/quick-start/deploy' },\n ],\n },\n {\n text: 'Features',\n collapsible: true,\n items: [\n { text: 'Lifecycle hooks', link: '/features/hooks' },\n { text: 'Custom resolvers', link: '/features/resolvers' },\n { text: 'Tweaking GQL schema', link: '/features/gql-schema' },\n ],\n },\n {\n text: 'Security',\n collapsible: true,\n items: [\n { text: 'Authorization', link: '/security/appsync-authz' },\n { text: 'Shield (ACL rules)', link: '/security/shield-acl' },\n { text: 'XSS sanitizer', link: '/security/xss-sanitizer' },\n { text: 'Query depth', link: '/security/query-depth' },\n { text: 'Rate limiter (DOS)', link: '/security/rate-limiter' },\n ],\n },\n {\n text: 'Contributing',\n collapsible: true,\n items: [\n { text: 'Contributions guide', link: '/contributing' },\n ],\n },\n {\n text: 'Changelog',\n collapsible: true,\n collapsed: true,\n items: [\n { text: '(latest) v1.0.0', link: '/changelog/1.0.0' },\n { text: 'Previous', link: '/changelog/' },\n ],\n },\n ],\n },\n}" }, { "path": "docs/.vitepress/theme/Layout.vue", "content": "\n\n\n\n" }, { "path": "docs/.vitepress/theme/index.ts", "content": "import Theme from 'vitepress/theme'\nimport Layout from './Layout.vue'\nimport './styles/vars.css'\n\nexport default {\n extends: Theme,\n Layout: Layout\n}\n" }, { "path": "docs/.vitepress/theme/styles/vars.css", "content": "/**\n * Colors\n * -------------------------------------------------------------------------- */\n\n:root {\n --vp-c-brand: #5379f4;\n --vp-c-brand-light: #747bff;\n --vp-c-brand-lighter: #9499ff;\n --vp-c-brand-dark: #535bf2;\n --vp-c-brand-darker: #454ce1;\n}\n\n/**\n * Component: Button\n * -------------------------------------------------------------------------- */\n\n:root {\n --vp-button-brand-border: var(--vp-c-brand-light);\n --vp-button-brand-text: var(--vp-c-text-dark-1);\n --vp-button-brand-bg: var(--vp-c-brand);\n --vp-button-brand-hover-border: var(--vp-c-brand-light);\n --vp-button-brand-hover-text: var(--vp-c-text-dark-1);\n --vp-button-brand-hover-bg: var(--vp-c-brand-light);\n --vp-button-brand-active-border: var(--vp-c-brand-light);\n --vp-button-brand-active-text: var(--vp-c-text-dark-1);\n --vp-button-brand-active-bg: var(--vp-button-brand-bg);\n}\n\n/**\n * Component: Home\n * -------------------------------------------------------------------------- */\n\n:root {\n --vp-home-hero-name-color: transparent;\n --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #5379f4 30%, #f59533);\n}\n\n/**\n * Component: Algolia\n * -------------------------------------------------------------------------- */\n\n.DocSearch {\n --docsearch-primary-color: var(--vp-c-brand) !important;\n}\n" }, { "path": "docs/changelog/1.0.0-rc.1.md", "content": "---\neditLink: false\n---\n\n# 1.0.0-rc.1\n\n::: warning BREAKING\n🚨 This release comes with a **major rewrite of the Prisma-AppSync Client API and breaking changes**. Please make sure to take a moment and read through the details below before upgrading.\n:::\n\n## Highlights\n\n- **Codebase rewrite**: Prisma-AppSync was rewritten from the ground to offer a simplified API with a more opinionated approach, end-to-end type safety for a better DX, advanced customisation options, as well as improved security and fine-grained access control.\n- **Installer CLI**: New interactive scaffolding CLI to quickly start new Prisma-AppSync projects, accessible from a single `npx create-prisma-appsync-app@latest` command. It can also plug into existing projects already using Prisma.\n- **Local AppSync Server**: New local development environment built for Prisma-AppSync (local database, auto-reload, TS support, GraphQL IDE). Iterate faster by simulating a GraphQL API running on AWS AppSync from your local machine.\n- **Documentation website**: New documentation website and contribution guide, built upon VitePress, and accessible from [prisma-appsync.vercel.app](https://prisma-appsync.vercel.app).\n- **Lots of improvements**: Implemented dozens of improvements, bug fixes and new Prisma features (atomic operations, order by relations, case sensitivity, etc).\n\n## πŸͺ“Β Breaking changes\n\n::: details Prisma-AppSync Client usage\n`BREAKING`Usage is simplified by adopting a more opinionated approach. Also provides a better TypeScript DX closer to Prisma Client.\n- Fine-gained access control and hooks have been re-engineered entirely to make them easier to use and more flexible for all project sizes.\n- Adopted a full TDD approach with both unit and integration tests. This is to help bring Prisma-AppSync to a stable version quicker.\n\n**Before:**\n\n```ts\n// init prisma-appsync client\nconst app = new PrismaAppSync({\n connectionUrl: process.env.CONNECTION_URL\n})\n\n// direct lambda resolver for appsync\nexport const main = async (event) => {\n // parse the `event` from your Lambda function\n app.parseEvent(event)\n\n // handle CRUD operations / resolve query\n const result = await app.resolve()\n\n // close database connection\n await app.prisma.$disconnect()\n\n // return query result\n return Promise.resolve(result)\n}\n```\n\n**After:**\n\n```ts\nconst prismaAppSync = new PrismaAppSync()\n\n// direct lambda resolver for appsync\nexport const resolver = async (event) => {\n return await prismaAppSync.resolve({ event })\n}\n```\n\n:::\n\n::: details Prisma-AppSync Client options\n\n`BREAKING`\n\n- `connectionUrl` parameter renamed into `connectionString`. This parameter is optional and leverages Prisma Client naming convention and defaults.\n- `debug` parameter renamed into `logLevel`. This parameter is optional and allows specify server logging levels.\n- New `maxDepth` parameter that improves security and prevents clients from abusing query depth. Defaults to `3`.\n- New `maxReqPerUserMinute` parameter that provides in-memory rate-limiting and prevents common DDoS attacks. Defaults to `200`.\n\n```ts\nconst prismaAppSync = new PrismaAppSync({\n // optional, DB connection string, default to env var `DATABASE_URL`\n connectionString,\n // optional, enable data sanitizer for DB storage (incl. XSS parser), default to true\n sanitize,\n // optional, specify server logging level (`INFO`, `WARN`, `ERROR`), default to `INFO`\n logLevel,\n // optional, pagination for listQueries, default to 50\n defaultPagination,\n // optional, allowed graphql query depth, default to 3\n maxDepth,\n // optional, per user, in-memory rate limiting, default to 200\n maxReqPerUserMinute\n})\n```\n\n:::\n\n::: details Custom Resolvers API\n\n`BREAKING`\n\n**Before:**\n\n```ts\napp.registerCustomResolvers({\n notify: async ({ args }: CustomResolverProps) => {\n return {\n message: `${args.message} from notify`\n }\n }\n})\n```\n\n**After:**\n\n```ts\nreturn await prismaAppSync.resolve<'notify'>({\n event,\n resolvers: {\n notify: async ({ args }: QueryParams) => {\n return {\n message: `${args.message} from notify`,\n }\n },\n }\n})\n```\n\n:::\n\n::: details Hooks before/after API\n\n`BREAKING`\n\n**Before:**\n\n```ts\n// execute before resolve\napp.beforeResolve(async (props) => {})\n\n// execute after resolve\napp.afterResolve(async (props) => {})\n```\n\n**After:**\n\n```ts\nreturn await prismaAppSync.resolve<'likePost'>({\n event,\n hooks: {\n // execute before any query\n 'before:**': async (params: BeforeHookParams) => params,\n\n // execute after any query\n 'after:**': async (params: AfterHookParams) => params,\n\n // execute after custom resolver query `likePost`\n // (e.g. `query { likePost(postId: 3) }`)\n 'after:likePost': async (params: AfterHookParams) => {\n await params.prismaClient.notification.create({\n data: {\n event: 'POST_LIKED',\n targetId: params.args.postId,\n userId: params.authIdentity.sub,\n },\n })\n return params\n },\n },\n})\n```\n\n:::\n\n::: details Fine-Grained Access Control API\n\n`BREAKING`\n\n**Before:**\n\n```ts\n// before resolving any query\napp.beforeResolve(async ({ authIdentity }: BeforeResolveProps) => {\n // rules only apply to Cognito authorization type\n if (authIdentity.authorization !== AuthModes.AMAZON_COGNITO_USER_POOLS)\n return false\n\n // get current user from database, using Prisma\n // we only need to know the user ID\n const currentUser = await prisma.user.findUnique({\n select: { id: true },\n where: { cognitoSub: authIdentity.sub }\n }) || { id: null }\n\n // everyone can access (get + list) or create Posts\n app.allow({ action: AuthActions.access, subject: 'Post' })\n app.allow({ action: AuthActions.create, subject: 'Post' })\n\n // only the author is allowed to modify a given Post\n app.deny({\n action: AuthActions.modify,\n subject: 'Post',\n // IF `Post.ownerId` NOT_EQUAL_TO `currentUser.id` THEN DENY_QUERY\n condition: { ownerId: { $ne: currentUser.id } }\n })\n})\n```\n\n**After:**\n\n```ts\nreturn await prismaAppSync.resolve({\n event,\n shield: ({ authorization, identity }: QueryParams) => {\n const isCognitoAuth = authorization === Authorizations.AMAZON_COGNITO_USER_POOLS\n const isOwner = { owner: { cognitoSub: identity?.sub } } // Prisma syntax\n\n return {\n '**': {\n rule: isCognitoAuth,\n reason: ({ model }) => `${model} access is restricted to logged-in users.`,\n },\n '{update,upsert,delete}Post{,/**}': {\n rule: isOwner,\n reason: ({ model }) => `${model} can only be modified by their owner.`,\n },\n }\n },\n})\n```\n\n:::\n\n::: details Prisma-AppSync Generator options\n\n`BREAKING`\n\n- `customSchema` parameter renamed into `extendSchema`.\n- `customResolvers` parameter renamed into `extendResolvers`.\n- new parameter `defaultDirective`, to globally apply default directives.\n\n```ts\ngenerator appsync {\n provider = \"prisma-appsync\"\n\n // optional params\n output = \"./generated/prisma-appsync\"\n extendSchema = \"./custom-schema.gql\"\n extendResolvers = \"./custom-resolvers.yaml\"\n defaultDirective = \"@auth(model: [{ allow: apiKey }])\"\n}\n```\n\n:::\n\n::: details AppSync Authorizations modes\n\n`BREAKING`\n\n**Before:**\n\n```json\n/// @PrismaAppSync.type: '@aws_api_key @aws_cognito_user_pools(cognito_groups: [\\\"admins\\\"])'\nmodel Post {\n id Int @id @default(autoincrement())\n title String\n}\n```\n\n**After:**\n\n```json\n/// @auth(model: [{ allow: apiKey }, { allow: userPools, groups: [\"admins\"] }])\nmodel Post {\n id Int @id @default(autoincrement())\n title String\n}\n```\n\nπŸ‘†Β Output: `@aws_api_key @aws_cognito_user_pools(cognito_groups: [\"admins\"])`\n:::\n\n::: details Data sanitizer behaviour\n\n`BREAKING`\n\nEnabling the data sanitizer will now automatically \"clarify/decode\" the data before sending it back to the client. Meaning client-side decoding is not anymore necessary, while your data will still be parsed for XSS before storage.\n:::\n\n::: details Auto-generated documentation\n\n`BREAKING`\n\nTo reduce the maintenance burden, auto-generated API docs have been removed from Prisma-AppSync in favour of a better description of the data (accessible via the native GraphQL documentation from your favourite GraphQL IDE).\n\nIn case this is problematic for you and you’d like auto-generated docs to make a comes back, please consider [supporting the project](https://github.com/sponsors/maoosi) and [opening a new issue](https://github.com/maoosi/prisma-appsync/issues).\n:::\n\n## πŸŽ‰Β New features\n\n::: details New documentation website\n\n`NEW FEATURE`\n\nAccessible from [prisma-appsync.vercel.app](https://prisma-appsync.vercel.app).\n\n:::\n\n::: details New installer (scaffolding tool)\n\n`NEW FEATURE`\n\nNew installer that can be run via `npx create-prisma-appsync-app@latest`. Nicely plug with existing Prisma projects (non-destroying), while also allowing scaffolding of new projects from scratch.\n\n```bash\n ___ _ _ __\n / _ \\_ __(β—­)___ _ __ ___ __ _ /_\\ _ __ _ __ / _\\_ _ _ __ ___\n / /β—­)/ '__| / __| '_ ` _ \\ / _` |_____ //β—­\\\\| '_ \\| '_ \\\\ \\| | | | '_ \\ / __|\n / ___/| | | \\__ \\ | | | | | (β—­| |_____/ _ \\ |β—­) | |β—­) |\\ \\ |_| | | | | (__\n \\/ |_| |_|___/_| |_| |_|\\__,_| \\_/ \\_/ .__/| .__/\\__/\\__, |_| |_|\\___|\n |_| |_| |___/\n β—­ Prisma-AppSync Installer v1.0.0\n```\n\n:::\n\n::: details Local development environment built for Prisma-AppSync\n\n`NEW FEATURE`\n\nNew local development environment built for Prisma-AppSync (local database, auto-reload, TS support, GraphQL IDE). Simulate a GraphQL API running on AWS AppSync + AWS Lambda Resolver + Prisma ORM + Database.\n\n:::\n\n::: details Support added for Prisma 4.5.x\n\n`NEW FEATURE`\n\nCodebase adapted and fully tested for Prisma 4.5.x support.\n\n:::\n\n::: details Customise GraphQL Schema output\n\n`NEW FEATURE`\n\n```json\n/// @gql(queries: { list: 'posts' }, subscriptions: null)\nmodel Post {\n id Int @id @default(autoincrement())\n title String\n}\n```\n\nπŸ‘†Β Output: Default `listPosts` query renamed to `posts` / No subscriptions for the Post model\n:::\n\n::: details Support for Atomic Operations\n\n`NEW FEATURE`\n\n```graphql\nmutation {\n updatePost(\n where: { id: 1 }, \n operation: { \n views: { increment: 1 }\n }\n ) {\n views\n }\n}\n```\n\n:::\n\n::: details Support for order by relational fields\n\n`NEW FEATURE`\n\n```graphql\nquery {\n listPosts(\n orderBy: {\n author: {\n name: ASC\n }\n }\n ) {\n title\n author {\n name\n }\n }\n}\n```\n\n:::\n\n::: details Support for Case Sensitivity (PostgreSQL and MongoDB connectors only)\n\n`NEW FEATURE`\n\n```graphql\nquery {\n listPosts(\n where: {\n title: {\n contains: \"prisma\",\n mode: \"insensitive\"\n }\n }\n ) {\n title\n }\n}\n```\n\n:::\n\n::: details CDK boilerplate upgraded to v2+\n\n`IMPROVEMENT`\n\nCDK boilerplate was entirely rewritten to offer a more easy-to-use, simpler syntax making it more approachable for people who are new to AWS CDK.\n:::\n\n::: details TypeScript types improved for better DX\n\n`IMPROVEMENT`\n\nHovering on Prisma-AppSync types and Client API methods using VSCode is now displaying docs and examples across the entire codebase.\n:::\n\n::: details Bundle size and performances\n\n`IMPROVEMENT`\n\nNoticeable gains in bundle size and runtime performances. Lots of dependencies were removed from the previous version, in favour of custom utils functions.\n:::\n\n::: details Errors handling and server logs improved\n\n`IMPROVEMENT`\n\nBoth error handling and server logs (accessible from CloudWatch) have been improved to include more details and be easily readable.\n\n```ts\n// Example object returned from the API\n{\n\t\"error\": \"Query has depth of 4, which exceeds max depth of 3.\",\n\t\"type\": \"FORBIDDEN\",\n\t\"code\": 401\n}\n\n// Error codes\nconst errorCodes = {\n FORBIDDEN: 401,\n BAD_USER_INPUT: 400,\n INTERNAL_SERVER_ERROR: 500,\n TOO_MANY_REQUESTS: 429,\n}\n```\n\n:::\n\n## 🐞 Bug fixes\n\n::: details Added support for uniqueIndexes (πŸ™ contribution from [@cipriancaba](https://github.com/cipriancaba))\nπŸ™Β [Issue #46](https://github.com/maoosi/prisma-appsync/issues/46) /[PR #47](https://github.com/maoosi/prisma-appsync/pull/47): Prisma is no longer providing idFields\n:::\n\n::: details Fixed casing issue on GraphQL relation fields (πŸ™ contribution from [@ryparker](https://github.com/ryparker))\nπŸ™Β [Issue #37](https://github.com/maoosi/prisma-appsync/issues/37) / [PR #38](https://github.com/maoosi/prisma-appsync/pull/38): Generated GraphQL schema relation definitions using the incorrect case for type values\n:::\n\n::: details Fixed issue on nullable relation fields in mutations\nπŸ™Β [Issue #26](https://github.com/maoosi/prisma-appsync/issues/26): Issue using nullable relation fields with mutations\n:::\n\n::: details Replaced env var JEST_WORKER_ID with PRISMA_APPSYNC_TESTING\nπŸ™Β [Issue #32](https://github.com/maoosi/prisma-appsync/issues/32): Issue performing tests because of JEST_WORKER_ID\n:::\n\n## πŸ’›Β Github Sponsors\n\nEnjoy using Prisma-AppSync? Please consider sponsoring me at πŸ™Β [maoosi β†—](https://github.com/sponsors/maoosi) so that I can spend more time working on the project.\n" }, { "path": "docs/changelog/1.0.0-rc.2.md", "content": "---\neditLink: false\n---\n\n# 1.0.0-rc.2\n\n**🌟 Help us spread the word about Prisma-AppSync by starring the repo.**\n\n## Major improvements\n\n### Support for Prisma Fluent API syntax on Relation Filters\n\n> 🚨 Breaking change affecting syntax for Relation Filters.\n\nIn this release, we are changing how to write relation filters. We are replacing the [original Prisma Client syntax](https://www.prisma.io/docs/concepts/components/prisma-client/relation-queries#filter-on--to-one-relations) (using `is` and `isNot` filters) with the newest [Fluent API syntax](https://www.prisma.io/docs/concepts/components/prisma-client/relation-queries#fluent-api) which feels more natural to write, but also allows using more complex Relation Filters such as `contains`, `endsWith`, `equals`, `gt`, `gte`, `lt`, `lte`, `in`, `not`, `notIn` and `startsWith`.\n\n**Before**\n\n```graphql\nquery {\n listPosts(\n where: {\n author: { is: { username: \"xxx\" } }\n }\n ) {\n title\n author { username }\n }\n}\n```\n\n**After**\n\n```graphql\nquery {\n listPosts(\n where: {\n author: { username: { equals: \"xxx\" } }\n }\n ) {\n title\n author { username }\n }\n}\n```\n\n### Improved readability for underlying Prisma client errors\n\nIn this release, we have improved readability for all [known errors](https://www.prisma.io/docs/reference/api-reference/error-reference) thrown by the underlying Prisma Client. For example, using an incorrect connection URL (`DATABASE_URL`) will now return the below message as part of the API response:\n\n> Error with Prisma client initialization. https://www.prisma.io/docs/reference/api-reference/error-reference#prismaclientinitializationerror\n\nThe full error trace will still appear inside the terminal and/or CloudWatch logs.\n\n### New documentation guide: \"Adding Hooks\"\n\nIn this release, we have added a new guide on \"Adding Hooks\". Particularly useful to trigger actions and/or manipulate data `before` or `after` queries.\n\nhttps://prisma-appsync.vercel.app/advanced/hooks.html\n\n**Example snippet:**\n\n```tsx\nreturn await prismaAppSync.resolve<'likePost'>({\n event,\n hooks: {\n // execute before any query\n 'before:**': async (params: BeforeHookParams) => params,\n\n // execute after any query\n 'after:**': async (params: AfterHookParams) => params,\n\n // execute after custom resolver query `likePost`\n // (e.g. `query { likePost(postId: 3) }`)\n 'after:likePost': async (params: AfterHookParams) => {\n await params.prismaClient.notification.create({\n data: {\n event: 'POST_LIKED',\n targetId: params.args.postId,\n userId: params.authIdentity.sub,\n },\n })\n return params\n },\n },\n})\n```\n\n## Fixes\n\n- [Issue using the `@aws_auth` directive along with additional authorization modes.](https://github.com/maoosi/prisma-appsync/pull/52)\n- [Issue with `before` and `after` hook responses.](https://github.com/maoosi/prisma-appsync/pull/54)\n\n## Credits\n\n\n \n \n \n \n \n \n
\"Sylvain\"/
Sylvain
πŸ§™β€β™‚οΈ πŸ’» πŸ€” πŸ“–		\"Ciprian
Ciprian Caba
πŸ’» πŸ€”
\n\n## Github sponsors\n\nEnjoy using Prisma-AppSync? Please consider [πŸ’› Github sponsors](https://github.com/sponsors/maoosi).\n" }, { "path": "docs/changelog/1.0.0-rc.3.md", "content": "---\neditLink: false\n---\n\n# 1.0.0-rc.3\n\n**🌟 Help us spread the word about Prisma-AppSync by starring the repo.**\n\n## Fixes\n\n- [Issue with Queries returning a single parameter (such as `count` queries)](https://github.com/maoosi/prisma-appsync/issues/61)\n- [Issue with generated GraphQL input `CreateInput` when using `@default(uuid())` inside Prisma Schema](https://github.com/maoosi/prisma-appsync/issues/62)\n\n## Credits\n\n\n \n \n \n \n \n
\"Sylvain\"/
Sylvain
πŸ§™β€β™‚οΈ πŸ’» πŸ€” πŸ“–
\n\n## Github sponsors\n\nEnjoy using Prisma-AppSync? Please consider [πŸ’› Github sponsors](https://github.com/sponsors/maoosi).\n" }, { "path": "docs/changelog/1.0.0-rc.4.md", "content": "---\neditLink: false\n---\n\n# 1.0.0-rc.4\n\n**🌟 Help us spread the word about Prisma-AppSync by starring the repo.**\n\n## Highlights\n\n### ⚑️ Local dev server is now using `vite-node` instead of `ts-node-dev`\n\nDue to some incompatibilities between `ts-node-dev` and some of the newest changes, Vite is now used as the underlying Node runtime for the Prisma-AppSync local dev server.\n\nTo migrate an existing project using the local dev server, you'll need to edit the `dev` script inside your `package.json` and replace the following part:\n\n```shell\nnpx ts-node-dev --rs --transpile-only --watch './*.ts' -- ./server.ts\n```\n\nwith:\n\n```shell\nnpx vite-node ./server.ts --watch --\n```\n\n### ⚑️ Local dev server upgraded to GraphQL Yoga v3, with the ability to use custom options\n\nWhen using Prisma-AppSync local dev server, it is now possible to pass custom options from the `server.ts` file. \n\n```ts\ncreateServer({\n yogaServerOptions: {\n cors: {\n origin: 'http://localhost:4000',\n credentials: true,\n allowedHeaders: ['X-Custom-Header'],\n methods: ['POST']\n }\n /* ...other args */\n }\n})\n```\n\nFor the full list of supported options, please refer to https://the-guild.dev/graphql/yoga-server/docs and the `createYoga` method.\n\n## Fixes and improvements\n\n- [Auto-populated fields (autoincrement, uuid, updatedAt, …) are now visible and directly editable from the GraphQL schema (Issue #70)](https://github.com/maoosi/prisma-appsync/issues/70)\n- [Fixed issue with lists (arrays) in Prisma Schema not being properly cast into the GraphQL Schema (PR #78)](https://github.com/maoosi/prisma-appsync/pull/78)\n- [Added `cuid` as part of the auto-populated fields (PR #72)](https://github.com/maoosi/prisma-appsync/pull/72)\n- [Initialize `prismaArgs` with empty select (PR #69)](https://github.com/maoosi/prisma-appsync/pull/69)\n- [Added an optional generic type for QueryParams (PR #74)](https://github.com/maoosi/prisma-appsync/pull/74)\n- [Fixed issue with CDK boilerplate policy statements (Issue #64)](https://github.com/maoosi/prisma-appsync/issues/64)\n- [Fixed docs using the wrong syntax for fine-grained access control examples (Issue #79)](https://github.com/maoosi/prisma-appsync/issues/79)\n- CDK boilerplate Lambda function upgraded to `NODEJS_16_X`\n- CDK boilerplate `warmUp(boolean)` parameter becomes `useWarmUp(number)`, allowing to specify the number of warm-up functions to use (default `0`)\n\n## Credits\n\n\n \n \n \n \n \n \n \n \n
\"Sylvain\"/
Sylvain
πŸ§™β€β™‚οΈ πŸ’» πŸ€” πŸ“–		\"Ciprian
Ciprian Caba
πŸ’» πŸ€”		\"Cameron
Cameron Jenkinson
πŸ’»		\"Bell\"/
Bell
πŸ’»
\n\n## Github sponsors\n\nEnjoy using Prisma-AppSync? Please consider [πŸ’› Github sponsors](https://github.com/sponsors/maoosi).\n" }, { "path": "docs/changelog/1.0.0-rc.5.md", "content": "---\neditLink: false\n---\n\n# 1.0.0-rc.5\n\n**🌟 Help us spread the word about Prisma-AppSync by starring the repo.**\n\n## Highlights\n\n### ⚑️ Async shield rules\n\nAsync Shield rules are now supported in Prisma-AppSync, opening up to 3 different ways to define fine-grained access control rules:\n\n```ts\nreturn await prismaAppSync.resolve({\n event,\n shield: () => {\n return {\n // Boolean\n 'listPosts{,/**}': { rule: true },\n\n // Function\n 'listPosts{,/**}': { rule: () => true },\n\n // (NEW) Async Function\n 'listPosts{,/**}': {\n rule: async () => {\n await sleep(1000)\n return true\n },\n },\n }\n },\n})\n```\n\n### ⚑️ Support for deeply nested relation filters\n\nDeeply nested relation filters are now supported in Prisma-AppSync, allowing to perform the following queries:\n\n```graphql\nquery {\n listComments(\n where: {\n author: {\n \n # deeply nested relation filter\n posts: {\n every: {\n published: { equals: true }\n }\n }\n\n }\n }\n )\n}\n```\n\n```graphql\nquery {\n listUsers(\n where: {\n posts: {\n every: {\n\n # deeply nested relation filter\n comments: {\n every: {\n message: { startsWith: 'hello' }\n }\n }\n\n }\n }\n }\n )\n}\n```\n\n### ⚑️ Support for `extendedWhereUnique` preview feature\n\nUsing the `extendedWhereUnique` preview feature flag will enable filtering on non-unique fields in Prisma-AppSync, allowing to do the following:\n\n```prisma\ngenerator client {\n provider = \"prisma-client-js\"\n previewFeatures = [\"extendedWhereUnique\"]\n}\n```\n\n```graphql\nmutation($id: Int!, $version: Int) {\n updatePost(\n # version is a non-unique field\n where: { id: $id, version: { equals: $version } },\n operation: { version: { increment: 1 } }\n ) {\n id\n version\n }\n}\n```\n\nSee [Prisma Docs](https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#filter-on-non-unique-fields-with-userwhereuniqueinput) for more details.\n\n## Fixes and improvements\n\n- [`maxDepth` parameter not working properly with Json fields (Issue #71).](https://github.com/maoosi/prisma-appsync/issues/71)\n- [Local dev server reads `undefined` when using nested arrays in query (Issue #83).](https://github.com/maoosi/prisma-appsync/issues/81)\n- [GraphQL input `WhereUniqueInput` shouldn’t include Relation fields (Issue #83).](https://github.com/maoosi/prisma-appsync/issues/83)\n- [Unit tests for Prisma to GraphQL schema conversion (Issue #84).](https://github.com/maoosi/prisma-appsync/issues/84)\n- [Local dev server returning `null` for `0` values (PR #82).](https://github.com/maoosi/prisma-appsync/pull/82)\n- [Issue: fields with `@default` should appear as required `!` in generated GraphQL schema base type (Issue #91).](https://github.com/maoosi/prisma-appsync/issues/91)\n- Improved, more readable, Prisma Client errors logs.\n\n## Credits\n\n\n \n \n \n \n \n \n \n
\"Sylvain\"/
Sylvain
πŸ§™β€β™‚οΈ πŸ’» πŸ€” πŸ“–		\"Ciprian
Ciprian Caba
πŸ’» πŸ€”		\"Bell\"/
Bell
πŸ’»
\n\n## Github sponsors\n\nEnjoy using Prisma-AppSync? Please consider [πŸ’› Github sponsors](https://github.com/sponsors/maoosi).\n" }, { "path": "docs/changelog/1.0.0-rc.6.md", "content": "---\neditLink: false\n---\n\n# 1.0.0-rc.6\n\n**🌟 Help us spread the word about Prisma-AppSync by starring the repo.**\n\n> 🚨 This release include breaking changes, so please make sure to read the below thoroughly before upgrading.\n\n## Breaking\n\n### πŸ’” Updated `upsert` mutation params to be similar to Prisma Client API\n\nThis change is considered breaking if you are using `upsert` mutations.\n\n```graphql\n# before\nmutation {\n upsertPost(\n where: { id: 1 }\n data: { title: \"Hello world\" }\n ) {\n title\n }\n}\n\n# after\nmutation {\n upsertPost(\n where: { id: 1 }\n create: { title: \"Hello world\" }\n update: { title: \"Hello world\" }\n ) {\n title\n }\n}\n```\n\n### πŸ’” Updated `QueryParams.paths` format to fix various reported issues on Shield ACL rules\n\nThis change fixes various reported issues on Shield ACL rules. [See full details here.](https://github.com/maoosi/prisma-appsync/issues/125) It also allows creating more granular rules such as [`createPost/**/connect{,/**}`](https://globster.xyz/?q=createPost%2F**%2Fconnect%7B%2C%2F**%7D&f=createPost%2CcreatePost%2Ftitle%2CcreatePost%2Fauthor%2CcreatePost%2Fauthor%2Fconnect%2CcreatePost%2Fauthor%2Fconnect%2Fid%2CgetPost%2CgetPost%2Fid%2CgetPost%2Ftitle).\n\nOnly considered breaking if you have implemented advanced fine-grained access control rules, or if you are using `QueryParams.paths` for some custom business logic (most likely inside Hooks).\n\n**Example:**\n\n```graphql\nmutation createPost {\n createPost(\n data: {\n title: \"Hello people\"\n author: { connect: { id: 1 } }\n }\n ) {\n id\n title\n }\n}\n```\n\n**Before:**\n\n```json\n{\n \"paths\": [\n \"/create/post/title\",\n \"/create/post/author/id\",\n \"/get/post/id\",\n \"/get/post/title\"\n ]\n}\n```\n\n**After:**\n\n```json\n{\n \"paths\": [\n \"createPost\",\n \"createPost/title\",\n \"createPost/author\",\n \"createPost/author/connect\",\n \"createPost/author/connect/id\",\n \"getPost\",\n \"getPost/id\",\n \"getPost/title\"\n ]\n}\n```\n\n## Highlights\n\n### ⚑️ Support for custom GraphQL scalars on fields\n\n**Prisma schema:**\n\n```prisma\n/// @gql(scalars: { website: \"AWSURL\" })\nmodel Company {\n id Int @id @default(autoincrement())\n name String\n website String?\n}\n```\n\n**GraphQL output:**\n\n```graphql\ntype Company {\n id: Int!\n name: String!\n website: AWSURL\n}\n```\n\n### ⚑️ Support for nullable in Query filters\n\n**Example #1:**\n\n```graphql\nquery {\n listUsers (\n where: {\n fullname: { isNull: true }\n }\n ) {\n id\n }\n}\n```\n\n**Example #2:**\n\n```graphql\nquery {\n listPosts (\n where: {\n author: { is: NULL }\n }\n ) {\n id\n }\n}\n```\n\n**Example #3:**\n\n```graphql\nquery {\n listPosts (\n where: {\n author: { isNot: NULL }\n }\n ) {\n id\n }\n}\n```\n\n### ⚑️ Refreshed documentation\n\n[Prisma-AppSync documentation](https://prisma-appsync.vercel.app) has been refreshed with new navigation, revised content, and a new guide on [Tweaking the GraphQL Schema](https://prisma-appsync.vercel.app/features/gql-schema.html).\n\n## Fixes and improvements\n\n- [The local dev server now supports concurrent queries.](https://github.com/maoosi/prisma-appsync/issues/103)\n- [The local dev server now returns __typename (similar to AppSync)](https://github.com/maoosi/prisma-appsync/issues/115)\n- [All fields with `@default()` are now optional in GraphQL output](https://github.com/maoosi/prisma-appsync/issues/96)\n- [Improved performances on ACL Shield Functions (checks now runs in parallel).](https://github.com/maoosi/prisma-appsync/issues/92)\n- [Fixed issue with ACL Shield rules and WhereUniqueInput.](https://github.com/maoosi/prisma-appsync/issues/123)\n- [Fixed issue with using `is` and `isNot` inside `some` or `every`.](https://github.com/maoosi/prisma-appsync/issues/102)\n- [Fixed issue using arguments with no selectionSet on the local dev server.](https://github.com/maoosi/prisma-appsync/pull/104)\n- [Fixed issue with `UpdateRelationsInput`, `delete` and `deleteMany` input types.](https://github.com/maoosi/prisma-appsync/pull/99)\n\n## Sponsors\n\n\n \n \n \n \n
\n \n \"kuizto.co\"/\n
Solve and sparkle up your daily food life\n \n 		\n \n \"travistravis.co\"/\n
Collaborative travel planning\n \n
\n\n## Credits\n\n\n \n \n \n \n \n \n \n \n
\"Sylvain\"/
Sylvain
πŸ™ πŸ’» πŸ€” πŸ“–		\"Bell\"/
Bell
πŸ’» πŸ€”		\"Tom\"/
Tom
πŸ’» πŸ€”		\"jeremy-white\"/
jeremy-white
πŸ’»
\n\n## Annoucements\n\n\"Sylvain\"/ **I am starting my Founder journey with [kuizto.co](https://kuizto.co).** Kuizto is a bit like Netflix for your daily food! Lots of visual cooking inspiration, auto-generated grocery lists, and a small social layer to share and discover deliciously simple meals. [Please register for early access](https://kuizto.co), launching later this year!\n\n\"Sylvain\"/ **[Prisma-EdgeQL](https://github.com/kuizto/prisma-edgeql) is an edge-compatible Prisma Client (using PlanetScale driver).** The project was initially built as part of my work at [kuizto.co](https://kuizto.co) and will be released open-source soon. Please go [Star the repo](https://github.com/kuizto/prisma-edgeql) if you are interested!\n\n## Github sponsors\n\nEnjoy using Prisma-AppSync? **Please consider [πŸ’› Github sponsors](https://github.com/sponsors/maoosi).**\n" }, { "path": "docs/changelog/1.0.0-rc.7.md", "content": "---\neditLink: false\n---\n\n# 1.0.0-rc.7\n\n**🌟 Support Prisma-AppSync by Starring Our Repo!**\n\n## Highlights\n\n### Local Dev Server Transitioned to Amplify AppSync Simulator\n\n> 🚨 Breaking Change: Please Read the Following Carefully Before Upgrading.\n\nThe previous version of our Prisma-AppSync local development server relied on GraphQL Yoga, complemented by several custom functions to mimic AWS Lambda and AppSync's internal behaviors. This was an effective approach initially but began to cause issues as Prisma-AppSync was used for more complex use cases.\n\nTo resolve these issues and simplify maintenance, we've opted to replace our bespoke implementation with Amplify AppSync Simulator. Amplify AppSync Simulator is an integral package within the [AWS Amplify CLI](https://github.com/aws-amplify/amplify-cli) and aims to accurately simulate the experience of using AppSync locally.\n\n**This migration brings numerous advantages to using the local development server:**\n\n- Enables the use of Codegen [Issue #137](https://github.com/maoosi/prisma-appsync/issues/137)\n- Supports using GraphQL Fragments [Issue #112](https://github.com/maoosi/prisma-appsync/issues/112)\n- Accommodates Authentication and Authorization modes provided by AWS AppSync, including Cognito User Pools.\n- Enables Subscription support, using a local WebSocket server.\n\n**For users already using the Prisma-AppSync local development server who wish to migrate, follow these steps:**\n\n1. Substitute your local `server.ts` file with the newer version found at `packages/boilerplate/server.ts`.\n2. Install the new required dependency using `yarn add js-yaml -D`.\n3. Modify the CLI command to initiate the local development server within your `package.json` file (by default, this is the `dev` script).\n4. Here are the corresponding before and after scripts:\n\n```shell\n# before\nnpx vite-node ./server.ts --watch --\n --handler handler.ts\n --schema prisma/generated/prisma-appsync/schema.gql\n --port 4000\n --watchers '[{\"watch\":[\"**/*.prisma\",\"*.prisma\"],\"exec\":\"npx prisma generate && touch ./server.ts\"}]'\n --headers '{\"x-fingerprint\":\"123456\"}' # removed\n\n# after\nnpx vite-node ./server.ts --watch --\n --handler handler.ts\n --schema prisma/generated/prisma-appsync/schema.gql\n --resolvers prisma/generated/prisma-appsync/resolvers.yaml # added\n --port 4000\n --wsPort 4001 # added\n --watchers '[{\"watch\":[\"**/*.prisma\",\"*.prisma\"],\"exec\":\"npx prisma generate && touch ./server.ts\"}]'\n```\n\n### Upgraded to Prisma 5.1.1+\n\n> 🚨 Breaking Change: Please Read the Following Carefully Before Upgrading.\n\nPrisma-AppSync internals were updated to support Prisma 5.1.1. One potentially breaking change is that the [`extendedWhereUnique`](https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#filter-on-non-unique-fields-with-userwhereuniqueinput) preview feature was promoted to general availability. So newly generated `WhereUniqueInput` schema types exposes all fields on the model, not just unique fields.\n\n### Updated Minimum NodeJS Version Requirement\n\n> 🚨 Breaking Change: Please Read the Following Carefully Before Upgrading.\n\nThe compilation target of Prisma-AppSync was updated **from Node.js 14 to Node.js 16**. Please ensure you have the minimum required Node.js version (Node.js 16) enabled on your local environment and deployed Lambda function.\n\n### Updated CDK Boilerplate\n\nThe provided CDK Boilerplate has been updated to use the latest depdencies and recommended CDK packages. In addition, the default Lambda function version has been updated to use **Node 18.X**.\n\n## Fixes and improvements\n\n- [GraphQL Schema adjusted to make some array elements and responses non-nullable.](https://github.com/maoosi/prisma-appsync/pull/133)\n- [Schema generation issue when using Prisma @@id attributes](https://github.com/maoosi/prisma-appsync/issues/149)\n\n## Sponsors\n\n\n \n \n \n
\n \n \"kuizto.co\"/\n
Reconnect with home cooking\n \n
\n\n## Credits\n\n\n \n \n \n \n \n \n \n \n
\"Sylvain\"/
Sylvain
πŸ™ πŸ’» πŸ€” πŸ“–		\"Tom\"/
Tom
πŸ’» πŸ€”		\"Bell\"/
Bell
πŸ’» πŸ€”		\"Max
Max Konin
πŸ’»
\n\n## Github sponsors\n\nEnjoy using Prisma-AppSync? **Please consider [πŸ’› Github sponsors](https://github.com/sponsors/maoosi).**\n" }, { "path": "docs/changelog/1.0.0.md", "content": "---\neditLink: false\n---\n\n# v1.0.0\n\n**Support Prisma-AppSync by Starring Our Repo!**\n\n## 🌟 Sponsor\n\n[![Kuizto β€” The Everyday Cooking App](https://prisma-appsync.vercel.app/sponsors/kuizto-banner.png \"Kuizto β€” The Everyday Cooking App\")](https://kuizto.co/?utm_source=prisma_appsync&utm_medium=github)\n\n[Kuizto.co](https://kuizto.co/?utm_source=prisma_appsync&utm_medium=github) is a cooking app that adds a unique twist to everyday cooking. Netflix-like feed to explore tailored recipes. Get inspired by others, save to cooklists, plan instantly!\n\n## πŸš€ Release Summary\n\n- Prisma-AppSync officially stable! πŸŽ‰\n- Breaking change to context alias values\n- Breaking change to maximum query depth defaults\n- Enhanced `@gql` and `@auth` directives for finer control\n- Generator Revamp & New Diff Tool for improved GraphQL Schema output\n- Streamlined Model Relations: `Create[Model]Without[Relation]Input`\n- Default input values are now visible in your GraphQL IDE\n- Added support for `AWS_LAMBDA` authorization mode\n\n## πŸ‘€ Full Changelog\n\n### πŸ‘‰ Prisma-AppSync officially stable! πŸŽ‰\n\nExciting news! Prisma-AppSync has achieved stability and is already in use in multiple production projects. Time to celebrate the release of v1.0.0!\n\n### πŸ‘‰ Breaking change to context alias values\n\nTo streamline values in `Context.alias` (accessible from hooks and custom resolvers params), the `modify` alias has been renammed to `mutate`, and `batchModify` is now referred to as `batchMutate`.\n\n### πŸ‘‰ Breaking change to maximum query depth defaults\n\nTo align maximum query depth with the latest changes from v1.0.0, the `maxDepth` default value was changed from `3` to `4`.\n\nTo limit side effects, you have the option to manually set it to its previous value via:\n\n```ts\nconst prismaAppSync = new PrismaAppSync({ maxDepth: 3 })\n```\n\n### πŸ‘‰ Enhanced `@gql` and `@auth` directives for finer control\n\nThe `@gql` directive has been updated to provide more detailed control over CRUD operations:\n\n```prisma\n// before: only top-level rules were supported\n@gql(queries: null, mutations: null)\n\n// after: define specific rules for each CRUD operation\n@gql(queries: { list: null, count: null }, mutations: { update: null, delete: null })\n```\n\nSame goes with the `@auth` directive, allowing granular access rules per operation:\n\n```prisma\n// before: only top-level rules were supported\n@auth(queries: [{ allow: iam }])\n\n// after: individual rules for specific query operations\n@auth(queries: { list: [{ allow: iam }] })\n```\n\nField-level authorization is now possible with the `@auth` directive:\n\n```prisma\n// newly supported field-level authorization rules\n@auth(fields: { password: [{ allow: apiKey }] })\n```\n\nThe `defaultDirective` in the prisma-appsync generator config is now optional, providing flexibility in configurations:\n\n```prisma\ngenerator appsync {\n provider = \"prisma-appsync\"\n // `defaultDirective` can be specified or omitted\n defaultDirective = \"@auth(model: [{ allow: iam }])\"\n}\n```\n\nWhen provided, `defaultDirective` seamlessly integrates with model-specific directives:\n\n```prisma\n// specified 'defaultDirective' for all models:\n@auth(model: [{ allow: iam }])\n\n// additional 'model directive' for enhanced control:\n@auth(model: [{ allow: apiKey }])\n\n// resulting merged directive for the model:\n@auth(model: [{ allow: iam }, { allow: apiKey }])\n```\n\n### πŸ‘‰ Generator Revamp for improved GraphQL Schema output\n\nThe Generator package has been totally rewritten to address reported issues and unlock a slew of new features. This not only makes the GraphQL Schema output more concise and well-optimized but also ensures Prisma-AppSync is ready for what's next.\n\nWith the largest production schemas, this revamp has led to a reduction of up to 500 lines in the GraphQL Schema output.\n\n::: info Free online tool: AppSync GraphQL Schema Diff\nTo see the before/after with your own schema or simply compare two different AppSync Schemas, we've published a free online tool: [AppSync GraphQL Schema Diff](https://prisma-appsync.vercel.app/tools/appsync-gql-schema-diff.html).\n:::\n\n### πŸ‘‰ Streamlined Model Relations: Create[Model]Without[Relation]Input\n\nWith the generator revamp, you can now create, update, or upsert any Model Relation (like Author) tied to a particular Model (such as Post) in just one GraphQL query. This eliminates the previous, more cumbersome process of inserting each Model separately and then manually associating them. The improvement is in sync with the Prisma Client API, offering a more streamlined and developer-friendly approach.\n\n```gql\nmutation {\n createPost(\n data: {\n title: \"Example post\"\n author: {\n connectOrCreate: {\n where: { name: \"John Doe\" }\n create: { name: \"John Doe\" }\n }\n }\n }\n ) {\n title\n author {\n name\n }\n }\n}\n```\n\n### πŸ‘‰ Default input values are now visible in your GraphQL IDE\n\nConsidering the Prisma model example below:\n\n```prisma\nmodel Post {\n content String\n views Int @default(0)\n isPublished Boolean @default(false)\n}\n```\n\nThis model will result in the following GraphQL schema:\n\n```gql\ninput PostCreateInput {\n content: String!\n views: Int = 0\n isPublished: Boolean = false\n}\n```\n\nThis update automatically fills the default values for `views` (0) and `isPublished` (false) in your GraphQL IDE, making it easier to see and work with your schema defaults.\n\n### πŸ‘‰ Added support for `AWS_LAMBDA` authorization mode\n\nYou can now utilize `AWS_LAMBDA` as an authorization mode with the `@auth` directive:\n\n```prisma\n// AWS_LAMBDA\n@auth(model: [{ allow: lambda }])\n```\n\n## πŸ™ Credits\n\n\"Sylvain\"/
Sylvain
πŸ™ πŸ’» πŸ€” πŸ“–\n\n## πŸ’› Github Sponsors\n\nEnjoy using Prisma-AppSync? **Please consider [πŸ’› Github sponsors](https://github.com/sponsors/maoosi).**\n" }, { "path": "docs/changelog/index.md", "content": "# Changelog\n\n- [(latest) v1.0.0](/changelog/1.0.0.html)\n- [1.0.0-rc.7](/changelog/1.0.0-rc.7.html)\n- [1.0.0-rc.6](/changelog/1.0.0-rc.6.html)\n- [1.0.0-rc.5](/changelog/1.0.0-rc.5.html)\n- [1.0.0-rc.4](/changelog/1.0.0-rc.4.html)\n- [1.0.0-rc.3](/changelog/1.0.0-rc.3.html)\n- [1.0.0-rc.2](/changelog/1.0.0-rc.2.html)\n- [1.0.0-rc.1](/changelog/1.0.0-rc.1.html)" }, { "path": "docs/contributing.md", "content": "# Contributions guide\n\nThanks for your interest in contributing!\n\n## πŸ‘‰ Discuss first\n\nBefore starting to work on a pull request, it's always better to open an issue first to confirm its desirability and discuss the approach with the maintainers.\n\n## πŸ‘‰ Project packages\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n\n**`packages/generator`**\n\nGenerator for [Prisma ORM](https://www.prisma.io/), whose role is to parse your Prisma Schema and generate all the necessary components to run and deploy a GraphQL API tailored for AWS AppSync.\n\n
\n\n**`packages/client`**\n\nThink of it as [Prisma Client](https://www.prisma.io/client) for GraphQL. Fully typed and designed for AWS Lambda AppSync Resolvers. It can handle CRUD operations with just a single line of code, or be fully extended.\n\n
\n\n**`packages/installer`**\n\nInteractive CLI tool that streamlines the setup of new Prisma-AppSync projects, making it as simple as running `npx create-prisma-appsync-app@latest`.\n\n
\n\n**`packages/server`**\n\nLocal dev environment that mimics running Prisma-AppSync in production. It includes an AppSync simulator, local Lambda resolvers execution, a GraphQL IDE, hot-reloading, and authorizations.\n\n
\n\n## πŸ‘‰ Repository setup\n\nWe use `pnpm` as the core package manager, `yarn` + `docker` for creating the AWS CDK bundle before deployment, `zx` for running scripts, `aws` + `cdk` CLIs for deployment.\n\n**Start with cloning the repo on your local machine:**\n\n```bash\ngit clone https://github.com/maoosi/prisma-appsync.git\n```\n\n**Checkout the `dev` branch (working branch):**\n\n```bash\ngit checkout dev\n```\n\n**Install pre-requirements:**\n\n| Step |\n|:-------------|\n| 1. Install NodeJS,Β [latest LTS is recommended β†—](https://nodejs.org/en/about/releases/) |\n| 2. InstallΒ [pnpm β†—](https://pnpm.js.org/) |\n| 3. InstallΒ [yarn@1 β†—](https://classic.yarnpkg.com/en/docs/install/) |\n| 4. Install [zx β†—](https://github.com/google/zx) |\n| 5. InstallΒ [docker β†—](https://www.docker.com/products/docker-desktop) |\n| 6. Install theΒ [AWS CLI β†—](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) |\n| 7. Install theΒ [AWS CDK β†—](https://github.com/aws/aws-cdk) |\n\n**Verify installation:**\n\n```bash\nnode -v && pnpm --version && yarn --version && zx --version && docker --version && aws --version && cdk --version\n```\n\n**Install dependencies:**\n\n```bash\npnpm install\n```\n\n**Run local dev playground:**\n\n```bash\npnpm dev\n```\n\n> See list of commands below for more details about `pnpm dev`.\n\n## πŸ‘‰ Commands\n\n| Command | Description |\n| ------------- |:-------------|\n| `pnpm install` | Install project dependencies. |\n| `pnpm test` | Run all unit tests and e2e tests. |\n| `pnpm build` | Build the entire prisma-appsync library. |\n| `pnpm dev` | Creates local dev setup, useful for contributing [1]. |\n\n> [1] Auto-generates a 'playground' folder (if not there already) and launches a local GraphQL + AWS AppSync server. This simulates the Prisma-AppSync AWS environment for local development, with 'playground' contents pointing to local source packages.\n\n## πŸ‘‰ Commit convention\n\nWe use [Conventional Commits β†—](https://www.conventionalcommits.org/) for commit messages such as:\n\n```ts\n[optional scope]: \n```\n\n> - Possible types: `feat` / `fix` / `chore` / `docs`\n> - Possible scopes: `client` / `generator` / `cli` / `boilerplate` / `server`\n> - Description: Short description, with issue number when relevant.\n\nHere are some examples:\n\n| Type | Commit message |\n|:------------- |:------------- |\n| Bug fix | `fix(client): issue #234 - JEST_WORKER_ID replaced` |\n| New feature | `feat(generator): new defaultDirective parameter` |\n| Routine task | `chore: deps updated to latest` |\n| Docs update | `docs: fix typo inside home` |\n\n## πŸ‘‰ Coding guidelines\n\n### ESLint\n\nWe use [ESLint β†—](https://eslint.org/) for both linting and formatting.\n\n
\n\n#### IDE Setup\n\nWe recommend using [VS Code β†—](https://code.visualstudio.com/) along with the [ESLint extension β†—](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).\n\nWith the settings on the right, you can have auto-fix and formatting when you save the code you are editing.\n\n
\n\nVS Code's `settings.json`\n\n```json\n{\n \"editor.codeActionsOnSave\": {\n \"source.fixAll\": false,\n \"source.fixAll.eslint\": true\n }\n}\n```\n\n
\n\n### No Prettier\n\nSince ESLint is already configured to format the code, there is no need to duplicate the functionality with Prettier. If you have Prettier installed in your editor, we recommend you disable it when working on the project to avoid conflict.\n\n## πŸ‘‰ License\n\nWhen you contribute code to the Prisma-AppSync project, you grant the maintainers permission to use and share your code under the project's BSD 2-Clause License. You also affirm that you are the original author of the code and have the authority to license it.\n" }, { "path": "docs/features/gql-schema.md", "content": "# Tweaking GraphQL Schema\n\nPrisma-AppSync provides ways to tweak and customise the GraphQL Schema output.\n\n## πŸ‘‰ Models directives\n\nTweaking the GraphQL schema for a given model require to write directives via AST comments (triple-slash `///`).\n\n```prisma\n/// @gql(mutations: null, subscriptions: null)\n/// @gql(fields: { password: null })\n/// @gql(scalars: { email: \"AWSEmail\" })\nmodel User {\n id Int @id @default(autoincrement())\n email String\n password String\n}\n```\n\n## πŸ‘‰ Usage with @gql syntax\n\n### Disabling an entire model\n\n```prisma\n// Disable all queries, mutations and subscriptions\n@gql(model: null)\n```\n\n### Disabling queries\n\n```prisma\n// Disable all queries (get, list, count, ...)\n@gql(queries: null)\n\n// Disable granular queries\n@gql(queries: { list: null, count: null })\n```\n\n### Disabling mutations\n\n```prisma\n// Disable all mutations (create, update, upsert, delete, ...)\n@gql(mutations: null)\n\n// Disable granular mutations\n@gql(mutations: { update: null, delete: null })\n```\n\n> **Cascading Rules:**\n>\n> - Disabling `update` **will also disable** `upsert`\n> - Disabling `create` **will also disable** `upsert`\n> - Disabling `mutations` **will also disable** `subscriptions`\n\n### Disabling subscriptions\n\n```prisma\n// Disable all subscriptions (onCreated, onUpdated, ...)\n@gql(subscriptions: null)\n\n// Disable granular subscriptions\n@gql(mutations: { onCreated: null, onUpdated: null })\n```\n\n### Hiding fields\n\n```prisma\n// If applied to a model with a `password` field:\n// hide `password` field from the generated Type\n@gql(fields: { password: null })\n```\n\n> **Note:** To maintain Prisma Client integrity, hidden fields remain writable in mutation operations.\n\n### Custom scalars on fields\n\n```prisma\n// If applied to a model with a `website` (string) field:\n// use scalar `AWSURL` instead of default `String`\n@gql(scalars: { website: \"AWSURL\" })\n```\n" }, { "path": "docs/features/hooks.md", "content": "# Lifecycle hooks\n\nHooks let you β€œhook into” Prisma-AppSync lifecycle to either trigger custom business logic or manipulate data at runtime.\n\n## πŸ‘‰ Example code\n\nBasic example:\n\n```ts\nreturn await prismaAppSync.resolve({\n event,\n hooks: {\n // Mutate Post title before creation on database\n 'before:createPost': async (params: BeforeHookParams) => {\n params.prismaArgs.data.title = 'New post title'\n return params\n },\n // Override query result using always the same Post title\n 'after:listPosts': async (params: AfterHookParams) => {\n params.result = params.result.map(r => r.title = 'Always the same title')\n return params\n },\n },\n})\n```\n\nAdvanced example:\n\n```ts\nreturn await prismaAppSync.resolve<'likePost'>({\n event,\n hooks: {\n // execute before any query\n 'before:**': async (params: BeforeHookParams) => params,\n\n // execute after any query\n 'after:**': async (params: AfterHookParams) => params,\n\n // execute after custom resolver query `likePost`\n // (e.g. `query { likePost(postId: 3) }`)\n 'after:likePost': async (params: AfterHookParams) => {\n await params.prismaClient.notification.create({\n data: {\n event: 'POST_LIKED',\n targetId: params.args.postId,\n userId: params.authIdentity.sub,\n },\n })\n return params\n },\n },\n})\n```\n\n## πŸ‘‰ Types\n\n```ts\nexport interface QueryParams {\n type: GraphQLType\n operation: string\n context: Context\n fields: string[]\n paths: string[]\n args: any\n prismaArgs: PrismaArgs\n authorization: Authorization\n identity: Identity\n headers: any\n prismaClient: PrismaClient\n}\n\ntype BeforeHookParams = QueryParams\n\ntype AfterHookParams = QueryParams & {\n result: any | any[]\n}\n```\n\n## πŸ‘‰ Usage rules\n\n- Hooks are made of a **Path** (e.g. `after:updatePost`) and an async function.\n- **Path** syntax always starts with `before:` or `after:`.\n\n > `before` or `after` querying data from the database.\n\n- **Path** syntax after `:` uses [Micromatch syntax](https://github.com/micromatch/micromatch).\n- Hooks are fully typed, so VSCode IntelliSense will give you the full list of Hooks Paths you can use while typing. Example:\n\n![Prisma-AppSync hooks on VS Code](/guides/hooks-autocompletion.png)\n\n- Hooks functions all receive a single object as a parameter. Here is an example object received inside `after:getPost`:\n\n```json\n{\n \"type\": \"Query\",\n \"operation\": \"getPost\",\n \"context\": { \"action\": \"get\", \"alias\": \"access\", \"model\": \"Post\" },\n \"fields\": [\"title\", \"status\"],\n \"paths\": [\"get/post/title\", \"get/post/status\"],\n \"args\": { \"where\": { \"id\": 5 } },\n \"prismaArgs\": {\n \"where\": { \"id\": 5 },\n \"select\": { \"title\": true, \"status\": true }\n },\n \"authorization\": \"API_KEY\",\n \"identity\": {},\n \"result\": { \"title\": \"My first post\", \"status\": \"PUBLISHED\" }\n}\n```\n\n- Key `result` is only available inside `after` hooks.\n- Hooks async functions MUST return the object received as a parameter (either mutated or untouched).\n- Using hooks on custom resolvers requires explicitly listing resolvers using a TypeScript Generic `prismaAppSync.resolve`:\n\n```ts\n// Using custom resolver `likePost`\nreturn await prismaAppSync.resolve<'likePost'>({ event, hooks })\n\n// Using multiple custom resolvers\nreturn await prismaAppSync.resolve<'likePost' | 'unlikePost'>({ event, hooks })\n```\n" }, { "path": "docs/features/resolvers.md", "content": "# Custom resolvers\n\nLet's assume we want to extend our GraphQL CRUD API and add a custom mutation `incrementPostsViews` based on our Prisma Schema:\n\n```prisma\nmodel Post {\n id Int @id @default(autoincrement())\n views Int\n}\n```\n\n## πŸ‘‰ 1. ExtendingΒ our GraphQL Schema\n\nTo extend our auto-generated `schema.gql`, we will create a newΒ `custom-schema.gql`Β file next to our `schema.prisma`Β file:\n\n```graphql\nextend type Mutation {\n \"\"\"\n Increment post views by +1\n \"\"\"\n incrementPostsViews(postId: Int!): Post\n}\n```\n\nFor Prisma-AppSync to merge our `custom-schema.gql`Β with the auto-generated schema, we edit the `schema.prisma` generator config:\n\n```json{3}\ngenerator appsync {\n provider = \"prisma-appsync\"\n extendSchema = \"./custom-schema.gql\"\n}\n```\n\n## πŸ‘‰ 2. ExtendingΒ our Resolvers Config\n\nFor AWS AppSync to be able to use our newΒ `incrementPostsViews`Β mutation, we also create a newΒ `custom-resolvers.yaml`Β next to our `schema.prisma`Β file:\n\n```yaml\n- typeName: Mutation\n fieldName: incrementPostsViews\n dataSource: prisma-appsync\n```\n\nFor Prisma-AppSync to merge ourΒ `custom-resolvers.yaml`Β with the auto-generated resolvers config, we edit the `schema.prisma` generator config:\n\n```json{4}\ngenerator appsync {\n provider = \"prisma-appsync\"\n extendSchema = \"./custom-schema.gql\"\n extendResolvers = \"./custom-resolvers.yaml\"\n}\n```\n\n## πŸ‘‰ 3. Coding our new Resolver Function\n\nQuerying the `incrementPostsViews` mutation will automatically run a Resolver Function inside our Lambda `handler.ts` file. This is where we will code our custom business logic.\n\n```ts\nreturn await prismaAppSync.resolve<'incrementPostsViews'>({\n event,\n resolvers: {\n // code for our new resolver function\n incrementPostsViews: async ({ args, prismaClient }: QueryParamsCustom) => {\n return await prismaClient.post.update({\n data: { views: { increment: 1 } },\n where: { id: args.postId }\n })\n },\n }\n})\n```\n\n## πŸ‘‰ 4. Updating our CDK file for bundling\n\nTo make sure ourΒ `custom-schema.gql`Β andΒ `custom-resolvers.yaml` are properly bundled and deployed on AWS, we update the `beforeBundling` function inside `cdk/index.ts`:\n\n```ts\nfunction: {\n bundling: {\n commandHooks: {\n beforeBundling(inputDir: string, outputDir: string): string[] {\n const schema = path.join(inputDir, 'prisma/schema.prisma')\n const gql = path.join(inputDir, 'prisma/custom-schema.gql')\n const yaml = path.join(inputDir, 'prisma/custom-resolvers.yaml')\n\n return [\n `cp ${schema} ${outputDir}`,\n `cp ${gql} ${outputDir}`,\n `cp ${yaml} ${outputDir}`,\n ]\n },\n },\n }\n}\n```\n\nπŸš€Β **Done! Next time we deploy on AWS, we will be able to use our newΒ `incrementPostsViews`Β mutation.**\n" }, { "path": "docs/index.md", "content": "---\nlayout: home\n\nhero:\n name: Prisma-AppSync\n text: GQL API Generator for Prisma ORM\n tagline: Turns your Prisma Schema into a fully-featured GraphQL API, tailored for AWS AppSync.\n image:\n src: /logo.svg\n alt: Prisma-AppSync\n actions:\n - theme: brand\n text: Try Prisma-AppSync\n link: /quick-start/getting-started\n - theme: alt\n text: View on GitHub β†—\n link: https://github.com/maoosi/prisma-appsync\n\nfeatures:\n - icon: β—­\n title: Prisma Schema to CRUD API\n details: Deploy a GraphQL API from your Prisma Schema with auto-generated CRUD.\n - icon: ⚑️\n title: GraphQL on AWS AppSync \n details: Serverless GraphQL with real-time updates and built-in security on AppSync.\n - icon: πŸ§‘β€πŸ’»\n title: Fast and Flexible DX\n details: Build and deploy a working API in minutes, easily customise to your needs.\n---" }, { "path": "docs/quick-start/deploy.md", "content": "# Deploy\n\n## πŸ‘‰ 1. Prepare your local machine\n\nMake sure to install the below on your local machine:\n\n- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)\n- [AWS CDK CLI](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html#getting_started_install)\n- [Docker](https://docs.docker.com/get-docker/)\n\nThen [configure your local environment](https://docs.aws.amazon.com/cdk/v2/guide/cli.html#cli-environment) with the AWS Account of your choice.\n\n## πŸ‘‰ 2. Setup a Database\n\nSetup the database of your choice. It doesn't have to be hosted on Amazon AWS, you can use any database supported by Prisma. If you are not sure what to use, we recommend using [PlanetScale](https://planetscale.com) and read the following [integration guide](https://planetscale.com/docs/tutorials/prisma-quickstart).\n\n## πŸ‘‰ 3. Deploy on AWS\n\nRun the below CDK CLI command:\n\n> Where `DATABASE_URL` is your own [database connection url](https://www.prisma.io/docs/reference/database-reference/connection-urls).\n\n```bash\nDATABASE_URL=mysql://xxx yarn deploy\n```\n\n**πŸš€ Done! Your GraphQL API is now ready to use.**\n" }, { "path": "docs/quick-start/getting-started.md", "content": "# Getting started\n\n**Prisma-AppSync** seamlessly transforms your [Prisma Schema](https://www.prisma.io) into a comprehensive GraphQL API, tailored for [AWS AppSync](https://aws.amazon.com/appsync/).\n\n
\n\n**From `schema.prisma`:**\n\n```prisma\nmodel Post {\n id Int\n title String\n}\n```\n\n\n\n**To full-blownΒ GraphQLΒ API:**\n\n```graphql\nquery list {\n listPosts {\n id\n title\n }\n}\n```\n\n
\n\n## πŸ‘‰ Features\n\nπŸ’Ž **Use your β—­ Prisma Schema**
Quickly define your data model and deploy a GraphQL API tailored for AWS AppSync.\n\n⚑️ **Auto-generated CRUD operations**
Using Prisma syntax, with a robust TS Client designed for AWS Lambda Resolvers.\n\nβ›‘ **Pre-configured security**
Built-in XSS protection, query depth limitation, and in-memory rate limiting.\n\nπŸ” **Fine-grained ACL and authorization**
Flexible security options such as API keys, IAM, Cognito, and more.\n\nπŸ”Œ **Fully extendable features**
Customize your GraphQL schema, API resolvers, and data flow as needed.\n\n## πŸ‘‰ Built around 4 packages\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n\n**`packages/generator`**\n\nGenerator for [Prisma ORM](https://www.prisma.io/), whose role is to parse your Prisma Schema and generate all the necessary components to run and deploy a GraphQL API tailored for AWS AppSync.\n\n
\n\n**`packages/client`**\n\nThink of it as [Prisma Client](https://www.prisma.io/client) for GraphQL. Fully typed and designed for AWS Lambda AppSync Resolvers. It can handle CRUD operations with just a single line of code, or be fully extended.\n\n
\n\n**`packages/installer`**\n\nInteractive CLI tool that streamlines the setup of new Prisma-AppSync projects, making it as simple as running `npx create-prisma-appsync-app@latest`.\n\n
\n\n**`packages/server`**\n\nLocal dev environment that mimics running Prisma-AppSync in production. It includes an AppSync simulator, local Lambda resolvers execution, a GraphQL IDE, hot-reloading, and authorizations.\n\n
\n" }, { "path": "docs/quick-start/installation.md", "content": "# Installation\n\n## πŸ‘‰ Option 1: Using the CLI Installer (recommended)\n\nRun the following command and follow the prompts πŸ™‚\n\n```bash\nnpx create-prisma-appsync-app@latest\n```\n\nπŸš€ Done!\n\n## πŸ‘‰ Option 2: Manual Install\n\nAdd `prisma-appsync` to your project dependencies.\n\n```bash\n# using yarn\nyarn add prisma-appsync\n\n# using npm\nnpm i prisma-appsync\n```\n\nEdit your `schema.prisma` file and add:\n\n```json\ngenerator appsync {\n provider = \"prisma-appsync\"\n}\n```\n\nAlso make sure to use the right binary targets:\n\n```json{3}\ngenerator client {\n provider = \"prisma-client-js\"\n binaryTargets = [\"native\", \"rhel-openssl-1.0.x\"]\n}\n```\n\nGenerate your Prisma Client (this will also generate your Prisma-AppSync client):\n\n```bash\nnpx prisma generate\n```\n\nCreate your `handler.ts` Lambda handler (AppSync Direct Lambda Resolver):\n\n```ts\n// Import generated Prisma-AppSync client (adjust path as necessary)\nimport { PrismaAppSync } from './prisma/generated/prisma-appsync/client'\n\n// Instantiate Prisma-AppSync Client\nconst prismaAppSync = new PrismaAppSync()\n\n// Lambda handler (AppSync Direct Lambda Resolver)\nexport const main = async (event: any) => {\n return await prismaAppSync.resolve({ event })\n}\n```\n\nEither copy the AWS CDK boilerplate provided with Prisma-AppSync into your project, OR just use it as a reference for your own CDK config:\n\n```bash\n# path to cdk boilerplate\n./node_modules/prisma-appsync/dist/boilerplate/cdk/\n```\n\nRefer to [AWS CDK Toolkit docs β†—](https://docs.aws.amazon.com/cdk/v2/guide/cli.html) for more info.\n\n" }, { "path": "docs/quick-start/usage.md", "content": "# Usage\n\n## πŸ‘‰ Folder structure\n\nUsing the CLI Installer (recommended):\n\n```bash\nproject/\n |__ handler.ts # lambda function handler (API resolver)\n |__ server.ts # local server (for dev)\n |__ cdk/ # AWS CDK deploy boilerplate\n |__ prisma/\n |__ schema.prisma # prisma schema (data source)\n |__ generated/ # auto-generated after each `npx prisma generate`\n```\n\n## πŸ‘‰ Generating the API\n\nRun the below command from the project root directory:\n\n```bash\nnpx prisma generate\n```\n\nAfter each `prisma generate`, files inside `prisma/generated` will be auto-generated.\n\n## πŸ‘‰ Local dev server\n\nRun the local server and try Prisma-AppSync locally (only if using the CLI Installer):\n\n```bash\nyarn run dev\n```\n\nThis will automatically push your Prisma Schema changes to a SQLite database, as well as launch a local GraphQL IDE server (with auto-reload and TS support).\n" }, { "path": "docs/security/appsync-authz.md", "content": "# AppSync Authorization modes\n\nAWS AppSync provides [authz directives β†—](https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html) for configuring security and data protection.\n\n::: warning SECURITY MUST NEVER BE TAKEN FOR GRANTED\nPrisma-AppSync implements a basic mechanism to help mitigate some common issues. However, accuracy is not guaranteed and you should always test your own API security implementation.\n:::\n\n## πŸ‘‰ Models directives\n\nApplying AppSync authorization modes for a given model require to write directives using AST comments (triple-slash `///`).\n\n```prisma\n/// @auth(model: [{ allow: iam }, { allow: apiKey }])\nmodel Post {\n id Int @id @default(autoincrement())\n title String\n}\n```\n\n## πŸ‘‰ Usage with @auth syntax\n\n> **Note:** For now, `@auth` only works supports the `allow` key.\n\n### Entire model\n\n```prisma\n// Apply to all queries, mutations and subscriptions\n@auth(model: [{ allow: iam }])\n```\n\n### Queries\n\n```prisma\n// Apply to all queries (get, list, count, ...)\n@auth(queries: [{ allow: iam }])\n\n// Apply to granular queries\n@auth(queries: { list: [{ allow: iam }] })\n```\n\n### Mutations\n\n```prisma\n// Apply to all mutations (create, update, upsert, delete, ...)\n@auth(mutations: [{ allow: iam }])\n\n// Apply to granular mutations\n@auth(mutations: { create: [{ allow: iam }] })\n```\n\n### Subscriptions\n\n```prisma\n// Apply to all subscriptions (onCreated, onUpdated, ...)\n@auth(subscriptions: [{ allow: iam }])\n\n// Apply to granular subscriptions\n@auth(subscriptions: { onCreated: [{ allow: iam }] })\n```\n\n### Fields\n\n```prisma\n// Apply to specific Type fields\n@auth(fields: { password: [{ allow: apiKey }] })\n```\n\n## πŸ‘‰ Supported Authorization modes\n\n\n\n```prisma\n// API_KEY Authorization\n@auth(model: [{ allow: apiKey }])\n\n// AWS_IAM\n@auth(model: [{ allow: iam }])\n\n// OPENID_CONNECT\n@auth(model: [{ allow: oidc }])\n\n// AWS_LAMBDA\n@auth(model: [{ allow: lambda }])\n\n// AMAZON_COGNITO_USER_POOLS\n@auth(model: [{ allow: userPools }])\n\n// AMAZON_COGNITO_USER_POOLS with groups\n@auth(model: [{ allow: userPools, groups: [\"users\", \"admins\"] }])\n\n// Allow multiples\n@auth(model: [{ allow: apiKey }, { allow: userPools, groups: [\"admins\"] }])\n```\n\n## πŸ‘‰ Default directive\n\nIt is also possible to set a `defaultDirective`, that will apply to all generated Types:\n\n```prisma{3}\ngenerator appsync {\n provider = \"prisma-appsync\"\n defaultDirective = \"@auth(model: [{ allow: iam }])\"\n}\n```\n\nWhen provided, `defaultDirective` seamlessly integrates with model-specific directives:\n\n```prisma\n// specified 'defaultDirective' for all models:\n@auth(model: [{ allow: iam }])\n\n// additional 'model directive' for enhanced control:\n@auth(model: [{ allow: apiKey }])\n\n// resulting merged directive for the model:\n@auth(model: [{ allow: iam }, { allow: apiKey }])\n```\n" }, { "path": "docs/security/query-depth.md", "content": "# Query depth\n\n## πŸ‘‰ Usage\n\nPrisma-AppSync automatically prevents from abusing query depth, by limiting query complexity.\n\n**For example, it will prevent from doing this:**\n\n```graphql\nquery IAmEvil {\n author(id: \"abc\") {\n posts {\n author {\n posts {\n author {\n posts {\n author {\n # that could go on as deep as the client wants!\n }\n }\n }\n }\n }\n }\n }\n}\n```\n\nDefault value for the maximum query depth is set to `4`. It is possible to change the default max depth value via the `maxDepth` option:\n\n```ts\nconst prismaAppSync = new PrismaAppSync({ maxDepth: 3 })\n```\n" }, { "path": "docs/security/rate-limiter.md", "content": "# Rate limiter (DOS)\n\n::: warning WARNING NOTICE\nLimits are kept in memory and are not shared between function instantiations. This means limits can reset arbitrarily when new instances get spawned or different instances are used to serve requests.\n:::\n\n## πŸ‘‰ Usage\n\nPrisma-AppSync uses in-memory rate-limiting to try protect your Database from most common DOS attacks.\n\nTo change the default value (default to 200 requests per user, per minute), you can adjust the `maxReqPerUserMinute` option when instantiating the Client:\n\n```ts\nconst prismaAppSync = new PrismaAppSync({ maxReqPerUserMinute: 500 })\n```\n\n## πŸ‘‰ Disable rate limiter\n\nIf you prefer to disable the in-memory rate limiter, set the option to false:\n\n```ts\nconst prismaAppSync = new PrismaAppSync({ maxReqPerUserMinute: false })\n```\n" }, { "path": "docs/security/shield-acl.md", "content": "# Shield (Access Control Rules)\n\nFine-grained access control rules can be used via the `shield` property of Prisma-AppSync client, directly inside the Lambda Handler function.\n\n::: warning SECURITY MUST NEVER BE TAKEN FOR GRANTED\nPrisma-AppSync implements a basic mechanism to help mitigate some common issues. However, accuracy is not guaranteed and you should always test your own API security implementation.\n:::\n\n## πŸ‘‰ Basic example\n\nFor example, we might want to only allow access to `PUBLISHED` posts:\n\n```ts\nreturn await prismaAppSync.resolve({\n event,\n shield: () => {\n // Prisma filtering syntax\n // https://www.prisma.io/docs/concepts/components/prisma-client/filtering-and-sorting\n const isPublished = { status: { equals: 'PUBLISHED' } }\n\n return {\n // Micromatch syntax\n // https://github.com/micromatch/micromatch\n 'getPost{,/**}': {\n rule: isPublished,\n reason: () => 'Unpublished Posts cannot be accessed.',\n },\n }\n },\n})\n```\n\nUseful links to create shield rules:\n\n- [Micromatch syntax](https://github.com/micromatch/micromatch)\n- [Micromatch tester](https://globster.xyz/?q=getPost%7B%2C%2F**%7D&f=getPost%2Ftitle%2CgetPost%2Fstatus)\n\n## πŸ‘‰ Usage with AppSync Authorization modes\n\nCombining fine-grained access control with [AppSync Authorization modes](/security/appsync-authz) allows to implement powerful controls around data.\n\nLet's assume we want to restrict API access to users logged in via `AMAZON_COGNITO_USER_POOLS` and only allow the owner of a given Post to modify it:\n\n```ts\nreturn await prismaAppSync.resolve({\n event,\n shield: ({ authorization, identity }: QueryParams) => {\n const isCognitoAuth = authorization === Authorizations.AMAZON_COGNITO_USER_POOLS\n const isOwner = { owner: { cognitoSub: identity?.sub } }\n\n return {\n '**': {\n rule: isCognitoAuth,\n reason: ({ model }) => `${model} access is restricted to logged-in users.`,\n },\n '{update,upsert,delete}Post{,/**}': {\n rule: isOwner,\n reason: ({ model }) => `${model} can only be modified by their owner.`,\n },\n }\n },\n})\n```\n\n> The above example implies using Cognito User Pools Authorization. Plus having set up an `Owner` relation on the `Post` model, and a `cognitoSub` field on the `User` model (containing all users `sub`).\n\n## 🚨 Order matters\n\nThe latest matching rule ALWAYS overrides previous ones.\n\n```ts\n// Bad - Second rule overrides first one\nreturn {\n 'listUsers/password': false,\n 'listUsers{,/**}': true,\n}\n\n// Good - Always write the more specific rules last\nreturn {\n 'listUsers{,/**}': true,\n 'listUsers/password': false\n}\n```\n" }, { "path": "docs/security/xss-sanitizer.md", "content": "# XSS sanitizer\n\n## πŸ‘‰ Usage\n\nPrisma-AppSync automatically perform XSS sanitization and encode all data coming through the GraphQL API.\n\n**Take a look at this example:**\n\n
\n\n1/ Assuming the following GraphQL Input:\n\n```graphql\nmutation maliciousPost($title: String!) {\n createPost(data: { title: $title }) {\n title\n }\n}\n```\n\n```json\n{\n \"title\": \"\"\n}\n```\n\n
\n\n2/ Prisma-AppSync will automatically remove the malicious code and encode Html, before storing anything in the database:\n\n| Column name | Value |\n| ------------- |:-------------|\n| title | `<img src>` |\n\n
\n\n3/ Finally, the GraphQL API will also automatically clarify (decode) all data before sending the response:\n\n```ts\nconsole.log(post.title) // output: \"\"\n```\n\n
\n\n## πŸ‘‰ Disable xss sanitization\n\nIf you prefer to disable data sanitization, set the `sanitize` option to false when instantiating the Client:\n\n```ts\nconst prismaAppSync = new PrismaAppSync({ sanitize: false })\n```\n" }, { "path": "docs/support.md", "content": "# Support\n\n## \"Sylvain\"/\n\n**πŸ‘‹ Hi, I’m Sylvain! [On-demand CTO](https://sylvainsimao.com/freelance/) and creator of β—­ Prisma-AppSync.**\n\nUsing Prisma-AppSync in production and looking for hourly paid support? You can contact me on [Twitter](https://twitter.com/Sylvain_Simao), message me on [LinkedIn](https://www.linkedin.com/in/sylvainsimao/), or [send me an email](https://sylvainsimao.com/contact).\n" }, { "path": "docs/tools/appsync-gql-schema-diff.md", "content": "---\naside: false\n---\n\n\n\n# AppSync GraphQL Schema Diff\n\nCompare changes between AppSync GraphQL Schemas.\n\n
\n
\n \n \n
\n
\n \n
    \n
  1. \n {{ log.level }}: {{ log.message }}\n
    2. \n
\n No differences.\n
\n
\n\n\n" }, { "path": "package.json", "content": "{\n \"name\": \"prisma-appsync\",\n \"version\": \"1.0.2\",\n \"description\": \"⚑ AppSync GraphQL API Generator for β—­ Prisma ORM.\",\n \"author\": \"maoosi \",\n \"license\": \"BSD-2-Clause\",\n \"repository\": \"git@github.com:maoosi/prisma-appsync.git\",\n \"keywords\": [\n \"api\",\n \"appsync\",\n \"aws\",\n \"crud\",\n \"generator\",\n \"graphql\",\n \"prisma\",\n \"prisma-appsync\",\n \"appsync-crud-api\"\n ],\n \"bin\": \"./dist/generator.js\",\n \"engines\": {\n \"node\": \">=14\",\n \"pnpm\": \">=6\"\n },\n \"scripts\": {\n \"preinstall\": \"npx only-allow pnpm\",\n \"postinstall\": \"zx bin/postinstall.mjs\",\n \"build\": \"zx bin/build.mjs\",\n \"test\": \"zx bin/test.mjs\",\n \"dev\": \"zx bin/dev.mjs\",\n \"cleans\": \"zx bin/cleans.mjs\",\n \"publish\": \"zx bin/publish.mjs\",\n \"docs:dev\": \"vitepress dev docs\",\n \"docs:build\": \"vitepress build docs\",\n \"docs:serve\": \"vitepress serve docs\"\n },\n \"devDependencies\": {\n \"@antfu/eslint-config\": \"^2.4.6\",\n \"@graphql-inspector/core\": \"^5.0.2\",\n \"@graphql-tools/schema\": \"^10.0.2\",\n \"@prisma/client\": \"^5.7.1\",\n \"@types/lodash\": \"^4.14.202\",\n \"@types/node\": \"^20.10.5\",\n \"@zerollup/ts-transform-paths\": \"^1.7.18\",\n \"all-contributors-cli\": \"^6.26.1\",\n \"easygraphql-tester\": \"^6.0.1\",\n \"esbuild\": \"^0.19.10\",\n \"eslint\": \"^8.56.0\",\n \"graphql\": \"16.8.1\",\n \"listr\": \"^0.14.3\",\n \"lodash\": \"^4.17.21\",\n \"pluralize\": \"^8.0.0\",\n \"prisma\": \"^5.7.1\",\n \"prompts\": \"^2.4.2\",\n \"sass\": \"^1.69.5\",\n \"ts-node\": \"^10.9.2\",\n \"tsconfig-paths\": \"^4.2.0\",\n \"typescript\": \"^5.3.3\",\n \"vite\": \"^5.0.10\",\n \"vite-tsconfig-paths\": \"^4.2.2\",\n \"vitepress\": \"1.0.0-rc.32\",\n \"vitest\": \"^1.1.0\"\n }\n}\n" }, { "path": "packages/boilerplate/cdk/package.json", "content": "{\n \"name\": \"prisma-appsync-cdk\",\n \"version\": \"1.0.0\",\n \"description\": \"Sample AWS CDK template for Prisma-AppSync\",\n \"author\": \"maoosi \",\n \"private\": true,\n \"license\": \"BSD-2-Clause\",\n \"devDependencies\": {\n \"@types/js-yaml\": \"^4.0.5\",\n \"@types/node\": \"^20.4.8\",\n \"aws-cdk-lib\": \"^2.90.0\",\n \"constructs\": \"^10.2.69\",\n \"js-yaml\": \"^4.1.0\",\n \"scule\": \"^1.0.0\",\n \"ts-node\": \"^10.9.1\",\n \"typescript\": \"^5.1.6\"\n }\n}\n" }, { "path": "packages/boilerplate/cdk/src/appsync.ts", "content": "/* eslint-disable no-new */\nimport { readFileSync } from 'fs'\nimport type { Construct } from 'constructs'\nimport { camelCase, kebabCase, pascalCase } from 'scule'\nimport { load } from 'js-yaml'\nimport {\n Duration,\n RemovalPolicy,\n Stack,\n aws_appsync as appSync,\n aws_iam as iam,\n aws_lambda as lambda,\n aws_lambda_nodejs as lambdaNodejs,\n type StackProps\n} from 'aws-cdk-lib'\n\nexport interface AppSyncStackProps {\n resourcesPrefix: string\n cognitoUserPoolId?: string\n schema: string\n resolvers: string\n function: {\n code: string\n memorySize: number\n useWarmUp: number\n policies?: iam.PolicyStatementProps[]\n bundling?: lambdaNodejs.BundlingOptions\n environment?: {}\n }\n additionalApiKeys?: string[]\n authorizationConfig: appSync.AuthorizationConfig\n}\n\nexport class AppSyncStack extends Stack {\n private props: AppSyncStackProps\n private resourcesPrefix: string\n private resourcesPrefixCamel: string\n private graphqlApi: appSync.GraphqlApi\n private directResolverFn: lambda.Alias\n private apiRole: iam.Role\n private dataSources: {\n lambda?: appSync.LambdaDataSource\n none?: appSync.NoneDataSource\n }\n\n constructor(scope: Construct, id: string, tplProps: AppSyncStackProps, props?: StackProps) {\n super(scope, id, props)\n\n // stack naming convention\n this.props = tplProps\n this.resourcesPrefix = kebabCase(this.props.resourcesPrefix)\n this.resourcesPrefixCamel = camelCase(this.resourcesPrefix)\n\n this.createGraphQLApi()\n this.createLambdaResolver()\n this.createDataSources()\n this.createPrismaAppSyncResolvers()\n }\n\n createGraphQLApi() {\n // create appsync instance\n this.graphqlApi = new appSync.GraphqlApi(this, `${this.resourcesPrefixCamel}Api`, {\n name: this.resourcesPrefix,\n schema: appSync.SchemaFile.fromAsset(this.props.schema),\n authorizationConfig: this.props.authorizationConfig,\n logConfig: {\n fieldLogLevel: appSync.FieldLogLevel.ERROR,\n },\n xrayEnabled: true,\n })\n\n // create default API key\n new appSync.CfnApiKey(this, `${this.resourcesPrefixCamel}ApiKey`, {\n apiId: this.graphqlApi.apiId,\n description: `${this.resourcesPrefix}_api-key`,\n expires: Math.floor(new Date().setDate(new Date().getDate() + 365) / 1000.0),\n })\n\n // create additional API keys\n if (this.props.additionalApiKeys) {\n this.props.additionalApiKeys.forEach((apiKey: string) => {\n new appSync.CfnApiKey(this, `${this.resourcesPrefixCamel}ApiKey${pascalCase(apiKey)}`, {\n apiId: this.graphqlApi.apiId,\n description: `${this.resourcesPrefix}_api-key_${kebabCase(apiKey)}`,\n expires: Math.floor(new Date().setDate(new Date().getDate() + 365) / 1000.0),\n })\n })\n }\n }\n\n createLambdaResolver() {\n // create function execution role\n const lambdaExecutionRole = new iam.Role(this, `${this.resourcesPrefixCamel}FnExecRole`, {\n roleName: `${this.resourcesPrefix}_fn-exec-role`,\n assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),\n managedPolicies: [iam.ManagedPolicy.fromAwsManagedPolicyName('service-role/AWSLambdaBasicExecutionRole')],\n ...(this.props.function?.policies\n && this.props.function.policies.length > 0 && {\n inlinePolicies: {\n customApiFunctionPolicy: new iam.PolicyDocument({\n statements: this.props.function.policies.map((statement) => {\n return new iam.PolicyStatement(statement)\n }),\n }),\n },\n }),\n })\n\n // create lambda function datasource\n const lambdaFunction = new lambdaNodejs.NodejsFunction(this, `${this.resourcesPrefixCamel}Fn`, {\n functionName: `${this.resourcesPrefix}_fn`,\n role: lambdaExecutionRole,\n environment: this.props.function.environment || {},\n runtime: lambda.Runtime.NODEJS_18_X,\n timeout: Duration.seconds(10),\n handler: 'main',\n entry: this.props.function.code,\n memorySize: this.props.function.memorySize,\n tracing: lambda.Tracing.ACTIVE,\n currentVersionOptions: {\n removalPolicy: RemovalPolicy.RETAIN,\n retryAttempts: 2,\n },\n ...(this.props.function.bundling && {\n bundling: this.props.function.bundling,\n }),\n })\n\n // create alias (from latest version)\n this.directResolverFn = new lambda.Alias(this, `${this.resourcesPrefixCamel}_FnAliasLive`, {\n aliasName: 'live',\n version: lambdaFunction.currentVersion,\n ...(this.props.function.useWarmUp > 0 && {\n provisionedConcurrentExecutions: this.props.function.useWarmUp,\n }),\n })\n\n // create IAM role\n this.apiRole = new iam.Role(this, `${this.resourcesPrefixCamel}ApiRole`, {\n roleName: `${this.resourcesPrefix}_api-role`,\n assumedBy: new iam.ServicePrincipal('appsync.amazonaws.com'),\n inlinePolicies: {\n allowEc2DescribeNetworkInterfaces: new iam.PolicyDocument({\n statements: [\n new iam.PolicyStatement({\n actions: ['lambda:InvokeAsync', 'lambda:InvokeFunction'],\n resources: [this.directResolverFn.functionArn],\n }),\n ],\n }),\n },\n })\n }\n\n createPrismaAppSyncResolvers() {\n // read resolvers from yaml\n const resolvers = load(readFileSync(this.props.resolvers, 'utf8'))\n\n // create resolvers\n if (Array.isArray(resolvers)) {\n resolvers.forEach((resolver: any) => {\n const resolvername = `${resolver.fieldName}${resolver.typeName}_resolver`\n\n if (['lambda', 'prisma-appsync'].includes(resolver.dataSource) && this.dataSources.lambda) {\n new appSync.Resolver(this, resolvername, {\n api: this.graphqlApi,\n typeName: resolver.typeName,\n fieldName: resolver.fieldName,\n dataSource: this.dataSources.lambda,\n })\n }\n else if (resolver.dataSource === 'none' && this.dataSources.none) {\n new appSync.Resolver(this, resolvername, {\n api: this.graphqlApi,\n typeName: resolver.typeName,\n fieldName: resolver.fieldName,\n dataSource: this.dataSources.none,\n requestMappingTemplate: appSync.MappingTemplate.fromString(\n resolver.requestMappingTemplate,\n ),\n responseMappingTemplate: appSync.MappingTemplate.fromString(\n resolver.responseMappingTemplate,\n ),\n })\n }\n })\n }\n }\n\n createDataSources() {\n this.dataSources = {}\n\n // create datasource of type \"lambda\"\n this.dataSources.lambda = new appSync.LambdaDataSource(\n this,\n `${this.resourcesPrefixCamel}LambdaDatasource`,\n {\n api: this.graphqlApi,\n name: `${this.resourcesPrefixCamel}LambdaDataSource`,\n lambdaFunction: this.directResolverFn,\n serviceRole: this.apiRole,\n },\n )\n\n // create datasource of type \"none\"\n this.dataSources.none = new appSync.NoneDataSource(this, `${this.resourcesPrefixCamel}NoneDatasource`, {\n api: this.graphqlApi,\n name: `${this.resourcesPrefixCamel}NoneDataSource`,\n })\n }\n}\n" }, { "path": "packages/boilerplate/cdk/src/index.ts", "content": "/* eslint-disable no-new */\nimport { join } from 'path'\nimport { App } from 'aws-cdk-lib'\nimport { AuthorizationType } from 'aws-cdk-lib/aws-appsync'\nimport { kebabCase } from 'scule'\nimport { AppSyncStack } from './appsync'\n\nconst app = new App()\n\nnew AppSyncStack(app, kebabCase('{{ projectName }}'), {\n resourcesPrefix: '{{ projectName }}',\n schema: join(process.cwd(), '{{ relativeGqlSchemaPath }}'),\n resolvers: join(process.cwd(), '{{ relativeYmlResolversPath }}'),\n function: {\n code: join(process.cwd(), '{{ relativeHandlerPath }}'),\n memorySize: 1536,\n useWarmUp: 0, // useWarmUp > 0 will incur extra costs\n environment: {\n NODE_ENV: 'production',\n DATABASE_URL: process.env.DATABASE_URL,\n },\n bundling: {\n minify: true,\n sourceMap: true,\n forceDockerBundling: true,\n commandHooks: {\n beforeBundling(inputDir: string, outputDir: string): string[] {\n return [`cp ${inputDir}/{{ relativePrismaSchemaPath }} ${outputDir}`]\n },\n beforeInstall() {\n return []\n },\n afterBundling() {\n return [\n 'npx prisma generate',\n 'rm -rf generated',\n\n // npm + yarn 1.x\n 'rm -rf node_modules/@prisma/engines',\n 'rm -rf node_modules/@prisma/client/node_modules',\n 'rm -rf node_modules/.bin',\n 'rm -rf node_modules/prisma',\n 'rm -rf node_modules/prisma-appsync',\n ]\n },\n },\n nodeModules: ['prisma', '@prisma/client'],\n environment: {\n NODE_ENV: 'production',\n },\n },\n },\n authorizationConfig: {\n defaultAuthorization: {\n authorizationType: AuthorizationType.API_KEY,\n },\n },\n})\n\napp.synth()\n" }, { "path": "packages/boilerplate/cdk/tsconfig.json", "content": "{\n \"compilerOptions\": {\n \"target\": \"ES2018\",\n \"module\": \"commonjs\",\n \"lib\": [\"es2016\", \"es2017.object\", \"es2017.string\"],\n \"strict\": true,\n \"noImplicitAny\": true,\n \"strictNullChecks\": true,\n \"noImplicitThis\": true,\n \"alwaysStrict\": true,\n \"noUnusedLocals\": true,\n \"noUnusedParameters\": true,\n \"noImplicitReturns\": true,\n \"noFallthroughCasesInSwitch\": false,\n \"inlineSourceMap\": true,\n \"inlineSources\": true,\n \"experimentalDecorators\": true,\n \"strictPropertyInitialization\": false\n }\n}\n" }, { "path": "packages/boilerplate/cdk.json", "content": "{\n \"app\": \"npx ts-node --prefer-ts-exts cdk/src/index.ts\"\n}" }, { "path": "packages/boilerplate/handler.ts", "content": "import type { AppSyncResolverEvent } from './prisma/generated/prisma-appsync/client'\nimport { PrismaAppSync } from './prisma/generated/prisma-appsync/client'\n\n// Instantiate Prisma-AppSync Client\nconst prismaAppSync = new PrismaAppSync()\n\n// Lambda handler (AppSync Direct Lambda Resolver)\nexport const main = async (event: AppSyncResolverEvent) => {\n return await prismaAppSync.resolve({ event })\n}\n" }, { "path": "packages/boilerplate/prisma/sqlite.prisma", "content": "datasource db {\n provider = \"sqlite\"\n url = env(\"DATABASE_URL\")\n}\n\ngenerator client {\n provider = \"prisma-client-js\"\n binaryTargets = [\"native\", \"rhel-openssl-1.0.x\"]\n}\n\ngenerator appsync {\n provider = \"prisma-appsync\"\n}\n\n/// @gql(fields: { passwordHash: null })\nmodel User {\n id Int @id @default(autoincrement())\n email String @unique\n passwordHash String\n posts Post[]\n createdAt DateTime @default(now())\n}\n\n/// @gql(scalars: { source: \"AWSURL\" })\nmodel Post {\n id Int @id @default(autoincrement())\n title String\n source String?\n author User? @relation(fields: [authorId], references: [id])\n authorId Int?\n updatedAt DateTime @updatedAt\n createdAt DateTime @default(now())\n}\n" }, { "path": "packages/boilerplate/server/server.ts", "content": "import { join } from 'path'\nimport { readFileSync } from 'fs'\nimport { load } from 'js-yaml'\nimport { argv, createServer } from 'prisma-appsync/dist/server'\n\n(async () => {\n const schema = readFileSync(join(process.cwd(), argv.flags.schema), { encoding: 'utf-8' })\n const lambdaHandler = await import(join(process.cwd(), argv.flags.handler))\n const resolvers = load(readFileSync(join(process.cwd(), argv.flags.resolvers), { encoding: 'utf-8' }))\n const port = argv.flags.port\n const wsPort = argv.flags.wsPort\n const watchers = argv.flags.watchers ? JSON.parse(argv.flags.watchers) : []\n\n createServer({\n schema,\n lambdaHandler,\n resolvers,\n port,\n wsPort,\n watchers,\n })\n})()\n" }, { "path": "packages/boilerplate/tsconfig.json", "content": "{\n \"$schema\": \"https://json.schemastore.org/tsconfig\",\n \"display\": \"Default\",\n \"compilerOptions\": {\n \"target\": \"ES2018\",\n \"module\": \"commonjs\",\n \"lib\": [\"es2018\"],\n \"declaration\": false,\n \"strict\": true,\n \"noImplicitAny\": false,\n \"strictNullChecks\": true,\n \"noImplicitThis\": true,\n \"alwaysStrict\": true,\n \"noUnusedLocals\": false,\n \"noImplicitReturns\": true,\n \"noFallthroughCasesInSwitch\": false,\n \"inlineSourceMap\": true,\n \"inlineSources\": true,\n \"esModuleInterop\": true,\n \"experimentalDecorators\": true,\n \"strictPropertyInitialization\": false,\n \"baseUrl\": \".\"\n },\n \"include\": [\"**/*.ts\", \"**/*.tsx\"],\n \"exclude\": [\"node_modules\"]\n}\n" }, { "path": "packages/client/package.json", "content": "{\n \"name\": \"prisma-appsync-client\",\n \"private\": true,\n \"version\": \"1.0.0\",\n \"author\": \"maoosi \",\n \"license\": \"BSD-2-Clause\",\n \"devDependencies\": {\n \"@types/aws-lambda\": \"^8.10.126\",\n \"@types/micromatch\": \"^4.0.5\",\n \"deepmerge\": \"^4.3.1\",\n \"html-entities\": \"^2.4.0\",\n \"lambda-rate-limiter\": \"^4.0.0\",\n \"micromatch\": \"^4.0.5\",\n \"wild-wild-path\": \"^4.0.0\",\n \"wild-wild-utils\": \"^5.0.0\",\n \"xss\": \"^1.0.14\"\n }\n}\n" }, { "path": "packages/client/src/adapter.ts", "content": "import { CustomError } from './inspector'\nimport { sanitize } from './guard'\nimport {\n clone,\n isEmpty,\n isObject,\n isUndefined,\n lowerFirst,\n merge,\n objectToPaths,\n uniq,\n walk,\n} from './utils'\nimport type {\n Action,\n ActionsAlias,\n AppSyncEvent,\n Authorization,\n Context,\n GraphQLType,\n Identity,\n Model,\n Options,\n PrismaArgs,\n QueryParams,\n} from './types'\nimport {\n Actions,\n ActionsAliasesList,\n Authorizations,\n BatchActionsList,\n Prisma_ReservedKeysForPaths,\n} from './consts'\n\n/**\n * #### Parse AppSync direct resolver `event` and returns Query Params.\n *\n * @param {AppSyncEvent} appsyncEvent - AppSync event received in Lambda.\n * @param {Required} options - PrismaAppSync Client options.\n * @param {any|null} customResolvers? - Custom Resolvers.\n * @returns `{ type, operation, context, fields, paths, args, prismaArgs, authorization, identity }` - QueryParams\n */\nexport async function parseEvent(appsyncEvent: AppSyncEvent, options: Options, customResolvers?: any | null): Promise {\n if (\n isEmpty(appsyncEvent?.info?.fieldName)\n || isUndefined(appsyncEvent?.info?.selectionSetList)\n || isEmpty(appsyncEvent?.info?.parentTypeName)\n || isUndefined(appsyncEvent?.arguments)\n )\n throw new CustomError('Error reading required parameters from appsyncEvent.', { type: 'INTERNAL_SERVER_ERROR' })\n\n const operation = getOperation({ fieldName: appsyncEvent.info.fieldName })\n\n const context = getContext({ customResolvers, options, operation })\n\n const { identity, authorization } = getAuthIdentity({\n appsyncEvent,\n })\n\n const fields = getFields({\n _selectionSetList: appsyncEvent.info.selectionSetList,\n })\n const sanitizedArgs = options.sanitize\n ? await sanitize(await addNullables(appsyncEvent.arguments))\n : await addNullables(appsyncEvent.arguments)\n\n const args = clone(sanitizedArgs)\n\n const prismaArgs = getPrismaArgs({\n action: context.action,\n defaultPagination: options.defaultPagination,\n _arguments: clone(sanitizedArgs),\n _selectionSetList: appsyncEvent.info.selectionSetList,\n })\n\n const type = getType({\n _parentTypeName: appsyncEvent.info.parentTypeName,\n })\n\n const paths = getPaths({\n operation,\n context,\n prismaArgs,\n })\n\n const headers = appsyncEvent?.request?.headers || {}\n\n return {\n operation,\n context,\n fields,\n args,\n prismaArgs,\n type,\n authorization,\n identity,\n paths,\n headers,\n }\n}\n\n/**\n * #### Convert `is: NULL` and `isNot: NULL` to `is: null` and `isNot: null`\n *\n * @param {any} data\n * @returns any\n */\nexport async function addNullables(data: any): Promise {\n return await walk(data, async ({ key, value }, node) => {\n if (key === 'is' || key === 'isNot') {\n value = value === 'NULL' ? null : undefined\n\n node.ignoreChilds()\n }\n else if (value && isObject(value) && Object.keys(value).includes('isNull')) {\n const { isNull, ...val } = value as any\n\n if (isNull === true)\n value = { ...val, equals: null }\n else\n value = { ...val, not: null }\n\n node.ignoreChilds()\n }\n return { key, value }\n })\n}\n\n/**\n * #### Returns authorization and identity.\n *\n * @param {any} options\n * @param {AppSyncEvent} options.appsyncEvent - AppSync event received in Lambda.\n * @returns `{ authorization, identity }`\n *\n * https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference.html#aws-appsync-resolver-context-reference-identity\n */\nexport function getAuthIdentity({ appsyncEvent }: { appsyncEvent: AppSyncEvent }): {\n identity: Identity\n authorization: Authorization\n} {\n let authorization: Authorization = null\n let identity: Identity = null\n\n // API_KEY authorization\n if (isEmpty(appsyncEvent?.identity)) {\n authorization = Authorizations.API_KEY\n identity = {\n ...(appsyncEvent?.request?.headers\n && typeof appsyncEvent.request.headers['x-api-key'] !== 'undefined' && {\n requestApiKey: appsyncEvent.request.headers['x-api-key'],\n }),\n ...(appsyncEvent?.request?.headers\n && typeof appsyncEvent.request.headers['user-agent'] !== 'undefined' && {\n requestUserAgent: appsyncEvent.request.headers['user-agent'],\n }),\n }\n }\n // AWS_LAMBDA authorization\n else if (appsyncEvent?.identity && typeof (appsyncEvent.identity as any).resolverContext !== 'undefined') {\n authorization = Authorizations.AWS_LAMBDA\n identity = appsyncEvent.identity\n }\n // AWS_IAM authorization\n else if (\n appsyncEvent?.identity\n && typeof (appsyncEvent.identity as any).cognitoIdentityAuthType !== 'undefined'\n && typeof (appsyncEvent.identity as any).cognitoIdentityAuthProvider !== 'undefined'\n && typeof (appsyncEvent.identity as any).cognitoIdentityPoolId !== 'undefined'\n && typeof (appsyncEvent.identity as any).cognitoIdentityId !== 'undefined'\n ) {\n authorization = Authorizations.AWS_IAM\n identity = appsyncEvent.identity\n }\n // AMAZON_COGNITO_USER_POOLS authorization\n else if (\n appsyncEvent?.identity\n && typeof (appsyncEvent.identity as any).sub !== 'undefined'\n && typeof (appsyncEvent.identity as any).issuer !== 'undefined'\n && typeof (appsyncEvent.identity as any).username !== 'undefined'\n && typeof (appsyncEvent.identity as any).claims !== 'undefined'\n && typeof (appsyncEvent.identity as any).sourceIp !== 'undefined'\n ) {\n authorization = Authorizations.AMAZON_COGNITO_USER_POOLS\n identity = appsyncEvent.identity\n }\n // OPENID_CONNECT authorization\n else if (\n appsyncEvent?.identity\n && typeof (appsyncEvent.identity as any).sub !== 'undefined'\n && typeof (appsyncEvent.identity as any).issuer !== 'undefined'\n && typeof (appsyncEvent.identity as any).claims !== 'undefined'\n ) {\n authorization = Authorizations.OPENID_CONNECT\n identity = appsyncEvent.identity\n }\n // ERROR\n else {\n throw new CustomError('Couldn\\'t detect caller identity.', {\n type: 'INTERNAL_SERVER_ERROR',\n })\n }\n\n return { authorization, identity }\n}\n\n/**\n * #### Returns context (`action`, `alias` and `model`).\n *\n * @param {any} options\n * @param {any|null} options.customResolvers\n * @param {string} options.operation\n * @param {Options} options.options\n * @returns Context\n */\nexport function getContext({\n customResolvers,\n operation,\n options,\n}: {\n customResolvers?: any | null\n operation: string\n options: Options\n}): Context {\n const context: Context = {\n action: String(),\n alias: null,\n model: null,\n }\n\n if (customResolvers && typeof customResolvers[operation] !== 'undefined') {\n context.action = operation\n context.alias = 'custom'\n context.model = null\n }\n else {\n context.action = getAction({ operation })\n context.model = getModel({ operation, action: context.action, options })\n context.alias = getActionAlias({ action: context.action })\n }\n\n return context\n}\n\n/**\n * #### Returns operation (`getPost`, `listUsers`, ..).\n *\n * @param {any} options\n * @param {string} options.fieldName\n * @returns Operation\n */\nexport function getOperation({ fieldName }: { fieldName: string }): string {\n const operation = fieldName\n\n if (!(operation.length > 0))\n throw new CustomError('Error parsing \\'operation\\' from input event.', { type: 'INTERNAL_SERVER_ERROR' })\n\n return operation\n}\n\n/**\n * #### Returns action (`get`, `list`, `create`, ...).\n *\n * @param {any} options\n * @param {string} options.operation\n * @returns Action\n */\nexport function getAction({ operation }: { operation: string }): Action {\n const actionsList = Object.keys(Actions).sort().reverse()\n\n const action = actionsList.find((action: Action) => {\n return operation.toLowerCase().startsWith(String(action).toLowerCase())\n }) as Action\n\n if (!(typeof action !== 'undefined' && String(action).length > 0)) {\n throw new CustomError(\n 'Error parsing \\'action\\' from input event. If you are trying to query a custom resolver, make sure it is properly declared inside \\'prismaAppSync.resolve({ event, resolvers: { /* HERE */ } })\\'.',\n { type: 'INTERNAL_SERVER_ERROR' },\n )\n }\n\n return action\n}\n\n/**\n * #### Returns action alias (`access`, `create`, `modify`, `subscribe`).\n *\n * @param {any} options\n * @param {Action} options.action\n * @returns ActionsAlias\n */\nexport function getActionAlias({ action }: { action: Action }): ActionsAlias {\n let actionAlias: ActionsAlias = null\n\n for (const alias in ActionsAliasesList) {\n const actionsList = ActionsAliasesList[alias]\n\n if (actionsList.includes(action)) {\n actionAlias = alias as ActionsAlias\n break\n }\n }\n\n if (!(typeof action !== 'undefined' && String(action).length > 0))\n throw new CustomError('Error parsing \\'actionAlias\\' from input event.', { type: 'INTERNAL_SERVER_ERROR' })\n\n return actionAlias\n}\n\n/**\n * #### Returns model (`Post`, `User`, ...).\n *\n * @param {any} options\n * @param {string} options.operation\n * @param {Action} options.action\n * @param {Options} options.options\n * @returns Model\n */\nexport function getModel(\n { operation, action, options }:\n { operation: string; action: Action; options: Options },\n): Model {\n const actionModel = operation.replace(String(action), '')\n\n if (!(actionModel.length > 0))\n throw new CustomError('Error parsing \\'model\\' from input event.', { type: 'INTERNAL_SERVER_ERROR' })\n\n const model = options?.modelsMapping?.[actionModel]\n\n if (!model) {\n throw new CustomError(`Resolver \"${actionModel}\" not found. If it's a custom resolver, please ensure it's available within your Lambda function.`, {\n type: 'INTERNAL_SERVER_ERROR',\n })\n }\n\n return model\n}\n\n/**\n * #### Returns fields (`title`, `author`, ...).\n *\n * @param {any} options\n * @param {string[]} options._selectionSetList\n * @returns string[]\n */\nexport function getFields({ _selectionSetList }: { _selectionSetList: string[] }): string[] {\n const fields: string[] = []\n\n _selectionSetList.forEach((item: string) => {\n const field = item.split('/')[0]\n if (!fields.includes(field) && !field.startsWith('__'))\n fields.push(item)\n })\n\n return fields\n}\n\n/**\n * #### Returns GraphQL type (`Query`, `Mutation` or `Subscription`).\n *\n * @param {any} options\n * @param {string} options._parentTypeName\n * @returns GraphQLType\n */\nexport function getType({ _parentTypeName }: { _parentTypeName: string }): GraphQLType {\n const type = _parentTypeName\n\n if (!['Query', 'Mutation', 'Subscription'].includes(type))\n throw new CustomError('Error parsing \\'type\\' from input event.', { type: 'INTERNAL_SERVER_ERROR' })\n\n return type as GraphQLType\n}\n\n/**\n * #### Returns Prisma args (`where`, `data`, `orderBy`, ...).\n *\n * @param {any} options\n * @param {Action} options.action\n * @param {Options['defaultPagination']} options.defaultPagination\n * @param {any} options._arguments\n * @param {any} options._selectionSetList\n * @returns PrismaArgs\n */\nexport function getPrismaArgs({\n action,\n defaultPagination,\n _arguments,\n _selectionSetList,\n}: {\n action: Action\n defaultPagination: Options['defaultPagination']\n _arguments: any\n _selectionSetList: any\n}): PrismaArgs {\n const prismaArgs: PrismaArgs = {}\n\n if (typeof _arguments.data !== 'undefined' && typeof _arguments.operation !== 'undefined') {\n throw new CustomError('Using \\'data\\' and \\'operation\\' together is not possible.', {\n type: 'BAD_USER_INPUT',\n })\n }\n\n if (typeof _arguments.data !== 'undefined')\n prismaArgs.data = _arguments.data\n else if (typeof _arguments.operation !== 'undefined')\n prismaArgs.data = _arguments.operation\n\n if (typeof _arguments.create !== 'undefined')\n prismaArgs.create = _arguments.create\n if (typeof _arguments.update !== 'undefined')\n prismaArgs.update = _arguments.update\n if (typeof _arguments.where !== 'undefined')\n prismaArgs.where = _arguments.where\n if (typeof _arguments.orderBy !== 'undefined')\n prismaArgs.orderBy = parseOrderBy(_arguments.orderBy)\n if (typeof _arguments.skipDuplicates !== 'undefined')\n prismaArgs.skipDuplicates = _arguments.skipDuplicates\n\n if (typeof _selectionSetList !== 'undefined')\n prismaArgs.select = parseSelectionList(_selectionSetList)\n\n if (isEmpty(prismaArgs.select))\n delete prismaArgs.select\n\n if (typeof _arguments.skip !== 'undefined')\n prismaArgs.skip = Number.parseInt(_arguments.skip)\n else if (defaultPagination !== false && action === Actions.list)\n prismaArgs.skip = 0\n\n if (typeof _arguments.take !== 'undefined')\n prismaArgs.take = Number.parseInt(_arguments.take)\n else if (defaultPagination !== false && action === Actions.list)\n prismaArgs.take = defaultPagination\n\n return prismaArgs\n}\n\n/**\n * #### Returns individual `orderBy` record formatted for Prisma.\n *\n * @param {any} sortObj\n * @returns any\n */\nfunction getOrderBy(sortObj: any): any {\n if (Object.keys(sortObj).length > 1)\n throw new CustomError('Wrong \\'orderBy\\' input format.', { type: 'BAD_USER_INPUT' })\n\n const key: any = Object.keys(sortObj)[0]\n const value = typeof sortObj[key] === 'object' ? getOrderBy(sortObj[key]) : sortObj[key].toLowerCase()\n\n return { [key]: value }\n}\n\n/**\n * #### Returns Prisma `orderBy` from parsed `event.arguments.orderBy`.\n *\n * @param {any} orderByInputs\n * @returns any[]\n */\nfunction parseOrderBy(orderByInputs: any): any[] {\n const orderByOutput: any = []\n const orderByInputsArray = Array.isArray(orderByInputs) ? orderByInputs : [orderByInputs]\n\n orderByInputsArray.forEach((orderByInput: any) => {\n orderByOutput.push(getOrderBy(orderByInput))\n })\n\n return orderByOutput\n}\n\n/**\n * #### Returns individual `include` field formatted for Prisma.\n *\n * @param {any} parts\n * @returns any\n */\nfunction getInclude(parts: any): any {\n const field = parts[0]\n const value = parts.length > 1 ? getSelect(parts.splice(1)) : true\n\n return {\n include: {\n [field]: value,\n },\n }\n}\n\n/**\n * #### Returns individual `select` field formatted for Prisma.\n *\n * @param {any} parts\n * @returns any\n */\nfunction getSelect(parts: any): any {\n const field = parts[0]\n const value = parts.length > 1 ? getSelect(parts.splice(1)) : true\n\n return {\n select: {\n [field]: value,\n },\n }\n}\n\n/**\n * #### Return Prisma `select` from parsed `event.arguments.info.selectionSetList`.\n *\n * @param {any} selectionSetList\n * @returns any\n */\nfunction parseSelectionList(selectionSetList: any): any {\n let prismaArgs: any = { select: {} }\n\n for (let i = 0; i < selectionSetList.length; i++) {\n const path = selectionSetList[i]\n const parts = path.split('/')\n\n if (!parts.includes('__typename')) {\n if (parts.length > 1)\n prismaArgs = merge(prismaArgs, getInclude(parts))\n else\n prismaArgs = merge(prismaArgs, getSelect(parts))\n }\n }\n\n if (prismaArgs.include) {\n for (const include in prismaArgs.include) {\n if (typeof prismaArgs.select[include] !== 'undefined')\n delete prismaArgs.select[include]\n }\n\n prismaArgs.select = merge(prismaArgs.select, prismaArgs.include)\n delete prismaArgs.include\n }\n\n return typeof prismaArgs.select !== 'undefined' ? prismaArgs.select : {}\n}\n\n/**\n * #### Returns req and res paths (`updatePost/title`, `getPost/date`, ..).\n *\n * @param {any} options\n * @param {string} options.operation\n * @param {Context} options.context\n * @param {PrismaArgs} options.prismaArgs\n * @returns string[]\n */\nexport function getPaths({\n operation,\n context,\n prismaArgs,\n}: {\n operation: string\n context: Context\n prismaArgs: PrismaArgs\n}): string[] {\n const paths: string[] = [\n operation,\n ...objectToPaths({\n ...(prismaArgs?.data && {\n data: prismaArgs.data,\n }),\n ...(prismaArgs?.select && {\n select: prismaArgs.select,\n }),\n }),\n ]\n\n paths.forEach((path: string, index: number) => {\n if (path.startsWith('data')) {\n paths[index] = path.replace('data', operation)\n }\n\n else if (path.startsWith('select')) {\n const action = BatchActionsList.includes(context.action) ? Actions.list : Actions.get\n if (context.model !== null) {\n const model = action === Actions.list ? context.model.plural : context.model.singular\n paths[index] = path.replace('select', `${lowerFirst(action)}${model}`)\n }\n else {\n paths[index] = path.replace('select', operation)\n }\n }\n })\n\n return uniq(\n paths.map(\n (path: string) => path\n .split('/')\n .filter(k => !Prisma_ReservedKeysForPaths.includes(k))\n .join('/'),\n ).filter(Boolean),\n )\n}\n" }, { "path": "packages/client/src/consts.ts", "content": "import type { Action } from './types'\nimport { uniq } from './utils'\n\n// Enums\n\nexport enum Actions {\n // queries\n get = 'get',\n list = 'list',\n count = 'count',\n\n // mutations (multiple)\n createMany = 'createMany',\n updateMany = 'updateMany',\n deleteMany = 'deleteMany',\n\n // mutations (single)\n create = 'create',\n update = 'update',\n upsert = 'upsert',\n delete = 'delete',\n\n // subscriptions (multiple)\n onCreatedMany = 'onCreatedMany',\n onUpdatedMany = 'onUpdatedMany',\n onDeletedMany = 'onDeletedMany',\n onMutatedMany = 'onMutatedMany',\n\n // subscriptions (single)\n onCreated = 'onCreated',\n onUpdated = 'onUpdated',\n onUpserted = 'onUpserted',\n onDeleted = 'onDeleted',\n onMutated = 'onMutated',\n}\n\nexport enum ActionsAliases {\n access = 'access',\n batchAccess = 'batchAccess',\n create = 'create',\n batchCreate = 'batchCreate',\n delete = 'delete',\n batchDelete = 'batchDelete',\n modify = 'modify',\n batchModify = 'batchModify',\n subscribe = 'subscribe',\n batchSubscribe = 'batchSubscribe',\n}\n\n/**\n * ### Authorizations\n *\n * - `API_KEY`: Via hard-coded API key passed into `x-api-key` header.\n * - `AWS_IAM`: Via IAM identity and associated IAM policy rules.\n * - `AMAZON_COGNITO_USER_POOLS`: Via Amazon Cognito user token.\n * - `AWS_LAMBDA`: Via an AWS Lambda function.\n * - `OPENID_CONNECT`: Via Open ID connect such as Auth0.\n *\n * https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html\n */\nexport enum Authorizations {\n API_KEY = 'API_KEY',\n AWS_IAM = 'AWS_IAM',\n AMAZON_COGNITO_USER_POOLS = 'AMAZON_COGNITO_USER_POOLS',\n AWS_LAMBDA = 'AWS_LAMBDA',\n OPENID_CONNECT = 'OPENID_CONNECT',\n}\n\n// Consts\n\nexport const Prisma_QueryOptions = [\n 'where', 'data', 'select', 'orderBy', 'include', 'distinct',\n]\n\nexport const Prisma_NestedQueries = [\n 'create', 'createMany', 'set', 'connect', 'connectOrCreate', 'disconnect', 'update', 'upsert', 'delete', 'updateMany', 'deleteMany',\n]\n\nexport const Prisma_FilterConditionsAndOperatos = [\n 'equals', 'not', 'in', 'notIn', 'lt', 'lte', 'gt', 'gte', 'contains', 'search', 'mode', 'startsWith', 'endsWith', 'AND', 'OR', 'NOT',\n]\n\nexport const Prisma_FilterRelationFilters = [\n 'some', 'every', 'none', 'is', 'isNot',\n]\n\nexport const Prisma_ScalarListMethods = [\n 'set', 'push', 'unset',\n]\n\nexport const Prisma_ScalarListFilters = [\n 'has', 'hasEvery', 'hasSome', 'isEmpty', 'isSet', 'equals',\n]\n\nexport const Prisma_CompositeTypeMethods = [\n 'set', 'unset', 'update', 'upsert', 'push',\n]\n\nexport const Prisma_CompositeTypeFilters = [\n 'equals', 'is', 'isNot', 'isEmpty', 'every', 'some', 'none',\n]\n\nexport const Prisma_AtomicNumberOperations = [\n 'increment', 'decrement', 'multiply', 'divide', 'set',\n]\n\nexport const Prisma_JSONFilters = [\n 'path', 'string_contains', 'string_starts_with', 'string_ends_with', 'array_contains', 'array_starts_with', 'array_ends_with',\n]\n\nexport const Prisma_ReservedKeysForPaths = uniq([\n ...Prisma_QueryOptions,\n ...Prisma_FilterConditionsAndOperatos,\n ...Prisma_FilterRelationFilters,\n ...Prisma_ScalarListFilters,\n ...Prisma_CompositeTypeFilters,\n ...Prisma_JSONFilters,\n])\n\nexport const Prisma_ReservedKeys = uniq([\n ...Prisma_QueryOptions,\n ...Prisma_NestedQueries,\n ...Prisma_FilterConditionsAndOperatos,\n ...Prisma_FilterRelationFilters,\n ...Prisma_ScalarListMethods,\n ...Prisma_ScalarListFilters,\n ...Prisma_CompositeTypeMethods,\n ...Prisma_CompositeTypeFilters,\n ...Prisma_AtomicNumberOperations,\n ...Prisma_JSONFilters,\n])\n\nexport const ActionsAliasesList = {\n access: [Actions.get, Actions.list, Actions.count],\n batchAccess: [Actions.list, Actions.count],\n create: [Actions.create, Actions.createMany],\n batchCreate: [Actions.createMany],\n modify: [Actions.upsert, Actions.update, Actions.updateMany, Actions.delete, Actions.deleteMany],\n batchModify: [Actions.updateMany, Actions.deleteMany],\n delete: [Actions.delete, Actions.deleteMany],\n batchDelete: [Actions.deleteMany],\n subscribe: [\n Actions.onCreatedMany,\n Actions.onUpdatedMany,\n Actions.onDeletedMany,\n Actions.onMutatedMany,\n Actions.onCreated,\n Actions.onUpdated,\n Actions.onUpserted,\n Actions.onDeleted,\n Actions.onMutated,\n ],\n batchSubscribe: [Actions.onCreatedMany, Actions.onUpdatedMany, Actions.onDeletedMany, Actions.onMutatedMany],\n} as const\n\nlet actionsListMultiple: Action[] = []\nlet actionsListSingle: Action[] = []\n\nfor (const actionAlias in ActionsAliasesList) {\n if (actionAlias.startsWith('batch'))\n actionsListMultiple = actionsListMultiple.concat(ActionsAliasesList[actionAlias])\n\n else\n actionsListSingle = actionsListSingle.concat(ActionsAliasesList[actionAlias])\n}\n\nexport const ActionsList = actionsListSingle.filter((item, pos) => actionsListSingle.indexOf(item) === pos)\n\nexport const BatchActionsList = actionsListMultiple.filter((item, pos) => actionsListMultiple.indexOf(item) === pos)\n\nexport const DebugTestingKey = '__prismaAppsync'\n" }, { "path": "packages/client/src/core.ts", "content": "/* eslint-disable @typescript-eslint/ban-types */\n/* eslint-disable no-restricted-globals */\n/* eslint-disable n/prefer-global/process */\nimport type {\n AfterHookParams,\n InjectedConfig,\n Options,\n PrismaAppSyncOptionsType,\n ResolveParams,\n Shield,\n ShieldAuthorization,\n} from './types'\nimport {\n Prisma,\n PrismaClient,\n} from './types'\nimport {\n BatchActionsList,\n DebugTestingKey,\n} from './consts'\nimport { CustomError, log, parseError } from './inspector'\nimport {\n clarify,\n getDepth,\n getShieldAuthorization,\n preventDOS,\n runHooks,\n} from './guard'\nimport { parseEvent } from './adapter'\nimport { isEmpty, omit } from './utils'\nimport { prismaQueryJoin } from './resolver'\nimport * as queries from './resolver'\n\n/**\n * ## Auto-injected at generation time\n */\n// eslint-disable-next-line spaced-comment\nconst injectedConfig: InjectedConfig = {} //! inject:config\n\n/**\n * ## Prisma-AppSync Client Κ²Λ’\n *\n * Type-safe Prisma AppSync client for TypeScript & Node.js\n * @example\n * ```\n * const prismaAppSync = new PrismaAppSync()\n *\n * // lambda handler (AppSync Direct Lambda Resolver)\n * export const resolver = async (event: any, context: any) => {\n * return await prismaAppSync.resolve({ event })\n * }\n * ```\n *\n *\n * Read more in our [docs](https://prisma-appsync.vercel.app).\n */\nexport class PrismaAppSync {\n public options: Options\n public prismaClient: PrismaClient\n\n /**\n * ### Client Constructor\n *\n * Instantiate Prisma-AppSync Client.\n * @example\n * ```\n * const prismaAppSync = new PrismaAppSync()\n * ```\n *\n * @param {PrismaAppSyncOptionsType} options\n * @param {string} options.connectionString? - Prisma connection string (database connection URL).\n * @param {boolean} options.sanitize? - Enable sanitize inputs (parse xss + encode html).\n * @param {'INFO' | 'WARN' | 'ERROR'} options.logLevel? - Server logs level (visible in CloudWatch).\n * @param {number|false} options.defaultPagination? - Default pagination for list Query (items per page).\n * @param {number} options.maxDepth? - Maximum allowed GraphQL query depth.\n * @param {number} options.maxReqPerUserMinute? - Maximum allowed requests per user, per minute.\n *\n * @default\n * ```\n * {\n * connectionString: process.env.DATABASE_URL,\n * sanitize: true,\n * logLevel: 'INFO',\n * defaultPagination: 50,\n * maxDepth: 4,\n * maxReqPerUserMinute: 200\n * }\n * ```\n *\n *\n * Read more in our [docs](https://prisma-appsync.vercel.app).\n */\n constructor(options?: PrismaAppSyncOptionsType) {\n // Set ENV variable DATABASE_URL if connectionString option is set\n if (typeof options?.connectionString !== 'undefined')\n process.env.DATABASE_URL = options.connectionString\n\n // Set client options using constructor options\n this.options = {\n modelsMapping: {},\n fieldsMapping: {},\n connectionString: String(process.env.DATABASE_URL),\n sanitize:\n typeof options?.sanitize !== 'undefined'\n ? options.sanitize\n : true,\n logLevel:\n typeof options?.logLevel !== 'undefined'\n ? options.logLevel\n : 'INFO',\n defaultPagination:\n typeof options?.defaultPagination !== 'undefined'\n ? options.defaultPagination\n : 50,\n maxDepth:\n typeof options?.maxDepth !== 'undefined'\n ? options.maxDepth\n : 4,\n maxReqPerUserMinute:\n typeof options?.maxReqPerUserMinute !== 'undefined'\n ? options.maxReqPerUserMinute\n : 200,\n }\n\n this.options.modelsMapping = {}\n\n // Read injected config\n if (injectedConfig?.modelsMapping) {\n this.options.modelsMapping = injectedConfig.modelsMapping\n }\n else if (process?.env?.PRISMA_APPSYNC_INJECTED_CONFIG) {\n try {\n this.options.modelsMapping = JSON.parse(\n process.env.PRISMA_APPSYNC_INJECTED_CONFIG,\n ).modelsMapping\n }\n catch {}\n }\n if (injectedConfig?.fieldsMapping) {\n this.options.fieldsMapping = injectedConfig.fieldsMapping\n }\n else if (process?.env?.PRISMA_APPSYNC_INJECTED_CONFIG) {\n try {\n this.options.fieldsMapping = JSON.parse(\n process.env.PRISMA_APPSYNC_INJECTED_CONFIG,\n ).fieldsMapping\n }\n catch {}\n }\n\n // Make sure injected config isn't empty\n if (Object.keys(this.options.modelsMapping).length === 0) {\n throw new CustomError('Issue with auto-injected models mapping config.', {\n type: 'INTERNAL_SERVER_ERROR',\n })\n }\n\n // Set ENV variable for log level\n process.env.PRISMA_APPSYNC_LOG_LEVEL = this.options.logLevel\n\n // Debug logs\n\n // eslint-disable-next-line unused-imports/no-unused-vars\n const { fieldsMapping, ...newInstanceLogs } = this.options\n log('New Prisma-AppSync instance created:', newInstanceLogs)\n\n // Prisma client options\n const prismaLogDef: Prisma.LogDefinition[] = [\n { emit: 'event', level: 'query' },\n { emit: 'event', level: 'error' },\n { emit: 'event', level: 'info' },\n { emit: 'event', level: 'warn' },\n ]\n\n // Create new Prisma Client\n if (process?.env?.PRISMA_APPSYNC_TESTING === 'true') {\n if (!global.prisma)\n global.prisma = new PrismaClient({ log: prismaLogDef })\n\n this.prismaClient = global.prisma\n }\n else {\n this.prismaClient = new PrismaClient({ log: prismaLogDef })\n }\n\n // Prisma logs\n if (!(process?.env?.PRISMA_APPSYNC_TESTING === 'true')) {\n this.prismaClient.$on('query', (e: any) => log('Prisma Client query:', e, 'INFO'))\n this.prismaClient.$on('info', (e: any) => log('Prisma Client info:', e, 'INFO'))\n this.prismaClient.$on('warn', (e: any) => log('Prisma Client warn:', e, 'WARN'))\n this.prismaClient.$on('error', (e: any) => log('Prisma Client error:', e, 'ERROR'))\n }\n }\n\n /**\n * ### Resolver\n *\n * Resolve the API request, based on the AppSync `event` received by the Direct Lambda Resolver.\n * @example\n * ```\n * await prismaAppSync.resolve({ event })\n *\n * // custom resolvers\n * await prismaAppSync.resolve<'notify'|'listPosts'>(\n * event,\n * resolvers: {\n * // extend CRUD API with a custom `notify` query\n * notify: async ({ args }) => { return { message: args.message } },\n *\n * // disable one of the generated CRUD API query\n * listPosts: false,\n * }\n * })\n * ```\n *\n * @param {ResolveParams} resolveParams\n * @param {any} resolveParams.event - AppSync event received by the Direct Lambda Resolver.\n * @param {any} resolveParams.resolvers? - Custom resolvers (to extend the CRUD API).\n * @param {function} resolveParams.shield? - Shield configuration (to protect your API).\n * @param {function} resolveParams.hooks? - Hooks (to trigger functions based on events).\n * @returns Promise\n *\n *\n * Read more in our [docs](https://prisma-appsync.vercel.app).\n */\n public async resolve(\n resolveParams: ResolveParams<'//! inject:type:operations', Extract>,\n ): Promise {\n let result: any = null\n\n try {\n log('Resolving API request w/ event (truncated):', {\n arguments: resolveParams.event.arguments,\n identity: resolveParams.event.identity,\n info: omit(resolveParams.event.info, 'selectionSetGraphQL'),\n })\n\n // Adapter :: parse appsync event\n let QueryParams = await parseEvent(\n resolveParams.event,\n this.options,\n resolveParams.resolvers,\n )\n log('Parsed event:', QueryParams)\n\n // Guard :: rate limiting\n const callerUuid\n = (QueryParams.identity as any)?.sourceIp?.[0]\n || (QueryParams.identity as any)?.sourceIp\n || (QueryParams.identity as any)?.sub\n || JSON.stringify(QueryParams.identity)\n\n if (this.options.maxReqPerUserMinute && callerUuid) {\n const { limitExceeded, count } = await preventDOS({\n callerUuid,\n maxReqPerMinute: this.options.maxReqPerUserMinute,\n })\n if (limitExceeded) {\n throw new CustomError(\n `Rate limit (maxReqPerUserMinute=${this.options.maxReqPerUserMinute}) exceeded for caller \"${callerUuid}\".`,\n {\n type: 'TOO_MANY_REQUESTS',\n },\n )\n }\n else {\n log(`Rate limit check for caller \"${callerUuid}\" returned ${count}/${this.options.maxReqPerUserMinute} (last minute).`)\n }\n }\n\n // Guard :: block queries with a depth > maxDepth\n const depth = getDepth({\n paths: QueryParams.paths,\n context: QueryParams.context,\n fieldsMapping: this.options.fieldsMapping,\n })\n if (depth > this.options.maxDepth) {\n throw new CustomError(\n `Query has depth of ${depth}, which exceeds max depth of ${this.options.maxDepth}.`,\n {\n type: 'FORBIDDEN',\n },\n )\n }\n else {\n log(`Query has depth of ${depth} (max allowed is ${this.options.maxDepth}).`)\n }\n\n // Guard :: create shield from config\n const shield: Shield = resolveParams?.shield\n ? await resolveParams.shield(QueryParams)\n : {}\n\n // Guard :: get shield authorization config\n const shieldAuth: ShieldAuthorization = await getShieldAuthorization({\n shield,\n paths: QueryParams.paths,\n context: QueryParams.context,\n })\n if (Object.keys(shield).length === 0)\n log('Query shield authorization: No Shield setup detected.', null, 'WARN')\n else\n log('Query shield authorization:', shieldAuth)\n\n // Guard :: if `canAccess` if equal to `false`, we reject the API call\n if (!shieldAuth.canAccess) {\n const reason = typeof shieldAuth.reason === 'string'\n ? shieldAuth.reason\n : shieldAuth.reason({\n action: QueryParams.context.action,\n model: QueryParams.context.model?.singular || QueryParams.context.action,\n })\n throw new CustomError(reason, { type: 'FORBIDDEN' })\n }\n\n // Guard :: if `prismaFilter` is set, combine with current Prisma query\n if (!isEmpty(shieldAuth.prismaFilter)) {\n log('QueryParams before adding Shield filters:', QueryParams)\n\n QueryParams.prismaArgs = prismaQueryJoin(\n [QueryParams.prismaArgs, { where: shieldAuth.prismaFilter }],\n [\n 'where',\n 'data',\n 'orderBy',\n 'skip',\n 'take',\n 'skipDuplicates',\n 'select',\n ],\n )\n\n log('QueryParams after adding Shield filters:', QueryParams)\n }\n\n // Guard: get and run all before hooks functions matching query\n if (!isEmpty(resolveParams?.hooks)) {\n QueryParams = await runHooks({\n when: 'before',\n hooks: resolveParams.hooks,\n prismaClient: this.prismaClient,\n QueryParams,\n })\n }\n\n // Resolver :: resolve query for UNIT TESTS\n if (process?.env?.PRISMA_APPSYNC_TESTING === 'true') {\n log('Resolving query for UNIT TESTS.')\n\n const isBatchAction = BatchActionsList.includes(\n QueryParams?.context?.action,\n )\n\n const getTestResult = () => {\n return {\n ...QueryParams.fields.reduce((a, v) => {\n const value = !isEmpty(QueryParams?.prismaArgs?.data?.[v])\n ? QueryParams.prismaArgs.data[v]\n : (Math.random() + 1).toString(36).substring(7)\n\n return { ...a, [v]: String(value) }\n }, {}),\n [DebugTestingKey]: {\n QueryParams,\n },\n }\n }\n\n if (isBatchAction)\n result = [getTestResult(), getTestResult()]\n else\n result = getTestResult()\n }\n // Resolver :: query is disabled\n else if (\n resolveParams?.resolvers\n && typeof resolveParams.resolvers[QueryParams.operation] === 'boolean'\n && resolveParams.resolvers[QueryParams.operation] === false\n ) {\n throw new CustomError(\n `Query resolver for ${QueryParams.operation} is disabled.`,\n { type: 'FORBIDDEN' },\n )\n }\n // Resolver :: resolve query with Custom Resolver\n else if (\n typeof resolveParams?.resolvers?.[QueryParams.operation] === 'function'\n ) {\n log(`Resolving query for Custom Resolver \"${QueryParams.operation}\".`)\n const customResolverFn = resolveParams.resolvers[\n QueryParams.operation\n ] as Function\n result = await customResolverFn({\n ...QueryParams,\n prismaClient: this.prismaClient,\n })\n }\n // Resolver :: resolve query with built-in CRUD\n else if (!isEmpty(QueryParams?.context?.model)) {\n log(`Resolving query for built-in CRUD operation \"${QueryParams.operation}\".`)\n\n try {\n result = await queries[`${QueryParams.context.action}Query`](\n this.prismaClient,\n QueryParams,\n )\n }\n catch (err: any) {\n if (err instanceof Prisma.PrismaClientKnownRequestError) {\n throw new CustomError(\n `Prisma Client known request error${err?.code ? ` (code ${err.code})` : ''}. https://www.prisma.io/docs/reference/api-reference/error-reference#prismaclientknownrequesterror`,\n { type: 'INTERNAL_SERVER_ERROR', cause: err },\n )\n }\n else if (err instanceof Prisma.PrismaClientUnknownRequestError) {\n throw new CustomError(\n 'Prisma Client unknown request error. https://www.prisma.io/docs/reference/api-reference/error-reference#prismaclientunknownrequesterror',\n { type: 'INTERNAL_SERVER_ERROR', cause: err },\n )\n }\n else if (err instanceof Prisma.PrismaClientRustPanicError) {\n throw new CustomError(\n 'Prisma Client Rust panic error. https://www.prisma.io/docs/reference/api-reference/error-reference#prismaclientrustpanicerror',\n { type: 'INTERNAL_SERVER_ERROR', cause: err },\n )\n }\n else if (err instanceof Prisma.PrismaClientInitializationError) {\n throw new CustomError(\n `Prisma Client initialization error${err?.errorCode ? ` (errorCode ${err.errorCode})` : ''}. https://www.prisma.io/docs/reference/api-reference/error-reference#prismaclientinitializationerror`,\n { type: 'INTERNAL_SERVER_ERROR', cause: err },\n )\n }\n else if (err instanceof Prisma.PrismaClientValidationError) {\n throw new CustomError(\n 'Prisma Client validation error. https://www.prisma.io/docs/reference/api-reference/error-reference#prismaclientvalidationerror',\n { type: 'INTERNAL_SERVER_ERROR', cause: err },\n )\n }\n else {\n throw new CustomError(\n err?.message?.split('\\n')?.pop() || 'Unknown error during query.',\n { type: 'INTERNAL_SERVER_ERROR', cause: err },\n )\n }\n }\n }\n // Resolver :: query resolver not found\n else {\n throw new CustomError(\n `Query resolver for ${QueryParams.operation} could not be found.`,\n {\n type: 'INTERNAL_SERVER_ERROR',\n },\n )\n }\n\n // Guard: get and run all after hooks functions matching query\n if (!isEmpty(resolveParams?.hooks)) {\n const q: AfterHookParams = await runHooks({\n when: 'after',\n hooks: resolveParams.hooks,\n prismaClient: this.prismaClient,\n QueryParams,\n result,\n })\n result = q.result\n }\n }\n catch (error) {\n // Return error\n return Promise.reject(parseError(error as Error))\n }\n\n // Guard :: clarify result (decode html)\n const resultClarified = this.options.sanitize ? await clarify(result) : result\n log('Returning response to API request w/ result:', resultClarified)\n\n return resultClarified\n }\n}\n" }, { "path": "packages/client/src/guard.ts", "content": "import lambdaRateLimiter from 'lambda-rate-limiter'\nimport type {\n Context,\n PrismaClient,\n QueryParams,\n Shield,\n ShieldAuthorization,\n ShieldRule,\n} from './types'\nimport { DebugTestingKey } from './consts'\nimport { decode, encode, filterXSS, isEmpty, isMatchingGlob, merge, walk } from './utils'\nimport { CustomError } from './inspector'\n\n// https:// github.com/blackflux/lambda-rate-limiter\nconst limiter = lambdaRateLimiter({\n interval: 60 * 1000, // 60 seconds = 1 minute\n uniqueTokenPerInterval: 1000,\n})\n\n/**\n * #### Sanitize data (parse xss + encode html).\n *\n * @param {any} data\n * @returns any\n */\nexport async function sanitize(data: any): Promise {\n return await walk(data, async ({ key, value }, node) => {\n if (typeof key === 'string' && key === DebugTestingKey)\n node.ignoreChilds()\n\n if (typeof value === 'string')\n value = encode(filterXSS(value))\n\n return { key, value }\n })\n}\n\n/**\n * #### Clarify data (decode html).\n *\n * @param {any} data\n * @returns any\n */\nexport async function clarify(data: any): Promise {\n return await walk(data, async ({ key, value }, node) => {\n if (typeof key === 'string' && key === DebugTestingKey)\n node.ignoreChilds()\n\n if (typeof value === 'string')\n value = decode(value)\n\n return { key, value }\n })\n}\n\n/**\n * #### Returns an Shield authorization object for a given field.\n *\n * @param {any} options\n * @param {Shield} options.shield\n * @param {ShieldRule} options.shieldRule\n * @param {string} options.globPattern\n * @param {string} options.matcher\n * @param {Context} options.context\n * @returns Promise\n */\nasync function getFieldAuthorization(\n { shield, shieldRule, globPattern, matcher, context }:\n {\n shield: Shield\n shieldRule: ShieldRule\n globPattern: string\n matcher: string\n context: Context\n },\n): Promise {\n const authorization: ShieldAuthorization = {\n canAccess: true,\n reason: String(),\n prismaFilter: {},\n matcher: String(),\n globPattern: String(),\n }\n\n if (typeof shieldRule === 'boolean') {\n authorization.canAccess = shield[matcher] as boolean\n }\n else {\n if (typeof shieldRule.rule === 'undefined')\n throw new Error('Badly formed shield rule.')\n\n if (typeof shieldRule.rule === 'boolean') {\n authorization.canAccess = shieldRule.rule\n }\n else if (typeof shieldRule.rule === 'function') {\n const ruleResult = shieldRule.rule(context)\n\n if (ruleResult instanceof Promise)\n authorization.canAccess = await ruleResult\n else if (typeof ruleResult === 'boolean')\n authorization.canAccess = ruleResult\n else\n throw new Error('Shield rule must return a boolean.')\n }\n else {\n authorization.canAccess = true\n if (!authorization.prismaFilter)\n authorization.prismaFilter = {}\n\n authorization.prismaFilter = merge(authorization.prismaFilter, shieldRule.rule)\n }\n }\n\n authorization.matcher = matcher\n authorization.globPattern = globPattern\n\n const isReasonDefined = typeof shieldRule !== 'boolean' && typeof shieldRule.reason !== 'undefined'\n let reason = `Matcher: ${authorization.matcher}`\n\n if (isReasonDefined && typeof shieldRule.reason === 'function')\n reason = shieldRule.reason({ action: context.action, model: context.model?.singular || context.action })\n\n else if (isReasonDefined && typeof shieldRule.reason === 'string')\n reason = shieldRule.reason\n\n authorization.reason = reason\n\n return authorization\n}\n\n/**\n * #### Returns an authorization object from a Shield configuration passed as input.\n *\n * @param {Shield} options.shield\n * @param {string[]} options.paths\n * @param {Context} options.context\n * @returns ShieldAuthorization\n */\nexport async function getShieldAuthorization({\n shield,\n paths,\n context,\n}: {\n shield: Shield\n paths: string[]\n context: Context\n}): Promise {\n let authorization: ShieldAuthorization = {\n canAccess: true,\n reason: String(),\n prismaFilter: {},\n matcher: String(),\n globPattern: String(),\n }\n\n for (const matcher in shield) {\n const concurrentFieldsAuthCheck: Promise[] = []\n\n const globPattern = matcher\n\n for (let i = paths.length - 1; i >= 0; i--) {\n const reqPath: string = paths[i]\n\n if (isMatchingGlob(reqPath, globPattern)) {\n const shieldRule = shield[matcher]\n\n concurrentFieldsAuthCheck.push(\n getFieldAuthorization({ shield, shieldRule, globPattern, matcher, context }),\n )\n }\n }\n\n const fieldsAuthCheckResults = await Promise.allSettled(concurrentFieldsAuthCheck)\n\n for (let fieldIndex = 0; fieldIndex < fieldsAuthCheckResults.length; fieldIndex++) {\n const fieldAuthCheckResult = fieldsAuthCheckResults[fieldIndex]\n\n if (fieldAuthCheckResult.status === 'rejected') {\n throw new CustomError(fieldAuthCheckResult.reason, { type: 'INTERNAL_SERVER_ERROR' })\n }\n else {\n authorization = fieldAuthCheckResult.value\n\n if (!fieldAuthCheckResult.value.canAccess)\n break\n }\n }\n }\n\n return authorization\n}\n\n/**\n * #### Returns GraphQL query depth for any given Query.\n *\n * @param {any} options\n * @param {string[]} options.paths\n * @param {Context} options.context\n * @param {any} options.fieldsMapping\n * @returns number\n */\nexport function getDepth(\n { paths, context, fieldsMapping }:\n { paths: string[]; context: Context; fieldsMapping: any },\n): number {\n let depth = 0\n\n const stopPaths: string[] = []\n\n if (!isEmpty(fieldsMapping)) {\n for (const fieldMap in fieldsMapping) {\n if (fieldsMapping[fieldMap].type.toLowerCase() === 'json')\n stopPaths.push(String(fieldMap))\n }\n }\n\n paths.forEach((path: string) => {\n const stopPath = stopPaths.find((p: string) => path.includes(p))\n const stopIndex = stopPath ? stopPath.split('/').length - 1 : undefined\n const parts = path.split('/').filter(Boolean).slice(1, stopIndex ? stopIndex + 1 : undefined)\n const pathDepth = parts.length\n\n if (pathDepth > depth)\n depth = pathDepth\n })\n\n if (context.model === null)\n depth += 1\n\n return depth\n}\n\n/**\n * #### Execute hooks that apply to a given Query.\n *\n * @param {any} options\n * @param {'before' | 'after'} options.when\n * @param {any} options.hooks\n * @param {PrismaClient} options.prismaClient\n * @param {QueryParams} options.QueryParams\n * @param {any | any[]} options.result\n * @returns Promise\n */\nexport async function runHooks({\n when,\n hooks,\n prismaClient,\n QueryParams,\n result,\n}: {\n when: 'before' | 'after'\n hooks: any\n prismaClient: PrismaClient\n QueryParams: QueryParams\n result?: any | any[]\n}): Promise {\n const matchingHooks = Object.keys(hooks).filter((hookPath: string) => {\n const hookParts = hookPath.split(':')\n const hookWhen = hookParts[0]\n const hookGlob = hookParts[1]\n const currentPath = QueryParams.operation\n\n return hookWhen === when && isMatchingGlob(currentPath, hookGlob)\n })\n\n let hookResponse = when === 'after'\n ? { ...QueryParams, result }\n : QueryParams\n\n if (matchingHooks.length > 0) {\n for (let index = 0; index < matchingHooks.length; index++) {\n const hookPath = matchingHooks[index]\n\n if (Object.prototype.hasOwnProperty.call(hooks, hookPath)) {\n hookResponse = await hooks[hookPath]({\n ...QueryParams,\n ...(typeof result !== 'undefined' && when === 'after' && { result }),\n prismaClient,\n })\n }\n }\n }\n\n return hookResponse\n}\n\nexport async function preventDOS({\n callerUuid,\n maxReqPerMinute,\n}: {\n callerUuid: string\n maxReqPerMinute: number\n}): Promise<{\n limitExceeded: boolean\n count: number\n}> {\n let limitExceeded = false\n let count = -1\n\n try {\n count = await limiter.check(maxReqPerMinute, callerUuid)\n }\n catch (error) {\n limitExceeded = true\n count = maxReqPerMinute\n }\n\n return {\n limitExceeded,\n count,\n }\n}\n" }, { "path": "packages/client/src/index.ts", "content": "import {\n clone,\n decode,\n dotate,\n encode,\n filterXSS,\n isEmpty,\n isMatchingGlob,\n isObject,\n isUndefined,\n lowerFirst,\n merge,\n replaceAll,\n walk,\n} from './utils'\n\nexport { PrismaAppSync } from './core'\nexport { CustomError, log } from './inspector'\nexport { queryBuilder } from './resolver'\nexport {\n QueryParams,\n QueryParamsCustom,\n BeforeHookParams,\n AfterHookParams,\n Authorization,\n AppSyncEvent,\n Identity,\n API_KEY,\n AWS_IAM,\n AMAZON_COGNITO_USER_POOLS,\n AWS_LAMBDA,\n OPENID_CONNECT,\n AppSyncResolverHandler,\n AppSyncResolverEvent,\n AppSyncIdentity,\n} from './types'\nexport { Authorizations } from './consts'\n\nconst _ = {\n merge,\n clone,\n decode,\n encode,\n dotate,\n isMatchingGlob,\n filterXSS,\n isEmpty,\n isUndefined,\n lowerFirst,\n isObject,\n walk,\n replaceAll,\n}\n\nexport { _ }\n" }, { "path": "packages/client/src/inspector.ts", "content": "/* eslint-disable n/prefer-global/process */\n/* eslint-disable no-console */\nimport { inspect as nodeInspect } from 'node:util'\nimport type { logLevel } from './types'\n\nconst errorCodes = {\n FORBIDDEN: 401,\n BAD_USER_INPUT: 400,\n INTERNAL_SERVER_ERROR: 500,\n TOO_MANY_REQUESTS: 429,\n}\n\nexport type ErrorExtensions = {\n type: keyof typeof errorCodes\n cause?: any\n}\n\nexport type ErrorDetails = {\n error: string\n type: ErrorExtensions['type']\n code: number\n cause?: ErrorExtensions['cause']\n}\n\nexport class CustomError extends Error {\n public error: ErrorDetails['error']\n public type: ErrorDetails['type']\n public code: ErrorDetails['code']\n public cause: ErrorDetails['cause']\n public details: ErrorDetails\n\n constructor(message: string, extensions: ErrorExtensions) {\n super(message)\n\n this.error = message\n this.type = extensions.type\n this.cause = extensions?.cause?.meta?.cause || extensions?.cause\n this.code = typeof errorCodes[this.type] !== 'undefined' ? errorCodes[this.type] : errorCodes.INTERNAL_SERVER_ERROR\n\n this.message = JSON.stringify({\n error: this.error,\n type: this.type,\n code: this.code,\n })\n\n const maxCauseMessageLength = 500\n\n if (this.cause?.message?.length > maxCauseMessageLength)\n this.cause.message = `... ${this.cause.message.slice(this.cause.message.length - maxCauseMessageLength)}`\n\n this.details = {\n error: this.error,\n type: this.type,\n code: this.code,\n ...(this.cause && { cause: this.cause }),\n }\n\n if (!(process?.env?.PRISMA_APPSYNC_TESTING === 'true'))\n log(message, this.details, 'ERROR')\n }\n}\n\nexport function parseError(error: Error): CustomError {\n if (error instanceof CustomError) {\n return error\n }\n else {\n return new CustomError(error.message, {\n type: 'INTERNAL_SERVER_ERROR',\n cause: error,\n })\n }\n}\n\nexport function log(message: string, obj?: any, level?: logLevel): void {\n if (canPrintLog(level || 'INFO')) {\n printLog(message, level || 'INFO')\n\n if (obj) {\n console.log(\n nodeInspect(obj, {\n compact: false,\n depth: 5,\n breakLength: 80,\n maxStringLength: 800,\n ...(!process.env.LAMBDA_TASK_ROOT && {\n colors: true,\n }),\n }),\n )\n }\n }\n}\n\nexport function printLog(message: any, level: logLevel): void {\n const timestamp = new Date().toLocaleString(undefined, {\n day: 'numeric',\n month: 'numeric',\n year: 'numeric',\n hour: '2-digit',\n minute: '2-digit',\n second: '2-digit',\n })\n const prefix = `β—­ ${timestamp} <<${level}>>`\n const log = [prefix, message].join(' ')\n\n if (level === 'ERROR' && canPrintLog(level))\n console.error(`\\x1B[31m${log}`)\n else if (level === 'WARN' && canPrintLog(level))\n console.warn(`\\x1B[33m${log}`)\n else if (level === 'INFO' && canPrintLog(level))\n console.info(`\\x1B[36m${log}`)\n}\n\nfunction canPrintLog(level: logLevel): boolean {\n if (process?.env?.PRISMA_APPSYNC_TESTING === 'true')\n return false\n\n const logLevel = String(process.env.PRISMA_APPSYNC_LOG_LEVEL) as logLevel\n\n return (logLevel === 'ERROR' && level === 'ERROR')\n || (logLevel === 'WARN' && ['WARN', 'ERROR'].includes(level))\n || (logLevel === 'INFO')\n}\n" }, { "path": "packages/client/src/resolver.ts", "content": "import type {\n PrismaArgs,\n PrismaClient,\n PrismaCount,\n PrismaCreate,\n PrismaCreateMany,\n PrismaDelete,\n PrismaDeleteMany,\n PrismaGet,\n PrismaList,\n PrismaOperator,\n PrismaUpdate,\n PrismaUpdateMany,\n PrismaUpsert,\n QueryBuilder,\n QueryParams,\n} from './types'\nimport { merge } from './utils'\n\n/**\n * #### Query Builder\n */\nexport function prismaQueryJoin(queries: PrismaArgs[], operators: PrismaOperator[]): T {\n const prismaArgs: PrismaArgs = {}\n\n // 'where', 'orderBy', 'select', 'skip', 'take', ...\n operators.forEach((operator: PrismaOperator) => {\n queries.forEach((query: PrismaArgs) => {\n if (query?.[operator]) {\n if (operator === 'where') {\n if (prismaArgs.where?.AND) {\n prismaArgs.where.AND.push(query.where)\n }\n else if (prismaArgs.where) {\n prismaArgs.where = {\n ...prismaArgs.where,\n AND: [query.where],\n }\n }\n else {\n prismaArgs.where = query.where\n }\n }\n else if (prismaArgs?.[operator]) {\n prismaArgs[operator] = merge(prismaArgs[operator], query[operator]) as never\n }\n else {\n prismaArgs[operator] = query[operator] as never\n }\n }\n })\n })\n\n return prismaArgs as T\n}\n\nexport const queryBuilder: QueryBuilder = {\n prismaGet: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['where', 'select'])\n },\n prismaList: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['where', 'orderBy', 'select', 'skip', 'take'])\n },\n prismaCount: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['where', 'orderBy', 'select', 'skip', 'take'])\n },\n prismaCreate: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['data', 'select'])\n },\n prismaCreateMany: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['data', 'skipDuplicates'])\n },\n prismaUpdate: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['data', 'where', 'select'])\n },\n prismaUpdateMany: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['data', 'where'])\n },\n prismaUpsert: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['where', 'create', 'update', 'select'])\n },\n prismaDelete: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['where', 'select'])\n },\n prismaDeleteMany: (...prismaQueries: PrismaArgs[]) => {\n return prismaQueryJoin(prismaQueries, ['where'])\n },\n}\n\n/**\n * #### Query :: Find Unique\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#findunique\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function getQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].findUnique(queryBuilder.prismaGet(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Query :: Find Many\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#findmany\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function listQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].findMany(queryBuilder.prismaList(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Query :: Count\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#count\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function countQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].count(queryBuilder.prismaCount(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Mutation :: Create\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#create\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function createQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].create(queryBuilder.prismaCreate(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Mutation :: Create Many\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#createmany\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function createManyQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].createMany(queryBuilder.prismaCreateMany(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Mutation :: Update\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#update\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function updateQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].update(queryBuilder.prismaUpdate(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Mutation :: Update Many\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#updatemany\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function updateManyQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].updateMany(queryBuilder.prismaUpdateMany(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Mutation :: Upsert\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#upsert\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function upsertQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].upsert(queryBuilder.prismaUpsert(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Mutation :: Delete\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#delete\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function deleteQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].delete(queryBuilder.prismaDelete(query.prismaArgs))\n\n return results\n}\n\n/**\n * #### Mutation :: Delete Many\n *\n * https://www.prisma.io/docs/reference/api-reference/prisma-client-reference#deletemany\n * @param {PrismaClient} prismaClient\n * @param {QueryParams} query\n */\nexport async function deleteManyQuery(prismaClient: PrismaClient, query: QueryParams) {\n if (query.context.model === null)\n return\n\n const results = await prismaClient[query.context.model.prismaRef].deleteMany(queryBuilder.prismaDeleteMany(query.prismaArgs))\n\n return results\n}\n" }, { "path": "packages/client/src/types.ts", "content": "import { Prisma, PrismaClient } from '@prisma/client'\nimport type {\n AppSyncIdentity,\n AppSyncIdentityCognito,\n AppSyncIdentityIAM,\n AppSyncIdentityLambda,\n AppSyncIdentityOIDC,\n AppSyncResolverEvent,\n AppSyncResolverHandler,\n} from 'aws-lambda'\nimport type { Actions, ActionsAliases, Authorizations } from './consts'\n\nexport type logLevel = 'INFO' | 'WARN' | 'ERROR'\n\nexport type PrismaAppSyncOptionsType = {\n connectionString?: string\n sanitize?: boolean\n logLevel?: logLevel\n defaultPagination?: number | false\n maxDepth?: number\n maxReqPerUserMinute?: number | false\n}\n\nexport type Options = Required & {\n modelsMapping: any\n fieldsMapping: any\n}\n\nexport type InjectedConfig = {\n modelsMapping?: { [modelVariant: string]: { prismaRef: string; singular: string; plural: string } }\n fieldsMapping?: { [fieldPath: string]: { type: string; isRelation: boolean } }\n operations?: string\n}\n\nexport type RuntimeConfig = {\n modelsMapping: { [modelVariant: string]: { prismaRef: string; singular: string; plural: string } }\n fieldsMapping: { [fieldPath: string]: { type: string; isRelation: boolean } }\n operations: string[]\n}\n\nexport type Action = typeof Actions[keyof typeof Actions] | string\n\nexport type ActionsAlias = typeof ActionsAliases[keyof typeof ActionsAliases] | 'custom' | null\n\nexport type ActionsAliasStr = keyof typeof ActionsAliases\n\nexport type Context = {\n action: Action\n alias: ActionsAlias\n model: Model\n}\n\nexport type Model = { prismaRef: string; singular: string; plural: string } | null\n\nexport type { AppSyncResolverHandler, AppSyncResolverEvent, AppSyncIdentity }\n\n/**\n * ### QueryParams\n *\n * @example\n * ```\n * {\n * type: 'Query',\n * operation: 'getPost',\n * context: { action: 'get', alias: 'access', model: 'Post' },\n * fields: ['title', 'status'],\n * paths: ['get/post/title', 'get/post/status'],\n * args: { where: { id: 5 } },\n * prismaArgs: {\n * where: { id: 5 },\n * select: { title: true, status: true },\n * },\n * authorization: 'API_KEY',\n * identity: { ... },\n * }\n * ```\n */\nexport type QueryParams = {\n type: GraphQLType\n operation: string\n context: Context\n fields: string[]\n paths: string[]\n args: T\n prismaArgs: PrismaArgs\n authorization: Authorization\n identity: Identity\n headers: any\n}\n\nexport type Authorization = typeof Authorizations[keyof typeof Authorizations] | null\n\nexport type PrismaGet = Pick, 'where'> & Pick\nexport type PrismaList = Pick\nexport type PrismaCount = Pick\nexport type PrismaCreate = Pick, 'data'> & Pick\nexport type PrismaCreateMany = Pick, 'data'> & Pick\nexport type PrismaUpdate = Pick, 'data' | 'where'> & Pick\nexport type PrismaUpdateMany = Pick, 'data' | 'where'>\nexport type PrismaUpsert = Pick, 'where'> &\nPick & Pick & Pick\nexport type PrismaDelete = Pick, 'where'> & Pick\nexport type PrismaDeleteMany = Pick, 'where'>\n\nexport type QueryBuilder = {\n prismaGet: (...prismaArgs: PrismaArgs[]) => PrismaGet\n prismaList: (...prismaArgs: PrismaArgs[]) => PrismaList\n prismaCount: (...prismaArgs: PrismaArgs[]) => PrismaCount\n prismaCreate: (...prismaArgs: PrismaArgs[]) => PrismaCreate\n prismaCreateMany: (...prismaArgs: PrismaArgs[]) => PrismaCreateMany\n prismaUpdate: (...prismaArgs: PrismaArgs[]) => PrismaUpdate\n prismaUpdateMany: (...prismaArgs: PrismaArgs[]) => PrismaUpdateMany\n prismaUpsert: (...prismaArgs: PrismaArgs[]) => PrismaUpsert\n prismaDelete: (...prismaArgs: PrismaArgs[]) => PrismaDelete\n prismaDeleteMany: (...prismaArgs: PrismaArgs[]) => PrismaDeleteMany\n}\n\nexport type QueryParamsCustom = QueryParams & {\n prismaClient: PrismaClient\n}\n\nexport type BeforeHookParams = QueryParams & {\n prismaClient: PrismaClient\n}\n\n/**\n * ### AfterHookParams\n *\n * @example\n * ```\n * {\n * type: 'Query',\n * operation: 'getPost',\n * context: { action: 'get', alias: 'access', model: 'Post' },\n * fields: ['title', 'status'],\n * paths: ['get/post/title', 'get/post/status'],\n * args: { where: { id: 5 } },\n * prismaArgs: {\n * where: { id: 5 },\n * select: { title: true, status: true },\n * },\n * authorization: 'API_KEY',\n * identity: { ... },\n * result: { title: 'Hello World', status: 'PUBLISHED' }\n * }\n * ```\n */\nexport type AfterHookParams = QueryParams & {\n prismaClient: PrismaClient\n result: any | any[]\n}\n\nexport type ShieldContext = {\n action: Action\n model: string\n}\n\nexport type Reason = string | ((context: ShieldContext) => string)\n\nexport type ShieldRule = boolean | ((context: ShieldContext) => boolean | Promise) | any\n\nexport type Shield = {\n [matcher: string]:\n | boolean\n | {\n rule: ShieldRule\n reason?: Reason\n }\n}\n\nexport type HooksProps = {\n before: BeforeHookParams\n after: AfterHookParams\n}\n\nexport type HooksReturn = {\n before: Promise\n after: Promise\n}\n\nexport type HookPath = Operations | CustomResolvers\n\nexport type HooksParameter<\n HookType extends 'before' | 'after',\n Operations extends string,\n CustomResolvers extends string,\n> = `${HookType}:${HookPath}` | `${HookType}:**`\n\nexport type HooksParameters<\n HookType extends 'before' | 'after',\n Operations extends string,\n CustomResolvers extends string,\n> = {\n [matcher in HooksParameter]?: (\n props: HooksProps[HookType],\n ) => HooksReturn[HookType]\n}\n\nexport type Hooks =\n | HooksParameters<'before', Operations, CustomResolvers>\n | HooksParameters<'after', Operations, CustomResolvers>\n\nexport type ShieldAuthorization = {\n canAccess: boolean\n reason: Reason\n prismaFilter: any\n matcher: string\n globPattern: string\n}\n\nexport type ResolveParams = {\n event: AppSyncEvent\n resolvers?: {\n [resolver in CustomResolvers]: ((props: QueryParamsCustom) => Promise) | boolean\n }\n shield?: (props: QueryParams) => Shield\n hooks?: Hooks\n}\n\n// Prisma-related Types\n\nexport { PrismaClient, Prisma }\n\nexport type PrismaArgs = {\n where?: any\n create?: any\n update?: any\n data?: any\n select?: any\n orderBy?: any\n skip?: number | undefined\n take?: number | undefined\n skipDuplicates?: boolean | undefined\n}\n\nexport type PrismaOperator = keyof Required\n\nexport type AppSyncEvent = AppSyncResolverEvent\n\nexport type GraphQLType = 'Query' | 'Mutation' | 'Subscription'\n\nexport type API_KEY = null | {\n [key: string]: any\n}\n\nexport type AWS_LAMBDA = AppSyncIdentityLambda\n\nexport type AWS_IAM = AppSyncIdentityIAM\n\nexport type AMAZON_COGNITO_USER_POOLS = AppSyncIdentityCognito\n\nexport type OPENID_CONNECT = AppSyncIdentityOIDC\n\nexport type Identity = API_KEY | AWS_LAMBDA | AWS_IAM | AMAZON_COGNITO_USER_POOLS | OPENID_CONNECT\n" }, { "path": "packages/client/src/utils.ts", "content": "/* eslint-disable @typescript-eslint/ban-types */\nimport { flatten } from 'wild-wild-utils'\nimport { isMatch } from 'micromatch'\nimport deepmerge from 'deepmerge'\nimport { decode as decodeHtml, encode as encodeHtml } from 'html-entities'\nimport xss from 'xss'\n\n/**\n * #### Deep merge objects (without mutating the target object).\n *\n * @example const newObj = merge(obj1, obj2, obj3)\n *\n * @param {any[]} sources\n * @returns any\n */\nexport function merge(...sources: any[]): any {\n return deepmerge.all([{}, ...sources])\n}\n\n/**\n * #### Deep clone object.\n *\n * @example const newObj = clone(sourceObj)\n *\n * @param {any} source\n * @returns any\n */\nexport function clone(source: any): any {\n return deepmerge({}, source)\n}\n\n/**\n * #### Returns decoded text, replacing HTML special characters.\n *\n * @example decode('< > " ' & © ∆')\n * // returns '< > \" \\' & Β© βˆ†'\n *\n * @param {string} str\n * @returns string\n */\nexport function decode(str: string): string {\n return decodeHtml(str)\n}\n\n/**\n * #### Returns encoded text, version of string.\n *\n * @example encode('