@visulima/crud 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## @visulima/crud [1.0.2](https://github.com/visulima/visulima/compare/@visulima/crud@1.0.1...@visulima/crud@1.0.2) (2022-12-01)
+
+
+### Bug Fixes
+
+* extended swagger generation for example and fixed typings ([#41](https://github.com/visulima/visulima/issues/41)) ([a16f49b](https://github.com/visulima/visulima/commit/a16f49b70f78763a63525e0d328bd2a597b183f7))
+
+
+
+### Dependencies
+
+* **@visulima/pagination:** upgraded to 1.0.1
+* **@visulima/prisma-dmmf-transformer:** upgraded to 1.0.1
+
+## @visulima/crud [1.0.1](https://github.com/visulima/visulima/compare/@visulima/crud@1.0.0...@visulima/crud@1.0.1) (2022-11-16)
+
+
+### Bug Fixes
+
+* fixed wrong image and url for the npm version ([297c187](https://github.com/visulima/visulima/commit/297c187d07ca7fb82d25fd46defe4f320c514de9))
+
 ## @visulima/crud 1.0.0 (2022-11-15)
 
 

package/README.md

@@ -37,38 +37,68 @@ With a more intuitive API for creating HTTP API endpoints.
 ## Installation
 
 ```sh
-npm install @visulima/crud
+npm install @visulima/crud prisma @prisma/client
 ```
 
 ```sh
-yarn add @visulima/crud
+yarn add @visulima/crud prisma @prisma/client
 ```
 
 ```sh
-pnpm add @visulima/crud
+pnpm add @visulima/crud prisma @prisma/client
 ```
 
 ## Usage
 
-This package has an extended version of the `@visulima/connect` package.
-That means you can use all the features of the `@visulima/connect` package, in addition to the features of this package.
+To use the `@visulima/crud` package, you need to have a [Prisma](https://www.prisma.io/) schema.
 
 ```ts
-// pages/api/hello.js
+// pages/api/[...crud].ts
+
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
 import type { NextApiRequest, NextApiResponse } from "next";
-import { createNodeRouter } from "@visulima/crud";
-import cors from "cors";
+import { PrismaAdapter } from "@visulima/crud";
+import { nodeHandler }  from "@visulima/crud/next";
+import type { User, Post, Prisma } from "@prisma/client";
+
+import { prisma } from "../../lib/prisma-client";
+
+const prismaAdapter = new PrismaAdapter<User | Post, Prisma.ModelName>({
+    prismaClient: prisma,
+});
+
+export default async (request, response) => {
+    const handler = await nodeHandler<User | Post, any, NextApiRequest, NextApiResponse, Prisma.ModelName>(prismaAdapter);
+
+    await handler(request, response);
+};
+```
+
+To use it with `api-platform connect` you need to install the `@visulima/api-platform` package.
+
+```ts
+// pages/api/[...crud].ts
+
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+import type { NextApiRequest, NextApiResponse } from "next";
+import { createNodeRouter } from "@visulima/api-platform";
+import { PrismaAdapter } from "@visulima/crud";
+import { nodeHandler }  from "@visulima/crud/next";
+import type { User, Post, Prisma } from "@prisma/client";
+
+import { prisma } from "../../lib/prisma-client";
+
+const prismaAdapter = new PrismaAdapter<User | Post, Prisma.ModelName>({
+    prismaClient: prisma,
+});
 
-// Default Req and Res are IncomingMessage and ServerResponse
-// You may want to pass in NextApiRequest and NextApiResponse
-const router = createNodeRouter<NextApiRequest, NextApiResponse>();
+const router = createNodeRouter<NextApiRequest, NextApiResponse>().all(async (request, response) => {
+    const handler = await nodeHandler<User | Post, any, NextApiRequest, NextApiResponse, Prisma.ModelName>(prismaAdapter);
 
-router
-  .get((req, res) => {
-    res.send("Hello world");
-  });
+    await handler(request, response);
+});
 
-export default router.nodeHandler();
+export default router.handler();
 ```
 
 ## Supported Node.js Versions
@@ -96,6 +126,6 @@ The visulima crud is open-sourced software licensed under the [MIT][license-url]
 [typescript-url]: "typescript"
 [license-image]: https://img.shields.io/npm/l/@visulima/crud?color=blueviolet&style=for-the-badge
 [license-url]: LICENSE.md "license"
-[npm-image]: https://img.shields.io/npm/v/@visulima/crud/alpha.svg?style=for-the-badge&logo=npm
-[npm-url]: https://www.npmjs.com/package/@visulima/crud/v/alpha "npm"
+[npm-image]: https://img.shields.io/npm/v/@visulima/crud/latest.svg?style=for-the-badge&logo=npm
+[npm-url]: https://www.npmjs.com/package/@visulima/crud/v/latest "npm"
 

package/dist/chunk-SH6A4KBC.mjs

@@ -0,0 +1,28 @@
+// src/types.d.ts
+var RouteType = /* @__PURE__ */ ((RouteType2) => {
+  RouteType2["CREATE"] = "CREATE";
+  RouteType2["READ_ALL"] = "READ_ALL";
+  RouteType2["READ_ONE"] = "READ_ONE";
+  RouteType2["UPDATE"] = "UPDATE";
+  RouteType2["DELETE"] = "DELETE";
+  return RouteType2;
+})(RouteType || {});
+
+// src/utils/get-accessible-routes.ts
+var getAccessibleRoutes = (only, exclude, defaultExposeStrategy = "all") => {
+  let accessibleRoutes = defaultExposeStrategy === "none" ? [] : ["READ_ALL" /* READ_ALL */, "READ_ONE" /* READ_ONE */, "UPDATE" /* UPDATE */, "DELETE" /* DELETE */, "CREATE" /* CREATE */];
+  if (Array.isArray(only)) {
+    accessibleRoutes = only;
+  }
+  if (exclude == null ? void 0 : exclude.length) {
+    accessibleRoutes = accessibleRoutes.filter((element) => !exclude.includes(element));
+  }
+  return accessibleRoutes;
+};
+var get_accessible_routes_default = getAccessibleRoutes;
+
+export {
+  RouteType,
+  get_accessible_routes_default
+};
+//# sourceMappingURL=chunk-SH6A4KBC.mjs.map

package/dist/{chunk-UBXIGP5H.mjs.map → chunk-SH6A4KBC.mjs.map}

@@ -1 +1 @@
-{"version":3,"sources":["../src/types.d.ts","../src/utils/get-accessible-routes.ts"],"sourcesContent":["import type { Handler as CreateHandler } from \"./handler/create\";\nimport type { Handler as DeleteHandler } from \"./handler/delete\";\nimport type { Handler as ListHandler } from \"./handler/list\";\nimport type { Handler as GetHandler } from \"./handler/read\";\nimport type { Handler as UpdateHandler } from \"./handler/update\";\n\nexport enum RouteType {\n    CREATE = \"CREATE\",\n    READ_ALL = \"READ_ALL\",\n    READ_ONE = \"READ_ONE\",\n    UPDATE = \"UPDATE\",\n    DELETE = \"DELETE\",\n}\n\nexport type ModelOption = {\n    name?: string\n    only?: RouteType[]\n    exclude?: RouteType[]\n    formatResourceId?: (resourceId: string) => string | number\n};\n\nexport type ModelsOptions<M extends string = string> = {\n    [key in M]?: ModelOption\n};\n\nexport type HandlerOptions<M extends string = string> = {\n    formatResourceId?: (resourceId: string) => string | number;\n    models?: ModelsOptions<M>;\n    exposeStrategy?: \"all\" | \"none\";\n    pagination?: PaginationConfig,\n    handlers?: {\n        create?: CreateHandler;\n        delete?: DeleteHandler;\n        get?: GetHandler;\n        list?: ListHandler;\n        update?: UpdateHandler;\n    },\n};\n\nexport type PaginationConfig = {\n    perPage: number\n};\n\nexport interface HandlerParameters<T, Q> {\n    adapter: Adapter<T, Q>;\n    query: Q;\n    resourceName: string;\n}\n\nexport interface UniqueResourceHandlerParameters<T, Q> {\n    adapter: Adapter<T, Q>;\n    query: Q;\n    resourceName: string;\n    resourceId: string | number;\n}\n\nexport interface Adapter<T, Q, M extends string = string> {\n    models?: M[];\n    init?: () => Promise<void>;\n    parseQuery(resourceName: M, query: ParsedQueryParameters): Q;\n    getAll(resourceName: M, query: Q): Promise<T[]>;\n    getOne(resourceName: M, resourceId: string | number, query: Q): Promise<T>;\n    create(resourceName: M, data: any, query: Q): Promise<T>;\n    update(resourceName: M, resourceId: string | number, data: any, query: Q): Promise<T>;\n    delete(resourceName: M, resourceId: string | number, query: Q): Promise<T>;\n    getPaginationData(resourceName: M, query: Q): Promise<PaginationData>;\n    getModels(): M[];\n    connect?: () => Promise<void>;\n    disconnect?: () => Promise<void>;\n    handleError?: (error: Error) => void;\n    mapModelsToRouteNames?: () => Promise<{ [key in M]?: string }>;\n}\n\nexport type PaginationData = {\n    total: number\n    pageCount: number\n    page: number\n};\n\nexport type RecursiveField = {\n    [key: string]: boolean | TRecursiveField;\n};\n\nexport type WhereOperator = \"$eq\" | \"$neq\" | \"$in\" | \"$notin\" | \"$lt\" | \"$lte\" | \"$gt\" | \"$gte\" | \"$cont\" | \"$starts\" | \"$ends\" | \"$isnull\";\n\nexport type SearchCondition = string | boolean | number | Date | null;\n\nexport type WhereCondition = {\n    [key in TWhereOperator]?: TSearchCondition;\n};\n\nexport type Condition = {\n    [key: string]: TSearchCondition | TWhereCondition | TCondition;\n};\n\nexport type WhereField = Condition & {\n    $and?: TCondition | TCondition[];\n    $or?: TCondition | TCondition[];\n    $not?: TCondition | TCondition[];\n};\n\nexport type OrderByOperator = \"$asc\" | \"$desc\";\n\nexport type OrderByField = {\n    [key: string]: TOrderByOperator;\n};\n\nexport interface ParsedQueryParameters {\n    select?: RecursiveField;\n    include?: RecursiveField;\n    where?: WhereField;\n    orderBy?: OrderByField;\n    limit?: number;\n    skip?: number;\n    distinct?: string;\n    page?: number;\n    originalQuery?: {\n        [key: string]: any;\n    };\n}\n\nexport interface ExecuteHandler<Request, Response> {\n    (request: Request, response: Response): Promise<void>;\n}\n","import { RouteType } from \"../types.d\";\n\nconst getAccessibleRoutes = (only?: RouteType[], exclude?: RouteType[], defaultExposeStrategy: \"all\" | \"none\" = \"all\"): RouteType[] => {\n    // eslint-disable-next-line max-len\n    let accessibleRoutes: RouteType[] = defaultExposeStrategy === \"none\" ? [] : [RouteType.READ_ALL, RouteType.READ_ONE, RouteType.UPDATE, RouteType.DELETE, RouteType.CREATE];\n\n    if (Array.isArray(only)) {\n        accessibleRoutes = only;\n    }\n\n    if (exclude?.length) {\n        accessibleRoutes = accessibleRoutes.filter((element) => !exclude.includes(element));\n    }\n\n    return accessibleRoutes;\n};\n\nexport default getAccessibleRoutes;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAMO,IAAK,YAAL,kBAAKA,eAAL;AACH,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,cAAW;AACX,EAAAA,WAAA,cAAW;AACX,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,YAAS;AALD,SAAAA;AAAA,GAAA;;;ACJZ,IAAM,sBAAsB,CAAC,MAAoB,SAAuB,wBAAwC,UAAuB;AAEnI,MAAI,mBAAgC,0BAA0B,SAAS,CAAC,IAAI,0HAA6F;AAEzK,MAAI,MAAM,QAAQ,IAAI,GAAG;AACrB,uBAAmB;AAAA,EACvB;AAEA,MAAI,mCAAS,QAAQ;AACjB,uBAAmB,iBAAiB,OAAO,CAAC,YAAY,CAAC,QAAQ,SAAS,OAAO,CAAC;AAAA,EACtF;AAEA,SAAO;AACX;AAEA,IAAO,gCAAQ;","names":["RouteType"]}
+{"version":3,"sources":["../src/types.d.ts","../src/utils/get-accessible-routes.ts"],"sourcesContent":["import type { Handler as CreateHandler } from \"./handler/create\";\nimport type { Handler as DeleteHandler } from \"./handler/delete\";\nimport type { Handler as ListHandler } from \"./handler/list\";\nimport type { Handler as GetHandler } from \"./handler/read\";\nimport type { Handler as UpdateHandler } from \"./handler/update\";\n\nexport enum RouteType {\n    CREATE = \"CREATE\",\n    READ_ALL = \"READ_ALL\",\n    READ_ONE = \"READ_ONE\",\n    UPDATE = \"UPDATE\",\n    DELETE = \"DELETE\",\n}\n\nexport type ModelOption = {\n    name?: string\n    only?: RouteType[]\n    exclude?: RouteType[]\n    formatResourceId?: (resourceId: string) => string | number\n};\n\nexport type ModelsOptions<M extends string = string> = {\n    [key in M]?: ModelOption\n};\n\nexport type HandlerOptions<M extends string = string> = {\n    formatResourceId?: (resourceId: string) => string | number;\n    models?: ModelsOptions<M>;\n    exposeStrategy?: \"all\" | \"none\";\n    pagination?: PaginationConfig,\n    handlers?: {\n        create?: CreateHandler;\n        delete?: DeleteHandler;\n        get?: GetHandler;\n        list?: ListHandler;\n        update?: UpdateHandler;\n    },\n};\n\nexport type PaginationConfig = {\n    perPage: number\n};\n\nexport interface HandlerParameters<T, Q> {\n    adapter: Adapter<T, Q>;\n    query: Q;\n    resourceName: string;\n}\n\nexport interface UniqueResourceHandlerParameters<T, Q> {\n    adapter: Adapter<T, Q>;\n    query: Q;\n    resourceName: string;\n    resourceId: string | number;\n}\n\nexport interface Adapter<T, Q, M extends string = string> {\n    models?: M[];\n    init?: () => Promise<void>;\n    parseQuery(resourceName: M, query: ParsedQueryParameters): Q;\n    getAll(resourceName: M, query: Q): Promise<T[]>;\n    getOne(resourceName: M, resourceId: string | number, query: Q): Promise<T>;\n    create(resourceName: M, data: any, query: Q): Promise<T>;\n    update(resourceName: M, resourceId: string | number, data: any, query: Q): Promise<T>;\n    delete(resourceName: M, resourceId: string | number, query: Q): Promise<T>;\n    getPaginationData(resourceName: M, query: Q): Promise<PaginationData>;\n    getModels(): M[];\n    connect?: () => Promise<void>;\n    disconnect?: () => Promise<void>;\n    handleError?: (error: Error) => void;\n    mapModelsToRouteNames?: () => Promise<{ [key in M]?: string }>;\n}\n\nexport type PaginationData = {\n    total: number\n    pageCount: number\n    page: number\n};\n\nexport type RecursiveField = {\n    [key: string]: boolean | TRecursiveField;\n};\n\nexport type WhereOperator = \"$eq\" | \"$neq\" | \"$in\" | \"$notin\" | \"$lt\" | \"$lte\" | \"$gt\" | \"$gte\" | \"$cont\" | \"$starts\" | \"$ends\" | \"$isnull\";\n\nexport type SearchCondition = string | boolean | number | Date | null;\n\nexport type WhereCondition = {\n    [key in TWhereOperator]?: TSearchCondition;\n};\n\nexport type Condition = {\n    [key: string]: TSearchCondition | TWhereCondition | TCondition;\n};\n\nexport type WhereField = Condition & {\n    $and?: TCondition | TCondition[];\n    $or?: TCondition | TCondition[];\n    $not?: TCondition | TCondition[];\n};\n\nexport type OrderByOperator = \"$asc\" | \"$desc\";\n\nexport type OrderByField = {\n    [key: string]: TOrderByOperator;\n};\n\nexport interface ParsedQueryParameters {\n    select?: RecursiveField;\n    include?: RecursiveField;\n    where?: WhereField;\n    orderBy?: OrderByField;\n    limit?: number;\n    skip?: number;\n    distinct?: string;\n    page?: number;\n    originalQuery?: {\n        [key: string]: any;\n    };\n}\n\nexport interface ExecuteHandler<Request, Response> {\n    (request: Request, response: Response): Promise<void>;\n}\n","import { RouteType } from \"../types.d\";\n\nconst getAccessibleRoutes = (only?: RouteType[], exclude?: RouteType[], defaultExposeStrategy: \"all\" | \"none\" = \"all\"): RouteType[] => {\n    // eslint-disable-next-line max-len\n    let accessibleRoutes: RouteType[] = defaultExposeStrategy === \"none\" ? [] : [RouteType.READ_ALL, RouteType.READ_ONE, RouteType.UPDATE, RouteType.DELETE, RouteType.CREATE];\n\n    if (Array.isArray(only)) {\n        accessibleRoutes = only;\n    }\n\n    if (exclude?.length) {\n        accessibleRoutes = accessibleRoutes.filter((element) => !exclude.includes(element));\n    }\n\n    return accessibleRoutes;\n};\n\nexport default getAccessibleRoutes;\n"],"mappings":";AAMO,IAAK,YAAL,kBAAKA,eAAL;AACH,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,cAAW;AACX,EAAAA,WAAA,cAAW;AACX,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,YAAS;AALD,SAAAA;AAAA,GAAA;;;ACJZ,IAAM,sBAAsB,CAAC,MAAoB,SAAuB,wBAAwC,UAAuB;AAEnI,MAAI,mBAAgC,0BAA0B,SAAS,CAAC,IAAI,0HAA6F;AAEzK,MAAI,MAAM,QAAQ,IAAI,GAAG;AACrB,uBAAmB;AAAA,EACvB;AAEA,MAAI,mCAAS,QAAQ;AACjB,uBAAmB,iBAAiB,OAAO,CAAC,YAAY,CAAC,QAAQ,SAAS,OAAO,CAAC;AAAA,EACtF;AAEA,SAAO;AACX;AAEA,IAAO,gCAAQ;","names":["RouteType"]}

package/dist/chunk-ZY3WOLEP.js

@@ -0,0 +1,28 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/types.d.ts
+var RouteType = /* @__PURE__ */ ((RouteType2) => {
+  RouteType2["CREATE"] = "CREATE";
+  RouteType2["READ_ALL"] = "READ_ALL";
+  RouteType2["READ_ONE"] = "READ_ONE";
+  RouteType2["UPDATE"] = "UPDATE";
+  RouteType2["DELETE"] = "DELETE";
+  return RouteType2;
+})(RouteType || {});
+
+// src/utils/get-accessible-routes.ts
+var getAccessibleRoutes = (only, exclude, defaultExposeStrategy = "all") => {
+  let accessibleRoutes = defaultExposeStrategy === "none" ? [] : ["READ_ALL" /* READ_ALL */, "READ_ONE" /* READ_ONE */, "UPDATE" /* UPDATE */, "DELETE" /* DELETE */, "CREATE" /* CREATE */];
+  if (Array.isArray(only)) {
+    accessibleRoutes = only;
+  }
+  if (exclude == null ? void 0 : exclude.length) {
+    accessibleRoutes = accessibleRoutes.filter((element) => !exclude.includes(element));
+  }
+  return accessibleRoutes;
+};
+var get_accessible_routes_default = getAccessibleRoutes;
+
+
+
+
+exports.RouteType = RouteType; exports.get_accessible_routes_default = get_accessible_routes_default;
+//# sourceMappingURL=chunk-ZY3WOLEP.js.map

package/dist/chunk-ZY3WOLEP.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.d.ts","../src/utils/get-accessible-routes.ts"],"names":["RouteType"],"mappings":";AAMO,IAAK,YAAL,kBAAKA,eAAL;AACH,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,cAAW;AACX,EAAAA,WAAA,cAAW;AACX,EAAAA,WAAA,YAAS;AACT,EAAAA,WAAA,YAAS;AALD,SAAAA;AAAA,GAAA;;;ACJZ,IAAM,sBAAsB,CAAC,MAAoB,SAAuB,wBAAwC,UAAuB;AAEnI,MAAI,mBAAgC,0BAA0B,SAAS,CAAC,IAAI,0HAA6F;AAEzK,MAAI,MAAM,QAAQ,IAAI,GAAG;AACrB,uBAAmB;AAAA,EACvB;AAEA,MAAI,mCAAS,QAAQ;AACjB,uBAAmB,iBAAiB,OAAO,CAAC,YAAY,CAAC,QAAQ,SAAS,OAAO,CAAC;AAAA,EACtF;AAEA,SAAO;AACX;AAEA,IAAO,gCAAQ","sourcesContent":["import type { Handler as CreateHandler } from \"./handler/create\";\nimport type { Handler as DeleteHandler } from \"./handler/delete\";\nimport type { Handler as ListHandler } from \"./handler/list\";\nimport type { Handler as GetHandler } from \"./handler/read\";\nimport type { Handler as UpdateHandler } from \"./handler/update\";\n\nexport enum RouteType {\n    CREATE = \"CREATE\",\n    READ_ALL = \"READ_ALL\",\n    READ_ONE = \"READ_ONE\",\n    UPDATE = \"UPDATE\",\n    DELETE = \"DELETE\",\n}\n\nexport type ModelOption = {\n    name?: string\n    only?: RouteType[]\n    exclude?: RouteType[]\n    formatResourceId?: (resourceId: string) => string | number\n};\n\nexport type ModelsOptions<M extends string = string> = {\n    [key in M]?: ModelOption\n};\n\nexport type HandlerOptions<M extends string = string> = {\n    formatResourceId?: (resourceId: string) => string | number;\n    models?: ModelsOptions<M>;\n    exposeStrategy?: \"all\" | \"none\";\n    pagination?: PaginationConfig,\n    handlers?: {\n        create?: CreateHandler;\n        delete?: DeleteHandler;\n        get?: GetHandler;\n        list?: ListHandler;\n        update?: UpdateHandler;\n    },\n};\n\nexport type PaginationConfig = {\n    perPage: number\n};\n\nexport interface HandlerParameters<T, Q> {\n    adapter: Adapter<T, Q>;\n    query: Q;\n    resourceName: string;\n}\n\nexport interface UniqueResourceHandlerParameters<T, Q> {\n    adapter: Adapter<T, Q>;\n    query: Q;\n    resourceName: string;\n    resourceId: string | number;\n}\n\nexport interface Adapter<T, Q, M extends string = string> {\n    models?: M[];\n    init?: () => Promise<void>;\n    parseQuery(resourceName: M, query: ParsedQueryParameters): Q;\n    getAll(resourceName: M, query: Q): Promise<T[]>;\n    getOne(resourceName: M, resourceId: string | number, query: Q): Promise<T>;\n    create(resourceName: M, data: any, query: Q): Promise<T>;\n    update(resourceName: M, resourceId: string | number, data: any, query: Q): Promise<T>;\n    delete(resourceName: M, resourceId: string | number, query: Q): Promise<T>;\n    getPaginationData(resourceName: M, query: Q): Promise<PaginationData>;\n    getModels(): M[];\n    connect?: () => Promise<void>;\n    disconnect?: () => Promise<void>;\n    handleError?: (error: Error) => void;\n    mapModelsToRouteNames?: () => Promise<{ [key in M]?: string }>;\n}\n\nexport type PaginationData = {\n    total: number\n    pageCount: number\n    page: number\n};\n\nexport type RecursiveField = {\n    [key: string]: boolean | TRecursiveField;\n};\n\nexport type WhereOperator = \"$eq\" | \"$neq\" | \"$in\" | \"$notin\" | \"$lt\" | \"$lte\" | \"$gt\" | \"$gte\" | \"$cont\" | \"$starts\" | \"$ends\" | \"$isnull\";\n\nexport type SearchCondition = string | boolean | number | Date | null;\n\nexport type WhereCondition = {\n    [key in TWhereOperator]?: TSearchCondition;\n};\n\nexport type Condition = {\n    [key: string]: TSearchCondition | TWhereCondition | TCondition;\n};\n\nexport type WhereField = Condition & {\n    $and?: TCondition | TCondition[];\n    $or?: TCondition | TCondition[];\n    $not?: TCondition | TCondition[];\n};\n\nexport type OrderByOperator = \"$asc\" | \"$desc\";\n\nexport type OrderByField = {\n    [key: string]: TOrderByOperator;\n};\n\nexport interface ParsedQueryParameters {\n    select?: RecursiveField;\n    include?: RecursiveField;\n    where?: WhereField;\n    orderBy?: OrderByField;\n    limit?: number;\n    skip?: number;\n    distinct?: string;\n    page?: number;\n    originalQuery?: {\n        [key: string]: any;\n    };\n}\n\nexport interface ExecuteHandler<Request, Response> {\n    (request: Request, response: Response): Promise<void>;\n}\n","import { RouteType } from \"../types.d\";\n\nconst getAccessibleRoutes = (only?: RouteType[], exclude?: RouteType[], defaultExposeStrategy: \"all\" | \"none\" = \"all\"): RouteType[] => {\n    // eslint-disable-next-line max-len\n    let accessibleRoutes: RouteType[] = defaultExposeStrategy === \"none\" ? [] : [RouteType.READ_ALL, RouteType.READ_ONE, RouteType.UPDATE, RouteType.DELETE, RouteType.CREATE];\n\n    if (Array.isArray(only)) {\n        accessibleRoutes = only;\n    }\n\n    if (exclude?.length) {\n        accessibleRoutes = accessibleRoutes.filter((element) => !exclude.includes(element));\n    }\n\n    return accessibleRoutes;\n};\n\nexport default getAccessibleRoutes;\n"]}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { PrismaClient } from '@prisma/client';
 import { S as SearchCondition, C as Condition, A as Adapter, P as PaginationData, a as ParsedQueryParameters, R as RouteType, M as ModelsOptions } from './types.d-6817d247.js';
 export { A as Adapter, C as Condition, c as CrudHandlerOptions, H as HandlerParameters, d as ModelOption, M as ModelsOptions, O as OrderByField, e as OrderByOperator, b as PaginationConfig, P as PaginationData, a as ParsedQueryParameters, f as RecursiveField, R as RouteType, S as SearchCondition, U as UniqueResourceHandlerParameters, h as WhereCondition, W as WhereField, g as WhereOperator } from './types.d-6817d247.js';
+import { OpenAPIV3 } from 'openapi-types';
 
 type PrismaRecursiveField = "select" | "include";
 
@@ -95,15 +96,6 @@ type SwaggerOperation = {
     response: SwaggerType;
 };
 
-type SwaggerTag = {
-    name?: string;
-    description?: string;
-    externalDocs?: {
-        description: string;
-        url: string;
-    };
-};
-
 type SwaggerParameter = {
     name: string;
     description?: string;
@@ -113,7 +105,7 @@ type SwaggerParameter = {
 };
 
 type ModelsConfig = {
-    tag: SwaggerTag;
+    tag: OpenAPIV3.TagObject;
     type?: SwaggerType;
     routeTypes?: {
         [RouteType.READ_ALL]?: SwaggerOperation;
@@ -130,12 +122,14 @@ type SwaggerModelsConfig<M extends string> = {
 };
 
 declare const modelsToOpenApi: <M extends string = string>({ prismaClient, models: ctorModels, swagger, crud, defaultExposeStrategy, }: ModelsToOpenApiParameters<M>) => Promise<{
-    schemas: any;
-    examples: {};
-    tags: SwaggerTag[];
-    paths: {
-        [key: string]: any;
+    schemas: {
+        [key: string]: OpenAPIV3.SchemaObject | OpenAPIV3.ReferenceObject;
+    };
+    examples: {
+        [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;
     };
+    tags: OpenAPIV3.TagObject[];
+    paths: OpenAPIV3.PathsObject;
 }>;
 interface ModelsToOpenApiParameters<M extends string = string> {
     prismaClient: PrismaClient;

package/dist/index.js

@@ -1,7 +1,7 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
 
 
-var _chunkFJWRITBOjs = require('./chunk-FJWRITBO.js');
+var _chunkZY3WOLEPjs = require('./chunk-ZY3WOLEP.js');
 
 // src/adapter/prisma/index.ts
 var _httperrors = require('http-errors'); var _httperrors2 = _interopRequireDefault(_httperrors);
@@ -58,16 +58,12 @@ var parse_order_by_default = parsePrismaOrderBy;
 var parsePrismaRecursiveField = (select, fieldName) => {
   const parsed = {};
   Object.keys(select).forEach((field) => {
-    if (select[field] !== true) {
-      parsed[field] = {
-        [fieldName]: parsePrismaRecursiveField(
-          select[field],
-          fieldName
-        )
-      };
-    } else {
-      parsed[field] = true;
-    }
+    parsed[field] = select[field] === true ? true : {
+      [fieldName]: parsePrismaRecursiveField(
+        select[field],
+        fieldName
+      )
+    };
   });
   return parsed;
 };
@@ -226,7 +222,7 @@ var PrismaAdapter = class {
   async init() {
     const models = this.ctorModels;
     const prismaDmmfModels = await this.getPrismaClientModels();
-    if (typeof models !== "undefined") {
+    if (models !== void 0) {
       models.forEach((model) => {
         if (!Object.keys(prismaDmmfModels).includes(model)) {
           throw new Error(`Model name ${model} is invalid.`);
@@ -268,10 +264,10 @@ var PrismaAdapter = class {
     if (query.orderBy) {
       parsed.orderBy = parse_order_by_default(query.orderBy);
     }
-    if (typeof query.limit !== "undefined") {
+    if (query.limit !== void 0) {
       parsed.take = query.limit;
     }
-    if (typeof query.skip !== "undefined") {
+    if (query.skip !== void 0) {
       parsed.skip = query.skip;
     }
     if ((_b = query.originalQuery) == null ? void 0 : _b.cursor) {
@@ -624,29 +620,21 @@ var PrismaJsonSchemaParser = class {
       const values = {};
       Object.entries((model == null ? void 0 : model.properties) || {}).forEach(([key, v]) => {
         const type = v.type;
-        if (type === "array") {
-          values[key] = [arrayItemsToSchema(v.items)];
-        } else {
-          values[key] = type;
-        }
+        values[key] = type === "array" ? [arrayItemsToSchema(v.items)] : type;
       });
       return values;
     };
     const objectPropertiesToSchema = (objectProperties) => {
       const values = {};
       Object.entries(objectProperties).forEach(([key, value]) => {
-        if (typeof value.$ref !== "undefined") {
-          values[key] = referenceToSchema(value.$ref);
-        } else {
-          values[key] = value.type;
-        }
+        values[key] = value.$ref === void 0 ? value.type : referenceToSchema(value.$ref);
       });
       return values;
     };
     const arrayItemsToSchema = (items) => {
       const values = {};
       Object.entries(items).forEach(([key, value]) => {
-        if (typeof value.items.$ref !== "undefined") {
+        if (value.items.$ref !== void 0) {
           values[key] = [referenceToSchema(value.items.$ref)];
         } else if (value.type === "array") {
           values[key] = [arrayItemsToSchema(value.items)];
@@ -681,6 +669,9 @@ var PrismaJsonSchemaParser = class {
         [`${modelName}`]: {
           value
         },
+        [`${modelName}s`]: {
+          value: [value]
+        },
         [`${modelName}Page`]: {
           value: {
             data: [value],
@@ -726,12 +717,12 @@ var getModelsAccessibleRoutes = (modelNames, models, defaultExposeStrategy = "al
   if (models == null ? void 0 : models[modelName]) {
     return {
       ...accumulator,
-      [modelName]: _chunkFJWRITBOjs.get_accessible_routes_default.call(void 0, models[modelName].only, models[modelName].exclude, defaultExposeStrategy)
+      [modelName]: _chunkZY3WOLEPjs.get_accessible_routes_default.call(void 0, models[modelName].only, models[modelName].exclude, defaultExposeStrategy)
     };
   }
   return {
     ...accumulator,
-    [modelName]: _chunkFJWRITBOjs.get_accessible_routes_default.call(void 0, void 0, void 0, defaultExposeStrategy)
+    [modelName]: _chunkZY3WOLEPjs.get_accessible_routes_default.call(void 0, void 0, void 0, defaultExposeStrategy)
   };
 }, {});
 var get_models_accessible_routes_default = getModelsAccessibleRoutes;
@@ -841,7 +832,8 @@ var generateSwaggerResponse = (routeType, modelName) => {
         description: `${modelName} created`,
         content: {
           "application/json": {
-            schema: generateContentForSchema(modelName)
+            schema: generateContentForSchema(modelName),
+            example: format_example_ref_default(modelName)
           }
         }
       }
@@ -854,7 +846,8 @@ var generateSwaggerResponse = (routeType, modelName) => {
         description: `${modelName} item deleted`,
         content: {
           "application/json": {
-            schema: generateContentForSchema(modelName)
+            schema: generateContentForSchema(modelName),
+            example: format_example_ref_default(modelName)
           }
         }
       }
@@ -872,7 +865,7 @@ var generateSwaggerResponse = (routeType, modelName) => {
             },
             examples: {
               Default: {
-                $ref: format_example_ref_default(`${modelName}`)
+                $ref: format_example_ref_default(`${modelName}s`)
               },
               Pagination: {
                 $ref: format_example_ref_default(`${modelName}Page`)
@@ -890,7 +883,8 @@ var generateSwaggerResponse = (routeType, modelName) => {
         description: `${modelName} item retrieved`,
         content: {
           "application/json": {
-            schema: generateContentForSchema(modelName)
+            schema: generateContentForSchema(modelName),
+            example: format_example_ref_default(modelName)
           }
         }
       }
@@ -903,7 +897,8 @@ var generateSwaggerResponse = (routeType, modelName) => {
         description: `${modelName} item updated`,
         content: {
           "application/json": {
-            schema: generateContentForSchema(modelName)
+            schema: generateContentForSchema(modelName),
+            example: format_example_ref_default(modelName)
           }
         }
       }
@@ -956,7 +951,7 @@ var generateSwaggerPathObject = ({
       const returnType = _nullishCoalesce(_nullishCoalesce(((_d = (_c = (_b = (_a = modelsConfig == null ? void 0 : modelsConfig[modelName]) == null ? void 0 : _a.routeTypes) == null ? void 0 : _b[routeType]) == null ? void 0 : _c.response) == null ? void 0 : _d.name), () => ( ((_f = (_e = modelsConfig == null ? void 0 : modelsConfig[modelName]) == null ? void 0 : _e.type) == null ? void 0 : _f.name))), () => ( modelName));
       const method = getRouteTypeMethod(routeType);
       const response = generateSwaggerResponse(routeType, returnType);
-      if (typeof response === "undefined") {
+      if (response === void 0) {
         throw new TypeError(`Route type ${routeType}; response config was not found.`);
       }
       methods[method] = {
@@ -1040,6 +1035,30 @@ var getSwaggerTags = (modelNames, modelsConfig) => modelNames.map((modelName) =>
 var get_swagger_tags_default = getSwaggerTags;
 
 // src/swagger/adapter/prisma/index.ts
+var overwritePathsExampleWithModel = (swaggerPaths, examples) => {
+  Object.values(swaggerPaths).forEach((pathSpec) => {
+    Object.values(pathSpec).forEach((methodSpec) => {
+      if (typeof methodSpec.responses === "object") {
+        Object.values(methodSpec.responses).forEach((responseSpec) => {
+          if (typeof responseSpec.content === "object") {
+            Object.values(
+              responseSpec.content
+            ).forEach((contentSpec) => {
+              var _a;
+              if (typeof contentSpec.example === "string") {
+                const example = contentSpec.example.replace("#/components/examples/", "");
+                if (typeof examples[example] !== void 0 && typeof ((_a = examples[example]) == null ? void 0 : _a.value) !== void 0) {
+                  contentSpec.example = examples[example].value;
+                }
+              }
+            });
+          }
+        });
+      }
+    });
+  });
+  return swaggerPaths;
+};
 var modelsToOpenApi = async ({
   prismaClient,
   models: ctorModels,
@@ -1068,7 +1087,7 @@ var modelsToOpenApi = async ({
     ...parser.getPaginationDataSchema(),
     ...parser.getPaginatedModelsSchemas(dModels)
   });
-  if (typeof ctorModels !== "undefined") {
+  if (ctorModels !== void 0) {
     ctorModels.forEach((model) => {
       if (!Object.keys(prismaDmmfModels).includes(model)) {
         throw new Error(`Model name ${model} is invalid.`);
@@ -1085,11 +1104,12 @@ var modelsToOpenApi = async ({
     routesMap: models_to_route_names_default(prismaDmmfModels, models)
   });
   const schemas = JSON.parse(schema.replace(/#\/definitions/g, "#/components/schemas"));
+  const examples = parser.getExampleModelsSchemas(dModels, schemas);
   return {
     schemas,
-    examples: parser.getExampleModelsSchemas(dModels, schemas),
+    examples,
     tags: swaggerTags,
-    paths: swaggerPaths
+    paths: overwritePathsExampleWithModel(swaggerPaths, examples)
   };
 };
 var prisma_default = modelsToOpenApi;
@@ -1097,5 +1117,5 @@ var prisma_default = modelsToOpenApi;
 
 
 
-exports.PrismaAdapter = PrismaAdapter; exports.RouteType = _chunkFJWRITBOjs.RouteType; exports.modelsToOpenApi = prisma_default;
+exports.PrismaAdapter = PrismaAdapter; exports.RouteType = _chunkZY3WOLEPjs.RouteType; exports.modelsToOpenApi = prisma_default;
 //# sourceMappingURL=index.js.map