feat(params): allow [_-] in url params (#322)

.github/workflows/tests.yaml

@@ -19,6 +19,8 @@ jobs:
         run: yarn
       - name: build
         run: yarn build
+      - name: unit tests
+        run: yarn test --run
       - name: tests install
         working-directory: ./tests
         run: yarn

.husky/pre-commit

@@ -2,3 +2,4 @@
 . "$(dirname "$0")/_/husky.sh"
 
 yarn lint
+yarn test --run

package.json

@@ -44,6 +44,7 @@
     "build": "tsup ./src/bin/orval.ts ./src/index.ts --minify --clean --dts --splitting",
     "dev": "tsup ./src/bin/orval.ts ./src/index.ts --clean --watch src --onSuccess 'yarn generate-api'",
     "lint": "eslint src/**/*.ts",
+    "test": "vitest --global test.ts",
     "format": "prettier --write 'src/**/*.{js,ts}'",
     "prerelease": "yarn build && cd ./tests && yarn generate && yarn build",
     "release": "dotenv release-it",
@@ -88,6 +89,7 @@
     "rimraf": "^3.0.2",
     "tsup": "^5.11.13",
     "typescript": "^4.5.5",
+    "vitest": "^0.3.6",
     "zx": "^4.2.0"
   },
   "dependencies": {

src/core/getters/params.ts

@@ -1,5 +1,6 @@
 import { ContextSpecs } from '../../types';
 import { GetterParameters, GetterParams } from '../../types/getters';
+import { camel } from '../../utils/case';
 import { sanitize, stringify } from '../../utils/string';
 import { resolveValue } from '../resolvers/value';
 
@@ -40,7 +41,9 @@ export const getParams = ({
   return Promise.all(
     params.map(async (p) => {
       const pathParam = pathParams.find(
-        ({ parameter }) => sanitize(parameter.name) === p,
+        ({ parameter }) =>
+          camel(sanitize(parameter.name, { underscore: true, dash: true })) ===
+          p,
       );
 
       if (!pathParam) {
@@ -55,7 +58,7 @@ export const getParams = ({
         schema,
       } = pathParam.parameter;
 
-      const name = sanitize(nameWithoutSanitize);
+      const name = sanitize(camel(nameWithoutSanitize));
 
       if (!schema) {
         return {

src/core/getters/route.test.ts

@@ -0,0 +1,16 @@
+import { getRoute } from './route';
+
+describe('getRoute getter', () => {
+  [
+    ['/api/test/{id}', '/api/test/${id}'],
+    ['/api/test/{user_id}', '/api/test/${userId}'],
+    ['/api/test/{locale}.js', '/api/test/${locale}.js'],
+    ['/api/test/i18n-{locale}.js', '/api/test/i18n-${locale}.js'],
+    ['/api/test/{param1}-{param2}.js', '/api/test/${param1}-${param2}.js'],
+    ['/api/test/user{param1}-{param2}.html', '/api/test/user${param1}-${param2}.html']
+  ].forEach(([input, expected]) => {
+    it(`should process ${input} to ${expected}`, () => {
+      expect(getRoute(input)).toBe(expected);
+    });
+  });
+});

src/core/getters/route.ts

@@ -1,17 +1,19 @@
+import { camel } from '../../utils/case';
 import { sanitize } from '../../utils/string';
 
-const getRoutePath = (path: string) => {
-  return path.split('').reduce((acc, letter) => {
-    if (letter === '{') {
-      return acc + '${';
-    }
-
-    if (letter === '}') {
-      return acc + '}';
-    }
+const hasParam = (path: string) => /[^{]*{[\w_-]*}.*/.test(path)
 
-    return acc + sanitize(letter, { dot: true });
-  }, '');
+const getRoutePath = (path: string) => {
+  const matches = path.match(/([^{]*){?([\w_-]*)}?(.*)/)
+  if (!matches?.length) return path // impossible due to regexp grouping here, but for TS
+  const prev = matches[1]
+  const param = camel(sanitize(matches[2], { underscore: true, dash: true, dot: true }))
+  const next: string = hasParam(matches[3]) ? getRoutePath(matches[3]) : matches[3]
+  if (hasParam(path)) {
+    return `${prev}\${${param}}${next}`
+  } else {
+    return `${prev}${param}${next}`
+  }
 };
 
 export const getRoute = (route: string) => {