# @jetvil/cm-api > πŸ“š Content management API for integrating with NodeJS(express) and Prisma ORM Latest version **0.2.1** (published 2022-10-26) Β· MIT license Β· 0 weekly downloads ## Install ```sh npm install @jetvil/cm-api pnpm add @jetvil/cm-api yarn add @jetvil/cm-api bun add @jetvil/cm-api ``` ## Health **Score 25/100 (F)** β€” status: abandoned. Positive: has types; no vulnerabilities; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.2.1 | | Published | 2022-10-26 | | First published | 2022-10-06 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=16.17.0 | | Dependencies | 3 | | Unpacked size | 25.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 3 | | Author | JetVil | | Maintainers | m10rten | | Keywords | jetvil, cm-api, typescript, nodejs, javascript | ## Links - npm: https://www.npmjs.com/package/@jetvil/cm-api - Repository: https://github.com/jetvil/cm-api - Homepage: https://github.com/jetvil/cm-api#readme - Issues: https://github.com/jetvil/cm-api/issues - npm.io page: https://npm.io/package/@jetvil/cm-api ## Dependencies (3) - [express](https://npm.io/package/express.md) ^4.18.1 - [@jetvil/types](https://npm.io/package/@jetvil/types.md) ^0.1.8 - [@prisma/client](https://npm.io/package/@prisma/client.md) ^4.4.0 ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) β€” 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) β€” 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) β€” 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) β€” 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) β€” 155.6K weekly downloads ## Recent versions - 0.2.1 (latest) β€” 2022-10-26 - 0.2.0-beta.2 β€” 2022-10-09 - 0.2.0-beta.1 β€” 2022-10-09 - 0.1.1 β€” 2022-10-06 - 0.1.0 β€” 2022-10-06 ## README # @jetvil/cm-api [![Bundle size](https://img.shields.io/bundlephobia/min/@jetvil/cm-api/latest?label=Bundle%20Size&style=for-the-badge)](https://bundlephobia.com/package/@jetvil/cm-api@latest) [![Version](https://img.shields.io/npm/v/@jetvil/cm-api?style=for-the-badge&color=cb3837&logo=npm)](https://www.npmjs.com/package/@jetvil/cm-api)  ![Downloads](https://img.shields.io/npm/dt/@jetvil/cm-api?style=for-the-badge)  [![GitHub](https://img.shields.io/github/license/jetvil/cm-api?style=for-the-badge)](https://github.com/jetvil/cm-api/blob/main/LICENSE)  [![GitHub Repo stars](https://img.shields.io/github/stars/jetvil/cm-api?color=E9E9E9&logo=Github&style=for-the-badge)](https://www.github.com/jetvil/cm-api)  [![GitHub issues](https://img.shields.io/github/issues-raw/jetvil/cm-api?label=issues&style=for-the-badge)](https://github.com/jetvil/cm-api/issues)  πŸ“š Content management API for integrating with NodeJS Express(backend) and Prisma(ORM) # Features - πŸš€ **Easy to use**: Easy to install in your project. - βœ… **ES6+ && TS**: TypeScript and ES6+ support(JS). - πŸ“¦ **Required dependencies**: You don't need what you won't use: express and prisma. - πŸ’΅ **Free**: It's free and always will be, the beauty of open source. # Getting Started ## Installation To use this package, **install** using `npm`, `yarn` or `pnpm`πŸ“₯: ```bash # npm npm install @jetvil/cm-api # yarn yarn add @jetvil/cm-api # pnpm pnpm install @jetvil/cm-api ``` ## Usage ```js const express = require("express"); const { PrismaClient } = require("@prisma/client"); const jetvil = require("@jetvil/cm-api"); // prisma with eg. postgresql and schemas: "user" and "post" const prisma = new PrismaClient(); // Prisma ORM, you must have it installed and generated. const app = express(); const jetvil = jetvil(); app.use(express.json()); // for parsing application/json. jetvil.setClient(prisma); // Set prisma client here or pass it in the router() method. const router = jetvil.router(); // Empty by default, you can configure it by passing an object. app.use("/api", router); app.listen(3000, () => { console.log("Server is running on port 3000"); }); // Routes such as /user and /post will be available at /api/user and /api/post ``` ## Configuration You can configure the router by passing an object to the router() method. By doing so you can adjust the routes to your needs. ```js const jetvil = require("@jetvil/cm-api"); const jetvil = jetvil(); const router = jetvil.router({ client: prisma, // Prisma ORM, you must have it installed and generated. global: { schemas: ["user", "post", "profile"], // if specified, only these schemas will be available. methods: ["get", "post", "put", "delete", "fake"], // if specified, only these methods will be available, 'fake' will not be used. middleware: [ { methods: ["get"], // Method to which the middleware will be applied. schemas: ["user"], // Schema to which the middleware will be applied. handler: (req, res, next) => { // Middleware function. next(); }, }, ], }, config: { // note how the schema is the key and the value is an object with the schema config. // these are overrides for the global config on a per schema basis. user: { methods: ["get", "post", "put"], // note how the delete method is not included. actions: ["read", "create", "update", "delete"], // these actions determine what the user can do with the schema. // for example, if the user has the 'read' action, he can only read the schema. // when the 'filter' action is included, the user can filter the schema on the schema. middleware: [ // this middleware will override the global middleware for the user schema. { handler: (_req, _res, next) => { console.log("Middleware applied to user schema!"); next(); }, }, ], }, }, verbose: true, // If true, the router will log the routes it generates. }); ``` # Documentation For more information, please check out the [documentation](https://github.com/jetvil/cm-api#documentation)πŸ“–. # Contributing Found a bug🦟? or want to suggest a new featureπŸ†•? or just want to helpπŸ†˜? Feel free to open an issue or a pull request. Contributions are always welcome!πŸŽ‰ - Fork the project [here](https://github.com/jetvil/cm-api/fork). - Create a new branch like this: `git checkout -b feature/featureName`. - Commit your changes to your branch: `git commit -m 'Create AwesomeFeature'`βš™οΈ. - Push your branch: `git push origin feature/featureName`. - Open a pull request on the `dev` branch [here](https://github.com/jetvil/cm-api/pulls)πŸ”ƒ. πŸ“’**Note:** Make sure to add tests for your changes βœ…. --- _Source: https://npm.io/package/@jetvil/cm-api Β· Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._