@soul-refiner/design-system 2.7.3 → 2.7.4-alpha.1

package/dist/src/components/custom/help_center/help_center-auth.d.ts

@@ -0,0 +1,7 @@
+import { USER_ROLES, User } from './types';
+declare const auth: {
+    isAuthenticated: () => boolean;
+    getUser: () => User | null;
+    hasPermission: (role: (typeof USER_ROLES)[keyof typeof USER_ROLES], permission: string) => boolean;
+};
+export default auth;

package/dist/src/components/custom/help_center/help_center-customModal.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { CustomModalProps } from './types';
+declare const CustomModal: React.FC<CustomModalProps>;
+export default CustomModal;

package/dist/src/components/custom/help_center/help_center-defaultArticle.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+interface DefaultArticlePageProps {
+    articleId: string;
+    title: string;
+    handleCreateCategory: (value: string) => void;
+    handleCreateArticle: () => void;
+}
+export declare const HowCanWeHelpPage: React.FC;
+export declare const DefaultArticlePage: React.FC<DefaultArticlePageProps>;
+interface DefaultSubcategoryPageProps {
+    categoryId: string;
+    subcategoryId: string;
+}
+export declare const DefaultSubcategoryPage: React.FC<DefaultSubcategoryPageProps>;
+export {};

package/dist/src/components/custom/help_center/help_center-editable-content.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+import { ArticleCategory } from './types';
+interface EditArticleFormProps {
+    articleCategory: ArticleCategory;
+}
+declare const ArticleCategoryWithQA: React.FC<EditArticleFormProps>;
+export default ArticleCategoryWithQA;

package/dist/src/components/custom/help_center/help_center-mainPage.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const MainPage: React.FC;
+export default MainPage;

package/dist/src/components/custom/help_center/help_center-sidebar.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const Sidebar: React.FC;
+export default Sidebar;

package/dist/src/components/custom/help_center/help_center.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { Category, USER_ROLES } from './types';
+interface HelpCenterProps {
+    initialData: {
+        categories: Category[];
+        userRole: (typeof USER_ROLES)[keyof typeof USER_ROLES];
+    };
+    onDataChange?: (data: {
+        categories: Category[];
+    }) => void;
+}
+export declare const HelpCenter: React.FC<HelpCenterProps>;
+export {};

package/dist/src/components/custom/help_center/help_center_articlle-list.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+interface ArticleListProps {
+    categoryId: string;
+    subcategoryId: string;
+}
+declare const ArticleList: React.FC<ArticleListProps>;
+export default ArticleList;

package/dist/src/components/custom/help_center/help_center_categoryList.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+export interface CategoryListProps {
+    children: (categoryId: string, subcategoryId?: string) => React.ReactNode;
+}
+declare const CategoryList: React.FC<CategoryListProps>;
+export default CategoryList;

package/dist/src/components/custom/help_center/help_center_dataStore.d.ts

@@ -0,0 +1,4 @@
+import React from 'react';
+import { HelpCenterContextValue, HelpCenterProviderProps } from './types';
+export declare const HelpCenterContext: React.Context<HelpCenterContextValue | undefined>;
+export declare const HelpCenterProvider: React.FC<HelpCenterProviderProps>;

package/dist/src/components/custom/help_center/help_center_layout.d.ts

@@ -0,0 +1,3 @@
+import React from 'react';
+declare const AppLayout: React.FC;
+export default AppLayout;

package/dist/src/components/custom/help_center/help_center_seedData.d.ts

@@ -0,0 +1,2 @@
+import { Category } from './types';
+export declare const categoriesInitialData: Category[];

package/dist/src/components/custom/help_center/help_center_sub-category.d.ts

@@ -0,0 +1,7 @@
+import React from 'react';
+interface SubCategoryListProps {
+    categoryId: string;
+    children: (subcategoryId: string) => React.ReactNode;
+}
+declare const SubCategoryList: React.FC<SubCategoryListProps>;
+export default SubCategoryList;

package/dist/src/components/custom/help_center/index.d.ts

@@ -0,0 +1 @@
+export { HelpCenter } from './help_center';

package/dist/src/components/custom/help_center/types.d.ts

