@softr/sdk 0.0.4 → 0.0.6

package/dist/types-DCiIbAw_.d.ts

@@ -1,237 +0,0 @@
-//#region src/routes/visibility.d.ts
-/**
- * Declare this interface in your app to narrow every group id the SDK takes and
- * returns. Without a declaration, a group id is a plain `string`.
- *
- * @example
- * declare module "@softr/sdk" {
- *   interface SoftrUserGroups {
- *     ids:
- *       | "b1f2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
- *       | "f9e8d7c6-5b4a-4938-8271-605f4e3d2c1b"
- *   }
- * }
- */
-interface SoftrUserGroups {}
-/** A Softr user group id, narrowed to your own ids if you declare {@link SoftrUserGroups}. */
-type SoftrUserGroupId = SoftrUserGroups extends {
-  ids: infer Id extends string;
-} ? Id : string;
-/**
- * Who may see a route.
- *
- * - `ALL_USERS` — everyone, signed in or not.
- * - `NON_LOGGED_IN_USERS` — signed-out visitors only.
- * - `LOGGED_IN_USERS` — signed-in visitors; with `userGroupIds`, only members of
- *   at least one of those groups.
- */
-type RouteVisibility = {
-  userGroup: "ALL_USERS";
-} | {
-  userGroup: "NON_LOGGED_IN_USERS";
-} | {
-  userGroup: "LOGGED_IN_USERS";
-  userGroupIds?: Array<SoftrUserGroupId>;
-};
-/** The signed-in visitor. */
-type User = {
-  id: string;
-  email: string;
-  name: string;
-  userGroupIds: Array<SoftrUserGroupId>;
-};
-/** The route context the root route publishes: the visitor, or `null` when signed out. */
-type SoftrContext = {
-  user: User | null;
-};
-/**
- * Why a visitor was denied.
- *
- * - `unauthenticated` — the route needs a signed-in visitor and there is none.
- * - `forbidden` — signed in, but in none of the groups the route names.
- * - `alreadySignedIn` — the route is for signed-out visitors only.
- */
-declare const ACCESS_REASONS: readonly ["unauthenticated", "forbidden", "alreadySignedIn"];
-type AccessReason = (typeof ACCESS_REASONS)[number];
-/**
- * What a guard does when it refuses a visitor: redirect to a path, or throw an
- * {@link AccessError} for the route's `errorComponent` to render. A bare string
- * is shorthand for redirecting there.
- */
-type AccessBehaviour = string | {
-  strategy: "redirect";
-  to: string;
-} | {
-  strategy: "throw";
-};
-/** Per-reason overrides of the default {@link AccessBehaviour}. */
-type GuardOverrides = Partial<Record<AccessReason, AccessBehaviour>>;
-/** The result of {@link VisibilityHandle.check}: passed, or denied with a reason. */
-type AccessCheck = {
-  ok: true;
-} | {
-  ok: false;
-  reason: AccessReason;
-};
-/**
- * The access error a guard throws. It is plain data, not an `Error` subclass, so
- * take it as `unknown` in an `errorComponent` and narrow it with
- * {@link isAccessError}. It carries the reason and nothing else: the error is
- * serialized into the page, so it never names the groups the route wanted.
- *
- * @example
- * errorComponent: ({ error }: { error: unknown }) =>
- *   isAccessError(error) ? <NoAccess /> : <AppError />
- */
-type AccessError = {
-  type: "access_error";
-  reason: AccessReason;
-};
-/**
- * True for any access error thrown by a guard, whatever its reason.
- *
- * An access error arrives as `unknown` — hydrated from the page, or thrown by
- * anything else at all — so every field is checked before it is narrowed.
- */
-declare function isAccessError(error: unknown): error is AccessError;
-/** True for an access error thrown because nobody was signed in. */
-declare function isUnauthenticatedError(error: unknown): error is AccessError;
-/** True for an access error thrown because the visitor was in none of the groups. */
-declare function isForbiddenError(error: unknown): error is AccessError;
-/** True for an access error thrown because a signed-out-only route saw a user. */
-declare function isAlreadySignedInError(error: unknown): error is AccessError;
-type Narrowed<R extends RouteVisibility> = R extends {
-  userGroup: "LOGGED_IN_USERS";
-} ? SoftrContext & {
-  user: User;
-} : R extends {
-  userGroup: "NON_LOGGED_IN_USERS";
-} ? SoftrContext & {
-  user: null;
-} : SoftrContext;
-/** The four ways to apply a rule, returned by {@link defineVisibility}. */
-type VisibilityHandle<R extends RouteVisibility = RouteVisibility> = {
-  /**
-   * A `beforeLoad` handler that denies a visitor who fails the rule.
-   *
-   * By default an unauthenticated visitor is redirected to `/login`, an already
-   * signed-in one to `/`, and a forbidden one gets an {@link AccessError} thrown
-   * in place, for the route's `errorComponent` to render. Pass `overrides` to
-   * change what any one reason does.
-   *
-   * @example
-   * beforeLoad: visibility.guard({ unauthenticated: "/sign-in" })
-   */
-  guard(overrides?: GuardOverrides): (opts: {
-    context: SoftrContext;
-  }) => void;
-  /**
-   * Throws the same access error or redirect `guard()` would, for code that
-   * needs to run its own checks after the rule.
-   *
-   * @example
-   * beforeLoad: ({ context }) => {
-   *   visibility.assert(context)
-   *   if (context.user.trialExpired) throw redirect({ to: "/renew" })
-   * }
-   */
-  assert(context: SoftrContext): void;
-  /**
-   * Whether the visitor passes the rule. Narrows `context.user` where the rule
-   * allows it.
-   */
-  isAuthorized(context: SoftrContext): context is Narrowed<R>;
-  /** The decision and, when a visitor is refused, the reason. Throws nothing. */
-  check(context: SoftrContext): AccessCheck;
-};
-/**
- * Declares who may see a route, and returns the handle that enforces it.
- *
- * One call per route file, at module scope: the build reads these declarations
- * to publish the app's route visibility, so the rule must be a literal.
- *
- * @example
- * const visibility = defineVisibility({ userGroup: "LOGGED_IN_USERS" })
- *
- * export const Route = createFileRoute("/about")({
- *   beforeLoad: visibility.guard(),
- *   component: About,
- * })
- */
-declare function defineVisibility<const R extends RouteVisibility>(rule: R): VisibilityHandle<R>;
-//#endregion
-//#region src/types.d.ts
-interface SoftrUser {
-  id: string;
-  email: string;
-  name: string;
-  userGroupIds: Array<SoftrUserGroupId>;
-}
-interface DatasourcePermissions {
-  read: boolean;
-  create: boolean;
-  update: boolean;
-  delete: boolean;
-}
-interface SoftrPermissions {
-  datasources: Record<string, DatasourcePermissions>;
-  workflows: Record<string, boolean>;
-}
-interface SoftrMe {
-  user: SoftrUser | null;
-  permissions: SoftrPermissions;
-}
-interface ListOptions {
-  page?: number;
-  limit?: number;
-  filters?: Array<{
-    field: string;
-    operator: string;
-    value: unknown;
-  }>;
-  sort?: Array<{
-    field: string;
-    direction: 'asc' | 'desc';
-  }>;
-}
-interface ListResult<T = SoftrRecord> {
-  records: T[];
-  total: number;
-  page: number;
-  limit: number;
-}
-interface SoftrRecord {
-  id: string;
-  [field: string]: unknown;
-}
-interface DatasourceAPI {
-  list(options?: ListOptions): Promise<ListResult>;
-  get(recordId: string): Promise<SoftrRecord>;
-  create(data: Record<string, unknown>): Promise<SoftrRecord>;
-  update(recordId: string, data: Record<string, unknown>): Promise<SoftrRecord>;
-  delete(recordId: string): Promise<void>;
-}
-interface WorkflowAPI {
-  trigger(payload?: Record<string, unknown>): Promise<void>;
-}
-interface AuthAPI {
-  /** Sign in with email and password. Clears the cached me() result. */
-  login(credentials: {
-    email: string;
-    password: string;
-  }): Promise<void>;
-  /** Sign out the current user. Clears the cached me() result. */
-  logout(): Promise<void>;
-}
-interface SoftrSDK {
-  /**
-   * Fetch the current user and their permissions from /me.
-   * Cached for the lifetime of the instance — create a new instance per request on the server.
-   */
-  me(): Promise<SoftrMe>;
-  auth: AuthAPI;
-  datasource(id: string): DatasourceAPI;
-  workflow(id: string): WorkflowAPI;
-}
-//#endregion
-export { isAccessError as C, isUnauthenticatedError as E, defineVisibility as S, isForbiddenError as T, SoftrContext as _, ListResult as a, User as b, SoftrRecord as c, WorkflowAPI as d, AccessBehaviour as f, RouteVisibility as g, AccessReason as h, ListOptions as i, SoftrSDK as l, AccessError as m, DatasourceAPI as n, SoftrMe as o, AccessCheck as p, DatasourcePermissions as r, SoftrPermissions as s, AuthAPI as t, SoftrUser as u, SoftrUserGroupId as v, isAlreadySignedInError as w, VisibilityHandle as x, SoftrUserGroups as y };