feat: allow raw queries for where filter

Add support for tests with and without query language

Author: SH-Exact

.github/workflows/main.yml

@@ -88,16 +88,30 @@ jobs:
           name: build
           path: dist
 
-      - name: Generate SDK for tests
+      - name: Run generator tests
+        run: npm run test:generator
+
+      - name: Generate SDK for tests with former query syntax
+        run: |
+          chmod +x ./bin/cli.js
+          ./bin/cli.js test/openapi_v3.json --target browser
+
+      - name: Run type-check (former-queries)
+        run: npm run type-check:former-queries
+
+      - name: Run tests (former-queries)
+        run: npm run test:former-queries
+
+      - name: Generate SDK for tests with query language
         run: |
           chmod +x ./bin/cli.js
           ./bin/cli.js test/openapi_v3.json --target browser --use-query-language
 
-      - name: Run type-check
-        run: npm run type-check
+      - name: Run type-check (query-language)
+        run: npm run type-check:query-language
 
-      - name: Run tests
-        run: npm run test
+      - name: Run tests (query-language)
+        run: npm run test:query-language
 
   publish:
     name: Publish release version

eslint.config.js

@@ -3,7 +3,7 @@ import tsEslint from 'typescript-eslint';
 export default tsEslint.config(
   {
     name: 'app/files-to-ignore',
-    ignores: ['**/*.d.ts', '**/.*', '**/dist', '**/sdk', '**/node_modules']
+    ignores: ['**/*.d.ts', '**/.*', '**/dist', '**/sdk', '**/node_modules', 'test/**']
   },
   {
     extends: [...tsEslint.configs.recommendedTypeChecked],

package.json

@@ -37,7 +37,7 @@
     }
   },
   "scripts": {
-    "build": "rollup --config rollup.config.ts --configPlugin typescript={tsconfig:\\'tsconfig.node.json\\'} --configImportAttributesKey with",
+    "build": "rollup --config rollup.config.ts --configPlugin typescript={tsconfig:'tsconfig.rollup.json'} --configImportAttributesKey with",
     "build:watch": "npm run build -- --watch",
     "cli:browser:v1": "./bin/cli.js test/openapi.json --target browser",
     "cli:browser.rx:v1": "./bin/cli.js test/openapi.json --target browser.rx",
@@ -54,12 +54,16 @@
     "cli:node.rx:cache": "./bin/cli.js test/openapi.json --target node.rx  --cache",
     "prettier": "prettier . --check",
     "prettier:fix": "prettier . --write",
-    "test": "vitest run",
+    "test:generator": "vitest run src/",
+    "test:former-queries": "vitest run test/former-queries/",
+    "test:query-language": "vitest run test/queries/",
     "test:coverage": "vitest run --coverage",
-    "type-check": "tsc -p tsconfig.node.json --noEmit --skipLibCheck",
+    "type-check:former-queries": "tsc -p tsconfig.typecheck-former-queries.json --noEmit --skipLibCheck",
+    "type-check:query-language": "tsc -p tsconfig.typecheck-query-language.json --noEmit --skipLibCheck",
     "lint": "eslint ./src --cache",
     "lint:fix": "npm run lint -- --fix",
-    "ci": "npm run prettier && npm run lint && npm run build && npm run cli:browser:v1 && npm run cli:browser:v2 && npm run cli:browser:v3 && npm run cli:browser:v3:ql && npm run type-check && npm run test",
+    "ci:test": "npm run test:generator && npm run cli:browser:v3 && npm run type-check:former-queries && npm run test:former-queries && npm run cli:browser:v3:ql && npm run type-check:query-language && npm run test:query-language",
+    "ci": "npm run prettier && npm run lint && npm run build && npm run cli:browser:v1 && npm run cli:browser:v2 && npm run cli:browser:v3 && npm run ci:test",
     "release": "standard-version"
   },
   "devDependencies": {

rollup.config.ts

@@ -20,7 +20,7 @@ const txt = (): Plugin => {
 
 export default defineConfig({
   input: 'src/index.ts',
-  plugins: [txt(), ts({ tsconfig: 'tsconfig.node.json' })],
+  plugins: [txt(), ts({ tsconfig: 'tsconfig.rollup.json' })],
   external: [
     ...Object.keys(pkg.dependencies),
     ...Object.keys(pkg.peerDependencies),

test/former-queries/filter.spec.ts

@@ -0,0 +1,105 @@
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+import { articleService, setGlobalConfig } from '@sdk/dist';
+
+describe('filter', () => {
+  let capturedRequest: Request;
+
+  beforeAll(() => {
+    setGlobalConfig({
+      host: 'test.example.com',
+      secure: true,
+      key: 'test-key',
+      interceptors: {
+        request: (request) => {
+          capturedRequest = request;
+          return new Response(
+            JSON.stringify({
+              result: [],
+              referencedEntities: {},
+              additionalProperties: {}
+            }),
+            {
+              status: 200,
+              headers: { 'content-type': 'application/json' }
+            }
+          );
+        }
+      }
+    });
+  });
+
+  describe('some query', () => {
+    it('should assemble a typed filter object into individual query params', async () => {
+      const service = articleService();
+
+      await service.some({
+        filter: {
+          articleNumber: { EQ: 'ART-001' }
+        }
+      });
+
+      const url = new URL(capturedRequest.url);
+      expect(url.searchParams.get('articleNumber-eq')).toBe('ART-001');
+    });
+
+    it('should pass sort as a comma-separated query param', async () => {
+      const service = articleService();
+
+      await service.some({
+        sort: [{ articleNumber: 'asc' }, { name: 'desc' }]
+      });
+
+      const url = new URL(capturedRequest.url);
+      expect(url.searchParams.get('sort')).toBe('articleNumber,-name');
+    });
+
+    it('should pass pagination as page and pageSize query params', async () => {
+      const service = articleService();
+
+      await service.some({
+        pagination: { page: 3, pageSize: 25 }
+      });
+
+      const url = new URL(capturedRequest.url);
+      expect(url.searchParams.get('page')).toBe('3');
+      expect(url.searchParams.get('pageSize')).toBe('25');
+    });
+
+    it('should combine filter, sort and pagination into a single request', async () => {
+      const service = articleService();
+
+      await service.some({
+        filter: {
+          articleNumber: { EQ: 'ART-001' }
+        },
+        sort: [{ articleNumber: 'asc' }],
+        pagination: { page: 1, pageSize: 10 }
+      });
+
+      const url = new URL(capturedRequest.url);
+      expect(url.searchParams.get('articleNumber-eq')).toBe('ART-001');
+      expect(url.searchParams.get('sort')).toBe('articleNumber');
+      expect(url.searchParams.get('page')).toBe('1');
+      expect(url.searchParams.get('pageSize')).toBe('10');
+    });
+  });
+
+  describe('count query', () => {
+    it('should assemble a typed filter object into individual query params', async () => {
+      const service = articleService();
+
+      await service.count({
+        filter: {
+          articleNumber: { EQ: 'ART-001' }
+        }
+      });
+
+      const url = new URL(capturedRequest.url);
+      expect(url.searchParams.get('articleNumber-eq')).toBe('ART-001');
+    });
+  });
+
+  afterAll(() => {
+    setGlobalConfig(undefined);
+  });
+});

tsconfig.json

@@ -6,6 +6,12 @@
     },
     {
       "path": "./tsconfig.sdk.json"
+    },
+    {
+      "path": "./tsconfig.typecheck-former-queries.json"
+    },
+    {
+      "path": "./tsconfig.typecheck-query-language.json"
     }
   ]
 }

tsconfig.node.json

@@ -23,5 +23,5 @@
       "@sdk/*": ["sdk/*"]
     }
   },
-  "include": ["src/**/*.ts", "test/**/*.spec.ts", "rollup.config.ts", "vitest.config.ts"]
+  "include": ["src/**/*.ts", "rollup.config.ts", "vitest.config.ts"]
 }

tsconfig.rollup.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.node.json",
+  "include": ["src/**/*.ts", "rollup.config.ts"]
+}

tsconfig.typecheck-former-queries.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.node.json",
+  "include": ["test/former-queries/**/*.spec.ts"]
+}

tsconfig.typecheck-query-language.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.node.json",
+  "include": ["test/queries/**/*.spec.ts"]
+}