@gatwech/auth 1.0.0-beta.18

package/dist/src/plugins/organization/organization.d.ts

@@ -0,0 +1,412 @@
+import * as z from "zod";
+import { type AccessControl } from "../access";
+import { ORGANIZATION_ERROR_CODES } from "./error-codes";
+import { createOrgRole, deleteOrgRole, getOrgRole, listOrgRoles, updateOrgRole } from "./routes/crud-access-control";
+import { acceptInvitation, cancelInvitation, createInvitation, getInvitation, listInvitations, listUserInvitations, rejectInvitation } from "./routes/crud-invites";
+import { addMember, getActiveMember, getActiveMemberRole, leaveOrganization, listMembers, removeMember, updateMemberRole } from "./routes/crud-members";
+import { checkOrganizationSlug, createOrganization, deleteOrganization, getFullOrganization, listOrganizations, setActiveOrganization, updateOrganization } from "./routes/crud-org";
+import { addTeamMember, createTeam, listOrganizationTeams, listTeamMembers, listUserTeams, removeTeam, removeTeamMember, setActiveTeam, updateTeam } from "./routes/crud-team";
+import type { InferInvitation, InferMember, InferOrganization, OrganizationSchema, Team, TeamMember } from "./schema";
+import type { OrganizationOptions } from "./types";
+export declare function parseRoles(roles: string | string[]): string;
+export type DynamicAccessControlEndpoints<O extends OrganizationOptions> = {
+    createOrgRole: ReturnType<typeof createOrgRole<O>>;
+    deleteOrgRole: ReturnType<typeof deleteOrgRole<O>>;
+    listOrgRoles: ReturnType<typeof listOrgRoles<O>>;
+    getOrgRole: ReturnType<typeof getOrgRole<O>>;
+    updateOrgRole: ReturnType<typeof updateOrgRole<O>>;
+};
+export type TeamEndpoints<O extends OrganizationOptions> = {
+    createTeam: ReturnType<typeof createTeam<O>>;
+    listOrganizationTeams: ReturnType<typeof listOrganizationTeams<O>>;
+    removeTeam: ReturnType<typeof removeTeam<O>>;
+    updateTeam: ReturnType<typeof updateTeam<O>>;
+    setActiveTeam: ReturnType<typeof setActiveTeam<O>>;
+    listUserTeams: ReturnType<typeof listUserTeams<O>>;
+    listTeamMembers: ReturnType<typeof listTeamMembers<O>>;
+    addTeamMember: ReturnType<typeof addTeamMember<O>>;
+    removeTeamMember: ReturnType<typeof removeTeamMember<O>>;
+};
+export type OrganizationEndpoints<O extends OrganizationOptions> = {
+    createOrganization: ReturnType<typeof createOrganization<O>>;
+    updateOrganization: ReturnType<typeof updateOrganization<O>>;
+    deleteOrganization: ReturnType<typeof deleteOrganization<O>>;
+    setActiveOrganization: ReturnType<typeof setActiveOrganization<O>>;
+    getFullOrganization: ReturnType<typeof getFullOrganization<O>>;
+    listOrganizations: ReturnType<typeof listOrganizations<O>>;
+    createInvitation: ReturnType<typeof createInvitation<O>>;
+    cancelInvitation: ReturnType<typeof cancelInvitation<O>>;
+    acceptInvitation: ReturnType<typeof acceptInvitation<O>>;
+    getInvitation: ReturnType<typeof getInvitation<O>>;
+    rejectInvitation: ReturnType<typeof rejectInvitation<O>>;
+    listInvitations: ReturnType<typeof listInvitations<O>>;
+    getActiveMember: ReturnType<typeof getActiveMember<O>>;
+    checkOrganizationSlug: ReturnType<typeof checkOrganizationSlug<O>>;
+    addMember: ReturnType<typeof addMember<O>>;
+    removeMember: ReturnType<typeof removeMember<O>>;
+    updateMemberRole: ReturnType<typeof updateMemberRole<O>>;
+    leaveOrganization: ReturnType<typeof leaveOrganization<O>>;
+    listUserInvitations: ReturnType<typeof listUserInvitations<O>>;
+    listMembers: ReturnType<typeof listMembers<O>>;
+    getActiveMemberRole: ReturnType<typeof getActiveMemberRole<O>>;
+    hasPermission: ReturnType<typeof createHasPermission<O>>;
+};
+declare const createHasPermission: <O extends OrganizationOptions>(options: O) => {
+    <AsResponse extends boolean = false, ReturnHeaders extends boolean = false>(inputCtx_0: {
+        body: ({
+            /**
+             * @deprecated Use `permissions` instead
+             */
+            permission: { [key in keyof (O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                readonly organization: readonly ["update", "delete"];
+                readonly member: readonly ["create", "update", "delete"];
+                readonly invitation: readonly ["create", "cancel"];
+                readonly team: readonly ["create", "update", "delete"];
+                readonly ac: readonly ["create", "read", "update", "delete"];
+            })]?: ((O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                readonly organization: readonly ["update", "delete"];
+                readonly member: readonly ["create", "update", "delete"];
+                readonly invitation: readonly ["create", "cancel"];
+                readonly team: readonly ["create", "update", "delete"];
+                readonly ac: readonly ["create", "read", "update", "delete"];
+            })[key] extends readonly unknown[] ? (O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                readonly organization: readonly ["update", "delete"];
+                readonly member: readonly ["create", "update", "delete"];
+                readonly invitation: readonly ["create", "cancel"];
+                readonly team: readonly ["create", "update", "delete"];
+                readonly ac: readonly ["create", "read", "update", "delete"];
+            })[key][number] : never)[] | undefined; };
+            permissions?: never | undefined;
+        } | {
+            permissions: { [key in keyof (O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                readonly organization: readonly ["update", "delete"];
+                readonly member: readonly ["create", "update", "delete"];
+                readonly invitation: readonly ["create", "cancel"];
+                readonly team: readonly ["create", "update", "delete"];
+                readonly ac: readonly ["create", "read", "update", "delete"];
+            })]?: ((O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                readonly organization: readonly ["update", "delete"];
+                readonly member: readonly ["create", "update", "delete"];
+                readonly invitation: readonly ["create", "cancel"];
+                readonly team: readonly ["create", "update", "delete"];
+                readonly ac: readonly ["create", "read", "update", "delete"];
+            })[key] extends readonly unknown[] ? (O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                readonly organization: readonly ["update", "delete"];
+                readonly member: readonly ["create", "update", "delete"];
+                readonly invitation: readonly ["create", "cancel"];
+                readonly team: readonly ["create", "update", "delete"];
+                readonly ac: readonly ["create", "read", "update", "delete"];
+            })[key][number] : never)[] | undefined; };
+            permission?: never | undefined;
+        }) & {
+            organizationId?: string | undefined;
+        };
+    } & {
+        method?: "POST" | undefined;
+    } & {
+        query?: Record<string, any> | undefined;
+    } & {
+        params?: Record<string, any>;
+    } & {
+        request?: Request;
+    } & {
+        headers: HeadersInit;
+    } & {
+        asResponse?: boolean;
+        returnHeaders?: boolean;
+        use?: import("better-call").Middleware[];
+        path?: string;
+    } & {
+        asResponse?: AsResponse | undefined;
+        returnHeaders?: ReturnHeaders | undefined;
+    }): Promise<[AsResponse] extends [true] ? Response : [ReturnHeaders] extends [true] ? {
+        headers: Headers;
+        response: {
+            error: null;
+            success: boolean;
+        };
+    } : {
+        error: null;
+        success: boolean;
+    }>;
+    options: {
+        method: "POST";
+        requireHeaders: true;
+        body: z.ZodIntersection<z.ZodObject<{
+            organizationId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodUnion<readonly [z.ZodObject<{
+            permission: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>;
+            permissions: z.ZodUndefined;
+        }, z.core.$strip>, z.ZodObject<{
+            permission: z.ZodUndefined;
+            permissions: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString>>;
+        }, z.core.$strip>]>>;
+        use: ((inputContext: import("better-call").MiddlewareInputContext<{
+            use: ((inputContext: import("better-call").MiddlewareInputContext<import("better-call").MiddlewareOptions>) => Promise<{
+                session: {
+                    session: Record<string, any> & {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        userId: string;
+                        expiresAt: Date;
+                        token: string;
+                        ipAddress?: string | null | undefined;
+                        userAgent?: string | null | undefined;
+                    };
+                    user: Record<string, any> & {
+                        id: string;
+                        createdAt: Date;
+                        updatedAt: Date;
+                        email: string;
+                        emailVerified: boolean;
+                        name: string;
+                        image?: string | null | undefined;
+                    };
+                };
+            }>)[];
+        }>) => Promise<{
+            session: {
+                session: import("@gatwech/core/db").Session & {
+                    activeTeamId?: string | undefined;
+                    activeOrganizationId?: string | undefined;
+                };
+                user: import("@gatwech/core/db").User;
+            };
+        }>)[];
+        metadata: {
+            $Infer: {
+                body: ({
+                    /**
+                     * @deprecated Use `permissions` instead
+                     */
+                    permission: { [key in keyof (O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                        readonly organization: readonly ["update", "delete"];
+                        readonly member: readonly ["create", "update", "delete"];
+                        readonly invitation: readonly ["create", "cancel"];
+                        readonly team: readonly ["create", "update", "delete"];
+                        readonly ac: readonly ["create", "read", "update", "delete"];
+                    })]?: ((O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                        readonly organization: readonly ["update", "delete"];
+                        readonly member: readonly ["create", "update", "delete"];
+                        readonly invitation: readonly ["create", "cancel"];
+                        readonly team: readonly ["create", "update", "delete"];
+                        readonly ac: readonly ["create", "read", "update", "delete"];
+                    })[key] extends readonly unknown[] ? (O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                        readonly organization: readonly ["update", "delete"];
+                        readonly member: readonly ["create", "update", "delete"];
+                        readonly invitation: readonly ["create", "cancel"];
+                        readonly team: readonly ["create", "update", "delete"];
+                        readonly ac: readonly ["create", "read", "update", "delete"];
+                    })[key][number] : never)[] | undefined; };
+                    permissions?: never | undefined;
+                } | {
+                    permissions: { [key in keyof (O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                        readonly organization: readonly ["update", "delete"];
+                        readonly member: readonly ["create", "update", "delete"];
+                        readonly invitation: readonly ["create", "cancel"];
+                        readonly team: readonly ["create", "update", "delete"];
+                        readonly ac: readonly ["create", "read", "update", "delete"];
+                    })]?: ((O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                        readonly organization: readonly ["update", "delete"];
+                        readonly member: readonly ["create", "update", "delete"];
+                        readonly invitation: readonly ["create", "cancel"];
+                        readonly team: readonly ["create", "update", "delete"];
+                        readonly ac: readonly ["create", "read", "update", "delete"];
+                    })[key] extends readonly unknown[] ? (O["ac"] extends AccessControl<infer S extends import("../access").Statements> ? S : {
+                        readonly organization: readonly ["update", "delete"];
+                        readonly member: readonly ["create", "update", "delete"];
+                        readonly invitation: readonly ["create", "cancel"];
+                        readonly team: readonly ["create", "update", "delete"];
+                        readonly ac: readonly ["create", "read", "update", "delete"];
+                    })[key][number] : never)[] | undefined; };
+                    permission?: never | undefined;
+                }) & {
+                    organizationId?: string | undefined;
+                };
+            };
+            openapi: {
+                description: string;
+                requestBody: {
+                    content: {
+                        "application/json": {
+                            schema: {
+                                type: "object";
+                                properties: {
+                                    permission: {
+                                        type: string;
+                                        description: string;
+                                        deprecated: boolean;
+                                    };
+                                    permissions: {
+                                        type: string;
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                };
+                responses: {
+                    "200": {
+                        description: string;
+                        content: {
+                            "application/json": {
+                                schema: {
+                                    type: "object";
+                                    properties: {
+                                        error: {
+                                            type: string;
+                                        };
+                                        success: {
+                                            type: string;
+                                        };
+                                    };
+                                    required: string[];
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    } & {
+        use: any[];
+    };
+    path: "/organization/has-permission";
+};
+export type OrganizationPlugin<O extends OrganizationOptions> = {
+    id: "organization";
+    endpoints: OrganizationEndpoints<O> & (O extends {
+        teams: {
+            enabled: true;
+        };
+    } ? TeamEndpoints<O> : {}) & (O extends {
+        dynamicAccessControl: {
+            enabled: true;
+        };
+    } ? DynamicAccessControlEndpoints<O> : {});
+    schema: OrganizationSchema<O>;
+    $Infer: {
+        Organization: InferOrganization<O>;
+        Invitation: InferInvitation<O>;
+        Member: InferMember<O>;
+        Team: O["teams"] extends {
+            enabled: true;
+        } ? Team : any;
+        TeamMember: O["teams"] extends {
+            enabled: true;
+        } ? TeamMember : any;
+        ActiveOrganization: Awaited<ReturnType<ReturnType<typeof getFullOrganization<O>>>>;
+    };
+    $ERROR_CODES: typeof ORGANIZATION_ERROR_CODES;
+    options: O;
+};
+/**
+ * Organization plugin for Payvo Auth. Organization allows you to create teams, members,
+ * and manage access control for your users.
+ *
+ * @example
+ * ```ts
+ * const auth = payvoAuth({
+ *  plugins: [
+ *    organization({
+ *      allowUserToCreateOrganization: true,
+ *    }),
+ *  ],
+ * });
+ * ```
+ */
+export declare function organization<O extends OrganizationOptions & {
+    teams: {
+        enabled: true;
+    };
+}>(options?: O | undefined): {
+    id: "organization";
+    endpoints: OrganizationEndpoints<O> & TeamEndpoints<O>;
+    schema: OrganizationSchema<O>;
+    $Infer: {
+        Organization: InferOrganization<O>;
+        Invitation: InferInvitation<O>;
+        Member: InferMember<O>;
+        Team: O["teams"] extends {
+            enabled: true;
+        } ? Team : any;
+        TeamMember: O["teams"] extends {
+            enabled: true;
+        } ? TeamMember : any;
+        ActiveOrganization: Awaited<ReturnType<ReturnType<typeof getFullOrganization<O>>>>;
+    };
+    $ERROR_CODES: typeof ORGANIZATION_ERROR_CODES;
+    options: O;
+};
+export declare function organization<O extends OrganizationOptions & {
+    teams: {
+        enabled: true;
+    };
+    dynamicAccessControl: {
+        enabled: true;
+    };
+}>(options?: O | undefined): {
+    id: "organization";
+    endpoints: OrganizationEndpoints<O> & TeamEndpoints<O> & DynamicAccessControlEndpoints<O>;
+    schema: OrganizationSchema<O>;
+    $Infer: {
+        Organization: InferOrganization<O>;
+        Invitation: InferInvitation<O>;
+        Member: InferMember<O>;
+        Team: O["teams"] extends {
+            enabled: true;
+        } ? Team : any;
+        TeamMember: O["teams"] extends {
+            enabled: true;
+        } ? TeamMember : any;
+        ActiveOrganization: Awaited<ReturnType<ReturnType<typeof getFullOrganization<O>>>>;
+    };
+    $ERROR_CODES: typeof ORGANIZATION_ERROR_CODES;
+    options: O;
+};
+export declare function organization<O extends OrganizationOptions & {
+    dynamicAccessControl: {
+        enabled: true;
+    };
+}>(options?: O | undefined): {
+    id: "organization";
+    endpoints: OrganizationEndpoints<O> & DynamicAccessControlEndpoints<O>;
+    schema: OrganizationSchema<O>;
+    $Infer: {
+        Organization: InferOrganization<O>;
+        Invitation: InferInvitation<O>;
+        Member: InferMember<O>;
+        Team: O["teams"] extends {
+            enabled: true;
+        } ? Team : any;
+        TeamMember: O["teams"] extends {
+            enabled: true;
+        } ? TeamMember : any;
+        ActiveOrganization: Awaited<ReturnType<ReturnType<typeof getFullOrganization<O>>>>;
+    };
+    $ERROR_CODES: typeof ORGANIZATION_ERROR_CODES;
+    options: O;
+};
+export declare function organization<O extends OrganizationOptions>(options?: O | undefined): {
+    id: "organization";
+    endpoints: OrganizationEndpoints<O>;
+    schema: OrganizationSchema<O>;
+    $Infer: {
+        Organization: InferOrganization<O>;
+        Invitation: InferInvitation<O>;
+        Member: InferMember<O>;
+        Team: O["teams"] extends {
+            enabled: true;
+        } ? Team : any;
+        TeamMember: O["teams"] extends {
+            enabled: true;
+        } ? TeamMember : any;
+        ActiveOrganization: Awaited<ReturnType<ReturnType<typeof getFullOrganization<O>>>>;
+    };
+    $ERROR_CODES: typeof ORGANIZATION_ERROR_CODES;
+    options: O;
+};
+export {};

package/dist/src/plugins/organization/permission.d.ts

@@ -0,0 +1,27 @@
+import type { Role } from "../access";
+import type { OrganizationOptions } from "./types";
+export declare const hasPermissionFn: (input: HasPermissionBaseInput, acRoles: {
+    [x: string]: Role<any> | undefined;
+}) => boolean;
+export type PermissionExclusive = {
+    /**
+     * @deprecated Use `permissions` instead
+     */
+    permission: {
+        [key: string]: string[];
+    };
+    permissions?: never | undefined;
+} | {
+    permissions: {
+        [key: string]: string[];
+    };
+    permission?: never | undefined;
+};
+export declare let cacheAllRoles: Map<string, {
+    [x: string]: Role<any> | undefined;
+}>;
+export type HasPermissionBaseInput = {
+    role: string;
+    options: OrganizationOptions;
+    allowCreatorAllPermissions?: boolean | undefined;
+} & PermissionExclusive;