@rebasepro/app 0.17.3 → 0.18.0

package/dist/hooks/data/delete.d.ts

@@ -1,4 +1,4 @@
-import { Entity, CollectionCallbacks, User } from "@rebasepro/types";
+import { Entity, User } from "@rebasepro/types";
 import { RebaseContext, AdminCollection } from "@rebasepro/cms-types";
 import { RebaseData } from "@rebasepro/types";
 /**
@@ -7,26 +7,35 @@ import { RebaseData } from "@rebasepro/types";
 export type DeleteEntityWithCallbacksProps<M extends Record<string, any>, USER extends User = User> = {
     entity: Entity<M>;
     collection?: AdminCollection<M>;
-    callbacks?: CollectionCallbacks<M, USER>;
     onDeleteSuccess?: (entity: Entity<M>) => void;
     onDeleteFailure?: (entity: Entity<M>, e: Error) => void;
 };
 /**
  * This function is in charge of deleting a entity.
- * It will run all the delete callbacks specified in the collection.
- * It is also possible to attach callbacks on save success or error, and callback
- * errors.
+ *
+ * It runs the collection's **`admin.browserCallbacks`** around the delete —
+ * `beforeDelete`, then `afterDelete`. Not `callbacks`: that block belongs to
+ * the server, which runs it inside the delete it serves, and its bodies are
+ * stripped from this bundle entirely.
+ *
+ * Which matters most for a collection on a `direct`/`custom` transport, where
+ * the panel talks to the store itself and no server sees the delete at all —
+ * before this ran them, such a collection had no delete callbacks anywhere.
+ * This function has been named `deleteEntityWithCallbacks` since it was written
+ * and did not run any; it even took a `callbacks` prop and ignored it.
+ *
+ * A `beforeDelete` that throws blocks the delete, exactly as the server's does:
+ * nothing is sent, and `onDeleteFailure` hears about it.
  *
  * @param data
  * @param entity
  * @param collection
- * @param callbacks
  * @param onDeleteSuccess
  * @param onDeleteFailure
  * @param context
  * @group Hooks and utilities
  */
