@simoncomputing/mui-bueno-v2 0.16.2 → 0.17.1

package/CHANGELOG.md

@@ -11,6 +11,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Minor increment --> singlular/minor changes. Minimal breaking changes.
 - Patch increment --> singlular/minor changes. Zero breaking changes.
 
+## [0.17.1] - 2025-09-TBD
+
+### Fixed
+
+- `CitationField`:
+    - fixed "empty" node lingering after citation has been deleted
+    - fixed bubble menu getting cut off when going to different pages on the citation paginated table
+
+### Changed
+
+- `CitationFieldProvider` - optimized to only fetch citation data from API on initial load to reduce excessive API calls. As a compromise, paginated fetches made by the citation table in the `CitationField` bubble menu will automatically update any outdated citations in the provider's local citation list.
+- `CitationMenu` - renamed `onContentUpdate` prop to `onContentChange`
+
+## [0.17.0] - 2025-09-11
+
+### Changed
+
+- `CitationField`:
+    - Renamed `fetchExistingCitations` to `getCitationsPaginated`
+    - Renamed menu button to "Insert Citation/Attachments" (formerly "Insert Citation")
+- `CitationFieldProvider`: Renamed `fetchExistingCitations` to `getCitations`
+
+### Fixed
+
+- `CitationField`: Fixed citation link not displaying initially for newly uploaded attachments.
+
 ## [0.16.2] - 2025-08-15
 
 ### Added

package/dist/@types/index.d.ts

