@washingtonpost/subs-de-inputs 1.0.0-react18.0 → 1.0.0-react18.10

package/dist/components/DEDisclosure/hooks/useOnetrustAlertBoxClosedPromise.d.ts

@@ -0,0 +1,23 @@
+import { ICookieStore } from '@washingtonpost/subs-sdk';
+interface TCData {
+    eventStatus: 'tcloaded' | 'cmpuishown' | 'useractioncomplete';
+    listenerId: number;
+    [key: string]: any;
+}
+type TCFAPIAddListener = (command: 'addEventListener', version: number, callback: (tcData: TCData, success: boolean) => void) => void;
+type TCFAPIRmListener = (command: 'removeEventListener', version: number, callback: (success: boolean) => void, listenerId: number) => void;
+type TCFAPIPing = (command: 'ping', version: number, callback: (pingReturn: any, success: boolean) => void) => void;
+declare global {
+    interface Window {
+        cookieStore?: ICookieStore;
+        __tcfapi?: TCFAPIAddListener & TCFAPIRmListener & TCFAPIPing;
+    }
+}
+export declare const useOneTrustAlertBoxClosed: ({ allowCookieStore, }: {
+    allowCookieStore: boolean;
+}) => {
+    alertBoxClosed: boolean | undefined;
+    listenToCookieStore: boolean;
+    listenToTcfApi: boolean;
+};
+export {};

package/dist/components/DEDisclosure/index.d.ts

@@ -0,0 +1,12 @@
+import React from 'react';
+interface DisclosureProps {
+    /** callback function to be called when the disclosure is finished loading */
+    onFinished?: ({ isFinished, isError, }: {
+        isFinished: boolean;
+        isError: boolean;
+    }) => void;
+    /** ability to turn off cookiestore listener, primarily for testing purposes */
+    allowCookieStore?: boolean;
+}
+export declare const DEDisclosure: React.FC<DisclosureProps>;
+export {};

package/dist/components/DEDisclosure/utils/checkCookie.d.ts

@@ -0,0 +1 @@
+export declare const checkCookie: () => boolean;

package/dist/components/DEDisclosure/utils/getConfig.d.ts

@@ -0,0 +1,2 @@
+import { DisclosureConfigValue } from '../../../interfaces/disclosure';
+export declare const getConfig: () => Promise<DisclosureConfigValue | undefined>;

package/dist/components/DEDisclosure/utils/hydrateLinks.d.ts

@@ -0,0 +1,3 @@
+type hydrateLinksType = (str: string) => string | JSX.Element;
+export declare const hydrateLinks: hydrateLinksType;
+export {};

package/dist/components/DESelect/Dropdown.d.ts

@@ -0,0 +1,17 @@
+import React from 'react';
+interface IDropdownProps {
+    id: string;
+    label: string;
+    values: Array<string>;
+    required?: boolean;
+    defaultValue?: string;
+    onChange?: (value: string) => void;
+    disabled?: boolean;
+}
+/**
+ * Dropdown component.  Uses wpds-ui-kit on desktop and native select on mobile.
+ * @param {IDropdownProps} props The props.
+ * @returns {React.ReactElement} The dropdown.
+ */
+export declare const Dropdown: ({ id, label, values, required, defaultValue, onChange, disabled, }: IDropdownProps) => React.JSX.Element;
+export {};

package/dist/components/DESelect/index.d.ts

@@ -1,15 +1,10 @@
 import React from 'react';
-import { SubsWindow } from '@washingtonpost/subs-sdk';
 import { Attribute, AttributeValue } from '../../interfaces';
-declare global {
-    interface Window extends SubsWindow {
-    }
-}
 interface DESelectProps {
     source: string;
     fieldName: string;
     label?: string;
-    dataDictionaryConfig?: Attribute;
+    dataDictionaryConfig?: Attribute | Readonly<Attribute>;
     defaultValue?: string;
     disabled?: boolean;
     submit: boolean;

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 export * from './interfaces/index';
+export * from './interfaces/twpdeu';
 export * from './utils/hasRequiredPrivacyCookies';
-export * from './services/dataEnrichment';
+export * from './utils/push';
+export * from './services/getAttributes';
 export * from './components/DESelect';
+export * from './components/DEDisclosure';

package/dist/interfaces/disclosure.d.ts

@@ -0,0 +1,8 @@
+export type DisclosureConfigValue = {
+    disclosure: string[];
+} & {
+    checkBannerStatus: boolean;
+    disclosure_beforebanner: string[];
+    disclosure_afterbanner: string[];
+};
+export type DisclosureConfig = Record<string, DisclosureConfigValue>;

package/dist/interfaces/index.d.ts

@@ -13,16 +13,20 @@ export type Attribute = {
     name: string;
     approved_for_use?: boolean;
     collection_behavior?: (typeof CollectionBehaviors)[keyof typeof CollectionBehaviors];
-    datatype: 'string';
+    datatype: string;
     explicit: boolean;
     multiple_value: boolean;
     last_modified_date: Number;
     date_created: Number;
-    values: Array<AttributeValue>;
+    values: AttributeValue[] | Readonly<AttributeValue[]>;
 };
 export declare const AttributesState: {
     readonly SUCCESS: "100";
 };
+export declare const IngestType: {
+    readonly EXPLICIT: "explicit";
+    readonly IMPLICIT: "implicit";
+};
 export declare const IngestResponseState: {
     readonly SUCCESS: "100";
     readonly SYSTEM_ERROR: "101";
@@ -31,4 +35,8 @@ export declare const IngestResponseState: {
     readonly INVALID_DATA: "104";
     readonly INVALID_ATTRIBUTE_DEFINITION: "105";
     readonly INVALID_META_DEFINITION: "106";
+    readonly UNAUTHENTICATED: "107";
+    readonly MISMATCHED_IDENTIFIER: "108";
+    readonly DISABLED_ATTRIBUTE_DEFINITION: "109";
+    readonly DO_NOT_COLLECT: "110";
 };

package/dist/interfaces/twpdeu.d.ts

@@ -0,0 +1,12 @@
+import { getAttributes } from '../services/getAttributes';
+import { push } from '../utils/push';
+export type TWPDEU = {
+    getFieldConfigs: typeof getAttributes;
+    push: typeof push;
+    version?: string;
+};
+declare global {
+    interface Window {
+        __twpdeu?: TWPDEU;
+    }
+}

package/dist/services/getAttributes.d.ts

@@ -0,0 +1,6 @@
+import { Attribute } from '../interfaces';
+export declare const getAttributes: GetAttributesType;
+type GetAttributesType = ({ fieldName, }: {
+    fieldName: string;
+}) => Promise<Attribute[]>;
+export {};

package/dist/services/ingest.d.ts

@@ -0,0 +1,14 @@
+import { ResponseStatus } from '@washingtonpost/subs-sdk';
+import { IngestResponseState, IngestType } from '../interfaces';
+export declare const ingest: IngestType;
+type IngestType = ({ submitData: { fieldName, value }, source, }: {
+    submitData: {
+        fieldName: string;
+        value: string;
+    };
+    source: string;
+}) => Promise<{
+    status: ResponseStatus;
+    state: (typeof IngestResponseState)[keyof typeof IngestResponseState];
+} | null>;
+export {};

package/dist/services/sendToGA.d.ts

@@ -0,0 +1,9 @@
+export declare const sendToGA: SendToGaType;
+type SendToGaType = ({ submitData: { fieldName, value }, source, }: {
+    submitData: {
+        fieldName: string;
+        value: string;
+    };
+    source: string;
+}) => Promise<true>;
+export {};