@osdk/react-components 0.12.0 → 0.13.0

package/build/cjs/public/experimental/object-table.d.cts

@@ -128,20 +128,13 @@ type EditFieldComponent = keyof EditFieldPropsByType;
 /**
  * Configuration for an editable cell's field component.
  *
- * @example
- * ```ts
- * editFieldConfig: {
- *   fieldComponent: "DROPDOWN",
- *   fieldComponentProps: {
- *     items: ["Active", "Inactive", "Pending"],
- *   },
- * }
- * ```
+ * `getFieldComponentProps` is called with the row's object so the configuration
+ * can vary per row (e.g. dropdown items that depend on row state).
  */
-type EditFieldConfig = {
+type EditFieldConfig<TData = unknown> = {
     [K in EditFieldComponent]: {
         fieldComponent: K;
-        fieldComponentProps: EditFieldPropsByType[K];
+        getFieldComponentProps: (object: TData) => EditFieldPropsByType[K];
     };
 }[EditFieldComponent];
 
@@ -192,19 +185,23 @@ interface SharedColumnDefinition<Q extends ObjectOrInterfaceDefinition, RDPs ext
      */
     renderHeader?: () => React.ReactNode;
 }
-/**
- * Column definition for an editable column. Setting `editable: true`
- * unlocks `editFieldConfig` and `validateEdit`.
- */
 interface EditableColumnDefinition<Q extends ObjectOrInterfaceDefinition, RDPs extends Record<string, SimplePropertyDef> = Record<string, never>, FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<string, never>> extends SharedColumnDefinition<Q, RDPs, FunctionColumns> {
-    editable: true;
+    /**
+     * `editable` can be a boolean or a predicate that receives the row's object
+     * and returns whether the cell is editable
+     */
+    editable: true | ((object: Osdk.Instance<Q, "$allBaseProperties", PropertyKeys<Q>, RDPs>) => boolean);
     /**
      * Configuration for the cell editor component.
      *
      * When provided, the column uses the specified field component
      * (e.g. dropdown) instead of the default auto-detected text/number input.
+     *
+     * `getFieldComponentProps` receives the row's object and returns the props
+     * to pass to the field component, so editor configuration can depend on the
+     * current row.
      */
-    editFieldConfig?: EditFieldConfig;
+    editFieldConfig?: EditFieldConfig<Osdk.Instance<Q, "$allBaseProperties", PropertyKeys<Q>, RDPs>>;
     /**
      * Additional function to validate the cell value during edit.
      *
@@ -362,6 +359,16 @@ interface ObjectTableProps<Q extends ObjectOrInterfaceDefinition, RDPs extends R
      * @default "manual"
      */
     editMode?: "always" | "manual";
+    /**
+     * Whether to render the bottom edit footer that hosts the
+     * "Edit Table" / "Cancel" / "Submit Edits" buttons and the edit-state
+     * indicators (modification count, validation errors).
+     *
+     * @default true whenever the table has at least one column declared
+     * editable (i.e. any column with `editable: true` or `editable: (object) => boolean`).
+     * When `false`, the "Edit Table" and "Submit Edits" buttons will not be shown.
+     */
+    showEditFooter?: boolean;
     /**
      * The default order by clause to sort the objects in the table.
      * If provided without orderBy prop, the sorting is uncontrolled.
@@ -398,7 +405,7 @@ interface ObjectTableProps<Q extends ObjectOrInterfaceDefinition, RDPs extends R
      */
     onCellValueChanged?: (info: CellEditInfo<Osdk.Instance<Q, "$allBaseProperties", PropertyKeys<Q>, RDPs>, unknown>) => void;
     /**
-     * If provided, the button Submit Edits will be shown in the table
+     * If provided, the "Submit Edits" button will be shown in the edit footer.
      *
      * @param edits an array of edit info containing details about the edited cells
      * including the rowId, columnId, new and old values, and the row data before the edit
@@ -487,6 +494,11 @@ interface ObjectTableProps<Q extends ObjectOrInterfaceDefinition, RDPs extends R
      * @default 40
      */
     rowHeight?: number;
+    /**
+     * Returns extra HTML attributes (typically `data-*`) to apply to each
+     * row element. Use this to drive conditional row styling
+     */
+    getRowAttributes?: (object: Osdk.Instance<Q, "$allBaseProperties", PropertyKeys<Q>, RDPs>) => Record<string, string | undefined>;
     className?: string;
 }
 interface ObjectSetOptions<Q extends ObjectOrInterfaceDefinition> {
@@ -542,9 +554,9 @@ declare module "@tanstack/react-table" {
         columnName?: string;
         isAsyncColumn?: boolean;
         isVisible?: boolean;
-        editable?: boolean;
+        editable?: boolean | ((object: TData) => boolean);
         dataType?: string;
-        editFieldConfig?: EditFieldConfig;
+        editFieldConfig?: EditFieldConfig<TData>;
         validateEdit?: (value: unknown) => Promise<string | undefined>;
     }
     interface TableMeta<TData extends RowData = unknown> {
@@ -569,6 +581,13 @@ interface BaseTableProps<TData extends RowData> {
     error?: Error;
     headerMenuFeatureFlags?: HeaderMenuFeatureFlags;
     editableConfig?: EditableConfig<TData, unknown>;
+    getRowAttributes?: (object: TData) => Record<string, string | undefined>;
+    /**
+     * Whether to render the bottom edit footer. Defaults to `true`; the
+     * footer is only rendered when the table has at least one editable
+     * column (`hasEditableColumns`).
+     */
+    showEditFooter?: boolean;
 }
 declare function BaseTable<TData extends RowData>(props: BaseTableProps<TData>): ReactElement;
 

package/build/cjs/public/experimental/pdf-viewer.cjs

@@ -1,98 +1,98 @@
 'use strict';
 
-var chunkYBDS5WQP_cjs = require('../../chunk-YBDS5WQP.cjs');
-require('../../chunk-SZXVBDSA.cjs');
+var chunk7H6WXQ35_cjs = require('../../chunk-7H6WXQ35.cjs');
+require('../../chunk-6UDBHYSO.cjs');
 require('../../chunk-Q2W6GYRK.cjs');
 
 
 
 Object.defineProperty(exports, "BasePdfViewer", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.BasePdfViewer; }
+  get: function () { return chunk7H6WXQ35_cjs.BasePdfViewer; }
 });
 Object.defineProperty(exports, "PdfViewer", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewer; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewer; }
 });
 Object.defineProperty(exports, "PdfViewerAnnotationLayer", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerAnnotationLayer; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerAnnotationLayer; }
 });
 Object.defineProperty(exports, "PdfViewerContent", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerContent; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerContent; }
 });
 Object.defineProperty(exports, "PdfViewerOutlineSidebar", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerOutlineSidebar; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerOutlineSidebar; }
 });
 Object.defineProperty(exports, "PdfViewerProvider", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerProvider; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerProvider; }
 });
 Object.defineProperty(exports, "PdfViewerSearchBar", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerSearchBar; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerSearchBar; }
 });
 Object.defineProperty(exports, "PdfViewerSidebar", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerSidebar; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerSidebar; }
 });
 Object.defineProperty(exports, "PdfViewerToolbar", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerToolbar; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerToolbar; }
 });
 Object.defineProperty(exports, "usePdfAnnotationPortals", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfAnnotationPortals; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfAnnotationPortals; }
 });
 Object.defineProperty(exports, "usePdfAnnotationsByPage", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfAnnotationsByPage; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfAnnotationsByPage; }
 });
 Object.defineProperty(exports, "usePdfDocument", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfDocument; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfDocument; }
 });
 Object.defineProperty(exports, "usePdfFormFields", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfFormFields; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfFormFields; }
 });
 Object.defineProperty(exports, "usePdfHighlightMode", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfHighlightMode; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfHighlightMode; }
 });
 Object.defineProperty(exports, "usePdfOutline", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfOutline; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfOutline; }
 });
 Object.defineProperty(exports, "usePdfViewer", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewer; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewer; }
 });
 Object.defineProperty(exports, "usePdfViewerContext", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerContext; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerContext; }
 });
 Object.defineProperty(exports, "usePdfViewerCore", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerCore; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerCore; }
 });
 Object.defineProperty(exports, "usePdfViewerInstance", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerInstance; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerInstance; }
 });
 Object.defineProperty(exports, "usePdfViewerSearch", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerSearch; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerSearch; }
 });
 Object.defineProperty(exports, "usePdfViewerState", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerState; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerState; }
 });
 Object.defineProperty(exports, "usePdfViewerSync", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerSync; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerSync; }
 });
 //# sourceMappingURL=pdf-viewer.cjs.map
 //# sourceMappingURL=pdf-viewer.cjs.map

