@edifice.io/react 2.0.0-develop-rc.8 → 2.0.0-develop-rc.14

package/README.md

@@ -1,4 +1,4 @@
-# Edifice React Library
+# Edifice React Components
 
 ![npm](https://img.shields.io/npm/v/@edifice.io/react?style=flat-square)
 ![bundlephobia](https://img.shields.io/bundlephobia/min/@edifice.io/react?style=flat-square)
@@ -7,33 +7,104 @@
 
 We follow [WAI ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/) rules and [Bootstrap 5](https://getbootstrap.com/docs/5.0/components/accordion/) guidelines when making our components
 
-### Install
+### Build
 
+```bash
+pnpm run build
 ```
-pnpm add @edifice.io/react
+
+### Lint
+
+```bash
+pnpm run lint
 ```
 
-### Modules
+If `pnpm run lint` shows issues, run this command to fix them.
 
-Optional modules are available as `sub-imports`. You can use them in specific applications:
+```bash
+pnpm run fix
+```
 
-#### Audience
+### Prettier
+
+```bash
+pnpm run format
+```
 
-Module to track views or reactions on a resource in a specific application (e.g: Blog)
+## Structure
 
-#### Editor
+### Component Folder
 
-Rich Text Editor using Tiptap and our `multimedia` module.
+- Folder name always in PascalCase: `Button`
+- Component file in PascalCase: `Button.tsx`
+- Export types & interfaces inside Component file
+- Stories file in PascalCase + `*.stories.tsx` : `Button.stories.tsx`
 
-#### Modals
+```bash
+src
+  -- ComponentFolder
+    -- Component.tsx
+    -- Component.stories.tsx
+    -- index.ts
+```
+
+- Re-export the Component inside his own `index` file: `index.ts`
+- Export everything if Component has types & interfaces
+
+```jsx
+export { default as Component } from './Component';
+export * from './Component';
+```
 
-- Onboarding Modal to greet user and give him some useful informations about an application.
-- Publish Modal to publish a resource to the BPR application.
-- Resource Modal can be used to create or edit information about a resource
-- Share Modal allows a user to share one of his resource with specific roles to users
+### Component Guideline
 
-#### Multimedia
+- Always document basic guideline of Component with JSDoc format. Used by Storybook to generate documentation.
+
+```jsx
+/**
+ * Primary UI component for user interaction
+ */
+```
+
+### Interface description
+
+- Always document typescript types and interface with JSDoc syntax. Used by Storybook to generate documentation.
+
+```jsx
+// Interface description (e.g: TreeViewProps.tsx)
+export interface ButtonProps {
+  /**
+   * Is this the principal call to action on the page?
+   */
+  primary?: boolean;
+  /**
+   * What background color to use
+   */
+  backgroundColor?: string;
+  /**
+   * How large should the button be?
+   */
+  size?: "small" | "medium" | "large";
+  /**
+   * Button contents
+   */
+  label: string;
+  /**
+   * Optional click handler
+   */
+  onClick?: () => void;
+}
+```
+
+### Index file inside `src` folder
+
+- Entry point of this React Library.
+- Import your component inside `index.ts` file.
+
+```jsx
+export * from './Button';
+```
 
-All our multimedia components to use in applications or in modules.
+## Dev
 
-- Linker, AudioRecorder, VideoRecorder, Iframe, Embed component, ...
+You can build your component using `Storybook`. See [README](../../docs//README.md)

package/dist/common/PublishModal/PublishModal.d.ts

@@ -0,0 +1,9 @@
+import { ID } from 'edifice-ts-client';
+interface PublishModalProps {
+    isOpen: boolean;
+    resourceId: ID;
+    onSuccess: () => void;
+    onCancel: () => void;
+}
+export default function PublishModal({ isOpen, resourceId, onSuccess, onCancel, }: PublishModalProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/common/PublishModal/components/ToastSuccess.d.ts

@@ -0,0 +1,4 @@
+import { PublishResult } from 'edifice-ts-client';
+export declare function ToastSuccess({ result }: {
+    result: PublishResult;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/common/PublishModal/hooks/usePublishModal.d.ts

@@ -0,0 +1,38 @@
+import { IResource } from 'edifice-ts-client';
+import { SubmitHandler } from 'react-hook-form';
+interface ModalProps {
+    resource: IResource;
+    onSuccess?: () => void;
+}
+export interface FormDataProps {
+    title: string;
+    description: string;
+    activityType: string;
+    subjectArea: string;
+    language: string;
+    ageMin: string;
+    ageMax: string;
+    keyWords: string;
+}
+export default function usePublishModal({ onSuccess, resource }: ModalProps): {
+    control: import('react-hook-form').Control<FormDataProps, any>;
+    cover: string | File | Blob;
+    formState: {
+        errors: import('react-hook-form').FieldErrors<FormDataProps>;
+        isSubmitting: boolean;
+        isDirty: boolean;
+        isValid: boolean;
+    };
+    handleDeleteImage: () => void;
+    handlePublish: SubmitHandler<FormDataProps>;
+    handleSubmit: import('react-hook-form').UseFormHandleSubmit<FormDataProps, undefined>;
+    handleUploadImage: (file: File | string) => void;
+    register: import('react-hook-form').UseFormRegister<FormDataProps>;
+    selectActivities: (value: string | number) => void;
+    selectedActivities: (string | number)[];
+    selectedSubjectAreas: (string | number)[];
+    selectSubjects: (value: string | number) => void;
+    setValue: import('react-hook-form').UseFormSetValue<FormDataProps>;
+    watch: import('react-hook-form').UseFormWatch<FormDataProps>;
+};
+export {};

package/dist/common/ResourceModal/ResourceModal.d.ts

@@ -0,0 +1,30 @@
+import { ReactNode } from 'react';
+import { UseMutationResult } from '../../../node_modules/@tanstack/react-query';
+import { CreateParameters, CreateResult, ID, IFolder, UpdateParameters, UpdateResult } from 'edifice-ts-client';
+export interface FormInputs {
+    title: string;
+    description: string;
+    enablePublic: boolean;
+    formSlug: string;
+}
+interface BaseProps {
+    isOpen: boolean;
+    children?: ReactNode | ((...props: any) => ReactNode);
+    inputMaxLength?: number;
+    textareaMaxLength?: number;
+    onSuccess: () => void;
+    onCancel: () => void;
+}
+interface CreateProps extends BaseProps {
+    mode: 'create';
+    createResource?: UseMutationResult<CreateResult, Error, CreateParameters, unknown>;
+    currentFolder: Partial<IFolder>;
+}
+interface UpdateProps extends BaseProps {
+    mode: 'update';
+    updateResource?: UseMutationResult<UpdateResult, unknown, UpdateParameters, unknown>;
+    resourceId: ID;
+}
+type Props = CreateProps | UpdateProps;
+declare const ResourceModal: ({ isOpen, onCancel, onSuccess, children, inputMaxLength, textareaMaxLength, ...props }: Props) => import("react/jsx-runtime").JSX.Element;
+export default ResourceModal;

package/dist/common/ResourceModal/apps/BlogPublic.d.ts

@@ -0,0 +1,13 @@
+import { IResource } from 'edifice-ts-client';
+import { UseFormRegister, UseFormSetValue, UseFormWatch } from 'react-hook-form';
+import { FormInputs } from '../ResourceModal';
+interface BlogPublicProps {
+    appCode: string;
+    isUpdating: boolean;
+    resource: IResource;
+    watch: UseFormWatch<FormInputs>;
+    register: UseFormRegister<FormInputs>;
+    setValue: UseFormSetValue<FormInputs>;
+}
+declare const BlogPublic: ({ appCode, isUpdating, resource, watch, register, setValue, }: BlogPublicProps) => import("react/jsx-runtime").JSX.Element;
+export default BlogPublic;

package/dist/common/ResourceModal/hooks/useSlug.d.ts

@@ -0,0 +1,17 @@
+import { IResource } from 'edifice-ts-client';
+import { UseFormSetValue, UseFormWatch } from 'react-hook-form';
+import { FormInputs } from '../ResourceModal';
+interface UseSlugProps {
+    watch: UseFormWatch<FormInputs>;
+    setValue: UseFormSetValue<FormInputs>;
+    selectedResource?: IResource;
+}
+export declare const useSlug: ({ watch, setValue, selectedResource, }: UseSlugProps) => {
+    slug: string;
+    uniqueId: string;
+    isPublic: boolean;
+    resourceName: string;
+    onPublicChange: (value: boolean) => void;
+    onCopyToClipBoard: (pathname: string) => void;
+};
+export {};

package/dist/common/ResourceModal/hooks/useThumb.d.ts

@@ -0,0 +1,11 @@
+import { IResource } from 'edifice-ts-client';
+interface UseThumbProps {
+    isUpdating: boolean;
+    selectedResource?: IResource;
+}
+export declare const useThumb: ({ isUpdating, selectedResource }: UseThumbProps) => {
+    thumbnail: string | File | Blob;
+    handleDeleteImage: () => void;
+    handleUploadImage: (file: File | string) => void;
+};
+export {};

package/dist/common/ResourceModal/hooks/useUpdateMutation.d.ts

@@ -0,0 +1,7 @@
+import { UseMutationOptions, UseMutationResult } from '../../../../node_modules/@tanstack/react-query';
+import { UpdateParameters, UpdateResult } from 'edifice-ts-client';
+declare const useUpdateMutation: ({ application, options, }: {
+    application: string;
+    options?: UseMutationOptions<UpdateResult, Error, UpdateParameters, unknown> | undefined;
+}) => UseMutationResult<UpdateResult, Error, UpdateParameters>;
+export default useUpdateMutation;

package/dist/common/ResourceModal/index.d.ts

@@ -0,0 +1,3 @@
+export { default as ResourceModal } from './ResourceModal';
+export { default as useUpdateMutation } from './hooks/useUpdateMutation';
+export { default as BlogPublic } from './apps/BlogPublic';

package/dist/common/ShareModal/ShareBookmarkLine.d.ts

@@ -0,0 +1,9 @@
+import { ShareRight, ShareRightAction, ShareRightActionDisplayName, ShareRightWithVisibles } from 'edifice-ts-client';
+export declare const ShareBookmarkLine: ({ shareRights, showBookmark, toggleBookmark, shareRightActions, toggleRight, onDeleteRow, }: {
+    shareRights: ShareRightWithVisibles;
+    shareRightActions: ShareRightAction[];
+    showBookmark: boolean;
+    toggleRight: (shareRight: ShareRight, actionName: ShareRightActionDisplayName) => void;
+    toggleBookmark: () => void;
+    onDeleteRow: (shareRight: ShareRight) => void;
+}) => (false | import("react/jsx-runtime").JSX.Element)[];

package/dist/common/ShareModal/ShareModal.d.ts

@@ -0,0 +1,41 @@
+import { ReactNode } from 'react';
+import { UseMutationResult } from '../../../node_modules/@tanstack/react-query';
+import { ID, PutShareResponse, RightStringified, ShareRight } from 'edifice-ts-client';
+export type ShareOptions = {
+    resourceId: ID;
+    resourceRights: RightStringified[];
+    resourceCreatorId: string;
+};
+export type ShareResourceMutation = UseMutationResult<PutShareResponse, unknown, {
+    resourceId: string;
+    rights: ShareRight[];
+}, unknown>;
+interface ShareResourceModalProps {
+    /** Handle open/close state */
+    isOpen: boolean;
+    /**
+     * Expect resourceId,
+     * new rights array (replace shared array),
+     * creatorId
+     * of a resource */
+    shareOptions: ShareOptions;
+    /**
+     * Use the `shareResource` props when you need to do Optimistic UI
+     * otherwise ShareModal handles everything
+     * Must use React Query */
+    shareResource?: ShareResourceMutation;
+    /**
+     * To pass any specific app related component (e.g: Blog)
+     */
+    children?: ReactNode;
+    /**
+     * onSuccess callback when a resource is successfully shared
+     */
+    onSuccess: () => void;
+    /**
+     * onCancel handler to close ShareModal
+     */
+    onCancel: () => void;
+}
+export default function ShareResourceModal({ isOpen, shareOptions, shareResource, children, onSuccess, onCancel, }: ShareResourceModalProps): import('react').ReactPortal;
+export {};

package/dist/common/ShareModal/apps/ShareBlog.d.ts

@@ -0,0 +1,8 @@
+import { UseMutationResult } from '../../../../node_modules/@tanstack/react-query';
+import { ID, UpdateParameters, UpdateResult } from 'edifice-ts-client';
+export type PublicationType = 'RESTRAINT' | 'IMMEDIATE' | undefined;
+export interface ShareBlogProps {
+    resourceId: ID;
+    updateResource?: UseMutationResult<UpdateResult, unknown, UpdateParameters, unknown>;
+}
+export default function ShareBlog({ resourceId, updateResource, }: ShareBlogProps): import("react/jsx-runtime").JSX.Element;

package/dist/common/ShareModal/hooks/useSearch.d.ts

@@ -0,0 +1,24 @@
+import { ChangeEvent, Dispatch } from 'react';
+import { ShareRightWithVisibles, ShareSubject } from 'edifice-ts-client';
+import { OptionListItemType } from '../../../components';
+import { ShareOptions } from '../ShareModal';
+import { ShareAction } from './useShare';
+export declare const useSearch: ({ resourceId, resourceCreatorId, shareRights, shareDispatch, }: {
+    resourceId: ShareOptions['resourceCreatorId'];
+    resourceCreatorId: ShareOptions['resourceCreatorId'];
+    shareRights: ShareRightWithVisibles;
+    shareDispatch: Dispatch<ShareAction>;
+}) => {
+    state: {
+        searchInputValue: string;
+        searchResults: OptionListItemType[];
+        searchAPIResults: ShareSubject[];
+        isSearching: boolean;
+    };
+    showSearchAdmlHint: () => boolean;
+    showSearchLoading: () => boolean;
+    showSearchNoResults: () => boolean;
+    getSearchMinLength: () => number;
+    handleSearchInputChange: (event: ChangeEvent<HTMLInputElement>) => void;
+    handleSearchResultsChange: (model: Array<string | number>) => Promise<void>;
+};

package/dist/common/ShareModal/hooks/useShare.d.ts

@@ -0,0 +1,54 @@
+import { ShareRight, ShareRightAction, ShareRightActionDisplayName, ShareRightWithVisibles } from 'edifice-ts-client';
+import { ShareOptions, ShareResourceMutation } from '../ShareModal';
+interface UseShareResourceModalProps {
+    /**
+     * Resource ID (assetId)
+     */
+    resourceId: ShareOptions['resourceId'];
+    /**
+     * Resource Rights (based on the new rights array)
+     */
+    resourceRights: ShareOptions['resourceRights'];
+    /**
+     * Resource Creator Id: Id of the user who created the resource
+     */
+    resourceCreatorId: ShareOptions['resourceCreatorId'];
+    shareResource?: ShareResourceMutation;
+    onSuccess: () => void;
+    setIsLoading: (value: boolean) => void;
+}
+type State = {
+    isSharing: boolean;
+    shareRights: ShareRightWithVisibles;
+    shareRightActions: ShareRightAction[];
+};
+export type ShareAction = {
+    type: 'init';
+    payload: Partial<State>;
+} | {
+    type: 'updateShareRights';
+    payload: ShareRightWithVisibles;
+} | {
+    type: 'toggleRight';
+    payload: ShareRightWithVisibles;
+} | {
+    type: 'deleteRow';
+    payload: ShareRightWithVisibles;
+} | {
+    type: 'isSharing';
+    payload: boolean;
+};
+export default function useShare({ resourceId, resourceRights, resourceCreatorId, shareResource, setIsLoading, onSuccess, }: UseShareResourceModalProps): {
+    state: {
+        isSharing: boolean;
+        shareRights: ShareRightWithVisibles;
+        shareRightActions: ShareRightAction[];
+    };
+    dispatch: import('react').Dispatch<ShareAction>;
+    currentIsAuthor: () => boolean;
+    myAvatar: string;
+    handleDeleteRow: (shareRight: ShareRight) => void;
+    handleShare: () => Promise<void>;
+    toggleRight: (shareRight: ShareRight, actionName: ShareRightActionDisplayName) => void;
+};
+export {};

package/dist/common/ShareModal/hooks/useShareBookmark.d.ts

@@ -0,0 +1,23 @@
+import { Dispatch } from 'react';
+import { ShareRightWithVisibles } from 'edifice-ts-client';
+import { ShareAction } from './useShare';
+interface UseShareBookmarkProps {
+    shareRights: ShareRightWithVisibles;
+    shareDispatch: Dispatch<ShareAction>;
+}
+export type BookmarkProps = {
+    name: string;
+    id: string;
+};
+export declare const useShareBookmark: ({ shareRights, shareDispatch, }: UseShareBookmarkProps) => {
+    refBookmark: import('react').RefObject<HTMLInputElement>;
+    showBookmark: boolean;
+    showBookmarkInput: boolean;
+    bookmark: BookmarkProps;
+    handleBookmarkChange: () => void;
+    setBookmark: Dispatch<import('react').SetStateAction<BookmarkProps>>;
+    handleOnSave: () => void;
+    toggleBookmark: () => void;
+    toggleBookmarkInput: Dispatch<import('react').SetStateAction<boolean>>;
+};
+export {};

package/dist/common/ShareModal/hooks/useShareMutation.d.ts

@@ -0,0 +1,13 @@
+import { UseMutationOptions, UseMutationResult } from '../../../../node_modules/@tanstack/react-query';
+import { PutShareResponse, ShareRight } from 'edifice-ts-client';
+declare const useShareMutation: ({ application, options, }: {
+    application: string;
+    options?: UseMutationOptions<PutShareResponse, Error, {
+        resourceId: string;
+        rights: ShareRight[];
+    }, unknown> | undefined;
+}) => UseMutationResult<PutShareResponse, Error, {
+    resourceId: string;
+    rights: ShareRight[];
+}>;
+export default useShareMutation;

package/dist/common/ShareModal/index.d.ts

@@ -0,0 +1,3 @@
+export { default as ShareModal } from './ShareModal';
+export { default as ShareBlog } from './apps/ShareBlog';
+export { default as useShareMutation } from './hooks/useShareMutation';

package/dist/common/ShareModal/utils/hasRight.d.ts

@@ -0,0 +1,2 @@
+import { ShareRight, ShareRightAction } from 'edifice-ts-client';
+export declare const hasRight: (shareRight: ShareRight, shareAction: ShareRightAction) => boolean;

package/dist/common/ShareModal/utils/showShareRightLine.d.ts

@@ -0,0 +1,2 @@
+import { ShareRight } from 'edifice-ts-client';
+export declare const showShareRightLine: (shareRight: ShareRight, showBookmarkMembers: boolean) => boolean;

package/dist/components/ActionBar/ActionBar.d.ts

@@ -6,5 +6,5 @@ export interface ActionBarProps {
     children: React.ReactNode;
 }
 export type ActionBarType = React.FC<ActionBarProps>;
-export declare const ActionBar: import('react').ForwardRefExoticComponent<ActionBarProps & import('react').RefAttributes<HTMLDivElement>>;
+declare const ActionBar: import('react').ForwardRefExoticComponent<ActionBarProps & import('react').RefAttributes<HTMLDivElement>>;
 export default ActionBar;

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

@@ -1 +1,2 @@
+export { default as ActionBar } from './ActionBar';
 export * from './ActionBar';

package/dist/components/Alert/Alert.d.ts

@@ -56,5 +56,5 @@ export interface AlertProps extends ComponentPropsWithRef<'div'> {
      */
     className?: string;
 }
-export declare const Alert: import('react').ForwardRefExoticComponent<Omit<AlertProps, "ref"> & import('react').RefAttributes<AlertRef>>;
+declare const Alert: import('react').ForwardRefExoticComponent<Omit<AlertProps, "ref"> & import('react').RefAttributes<AlertRef>>;
 export default Alert;

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

@@ -1 +1,2 @@
+export { default as Alert } from './Alert';
 export * from './Alert';

package/dist/components/AppHeader/AppHeader.d.ts

@@ -13,5 +13,5 @@ export interface AppHeaderProps extends ComponentPropsWithRef<'div'> {
      */
     isFullscreen?: boolean;
 }
-export declare const AppHeader: import('react').ForwardRefExoticComponent<Omit<AppHeaderProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
+declare const AppHeader: import('react').ForwardRefExoticComponent<Omit<AppHeaderProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
 export default AppHeader;

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

@@ -1 +1,2 @@
+export { default as AppHeader } from './AppHeader';
 export * from './AppHeader';

package/dist/components/AppIcon/AppIcon.d.ts

@@ -1,4 +1,4 @@
-import { IWebApp } from '@edifice.io/ts-client';
+import { IWebApp } from 'edifice-ts-client';
 export type AppIconSize = '24' | '32' | '40' | '48' | '80' | '160';
 export interface AppIconBaseProps {
     /**

package/dist/components/Attachment/Attachment.d.ts

@@ -10,5 +10,5 @@ export interface AttachmentProps extends ComponentPropsWithRef<'div'> {
     options: ReactNode | undefined;
 }
 export type AttachmentType = AttachmentProps;
-export declare const Attachment: import('react').ForwardRefExoticComponent<Omit<AttachmentProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
+declare const Attachment: import('react').ForwardRefExoticComponent<Omit<AttachmentProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
 export default Attachment;

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

@@ -1 +1,2 @@
+export { default as Attachment } from './Attachment';
 export * from './Attachment';

package/dist/components/Audience/ReactionChoice.d.ts

@@ -0,0 +1,11 @@
+import { ReactionSummaryData, ReactionType } from 'edifice-ts-client';
+export interface ReactionChoiceProps {
+    availableReactions: ReactionType[];
+    summary?: ReactionSummaryData;
+    onChange?: (chosenReaction?: ReactionType) => void;
+}
+declare const ReactionChoice: {
+    ({ availableReactions, summary, onChange, }: ReactionChoiceProps): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export default ReactionChoice;

package/dist/components/Audience/ReactionModal.Card.d.ts

@@ -0,0 +1,4 @@
+import { ReactionDetailsData } from 'edifice-ts-client';
+export declare function ReactionModalCard({ reaction, }: {
+    reaction: ReactionDetailsData['userReactions'][number];
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/Audience/ReactionModal.d.ts

@@ -0,0 +1,20 @@
+import { ReactionDetailsData } from 'edifice-ts-client';
+import { ReactionModalCard } from './ReactionModal.Card';
+export interface ReactionModalProps {
+    /** Id of resource. */
+    resourceId: string;
+    /** Number of results per page, defaults to 30. */
+    pageSize?: number;
+    /** Display modal ? */
+    isOpen: boolean;
+    /** Close button handler. */
+    onModalClose(): void;
+    /** Function for loading reactions to the resource. */
+    reactionDetailsLoader: (resourceId: string, page: number, size: number) => Promise<ReactionDetailsData | undefined>;
+}
+declare const ReactionModal: {
+    ({ resourceId, pageSize, reactionDetailsLoader: loadReactionDetails, onModalClose, ...restProps }: ReactionModalProps): import('react').ReactPortal;
+    displayName: string;
+    Card: typeof ReactionModalCard;
+};
+export default ReactionModal;

package/dist/components/Audience/ReactionSummary.d.ts

@@ -0,0 +1,10 @@
+import { ReactionSummaryData } from 'edifice-ts-client';
+export interface ReactionSummaryProps {
+    summary?: ReactionSummaryData;
+    onClick?: () => void;
+}
+declare const ReactionSummary: {
+    ({ summary, onClick, }: ReactionSummaryProps): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export default ReactionSummary;

package/dist/components/Audience/ViewsByProfileCard.d.ts

@@ -0,0 +1,9 @@
+import { ViewsDetailsProfile } from 'edifice-ts-client';
+export interface ViewsCardProps {
+    viewsByProfile: ViewsDetailsProfile;
+}
+declare const ViewsByProfileCard: {
+    ({ viewsByProfile }: ViewsCardProps): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export default ViewsByProfileCard;

package/dist/components/Audience/ViewsModal.d.ts

@@ -0,0 +1,11 @@
+import { ViewsDetails } from 'edifice-ts-client';
+export interface ViewsModalProps {
+    viewsDetails: ViewsDetails;
+    isOpen: boolean;
+    onModalClose: () => void;
+}
+declare const ViewsModal: {
+    ({ viewsDetails, isOpen, onModalClose, }: ViewsModalProps): import('react').ReactPortal;
+    displayName: string;
+};
+export default ViewsModal;

package/dist/components/Audience/hooks/useReactionIcons.d.ts

@@ -0,0 +1,5 @@
+import { ReactionType } from 'edifice-ts-client';
+export default function useReactionIcons(): {
+    getReactionIcon: (reactionType?: ReactionType | null, asCounter?: boolean) => import("react/jsx-runtime").JSX.Element;
+    getReactionLabel: (reactionType?: ReactionType | null) => "audience.reaction.thanks" | "audience.reaction.great" | "audience.reaction.congrats" | "audience.reaction.interesting" | "audience.reaction.default";
+};

package/dist/components/Audience/hooks/useReactions.d.ts

@@ -0,0 +1,15 @@
+import { ReactionType } from 'edifice-ts-client';
+/**
+ * This hook implements some logic and provides functions to easily call "audience" backend endpoints.
+ * @param module application code, e.g. "blog"
+ * @param resourceType type of resource, e.g. "post"
+ * @returns functions to easily call "audience" backend endpoints
+ */
+export default function useReactions(module: string, resourceType: string): {
+    availableReactions: ("REACTION_1" | "REACTION_2" | "REACTION_3" | "REACTION_4")[];
+    loadReactionDetails: (resourceId: string, page: number, size?: number) => Promise<import('edifice-ts-client').ReactionDetailsData | undefined>;
+    loadReactionSummaries: (resourceIds: string[]) => Promise<{
+        [resourceId: string]: import('edifice-ts-client').ReactionSummaryData | undefined;
+    }>;
+    applyReaction: (resourceId: string, newReaction: ReactionType, oldReaction: ReactionType | null) => Promise<"-" | "+" | "=">;
+};

package/dist/components/Audience/hooks/useViews.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This hook provides functions to easily call "audience" backend endpoints.
+ * @param module application code, e.g. "blog"
+ * @param resourceType type of resource, e.g. "post"
+ * @returns functions to easily call "audience" backend endpoints.
+ */
+export default function useViews(module: string, resourceType: string): {
+    getViewsCounter: (resourceIds: string[]) => Promise<import('edifice-ts-client').ViewsCounters>;
+    getViewsDetail: (resourceId: string) => Promise<import('edifice-ts-client').ViewsDetails | undefined>;
+    triggerView: (resourceId: string) => Promise<void>;
+};

package/dist/components/Avatar/Avatar.d.ts

@@ -28,5 +28,5 @@ export interface AvatarProps extends React.ComponentPropsWithRef<'img'> {
      */
     className?: string;
 }
-export declare const Avatar: import('react').ForwardRefExoticComponent<Omit<AvatarProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
+declare const Avatar: import('react').ForwardRefExoticComponent<Omit<AvatarProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
 export default Avatar;