@@ -164,7 +164,7 @@ export type CheckboxOption =
 
 /**
  * Used for CitationField
- * Represents a citation (web article/attachment/other url)
+ * Represents a citation (url or attachment)
  */
 export type Citation = {
     id: number;
@@ -172,9 +172,13 @@ export type Citation = {
     updatedBy?: number;
     deletedBy?: number;
 
+    title: string;
+
+    // for attachments
     fileName?: string;
+
+    // for urls
     url?: string;
-    title: string;
     source?: string; // publisher
     accessedAt?: string | null;
     classification?: string; // public, unclassified
@@ -186,12 +190,9 @@ export type Citation = {
  */
 export type UnsavedCitation = {
     id?: number;
+    type: 'Url' | 'Attachment';
+    file?: File;
 } & Omit<Citation, 'id'>;
 
-/**
- * Used for CitationField
- * Used to represent a (potentially) unsaved Attachment (same as UnsavedCitation but with a File obj)
- */
-export type UnsavedAttachment = {
-    file?: File;
-} & UnsavedCitation;
+type UnsavedUrlCitation = Omit<UnsavedCitation, 'type'> & { type: 'Url' };
+type UnsavedAttachmentCitation = Omit<UnsavedCitation, 'type'> & { type: 'Attachment' };

package/dist/components/Form/Inputs/CitationField/CitationField.d.ts

@@ -1,4 +1,4 @@
-import { Citation, PageState, PageResponse, UnsavedCitation, UnsavedAttachment } from '../../../../@types';
+import { Citation, PageState, PageResponse, UnsavedCitation } from '../../../../@types';
 export type CitationFieldProps = {
     /**
      * Name and ID of the component. Must match a key from initialValues in Formik.
@@ -42,13 +42,13 @@ export type CitationFieldProps = {
      *
      * Error handling is supported internally.
      */
-    fetchExistingCitations: (req: PageState) => Promise<PageResponse<Citation>>;
+    getCitationsPaginated: (req: PageState) => Promise<PageResponse<Citation>>;
     /**
      * API call for creating a new citation/attachment.
      *
      * Error handling is supported internally.
      */
-    onCreateCitation: (citation: UnsavedCitation) => Promise<Citation>;
+    onCreateCitation: (unsavedCitation: UnsavedCitation) => Promise<Citation>;
     /**
      * API call for updating a citation/attachment.
      *
@@ -67,12 +67,6 @@ export type CitationFieldProps = {
      * Error handling is supported internally.
      */
     getCitationById: (id: number) => Promise<Citation>;
-    /**
-     * API call for storing an attachment (ex. in an s3 bucket)
-     *
-     * Error handling is supported internally.
-     */
-    onStoreAttachment: (citation: UnsavedAttachment) => Promise<Citation>;
     /**
      * Error callback.
      *
@@ -84,9 +78,11 @@ export type CitationFieldProps = {
 /**
  * Rich Text field -- uses MUI Tip Tap
  *
- * Formik -- This field cannot be completely controlled, so keep in mind that the Formik value will not update until the field
- * __loses focus__. This is to prevent issues with converting from rich text to HTML as the user types as it could override
- * their changes unintentionally.
+ * IMPORTANT: As per Mui TipTap's documentation, it's not efficient to use it as a fully controlled component since the
+ * editor content has to be serialized to HTML (which is what is stored in Formik). Therefore, keep in mind that what is
+ * shown in the editor will not match the Formik value until the field __loses focus__.
+ *
+ * Recommended to use with `CitationFieldProvider` for cross-field synchronization.
  */
 export declare const CitationField: (props: CitationFieldProps) => import("react/jsx-runtime").JSX.Element;
 export default CitationField;

package/dist/components/Form/Inputs/CitationField/CitationFieldContext/CitationFieldContext.d.ts

@@ -1,9 +1,10 @@
 import { Citation } from '../../../../../@types';
 interface SyncContextType {
     citations: Citation[];
-    resync: () => void;
+    isLoaded: boolean;
     addUpdateCitation: (citation: Citation) => void;
     deleteCitation: (id: number) => void;
+    batchUpdate: (newCitations: Citation[]) => void;
 }
 export declare const SyncContext: import('react').Context<SyncContextType | undefined>;
 export declare const useCitationSync: () => SyncContextType;

package/dist/components/Form/Inputs/CitationField/CitationFieldContext/CitationFieldProvider.d.ts

@@ -2,7 +2,16 @@ import { default as React } from 'react';
 import { Citation } from '../../../../../@types';
 type CitationFieldProviderProps = {
     children: React.ReactNode;
-    fetchExistingCitations: () => Promise<Citation[]>;
+    getCitations: () => Promise<Citation[]>;
 };
+/**
+ * CitationFieldProvider ensures `CitationField` stays in sync with other `CitationField` components. Always
+ * use when multiple `CitationField` components are on the same page.
+ *
+ * NOTE: The provider is optimized to reduce excessive API calls. Currently, it will only perform the inital full
+ *       data fetch on initial load. Subsequent changes are updated locally based on what add/update/delete actions
+ *       are made by the user, but any remote additions/updates/deletions will not be fetched. Keep this in mind when
+ *       deciding what level to place the provider in your app so that you can control how often the provider is initialized.
+ */
 export declare const CitationFieldProvider: React.FC<CitationFieldProviderProps>;
 export {};

package/dist/components/Form/Inputs/CitationField/CitationMenu/AttachmentForm.d.ts

@@ -1,8 +1,8 @@
-import { Citation, UnsavedAttachment } from '../../../../../@types';
+import { Citation, UnsavedAttachmentCitation } from '../../../../../@types';
 import { CitationMenuError } from './CitationMenu';
 export type NewAttachmentFormProps = {
     id?: number;
-    onSave: (citation: UnsavedAttachment) => Promise<void>;
+    onSave: (unsavedAttachment: UnsavedAttachmentCitation) => Promise<void>;
     onCancel: () => void;
     getCitationById: (id: number) => Promise<Citation>;
     disableFileUpload?: boolean;

package/dist/components/Form/Inputs/CitationField/CitationMenu/CitationBubbleMenu.d.ts

@@ -24,4 +24,4 @@ export type CitationBubbleMenuProps = Partial<Except<ControlledBubbleMenuProps,
  * update, which will happen if it's a child of the component using
  * `useEditor`).
  */
-export default function CitationBubbleMenuTipTap({ fetchExistingCitations, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, onStoreAttachment, ...controlledBubbleMenuProps }: CitationBubbleMenuProps): import("react/jsx-runtime").JSX.Element | null;
+export default function CitationBubbleMenuTipTap({ getCitationsPaginated, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, ...controlledBubbleMenuProps }: CitationBubbleMenuProps): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/Form/Inputs/CitationField/CitationMenu/CitationForm.d.ts

@@ -1,8 +1,8 @@
-import { Citation, UnsavedCitation } from '../../../../../@types';
+import { Citation, UnsavedUrlCitation } from '../../../../../@types';
 import { CitationMenuError } from './CitationMenu';
 export type CitationFormProps = {
     id?: number;
-    onSave: (citation: UnsavedCitation) => Promise<void>;
+    onSave: (unsavedUrl: UnsavedUrlCitation) => Promise<void>;
     onCancel: () => void;
     getCitationById: (id: number) => Promise<Citation>;
     setError: React.Dispatch<React.SetStateAction<CitationMenuError | undefined>>;

package/dist/components/Form/Inputs/CitationField/CitationMenu/CitationMenu.d.ts

@@ -1,9 +1,9 @@
-import { Citation, PageState, PageResponse, UnsavedCitation, UnsavedAttachment } from '../../../../../@types';
+import { Citation, PageState, PageResponse, UnsavedCitation } from '../../../../../@types';
 export interface CitationMenuProps {
     /**
      * API call for fetching citations. These will populate the "Insert Citation/Attachment(s)" table.
      */
-    fetchExistingCitations: (req: PageState) => Promise<PageResponse<Citation>>;
+    getCitationsPaginated: (req: PageState) => Promise<PageResponse<Citation>>;
     /**
      * API call for creating a new citation/attachment.
      */
@@ -20,10 +20,6 @@ export interface CitationMenuProps {
      * API call for retrieving a citation by id
      */
     getCitationById: (id: number) => Promise<Citation>;
-    /**
-     * API call for storing an attachment (ex. in an s3 bucket)
-     */
-    onStoreAttachment: (citation: UnsavedAttachment) => Promise<Citation>;
     /**
      * Set which citations should be pre-checked in the citations table when this component is first rendered (used
      * to initialize useState).
@@ -44,7 +40,7 @@ export interface CitationMenuProps {
      *
      * Currently, this will be called when the data in the citations table changes, and when the content itself changes (ex. clicks on "Add Citation")
      */
-    onContentUpdate?: () => void;
+    onContentChange?: () => void;
     /**
      * Error callback.
      *
@@ -74,5 +70,5 @@ export declare enum CitationMenuState {
  *
  * Intended to be used within a bubble/pop-up/modal/dialog. For in-line citations, see CitationField instead.
  */
-export declare function CitationMenu({ fetchExistingCitations, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, onStoreAttachment, onSelectCitations, onCancel, initialSelectedIds, onContentUpdate, onError, }: CitationMenuProps): import("react/jsx-runtime").JSX.Element;
+export declare function CitationMenu({ getCitationsPaginated, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, onSelectCitations, onCancel, initialSelectedIds, onContentChange, onError, }: CitationMenuProps): import("react/jsx-runtime").JSX.Element;
 export default CitationMenu;

package/dist/components/Form/Inputs/CitationField/CitationMenu/CitationTable.d.ts

@@ -8,7 +8,7 @@ export type CitationTableProps = {
     onEditAttachment: (citation: Citation) => void;
     onDeleteCitation: (id: number) => Promise<void>;
     onSelect: (selectedIds: number[]) => void;
-    fetchExistingCitations: (req: PageState) => Promise<PageResponse<Citation>>;
+    getCitationsPaginated: (req: PageState) => Promise<PageResponse<Citation>>;
     selectedIds: number[];
     setSelectedIds: React.Dispatch<React.SetStateAction<number[]>>;
     /**
@@ -19,6 +19,7 @@ export type CitationTableProps = {
      */
     onError?: (err: string) => void;
     setError: React.Dispatch<React.SetStateAction<CitationMenuError | undefined>>;
+    setSuccess: React.Dispatch<React.SetStateAction<string | undefined>>;
 };
 declare const CitationTable: (props: CitationTableProps) => import("react/jsx-runtime").JSX.Element;
 export default CitationTable;