@@ -0,0 +1,124 @@
+/// <reference types="react" />
+import { TElement } from '@udecode/plate';
+import { IStyledComponent } from 'styled-components';
+import { FastOmit } from 'styled-components/dist/types';
+export interface Category {
+    id: string;
+    name: string;
+    subcategories: Subcategory[];
+}
+export interface Subcategory {
+    id: string;
+    name: string;
+    categoryId: string;
+    articles: Article[];
+}
+export interface WithPermissionProps {
+    role: (typeof USER_ROLES)[keyof typeof USER_ROLES];
+    permission: string;
+}
+export declare const USER_ROLES: {
+    readonly ADMIN: "admin";
+    readonly EDITOR: "editor";
+    readonly VIEWER: "viewer";
+};
+export interface User {
+    id: string;
+    email: string;
+    role: (typeof USER_ROLES)[keyof typeof USER_ROLES];
+}
+export interface Category {
+    id: string;
+    name: string;
+    subcategories: Subcategory[];
+}
+export declare enum DropdownOptions {
+    RENAME = "Rename",
+    CREATE_SUBCATEGORY = "Create Sub-Category",
+    DELETE_CATEGORY = "Remove the Category",
+    CREATE_ARTICLES = "Create Articles",
+    DELETE_SUBCATEGORY = "Remove"
+}
+export interface CustomModalProps {
+    title: string;
+    isOpen: boolean;
+    setIsOpen: React.Dispatch<React.SetStateAction<boolean>>;
+    initialValue?: string;
+    modalType: modalType;
+    submitButtonText?: string;
+    cancelButtonText?: string;
+    mainContent?: React.ReactNode;
+    headerContent?: React.ReactNode;
+    footerContent?: React.ReactNode;
+    onSubmit: (value: string) => void;
+    trigger: React.ReactNode;
+}
+export type modalType = 'create' | 'edit' | 'delete' | 'create-article-category' | 'edit-article' | 'edit-article-category' | 'delete-article-category' | 'edit-article-QA' | 'delete-article-QA' | 'articleQuestion';
+export interface Subcategory {
+    id: string;
+    name: string;
+    categoryId: string;
+    articles: Article[];
+}
+export interface ArticleCategory {
+    id: string;
+    title?: string;
+    articleId: string;
+    description?: string;
+    questions?: ArticleQuestion[];
+}
+export interface ArticleQuestion {
+    id: string;
+    articleCategoryId: string;
+    question?: string;
+    answer?: TElement[];
+}
+export interface Article {
+    id: string;
+    title: string;
+    content: ArticleCategory[];
+    categoryId: string;
+    subcategoryId: string;
+}
+export interface HelpCenterContextValue {
+    categories: Category[];
+    isLoading: boolean;
+    selectedArticle: Article | null;
+    isNewArticle: boolean;
+    selectedSubcategory: Subcategory | null;
+    error: string | null;
+    userRole: (typeof USER_ROLES)[keyof typeof USER_ROLES];
+    breadcrumbTrail: string[];
+    setSelectedSubcategory: React.Dispatch<React.SetStateAction<Subcategory | null>>;
+    setSelectedArticle: React.Dispatch<React.SetStateAction<Article | null>>;
+    setIsNewArticle: React.Dispatch<React.SetStateAction<boolean>>;
+    setBreadcrumbTrail: React.Dispatch<React.SetStateAction<string[]>>;
+    addCategory: (name: string) => void;
+    updateCategory: (id: string, name: string) => void;
+    deleteCategory: (id: string) => void;
+    addSubcategory: (categoryId: string, name: string) => void;
+    addArticleCategory: (categoryId: string, subcategoryId: string, articleId: string, newCategory: Omit<ArticleCategory, 'id'>) => void;
+    deleteArticleQuestion: (categoryId: string, subcategoryId: string, articleId: string, articleCategoryId: string, questionId: string) => void;
+    deleteArticleCategory: (categoryId: string, subcategoryId: string, articleId: string, articleCategoryId: string) => void;
+    updateArticleCategory: (categoryId: string, subcategoryId: string, articleId: string, articleCategoryId: string, updatedCategoryName: string) => void;
+    addArticleQuestion: (categoryId: string, subcategoryId: string, articleId: string, articleCategoryId: string, newQuestion: Omit<ArticleQuestion, 'id'>) => void;
+    updateArticleQuestion: (categoryId: string, subcategoryId: string, articleId: string, articleCategoryId: string, articleQuestionId: string, updatedQuestion: Omit<ArticleQuestion, 'id'>) => void;
+    updateSubcategory: (categoryId: string, subcategoryId: string, name: string) => void;
+    deleteSubcategory: (categoryId: string, subcategoryId: string) => void;
+    addArticle: (categoryId: string, subcategoryId: string, title: string, content: ArticleCategory[]) => string;
+    updateArticle: (categoryId: string, subcategoryId: string, articleId: string, title: string, content: ArticleCategory[]) => void;
+    deleteArticle: (categoryId: string, subcategoryId: string, articleId: string) => void;
+}
+export interface HelpCenterProviderProps extends HelpCenterProps {
+    children: React.ReactNode;
+}
+export interface HelpCenterProps {
+    initialData: {
+        categories: Category[];
+        userRole: (typeof USER_ROLES)[keyof typeof USER_ROLES];
+    };
+    onDataChange?: (data: {
+        categories: Category[];
+    }) => void;
+}
+export type StyledType = IStyledComponent<'web', FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>>;

