@slashid/react/dist/react/src/middleware/default-organization/index.d.ts

React SDK for the /id platform

import { OrganizationDetails, User } from "@slashid/slashid";
import { LoginMiddleware } from "../../domain/types";
/**
 * Middleware: post-login switch the users organization context to another suborganization.
 *
 * This middleware allows for you to login at your root organization but then
 * have the user land in a suborganization e.g. their personal organization,
 * their teams organization, their preferred home, etc.
 *
 * @param oid the organization id of the users default organization - this can be a string or a function which resolves to a string. When a function is provided it's called with a list of all available organizations for that user, and the user object itself.
 *
 * @example
 * Using a static default organization
 * ```tsx
 * <Form
 *  middleware={[
 *    defaultOrganization("ORG_ID")
 *  ]}
 * />
 * ```
 *
 * @example
 * Searching for the organization from the users available organizations
 * ```tsx
 * <Form
 *  middleware={[
 *    defaultOrganization(({ organizations }) =>
 *      orgs.find(({ org_name }) => org_name === "home") ?? "FALLBACK_ORG_ID"
 *    )
 *  ]}
 * />
 * ```
 *
 * @example
 * Getting the default org from a user attribute you've set
 * ```tsx
 * <Form
 *  middleware={[
 *    defaultOrganization(async ({ user }) => {
 *      const bucket = user.getBucket()
 *      const { preferred_org_id } = await bucket.get<{ preferred_org_id }>("preferred_org_id")
 *
 *      return preferred_org_id
 *    })
 *  ]}
 * />
 * ```
 */
export declare const defaultOrganization: (oid: string | ((context: {
    organizations: OrganizationDetails[];
    user: User;
}) => string | Promise<string>)) => LoginMiddleware;
//# sourceMappingURL=index.d.ts.map