@financial-times/cmp-client 2.0.4-alpha → 2.0.5-beta.2

package/dist/client.d.ts

@@ -1,63 +1,3 @@
-import { updateFooterLinkCMP } from '@financial-times/privacy-utils';
-
-declare interface CMPInitOptions {
-    propertyConfig: SPConfig;
-    userId?: string;
-    useFTSession: boolean;
-    consentProxyHost: string;
-    cookieDomain: string;
-    formOfWordsId: string;
-    useConsentStore: boolean;
-}
-
-declare const events = {
-    onMessageChoiceSelect: declare function (...args: unknown[]) {
-        console.log("[event] onMessageChoiceSelect", args);
-    },
-    onMessageReady: declare function (...args: unknown[]) {
-        console.log("[event] onMessageReady", args);
-    },
-    onMessageChoiceError: declare function (...args: unknown[]) {
-        console.log("[event] onMessageChoiceError", args);
-    },
-    onPrivacyManagerAction: declare function (...args: unknown[]) {
-        console.log("[event] onPrivacyManagerAction", args);
-    },
-    onPMCancel: declare function (...args: unknown[]) {
-        console.log("[event] onPMCancel", args);
-    },
-    onMessageReceiveData: declare function (...args: unknown[]) {
-        console.log("[event] onMessageReceiveData", args);
-    },
-    onSPPMObjectReady: declare function (...args: unknown[]) {
-        console.log("[event] onSPPMObjectReady", args);
-    },
-    onConsentReady: declare function (...args: unknown[]) {
-        console.log("[event] onConsentReady", args);
-    },
-    onError: declare function (...args: unknown[]) {
-        console.log("[event] onError", args);
-    },
-};
-
-export declare function getCmpScripts(config: SPConfig): DocumentFragment;
-
-export declare function initSourcepointCmp({ propertyConfig, userId, useFTSession, consentProxyHost, cookieDomain, formOfWordsId, useConsentStore, }: CMPInitOptions): Promise<void>;
-
-declare interface SPConfig {
-    accountId: number;
-    baseEndpoint: string;
-    gdpr: Record<string, unknown>;
-    ccpa: Record<string, unknown>;
-    propertyHref?: string;
-    propertyId?: string;
-    joinHref?: boolean;
-    events?: SPLifecycleEvents;
-    authId?: string;
-}
-
-declare type SPLifecycleEvents = Partial<typeof events>;
-
-export { updateFooterLinkCMP }
-
-export { }
+import type { CMPInitOptions } from "../typings/types.d.ts";
+export declare function initSourcepointCmp({ propertyConfig, userId, useFTSession, consentProxyHost, cookieDomain, formOfWordsId, useConsentStore, }: CMPInitOptions): Promise<void>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAS5D,wBAAsB,kBAAkB,CAAC,EACvC,cAA+B,EAC/B,MAAM,EACN,YAAmB,EACnB,gBAAwC,EACxC,YAA+B,EAC/B,aAAkC,EAClC,eAAsB,GACvB,EAAE,cAAc,iBAiChB"}

package/dist/consent-ready/index.d.ts

@@ -0,0 +1,5 @@
+import type { ConsentReadyProps } from "../../typings/types.d.ts";
+export declare function consentReadyHandlerFn(props: ConsentReadyProps): (legislation: string, _: string, consentString: string, consentMeta: {
+    applies?: boolean;
+}) => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/consent-ready/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/consent-ready/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AA0B/E,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,iBAAiB,iBAI7C,MAAM,KAChB,MAAM,iBACM,MAAM,eACR;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,mBAoCrC"}

package/dist/consent-ready/utils/__fixtures__/strings.d.ts

@@ -0,0 +1,9 @@
+export declare const validTCStringNoConsent = "CPzIxKcPzIxKcFNAAAENCZCAAAAAAAAAAAAAAAAAAAAA.II7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8A";
+/**
+ * Purposes 1, 5 & 6
+ */
+export declare const validTCStringPartialConsent = "CPy5ZPbPy5ZPbEsACAENCZCAAIwAAAAAAAwIAAAAAAAA.II7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8A";
+export declare const validTCStringFullConsent = "CPyTwm7PyTwm7EsAAAENCZCMAP_AAAAAAAwII7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8AAAAAA.II7Nd_X__bX9n-_7_6ft0eY1f9_r37uQzDhfNs-8F3L_W_LwX32E7NF36tq4KmR4ku1bBIQNtHMnUDUmxaolVrzHsak2cpyNKJ_JkknsZe2dYGF9Pn9lD-YKZ7_5_9_f52T_9_9_-39z3_9f___dv_-__-vjf_599n_v9fV_78_Kf9______-____________8A";
+export declare const uspStringFullConsent = "1YNN";
+export declare const uspStringNoConsent = "1YYN";
+//# sourceMappingURL=strings.d.ts.map

