@apolitical/component-library 1.13.6 → 1.14.0

package/cards/mocks/mocks.helpers.d.ts

@@ -0,0 +1,500 @@
+import { MockCardType, CardType } from './../cards.types';
+export declare const CONTENT_TYPES: {
+    ARTICLE: string;
+    COURSE: string;
+    EVENT: string;
+    LIST: string;
+    QUESTION: string;
+    PEOPLE: string;
+    LEARNING_HUB: string;
+    CUSTOM: string;
+};
+export declare const buildCard: (contentType: string, cardType?: string | null) => {
+    contentType: string;
+    cardType: string | null;
+    sys: {
+        id: string;
+        linkType: string;
+        type: string;
+    };
+};
+export declare const cardMapper: {
+    [x: string]: {
+        oneAuthor: {
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            contributors: {
+                name: string;
+                image: null;
+            }[];
+            publishedDate: Date;
+            readingTime: number;
+            slug: string;
+            title: string;
+        };
+        twoAuthors: {
+            contributors: {
+                name: string;
+                image: null;
+            }[];
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            publishedDate: Date;
+            readingTime: number;
+            slug: string;
+            title: string;
+        };
+        multipleAuthors: {
+            contributors: {
+                name: string;
+                image: null;
+            }[];
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            publishedDate: Date;
+            readingTime: number;
+            slug: string;
+            title: string;
+        };
+        premium?: undefined;
+        free?: undefined;
+        partner?: undefined;
+        registered?: undefined;
+        upcoming?: undefined;
+        past?: undefined;
+        twoSpeakers?: undefined;
+        multipleSpeakers?: undefined;
+        list?: undefined;
+        noAnswers?: undefined;
+        oneAnswer?: undefined;
+        multipleAnswers?: undefined;
+        shortQuestion?: undefined;
+        longQuestion?: undefined;
+        people?: undefined;
+        learningHub?: undefined;
+        custom?: undefined;
+    } | {
+        premium: {
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            slug: string;
+            title: string;
+            pill: string;
+            registered: boolean;
+        };
+        free: {
+            pill: string;
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            slug: string;
+            title: string;
+            registered: boolean;
+        };
+        partner: {
+            partner: {
+                title: string;
+            };
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            slug: string;
+            title: string;
+            pill: string;
+            registered: boolean;
+        };
+        registered: {
+            registered: boolean;
+            pill: string;
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            slug: string;
+            title: string;
+        };
+        oneAuthor?: undefined;
+        twoAuthors?: undefined;
+        multipleAuthors?: undefined;
+        upcoming?: undefined;
+        past?: undefined;
+        twoSpeakers?: undefined;
+        multipleSpeakers?: undefined;
+        list?: undefined;
+        noAnswers?: undefined;
+        oneAnswer?: undefined;
+        multipleAnswers?: undefined;
+        shortQuestion?: undefined;
+        longQuestion?: undefined;
+        people?: undefined;
+        learningHub?: undefined;
+        custom?: undefined;
+    } | {
+        upcoming: {
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            dateHasPassed: boolean;
+            title: string;
+            slug: string;
+            contributors: {
+                name: string;
+                image: null;
+            }[];
+            startDate: Date;
+        };
+        past: {
+            dateHasPassed: boolean;
+            startDate: Date;
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            title: string;
+            slug: string;
+            contributors: {
+                name: string;
+                image: null;
+            }[];
+        };
+        twoSpeakers: {
+            contributors: {
+                name: string;
+                image: null;
+            }[];
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            dateHasPassed: boolean;
+            title: string;
+            slug: string;
+            startDate: Date;
+        };
+        multipleSpeakers: {
+            contributors: {
+                name: string;
+                image: null;
+            }[];
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            dateHasPassed: boolean;
+            title: string;
+            slug: string;
+            startDate: Date;
+        };
+        registered: {
+            registered: boolean;
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            dateHasPassed: boolean;
+            title: string;
+            slug: string;
+            contributors: {
+                name: string;
+                image: null;
+            }[];
+            startDate: Date;
+        };
+        oneAuthor?: undefined;
+        twoAuthors?: undefined;
+        multipleAuthors?: undefined;
+        premium?: undefined;
+        free?: undefined;
+        partner?: undefined;
+        list?: undefined;
+        noAnswers?: undefined;
+        oneAnswer?: undefined;
+        multipleAnswers?: undefined;
+        shortQuestion?: undefined;
+        longQuestion?: undefined;
+        people?: undefined;
+        learningHub?: undefined;
+        custom?: undefined;
+    } | {
+        list: {
+            contentType: string;
+            banner: {
+                description: string;
+                height: number;
+                type: string;
+                url: string;
+                width: number;
+                aspect: string;
+                query: string;
+            };
+            slug: string;
+            title: string;
+        };
+        oneAuthor?: undefined;
+        twoAuthors?: undefined;
+        multipleAuthors?: undefined;
+        premium?: undefined;
+        free?: undefined;
+        partner?: undefined;
+        registered?: undefined;
+        upcoming?: undefined;
+        past?: undefined;
+        twoSpeakers?: undefined;
+        multipleSpeakers?: undefined;
+        noAnswers?: undefined;
+        oneAnswer?: undefined;
+        multipleAnswers?: undefined;
+        shortQuestion?: undefined;
+        longQuestion?: undefined;
+        people?: undefined;
+        learningHub?: undefined;
+        custom?: undefined;
+    } | {
+        noAnswers: {
+            contentType: string;
+            answers: number;
+            contributors: {
+                id: string;
+                name: string;
+            }[];
+            slug: string;
+            title: string;
+            createdAt: Date;
+        };
+        oneAnswer: {
+            answers: number;
+            contentType: string;
+            contributors: {
+                id: string;
+                name: string;
+            }[];
+            slug: string;
+            title: string;
+            createdAt: Date;
+        };
+        multipleAnswers: {
+            answers: number;
+            contentType: string;
+            contributors: {
+                id: string;
+                name: string;
+            }[];
+            slug: string;
+            title: string;
+            createdAt: Date;
+        };
+        shortQuestion: {
+            title: string;
+            answers: number;
+            contentType: string;
+            contributors: {
+                id: string;
+                name: string;
+            }[];
+            slug: string;
+            createdAt: Date;
+        };
+        longQuestion: {
+            title: string;
+            answers: number;
+            contentType: string;
+            contributors: {
+                id: string;
+                name: string;
+            }[];
+            slug: string;
+            createdAt: Date;
+        };
+        oneAuthor?: undefined;
+        twoAuthors?: undefined;
+        multipleAuthors?: undefined;
+        premium?: undefined;
+        free?: undefined;
+        partner?: undefined;
+        registered?: undefined;
+        upcoming?: undefined;
+        past?: undefined;
+        twoSpeakers?: undefined;
+        multipleSpeakers?: undefined;
+        list?: undefined;
+        people?: undefined;
+        learningHub?: undefined;
+        custom?: undefined;
+    } | {
+        people: {
+            contentType: string;
+            title: string;
+            text: string;
+            secondaryText: string;
+            profile: string;
+            slug: string;
+        };
+        oneAuthor?: undefined;
+        twoAuthors?: undefined;
+        multipleAuthors?: undefined;
+        premium?: undefined;
+        free?: undefined;
+        partner?: undefined;
+        registered?: undefined;
+        upcoming?: undefined;
+        past?: undefined;
+        twoSpeakers?: undefined;
+        multipleSpeakers?: undefined;
+        list?: undefined;
+        noAnswers?: undefined;
+        oneAnswer?: undefined;
+        multipleAnswers?: undefined;
+        shortQuestion?: undefined;
+        longQuestion?: undefined;
+        learningHub?: undefined;
+        custom?: undefined;
+    } | {
+        learningHub: {
+            contentType: string;
+            label: string;
+            title: string;
+            banner: {
+                url: string;
+            };
+            slug: string;
+        };
+        oneAuthor?: undefined;
+        twoAuthors?: undefined;
+        multipleAuthors?: undefined;
+        premium?: undefined;
+        free?: undefined;
+        partner?: undefined;
+        registered?: undefined;
+        upcoming?: undefined;
+        past?: undefined;
+        twoSpeakers?: undefined;
+        multipleSpeakers?: undefined;
+        list?: undefined;
+        noAnswers?: undefined;
+        oneAnswer?: undefined;
+        multipleAnswers?: undefined;
+        shortQuestion?: undefined;
+        longQuestion?: undefined;
+        people?: undefined;
+        custom?: undefined;
+    } | {
+        custom: {
+            contentType: string;
+            slug: null;
+            customIcon: string;
+            customLabel: string;
+            contributors: {
+                name: string;
+                image: {
+                    thumbnail: string;
+                };
+            }[];
+            text: string;
+            secondaryText: string;
+        };
+        oneAuthor?: undefined;
+        twoAuthors?: undefined;
+        multipleAuthors?: undefined;
+        premium?: undefined;
+        free?: undefined;
+        partner?: undefined;
+        registered?: undefined;
+        upcoming?: undefined;
+        past?: undefined;
+        twoSpeakers?: undefined;
+        multipleSpeakers?: undefined;
+        list?: undefined;
+        noAnswers?: undefined;
+        oneAnswer?: undefined;
+        multipleAnswers?: undefined;
+        shortQuestion?: undefined;
+        longQuestion?: undefined;
+        people?: undefined;
+        learningHub?: undefined;
+    };
+};
+export declare const buildCardDataMock: (card: MockCardType) => Promise<unknown>;
+export declare const buildCustomCardData: (card: CardType) => () => Promise<unknown>;

