feat: move next path utils out of the core lib

Author: oliverbutler

.changeset/clean-phones-push.md

@@ -0,0 +1,6 @@
+---
+'@ts-rest/core': patch
+'@ts-rest/next': patch
+---
+
+Move next lib utils out of @ts-rest/core to reduce bundle size

libs/ts-rest/core/src/index.ts

@@ -1,9 +1,7 @@
-export * from './lib/dsl';
 export * from './lib/client';
-export * from './lib/server-utils';
-export * from './lib/type-utils';
-export * from './lib/server-utils';
-export * from './lib/zod-utils';
-export * from './lib/status-codes';
+export * from './lib/dsl';
 export * from './lib/paths';
 export * from './lib/query';
+export * from './lib/status-codes';
+export * from './lib/type-utils';
+export * from './lib/zod-utils';

libs/ts-rest/core/src/lib/server-utils.spec.ts

@@ -0,0 +1,53 @@
+import { initContract } from '@ts-rest/core';
+import { getPathParamsFromArray } from './path-utils';
+
+const c = initContract();
+
+describe('getPathParamsFromArray', () => {
+  it('should extract params from array', () => {
+    const appRoute = c.query({
+      method: 'GET',
+      path: `/posts/:id`,
+      query: null,
+      responses: {
+        200: c.response<{ message: string }>(),
+      },
+    });
+
+    const pathParams = getPathParamsFromArray(['posts', '1'], appRoute);
+
+    expect(pathParams).toStrictEqual({ id: '1' });
+  });
+
+  it('should extract params from array with many path params', () => {
+    const appRoute = c.query({
+      method: 'GET',
+      path: `/posts/:id/comments/:commentId`,
+      query: null,
+      responses: {
+        200: c.response<{ message: string }>(),
+      },
+    });
+
+    const pathParams = getPathParamsFromArray(
+      ['posts', '1', 'comments', '2'],
+      appRoute
+    );
+
+    expect(pathParams).toStrictEqual({ id: '1', commentId: '2' });
+  });
+  it('should ignore any query params', () => {
+    const appRoute = c.query({
+      method: 'GET',
+      path: `/posts/:id`,
+      query: null,
+      responses: {
+        200: c.response<{ message: string }>(),
+      },
+    });
+
+    const pathParams = getPathParamsFromArray(['posts', '1'], appRoute);
+
+    expect(pathParams).toStrictEqual({ id: '1' });
+  });
+});

libs/ts-rest/next/src/lib/path-utils.spec.ts

@@ -1,20 +1,4 @@
-import { AppRoute } from './dsl';
-
-/**
- * Extract path params from url
- * @param url e.g. /posts/1/comments/2?unwanted-query-param=true
- * @param appRoute
- * @returns
- */
-export const getPathParamsFromUrl = (
-  url: string,
-  appRoute: AppRoute
-): Record<string, string> => {
-  const baseUrl = url.split('?')[0];
-  const baseUrlAsArr = baseUrl.split('/').slice(1);
-
-  return getPathParamsFromArray(baseUrlAsArr, appRoute);
-};
+import { AppRoute } from '@ts-rest/core';
 
 /**
  * Get path params from array of url segments

libs/ts-rest/core/src/lib/server-utils.ts libs/ts-rest/next/src/lib/path-utils.tslibs/ts-rest/core/src/lib/server-utils.ts renamed to libs/ts-rest/next/src/lib/path-utils.ts

@@ -1,7 +1,6 @@
 import { initContract } from '@ts-rest/core';
-import { NextApiResponse } from 'next';
+import { NextApiRequest, NextApiResponse } from 'next';
 import { createNextRoute, createNextRouter } from './ts-rest-next';
-import { mockReq } from './test-helpers';
 
 const c = initContract();
 
@@ -150,3 +149,25 @@ describe('createNextRouter', () => {
     });
   });
 });
+
+export const mockReq = (
+  url: string,
+  args: {
+    query?: Record<string, string>;
+    body?: unknown;
+    method: string;
+  }
+): NextApiRequest => {
+  const paramArray = url.split('/').splice(1);
+
+  const req = {
+    query: {
+      ...args.query,
+      ['ts-rest']: paramArray,
+    },
+    body: args.body,
+    method: args.method,
+  } as unknown as NextApiRequest;
+
+  return req;
+};

libs/ts-rest/next/src/lib/test-helpers.ts

@@ -12,11 +12,11 @@ import {
   AppRouteQuery,
   AppRouter,
   checkZodSchema,
-  getPathParamsFromArray,
   isAppRoute,
   PathParamsWithCustomValidators,
   ZodInferOrType,
 } from '@ts-rest/core';
+import { getPathParamsFromArray } from './path-utils';
 
 type RouteToQueryFunctionImplementation<T extends AppRouteQuery> = (args: {
   params: PathParamsWithCustomValidators<T>;