Merge pull request #78 from laravel/fix-url-defaults-typing

Fix type errors for URL default methods

Author: joetannenbaum

package.json

@@ -1,10 +1,11 @@
 {
     "type": "module",
     "scripts": {
-        "test": "vitest run && npm run lint && npm run test-routes-cached && npm run lint",
+        "test": "vitest run && npm run lint && npm run test-routes-cached && npm run lint && npm run tsc",
         "test-routes-cached": "WAYFINDER_CACHE_ROUTES=1 vitest run",
         "lint": "eslint ./workbench/resources/js --ext .ts,.tsx",
-        "lint:fix": "eslint ./workbench/resources/js --ext .ts,.tsx --fix"
+        "lint:fix": "eslint ./workbench/resources/js --ext .ts,.tsx --fix",
+        "tsc": "tsc --noEmit"
     },
     "devDependencies": {
         "@eslint/js": "^9.29.0",

resources/js/wayfinder.ts

@@ -11,7 +11,7 @@ export type QueryParams = Record<
 
 type Method = "get" | "post" | "put" | "delete" | "patch" | "head";
 
-let urlDefaults = {};
+let urlDefaults: Record<string, unknown> = {};
 
 export type RouteDefinition<TMethod extends Method | Method[]> = {
     url: string;
@@ -75,12 +75,19 @@ export const queryParams = (options?: RouteQueryOptions) => {
             });
 
             for (const subKey in query[key]) {
-                if (typeof query[key][subKey] === 'undefined') {
+                if (typeof query[key][subKey] === "undefined") {
                     continue;
                 }
 
-                if (['string', 'number', 'boolean'].includes(typeof query[key][subKey])) {
-                    params.set(`${key}[${subKey}]`, getValue(query[key][subKey]));
+                if (
+                    ["string", "number", "boolean"].includes(
+                        typeof query[key][subKey],
+                    )
+                ) {
+                    params.set(
+                        `${key}[${subKey}]`,
+                        getValue(query[key][subKey]),
+                    );
                 }
             }
         } else {
@@ -104,19 +111,21 @@ export const addUrlDefault = (
     urlDefaults[key] = value;
 };
 
-export const applyUrlDefaults = <T>(existing: T): T => {
-    const existingParams = { ...existing };
+export const applyUrlDefaults = <T extends Record<string, unknown> | undefined>(
+    existing: T,
+): T => {
+    const existingParams = { ...(existing ?? ({} as Record<string, unknown>)) };
 
     for (const key in urlDefaults) {
         if (
             existingParams[key] === undefined &&
             urlDefaults[key] !== undefined
         ) {
-            existingParams[key] = urlDefaults[key];
+            (existingParams as Record<string, unknown>)[key] = urlDefaults[key];
         }
     }
 
-    return existingParams;
+    return existingParams as T;
 };
 
 export const validateParameters = (

tsconfig.json

@@ -0,0 +1,30 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "module": "ESNext",
+        "moduleResolution": "bundler",
+        "allowSyntheticDefaultImports": true,
+        "esModuleInterop": true,
+        "allowJs": true,
+        "strict": true,
+        "noImplicitAny": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "strictBindCallApply": true,
+        "strictPropertyInitialization": true,
+        "noImplicitThis": true,
+        "noImplicitReturns": true,
+        "noUncheckedIndexedAccess": true,
+        "skipLibCheck": true,
+        "forceConsistentCasingInFileNames": true,
+        "declaration": true,
+        "outDir": "./dist",
+        "rootDir": "."
+    },
+    "include": [
+        "workbench/resources/js/**/*.ts",
+        "resources/js/**/*.ts",
+        "tests/**/*.ts"
+    ],
+    "exclude": ["node_modules", "dist"]
+}