package/build/cjs/public/experimental.cjs

@@ -1,20 +1,22 @@
 'use strict';
 
 var chunkIDDBCC5C_cjs = require('../chunk-IDDBCC5C.cjs');
-var chunkBJDCC446_cjs = require('../chunk-BJDCC446.cjs');
-var chunkL5LPFCXT_cjs = require('../chunk-L5LPFCXT.cjs');
-require('../chunk-UCTQICPR.cjs');
+var chunkPTTCWNZZ_cjs = require('../chunk-PTTCWNZZ.cjs');
+var chunkW2IASYE4_cjs = require('../chunk-W2IASYE4.cjs');
+require('../chunk-X337DNCW.cjs');
 var chunk2LKVRPJY_cjs = require('../chunk-2LKVRPJY.cjs');
-var chunkYPXTSEE7_cjs = require('../chunk-YPXTSEE7.cjs');
+var chunkMLFMSZJQ_cjs = require('../chunk-MLFMSZJQ.cjs');
 require('../chunk-O5EUACSV.cjs');
-require('../chunk-T7I6O43T.cjs');
-require('../chunk-JLESWL47.cjs');
-require('../chunk-VVJFMOZI.cjs');
+require('../chunk-6SPXSFPI.cjs');
+require('../chunk-V7XWTJV7.cjs');
+require('../chunk-I3OSD6CF.cjs');
+require('../chunk-MD4KDE44.cjs');
 require('../chunk-OHKKNZZS.cjs');
