lambder 1.0.133 → 1.0.134

package/dist/LambderMSW.d.ts

@@ -23,27 +23,32 @@ export default class LambderMSW<TContract extends ApiContractShape = any> {
      * @param apiName - The name of the API to mock
      * @param handler - Function that returns the mock payload
      * @param options - Additional response options (session expired, version expired, etc.)
+     *
+     * Note: TypeScript will check that the return type is assignable to the output type,
+     * but due to structural typing, extra properties are allowed. Enable strict checks
+     * in your tsconfig.json with "noUncheckedIndexedAccess" and "exactOptionalPropertyTypes"
+     * for better type safety.
      */
-    mockApi<TApiName extends keyof TContract & string>(apiName: TApiName, handler: (payload?: TContract[TApiName]['input']) => Promise<TContract[TApiName]['output']> | TContract[TApiName]['output'], options?: MockApiOptions): RequestHandler;
+    mockApi<TApiName extends keyof TContract>(apiName: TApiName, handler: (payload?: TContract[TApiName]['input']) => Promise<TContract[TApiName]['output']> | TContract[TApiName]['output'], options?: MockApiOptions): RequestHandler;
     /**
      * Mock an API endpoint that returns a session expired error
      */
-    mockSessionExpired<TApiName extends keyof TContract & string>(apiName: TApiName): RequestHandler;
+    mockSessionExpired<TApiName extends keyof TContract>(apiName: TApiName): RequestHandler;
     /**
      * Mock an API endpoint that returns a version expired error
      */
-    mockVersionExpired<TApiName extends keyof TContract & string>(apiName: TApiName): RequestHandler;
+    mockVersionExpired<TApiName extends keyof TContract>(apiName: TApiName): RequestHandler;
     /**
      * Mock an API endpoint that returns a not authorized error
      */
-    mockNotAuthorized<TApiName extends keyof TContract & string>(apiName: TApiName): RequestHandler;
+    mockNotAuthorized<TApiName extends keyof TContract>(apiName: TApiName): RequestHandler;
     /**
      * Mock an API endpoint that returns an error message
      */
-    mockError<TApiName extends keyof TContract & string>(apiName: TApiName, errorMessage: string): RequestHandler;
+    mockError<TApiName extends keyof TContract>(apiName: TApiName, errorMessage: string): RequestHandler;
     /**
      * Mock an API endpoint with a custom message
      */
-    mockWithMessage<TApiName extends keyof TContract & string>(apiName: TApiName, handler: (payload?: TContract[TApiName]['input']) => Promise<TContract[TApiName]['output']> | TContract[TApiName]['output'], message: any): RequestHandler;
+    mockWithMessage<TApiName extends keyof TContract>(apiName: TApiName, handler: (payload?: TContract[TApiName]['input']) => Promise<TContract[TApiName]['output']> | TContract[TApiName]['output'], message: any): RequestHandler;
 }
 export {};

package/dist/LambderMSW.js

