better-supabase 0.14.0 → 0.15.0

package/dist/blocks/saved-views/index.d.ts

@@ -1,6 +1,313 @@
-import { $ as SaasEventData, Ct as Events } from "../../events-DbLjvxDX.js";
-import { c as BlockOf } from "../../define-block-COpcS6aT.js";
-import { A as SavedViewRef, C as SavedViewColumns, D as SavedViewList, E as SavedViewKind, F as createSavedViews, I as defaultView, L as savedViewIssues, M as SavedViewState, N as SavedViews, O as SavedViewPreference, P as SavedViewsOptions, R as savedViewStateSchema, S as SavedView, T as SavedViewDisplayState, _ as DuplicateViewInput, a as SavedViewsMatch, b as SAVED_VIEW_SCOPES, c as createSavedViewsController, d as displayStateOf, f as queryFromUrlState, g as DefaultViewCandidate, h as urlStateFromQuery, i as SavedViewsControllerOptions, j as SavedViewScope, k as SavedViewPreferenceInput, l as matchSavedViews, m as sameQuery, n as SavedViewsActions, o as SavedViewsSnapshot, p as sameDisplayState, r as SavedViewsController, s as SavedViewsSyncOptions, t as SavedViewLike, u as ListUrlState, v as SAVED_VIEW_DENSITIES, w as SavedViewDensity, x as SaveViewInput, y as SAVED_VIEW_KINDS } from "../../client-BQseXods.js";
+import { D as ValidationIssue, T as ErrorMapper, t as AsyncResult } from "../../result-DZeA5KS6.js";
+import { t as StandardSchemaV1 } from "../../standard-DBV730sF.js";
+import { i as RowFields, r as FieldsOf } from "../../block-fields-BE7pInWZ.js";
+import { $ as SaasEventData, Ct as Events } from "../../events-vcqenSYU.js";
+import { n as Logger } from "../../logger-DWVYUmwi.js";
+import { t as BlockTransport } from "../../block-transport-DWZSJrwN.js";
+import { n as BlockHooks } from "../../block-hooks-DZN2w69m.js";
+import { c as BlockOf } from "../../define-block-BVcLQ3DF.js";
+import { p as ListQueryInput } from "../../list-query-BDVutLFr.js";
+import { n as Controller } from "../../controller-BrP0gn47.js";
+import { t as RankNeighbors } from "../../rank-result-Bwe7igy-.js";
+//#region src/blocks/saved-views/saved-views.d.ts
+export declare const SAVED_VIEW_KINDS: readonly ["table", "board", "calendar", "timeline", "gantt"];
+type SavedViewKind = (typeof SAVED_VIEW_KINDS)[number];
+export declare const SAVED_VIEW_SCOPES: readonly ["user", "team", "tenant"];
+type SavedViewScope = (typeof SAVED_VIEW_SCOPES)[number];
+export declare const SAVED_VIEW_DENSITIES: readonly ["compact", "default", "comfortable"];
+type SavedViewDensity = (typeof SAVED_VIEW_DENSITIES)[number];
+/** Column layout, in the shape of TanStack Table's column state. */
+interface SavedViewColumns {
+  readonly visible?: readonly string[];
+  readonly order?: readonly string[];
+  readonly sizes?: Readonly<Record<string, number>>;
+  readonly pinned?: {
+    readonly left?: readonly string[];
+    readonly right?: readonly string[];
+  };
+}
+/** What a view stores. `query` is the list's typed input, without the page. */
+interface SavedViewState<Q extends ListQueryInput<string, string> = ListQueryInput<string, string>> {
+  readonly query?: Omit<Q, "page" | "after">;
+  readonly columns?: SavedViewColumns;
+  readonly grouping?: readonly string[];
+  readonly density?: SavedViewDensity;
+  /**
+   * Settings of the layout, such as a board's group column or a calendar's date
+   * field.
+   */
+  readonly layout?: Readonly<Record<string, unknown>>;
+  /**
+   * Keeps the view to the records of a collection
+   * (`better-supabase/blocks/collections`): pass `collections.where(id)` as the
+   * list's `where`.
+   */
+  readonly collectionId?: string;
+}
+/** The part of a view's state that lives outside the URL. */
+type SavedViewDisplayState = Omit<SavedViewState, "query">;
+/** The caller's own flags for a view, which need no right to change it. */
+interface SavedViewPreference {
+  /** Opens this view first, ahead of every slot default. */
+  readonly isDefault: boolean;
+  readonly hidden: boolean;
+  readonly pinned: boolean;
+}
+interface SavedViewPreferenceInput {
+  readonly isDefault?: boolean;
+  readonly hidden?: boolean;
+  readonly pinned?: boolean;
+}
+interface DuplicateViewInput {
+  readonly name?: string;
+  /** Default `user`. `team` and `tenant` need `views.share`. */
+  readonly scope?: SavedViewScope;
+  /** The team, for `scope: "team"`. */
+  readonly teamId?: string;
+}
+/**
+ * The part of a `defineListQuery` definition a saved view checks its query
+ * against. Any list definition fits.
+ */
+interface SavedViewList {
+  parse(input: object | undefined): {
+    readonly ok: boolean;
+    readonly issues?: readonly ValidationIssue[] | undefined;
+  };
+  readonly jsonSchema: Readonly<Record<string, unknown>>;
+}
+interface SavedView<Q extends ListQueryInput<string, string> = ListQueryInput<string, string>, F extends object = Record<never, never>> {
+  readonly id: string;
+  readonly list: string;
+  readonly scope: SavedViewScope;
+  readonly ownerId: string | null;
+  readonly teamId: string | null;
+  readonly name: string;
+  readonly kind: SavedViewKind;
+  readonly state: SavedViewState<Q>;
+  readonly rank: string;
+  /** The default of its slot (the owner's, the team's or the tenant's). */
+  readonly isDefault: boolean;
+  /** The caller's own flags; all false without the preferences table. */
+  readonly preference: SavedViewPreference;
+  /** The app's extra columns (`options.extraColumns`), by column name. */
+  readonly fields: RowFields<F>;
+}
+/**
+ * What `upsert` and `duplicate` resolve to: the view's id, rank key and extra
+ * columns.
+ */
+interface SavedViewRef<F extends object = Record<never, never>> {
+  readonly id: string;
+  readonly rank: string;
+  /** The app's extra columns (`options.extraColumns`), by column name. */
+  readonly fields: RowFields<F>;
+}
+interface SaveViewInput<Q extends ListQueryInput<string, string> = ListQueryInput<string, string>, F extends object = Record<never, never>> {
+  readonly organizationId: string;
+  /** The list's key, such as `tasks`; also the key in `lists`. */
+  readonly list: string;
+  readonly name: string;
+  readonly state: SavedViewState<Q>;
+  /** Default `table`. */
+  readonly kind?: SavedViewKind;
+  /** Default `user`. `team` and `tenant` need `views.share`. */
+  readonly scope?: SavedViewScope;
+  /** The team, for `scope: "team"`. */
+  readonly teamId?: string;
+  /** Updates this view instead of adding one. */
+  readonly id?: string;
+  /**
+   * Values for the app's extra columns (`options.extraColumns`); left out keeps
+   * the stored ones.
+   */
+  readonly fields?: Partial<F> & Readonly<Record<string, unknown>>;
+}
+interface SavedViewsOptions<S extends StandardSchemaV1 | undefined = undefined> {
+  readonly transport: BlockTransport;
+  readonly schema?: string;
+  readonly mappers?: readonly ErrorMapper[];
+  /** List definitions by key; `upsert` checks a view's query against its list. */
+  readonly lists?: Readonly<Record<string, SavedViewList>>;
+  /**
+   * A Standard Schema for the extra columns of the saved views table
+   * (`blocks.saved-views.options.extraColumns`): writes are validated, reads
+   * parsed.
+   */
+  readonly fields?: S;
+  /** `withBlockHooks` hooks around the client's methods. */
+  readonly hooks?: NoInfer<BlockHooks<SavedViews<FieldsOf<S>>>>;
+  /** Receives the errors `after` hooks throw. Default: `console`. */
+  readonly logger?: Logger;
+}
+interface SavedViews<F extends object = Record<never, never>> {
+  /** Adds a view, or updates `input.id`. Resolves to its id and rank key. */
+  upsert(input: SaveViewInput<ListQueryInput<string, string>, F>): AsyncResult<SavedViewRef<F>>;
+  /** The views the caller sees for a list, in rank order. */
+  list(organizationId: string, list: string): AsyncResult<SavedView<ListQueryInput<string, string>, F>[]>;
+  /** Moves a view between its neighbours' rank keys. Resolves to its new key. */
+  reorder(id: string, neighbors: RankNeighbors): AsyncResult<string>;
+  /**
+   * Makes a view the default of its slot (the user's, the team's or the
+   * tenant's).
+   */
+  setDefault(id: string, on?: boolean): AsyncResult<boolean>;
+  /**
+   * Sets the caller's own flags on a view they see. Omitted flags keep their
+   * value; one preferred default per user and list.
+   */
+  setPreference(id: string, preference: SavedViewPreferenceInput): AsyncResult<SavedViewPreference>;
+  /**
+   * Copies a view the caller sees as a new view. Resolves to its id and rank
+   * key.
+   */
+  duplicate(id: string, input?: DuplicateViewInput): AsyncResult<SavedViewRef<F>>;
+  delete(id: string): AsyncResult<boolean>;
+}
+/**
+ * Checks a view's state, and its `query` against `list` when given. An empty
+ * list means the state is valid.
+ */
+export declare function savedViewIssues(state: unknown, list?: SavedViewList): readonly ValidationIssue[];
+/** The JSON Schema of a view's state, with `query` from the list's schema. */
+export declare function savedViewStateSchema(list?: SavedViewList): Readonly<Record<string, unknown>>;
+export declare function createSavedViews<S extends StandardSchemaV1 | undefined = undefined>(options: SavedViewsOptions<S>): SavedViews<FieldsOf<S>>;
+/** The fields of a view `defaultView` reads; `SavedView` fits. */
+interface DefaultViewCandidate {
+  readonly scope: SavedViewScope;
+  readonly isDefault: boolean;
+  readonly preference?: Partial<Pick<SavedViewPreference, "isDefault" | "hidden">>;
+}
+/**
+ * The view that opens first: the caller's preferred default, then the user's
+ * slot default, a team default, the tenant's, then the first view. Views the
+ * caller hid are skipped.
+ */
+export declare function defaultView<V extends DefaultViewCandidate>(views: readonly V[]): V | undefined;
+//#endregion
+//#region src/blocks/saved-views/query-state.d.ts
+/**
+ * The URL state of a list as nuqs returns it from
+ * `useQueryStates(list.nuqs(createParser))`: one key per parser, `null` when
+ * the parameter is absent.
+ */
+type ListUrlState = Readonly<Record<string, unknown>>;
+/** A list's URL state as the typed query a view stores, without the page. */
+export declare function queryFromUrlState(state: ListUrlState): ListQueryInput<string, string>;
+/**
+ * The URL state that opens a view's query: every key in `keys` (the current
+ * state's), `null` unless the query sets it, so applying a view clears what the
+ * previous one set. The page goes back to the first.
+ */
+export declare function urlStateFromQuery(query: ListQueryInput<string, string> | undefined, keys: readonly string[]): Record<string, unknown>;
+/** A view's state without `query`: the part `onApplyState` shows. */
+export declare function displayStateOf(state: SavedViewState): SavedViewDisplayState;
+/** Whether two states show the same columns, grouping, density and layout. */
+export declare function sameDisplayState(a: SavedViewState | undefined, b: SavedViewState | undefined): boolean;
+/** Whether two stored queries select the same rows in the same order. */
+export declare function sameQuery(a: ListQueryInput<string, string> | undefined, b: ListQueryInput<string, string> | undefined): boolean;
+//#endregion
+//#region src/blocks/saved-views/client.d.ts
+/** The fields of a saved view the controller reads; `SavedView` fits. */
+interface SavedViewLike extends DefaultViewCandidate {
+  readonly id: string;
+  readonly name: string;
+  readonly state: SavedViewState;
+}
+interface SavedViewsSyncOptions<V extends SavedViewLike> {
+  /**
+   * Loads the list's views, e.g. a server action that calls
+   * `savedViews.list()`.
+   */
+  readonly load: () => Promise<readonly V[]>;
+  /**
+   * The state the UI shows outside the URL: columns, grouping, density and
+   * layout. `saveCurrent` stores it with the query, and `active` and `isDirty`
+   * compare it. Without it only the query counts.
+   */
+  readonly getState?: () => SavedViewDisplayState;
+  /**
+   * Shows a view's state outside the URL; `apply` calls it with everything but
+   * `query`.
+   */
+  readonly onApplyState?: (state: SavedViewDisplayState, view: V) => void;
+  /**
+   * Saves the current state, e.g. a server action that calls
+   * `savedViews.upsert()`.
+   */
+  readonly save?: (input: {
+    readonly name: string;
+    readonly query: ListQueryInput<string, string>;
+    /** The query and `getState()` together, as `savedViews.upsert()` takes it. */
+    readonly state: SavedViewState;
+    readonly id?: string;
+  }) => Promise<unknown>;
+  readonly remove?: (id: string) => Promise<unknown>;
+  /** Copies a view, e.g. a server action that calls `savedViews.duplicate()`. */
+  readonly duplicate?: (input: {
+    readonly id: string;
+    readonly name: string;
+    readonly scope?: SavedViewScope;
+  }) => Promise<unknown>;
+  /**
+   * Sets the caller's flags, e.g. a server action that calls
+   * `savedViews.setPreference()`.
+   */
+  readonly setPreference?: (id: string, preference: SavedViewPreferenceInput) => Promise<unknown>;
+  /**
+   * Applies the default view after the first load when the URL holds no query.
+   * Default `true`.
+   */
+  readonly openDefault?: boolean;
+}
+interface SavedViewsControllerOptions<V extends SavedViewLike> extends SavedViewsSyncOptions<V> {
+  /**
+   * The list's URL state now, e.g. from nuqs
+   * `useQueryStates(list.nuqs(createParser))`.
+   */
+  readonly urlState: () => ListUrlState;
+  /** Its setter, which `apply` calls with every key so stale ones clear. */
+  readonly setUrlState: (next: Record<string, unknown>) => unknown;
+}
+interface SavedViewsSnapshot<V extends SavedViewLike> {
+  /** `undefined` until the first load. */
+  readonly views: readonly V[] | undefined;
+  /** The view `apply` opened last. */
+  readonly opened: V | undefined;
+  readonly error: unknown;
+}
+interface SavedViewsActions<V extends SavedViewLike> {
+  /** Puts a view's query in the URL and passes the rest to `onApplyState`. */
+  readonly apply: (view: V) => void;
+  /** Saves the current state as a new view, or over `id`, then loads again. */
+  readonly saveCurrent: (name: string, id?: string) => Promise<void>;
+  readonly remove: (id: string) => Promise<void>;
+  /** Copies a view under `name`, then loads again. */
+  readonly duplicate: (id: string, name: string, scope?: SavedViewScope) => Promise<void>;
+  /** Sets the caller's own default, hidden or pinned flag, then loads again. */
+  readonly setPreference: (id: string, preference: SavedViewPreferenceInput) => Promise<void>;
+  readonly refresh: () => Promise<void>;
+}
+type SavedViewsController<V extends SavedViewLike> = Controller<SavedViewsSnapshot<V>, SavedViewsActions<V>>;
+/** What the URL and the display state show, compared with the views. */
+interface SavedViewsMatch<V extends SavedViewLike> {
+  /** The view whose state the URL and `getState()` hold, if any. */
+  readonly active: V | undefined;
+  /** The URL's query, in the shape a view stores. */
+  readonly query: ListQueryInput<string, string>;
+  /** The URL's query and `getState()`, in the shape a view stores. */
+  readonly state: SavedViewState;
+  /** Whether the state changed since `apply` opened the last view. */
+  readonly isDirty: boolean;
+}
+/** Matches the URL state and the display state against the loaded views. */
+export declare function matchSavedViews<V extends SavedViewLike>(snapshot: SavedViewsSnapshot<V>, urlState: ListUrlState, display: SavedViewDisplayState | undefined): SavedViewsMatch<V>;
+/**
+ * Saved views of one list, synced with its URL state and, through `getState`
+ * and `onApplyState`, with the table's columns, grouping, density and layout.
+ */
+export declare function createSavedViewsController<V extends SavedViewLike>(options: SavedViewsControllerOptions<V>): SavedViewsController<V>;
+//#endregion
 //#region src/blocks/saved-views/events.d.ts
 /** The events of the `saved-views` block: type to data. */
 type SavedViewsEvents = {
@@ -14,4 +321,4 @@ export declare const savedViewsEvents: Events<SavedViewsEvents>;
 /** The `saved-views` block's manifest (ADR 0029). */
 export declare const savedViewsBlock: BlockOf<"saved-views", typeof createSavedViews, SavedViewsEvents>;
 //#endregion
-export { type DefaultViewCandidate, type DuplicateViewInput, type ListUrlState, SAVED_VIEW_DENSITIES, SAVED_VIEW_KINDS, SAVED_VIEW_SCOPES, type SaveViewInput, type SavedView, type SavedViewColumns, type SavedViewDensity, type SavedViewDisplayState, type SavedViewKind, type SavedViewLike, type SavedViewList, type SavedViewPreference, type SavedViewPreferenceInput, type SavedViewRef, type SavedViewScope, type SavedViewState, type SavedViews, type SavedViewsActions, type SavedViewsController, type SavedViewsControllerOptions, type SavedViewsEvents, type SavedViewsMatch, type SavedViewsOptions, type SavedViewsSnapshot, type SavedViewsSyncOptions, createSavedViews, createSavedViewsController, defaultView, displayStateOf, matchSavedViews, queryFromUrlState, sameDisplayState, sameQuery, savedViewIssues, savedViewStateSchema, urlStateFromQuery };
+export type { DefaultViewCandidate, DuplicateViewInput, ListUrlState, SaveViewInput, SavedView, SavedViewColumns, SavedViewDensity, SavedViewDisplayState, SavedViewKind, SavedViewLike, SavedViewList, SavedViewPreference, SavedViewPreferenceInput, SavedViewRef, SavedViewScope, SavedViewState, SavedViews, SavedViewsActions, SavedViewsController, SavedViewsControllerOptions, SavedViewsEvents, SavedViewsMatch, SavedViewsOptions, SavedViewsSnapshot, SavedViewsSyncOptions };