@apolitical/component-library 6.4.1 → 6.5.0-beta.0

package/discussion/components/form/form.constants.d.ts

@@ -0,0 +1,2 @@
+export declare const MAX_POLL_OPTIONS = 5;
+export declare const MIN_POLL_OPTIONS = 2;

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

@@ -1,3 +1,3 @@
 import { IDiscussionForm } from './form.type';
-declare const DiscussionForm: ({ id, parentId, content, userHasPermissions, meta, placeholder, maxLength, buttons, forceShow, isCommunity, functions, data, gtmContext, }: IDiscussionForm) => import("react/jsx-runtime").JSX.Element;
+declare const DiscussionForm: ({ id, parentId, content, userHasPermissions, meta, placeholder, maxLength, buttons, forceShow, functions, data, gtmContext, }: IDiscussionForm) => import("react/jsx-runtime").JSX.Element;
 export default DiscussionForm;

package/discussion/components/form/form.helpers.d.ts

@@ -0,0 +1,4 @@
+import type { IFormValues } from '../../../form';
+import type { IRTEValues } from './form.type';
+import { ITransformedPollData } from './../../shared';
+export declare const transformPollData: (data: IRTEValues & IFormValues) => ITransformedPollData;

package/discussion/components/form/form.type.d.ts

@@ -1,6 +1,9 @@
 import type { IEnrichedUrlData } from '../../../navigation';
