@bifravst/http-api-mock 1.1.6 → 1.2.0

package/README.md

@@ -21,7 +21,6 @@ npx @bifravst/http-api-mock
 {
   "stackName": "http-api-mock-69c2c4b9",
   "responsesTableName": "http-api-mock-69c2c4b9-httpapimockresponses562FCFC7-C80OCULJKYFE",
-  "httpapimockapiEndpointF8DBD534": "https://liv73h149l.execute-api.eu-west-1.amazonaws.com/prod/",
   "apiURL": "https://liv73h149l.execute-api.eu-west-1.amazonaws.com/prod/",
   "requestsTableName": "http-api-mock-69c2c4b9-httpapimockrequests2216D487-608PM7EHETW4"
 }

package/cdk/http-api-mock.ts

@@ -6,6 +6,7 @@ import path from 'node:path'
 import { fileURLToPath } from 'node:url'
 import fs from 'node:fs/promises'
 import os from 'node:os'
+import pJSON from '../package.json'
 
 const { stackName } = fromEnv({ stackName: 'HTTP_API_MOCK_STACK_NAME' })(
 	process.env,
@@ -18,6 +19,10 @@ await fs.mkdir(lambdasDir)
 const layersDir = path.join(distDir, 'layers')
 await fs.mkdir(layersDir)
 
+const dependencies: Array<keyof (typeof pJSON)['dependencies']> = [
+	'@nordicsemiconductor/from-env',
+]
+
 new HTTPAPIMockApp(stackName, {
 	lambdaSources: {
 		httpApiMock: await packLambdaFromPath(
@@ -30,11 +35,7 @@ new HTTPAPIMockApp(stackName, {
 	},
 	layer: await packLayer({
 		id: 'testResources',
-		dependencies: [
-			'@aws-sdk/client-dynamodb',
-			'@nordicsemiconductor/from-env',
-			'@hello.nrfcloud.com/lambda-helpers',
-		],
+		dependencies,
 		baseDir,
 		distDir: layersDir,
 	}),

package/cdk/resources/http-api-mock-lambda.ts

@@ -11,18 +11,17 @@ import type {
 	Context,
 } from 'aws-lambda'
 import { URLSearchParams } from 'url'
-import { logger } from '@hello.nrfcloud.com/lambda-helpers/logger'
 import { checkMatchingQueryParams } from './checkMatchingQueryParams.js'
 import { splitMockResponse } from './splitMockResponse.js'
 import { sortQueryString } from '../../src/sortQueryString.js'
 
 const db = new DynamoDBClient({})
-const log = logger('httpApiMock')
 
 export const handler = async (
 	event: APIGatewayEvent,
 	context: Context,
 ): Promise<APIGatewayProxyResult> => {
+	console.log(JSON.stringify({ event }))
 	const query =
 		event.queryStringParameters !== null &&
 		event.queryStringParameters !== undefined
@@ -80,7 +79,7 @@ export const handler = async (
 	)
 
 	// Check if response exists
-	log.info(
+	console.debug(
 		`Checking if response exists for ${event.httpMethod} ${pathWithQuery}...`,
 	)
 	// Query using httpMethod and path only
@@ -90,13 +89,13 @@ export const handler = async (
 			KeyConditionExpression: 'methodPathQuery = :methodPathQuery',
 			ExpressionAttributeValues: {
 				[':methodPathQuery']: {
-					S: `${event.httpMethod} ${event.path.replace(/^\//, '')}`,
+					S: `${event.httpMethod} ${pathWithQuery}`,
 				},
 			},
 			ScanIndexForward: false,
 		}),
 	)
-	log.debug(`Found response items: ${Items?.length}`)
+	console.debug(`Found response items: ${Items?.length}`)
 
 	let res: APIGatewayProxyResult | undefined
 	for (const Item of Items ?? []) {
@@ -106,7 +105,6 @@ export const handler = async (
 			? checkMatchingQueryParams(
 					event.queryStringParameters,
 					objItem.queryParams,
-					log,
 				)
 			: true
 		if (matchedQueryParams === false) continue
@@ -144,7 +142,7 @@ export const handler = async (
 				: body,
 			isBase64Encoded: isBinary,
 		}
-		log.info(`Return response`, { response: res })
+		console.debug(`Return response`, JSON.stringify({ response: res }))
 
 		break
 	}
@@ -153,6 +151,6 @@ export const handler = async (
 		return res
 	}
 
-	log.warn('No responses found')
+	console.debug('No responses found')
 	return { statusCode: 404, body: '' }
 }

package/dist/cdk/http-api-mock.js

@@ -6,6 +6,7 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import fs from 'node:fs/promises';
 import os from 'node:os';
+import pJSON from '../package.json';
 const { stackName } = fromEnv({ stackName: 'HTTP_API_MOCK_STACK_NAME' })(process.env);
 const baseDir = path.join(path.dirname(fileURLToPath(import.meta.url)), '..');
 const distDir = await fs.mkdtemp(path.join(os.tmpdir(), 'temp-'));
@@ -13,17 +14,16 @@ const lambdasDir = path.join(distDir, 'lambdas');
 await fs.mkdir(lambdasDir);
 const layersDir = path.join(distDir, 'layers');
 await fs.mkdir(layersDir);
+const dependencies = [
+    '@nordicsemiconductor/from-env',
+];
 new HTTPAPIMockApp(stackName, {
     lambdaSources: {
         httpApiMock: await packLambdaFromPath('httpApiMock', 'cdk/resources/http-api-mock-lambda.ts', undefined, baseDir, lambdasDir),
     },
     layer: await packLayer({
         id: 'testResources',
-        dependencies: [
-            '@aws-sdk/client-dynamodb',
-            '@nordicsemiconductor/from-env',
-            '@hello.nrfcloud.com/lambda-helpers',
-        ],
+        dependencies,
         baseDir,
         distDir: layersDir,
     }),

package/dist/cdk/resources/http-api-mock-lambda.js

@@ -1,13 +1,12 @@
 import { DeleteItemCommand, DynamoDBClient, PutItemCommand, QueryCommand, } from '@aws-sdk/client-dynamodb';
 import { marshall, unmarshall } from '@aws-sdk/util-dynamodb';
 import { URLSearchParams } from 'url';
-import { logger } from '@hello.nrfcloud.com/lambda-helpers/logger';
 import { checkMatchingQueryParams } from './checkMatchingQueryParams.js';
 import { splitMockResponse } from './splitMockResponse.js';
 import { sortQueryString } from '../../src/sortQueryString.js';
 const db = new DynamoDBClient({});
-const log = logger('httpApiMock');
 export const handler = async (event, context) => {
+    console.log(JSON.stringify({ event }));
     const query = event.queryStringParameters !== null &&
         event.queryStringParameters !== undefined
         ? new URLSearchParams(event.queryStringParameters)
@@ -50,25 +49,25 @@ export const handler = async (event, context) => {
         },
     }));
     // Check if response exists
-    log.info(`Checking if response exists for ${event.httpMethod} ${pathWithQuery}...`);
+    console.debug(`Checking if response exists for ${event.httpMethod} ${pathWithQuery}...`);
     // Query using httpMethod and path only
     const { Items } = await db.send(new QueryCommand({
         TableName: process.env.RESPONSES_TABLE_NAME,
         KeyConditionExpression: 'methodPathQuery = :methodPathQuery',
         ExpressionAttributeValues: {
             [':methodPathQuery']: {
-                S: `${event.httpMethod} ${event.path.replace(/^\//, '')}`,
+                S: `${event.httpMethod} ${pathWithQuery}`,
             },
         },
         ScanIndexForward: false,
     }));
-    log.debug(`Found response items: ${Items?.length}`);
+    console.debug(`Found response items: ${Items?.length}`);
     let res;
     for (const Item of Items ?? []) {
         const objItem = unmarshall(Item);
         const hasExpectedQueryParams = 'queryParams' in objItem;
         const matchedQueryParams = hasExpectedQueryParams
-            ? checkMatchingQueryParams(event.queryStringParameters, objItem.queryParams, log)
+            ? checkMatchingQueryParams(event.queryStringParameters, objItem.queryParams)
             : true;
         if (matchedQueryParams === false)
             continue;
@@ -99,12 +98,12 @@ export const handler = async (event, context) => {
                 : body,
             isBase64Encoded: isBinary,
         };
-        log.info(`Return response`, { response: res });
+        console.debug(`Return response`, JSON.stringify({ response: res }));
         break;
     }
     if (res !== undefined) {
         return res;
     }
-    log.warn('No responses found');
+    console.debug('No responses found');
     return { statusCode: 404, body: '' };
 };

package/dist/src/URLSearchParamsToObject.d.ts

@@ -0,0 +1 @@
+export declare const URLSearchParamsToObject: (params: URLSearchParams) => Record<string, string>;

package/dist/src/URLSearchParamsToObject.js

@@ -0,0 +1,7 @@
+export const URLSearchParamsToObject = (params) => {
+    const result = {};
+    for (const [key, value] of params.entries()) {
+        result[key] = value;
+    }
+    return result;
+};

package/dist/src/URLSearchParamsToObject.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/URLSearchParamsToObject.spec.js

@@ -0,0 +1,13 @@
+import { describe, it } from 'node:test';
+import assert from 'node:assert/strict';
+import { URLSearchParamsToObject } from './URLSearchParamsToObject.js';
+void describe('URLSearchParamsToObject()', () => {
+    void it('should convert URLSearchParams to a plain object', () => assert.deepEqual(URLSearchParamsToObject(new URLSearchParams('eci=73393515&tac=132&requestType=custom&mcc=397&mnc=73&customTypes=2')), {
+        eci: '73393515',
+        tac: '132',
+        requestType: 'custom',
+        mcc: '397',
+        mnc: '73',
+        customTypes: '2',
+    }));
+});

package/dist/src/mock.d.ts

@@ -0,0 +1,15 @@
+import type { DynamoDBClient } from '@aws-sdk/client-dynamodb';
+type MockResponseFn = (methodPathQuery: string, response: Partial<{
+    headers: Headers;
+    status: number;
+    body: string;
+}>) => Promise<void>;
+export declare const mockResponse: (db: DynamoDBClient, responsesTable: string) => MockResponseFn;
+export type HttpAPIMock = {
+    response: MockResponseFn;
+};
+export declare const mock: ({ db, responsesTable, }: {
+    db: DynamoDBClient;
+    responsesTable: string;
+}) => HttpAPIMock;
+export {};

package/dist/src/mock.js

@@ -0,0 +1,30 @@
+import { registerResponse } from './responses.js';
+export const mockResponse = (db, responsesTable) => async (methodPathQuery, response) => {
+    const [method, pathWithQuery] = methodPathQuery.split(' ', 2);
+    if (!/^[A-Z]+$/.test(method ?? ''))
+        throw new Error(`Invalid method ${method} in ${methodPathQuery}!`);
+    if (pathWithQuery === undefined)
+        throw new Error(`Missing path in ${methodPathQuery}!`);
+    const [path, query] = pathWithQuery.split('?', 2);
+    if (path.startsWith('/'))
+        throw new Error(`Path ${path} must not start with /!`);
+    const bodyParts = [];
+    if (response.headers !== undefined) {
+        for (const [k, v] of response.headers.entries()) {
+            bodyParts.push(`${k}: ${v}`);
+        }
+        bodyParts.push('');
+    }
+    if (response.body !== undefined)
+        bodyParts.push(response.body);
+    await registerResponse(db, responsesTable, {
+        path,
+        method: method ?? 'GET',
+        queryParams: new URLSearchParams(query),
+        body: bodyParts.length > 0 ? bodyParts.join('\n') : undefined,
+        statusCode: response.status,
+    });
+};
+export const mock = ({ db, responsesTable, }) => ({
+    response: mockResponse(db, responsesTable),
+});

package/dist/src/mock.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/mock.spec.js

@@ -0,0 +1,36 @@
+import { describe, it, mock as testMock } from 'node:test';
+import assert from 'node:assert/strict';
+import { mock } from './mock.js';
+import { unmarshall } from '@aws-sdk/util-dynamodb';
+void describe('mock()', () => {
+    void it('should register a response', async () => {
+        const db = {
+            send: testMock.fn(async () => Promise.resolve(undefined)),
+        };
+        const httpApiMock = mock({
+            db: db,
+            responsesTable: 'response-table',
+        });
+        await httpApiMock.response(`GET foo/bar?k=v`, {
+            status: 200,
+            headers: new Headers({
+                'content-type': 'application/json; charset=utf-8',
+            }),
+            body: JSON.stringify({
+                result: 'some-value',
+            }),
+        });
+        assert.equal(db.send.mock.callCount(), 1);
+        const [{ input: args }] = db.send.mock.calls[0]?.arguments;
+        assert.equal(args.TableName, 'response-table');
+        const { methodPathQuery, statusCode, body, queryParams } = unmarshall(args.Item);
+        assert.equal(statusCode, 200);
+        assert.equal(methodPathQuery, 'GET foo/bar?k=v');
+        assert.equal(body, [
+            `content-type: application/json; charset=utf-8`,
+            ``,
+            JSON.stringify({ result: 'some-value' }),
+        ].join('\n'));
+        assert.deepEqual(queryParams, { k: 'v' });
+    });
+});

package/dist/src/responses.d.ts

@@ -2,8 +2,13 @@ import { type DynamoDBClient } from '@aws-sdk/client-dynamodb';
 export type Response = {
     method: string;
     path: string;
-    queryParams?: Record<string, string>;
+    queryParams?: URLSearchParams;
     statusCode?: number;
+    /**
+     * Header + Body
+     *
+     * @see splitMockResponse
+     */
     body?: string;
     ttl?: number;
     keep?: boolean;

package/dist/src/responses.js

@@ -1,15 +1,18 @@
 import { PutItemCommand } from '@aws-sdk/client-dynamodb';
 import { marshall } from '@aws-sdk/util-dynamodb';
-import { sortQueryString } from './sortQueryString.js';
+import { sortQuery } from './sortQueryString.js';
+import { URLSearchParamsToObject } from './URLSearchParamsToObject.js';
 export const registerResponse = async (db, responsesTable, response) => {
     await db.send(new PutItemCommand({
         TableName: responsesTable,
         Item: marshall({
-            methodPathQuery: `${response.method} ${sortQueryString(response.path)}`,
+            methodPathQuery: `${response.method} ${response.path}${response.queryParams !== undefined ? `?${sortQuery(response.queryParams)}` : ``}`,
             timestamp: new Date().toISOString(),
             statusCode: response.statusCode,
             body: response.body,
-            queryParams: response.queryParams,
+            queryParams: response.queryParams !== undefined
+                ? URLSearchParamsToObject(response.queryParams)
+                : undefined,
             ttl: response.ttl,
             keep: response.ttl,
         }, { removeUndefinedValues: true }),

package/dist/src/sortQueryString.d.ts

@@ -1 +1,2 @@
 export declare const sortQueryString: (mockUrl: string) => string;
+export declare const sortQuery: (query: URLSearchParams | Record<string, string>) => string;

package/dist/src/sortQueryString.js

@@ -1,15 +1,23 @@
 export const sortQueryString = (mockUrl) => {
     const [host, query] = mockUrl.split('?', 2);
-    if ((query?.length ?? 0) === 0)
+    if (query === undefined || (query?.length ?? 0) === 0)
         return host;
+    return `${host}?${sortQuery(new URLSearchParams(query))}`;
+};
+export const sortQuery = (query) => {
     const params = [];
-    new URLSearchParams(query).forEach((v, k) => {
-        params.push([k, v]);
-    });
+    if (query instanceof URLSearchParams) {
+        query.forEach((v, k) => {
+            params.push([k, v]);
+        });
+    }
+    else {
+        params.push(...Object.entries(query));
+    }
     params.sort(([k1], [k2]) => (k1 ?? '').localeCompare(k2 ?? ''));
     const sortedParams = new URLSearchParams();
     for (const [k, v] of params) {
         sortedParams.append(k, v);
     }
-    return `${host}?${sortedParams.toString()}`;
+    return sortedParams.toString();
 };

package/dist/src/sortQueryString.spec.js

@@ -1,6 +1,18 @@
 import assert from 'node:assert';
 import { describe, test as it } from 'node:test';
-import { sortQueryString } from './sortQueryString.js';
+import { sortQuery, sortQueryString } from './sortQueryString.js';
+import { URLSearchParams } from 'node:url';
 void describe('sortQueryString', () => {
     void it('should sort the query part of a mock URL', () => assert.deepStrictEqual(sortQueryString('api.nrfcloud.com/v1/location/agps?eci=73393515&tac=132&requestType=custom&mcc=397&mnc=73&customTypes=2'), 'api.nrfcloud.com/v1/location/agps?customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132'));
 });
+void describe('sortQuery', () => {
+    void it('should sort URLSearchParams', () => assert.equal(sortQuery(new URLSearchParams('eci=73393515&tac=132&requestType=custom&mcc=397&mnc=73&customTypes=2')), 'customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132'));
+    void it('should sort a Record', () => assert.equal(sortQuery({
+        eci: '73393515',
+        tac: '132',
+        requestType: 'custom',
+        mcc: '397',
+        mnc: '73',
+        customTypes: '2',
+    }), 'customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132'));
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bifravst/http-api-mock",
-  "version": "1.1.6",
+  "version": "1.2.0",
   "description": "Helper functions for AWS lambdas written in TypeScript.",
   "exports": {
     "./*": {
@@ -34,15 +34,6 @@
   ],
   "author": "Nordic Semiconductor ASA | nordicsemi.no",
   "license": "BSD-3-Clause",
-  "devDependencies": {
-    "@bifravst/eslint-config-typescript": "6.0.22",
-    "@bifravst/prettier-config": "1.0.0",
-    "@commitlint/config-conventional": "19.1.0",
-    "@types/aws-lambda": "8.10.137",
-    "@types/node": "20.12.7",
-    "globstar": "1.0.0",
-    "husky": "9.0.11"
-  },
   "lint-staged": {
     "*.ts": [
       "prettier --write",
@@ -82,7 +73,6 @@
     "access": "public"
   },
   "files": [
-    "package-lock.json",
     "dist/cdk",
     "dist/src",
     "cdk",
@@ -92,21 +82,27 @@
     "README.md"
   ],
   "prettier": "@bifravst/prettier-config",
-  "peerDependencies": {
-    "@aws-sdk/client-cloudformation": "^3.552.0",
-    "@aws-sdk/client-sts": "^3.552.0",
+  "dependencies": {
+    "@aws-sdk/client-cloudformation": "^3.554.0",
+    "@aws-sdk/client-dynamodb": "^3.554.0",
+    "@aws-sdk/client-sts": "^3.554.0",
+    "@aws-sdk/util-dynamodb": "^3.554.0",
+    "@bifravst/aws-cdk-lambda-helpers": "^1.4.0",
     "@bifravst/run": "^1.2.0",
     "@nordicsemiconductor/cloudformation-helpers": "^9.0.3",
+    "@nordicsemiconductor/from-env": "^3.0.1",
     "aws-cdk-lib": "^2.137.0",
     "cdk": "^2.137.0",
     "chalk": "^5.3.0",
     "tsx": "^4.7.2"
   },
-  "dependencies": {
-    "@aws-sdk/client-dynamodb": "^3.552.0",
-    "@aws-sdk/util-dynamodb": "^3.552.0",
-    "@bifravst/aws-cdk-lambda-helpers": "^1.3.3",
-    "@hello.nrfcloud.com/lambda-helpers": "^1.0.1",
-    "@nordicsemiconductor/from-env": "^3.0.1"
+  "devDependencies": {
+    "@bifravst/eslint-config-typescript": "6.0.22",
+    "@bifravst/prettier-config": "1.0.0",
+    "@commitlint/config-conventional": "19.1.0",
+    "@types/aws-lambda": "8.10.137",
+    "@types/node": "20.12.7",
+    "globstar": "1.0.0",
+    "husky": "9.0.11"
   }
 }

package/src/URLSearchParamsToObject.spec.ts

@@ -0,0 +1,22 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { URLSearchParamsToObject } from './URLSearchParamsToObject.js'
+
+void describe('URLSearchParamsToObject()', () => {
+	void it('should convert URLSearchParams to a plain object', () =>
+		assert.deepEqual(
+			URLSearchParamsToObject(
+				new URLSearchParams(
+					'eci=73393515&tac=132&requestType=custom&mcc=397&mnc=73&customTypes=2',
+				),
+			),
+			{
+				eci: '73393515',
+				tac: '132',
+				requestType: 'custom',
+				mcc: '397',
+				mnc: '73',
+				customTypes: '2',
+			},
+		))
+})

package/src/URLSearchParamsToObject.ts

@@ -0,0 +1,9 @@
+export const URLSearchParamsToObject = (
+	params: URLSearchParams,
+): Record<string, string> => {
+	const result: Record<string, string> = {}
+	for (const [key, value] of params.entries()) {
+		result[key] = value
+	}
+	return result
+}

package/src/mock.spec.ts

@@ -0,0 +1,52 @@
+import { describe, it, mock as testMock } from 'node:test'
+import assert from 'node:assert/strict'
+import { mock } from './mock.js'
+import type { AttributeValue, DynamoDBClient } from '@aws-sdk/client-dynamodb'
+import { unmarshall } from '@aws-sdk/util-dynamodb'
+
+void describe('mock()', () => {
+	void it('should register a response', async () => {
+		const db = {
+			send: testMock.fn(async () => Promise.resolve(undefined)),
+		}
+		const httpApiMock = mock({
+			db: db as unknown as DynamoDBClient,
+			responsesTable: 'response-table',
+		})
+
+		await httpApiMock.response(`GET foo/bar?k=v`, {
+			status: 200,
+			headers: new Headers({
+				'content-type': 'application/json; charset=utf-8',
+			}),
+			body: JSON.stringify({
+				result: 'some-value',
+			}),
+		})
+
+		assert.equal(db.send.mock.callCount(), 1)
+		const [{ input: args }] = db.send.mock.calls[0]?.arguments as unknown as [
+			{
+				input: {
+					TableName: string
+					Item: Record<string, AttributeValue>
+				}
+			},
+		]
+		assert.equal(args.TableName, 'response-table')
+		const { methodPathQuery, statusCode, body, queryParams } = unmarshall(
+			args.Item,
+		)
+		assert.equal(statusCode, 200)
+		assert.equal(methodPathQuery, 'GET foo/bar?k=v')
+		assert.equal(
+			body,
+			[
+				`content-type: application/json; charset=utf-8`,
+				``,
+				JSON.stringify({ result: 'some-value' }),
+			].join('\n'),
+		)
+		assert.deepEqual(queryParams, { k: 'v' })
+	})
+})

package/src/mock.ts

@@ -0,0 +1,59 @@
+import type { DynamoDBClient } from '@aws-sdk/client-dynamodb'
+import { registerResponse } from './responses.js'
+
+type MockResponseFn = (
+	// The expected request in the form 'GET resource/subresource?query=value
+	methodPathQuery: string,
+	// The response
+	response: Partial<{
+		headers: Headers
+		status: number
+		body: string
+	}>,
+) => Promise<void>
+
+export const mockResponse =
+	(db: DynamoDBClient, responsesTable: string): MockResponseFn =>
+	async (methodPathQuery, response) => {
+		const [method, pathWithQuery] = methodPathQuery.split(' ', 2)
+		if (!/^[A-Z]+$/.test(method ?? ''))
+			throw new Error(`Invalid method ${method} in ${methodPathQuery}!`)
+		if (pathWithQuery === undefined)
+			throw new Error(`Missing path in ${methodPathQuery}!`)
+		const [path, query] = pathWithQuery.split('?', 2) as [
+			string,
+			string | undefined,
+		]
+		if (path.startsWith('/'))
+			throw new Error(`Path ${path} must not start with /!`)
+
+		const bodyParts = []
+		if (response.headers !== undefined) {
+			for (const [k, v] of response.headers.entries()) {
+				bodyParts.push(`${k}: ${v}`)
+			}
+			bodyParts.push('')
+		}
+		if (response.body !== undefined) bodyParts.push(response.body)
+		await registerResponse(db, responsesTable, {
+			path,
+			method: method ?? 'GET',
+			queryParams: new URLSearchParams(query),
+			body: bodyParts.length > 0 ? bodyParts.join('\n') : undefined,
+			statusCode: response.status,
+		})
+	}
+
+export type HttpAPIMock = {
+	response: MockResponseFn
+}
+
+export const mock = ({
+	db,
+	responsesTable,
+}: {
+	db: DynamoDBClient
+	responsesTable: string
+}): HttpAPIMock => ({
+	response: mockResponse(db, responsesTable),
+})

package/src/responses.ts

@@ -1,14 +1,20 @@
 import { PutItemCommand, type DynamoDBClient } from '@aws-sdk/client-dynamodb'
 import { marshall } from '@aws-sdk/util-dynamodb'
-import { sortQueryString } from './sortQueryString.js'
+import { sortQuery } from './sortQueryString.js'
+import { URLSearchParamsToObject } from './URLSearchParamsToObject.js'
 
 export type Response = {
 	// e.g. 'GET'
 	method: string
 	// without leading slash
 	path: string
-	queryParams?: Record<string, string>
+	queryParams?: URLSearchParams
 	statusCode?: number
+	/**
+	 * Header + Body
+	 *
+	 * @see splitMockResponse
+	 */
 	body?: string
 	ttl?: number
 	// Whether to delete the message after sending it
@@ -25,11 +31,14 @@ export const registerResponse = async (
 			TableName: responsesTable,
 			Item: marshall(
 				{
-					methodPathQuery: `${response.method} ${sortQueryString(response.path)}`,
+					methodPathQuery: `${response.method} ${response.path}${response.queryParams !== undefined ? `?${sortQuery(response.queryParams)}` : ``}`,
 					timestamp: new Date().toISOString(),
 					statusCode: response.statusCode,
 					body: response.body,
-					queryParams: response.queryParams,
+					queryParams:
+						response.queryParams !== undefined
+							? URLSearchParamsToObject(response.queryParams)
+							: undefined,
 					ttl: response.ttl,
 					keep: response.ttl,
 				},

package/src/sortQueryString.spec.ts

@@ -1,6 +1,7 @@
 import assert from 'node:assert'
 import { describe, test as it } from 'node:test'
-import { sortQueryString } from './sortQueryString.js'
+import { sortQuery, sortQueryString } from './sortQueryString.js'
+import { URLSearchParams } from 'node:url'
 
 void describe('sortQueryString', () => {
 	void it('should sort the query part of a mock URL', () =>
@@ -11,3 +12,27 @@ void describe('sortQueryString', () => {
 			'api.nrfcloud.com/v1/location/agps?customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132',
 		))
 })
+
+void describe('sortQuery', () => {
+	void it('should sort URLSearchParams', () =>
+		assert.equal(
+			sortQuery(
+				new URLSearchParams(
+					'eci=73393515&tac=132&requestType=custom&mcc=397&mnc=73&customTypes=2',
+				),
+			),
+			'customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132',
+		))
+	void it('should sort a Record', () =>
+		assert.equal(
+			sortQuery({
+				eci: '73393515',
+				tac: '132',
+				requestType: 'custom',
+				mcc: '397',
+				mnc: '73',
+				customTypes: '2',
+			}),
+			'customTypes=2&eci=73393515&mcc=397&mnc=73&requestType=custom&tac=132',
+		))
+})

package/src/sortQueryString.ts

@@ -1,14 +1,24 @@
 export const sortQueryString = (mockUrl: string): string => {
 	const [host, query] = mockUrl.split('?', 2) as [string, string | undefined]
-	if ((query?.length ?? 0) === 0) return host
+	if (query === undefined || (query?.length ?? 0) === 0) return host
+	return `${host}?${sortQuery(new URLSearchParams(query))}`
+}
+
+export const sortQuery = (
+	query: URLSearchParams | Record<string, string>,
+): string => {
 	const params: string[][] = []
-	new URLSearchParams(query).forEach((v, k) => {
-		params.push([k, v])
-	})
+	if (query instanceof URLSearchParams) {
+		query.forEach((v, k) => {
+			params.push([k, v])
+		})
+	} else {
+		params.push(...Object.entries(query))
+	}
 	params.sort(([k1], [k2]) => (k1 ?? '').localeCompare(k2 ?? ''))
 	const sortedParams = new URLSearchParams()
 	for (const [k, v] of params) {
 		sortedParams.append(k as string, v as string)
 	}
-	return `${host}?${sortedParams.toString()}`
+	return sortedParams.toString()
 }