@apolitical/component-library 3.3.6 → 3.4.0

package/cards/cards.types.d.ts

@@ -1,7 +1,7 @@
 import { ResponsiveImageType } from '../general';
 import { CustomIconType } from '../text';
 import { MemberProps } from '../user';
-export type CardContentType = 'customCard' | 'event' | 'learningHub' | 'listPage' | 'microcourse' | 'people' | 'qaQuestion' | 'solutionArticle';
+export type CardContentType = 'customCard' | 'event' | 'learningHub' | 'listPage' | 'microcourse' | 'people' | 'qaQuestion' | 'solutionArticle' | 'communityPage';
 export interface CardCTAType {
     /** The text to show on the CTA button - different content types have different fallbacks */
     text?: string;
@@ -62,6 +62,12 @@ export interface CardType {
     profile?: string;
     /** The number of answers */
     answers?: number;
+    /** Community cards */
+    members?: {
+        memberType: string;
+        isMember: boolean;
+        count: number;
+    };
 }
 export interface MockCardType extends CardType {
     cardType?: string;

package/cards/mocks/card.d.ts

@@ -214,11 +214,35 @@ export namespace learningHub {
     let slug_6: string;
     export { slug_6 as slug };
 }
-export namespace custom {
+export namespace community {
     let contentType_7: string;
     export { contentType_7 as contentType };
-    let slug_7: null;
+    export namespace sys {
+        let id: string;
+    }
+    let title_10: string;
+    export { title_10 as title };
+    let slug_7: string;
     export { slug_7 as slug };
+    let _private: boolean;
+    export { _private as private };
+    export let visible: boolean;
+    export namespace bannerSection {
+        export let eyebrow: string;
+        let title_11: string;
+        export { title_11 as title };
+        let text_1: string;
+        export { text_1 as text };
+        export let ctaLink: null;
+        export let ctaText: null;
+        export let image: null;
+    }
+}
+export namespace custom {
+    let contentType_8: string;
+    export { contentType_8 as contentType };
+    let slug_8: null;
+    export { slug_8 as slug };
     export let customIcon: string;
     export let customLabel: string;
     let contributors_7: {
@@ -228,8 +252,8 @@ export namespace custom {
         };
     }[];
     export { contributors_7 as contributors };
-    let text_1: string;
-    export { text_1 as text };
+    let text_2: string;
+    export { text_2 as text };
     let secondaryText_1: string;
     export { secondaryText_1 as secondaryText };
 }

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

@@ -7,6 +7,7 @@ export declare const CONTENT_TYPES: {
     QUESTION: string;
     PEOPLE: string;
     LEARNING_HUB: string;
+    COMMUNITY: string;
     CUSTOM: string;
 };
 export declare const buildCard: (contentType: string, cardType?: string | null) => {
@@ -98,6 +99,7 @@ export declare const cardMapper: {
         customLink?: undefined;
         learningHub?: undefined;
         custom?: undefined;
+        community?: undefined;
     } | {
         premium: {
             contentType: string;
@@ -183,6 +185,7 @@ export declare const cardMapper: {
         customLink?: undefined;
         learningHub?: undefined;
         custom?: undefined;
+        community?: undefined;
     } | {
         upcoming: {
             contentType: string;
@@ -301,6 +304,7 @@ export declare const cardMapper: {
         customLink?: undefined;
         learningHub?: undefined;
         custom?: undefined;
+        community?: undefined;
     } | {
         list: {
             contentType: string;
@@ -336,6 +340,7 @@ export declare const cardMapper: {
         customLink?: undefined;
         learningHub?: undefined;
         custom?: undefined;
+        community?: undefined;
     } | {
         noAnswers: {
             contentType: string;
@@ -408,6 +413,7 @@ export declare const cardMapper: {
         customLink?: undefined;
         learningHub?: undefined;
         custom?: undefined;
+        community?: undefined;
     } | {
         people: {
             contentType: string;
@@ -445,6 +451,7 @@ export declare const cardMapper: {
         longQuestion?: undefined;
         learningHub?: undefined;
         custom?: undefined;
+        community?: undefined;
     } | {
         learningHub: {
             contentType: string;
@@ -475,6 +482,7 @@ export declare const cardMapper: {
         people?: undefined;
         customLink?: undefined;
         custom?: undefined;
+        community?: undefined;
     } | {
         custom: {
             contentType: string;
@@ -510,7 +518,49 @@ export declare const cardMapper: {
         people?: undefined;
         customLink?: undefined;
         learningHub?: undefined;
+        community?: undefined;
+    } | {
+        community: {
+            contentType: string;
+            sys: {
+                id: string;
+            };
+            title: string;
+            slug: string;
+            private: boolean;
+            visible: boolean;
+            bannerSection: {
+                eyebrow: string;
+                title: string;
+                text: string;
+                ctaLink: null;
+                ctaText: null;
+                image: null;
+            };
+        };
+        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;
+        customLink?: undefined;
+        learningHub?: undefined;
+        custom?: undefined;
     };
 };
 export declare const buildCardDataMock: (card: MockCardType) => Promise<unknown>;
 export declare const buildCustomCardData: (card: CardType) => () => Promise<unknown>;
+export declare const buildCommunityCardData: (card: CardType, memberType: string) => () => Promise<unknown>;

package/form/components/form/form.d.ts

@@ -1,3 +1,3 @@
 import { IFormProps } from './form.types';
-declare const Form: ({ fields, className, id: formId, formRef: ref, intlPath, button, secondaryActionButton, meta, gtm, functions: { onSuccess, onCancel, onCatch, onFailure, }, ...props }: IFormProps) => import("react/jsx-runtime").JSX.Element | null;
+declare const Form: ({ fields, className, id: formId, formRef: ref, intlPath, button, secondaryActionButton, meta: { shouldShowCancelButton, shouldReset, showRequiredLabels, showSuccessMessage, }, gtm, functions: { onSuccess, onCancel, onCatch, onFailure, }, ...props }: IFormProps) => import("react/jsx-runtime").JSX.Element | null;
 export default Form;

package/form/types/signup-form/signup-form.d.ts

@@ -1,10 +1,3 @@
-export interface IShouldShowProps {
-    title?: boolean;
-    expectation?: boolean;
-    url?: boolean;
-    logInButton?: boolean;
-    successMessage?: boolean;
-}
 interface ISignupForm {
     className?: string;
     functions: {
@@ -15,11 +8,18 @@ interface ISignupForm {
         /** Callback function to resend verification code (used when user already signed up but not verified) */
         resendVerificationCode: () => void;
     };
-    shouldShow: IShouldShowProps;
+    shouldShow: {
+        title?: boolean;
+        expectation: boolean;
+        url?: boolean;
+        logInButton: boolean;
+        successMessage?: boolean;
+    };
     dataToSubmit: {
         [key: string]: string;
     };
     submitButton: string;
+    showSuccessMessage?: boolean;
 }
-declare const SignupForm: ({ className, functions, shouldShow: shouldShowProps, submitButton, dataToSubmit, ...props }: ISignupForm) => import("react/jsx-runtime").JSX.Element;
+declare const SignupForm: ({ className, functions, shouldShow, submitButton, dataToSubmit, ...props }: ISignupForm) => import("react/jsx-runtime").JSX.Element;
 export default SignupForm;

package/form/types/signup-form/signup-form.helpers.d.ts

@@ -7,7 +7,7 @@ interface IBlurEmailField {
 }
 declare const blurEmailField: ({ ref, validateEmail, dispatch }: IBlurEmailField) => Promise<void>;
 declare const transformFormData: (formData: FormData) => {
-    name: string;
+    name: FormDataEntryValue;
     email: string;
     jobTitle: FormDataEntryValue;
     organization: FormDataEntryValue;

package/form/types/signup-form/signup-form.helpers.get-fields.d.ts

@@ -1,8 +1,13 @@
 import React from 'react';
 import { IField } from '../../../form/components/form/form.types';
-import { IShouldShowProps } from './signup-form';
 interface Props {
-    shouldShow: IShouldShowProps;
+    shouldShow: {
+        title?: boolean;
+        expectation: boolean;
+        url?: boolean;
+        logInButton: boolean;
+        successMessage?: boolean;
+    };
     functions: {
         validateEmail: (arg: any) => Promise<any>;
         createAccount: (arg: any) => Promise<any>;

package/helpers/intl.d.ts

@@ -6,6 +6,13 @@ export declare const checkIntlPathExists: (path: string, language?: {
     dates_weeks: string;
     dates_years: string;
     card_carousel_viewAll: string;
+    card_label_communityPage: string;
+    card_label_event: string;
+    card_label_learningHub: string;
+    card_label_listPage: string;
+    card_label_microcourse: string;
+    card_label_qaQuestion: string;
+    card_label_solutionArticle: string;
     card_bootcamp: string;
     card_ended: string;
     card_registered: string;
@@ -16,6 +23,9 @@ export declare const checkIntlPathExists: (path: string, language?: {
     card_time_ago: string;
     card_time_read: string;
     card_watch: string;
+    card_member_type_owner: string;
+    card_member_type_member: string;
+    card_member_count: string;
     card_cta_people: string;
     card_cta_event: string;
     card_cta_microcourse: string;
@@ -254,6 +264,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     footer_platform_courses: string;
     footer_platform_qanda: string;
     footer_platform_articles: string;
+    footer_platform_communities: string;
     footer_community: string;
     footer_community_support: string;
     footer_community_post: string;
@@ -298,6 +309,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     header_topics_explore_courses: string;
     'header_topics_explore_q-and-a': string;
     header_topics_explore_articles: string;
+    header_topics_explore_communities: string;
     header_topics_topics: string;
     header_topics_topics_climate: string;
     'header_topics_topics_cities-and-local-government': string;
@@ -349,6 +361,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     navigationMenu_links_microcourses: string;
     'navigationMenu_links_q-and-a': string;
     navigationMenu_links_articles: string;
+    navigationMenu_links_communities: string;
     navigationMenu_profile: string;
     shareLinks_label: string;
     shareLinks_link_linkedin: string;