package/dist/consent-ready/utils/__fixtures__/strings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strings.d.ts","sourceRoot":"","sources":["../../../../src/consent-ready/utils/__fixtures__/strings.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB,qPACiN,CAAC;AAErP;;GAEG;AACH,eAAO,MAAM,2BAA2B,qPAC4M,CAAC;AAErP,eAAO,MAAM,wBAAwB,obAC8Y,CAAC;AAEpb,eAAO,MAAM,oBAAoB,SAAS,CAAC;AAC3C,eAAO,MAAM,kBAAkB,SAAS,CAAC"}

package/dist/consent-ready/utils/__tests__/check-consent.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=check-consent.test.d.ts.map

package/dist/consent-ready/utils/__tests__/check-consent.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-consent.test.d.ts","sourceRoot":"","sources":["../../../../src/consent-ready/utils/__tests__/check-consent.test.ts"],"names":[],"mappings":""}

package/dist/consent-ready/utils/__tests__/get-parsed-consent.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=get-parsed-consent.test.d.ts.map

package/dist/consent-ready/utils/__tests__/get-parsed-consent.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-parsed-consent.test.d.ts","sourceRoot":"","sources":["../../../../src/consent-ready/utils/__tests__/get-parsed-consent.test.ts"],"names":[],"mappings":""}

package/dist/consent-ready/utils/__tests__/validators.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=validators.test.d.ts.map

package/dist/consent-ready/utils/__tests__/validators.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.test.d.ts","sourceRoot":"","sources":["../../../../src/consent-ready/utils/__tests__/validators.test.ts"],"names":[],"mappings":""}

package/dist/consent-ready/utils/get-consent-payload.d.ts

@@ -0,0 +1,18 @@
+import type { ParsedConsentState, ConsentPayloadOptions, ConsentCategoryPayload } from "../../../typings/types";
+/**
+ * Build payload for updating user's consent
+ */
+export declare function getConsentPayload(parsedConsent: ParsedConsentState, { shouldUpdateConsentStore, formOfWordsId, cookieDomain }: Partial<ConsentPayloadOptions>): {
+    data: Record<string, ConsentCategoryPayload>;
+    setConsentCookie?: undefined;
+    formOfWordsId?: undefined;
+    consentSource?: undefined;
+    cookieDomain?: undefined;
+} | {
+    setConsentCookie: boolean;
+    formOfWordsId: string | undefined;
+    consentSource: string;
+    cookieDomain: string | undefined;
+    data: Record<string, ConsentCategoryPayload>;
+};
+//# sourceMappingURL=get-consent-payload.d.ts.map

package/dist/consent-ready/utils/get-consent-payload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-consent-payload.d.ts","sourceRoot":"","sources":["../../../src/consent-ready/utils/get-consent-payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACrB,sBAAsB,EACvB,MAAM,wBAAwB,CAAC;AAIhC;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,aAAa,EAAE,kBAAkB,EACjC,EAAE,wBAAwB,EAAE,aAAa,EAAE,YAAY,EAAE,EAAE,OAAO,CAAC,qBAAqB,CAAC;;;;;;;;;;;;EA6B1F"}

package/dist/consent-ready/utils/get-parsed-consent.d.ts

@@ -0,0 +1,14 @@
+import type { RawConsentState, ParsedConsentState } from "../../../typings/types.d.ts";
+/**
+ * Checks the consent for a specific custom purpose.
+ * @param categoryName - The custom IAB category identifier to check.
+ * @param consentState - The consent state to use for checking.
+ * @returns {boolean} - Returns true if consent is granted, otherwise false.
+ */
+export declare function checkConsentFor(categoryName: string, consentState: RawConsentState): boolean;
+/**
+ * This function returns a pre-processed consent state of the user
+ * The returned object is a dictionary of custom purposes and their boolean on/off values
+ */
+export declare function getParsedConsent(rawConsentState: RawConsentState): ParsedConsentState;
+//# sourceMappingURL=get-parsed-consent.d.ts.map