package/helpers/cases.d.ts

@@ -0,0 +1 @@
+export declare const camelCaseToDashCase: (str: string) => string;

package/helpers/dates.d.ts

@@ -1,4 +1,4 @@
-type DateType = Date | string;
+export type DateType = Date | string;
 export declare const getMonth: (date: DateType, locale?: string) => string;
 export declare const getNumericDay: (date: DateType, locale?: string) => string;
 export declare const getShortDate: (date: DateType, locale?: string) => string;
@@ -11,4 +11,3 @@ export declare const getShortDateHowLongAgo: (dateInPast: Date | string) => "" |
     path: string;
     number: number;
 };
-export {};

package/helpers/index.d.ts

@@ -1,5 +1,6 @@
 export { default as basicReducer } from './basic-reducer';
 export * from './breakpoints';
+export * from './cases';
 export * from './dates';
 export { default as delay } from './delay';
 export * from './intl';

package/helpers/intl.d.ts

@@ -1,3 +1,4 @@
+export declare const checkIntlPathExists: (path: string) => boolean;
 export declare const getIntlPath: (callback: (args1: {
     id: string;
 }, args2?: object) => string, path: string, key: string, value: string, args?: object) => string;

package/hooks/index.d.ts

@@ -1,5 +1,5 @@
 export { default as useCurrentPath } from './use-current-path';
 export { default as useEffectAfterMount } from './use-effect-after-mount';
-export { default as useScreenWidth } from './use-screen-width';
+export { default as useElementWidth } from './use-element-width';
 export { default as useScrollListener } from './use-scroll-listener';
 export { default as useScrollToHash } from './use-scroll-to-hash';

package/hooks/{use-screen-width.d.ts → use-element-width.d.ts}

@@ -1,2 +1,2 @@
-declare function _default(shouldGetWidth?: boolean, shouldAddClass?: boolean): number | undefined;
+declare function _default(shouldGetWidth?: boolean, shouldAddClass?: boolean, element?: string): number | undefined;
 export default _default;