-require('../chunk-SB2VTP67.cjs');
+require('../chunk-Z7VHLTKD.cjs');
+require('../chunk-MQYOHGPY.cjs');
 require('../chunk-7LXS66DW.cjs');
-var chunkYBDS5WQP_cjs = require('../chunk-YBDS5WQP.cjs');
-require('../chunk-SZXVBDSA.cjs');
+var chunk7H6WXQ35_cjs = require('../chunk-7H6WXQ35.cjs');
+require('../chunk-6UDBHYSO.cjs');
 require('../chunk-Q2W6GYRK.cjs');
 
 
@@ -25,27 +27,27 @@ Object.defineProperty(exports, "TiffRenderer", {
 });
 Object.defineProperty(exports, "ActionForm", {
   enumerable: true,
-  get: function () { return chunkBJDCC446_cjs.ActionForm; }
+  get: function () { return chunkPTTCWNZZ_cjs.ActionForm; }
 });
 Object.defineProperty(exports, "BaseForm", {
   enumerable: true,
-  get: function () { return chunkBJDCC446_cjs.BaseForm; }
+  get: function () { return chunkPTTCWNZZ_cjs.BaseForm; }
 });
 Object.defineProperty(exports, "BaseFilterList", {
   enumerable: true,
-  get: function () { return chunkL5LPFCXT_cjs.BaseFilterList; }
+  get: function () { return chunkW2IASYE4_cjs.BaseFilterList; }
 });
 Object.defineProperty(exports, "FilterList", {
   enumerable: true,
-  get: function () { return chunkL5LPFCXT_cjs.FilterList; }
+  get: function () { return chunkW2IASYE4_cjs.FilterList; }
 });
 Object.defineProperty(exports, "deserializeFilterStates", {
   enumerable: true,
-  get: function () { return chunkL5LPFCXT_cjs.deserializeFilterStates; }
+  get: function () { return chunkW2IASYE4_cjs.deserializeFilterStates; }
 });
 Object.defineProperty(exports, "serializeFilterStates", {
   enumerable: true,
-  get: function () { return chunkL5LPFCXT_cjs.serializeFilterStates; }
+  get: function () { return chunkW2IASYE4_cjs.serializeFilterStates; }
 });
 Object.defineProperty(exports, "MarkdownRenderer", {
   enumerable: true,
@@ -53,115 +55,115 @@ Object.defineProperty(exports, "MarkdownRenderer", {
 });
 Object.defineProperty(exports, "BaseTable", {
   enumerable: true,
-  get: function () { return chunkYPXTSEE7_cjs.BaseTable; }
+  get: function () { return chunkMLFMSZJQ_cjs.BaseTable; }
 });
 Object.defineProperty(exports, "ColumnConfigDialog", {
   enumerable: true,
-  get: function () { return chunkYPXTSEE7_cjs.ColumnConfigDialog; }
+  get: function () { return chunkMLFMSZJQ_cjs.ColumnConfigDialog; }
 });
 Object.defineProperty(exports, "LoadingCell", {
   enumerable: true,
-  get: function () { return chunkYPXTSEE7_cjs.LoadingCell; }
+  get: function () { return chunkMLFMSZJQ_cjs.LoadingCell; }
 });
 Object.defineProperty(exports, "LoadingCellContent", {
   enumerable: true,
-  get: function () { return chunkYPXTSEE7_cjs.LoadingCellContent; }
+  get: function () { return chunkMLFMSZJQ_cjs.LoadingCellContent; }
 });
 Object.defineProperty(exports, "MultiColumnSortDialog", {
   enumerable: true,
-  get: function () { return chunkYPXTSEE7_cjs.MultiColumnSortDialog; }
+  get: function () { return chunkMLFMSZJQ_cjs.MultiColumnSortDialog; }
 });
 Object.defineProperty(exports, "ObjectTable", {
   enumerable: true,
-  get: function () { return chunkYPXTSEE7_cjs.ObjectTable; }
+  get: function () { return chunkMLFMSZJQ_cjs.ObjectTable; }
 });
 Object.defineProperty(exports, "BasePdfViewer", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.BasePdfViewer; }
+  get: function () { return chunk7H6WXQ35_cjs.BasePdfViewer; }
 });
 Object.defineProperty(exports, "PdfViewer", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewer; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewer; }
 });
 Object.defineProperty(exports, "PdfViewerAnnotationLayer", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerAnnotationLayer; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerAnnotationLayer; }
 });
 Object.defineProperty(exports, "PdfViewerContent", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerContent; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerContent; }
 });
 Object.defineProperty(exports, "PdfViewerOutlineSidebar", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerOutlineSidebar; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerOutlineSidebar; }
 });
 Object.defineProperty(exports, "PdfViewerProvider", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerProvider; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerProvider; }
 });
 Object.defineProperty(exports, "PdfViewerSearchBar", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerSearchBar; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerSearchBar; }
 });
 Object.defineProperty(exports, "PdfViewerSidebar", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerSidebar; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerSidebar; }
 });
 Object.defineProperty(exports, "PdfViewerToolbar", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.PdfViewerToolbar; }
