@robelest/convex-auth 0.0.4-preview.13 → 0.0.4-preview.15

package/dist/server/domains/core.d.ts

@@ -0,0 +1,320 @@
+import { AuthProviderConfig, KeyDoc, KeyScope, ScopeChecker, UserOrderBy, UserWhere } from "../types.js";
+import { Auth, GenericActionCtx, GenericDataModel } from "convex/server";
+import { GenericId } from "convex/values";
+
+//#region src/server/domains/core.d.ts
+type ComponentCtx = Pick<GenericActionCtx<GenericDataModel>, "runQuery" | "runMutation">;
+type ComponentReadCtx = Pick<GenericActionCtx<GenericDataModel>, "runQuery">;
+type ComponentAuthReadCtx = ComponentReadCtx & {
+  auth: Auth;
+};
+type AccountCredentials = {
+  id: string;
+  secret?: string;
+};
+type CreateAccountArgs = {
+  provider: string;
+  account: AccountCredentials;
+  profile: Record<string, unknown>;
+  shouldLinkViaEmail?: boolean;
+  shouldLinkViaPhone?: boolean;
+};
+type RetrieveAccountArgs = {
+  provider: string;
+  account: AccountCredentials;
+};
+type UpdateAccountCredentialsArgs = {
+  provider: string;
+  account: {
+    id: string;
+    secret: string;
+  };
+};
+type CoreDeps = {
+  config: any;
+  getAuth: () => any;
+  callInvalidateSessions: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: {
+    userId: GenericId<"User">;
+    except?: GenericId<"Session">[];
+  }) => Promise<void>;
+  callCreateAccountFromCredentials: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: CreateAccountArgs) => Promise<any>;
+  callRetrieveAccountWithCredentials: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: RetrieveAccountArgs) => Promise<any>;
+  callModifyAccount: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: UpdateAccountCredentialsArgs) => Promise<void>;
+  getEnrichCtx: () => <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>) => any;
+  inviteTokenAlphabet: string;
+  inviteTokenLength: number;
+};
+/**
+ * Build the core auth domains that back the canonical app API surface.
+ */
+declare function createCoreDomains(deps: CoreDeps): {
+  user: {
+    current: (ctx: {
+      auth: Auth;
+    } & Partial<ComponentCtx>, request?: Request) => Promise<string | null>;
+    require: (ctx: {
+      auth: Auth;
+    } & Partial<ComponentCtx>, request?: Request) => Promise<string>;
+    get: (ctx: ComponentReadCtx, userId: string) => Promise<any>;
+    list: (ctx: ComponentReadCtx, opts?: {
+      where?: UserWhere;
+      limit?: number;
+      cursor?: string | null;
+      orderBy?: UserOrderBy;
+      order?: "asc" | "desc";
+    }) => Promise<any>;
+    viewer: (ctx: ComponentAuthReadCtx) => Promise<any>;
+    patch: (ctx: ComponentCtx, userId: string, data: Record<string, unknown>) => Promise<void>;
+    setActiveGroup: (ctx: ComponentCtx, opts: {
+      userId: string;
+      groupId: string | null;
+    }) => Promise<void>;
+    getActiveGroup: (ctx: ComponentReadCtx, opts: {
+      userId: string;
+    }) => Promise<string | null>;
+    remove: (ctx: ComponentCtx, userId: string, opts?: {
+      cascade?: boolean;
+    }) => Promise<void>;
+  };
+  session: {
+    current: (ctx: {
+      auth: Auth;
+    }) => Promise<GenericId<"Session"> | null>;
+    invalidate: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: {
+      userId: GenericId<"User">;
+      except?: GenericId<"Session">[];
+    }) => Promise<void>;
+    get: (ctx: ComponentReadCtx, sessionId: string) => Promise<any>;
+    list: (ctx: ComponentReadCtx, opts: {
+      userId: string;
+    }) => Promise<any>;
+  };
+  account: {
+    create: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: CreateAccountArgs) => Promise<any>;
+    get: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: RetrieveAccountArgs) => Promise<any>;
+    update: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, args: UpdateAccountCredentialsArgs) => Promise<void>;
+    remove: (ctx: ComponentCtx, accountId: string) => Promise<void>;
+    listPasskeys: (ctx: ComponentReadCtx, opts: {
+      userId: string;
+    }) => Promise<any>;
+    renamePasskey: (ctx: ComponentCtx, passkeyId: string, name: string) => Promise<void>;
+    removePasskey: (ctx: ComponentCtx, passkeyId: string) => Promise<void>;
+    listTotps: (ctx: ComponentReadCtx, opts: {
+      userId: string;
+    }) => Promise<any>;
+    removeTotp: (ctx: ComponentCtx, totpId: string) => Promise<void>;
+  };
+  provider: {
+    signIn: <DataModel extends GenericDataModel>(ctx: GenericActionCtx<DataModel>, providerConfig: AuthProviderConfig, args: {
+      accountId?: GenericId<"Account">;
+      params?: Record<string, unknown>;
+    }) => Promise<{
+      userId: GenericId<"User">;
+      sessionId: GenericId<"Session">;
+    } | null>;
+  };
+  group: {
+    create: (ctx: ComponentCtx, data: {
+      name: string;
+      slug?: string;
+      type?: string;
+      parentGroupId?: string;
+      tags?: Array<{
+        key: string;
+        value: string;
+      }>;
+      extend?: Record<string, unknown>;
+    }) => Promise<string>;
+    get: (ctx: ComponentReadCtx, groupId: string) => Promise<any>;
+    list: (ctx: ComponentReadCtx, opts?: {
+      where?: {
+        slug?: string;
+        type?: string;
+        parentGroupId?: string;
+        name?: string;
+        isRoot?: boolean;
+        tagsAll?: Array<{
+          key: string;
+          value: string;
+        }>;
+        tagsAny?: Array<{
+          key: string;
+          value: string;
+        }>;
+      };
+      limit?: number;
+      cursor?: string | null;
+      orderBy?: "_creationTime" | "name" | "slug" | "type";
+      order?: "asc" | "desc";
+    }) => Promise<any>;
+    update: (ctx: ComponentCtx, groupId: string, data: Record<string, unknown>) => Promise<void>;
+    delete: (ctx: ComponentCtx, groupId: string) => Promise<void>;
+    ancestors: (ctx: ComponentReadCtx, opts: {
+      groupId: string;
+      maxDepth?: number;
+      includeSelf?: boolean;
+    }) => Promise<{
+      ancestors: any[];
+      cycleDetected: boolean;
+      maxDepthReached: boolean;
+    }>;
+  };
+  member: {
+    add: (ctx: ComponentCtx, data: {
+      groupId: string;
+      userId: string;
+      role?: string;
+      status?: string;
+      extend?: Record<string, unknown>;
+    }) => Promise<string>;
+    get: (ctx: ComponentReadCtx, memberId: string) => Promise<any>;
+    getByUserAndGroup: (ctx: ComponentReadCtx, opts: {
+      userId: string;
+      groupId: string;
+    }) => Promise<any>;
+    list: (ctx: ComponentReadCtx, opts?: {
+      where?: {
+        groupId?: string;
+        userId?: string;
+        role?: string;
+        status?: string;
+      };
+      limit?: number;
+      cursor?: string | null;
+      orderBy?: "_creationTime" | "role" | "status";
+      order?: "asc" | "desc";
+    }) => Promise<any>;
+    remove: (ctx: ComponentCtx, memberId: string) => Promise<void>;
+    update: (ctx: ComponentCtx, memberId: string, data: Record<string, unknown>) => Promise<void>;
+    inherit: (ctx: ComponentReadCtx, opts: {
+      userId: string;
+      groupId: string;
+      roles?: string[];
+      maxDepth?: number;
+    }) => Promise<{
+      requestedGroupId: string;
+      matchedGroupId: string;
+      membership: any;
+      depth: number;
+      isDirect: boolean;
+      isInherited: boolean;
+      traversedGroupIds: string[];
+      cycleDetected: boolean;
+      maxDepthReached: boolean;
+    } | {
+      requestedGroupId: string;
+      matchedGroupId: null;
+      membership: null;
+      depth: null;
+      isDirect: boolean;
+      isInherited: boolean;
+      traversedGroupIds: string[];
+      cycleDetected: boolean;
+      maxDepthReached: boolean;
+    }>;
+    require: (ctx: ComponentReadCtx, opts: {
+      userId: string;
+      groupId: string;
+      roles?: string[];
+      maxDepth?: number;
+    }) => Promise<{
+      membership: any;
+      matchedGroupId: string | null;
+      isDirect: boolean;
+      isInherited: boolean;
+      depth: number | null;
+    }>;
+  };
+  invite: {
+    create: (ctx: ComponentCtx, data: {
+      groupId?: string;
+      invitedByUserId?: string;
+      email?: string;
+      role?: string;
+      expiresTime?: number;
+      extend?: Record<string, unknown>;
+    }) => Promise<{
+      inviteId: string;
+      token: string;
+    }>;
+    get: (ctx: ComponentReadCtx, inviteId: string) => Promise<any>;
+    token: {
+      get: (ctx: ComponentReadCtx, token: string) => Promise<any>;
+      accept: (ctx: ComponentCtx, args: {
+        token: string;
+        acceptedByUserId: string;
+      }) => Promise<any>;
+    };
+    list: (ctx: ComponentReadCtx, opts?: {
+      where?: {
+        tokenHash?: string;
+        groupId?: string;
+        status?: "pending" | "accepted" | "revoked" | "expired";
+        email?: string;
+        invitedByUserId?: string;
+        role?: string;
+        acceptedByUserId?: string;
+      };
+      limit?: number;
+      cursor?: string | null;
+      orderBy?: "_creationTime" | "status" | "email" | "expiresTime" | "acceptedTime";
+      order?: "asc" | "desc";
+    }) => Promise<any>;
+    accept: (ctx: ComponentCtx, inviteId: string, acceptedByUserId?: string) => Promise<void>;
+    revoke: (ctx: ComponentCtx, inviteId: string) => Promise<void>;
+  };
+  key: {
+    create: (ctx: ComponentCtx, opts: {
+      userId: string;
+      name: string;
+      scopes: KeyScope[];
+      rateLimit?: {
+        maxRequests: number;
+        windowMs: number;
+      };
+      expiresAt?: number;
+      metadata?: Record<string, unknown>;
+    }) => Promise<{
+      keyId: string;
+      raw: string;
+    }>;
+    verify: (ctx: ComponentCtx, rawKey: string) => Promise<{
+      userId: string;
+      keyId: string;
+      scopes: ScopeChecker;
+    }>;
+    list: (ctx: ComponentReadCtx, opts?: {
+      where?: {
+        userId?: string;
+        revoked?: boolean;
+        name?: string;
+        prefix?: string;
+      };
+      limit?: number;
+      cursor?: string | null;
+      orderBy?: "_creationTime" | "name" | "lastUsedAt" | "expiresAt" | "revoked";
+      order?: "asc" | "desc";
+    }) => Promise<any>;
+    get: (ctx: ComponentReadCtx, keyId: string) => Promise<KeyDoc | null>;
+    update: (ctx: ComponentCtx, keyId: string, data: {
+      name?: string;
+      scopes?: KeyScope[];
+      rateLimit?: {
+        maxRequests: number;
+        windowMs: number;
+      };
+    }) => Promise<void>;
+    revoke: (ctx: ComponentCtx, keyId: string) => Promise<void>;
+    remove: (ctx: ComponentCtx, keyId: string) => Promise<void>;
+    rotate: (ctx: ComponentCtx, keyId: string, opts?: {
+      name?: string;
+      expiresAt?: number;
+    }) => Promise<{
+      keyId: string;
+      raw: string;
+    }>;
+  };
+};
+//#endregion
+export { createCoreDomains };
+//# sourceMappingURL=core.d.ts.map