-import { IDiscussionContent, IMentions } from './../../discussion';
-import { ICategory, IDiscussionFormFunctions } from '../../shared';
+import type { ICategory, IDiscussionFormFunctions, IDiscussionContent, IMentions } from '../../shared';
+interface IPollData {
+    options: string[];
+    multipleAnswers: boolean;
+}
 export interface IDiscussionFormMeta {
     /** Whether the form data is still loading */
     isLoading?: boolean;
@@ -14,11 +17,14 @@ export interface IDiscussionFormMeta {
     isEditing: false | {
         categories?: string[] | string;
         text?: string;
+        poll?: IPollData;
     };
     /** Whether the form has a title field */
     hasTitleField?: false | {
         text?: string;
     };
+    /** If the form can be pre-populated; this is not allowed outside communities at the moment */
+    canBePrepopulated?: boolean;
     /** Whether the form is prepopulated with text (different to isEditing, as we want different buttons and text to show */
     isPrepopulated: false | {
         text?: string;
@@ -58,8 +64,6 @@ export interface IDiscussionForm {
         /** Text for the submit button */
         submit?: string;
     };
-    /** If the form is used within a Community */
-    isCommunity?: boolean;
     /** Force elements on the form to show, regardless of the form state */
     forceShow?: {
         /** If the cancel button should always show */
@@ -81,11 +85,15 @@ export interface IDiscussionForm {
     /** The language to use for the text */
     locale?: string;
 }
-export interface IDiscussionFormState {
-    title: string;
-    body: string;
-    categories: string[] | string;
-    data: {
+export interface IRTEValues {
+    body?: string;
+    data?: {
         link?: false | IEnrichedUrlData;
     };
 }
+export interface IDiscussionFormState {
+    status: false | 'submitting' | 'submitted';
+    title: string;
+    polls: number;
+}
+export {};

package/discussion/components/post/post.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { IMemberComponentProps } from '../../../user';
 import { DiscussionCreateContentFunction, DiscussionCreateLikeFunction, DiscussionDeleteLikeFunction, DiscussionListLikesFunction, IDiscussionFormFns } from '../../discussion';
-import type { IForceHide, IFullDiscussionContent } from '../../shared/interfaces';
+import { type IForceHide, type IFullDiscussionContent } from '../../shared/interfaces';
 import { IBadgesOption } from '../../../user/badges';
 export interface IPostContent extends IFullDiscussionContent {
     /** The post body */

package/discussion/discussion.mock.d.ts

@@ -216,3 +216,7 @@ export namespace question {
     let createdAt_5: string;
     export { createdAt_5 as createdAt };
 }
+export const postCategories: {
+    name: string;
+    slug: string;
+}[];

package/discussion/sections/activity-section/activity-section.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { type IProfileFormProps } from '../../../form';
-import { type IRepliesFeedQueryFns, type ILikesFeedQueryFns } from '../../../discussion/feeds';
+import { type ILikesFeedQueryFns, type IRepliesFeedQueryFns } from '../../../discussion/feeds';
 import type { IDiscussionFormFns } from './../../discussion.d';
 import { type IQueryFns } from './cache';
 import { ICategory } from '../../shared';

package/discussion/shared/interfaces/discussion.interface.d.ts

@@ -3,10 +3,18 @@ import type { ListMembers, ClickMentionFallback } from '../../../form';
 import type { IEnrichedUrlData } from '../../../navigation';
 import type { ICategory } from './community.category.interface';
 import type { IDiscussionFormFns } from '../../discussion';
-export type IDiscussionContentType = 'answer' | 'post' | 'response' | 'reply' | 'question';
+export declare enum DiscussionContentType {
+    Answer = "answer",
+    Poll = "poll",
+    Post = "post",
+    Response = "response",
+    Reply = "reply",
+    Question = "question"
+}
+export type IDiscussionContentType = DiscussionContentType.Answer | DiscussionContentType.Poll | DiscussionContentType.Post | DiscussionContentType.Response | DiscussionContentType.Reply | DiscussionContentType.Question;
 export interface IDiscussionContent {
     /** The type of content */
-    type: IDiscussionContentType;
+    type: IDiscussionContentType | undefined;
     /** The slugs we're dealing with - used in functions */
     slugs: {
         question?: string;
@@ -92,15 +100,21 @@ export interface IConversation {
     prepopulateForm?: string;
     mentionData?: IListMemberData;
 }
+export interface ITransformedPollData {
+    [key: string]: string | number | {
+        [key: string]: string | number;
+    } | {
+        [key: string]: string | number;
+    }[];
+}
 export interface IDiscussionFormFunctions extends IDiscussionFormFns {
     onChange?: (args: {
-        [key: string]: string | boolean;
+        [key: string]: string | string[] | boolean;
     }) => void;
     create: DiscussionCreateContentFunction;
-    handleSaveEdit?: (({ title, body }: {
-        title: string;
-        body: string;
-    }) => Promise<void>) | (() => void);
+    createPoll?: (args: ITransformedPollData) => void;
+    handleSaveEdit?: // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+    ((args: any) => Promise<void>) | (() => void);
     handleCancel?: () => void;
     callback?: (args: void) => void;
     onMention?: (value?: IListMemberData) => void;

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

@@ -268,5 +268,7 @@ export interface IFieldWrapper extends IField {
         setFields: React.Dispatch<React.SetStateAction<IField[]>>;
         dispatch: React.Dispatch<IFormReducerAction>;
     };
+    /** Optional siblings to render alongside component */
+    siblings?: React.ReactNode;
 }
 export {};

package/helpers/intl.d.ts

@@ -137,6 +137,12 @@ export declare const checkIntlPathExists: (path: string, language?: {
     discussion_form_titleField_label: string;
     discussion_form_titleField_placeholder: string;
     discussion_form_titleField_error: string;
+    discussion_form_question_label: string;
+    discussion_form_question_placeholder: string;
+    discussion_form_option_label: string;
+    discussion_form_option_placeholder: string;
+    discussion_form_option_cta: string;
+    discussion_form_multiplePollAnswers: string;
     discussion_form_placeholder: string;
     discussion_form_label: string;
     discussion_form_label_action: string;
@@ -236,6 +242,7 @@ export declare const checkIntlPathExists: (path: string, language?: {
     form_multipleInputs_label: string;
     form_multipleInputs_filledInCount: string;
     form_multipleInputs_filledInCount_aria: string;
+    form_multipleInputs_remove: string;
     inviteForm_email_placeholder: string;
     inviteForm_title: string;
     inviteForm_label: string;
@@ -279,7 +286,6 @@ export declare const checkIntlPathExists: (path: string, language?: {
     profileImageChange_error: string;
     publishArticleForm_title_label: string;
     publishArticleForm_title_placeholder: string;
-    publishArticleForm_title_error: string;
     publishArticleForm_subtitle_label: string;
     publishArticleForm_subtitle_placeholder: string;
     publishArticleForm_body_label: string;