@simoncomputing/mui-bueno-v2 0.17.4 → 0.17.5

package/CHANGELOG.md

@@ -11,6 +11,13 @@ 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.5] - 2025-09-22
+
+### Added
+
+- `CitationMenu`:
+    - added `renderAsSelectablePopup` prop
+
 ## [0.17.4] - 2025-09-16
 
 ### Changed

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

@@ -78,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

@@ -4,5 +4,14 @@ type CitationFieldProviderProps = {
     children: React.ReactNode;
     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

@@ -2,6 +2,7 @@ import { Citation, UnsavedAttachmentCitation } from '../../../../../@types';
 import { CitationMenuError } from './CitationMenu';
 export type NewAttachmentFormProps = {
     id?: number;
+    title?: string;
     onSave: (unsavedAttachment: UnsavedAttachmentCitation) => Promise<void>;
     onCancel: () => void;
     getCitationById: (id: number) => Promise<Citation>;

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

@@ -0,0 +1,17 @@
+type Props = {
+    error?: CitationMenuError;
+    setError: React.Dispatch<React.SetStateAction<CitationMenuError | undefined>>;
+    success?: string;
+    setSuccess: React.Dispatch<React.SetStateAction<string | undefined>>;
+};
+/**
+ * Error for CitationMenu
+ *   title = human-friendly/shortened version of the error (ex. "Failed to create citation")
+ *   err = the actual error thrown by the exception that was caught
+ */
+export type CitationMenuError = {
+    title: string;
+    err: string;
+};
+declare const CitationAlert: (props: Props) => import("react/jsx-runtime").JSX.Element;
+export default CitationAlert;

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

@@ -2,6 +2,7 @@ import { Citation, UnsavedUrlCitation } from '../../../../../@types';
 import { CitationMenuError } from './CitationMenu';
 export type CitationFormProps = {
     id?: number;
+    title?: string;
     onSave: (unsavedUrl: UnsavedUrlCitation) => Promise<void>;
     onCancel: () => void;
     getCitationById: (id: number) => Promise<Citation>;

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

@@ -40,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.
      *
@@ -48,6 +48,11 @@ export interface CitationMenuProps {
      * help debug issues so developers can see specific details about an error.
      */
     onError?: (err: string) => void;
+    /**
+     * When true, the table will be rendered for pop-ups with the ability to select citations from the table.
+     * When false, teh table will be rendered as a basic paginated table with all columns displayed.
+     */
+    renderAsSelectablePopup?: boolean;
 }
 /**
  * Error for CitationMenu
@@ -70,5 +75,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({ getCitationsPaginated, onCreateCitation, onUpdateCitation, onDeleteCitation, getCitationById, 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, renderAsSelectablePopup, }: CitationMenuProps): import("react/jsx-runtime").JSX.Element;
 export default CitationMenu;

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

@@ -1,6 +1,7 @@
 import { PageState, PageResponse, Citation } from '../../../../../@types';
 import { CitationMenuError } from './CitationMenu';
 export type CitationTableProps = {
+    title: string;
     onCancel: () => void;
     onNewCitation: () => void;
     onNewAttachment: () => void;
@@ -19,6 +20,19 @@ export type CitationTableProps = {
      */
     onError?: (err: string) => void;
     setError: React.Dispatch<React.SetStateAction<CitationMenuError | undefined>>;
+    setSuccess: React.Dispatch<React.SetStateAction<string | undefined>>;
+    /**
+     * When true, the Source, Accessed At & Classification columns will not be displayed
+     * to preserve horizontal space.
+     */
+    condenseTable?: boolean;
+    /**
+     * When true, first column will be checkboxes, allowing users to select citations.
+     *
+     * Select/Cancel buttons will appear at the bottom of the component.
+     * NOTE: add buttons will move to the bottom of the component, inline with the Select/Cancel buttons.
+     */
+    canSelect?: boolean;
 };
 declare const CitationTable: (props: CitationTableProps) => import("react/jsx-runtime").JSX.Element;
 export default CitationTable;