-export declare function deleteEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ data, entity, collection, callbacks, onDeleteSuccess, onDeleteFailure, context }: DeleteEntityWithCallbacksProps<M> & {
+export declare function deleteEntityWithCallbacks<M extends Record<string, any>, USER extends User>({ data, entity, collection, onDeleteSuccess, onDeleteFailure, context }: DeleteEntityWithCallbacksProps<M> & {
     collection: AdminCollection<M>;
     data: RebaseData;
     context: RebaseContext<USER>;

package/dist/hooks/data/save.d.ts

@@ -16,14 +16,28 @@ export type SaveEntityWithCallbacksProps<M extends Record<string, unknown>> = {
 };
 /**
  * This function is in charge of saving a entity.
- * It will run all the save callbacks specified in the collection.
- * It is also possible to attach callbacks on save success or error, and callback
- * errors.
+ *
+ * It runs the collection's **`admin.browserCallbacks`** around the write —
+ * `beforeSave`, then `afterSave` or `afterSaveError`. Not `callbacks`: that
+ * block belongs to the server, which runs it inside the write it serves, and
+ * its bodies are stripped from this bundle entirely.
+ *
+ * Which matters most for a collection on a `direct`/`custom` transport, where
+ * the panel talks to the store itself and no server sees the write at all —
+ * before this ran them, such a collection had no write callbacks anywhere. This
+ * function has been named `saveEntityWithCallbacks` since it was written and
+ * did not run any.
+ *
+ * A `beforeSave` that throws blocks the write, exactly as the server's does:
+ * nothing is sent, and the error reaches `afterSaveError` and the caller.
+ *
+ * `afterSave`/`afterSaveError` below are the *caller's* UI callbacks — the
+ * form's "close the dialog", the table's "clear the editing state" — and are
+ * unrelated to the collection's. Both run: the collection's first.
  *
  * @param collection
  * @param path
  * @param entityId
- * @param callbacks
  * @param values
  * @param previousValues
  * @param status

package/dist/hooks/index.d.ts

@@ -29,6 +29,7 @@ export * from "./useBackendStorageSource.js";
 export * from "./usePermissions.js";
 export * from "./ApiConfigContext.js";
 export * from "./useTranslation.js";
+export * from "./useNavigationGroupLabel.js";
 export * from "./useRebaseClient.js";
 export * from "./useAnalyticsController.js";
 export * from "./useUserConfigurationPersistence.js";

package/dist/hooks/useAdminModeController.d.ts

@@ -1,13 +1,14 @@
 /**
- * Use this controller to change the admin mode (developer vs editor)
+ * Use this controller to change the admin mode: `"cms"` for editing data,
+ * `"studio"` for the developer tools.
  * @group Hooks and utilities
  */
 export interface AdminModeController {
-    mode: "cms" | "studio" | "settings";
-    setMode: (mode: "cms" | "studio" | "settings") => void;
+    mode: "cms" | "studio";
+    setMode: (mode: "cms" | "studio") => void;
 }
 /**
- * Hook to retrieve the current admin mode ("developer" | "editor"), and `setMode`
+ * Hook to retrieve the current admin mode (`"cms"` | `"studio"`), and `setMode`
  * to change it.
  *
  * Consider that in order to use this hook you need to have a parent

package/dist/hooks/useNavigationGroupLabel.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The display label for a navigation group.
+ *
+ * A group *name* is an identifier: `StudioHomePage` orders the built-in groups
+ * by comparing against `["Database", "Compute", …]`, `navigationGroupMappings`
+ * keys its icons off it, and `AppView.group` sorts views into one by string
+ * equality. Translating the name at the point it is declared therefore breaks
+ * the ordering and drops the icons in every locale but English — which is
+ * exactly what happened the first time the Studio tool list was translated.
+ *
+ * So the name stays English and the *label* is translated here, at the one
+ * place it is drawn. A group Rebase does not ship — anything an app declares
+ * itself — has no key and is rendered as written.
+ *
+ * @group Hooks and utilities
+ */
+export declare function useNavigationGroupLabel(): (group: string) => string;

package/dist/hooks/useStudioBridge.d.ts

@@ -7,8 +7,36 @@ export type { BreadcrumbEntry, BreadcrumbsController };
  * When the admin is present, a bridge provider injects real implementations.
  * When the admin is absent, noop defaults ensure Studio works standalone.
  */
+/**
+ * Editing a collection's source through the admin's plan/apply flow.
+ *
+ * Studio has its own writers — the RLS editor saves a policy, the collection
+ * editor saves a property — and until this existed they did not go to the same
+ * place. Saving a policy on a mapped table POSTed the rules straight to
+ * `/schema-editor/collection/save`: no plan, no dialog, no record of what SQL
+ * the change would produce, while the identical edit made two tabs away in the
+ * collection editor showed all three.
+ *
+ * `available` is false when there is no collection editor above this Studio —
+ * the hosted console against somebody else's container, or a panel that never
+ * enabled it — and the caller falls back to whatever it did before.
+ */
+export interface StudioSchemaEditing {
+    available: boolean;
+    /**
+     * Merge `patch` into the collection and take it through plan → confirm →
+     * apply: the same dialog `useLiveSchemaEditing` shows the collection
+     * editor.
+     *
+     * Resolves once the change has been applied, or written source-only if
+     * that is what was chosen. Rejects with `SchemaChangeCancelled` when the
+     * dialog was closed — which is not an error to report, it is an answer.
+     */
+    updateCollection: (collectionId: string, patch: Record<string, unknown>) => Promise<void>;
+}
 export interface StudioBridge {
     collectionRegistry: CollectionRegistryController;
+    schemaEditing: StudioSchemaEditing;
     sidePanelController: SidePanelController;
     urlController: UrlController;
     navigationState: NavigationStateController;
@@ -61,6 +89,11 @@ export declare function StudioBridgeProvider({ value, children }: {
     value: Partial<StudioBridge>;
     children: React.ReactNode;
 }): React.JSX.Element;
+/**
+ * Source editing through the admin's plan/apply dialog. `available` is false
+ * when no collection editor is mounted.
+ */
+export declare function useStudioSchemaEditing(): StudioSchemaEditing;
 /** Collection registry — returns noop if the admin is not present. */
 export declare function useStudioCollectionRegistry(): CollectionRegistryController;
 /** Side panel controller — returns noop if the admin is not present. */