package/dist/src/components/editor/context.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
-export type TCustomFilter = 'MEETING_ANSWERS' | 'MY_ANSWERS' | 'ALL_ANSWERS';
 export interface CommentLoaderProps {
     questionAnswerId: string;
-    filterType: TCustomFilter;
+    filterType: string;
+    resetFilter: () => void;
     waitToLoad: boolean;
 }
 export interface CommentInputProps {
@@ -10,7 +10,7 @@ export interface CommentInputProps {
     questionAnswerId: string;
 }
 export interface FilterComponentProps {
-    filter: TCustomFilter;
+    filter: string;
     onFilterChange: (event: React.MouseEvent) => void;
     questionAnswerId: string;
 }
@@ -23,4 +23,5 @@ export declare const EditorContext: React.Context<{
         courseMediaId: number;
     }) => React.ReactElement;
     filterComponent?: React.ComponentType<FilterComponentProps> | undefined;
+    defaultFilter?: string | undefined;
 }>;

package/dist/src/components/editor/editor.d.ts

@@ -9,10 +9,11 @@ export interface EditorProps {
     imageSrcLoader: (id: number) => Promise<string>;
     onChange: (newNodes: TElement[]) => void;
     previousContent?: TElement[];
+    defaultFilter?: string;
     videoTitleLoader: (props: {
         courseMediaId: number;
     }) => React.ReactElement;
     filterComponent?: React.ComponentType<FilterComponentProps>;
 }
 export type EditorContent = TElement;
-export declare const Editor: ({ commentInputLoader, commentLoader, editable, handleVideoClick, imageSrcLoader, onChange, previousContent, videoTitleLoader, filterComponent, }: EditorProps) => React.JSX.Element;
+export declare const Editor: ({ commentInputLoader, commentLoader, editable, handleVideoClick, imageSrcLoader, onChange, previousContent, defaultFilter, videoTitleLoader, filterComponent, }: EditorProps) => React.JSX.Element;

package/dist/src/components/media/audio-player/progress-bar.d.ts

@@ -0,0 +1,14 @@
+import React from 'react';
+interface AudioProgressBarProps {
+    /**
+     * @param duration the total duration of the audio media in seconds
+     * */
+    duration: number;
+    /**
+     * @param progress the amount of the audio media listened to
+     * */
+    progress: number;
+    onSeek: (percent: number) => void;
+}
+export declare const AudioProgressBar: ({ duration, progress, onSeek, }: AudioProgressBarProps) => React.JSX.Element;
+export {};

package/dist/src/components/surfaces/comment/comment.d.ts

@@ -20,5 +20,6 @@ export interface CommentProps {
     userName: string;
     userReactions?: string[];
     userProfileUri: string;
+    sx?: string;
 }
-export declare const Comment: ({ avatarTooltipContent, avatarTooltipSx, content, createdDate, hasMoreReplies, id, onComment, onReact, onShowReplies, dropdown, reactionModal, reactions, replies, userImageUri, userName, userReactions, visibilityIcon, customPlaceHolder, userProfileUri, }: CommentProps) => React.JSX.Element;
+export declare const Comment: ({ avatarTooltipContent, avatarTooltipSx, content, createdDate, hasMoreReplies, id, onComment, onReact, onShowReplies, dropdown, reactionModal, reactions, replies, userImageUri, userName, userReactions, visibilityIcon, customPlaceHolder, userProfileUri, sx, }: CommentProps) => React.JSX.Element;