permdock 0.6.0 → 0.8.0

package/dist/react-native/index.d.ts

@@ -1,16 +1,20 @@
-import { Bt as LocalSnapshotManifest, Rt as Instant, Vt as Snapshot, Zn as CustomRole, nr as Membership, ot as SnapshotSource } from "../policy-types-n0uRTsW8.js";
-import { w as Permission } from "../vocabulary-CN8H_9UF.js";
-import { n as requiredPlans } from "../problem-details-B45V5d2b.js";
-import { i as describe } from "../describe-B5qgDvEW.js";
-import { t as parseLocalSnapshotManifest } from "../parse-local-manifest-5ODwqu8b.js";
-import { t as approvalHeaders } from "../headers-CIbDTUTK.js";
-import { a as FilterResult, c as PermissionSet, f as SubjectView, i as ClientStatus, l as PermissionState, m as ClientStore, n as ApprovalState, o as GateMode, p as TenantView, r as ClientPermDock, s as GateView, t as ApprovalHandle } from "../types-B3_ooZgZ.js";
-import { r as ProtectedProps, t as PermDockDefaults } from "../types-CX7AvRqP.js";
-import { a as useDescribe, c as useMemberships, d as usePermissions, f as useRoles, i as useAssignableRoles, l as usePermDock, m as useTenant, n as useApproval, o as useFilter, p as useSubject, r as useAssignablePermissions, s as useGate, t as Protected, u as usePermission } from "../protected-RFGpakN9.js";
-import { a as SubscribeOnline, i as SubscribeForeground, n as ReactNativePermDockProviderProps, r as SnapshotStorage, t as NativeRevalidate } from "../types-C863OQiR.js";
+import { Bt as LocalMembershipRows, Gt as Snapshot, Ht as LocalRowValue, Rt as Instant, Ut as LocalSnapshotManifest, Vt as LocalRowColumn, Wt as LocalSnapshotRows, or as Membership, ot as SnapshotSource, tr as CustomRole } from "../policy-types-CCiDRZBH.js";
+import { u as Permission } from "../permission-types-CAY-GU7e.js";
+import { c as requiredPlans } from "../errors-zi_4T-rx.js";
+import { i as describe } from "../describe-ByS9LgHK.js";
+import { t as parseLocalSnapshotManifest } from "../parse-local-manifest-BQhTlLQS.js";
+import { n as ProtectedAction, t as ActionResult } from "../action-result-CL-QCITA.js";
+import { t as approvalHeaders } from "../headers-B9jQxjtW.js";
+import { a as FilterResult, b as eventSourceRefresh, c as PermissionSet, d as ProtectedActionView, g as ClientStore, h as TenantView, i as ClientStatus, l as PermissionState, m as SubjectView, n as ApprovalState, o as GateMode, p as RolesOptions, r as ClientPermDock, s as GateView, t as ApprovalHandle, u as ProtectedActionHandle, v as EventSourceRefreshOptions, y as RefreshTrigger } from "../types-B_d_g7T3.js";
+import { r as ProtectedProps, t as PermDockDefaults } from "../types-BJk0BKRX.js";
+import { a as useAssignableRoles, c as useGate, d as usePermission, f as usePermissions, h as useTenant, i as useAssignablePermissions, l as useMemberships, m as useSubject, n as Protected, o as useDescribe, p as useRoles, r as useApproval, s as useFilter, t as useProtectedAction, u as usePermDock } from "../protected-action-BE7N_Luo.js";
+import { a as SubscribeOnline, i as SubscribeForeground, n as ReactNativePermDockProviderProps, r as SnapshotStorage, t as NativeRevalidate } from "../types-HzqOtvsJ.js";
 import { ReactElement } from "react";
 //#region src/react-native/guards.d.ts
-/** `true` once the provider has a snapshot to answer from: storage was read or a seed was given. Hide the splash screen on it. */
+/**
+ * `true` once the provider has a snapshot to answer from: storage was read or a
+ * seed was given. Hide the splash screen on it.
+ */
 export declare function useSnapshotReady(): boolean;
 /**
  * A boolean for `Stack.Protected` and `Tabs.Protected`: `false` while the
@@ -30,7 +34,10 @@ type LocalSnapshotData = {
     /** The active tenant: the first scope's instance the UI shows. */
     readonly tenant?: string;
     readonly memberships?: readonly Membership[];