+  get: function () { return chunk7H6WXQ35_cjs.PdfViewerToolbar; }
 });
 Object.defineProperty(exports, "usePdfAnnotationPortals", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfAnnotationPortals; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfAnnotationPortals; }
 });
 Object.defineProperty(exports, "usePdfAnnotationsByPage", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfAnnotationsByPage; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfAnnotationsByPage; }
 });
 Object.defineProperty(exports, "usePdfDocument", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfDocument; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfDocument; }
 });
 Object.defineProperty(exports, "usePdfFormFields", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfFormFields; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfFormFields; }
 });
 Object.defineProperty(exports, "usePdfHighlightMode", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfHighlightMode; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfHighlightMode; }
 });
 Object.defineProperty(exports, "usePdfOutline", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfOutline; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfOutline; }
 });
 Object.defineProperty(exports, "usePdfViewer", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewer; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewer; }
 });
 Object.defineProperty(exports, "usePdfViewerContext", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerContext; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerContext; }
 });
 Object.defineProperty(exports, "usePdfViewerCore", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerCore; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerCore; }
 });
 Object.defineProperty(exports, "usePdfViewerInstance", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerInstance; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerInstance; }
 });
 Object.defineProperty(exports, "usePdfViewerSearch", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerSearch; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerSearch; }
 });
 Object.defineProperty(exports, "usePdfViewerState", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerState; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerState; }
 });
 Object.defineProperty(exports, "usePdfViewerSync", {
   enumerable: true,
-  get: function () { return chunkYBDS5WQP_cjs.usePdfViewerSync; }
+  get: function () { return chunk7H6WXQ35_cjs.usePdfViewerSync; }
 });
 //# sourceMappingURL=experimental.cjs.map
 //# sourceMappingURL=experimental.cjs.map