package/dist/server/domains/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","names":[],"sources":["../../../src/server/domains/core.ts"],"mappings":";;;;;KA0BK,YAAA,GAAe,IAAA,CAClB,gBAAA,CAAiB,gBAAA;AAAA,KAGd,gBAAA,GAAmB,IAAA,CAAK,gBAAA,CAAiB,gBAAA;AAAA,KACzC,oBAAA,GAAuB,gBAAA;EAAqB,IAAA,EAAM,IAAA;AAAA;AAAA,KAClD,kBAAA;EAAuB,EAAA;EAAY,MAAA;AAAA;AAAA,KACnC,iBAAA;EACH,QAAA;EACA,OAAA,EAAS,kBAAA;EACT,OAAA,EAAS,MAAA;EACT,kBAAA;EACA,kBAAA;AAAA;AAAA,KAEG,mBAAA;EAAwB,QAAA;EAAkB,OAAA,EAAS,kBAAA;AAAA;AAAA,KACnD,4BAAA;EACH,QAAA;EACA,OAAA;IAAW,EAAA;IAAY,MAAA;EAAA;AAAA;AAAA,KAGpB,QAAA;EACH,MAAA;EACA,OAAA;EACA,sBAAA,qBAA2C,gBAAA,EACzC,GAAA,EAAK,gBAAA,CAAiB,SAAA,GACtB,IAAA;IAAQ,MAAA,EAAQ,SAAA;IAAmB,MAAA,GAAS,SAAA;EAAA,MACzC,OAAA;EACL,gCAAA,qBAAqD,gBAAA,EACnD,GAAA,EAAK,gBAAA,CAAiB,SAAA,GACtB,IAAA,EAAM,iBAAA,KACH,OAAA;EACL,kCAAA,qBAAuD,gBAAA,EACrD,GAAA,EAAK,gBAAA,CAAiB,SAAA,GACtB,IAAA,EAAM,mBAAA,KACH,OAAA;EACL,iBAAA,qBAAsC,gBAAA,EACpC,GAAA,EAAK,gBAAA,CAAiB,SAAA,GACtB,IAAA,EAAM,4BAAA,KACH,OAAA;EACL,YAAA,2BAAuC,gBAAA,EACrC,GAAA,EAAK,gBAAA,CAAiB,SAAA;EAExB,mBAAA;EACA,iBAAA;AAAA;;AArC4C;;iBA2C9B,iBAAA,CAAkB,IAAA,EAAM,QAAA;;;MAe3B,IAAA,EAAM,IAAA;IAAA,IAAS,OAAA,CAAQ,YAAA,GAAa,OAAA,GACjC,OAAA,KACT,OAAA;;MAwBM,IAAA,EAAM,IAAA;IAAA,IAAS,OAAA,CAAQ,YAAA,GAAa,OAAA,GACjC,OAAA,KACT,OAAA;eAOc,gBAAA,EAAgB,MAAA,aAAgB,OAAA;gBAM1C,gBAAA,EAAgB,IAAA;MAEnB,KAAA,GAAQ,SAAA;MACR,KAAA;MACA,MAAA;MACA,OAAA,GAAU,WAAA;MACV,KAAA;IAAA,MACD,OAAA;kBAIiB,oBAAA,KAAoB,OAAA;iBAQjC,YAAA,EAAY,MAAA,UACH,IAAA,EACR,MAAA,sBAAuB,OAAA;0BAQxB,YAAA,EAAY,IAAA;MACT,MAAA;MAAgB,OAAA;IAAA,MAAwB,OAAA;0BAoB3C,gBAAA,EAAgB,IAAA;MACb,MAAA;IAAA,MACP,OAAA;kBAcI,YAAA,EAAY,MAAA,UACH,IAAA;MACL,OAAA;IAAA,MACR,OAAA;EAAA;;;MA6EoB,IAAA,EAAM,IAAA;IAAA,MAAM,OAAA,CAAA,SAAA;mCAME,gBAAA,EAAgB,GAAA,EAC9C,gBAAA,CAAiB,SAAA,GAAU,IAAA;MACxB,MAAA,EAAQ,SAAA;MAAmB,MAAA,GAAS,SAAA;IAAA,MAAwB,OAAA;eAErD,gBAAA,EAAgB,SAAA,aAAmB,OAAA;gBAKlC,gBAAA,EAAgB,IAAA;MAAU,MAAA;IAAA,MAAgB,OAAA;EAAA;;+BAQ3B,gBAAA,EAAgB,GAAA,EAC1C,gBAAA,CAAiB,SAAA,GAAU,IAAA,EAC1B,iBAAA,KAAiB,OAAA;4BAIK,gBAAA,EAAgB,GAAA,EACvC,gBAAA,CAAiB,SAAA,GAAU,IAAA,EAC1B,mBAAA,KAAmB,OAAA;+BAQM,gBAAA,EAAgB,GAAA,EAC1C,gBAAA,CAAiB,SAAA,GAAU,IAAA,EAC1B,4BAAA,KACL,OAAA;kBAGiB,YAAA,EAAY,SAAA,aAAsB,OAAA;wBAwB5B,gBAAA,EAAgB,IAAA;MAAU,MAAA;IAAA,MAAgB,OAAA;yBAO7D,YAAA,EAAY,SAAA,UACA,IAAA,aACL,OAAA;yBAOa,YAAA,EAAY,SAAA,aAAmB,OAAA;qBAKnC,gBAAA,EAAgB,IAAA;MAAU,MAAA;IAAA,MAAgB,OAAA;sBAGzC,YAAA,EAAY,MAAA,aAAgB,OAAA;EAAA;;+BAMnB,gBAAA,EAAgB,GAAA,EAC1C,gBAAA,CAAiB,SAAA,GAAU,cAAA,EAChB,kBAAA,EAAkB,IAAA;MAEhC,SAAA,GAAY,SAAA;MACZ,MAAA,GAAS,MAAA;IAAA,MACV,OAAA;;;;;;kBAwBI,YAAA,EAAY,IAAA;MAEf,IAAA;MACA,IAAA;MACA,IAAA;MACA,aAAA;MACA,IAAA,GAAO,KAAA;QAAQ,GAAA;QAAa,KAAA;MAAA;MAC5B,MAAA,GAAS,MAAA;IAAA,MAEV,OAAA;eAMc,gBAAA,EAAgB,OAAA,aAAiB,OAAA;gBAI3C,gBAAA,EAAgB,IAAA;MAEnB,KAAA;QACE,IAAA;QACA,IAAA;QACA,aAAA;QACA,IAAA;QACA,MAAA;QACA,OAAA,GAAU,KAAA;UAAQ,GAAA;UAAa,KAAA;QAAA;QAC/B,OAAA,GAAU,KAAA;UAAQ,GAAA;UAAa,KAAA;QAAA;MAAA;MAEjC,KAAA;MACA,MAAA;MACA,OAAA;MACA,KAAA;IAAA,MACD,OAAA;kBAWI,YAAA,EAAY,OAAA,UACF,IAAA,EACT,MAAA,sBAAuB,OAAA;kBAOX,YAAA,EAAY,OAAA,aAAiB,OAAA;qBAI1C,gBAAA,EAAgB,IAAA;MACb,OAAA;MAAiB,QAAA;MAAmB,WAAA;IAAA,MAAuB,OAAA;;;;;;;eAuC9D,YAAA,EAAY,IAAA;MAEf,OAAA;MACA,MAAA;MACA,IAAA;MACA,MAAA;MACA,MAAA,GAAS,MAAA;IAAA,MAEV,OAAA;eAMc,gBAAA,EAAgB,QAAA,aAAkB,OAAA;6BAM5C,gBAAA,EAAgB,IAAA;MACb,MAAA;MAAgB,OAAA;IAAA,MAAiB,OAAA;gBAQpC,gBAAA,EAAgB,IAAA;MAEnB,KAAA;QACE,OAAA;QACA,MAAA;QACA,IAAA;QACA,MAAA;MAAA;MAEF,KAAA;MACA,MAAA;MACA,OAAA;MACA,KAAA;IAAA,MACD,OAAA;kBAUiB,YAAA,EAAY,QAAA,aAAkB,OAAA;kBAI3C,YAAA,EAAY,QAAA,UACD,IAAA,EACV,MAAA,sBAAuB,OAAA;mBAQxB,gBAAA,EAAgB,IAAA;MAEnB,MAAA;MACA,OAAA;MACA,KAAA;MACA,QAAA;IAAA,MACD,OAAA;;;;;;;;;;;;;;;;;;;;;mBA8DI,gBAAA,EAAgB,IAAA;MAEnB,MAAA;MACA,OAAA;MACA,KAAA;MACA,QAAA;IAAA,MACD,OAAA;;;;;;;;;kBAqBI,YAAA,EAAY,IAAA;MAEf,OAAA;MACA,eAAA;MACA,KAAA;MACA,IAAA;MACA,WAAA;MACA,MAAA,GAAS,MAAA;IAAA,MAEV,OAAA;MAAU,QAAA;MAAkB,KAAA;IAAA;eAYd,gBAAA,EAAgB,QAAA,aAAkB,OAAA;;iBAMhC,gBAAA,EAAgB,KAAA,aAAe,OAAA;oBAQzC,YAAA,EAAY,IAAA;QACT,KAAA;QAAe,gBAAA;MAAA,MAA0B,OAAA;IAAA;gBAU9C,gBAAA,EAAgB,IAAA;MAEnB,KAAA;QACE,SAAA;QACA,OAAA;QACA,MAAA;QACA,KAAA;QACA,eAAA;QACA,IAAA;QACA,gBAAA;MAAA;MAEF,KAAA;MACA,MAAA;MACA,OAAA;MAMA,KAAA;IAAA,MACD,OAAA;kBAWI,YAAA,EAAY,QAAA,UACD,gBAAA,cACS,OAAA;kBAOP,YAAA,EAAY,QAAA,aAAkB,OAAA;EAAA;;kBAO3C,YAAA,EAAY,IAAA;MAEf,MAAA;MACA,IAAA;MACA,MAAA,EAAQ,QAAA;MACR,SAAA;QAAc,WAAA;QAAqB,QAAA;MAAA;MACnC,SAAA;MACA,QAAA,GAAW,MAAA;IAAA,MAEZ,OAAA;MAAU,KAAA;MAAe,GAAA;IAAA;kBAerB,YAAA,EAAY,MAAA,aAEhB,OAAA;MAAU,MAAA;MAAgB,KAAA;MAAe,MAAA,EAAQ,YAAA;IAAA;gBA0C7C,gBAAA,EAAgB,IAAA;MAEnB,KAAA;QACE,MAAA;QACA,OAAA;QACA,IAAA;QACA,MAAA;MAAA;MAEF,KAAA;MACA,MAAA;MACA,OAAA;MAMA,KAAA;IAAA,MACD,OAAA;eAWI,gBAAA,EAAgB,KAAA,aAEpB,OAAA,CAAQ,MAAA;kBAMJ,YAAA,EAAY,KAAA,UACJ,IAAA;MAEX,IAAA;MACA,MAAA,GAAS,QAAA;MACT,SAAA;QAAc,WAAA;QAAqB,QAAA;MAAA;IAAA,MACpC,OAAA;kBAIiB,YAAA,EAAY,KAAA,aAAe,OAAA;kBAM3B,YAAA,EAAY,KAAA,aAAe,OAAA;kBAIxC,YAAA,EAAY,KAAA,UACJ,IAAA;MACJ,IAAA;MAAe,SAAA;IAAA,MACvB,OAAA;MAAU,KAAA;MAAe,GAAA;IAAA;EAAA;AAAA"}