-    /** Attributes conditions read, such as `claims` for `principal.claims.team_ids`. */
+    /**
+     * Attributes conditions read, such as `claims` for
+     * `principal.claims.team_ids`.
+     */
     readonly attributes?: Readonly<Record<string, unknown>>;
   } | null;
   /** The tenant's custom roles, in the shape a `CustomRoleSource` returns. */
@@ -40,7 +47,10 @@ type LocalSnapshotOptions = {
   /** `localSnapshotManifest(policy)`, written at build time. */
   readonly manifest: LocalSnapshotManifest;
   readonly read: () => LocalSnapshotData | Promise<LocalSnapshotData>;
-  /** Calls the listener when the rows `read` reads change; returns the unsubscribe. */
+  /**
+   * Calls the listener when the rows `read` reads change; returns the
+   * unsubscribe.
+   */
   readonly subscribe?: (listener: () => void) => () => void;
 };
 /**
@@ -49,21 +59,21 @@ type LocalSnapshotOptions = {
  */
 export declare function buildLocalSnapshot(manifest: LocalSnapshotManifest, data: LocalSnapshotData, at?: Instant): Snapshot;
 /**
- * A snapshot source over the device's own membership rows (SQLite, a
- * PowerSync or Electric replica): offline, the UI guards answer from them.
+ * A snapshot source over the device's own membership rows (SQLite, a PowerSync
+ * or Electric replica): offline, the UI guards answer from them.
  */
 export declare function localSnapshot(options: LocalSnapshotOptions): SnapshotSource;
 //#endregion
 //#region src/react-native/powersync.d.ts
 /** The `PowerSyncDatabase` methods `powerSyncSource` calls. */
 type PowerSyncWatchable = {
-  getAll(sql: string, parameters?: unknown[]): Promise<unknown[]>;
-  watch(sql: string, parameters: unknown[] | undefined, handler: {
-    onResult(result: unknown): void;
-    onError?(error: Error): void;
+  getAll: (sql: string, parameters?: unknown[]) => Promise<unknown[]>;
+  watch: (sql: string, parameters: unknown[] | undefined, handler: {
+    onResult: (result: unknown) => void;
+    onError?: (error: Error) => void;
   }, options: {
     readonly signal: AbortSignal;
-  }): void;
+  }) => void;
 };
 /** One local query: SQL over the synced tables and its parameters. */
 type PowerSyncQuery = {
@@ -71,19 +81,47 @@ type PowerSyncQuery = {
   readonly parameters?: readonly unknown[];
 };
 type PowerSyncSourceOptions<Q extends string> = {
-  /** `localSnapshotManifest(policy)`, as `permdock powersync generate` writes it to `powersync.manifest`. */
+  /**
+   * `localSnapshotManifest(policy)`, as `permdock powersync generate`
+   * writes it to `powersync.manifest`.
+   */
   readonly manifest: LocalSnapshotManifest;
   /** The queries over the `permdock_*` streams' tables; each one is watched. */
   readonly queries: Readonly<Record<Q, PowerSyncQuery>>;
-  /** Maps the rows of each query to the signed-in user's memberships and roles. */
+  /**
+   * Maps the rows of each query to the signed-in user's memberships and
+   * roles.
+   */
   readonly read: (rows: Readonly<Record<Q, readonly unknown[]>>) => LocalSnapshotData;
+} | {
+  /**
+   * The manifest `permdock powersync generate` writes, with its `rows`
+   * section.
+   */
+  readonly manifest: LocalSnapshotManifest;
+  /**
+   * The signed-in user's id; the source reads the rows `manifest.rows`
+   * names.
+   */
+  readonly user: string;
+  /** The active tenant: the first scope's instance the UI shows. */
+  readonly tenant?: string;
+  /**
+   * Attributes conditions read, such as `claims` for
+   * `principal.claims.team_ids`.
+   */
+  readonly attributes?: Readonly<Record<string, unknown>>;
+  readonly queries?: undefined;
+  readonly read?: undefined;
 };
 /**
  * A `localSnapshot` source over a PowerSync database: `get` runs every query
- * with `db.getAll`, and a `db.watch` per query reports changes. A watch
- * result with unchanged content re-renders nothing (`connectSource`). The source
- * takes the database as an argument; `permdock/react-native` never imports
- * `@powersync/*`.
+ * with `db.getAll`, and a `db.watch` per query reports changes. Without
+ * `queries` and `read`, it reads the tables `manifest.rows` names: the
+ * memberships of every source with null roles dropped, the global roles and the
+ * custom roles with their levels. A watch result with unchanged content
+ * re-renders nothing (`connectSource`). The source takes the database as an
+ * argument; `permdock/react-native` never imports `@powersync/*`.
  */
 export declare function powerSyncSource<Q extends string>(db: PowerSyncWatchable, options: PowerSyncSourceOptions<Q>): SnapshotSource;
 //#endregion
@@ -96,64 +134,79 @@ export declare function memorySnapshotStorage(initial?: Readonly<Record<string,
 //#region src/react-native/storage-adapters.d.ts
 /** The `expo-secure-store` functions `secureStoreStorage` calls. */
 type SecureStoreModule = {
-  getItem(key: string, options?: object): string | null;
-  setItem(key: string, value: string, options?: object): void;
-  deleteItemAsync(key: string, options?: object): Promise<void>;
+  getItem: (key: string, options?: object) => string | null;
+  setItem: (key: string, value: string, options?: object) => void;
+  deleteItemAsync: (key: string, options?: object) => Promise<void>;
 };
-/** The `react-native-mmkv` instance methods `mmkvStorage` calls: `remove` (v4) or `delete` (v3). */
+/**
+ * The `react-native-mmkv` instance methods `mmkvStorage` calls: `remove` (v4)
+ * or `delete` (v3).
+ */
 type MmkvInstance = {
-  getString(key: string): string | undefined;
-  set(key: string, value: string): void;
+  getString: (key: string) => string | undefined;
+  set: (key: string, value: string) => void;
 } & ({
-  remove(key: string): unknown;
+  remove: (key: string) => unknown;
 } | {
-  delete(key: string): unknown;
+  delete: (key: string) => unknown;
 });
 /**
- * A `SnapshotStorage` over `expo-secure-store`. Values are split into chunks
- * of at most 2048 bytes under `<key>.<n>`; `<key>` holds the chunk count and
- * is written last, so an interrupted write reads as absent.
+ * A `SnapshotStorage` over `expo-secure-store`. Values are split into chunks of
+ * at most 2048 bytes under `<key>.<n>`; `<key>` holds the chunk count and is
+ * written last, so an interrupted write reads as absent.
  */
 export declare function secureStoreStorage(store: SecureStoreModule, options?: object): SnapshotStorage;
-/** A synchronous `SnapshotStorage` over a `react-native-mmkv` instance: the first frame already has the snapshot. */
+/**
+ * A synchronous `SnapshotStorage` over a `react-native-mmkv` instance: the
+ * first frame already has the snapshot.
+ */
 export declare function mmkvStorage(mmkv: MmkvInstance): SnapshotStorage;
 //#endregion
 //#region src/react-native/subscriptions.d.ts
 /** The `AppState` export of `react-native`, as `appStateForeground` calls it. */
 type AppStateModule = {
-  addEventListener(type: "change", listener: (state: string) => void): {
-    remove(): void;
+  addEventListener: (type: "change", listener: (state: string) => void) => {
+    remove: () => void;
   };
 };
-/** The default export of `@react-native-community/netinfo`, as `netInfoOnline` calls it. */
+/**
+ * The default export of `@react-native-community/netinfo`, as `netInfoOnline`
+ * calls it.
+ */
 type NetInfoModule = {
-  addEventListener(listener: (state: {
+  addEventListener: (listener: (state: {
     readonly isConnected: boolean | null;
     readonly isInternetReachable?: boolean | null;
-  }) => void): () => void;
+  }) => void) => () => void;
 };
 /**
- * `subscribeForeground` over `AppState`: `active` returns to the foreground
- * and `background` leaves it. iOS `inactive` (a system sheet over the app) is
+ * `subscribeForeground` over `AppState`: `active` returns to the foreground and
+ * `background` leaves it. iOS `inactive` (a system sheet over the app) is
  * neither.
  */
 export declare function appStateForeground(appState: AppStateModule): SubscribeForeground;
-/** `subscribeOnline` over NetInfo. An unknown (`null`) connection counts as online. */
+/**
+ * `subscribeOnline` over NetInfo. An unknown (`null`) connection counts as
+ * online.
+ */
 export declare function netInfoOnline(netInfo: NetInfoModule): SubscribeOnline;
 //#endregion
 //#region src/react-native/store.d.ts
 type NativeStoreOptions = Omit<ReactNativePermDockProviderProps, "children" | "headers" | "defaults" | "messages"> & {
   readonly headers?: Readonly<Record<string, string>> | (() => Readonly<Record<string, string>> | undefined);
-  /** A store this one replaces: its snapshot and tenant seed this store, so guards do not flip while it boots. */
+  /**
+   * A store this one replaces: its snapshot and tenant seed this store, so
+   * guards do not flip while it boots.
+   */
   readonly previous?: ClientStore;
 };
 /**
  * Hydrates `store` from `source` now, on every change it reports and on each
- * return to the foreground. Only the latest read applies; a read with
- * unchanged content re-renders nothing, and a failed read keeps the current
- * snapshot. Returns the unsubscribe.
+ * return to the foreground. Only the latest read applies; a read with unchanged
+ * content re-renders nothing, and a failed read keeps the current snapshot.
+ * Returns the unsubscribe.
  */
 export declare function connectSource(store: ClientStore, source: SnapshotSource, subscribeForeground?: SubscribeForeground): () => void;
 export declare function nativeStore(options: NativeStoreOptions): ClientStore;
 //#endregion
-export { type AppStateModule, type ApprovalHandle, type ApprovalState, type ClientPermDock, type ClientStatus, type FilterResult, type GateMode, type GateView, type LocalSnapshotData, type LocalSnapshotManifest, type LocalSnapshotOptions, type MmkvInstance, type NativeRevalidate, type NetInfoModule, type PermDockDefaults, type PermissionSet, type PermissionState, type PowerSyncQuery, type PowerSyncSourceOptions, type PowerSyncWatchable, Protected, type ProtectedProps, type ReactNativePermDockProviderProps, type SecureStoreModule, type SnapshotSource, type SnapshotStorage, type SubjectView, type SubscribeForeground, type SubscribeOnline, type TenantView, approvalHeaders, describe, parseLocalSnapshotManifest, requiredPlans, useApproval, useAssignablePermissions, useAssignableRoles, useDescribe, useFilter, useGate, useMemberships, usePermDock, usePermission, usePermissions, useRoles, useSubject, useTenant };
+export { type ActionResult, type AppStateModule, type ApprovalHandle, type ApprovalState, type ClientPermDock, type ClientStatus, type EventSourceRefreshOptions, type FilterResult, type GateMode, type GateView, type LocalMembershipRows, type LocalRowColumn, type LocalRowValue, type LocalSnapshotData, type LocalSnapshotManifest, type LocalSnapshotOptions, type LocalSnapshotRows, type MmkvInstance, type NativeRevalidate, type NetInfoModule, type PermDockDefaults, type PermissionSet, type PermissionState, type PowerSyncQuery, type PowerSyncSourceOptions, type PowerSyncWatchable, Protected, type ProtectedAction, type ProtectedActionHandle, type ProtectedActionView, type ProtectedProps, type ReactNativePermDockProviderProps, type RefreshTrigger, type RolesOptions, type SecureStoreModule, type SnapshotSource, type SnapshotStorage, type SubjectView, type SubscribeForeground, type SubscribeOnline, type TenantView, approvalHeaders, describe, eventSourceRefresh, parseLocalSnapshotManifest, requiredPlans, useApproval, useAssignablePermissions, useAssignableRoles, useDescribe, useFilter, useGate, useMemberships, usePermDock, usePermission, usePermissions, useProtectedAction, useRoles, useSubject, useTenant };