@@ -21,6 +21,11 @@ export default class LambderMSW {
      * @param apiName - The name of the API to mock
      * @param handler - Function that returns the mock payload
      * @param options - Additional response options (session expired, version expired, etc.)
+     *
+     * Note: TypeScript will check that the return type is assignable to the output type,
+     * but due to structural typing, extra properties are allowed. Enable strict checks
+     * in your tsconfig.json with "noUncheckedIndexedAccess" and "exactOptionalPropertyTypes"
+     * for better type safety.
      */
     mockApi(apiName, handler, options) {
         return this.http.post(this.apiPath, async ({ request }) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lambder",
-  "version": "1.0.133",
+  "version": "1.0.134",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/LambderMSW.ts

@@ -50,8 +50,13 @@ export default class LambderMSW<TContract extends ApiContractShape = any> {
      * @param apiName - The name of the API to mock
      * @param handler - Function that returns the mock payload
      * @param options - Additional response options (session expired, version expired, etc.)
+     * 
+     * Note: TypeScript will check that the return type is assignable to the output type,
+     * but due to structural typing, extra properties are allowed. Enable strict checks
+     * in your tsconfig.json with "noUncheckedIndexedAccess" and "exactOptionalPropertyTypes"
+     * for better type safety.
      */
-    mockApi<TApiName extends keyof TContract & string>(
+    mockApi<TApiName extends keyof TContract>(
         apiName: TApiName,
         handler: (payload?: TContract[TApiName]['input']) => Promise<TContract[TApiName]['output']> | TContract[TApiName]['output'],
         options?: MockApiOptions
@@ -122,7 +127,7 @@ export default class LambderMSW<TContract extends ApiContractShape = any> {
     /**
      * Mock an API endpoint that returns a session expired error
      */
-    mockSessionExpired<TApiName extends keyof TContract & string>(
+    mockSessionExpired<TApiName extends keyof TContract>(
         apiName: TApiName
     ): RequestHandler {
         return this.mockApi(
@@ -135,7 +140,7 @@ export default class LambderMSW<TContract extends ApiContractShape = any> {
     /**
      * Mock an API endpoint that returns a version expired error
      */
-    mockVersionExpired<TApiName extends keyof TContract & string>(
+    mockVersionExpired<TApiName extends keyof TContract>(
         apiName: TApiName
     ): RequestHandler {
         return this.mockApi(
@@ -148,7 +153,7 @@ export default class LambderMSW<TContract extends ApiContractShape = any> {
     /**
      * Mock an API endpoint that returns a not authorized error
      */
-    mockNotAuthorized<TApiName extends keyof TContract & string>(
+    mockNotAuthorized<TApiName extends keyof TContract>(
         apiName: TApiName
     ): RequestHandler {
         return this.mockApi(
@@ -161,7 +166,7 @@ export default class LambderMSW<TContract extends ApiContractShape = any> {
     /**
      * Mock an API endpoint that returns an error message
      */
-    mockError<TApiName extends keyof TContract & string>(
+    mockError<TApiName extends keyof TContract>(
         apiName: TApiName,
         errorMessage: string
     ): RequestHandler {
@@ -175,7 +180,7 @@ export default class LambderMSW<TContract extends ApiContractShape = any> {
     /**
      * Mock an API endpoint with a custom message
      */
-    mockWithMessage<TApiName extends keyof TContract & string>(
+    mockWithMessage<TApiName extends keyof TContract>(
         apiName: TApiName,
         handler: (payload?: TContract[TApiName]['input']) => Promise<TContract[TApiName]['output']> | TContract[TApiName]['output'],
         message: any

package/test-type-enforcement.ts

@@ -0,0 +1,111 @@
+// Test file to verify LambderMSW type enforcement
+import LambderMSW from './src/LambderMSW';
+import type { ApiContract } from './src/LambderApiContract';
+
+// Define a test API contract
+type TestContract = ApiContract<{
+    'public.getInitialPageData': {
+        input: void;
+        output: {
+            userLocationData: {
+                country: string;
+                region: string;
+                regionCode: string;
+                city: string;
+                zipCode: string;
+                lat: number;
+                lng: number;
+            };
+            sessionUser: {
+                id: string;
+                username: string;
+                email: string;
+                name: string;
+                bio: string;
+                // NOTE: 's' property should NOT be here
+            };
+        };
+    };
+}>;
+
+const apiMocker = new LambderMSW<TestContract>({
+    apiPath: '/secure',
+});
+
+// TEST 1: Extra properties - TypeScript allows this due to structural typing
+const handler1 = apiMocker.mockApi(
+    'public.getInitialPageData',
+    async () => {
+        return {
+            userLocationData: {
+                country: 'United States',
+                region: 'California',
+                regionCode: 'CA',
+                city: 'San Francisco',
+                zipCode: '94102',
+                lat: 37.7749,
+                lng: -122.4194,
+            },
+            sessionUser: {
+                id: 'mock-user-123',
+                username: 'mockuser',
+                email: 'mock@example.com',
+                name: 'Mock User',
+                bio: 'This is a mock user for development',
+                s: 43  // ⚠️ Extra property - TypeScript structural typing allows this
+            },
+        };
+    }
+);
+
+// TEST 2: Missing required property - THIS WILL CAUSE AN ERROR!
+const handler2 = apiMocker.mockApi(
+    'public.getInitialPageData',
+    async () => {
+        return {
+            userLocationData: {
+                country: 'United States',
+                region: 'California',
+                regionCode: 'CA',
+                city: 'San Francisco',
+                zipCode: '94102',
+                lat: 37.7749,
+                lng: -122.4194,
+            },
+            sessionUser: {
+                id: 'mock-user-123',
+                username: 'mockuser',
+                email: 'mock@example.com',
+                name: 'Mock User',
+                // bio: 'This is a mock user for development',  // ❌ Missing required property - ERROR!
+            },
+        };
+    }
+);
+
+// TEST 3: Wrong type - THIS WILL CAUSE AN ERROR!
+const handler3 = apiMocker.mockApi(
+    'public.getInitialPageData',
+    async () => {
+        return {
+            userLocationData: {
+                country: 'United States',
+                region: 'California',
+                regionCode: 'CA',
+                city: 'San Francisco',
+                zipCode: '94102',
+                lat: 37.7749,
+                lng: -122.4194,
+            },
+            sessionUser: {
+                id: 123,  // ❌ Wrong type - should be string - ERROR!
+                username: 'mockuser',
+                email: 'mock@example.com',
+                name: 'Mock User',
+                bio: 'This is a mock user for development',
+            },
+        };
+    }
+);
+
+console.log('Check for TypeScript errors above!');