@rebasepro/app 0.24.0 → 0.24.1-canary.g56af4a4

package/README.md

@@ -68,7 +68,7 @@ This package is **framework-agnostic** in the sense that it doesn't depend on an
 | `useDialogsController` | Programmatic dialog management |
 | `useSnackbarController` | Show snackbar notifications |
 | `useModeController` / `useBuildModeController` | Light/dark mode |
-| `useStorageSource` / `useBackendStorageSource` | Storage source from context |
+| `useStorageSource` | Storage source from context |
 | `useRebaseClient` | Access the `RebaseClient` instance |
 | `useLargeLayout` | Responsive layout breakpoint hook |
 | `useClipboard` | Copy-to-clipboard |

package/dist/components/common/useColumnsIds.d.ts

@@ -12,8 +12,8 @@ export declare function getSubcollectionColumnId(collection: AdminCollection<any
  * Every child view gets a 200px button column that opens its tab. For a relation
  * declared in `relations` that button is the relation's only presence in the
  * table. For one declared as a property it is the second: the property's own
- * column is already there, hydrated by the list fetch's `include: ["*"]`, showing
- * the child rows themselves — and carrying the *same heading*, because the tab
+ * column is already there, hydrated by the list fetch's `include`
+ * (`getRelationIncludeParams`), showing the child rows themselves — and carrying the *same heading*, because the tab
  * takes its name from the declaring property. Two columns called "Applications",
  * one of them a button, and nothing in the header to tell them apart.
  *

package/dist/components/common/useDataTableController.d.ts

@@ -2,6 +2,12 @@ import { Entity, FilterValues, User } from "@rebasepro/types";
 import { EntityTableController, AdminCollection } from "@rebasepro/cms-types";
 import { ScrollRestorationController } from "./useScrollRestoration.js";
 export declare const DEFAULT_PAGE_SIZE = 50;
+/**
+ * Rows held with `pagination: false` past which development builds warn. The
+ * docs promise every row, so they are all loaded; but tens of thousands of
+ * them sit in memory and re-render on every change, and nothing said so.
+ */
+export declare const UNPAGINATED_WARNING_ROWS = 10000;
 export type DataTableControllerProps<M extends Record<string, any> = any> = {
     /**
      * Full path where the data of this table is located
@@ -26,6 +32,14 @@ export type DataTableControllerProps<M extends Record<string, any> = any> = {
      * When set to true the filters and sort will be updated in the URL
      */
     updateUrl?: boolean;
+    /**
+     * Read rows at all. Defaults to `true`. `false` closes the subscription and
+     * reads nothing — for a view that keeps the controller for its search and
+     * filters but draws its rows some other way, like the board, whose columns
+     * each read their own. The rows already held stay until it is enabled
+     * again, which reads afresh.
+     */
+    enabled?: boolean;
 };
 /**
  * Use this hook to build a controller for the {@link DataCollectionTable}.
@@ -42,4 +56,4 @@ export type DataTableControllerProps<M extends Record<string, any> = any> = {
  * @param fixedFilterFromProps
  * @param updateUrl
  */
-export declare function useDataTableController<M extends Record<string, any> = any, USER extends User = User>({ path, collection, scrollRestoration, entitiesDisplayedFirst, lastDeleteTimestamp, fixedFilter: fixedFilterFromProps, updateUrl }: DataTableControllerProps<M>): EntityTableController<M>;
+export declare function useDataTableController<M extends Record<string, any> = any, USER extends User = User>({ path, collection, scrollRestoration, entitiesDisplayedFirst, lastDeleteTimestamp, fixedFilter: fixedFilterFromProps, updateUrl, enabled }: DataTableControllerProps<M>): EntityTableController<M>;

package/dist/components/common/useScrollRestoration.d.ts

@@ -1,4 +1,18 @@
 import { Entity, FilterValues } from "@rebasepro/types";
+/**
+ * Where a collection view was, and the rows to show when it comes back.
+ *
+ * `data` is the rows around what was on screen — a page either side, when the
+ * view reports what it draws — starting at row `dataOffset` (0 when absent:
+ * `data` then starts at the first row). It used to be every row the view held,
+ * which a table scrolled to 100,000 rows kept for the rest of the session and
+ * read again in full on the way back.
+ */
+export type CollectionScrollEntry = {
+    scrollOffset: number;
+    data: Entity<any>[];
+    dataOffset?: number;
+};
 /**
  * Forget every collection's scroll position and the rows kept with it.
  *
@@ -7,15 +21,10 @@ import { Entity, FilterValues } from "@rebasepro/types";
  */
 export declare function clearCollectionScrollCache(): void;
 export type ScrollRestorationController = {
-    getCollectionScroll: (path: string, filters?: FilterValues<any>) => {
-        scrollOffset: number;
-        data: Entity<any>[];
-    } | undefined;
-    updateCollectionScroll: (props: {
+    getCollectionScroll: (path: string, filters?: FilterValues<any>) => CollectionScrollEntry | undefined;
+    updateCollectionScroll: (props: CollectionScrollEntry & {
         path: string;
-        scrollOffset: number;
         filters?: FilterValues<any>;
-        data: Entity<any>[];
     }) => void;
 };
 export declare function useScrollRestoration(): ScrollRestorationController;

package/dist/contexts/StorageSourcesContext.d.ts

@@ -14,6 +14,12 @@ export interface StorageSourcesContextValue {
     registry: Record<string, StorageSourceDefinition>;
     /** Built {@link StorageSource} for direct sources, keyed by key. */
     sources: Record<string, StorageSource>;
+    /**
+     * A server-routed source for a key not (yet) in `sources` — requests carry
+     * `?storageId=<key>`, so the server serves it or refuses naming it, rather
+     * than the panel guessing the default. Absent without a client.
+     */
+    createSource?: (key: string) => StorageSource;
 }
 /** @internal */
 export declare const StorageSourcesContext: React.Context<StorageSourcesContextValue>;