@fuzdev/fuz_app 0.51.0 → 0.52.0

package/dist/ui/position_helpers.d.ts

@@ -22,6 +22,7 @@ export type Alignment = 'start' | 'center' | 'end';
  * @param align - alignment along the position edge ('start', 'center', 'end')
  * @param offset - distance from the position (CSS value)
  * @returns CSS styles as a Record
+ * @throws UnreachableError if `position` is not a known `Position` value
  */
 export declare const generate_position_styles: (position?: Position, align?: Alignment, offset?: string) => Record<string, string>;
 //# sourceMappingURL=position_helpers.d.ts.map

package/dist/ui/position_helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"position_helpers.d.ts","sourceRoot":"../src/lib/","sources":["../../src/lib/ui/position_helpers.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,gBAAgB,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEnD;;;;;;;GAOG;AACH,eAAO,MAAM,wBAAwB,GACpC,WAAU,QAAmB,EAC7B,QAAO,SAAoB,EAC3B,eAAY,KACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAiEvB,CAAC"}
+{"version":3,"file":"position_helpers.d.ts","sourceRoot":"../src/lib/","sources":["../../src/lib/ui/position_helpers.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,gBAAgB,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEnD;;;;;;;;GAQG;AACH,eAAO,MAAM,wBAAwB,GACpC,WAAU,QAAmB,EAC7B,QAAO,SAAoB,EAC3B,eAAY,KACV,MAAM,CAAC,MAAM,EAAE,MAAM,CAiEvB,CAAC"}

package/dist/ui/position_helpers.js

@@ -11,6 +11,7 @@ import { UnreachableError } from '@fuzdev/fuz_util/error.js';
  * @param align - alignment along the position edge ('start', 'center', 'end')
  * @param offset - distance from the position (CSS value)
  * @returns CSS styles as a Record
+ * @throws UnreachableError if `position` is not a known `Position` value
  */
 export const generate_position_styles = (position = 'center', align = 'center', offset = '0') => {
     const styles = {

package/dist/ui/sidebar_state.svelte.d.ts

@@ -1,16 +1,26 @@
+/**
+ * Reactive sidebar visibility state. Provisioned by `AppShell.svelte` via
+ * `sidebar_state_context`; consumers read `show_sidebar` and call
+ * `toggle_sidebar` / `activate`.
+ *
+ * @module
+ */
+/**
+ * Svelte context carrying a reactive `SidebarState` accessor. Set by
+ * `AppShell.svelte` (creates a fresh `SidebarState` if not supplied);
+ * consumers call `sidebar_state_context.get()` to read or toggle visibility.
+ */
 export declare const sidebar_state_context: {
     get: (error_message?: string) => () => SidebarState;
     get_maybe: () => (() => SidebarState) | undefined;
     set: (value: () => SidebarState) => () => SidebarState;
 };
-/**
- * Options for configuring a `SidebarState`.
- *
- * @param enabled Optional reactive getter that controls whether the sidebar is enabled.
- *                When provided, overrides the internal `enabled` state.
- *                `show_sidebar` automatically returns `false` when `enabled` is `false`.
- */
 export interface SidebarStateOptions {
+    /**
+     * Reactive getter that controls whether the sidebar is enabled. When
+     * supplied, overrides the internal `enabled` state — `show_sidebar`
+     * auto-returns `false` while the getter returns `false`.
+     */
     enabled?: () => boolean;
 }
 export declare class SidebarState {
@@ -22,8 +32,11 @@ export declare class SidebarState {
     constructor(options?: SidebarStateOptions);
     toggle_sidebar(value?: boolean): void;
     /**
-     * Activates the sidebar, showing it and enabling the toggle.
-     * Returns a cleanup function that deactivates.
+     * Show the sidebar and enable the toggle. The returned disposer hides
+     * and disables on cleanup — pair with `$effect` for scoped activation.
+     *
+     * @returns cleanup function that deactivates and hides the sidebar
+     * @mutates `this`
      */
     activate(): () => void;
 }

package/dist/ui/sidebar_state.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sidebar_state.svelte.d.ts","sourceRoot":"../src/lib/","sources":["../../src/lib/ui/sidebar_state.svelte.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,qBAAqB;2CAAwB,YAAY;4BAAZ,YAAY;uBAAZ,YAAY,WAAZ,YAAY;CAAG,CAAC;AAE1E;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IACnC,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;CACxB;AAED,qBAAa,YAAY;;IAKxB,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,YAAY,IAAI,OAAO,CAG1B;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,EAE9B;gBAEW,OAAO,CAAC,EAAE,mBAAmB;IAIzC,cAAc,CAAC,KAAK,GAAE,OAA4B,GAAG,IAAI;IAIzD;;;OAGG;IACH,QAAQ,IAAI,MAAM,IAAI;CAQtB"}
+{"version":3,"file":"sidebar_state.svelte.d.ts","sourceRoot":"../src/lib/","sources":["../../src/lib/ui/sidebar_state.svelte.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;2CAAwB,YAAY;4BAAZ,YAAY;uBAAZ,YAAY,WAAZ,YAAY;CAAG,CAAC;AAE1E,MAAM,WAAW,mBAAmB;IACnC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,OAAO,CAAC;CACxB;AAED,qBAAa,YAAY;;IAKxB,IAAI,OAAO,IAAI,OAAO,CAErB;IAED,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAEzB;IAED,IAAI,YAAY,IAAI,OAAO,CAG1B;IAED,IAAI,YAAY,CAAC,KAAK,EAAE,OAAO,EAE9B;gBAEW,OAAO,CAAC,EAAE,mBAAmB;IAIzC,cAAc,CAAC,KAAK,GAAE,OAA4B,GAAG,IAAI;IAIzD;;;;;;OAMG;IACH,QAAQ,IAAI,MAAM,IAAI;CAQtB"}

package/dist/ui/sidebar_state.svelte.js

@@ -1,4 +1,16 @@
+/**
+ * Reactive sidebar visibility state. Provisioned by `AppShell.svelte` via
+ * `sidebar_state_context`; consumers read `show_sidebar` and call
+ * `toggle_sidebar` / `activate`.
+ *
+ * @module
+ */
 import { create_context } from '@fuzdev/fuz_ui/context_helpers.js';
+/**
+ * Svelte context carrying a reactive `SidebarState` accessor. Set by
+ * `AppShell.svelte` (creates a fresh `SidebarState` if not supplied);
+ * consumers call `sidebar_state_context.get()` to read or toggle visibility.
+ */
 export const sidebar_state_context = create_context();
 export class SidebarState {
     #get_enabled;
@@ -25,8 +37,11 @@ export class SidebarState {
         this.show_sidebar = value;
     }
     /**
-     * Activates the sidebar, showing it and enabling the toggle.
-     * Returns a cleanup function that deactivates.
+     * Show the sidebar and enable the toggle. The returned disposer hides
+     * and disables on cleanup — pair with `$effect` for scoped activation.
+     *
+     * @returns cleanup function that deactivates and hides the sidebar
+     * @mutates `this`
      */
     activate() {
         this.enabled = true;

package/dist/ui/table_state.svelte.d.ts

@@ -55,9 +55,23 @@ export declare class TableState extends Loadable {
     readonly showing_end: number;
     readonly has_prev: boolean;
     readonly has_next: boolean;
+    /**
+     * Fetch a page of rows for `table_name` from `GET /api/db/tables/{table_name}`.
+     * `limit` is clamped to `[1, TABLE_LIMIT_MAX]`.
+     *
+     * @mutates `this`
+     */
     fetch(table_name: string, offset?: number, limit?: number): Promise<void>;
     go_prev(): void;
     go_next(): void;
+    /**
+     * Delete a row by its primary key via `DELETE /api/db/tables/{table_name}/rows/{pk}`.
+     * Optimistically drops it from `rows` and decrements `total` on success;
+     * surfaces server errors on `delete_error`.
+     *
+     * @returns `true` when the row was removed; `false` on missing primary key or server error
+     * @mutates `this`
+     */
     delete_row(row: Record<string, unknown>): Promise<boolean>;
 }
 //# sourceMappingURL=table_state.svelte.d.ts.map

package/dist/ui/table_state.svelte.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"table_state.svelte.d.ts","sourceRoot":"../src/lib/","sources":["../../src/lib/ui/table_state.svelte.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,OAAO,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAC;AAG9C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAErD,mEAAmE;AACnE,eAAO,MAAM,eAAe,OAAO,CAAC;AAEpC,qBAAa,UAAW,SAAQ,QAAQ;IACvC,UAAU,EAAE,MAAM,CAAkB;IACpC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAkB;IAC5C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAkB;IACtD,KAAK,SAAiB;IACtB,MAAM,SAAiB;IACvB,KAAK,SAAmB;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAoB;IAC9C,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAoB;IAC3C,YAAY,EAAE,MAAM,GAAG,IAAI,CAAoB;IAG/C,QAAQ,CAAC,aAAa,SAAoD;IAC1E,QAAQ,CAAC,WAAW,SAAkE;IACtF,QAAQ,CAAC,QAAQ,UAA6B;IAC9C,QAAQ,CAAC,QAAQ,UAAmD;IAE9D,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,SAAI,EAAE,KAAK,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBvE,OAAO,IAAI,IAAI;IAIf,OAAO,IAAI,IAAI;IAIT,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAoChE"}
+{"version":3,"file":"table_state.svelte.d.ts","sourceRoot":"../src/lib/","sources":["../../src/lib/ui/table_state.svelte.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAEH,OAAO,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAC;AAG9C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,sBAAsB,CAAC;AAErD,mEAAmE;AACnE,eAAO,MAAM,eAAe,OAAO,CAAC;AAEpC,qBAAa,UAAW,SAAQ,QAAQ;IACvC,UAAU,EAAE,MAAM,CAAkB;IACpC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAkB;IAC5C,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAkB;IACtD,KAAK,SAAiB;IACtB,MAAM,SAAiB;IACvB,KAAK,SAAmB;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAoB;IAC9C,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAoB;IAC3C,YAAY,EAAE,MAAM,GAAG,IAAI,CAAoB;IAG/C,QAAQ,CAAC,aAAa,SAAoD;IAC1E,QAAQ,CAAC,WAAW,SAAkE;IACtF,QAAQ,CAAC,QAAQ,UAA6B;IAC9C,QAAQ,CAAC,QAAQ,UAAmD;IAEpE;;;;;OAKG;IACG,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,SAAI,EAAE,KAAK,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBvE,OAAO,IAAI,IAAI;IAIf,OAAO,IAAI,IAAI;IAIf;;;;;;;OAOG;IACG,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAoChE"}

package/dist/ui/table_state.svelte.js

@@ -57,6 +57,12 @@ export class TableState extends Loadable {
     showing_end = $derived(Math.min(this.offset + this.rows.length, this.total));
     has_prev = $derived(this.offset > 0);
     has_next = $derived(this.offset + this.limit < this.total);
+    /**
+     * Fetch a page of rows for `table_name` from `GET /api/db/tables/{table_name}`.
+     * `limit` is clamped to `[1, TABLE_LIMIT_MAX]`.
+     *
+     * @mutates `this`
+     */
     async fetch(table_name, offset = 0, limit = 100) {
         this.table_name = table_name;
         this.offset = offset;
@@ -79,6 +85,14 @@ export class TableState extends Loadable {
     go_next() {
         this.offset += this.limit;
     }
+    /**
+     * Delete a row by its primary key via `DELETE /api/db/tables/{table_name}/rows/{pk}`.
+     * Optimistically drops it from `rows` and decrements `total` on success;
+     * surfaces server errors on `delete_error`.
+     *
+     * @returns `true` when the row was removed; `false` on missing primary key or server error
+     * @mutates `this`
+     */
     async delete_row(row) {
         if (!this.primary_key)
             return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fuzdev/fuz_app",
-  "version": "0.51.0",
+  "version": "0.52.0",
   "description": "fullstack app library",
   "glyph": "🗝",
   "logo": "logo.svg",