crud-query-parser 0.0.1 → 0.0.3

package/dist/request-parser-WaQBZsYG.d.mts

@@ -0,0 +1,31 @@
+import { c as CrudRequest } from './crud-request-CvDKp6Iy.mjs';
+
+interface OpenAPIParameter {
+    name: string;
+    description?: string;
+    required?: boolean;
+    schema?: OpenAPISchema;
+    style?: string;
+    explode?: boolean;
+}
+interface OpenAPISchema {
+    type: string;
+    default?: string;
+    items?: OpenAPISchema;
+}
+
+type RequestParamValue = string | string[] | undefined;
+interface RequestParser {
+    /**
+     * Parses a query string into a parsed request object
+     *
+     * @param query The query string map
+     */
+    parse(query: Record<string, RequestParamValue>): CrudRequest;
+    /**
+     * Gets the OpenAPI query parameters documentation
+     */
+    getOpenAPIParameters(): OpenAPIParameter[];
+}
+
+export type { OpenAPIParameter as O, RequestParamValue as R, RequestParser as a };

package/package.json

@@ -1,18 +1,33 @@
 {
   "name": "crud-query-parser",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Parses HTTP requests and converts them into database queries",
+  "keywords": [
+    "crud",
+    "http",
+    "query",
+    "request",
+    "parser",
+    "typeorm",
+    "nestjs"
+  ],
   "license": "MIT",
   "author": "Guilherme Chaguri",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Guichaguri/crud-query-parser.git"
+  },
   "scripts": {
     "build": "tsup",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "sample:typeorm": "ts-node ./samples/typeorm/index.ts"
   },
   "tsup": {
     "entry": [
       "src/index.ts",
       "src/adapters/typeorm/index.ts",
       "src/parsers/crud/index.ts",
+      "src/helpers/nestjs/index.ts",
       "src/filters/index.ts"
     ],
     "target": "es2022",
@@ -67,6 +82,16 @@
         "types": "./dist/parsers/crud/index.d.ts"
       }
     },
+    "./helpers/nestjs": {
+      "import": {
+        "default": "./dist/helpers/nestjs/index.mjs",
+        "types": "./dist/helpers/nestjs/index.d.mts"
+      },
+      "require": {
+        "default": "./dist/helpers/nestjs/index.js",
+        "types": "./dist/helpers/nestjs/index.d.ts"
+      }
+    },
     "./filters": {
       "import": {
         "default": "./dist/filters/index.mjs",
@@ -100,6 +125,7 @@
     "@types/node": "^17.0.23",
     "reflect-metadata": "^0.2.2",
     "sqlite3": "^5.1.7",
+    "ts-node": "^10.9.2",
     "tsup": "^8.1.0",
     "typeorm": "^0.3.20",
     "typescript": "^5.5.2"

package/dist/parsed-request-where.builder-CTGRmvAX.d.ts

@@ -1,42 +0,0 @@
-import { c as CrudRequest, e as CrudRequestWhereAND, f as CrudRequestWhereOR, i as CrudRequestWhereOperator, h as CrudRequestWhereValueType, d as CrudRequestWhere } from './crud-request-CvDKp6Iy.js';
-
-type RequestParamValue = string | string[] | undefined;
-interface RequestParser {
-    /**
-     * Parses a query string into a parsed request object
-     *
-     * @param query The query string map
-     */
-    parse(query: Record<string, RequestParamValue>): CrudRequest;
-}
-
-/**
- * A helper class that makes it easier to create a CrudRequestWhere
- */
-declare class ParsedRequestWhereBuilder {
-    private readonly where;
-    private readonly parent?;
-    constructor(where?: CrudRequestWhereAND | CrudRequestWhereOR, parent?: ParsedRequestWhereBuilder | undefined);
-    /**
-     * Adds an AND bracket
-     */
-    addAnd(): ParsedRequestWhereBuilder;
-    /**
-     * Adds an OR bracket
-     */
-    addOr(): ParsedRequestWhereBuilder;
-    /**
-     * Adds a field comparison
-     *
-     * @param field The field path
-     * @param operator The comparison operator
-     * @param value The value to compare
-     */
-    addField(field: string[], operator: CrudRequestWhereOperator, value: CrudRequestWhereValueType): ParsedRequestWhereBuilder;
-    /**
-     * Constructs the final where condition
-     */
-    build(): CrudRequestWhere;
-}
-
-export { ParsedRequestWhereBuilder as P, type RequestParamValue as R, type RequestParser as a };

package/dist/parsed-request-where.builder-LCWNWCt6.d.mts

@@ -1,42 +0,0 @@
-import { c as CrudRequest, e as CrudRequestWhereAND, f as CrudRequestWhereOR, i as CrudRequestWhereOperator, h as CrudRequestWhereValueType, d as CrudRequestWhere } from './crud-request-CvDKp6Iy.mjs';
-
-type RequestParamValue = string | string[] | undefined;
-interface RequestParser {
-    /**
-     * Parses a query string into a parsed request object
-     *
-     * @param query The query string map
-     */
-    parse(query: Record<string, RequestParamValue>): CrudRequest;
-}
-
-/**
- * A helper class that makes it easier to create a CrudRequestWhere
- */
-declare class ParsedRequestWhereBuilder {
-    private readonly where;
-    private readonly parent?;
-    constructor(where?: CrudRequestWhereAND | CrudRequestWhereOR, parent?: ParsedRequestWhereBuilder | undefined);
-    /**
-     * Adds an AND bracket
-     */
-    addAnd(): ParsedRequestWhereBuilder;
-    /**
-     * Adds an OR bracket
-     */
-    addOr(): ParsedRequestWhereBuilder;
-    /**
-     * Adds a field comparison
-     *
-     * @param field The field path
-     * @param operator The comparison operator
-     * @param value The value to compare
-     */
-    addField(field: string[], operator: CrudRequestWhereOperator, value: CrudRequestWhereValueType): ParsedRequestWhereBuilder;
-    /**
-     * Constructs the final where condition
-     */
-    build(): CrudRequestWhere;
-}
-
-export { ParsedRequestWhereBuilder as P, type RequestParamValue as R, type RequestParser as a };