package/dist/consent-ready/utils/get-parsed-consent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-parsed-consent.d.ts","sourceRoot":"","sources":["../../../src/consent-ready/utils/get-parsed-consent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,eAAe,EACf,kBAAkB,EACnB,MAAM,6BAA6B,CAAC;AAOrC;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,eAAe,GAAG,OAAO,CA8B5F;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,eAAe,EAAE,eAAe,GAAG,kBAAkB,CAMrF"}

package/dist/consent-ready/utils/has-consent-changed.d.ts

@@ -0,0 +1,3 @@
+import type { ParsedConsentState } from "../../../typings/types";
+export declare function hasConsentChanged(parsedConsent: ParsedConsentState): boolean;
+//# sourceMappingURL=has-consent-changed.d.ts.map

package/dist/consent-ready/utils/has-consent-changed.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"has-consent-changed.d.ts","sourceRoot":"","sources":["../../../src/consent-ready/utils/has-consent-changed.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAoBjE,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,kBAAkB,GAAG,OAAO,CAO5E"}

package/dist/consent-ready/utils/validators.d.ts

@@ -0,0 +1,16 @@
+import type { RawConsentState } from "../../../typings/types";
+export declare function isValidGdprValue(val: string | null): boolean;
+export declare function isValidUspString(val: string | null): boolean;
+/**
+ * Validates consent state.
+ * @param input - The consent state to validate.
+ * @throws Will throw an error if the consent state is invalid.
+ */
+export declare function validateRawConsentState(input: RawConsentState): input is RawConsentState;
+/**
+ * Validates the custom purpose identifier.
+ * @param categoryName - The custom purpose identifier to validate.
+ * @throws Will throw an error if the custom purpose identifier is invalid.
+ */
+export declare function validateIabConsentCategory(categoryName: string): void;
+//# sourceMappingURL=validators.d.ts.map

package/dist/consent-ready/utils/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../../../src/consent-ready/utils/validators.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAM9D,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAU5D;AAED,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAO5D;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,eAAe,GAAG,KAAK,IAAI,eAAe,CAsBxF;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAIrE"}

package/dist/html/__tests__/cmp-footer-links.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=cmp-footer-links.test.d.ts.map

package/dist/html/__tests__/cmp-footer-links.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cmp-footer-links.test.d.ts","sourceRoot":"","sources":["../../../src/html/__tests__/cmp-footer-links.test.ts"],"names":[],"mappings":""}

package/dist/html/cmp-footer-link.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Runs a querySelector to get a reference to the Manage Gookies link anchor-tag element if
+ * it exists in the page DOM. It then adds an onClick function to the link
+
+ * @returns {boolean} - Returns true if the link was updated, false if not
+ */
+export declare function updateFooterLinkCMP(): boolean;
+//# sourceMappingURL=cmp-footer-link.d.ts.map

package/dist/html/cmp-footer-link.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cmp-footer-link.d.ts","sourceRoot":"","sources":["../../src/html/cmp-footer-link.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,mBAAmB,IAAI,OAAO,CAa7C"}

package/dist/html/cmp-scripts.d.ts

@@ -0,0 +1,16 @@
+import type { SPConfig } from "../../typings/types";
+/**
+ * Utility method to string-encode an object including functions
+ */
+export declare function encodeConfig(obj: Record<string, string | object | null> | object | null): string;
+export declare function getSPConfig(config: SPConfig): string;
+export declare const scriptSources: {
+    cmpFrames: string;
+};
+export declare const scriptContent: {
+    getSPConfig: typeof getSPConfig;
+    tcfStub: string;
+    uspStub: string;
+};
+export declare function getCmpScripts(config: SPConfig): DocumentFragment;
+//# sourceMappingURL=cmp-scripts.d.ts.map

package/dist/html/cmp-scripts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cmp-scripts.d.ts","sourceRoot":"","sources":["../../src/html/cmp-scripts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAIpD;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,UA2BvF;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,QAAQ,UAE3C;AAED,eAAO,MAAM,aAAa;;CAEzB,CAAC;AAEF,eAAO,MAAM,aAAa;;;;CAIzB,CAAC;AAEF,wBAAgB,aAAa,CAAC,MAAM,EAAE,QAAQ,oBAQ7C"}