rename isCmcdResponseKey

Author: cotid-qualabs

lib/src/cmcd.ts

@@ -63,7 +63,7 @@ export { groupCmcdHeaders } from './cmcd/groupCmcdHeaders.js';
 export { isCmcdCustomKey } from './cmcd/isCmcdCustomKey.js';
 export { isCmcdEventKey } from './cmcd/isCmcdEventKey.js';
 export { isCmcdRequestKey } from './cmcd/isCmcdRequestKey.js';
-export { isCmcdResponseKey } from './cmcd/isCmcdResponseKey.js';
+export { isCmcdResponseReceivedKey } from './cmcd/isCmcdResponseReceivedKey.js';
 export { isCmcdV1Key } from './cmcd/isCmcdV1Key.js';
 export { prepareCmcdData } from './cmcd/prepareCmcdData.js';
 export { toCmcdHeaders } from './cmcd/toCmcdHeaders.js';

lib/src/cmcd/isCmcdResponseKey.ts renamed to lib/src/cmcd/isCmcdResponseReceivedKey.ts

@@ -1,8 +1,5 @@
-import { CMCD_COMMON_KEYS } from './CMCD_COMMON_KEYS.js';
-import { CMCD_REQUEST_KEYS } from './CMCD_REQUEST_KEYS.js';
 import { CMCD_RESPONSE_KEYS } from './CMCD_RESPONSE_KEYS.js';
 import type { CmcdResponse } from './CmcdResponse.js';
-import { isCmcdCustomKey } from './isCmcdCustomKey.js';
 
 /**
  * Check if a key is a valid CMCD response key.
@@ -16,8 +13,8 @@ import { isCmcdCustomKey } from './isCmcdCustomKey.js';
  * @beta
  *
  * @example
- * {@includeCode ../../test/cmcd/isCmcdResponseKey.test.ts#example}
+ * {@includeCode ../../test/cmcd/isCmcdResponseReceivedKey.test.ts#example}
  */
-export function isCmcdResponseKey(key: string): key is keyof CmcdResponse {
+export function isCmcdResponseReceivedKey(key: string): key is keyof CmcdResponse {
 	return CMCD_RESPONSE_KEYS.includes(key as any);
 }

lib/src/cmcd/prepareCmcdData.ts

@@ -10,7 +10,7 @@ import type { CmcdFormatterOptions } from './CmcdFormatterOptions.js';
 import type { CmcdValue } from './CmcdValue.js';
 import { isCmcdEventKey } from './isCmcdEventKey.js';
 import { isCmcdRequestKey } from './isCmcdRequestKey.js';
-import { isCmcdResponseKey } from './isCmcdResponseKey.js';
+import { isCmcdResponseReceivedKey } from './isCmcdResponseReceivedKey.js';
 import { isCmcdV1Key } from './isCmcdV1Key.js';
 
 const filterMap = {
@@ -41,7 +41,7 @@ export function prepareCmcdData(obj: Record<string, any>, options: CmcdEncodeOpt
 
 	if (!options.events || !options.events.includes('rr')){
 		const remainingObj = Object.fromEntries(
-			Object.entries(obj).filter(([key]) => !isCmcdResponseKey(key)),
+			Object.entries(obj).filter(([key]) => !isCmcdResponseReceivedKey(key)),
 		);
 		obj = remainingObj;
 	}

lib/test/cmcd/isCmcdResponseKey.test.ts

@@ -1,33 +1,33 @@
-import { CMCD_REQUEST_KEYS, CMCD_RESPONSE_KEYS, isCmcdResponseKey } from '@svta/common-media-library/cmcd';
+import { CMCD_REQUEST_KEYS, CMCD_RESPONSE_KEYS, isCmcdResponseReceivedKey } from '@svta/common-media-library/cmcd';
 import { equal } from 'node:assert';
 import { describe, it } from 'node:test';
 
-describe('isCmcdResponseKey', () => {
+describe('isCmcdResponseReceivedKey', () => {
 	it('provides a valid example', () => {
 		//#region example
-		equal(isCmcdResponseKey('url'), true);
-		equal(isCmcdResponseKey('e'), false);
+		equal(isCmcdResponseReceivedKey('url'), true);
+		equal(isCmcdResponseReceivedKey('e'), false);
 		//#endregion example
 	});
 
 	it('Rejects all request keys', () => {
 		for (const key of CMCD_REQUEST_KEYS) {
-			equal(isCmcdResponseKey(key), false);
+			equal(isCmcdResponseReceivedKey(key), false);
 		}
 	});
 
 	it('Accepts all response keys', () => {
 		for (const key of CMCD_RESPONSE_KEYS) {
-			equal(isCmcdResponseKey(key), true);
+			equal(isCmcdResponseReceivedKey(key), true);
 		}
 	});
 
 	it('Rejects custom keys', () => {
-		equal(isCmcdResponseKey('com.hello.world-foo'), false);
+		equal(isCmcdResponseReceivedKey('com.hello.world-foo'), false);
 	});
 
 	it('Rejects invalid keys', () => {
-		equal(isCmcdResponseKey('nrr'), false);
-		equal(isCmcdResponseKey('e'), false);
+		equal(isCmcdResponseReceivedKey('nrr'), false);
+		equal(isCmcdResponseReceivedKey('e'), false);
 	});
 });