@hexclave/js 1.0.2 → 1.0.5

package/src/lib/hexclave-app/apps/interfaces/admin-app.ts

@@ -0,0 +1,189 @@
+
+//===========================================
+// THIS FILE IS AUTO-GENERATED FROM TEMPLATE. DO NOT EDIT IT DIRECTLY UNLESS YOU ALSO EDIT THE CORRESPONDING FILE IN packages/template
+//===========================================
+import { AnalyticsQueryOptions, AnalyticsQueryResponse } from "@hexclave/shared/dist/interface/crud/analytics";
+import type { AdminGetSessionReplayChunkEventsResponse, AdminGetSessionReplayAllEventsResponse } from "@hexclave/shared/dist/interface/crud/session-replays";
+import type { Transaction, TransactionType } from "@hexclave/shared/dist/interface/crud/transactions";
+import { InternalSession } from "@hexclave/shared/dist/sessions";
+import type { MoneyAmount } from "@hexclave/shared/dist/utils/currency-constants";
+import { Result } from "@hexclave/shared/dist/utils/results";
+import { AsyncStoreProperty, EmailConfig } from "../../common";
+import { AdminEmailOutbox, AdminSentEmail } from "../../email";
+import { InternalApiKey, InternalApiKeyCreateOptions, InternalApiKeyFirstView } from "../../internal-api-keys";
+import { AdminProjectPermission, AdminProjectPermissionDefinition, AdminProjectPermissionDefinitionCreateOptions, AdminProjectPermissionDefinitionUpdateOptions, AdminTeamPermission, AdminTeamPermissionDefinition, AdminTeamPermissionDefinitionCreateOptions, AdminTeamPermissionDefinitionUpdateOptions } from "../../permissions";
+import { AdminProject } from "../../projects";
+import { _HexclaveAdminAppImpl } from "../implementations";
+import { StackServerApp, StackServerAppConstructorOptions } from "./server-app";
+
+export type EmailOutboxListOptions = {
+  status?: string,
+  simpleStatus?: string,
+  limit?: number,
+  cursor?: string,
+};
+
+export type EmailOutboxListResult = {
+  items: AdminEmailOutbox[],
+  nextCursor: string | null,
+};
+
+export type EmailOutboxUpdateOptions = {
+  isPaused?: boolean,
+  scheduledAtMillis?: number,
+  cancel?: boolean,
+  tsxSource?: string,
+  themeId?: string | null,
+};
+
+export type ManagedEmailProviderSetupResult = {
+  domainId: string,
+  subdomain: string,
+  senderLocalPart: string,
+  nameServerRecords: string[],
+  status: ManagedEmailProviderStatus["status"],
+};
+
+export type ManagedEmailProviderStatus = {
+  status: "pending_dns" | "pending_verification" | "verified" | "applied" | "failed",
+};
+
+export type ManagedEmailProviderListItem = {
+  domainId: string,
+  subdomain: string,
+  senderLocalPart: string,
+  status: ManagedEmailProviderStatus["status"],
+  nameServerRecords: string[],
+};
+
+import type { AdminSessionReplay, ListSessionReplayChunksOptions, ListSessionReplayChunksResult, ListSessionReplaysOptions, ListSessionReplaysResult, SessionReplayAllEventsResult } from "../../session-replays";
+export type { AdminSessionReplay, AdminSessionReplayChunk, ListSessionReplaysOptions, ListSessionReplaysResult, ListSessionReplayChunksOptions, ListSessionReplayChunksResult, SessionReplayAllEventsResult } from "../../session-replays";
+
+
+/** @deprecated Use `HexclaveAdminAppConstructorOptions` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackAdminAppConstructorOptions<HasTokenStore extends boolean, ProjectId extends string> = (
+  & StackServerAppConstructorOptions<HasTokenStore, ProjectId>
+  & {
+    superSecretAdminKey?: string,
+    projectOwnerSession?: InternalSession | (() => Promise<string | null>),
+  }
+);
+
+
+/** @deprecated Use `HexclaveAdminApp` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackAdminApp<HasTokenStore extends boolean = boolean, ProjectId extends string = string> = (
+  & AsyncStoreProperty<"project", [], AdminProject, false>
+  & AsyncStoreProperty<"internalApiKeys", [], InternalApiKey[], true>
+  & AsyncStoreProperty<"teamPermissionDefinitions", [], AdminTeamPermissionDefinition[], true>
+  & AsyncStoreProperty<"projectPermissionDefinitions", [], AdminProjectPermissionDefinition[], true>
+  & AsyncStoreProperty<"emailThemes", [], { id: string, displayName: string }[], true>
+  & AsyncStoreProperty<"emailPreview", [{ themeId?: string | null | false, themeTsxSource?: string, templateId?: string, templateTsxSource?: string }], string, false>
+  & AsyncStoreProperty<"emailTemplates", [], { id: string, displayName: string, themeId?: string, tsxSource: string }[], true>
+  & AsyncStoreProperty<"emailDrafts", [], { id: string, displayName: string, themeId: string | undefined | false, tsxSource: string, sentAt: Date | null }[], true>
+  & AsyncStoreProperty<"stripeAccountInfo", [], { account_id: string, charges_enabled: boolean, details_submitted: boolean, payouts_enabled: boolean } | null, false>
+  & AsyncStoreProperty<
+    "transactions",
+    [{
+      cursor?: string,
+      limit?: number,
+      type?: TransactionType,
+      customerType?: 'user' | 'team' | 'custom',
+      customerId?: string,
+    }],
+    { transactions: Transaction[], nextCursor: string | null },
+    true
+  >
+  & {
+    createInternalApiKey(options: InternalApiKeyCreateOptions): Promise<InternalApiKeyFirstView>,
+
+    createTeamPermissionDefinition(data: AdminTeamPermissionDefinitionCreateOptions): Promise<AdminTeamPermission>,
+    updateTeamPermissionDefinition(permissionId: string, data: AdminTeamPermissionDefinitionUpdateOptions): Promise<void>,
+    deleteTeamPermissionDefinition(permissionId: string): Promise<void>,
+    /**
+     * @param options.query Free-text search; matches against permission ID and description.
+     */
+    listTeamPermissionDefinitionsPaginated(options: { limit: number, cursor?: string, query?: string }): Promise<{ items: AdminTeamPermissionDefinition[], nextCursor: string | null }>,
+
+    createProjectPermissionDefinition(data: AdminProjectPermissionDefinitionCreateOptions): Promise<AdminProjectPermission>,
+    updateProjectPermissionDefinition(permissionId: string, data: AdminProjectPermissionDefinitionUpdateOptions): Promise<void>,
+    deleteProjectPermissionDefinition(permissionId: string): Promise<void>,
+
+
+    sendTestEmail(options: {
+      recipientEmail: string,
+      emailConfig: EmailConfig,
+    }): Promise<Result<undefined, { errorMessage: string }>>,
+
+    sendTestWebhook(options: { endpointId: string }): Promise<Result<undefined, { errorMessage: string }>>,
+
+    sendSignInInvitationEmail(email: string, callbackUrl: string): Promise<void>,
+
+    listSentEmails(): Promise<AdminSentEmail[]>,
+    setupManagedEmailProvider(options: { subdomain: string, senderLocalPart: string }): Promise<ManagedEmailProviderSetupResult>,
+    checkManagedEmailStatus(options: { domainId: string, subdomain: string, senderLocalPart: string }): Promise<ManagedEmailProviderStatus>,
+    listManagedEmailDomains(): Promise<ManagedEmailProviderListItem[]>,
+    applyManagedEmailProvider(options: { domainId: string }): Promise<{ status: "applied" }>,
+    deleteManagedEmailDomain(options: { resendDomainId: string }): Promise<{ status: "deleted" }>,
+
+    createEmailTheme(displayName: string): Promise<{ id: string }>,
+    updateEmailTheme(id: string, tsxSource: string): Promise<void>,
+    deleteEmailTheme(id: string): Promise<void>,
+    saveChatMessage(threadId: string, message: any): Promise<void>,
+    listChatMessages(threadId: string): Promise<{ messages: Array<any> }>,
+    rewriteTemplateSourceWithAI(templateTsxSource: string): Promise<{ tsxSource: string }>,
+    updateEmailTemplate(id: string, tsxSource: string, themeId: string | null | false): Promise<{ renderedHtml: string }>,
+    createEmailTemplate(displayName: string): Promise<{ id: string }>,
+    deleteEmailTemplate(id: string): Promise<void>,
+
+    setupPayments(): Promise<{ url: string }>,
+    createStripeWidgetAccountSession(): Promise<{ client_secret: string }>,
+    getPaymentMethodConfigs(): Promise<{ configId: string, methods: Array<{ id: string, name: string, enabled: boolean, available: boolean, overridable: boolean }> } | null>,
+    updatePaymentMethodConfigs(configId: string, updates: Record<string, 'on' | 'off'>): Promise<void>,
+    createEmailDraft(options: { displayName: string, themeId?: string | undefined | false, tsxSource?: string }): Promise<{ id: string }>,
+    updateEmailDraft(id: string, data: { displayName?: string, themeId?: string | undefined | false, tsxSource?: string }): Promise<void>,
+    deleteEmailDraft(id: string): Promise<void>,
+    refreshEmailDrafts(): Promise<void>,
+    createItemQuantityChange(options: (
+      { userId: string, itemId: string, quantity: number, expiresAt?: string, description?: string } |
+      { teamId: string, itemId: string, quantity: number, expiresAt?: string, description?: string } |
+      { customCustomerId: string, itemId: string, quantity: number, expiresAt?: string, description?: string }
+    )): Promise<void>,
+    refundTransaction(options: {
+      type: "subscription" | "one-time-purchase",
+      id: string,
+      invoiceId?: string,
+      amountUsd: MoneyAmount,
+      endAction?: "now" | "at-period-end",
+    }): Promise<{ refundTransactionId: string }>,
+    queryAnalytics(options: AnalyticsQueryOptions): Promise<AnalyticsQueryResponse>,
+
+    listSessionReplays(options?: ListSessionReplaysOptions): Promise<ListSessionReplaysResult>,
+    getSessionReplay(sessionReplayId: string): Promise<AdminSessionReplay>,
+    listSessionReplayChunks(sessionReplayId: string, options?: ListSessionReplayChunksOptions): Promise<ListSessionReplayChunksResult>,
+    getSessionReplayChunkEvents(sessionReplayId: string, chunkId: string): Promise<AdminGetSessionReplayChunkEventsResponse>,
+    getSessionReplayEvents(sessionReplayId: string, options?: { offset?: number, limit?: number }): Promise<SessionReplayAllEventsResult>,
+
+    // Email Outbox methods
+    listOutboxEmails(options?: EmailOutboxListOptions): Promise<EmailOutboxListResult>,
+    getOutboxEmail(id: string): Promise<AdminEmailOutbox>,
+    updateOutboxEmail(id: string, options: EmailOutboxUpdateOptions): Promise<AdminEmailOutbox>,
+    pauseOutboxEmail(id: string): Promise<AdminEmailOutbox>,
+    unpauseOutboxEmail(id: string): Promise<AdminEmailOutbox>,
+    cancelOutboxEmail(id: string): Promise<AdminEmailOutbox>,
+  }
+  & StackServerApp<HasTokenStore, ProjectId>
+);
+/** @deprecated Use `HexclaveAdminAppConstructor` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackAdminAppConstructor = {
+  new <
+    HasTokenStore extends boolean,
+    ProjectId extends string
+  >(options: StackAdminAppConstructorOptions<HasTokenStore, ProjectId>): StackAdminApp<HasTokenStore, ProjectId>,
+  new(options: StackAdminAppConstructorOptions<boolean, string>): StackAdminApp<boolean, string>,
+};
+export type HexclaveAdminAppConstructorOptions<HasTokenStore extends boolean, ProjectId extends string> = StackAdminAppConstructorOptions<HasTokenStore, ProjectId>;
+export type HexclaveAdminApp<HasTokenStore extends boolean = boolean, ProjectId extends string = string> = StackAdminApp<HasTokenStore, ProjectId>;
+export type HexclaveAdminAppConstructor = StackAdminAppConstructor;
+export const HexclaveAdminApp: HexclaveAdminAppConstructor = _HexclaveAdminAppImpl;
+/** @deprecated Use `HexclaveAdminApp` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export const StackAdminApp: StackAdminAppConstructor = HexclaveAdminApp;

package/src/lib/hexclave-app/apps/interfaces/client-app.ts

@@ -0,0 +1,172 @@
+
+//===========================================
+// THIS FILE IS AUTO-GENERATED FROM TEMPLATE. DO NOT EDIT IT DIRECTLY UNLESS YOU ALSO EDIT THE CORRESPONDING FILE IN packages/template
+//===========================================
+import { KnownErrors } from "@hexclave/shared";
+import { CurrentUserCrud } from "@hexclave/shared/dist/interface/crud/current-user";
+import { Result } from "@hexclave/shared/dist/utils/results";
+import { AsyncStoreProperty, AuthLike, GetCurrentPartialUserOptions, GetCurrentUserOptions, HandlerUrlOptions, HandlerUrls, OAuthScopesOnSignIn, RedirectMethod, RedirectToOptions, ResolvedHandlerUrls, hexclaveAppInternalsSymbol, TokenStoreInit } from "../../common";
+import type { RequestListener } from "@hexclave/shared/dist/interface/client-interface";
+import { CustomerInvoicesList, CustomerInvoicesRequestOptions, CustomerProductsList, CustomerProductsRequestOptions, Item } from "../../customers";
+import { Project } from "../../projects";
+import { ProjectCurrentUser, SyncedPartialUser, TokenPartialUser } from "../../users";
+import { _HexclaveClientAppImpl } from "../implementations";
+import { AnalyticsOptions } from "../implementations/session-replay";
+
+/** @deprecated Use `HexclaveClientAppConstructorOptions` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackClientAppConstructorOptions<HasTokenStore extends boolean, ProjectId extends string> = {
+  baseUrl?: string | { browser: string, server: string },
+  extraRequestHeaders?: Record<string, string>,
+  projectId?: ProjectId,
+  publishableClientKey?: string,
+  urls?: HandlerUrlOptions,
+  oauthScopesOnSignIn?: Partial<OAuthScopesOnSignIn>,
+  tokenStore?: TokenStoreInit<HasTokenStore>,
+  redirectMethod?: RedirectMethod,
+  inheritsFrom?: StackClientApp<any, any>,
+
+  /**
+   * Whether to show the Hexclave dev tool indicator in browser-like development environments.
+   *
+   * Defaults to true.
+   */
+  devTool?: boolean,
+
+  /**
+   * By default, the Stack app will automatically prefetch some data from Stack's server when this app is first
+   * constructed. This improves the performance of your app, but will create network requests that are unnecessary if
+   * the app is never used or disposed of immediately. To disable this behavior, set this option to true.
+   */
+  noAutomaticPrefetch?: boolean,
+
+  /**
+   * Options for analytics and session recording. Replays are disabled by default;
+   * set `{ replays: { enabled: true } }` to opt in.
+   */
+  analytics?: AnalyticsOptions,
+} & (
+  { tokenStore: TokenStoreInit<HasTokenStore> } | { tokenStore?: undefined, inheritsFrom: StackClientApp<HasTokenStore, any> }
+) & (
+  string extends ProjectId ? unknown : ({ projectId: ProjectId } | { inheritsFrom: StackClientApp<any, ProjectId> })
+);
+
+
+/** @deprecated Use `HexclaveClientAppJson` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackClientAppJson<HasTokenStore extends boolean, ProjectId extends string> = StackClientAppConstructorOptions<HasTokenStore, ProjectId> & { inheritsFrom?: undefined } & {
+  uniqueIdentifier: string,
+  // note: if you add more fields here, make sure to ensure the checkString in the constructor has/doesn't have them
+};
+
+/** @deprecated Use `HexclaveClientApp` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackClientApp<HasTokenStore extends boolean = boolean, ProjectId extends string = string> = (
+  & {
+    readonly projectId: ProjectId,
+
+    /**
+     * The version of the Hexclave SDK.
+     */
+    readonly version: string,
+
+    /**
+     * @deprecated `app.urls` is static and does not include runtime redirect-back parameters.
+     * For navigation, prefer `redirectToXyz()` methods (for example `redirectToSignIn()`).
+     */
+    readonly urls: Readonly<ResolvedHandlerUrls>,
+
+    signInWithOAuth(provider: string, options?: { returnTo?: string }): Promise<void>,
+    signInWithCredential(options: { email: string, password: string, noRedirect?: boolean }): Promise<Result<undefined, KnownErrors["EmailPasswordMismatch"] | KnownErrors["InvalidTotpCode"]>>,
+    signUpWithCredential(options: {
+      email: string,
+      password: string,
+      noRedirect?: boolean,
+    } & ({ noVerificationCallback: true } | { noVerificationCallback?: false, verificationCallbackUrl?: string })): Promise<Result<undefined, KnownErrors["UserWithEmailAlreadyExists"] | KnownErrors["PasswordRequirementsNotMet"] | KnownErrors["BotChallengeFailed"]>>,
+    signInWithPasskey(): Promise<Result<undefined, KnownErrors["PasskeyAuthenticationFailed"] | KnownErrors["InvalidTotpCode"] | KnownErrors["PasskeyWebAuthnError"]>>,
+    callOAuthCallback(): Promise<boolean>,
+    promptCliLogin(options: { appUrl: string, expiresInMillis?: number, anonRefreshToken?: string, promptLink?: (url: string, loginCode: string) => void }): Promise<Result<string, KnownErrors["CliAuthError"] | KnownErrors["CliAuthExpiredError"] | KnownErrors["CliAuthUsedError"]>>,
+    sendForgotPasswordEmail(email: string, options?: { callbackUrl?: string }): Promise<Result<undefined, KnownErrors["UserNotFound"]>>,
+    sendMagicLinkEmail(email: string, options?: { callbackUrl?: string }): Promise<Result<{ nonce: string }, KnownErrors["RedirectUrlNotWhitelisted"] | KnownErrors["BotChallengeFailed"]>>,
+    resetPassword(options: { code: string, password: string }): Promise<Result<undefined, KnownErrors["VerificationCodeError"]>>,
+    verifyPasswordResetCode(code: string): Promise<Result<undefined, KnownErrors["VerificationCodeError"]>>,
+    verifyTeamInvitationCode(code: string): Promise<Result<undefined, KnownErrors["VerificationCodeError"] | KnownErrors["TeamInvitationEmailMismatch"]>>,
+    acceptTeamInvitation(code: string): Promise<Result<undefined, KnownErrors["VerificationCodeError"] | KnownErrors["TeamInvitationEmailMismatch"]>>,
+    getTeamInvitationDetails(code: string): Promise<Result<{ teamDisplayName: string }, KnownErrors["VerificationCodeError"] | KnownErrors["TeamInvitationEmailMismatch"]>>,
+    verifyEmail(code: string): Promise<Result<undefined, KnownErrors["VerificationCodeError"]>>,
+    signInWithMagicLink(code: string, options?: { noRedirect?: boolean }): Promise<Result<undefined, KnownErrors["VerificationCodeError"] | KnownErrors["InvalidTotpCode"]>>,
+    signInWithMfa(otp: string, code: string, options?: { noRedirect?: boolean }): Promise<Result<undefined, KnownErrors["VerificationCodeError"] | KnownErrors["InvalidTotpCode"]>>,
+
+    redirectToOAuthCallback(): Promise<void>,
+
+    getConvexClientAuth(options: HasTokenStore extends false ? { tokenStore: TokenStoreInit } : { tokenStore?: TokenStoreInit }): (args: { forceRefreshToken: boolean }) => Promise<string | null>,
+    getConvexHttpClientAuth(options: { tokenStore: TokenStoreInit }): Promise<string>,
+
+
+    getUser(options: GetCurrentUserOptions<HasTokenStore> & { or: 'redirect' }): Promise<ProjectCurrentUser<ProjectId>>,
+    getUser(options: GetCurrentUserOptions<HasTokenStore> & { or: 'throw' }): Promise<ProjectCurrentUser<ProjectId>>,
+    getUser(options: GetCurrentUserOptions<HasTokenStore> & { or: 'anonymous' }): Promise<ProjectCurrentUser<ProjectId>>,
+    getUser(options?: GetCurrentUserOptions<HasTokenStore>): Promise<ProjectCurrentUser<ProjectId> | null>,
+
+    cancelSubscription(options: { productId: string, subscriptionId?: string } | { productId: string, subscriptionId?: string, teamId: string }): Promise<void>,
+
+    // note: we don't special-case 'anonymous' here to return non-null, see GetPartialUserOptions for more details
+    getPartialUser(options: GetCurrentPartialUserOptions<HasTokenStore> & { from: 'token' }): Promise<TokenPartialUser | null>,
+    getPartialUser(options: GetCurrentPartialUserOptions<HasTokenStore> & { from: 'convex' }): Promise<TokenPartialUser | null>,
+    getPartialUser(options: GetCurrentPartialUserOptions<HasTokenStore>): Promise<SyncedPartialUser | TokenPartialUser | null>,
+
+    [hexclaveAppInternalsSymbol]: {
+      toClientJson(): StackClientAppJson<HasTokenStore, ProjectId>,
+      setCurrentUser(userJsonPromise: Promise<CurrentUserCrud['Client']['Read'] | null>): void,
+      getConstructorOptions(): StackClientAppConstructorOptions<HasTokenStore, ProjectId> & { inheritsFrom?: undefined },
+      sendSessionReplayBatch(body: string, options: { keepalive: boolean }): Promise<Result<Response, Error>>,
+      sendAnalyticsEventBatch(body: string, options: { keepalive: boolean }): Promise<Result<Response, Error>>,
+      addRequestListener(listener: RequestListener): () => void,
+      sendRequest(path: string, requestOptions: RequestInit, requestType?: "client" | "server" | "admin"): Promise<Response>,
+      getRedirectMethod(): RedirectMethod,
+      redirectToUrl(url: string | URL, options?: { replace?: boolean }): Promise<void>,
+      redirectToHandler(handlerName: keyof HandlerUrls, options?: RedirectToOptions): Promise<void>,
+      signInWithTokens(tokens: { accessToken: string, refreshToken: string }): Promise<void>,
+    },
+  }
+  & AsyncStoreProperty<"project", [], Project, false>
+  & AsyncStoreProperty<
+    "item",
+    [{ itemId: string, userId: string } | { itemId: string, teamId: string } | { itemId: string, customCustomerId: string }],
+    Item,
+    false
+  >
+  & AsyncStoreProperty<
+    "products",
+    [options: CustomerProductsRequestOptions],
+    CustomerProductsList,
+    true
+  >
+  & AsyncStoreProperty<
+    "invoices",
+    [options: CustomerInvoicesRequestOptions],
+    CustomerInvoicesList,
+    true
+  >
+  & { [K in `redirectTo${Capitalize<keyof Omit<HandlerUrls, 'handler' | 'oauthCallback'>>}`]: (options?: RedirectToOptions) => Promise<void> }
+  & AuthLike<HasTokenStore extends false ? { tokenStore: TokenStoreInit } : { tokenStore?: TokenStoreInit }>
+);
+/** @deprecated Use `HexclaveClientAppConstructor` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackClientAppConstructor = {
+  new <
+    TokenStoreType extends string,
+    HasTokenStore extends (TokenStoreType extends {} ? true : boolean),
+    ProjectId extends string
+  >(options: StackClientAppConstructorOptions<HasTokenStore, ProjectId>): StackClientApp<HasTokenStore, ProjectId>,
+  new(options: StackClientAppConstructorOptions<boolean, string>): StackClientApp<boolean, string>,
+
+  [hexclaveAppInternalsSymbol]: {
+    fromClientJson<HasTokenStore extends boolean, ProjectId extends string>(
+      json: StackClientAppJson<HasTokenStore, ProjectId>
+    ): StackClientApp<HasTokenStore, ProjectId>,
+  },
+};
+export type HexclaveClientAppConstructorOptions<HasTokenStore extends boolean, ProjectId extends string> = StackClientAppConstructorOptions<HasTokenStore, ProjectId>;
+export type HexclaveClientAppJson<HasTokenStore extends boolean, ProjectId extends string> = StackClientAppJson<HasTokenStore, ProjectId>;
+export type HexclaveClientApp<HasTokenStore extends boolean = boolean, ProjectId extends string = string> = StackClientApp<HasTokenStore, ProjectId>;
+export type HexclaveClientAppConstructor = StackClientAppConstructor;
+export const HexclaveClientApp: HexclaveClientAppConstructor = _HexclaveClientAppImpl;
+/** @deprecated Use `HexclaveClientApp` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export const StackClientApp: StackClientAppConstructor = HexclaveClientApp;

package/src/lib/hexclave-app/apps/interfaces/server-app.ts

@@ -0,0 +1,114 @@
+
+//===========================================
+// THIS FILE IS AUTO-GENERATED FROM TEMPLATE. DO NOT EDIT IT DIRECTLY UNLESS YOU ALSO EDIT THE CORRESPONDING FILE IN packages/template
+//===========================================
+import { KnownErrors } from "@hexclave/shared";
+import { Result } from "@hexclave/shared/dist/utils/results";
+import type { GenericQueryCtx } from "convex/server";
+import { AsyncStoreProperty, GetCurrentPartialUserOptions, GetCurrentUserOptions } from "../../common";
+import { CustomerProductsList, CustomerProductsRequestOptions, InlineProduct, ServerItem } from "../../customers";
+import { DataVaultStore } from "../../data-vault";
+import { EmailDeliveryInfo, SendEmailOptions } from "../../email";
+import { ServerListTeamsOptions, ServerListUsersOptions, ServerTeam, ServerTeamCreateOptions } from "../../teams";
+import { ProjectCurrentServerUser, ServerOAuthProvider, ServerUser, ServerUserCreateOptions, SyncedPartialServerUser, TokenPartialUser } from "../../users";
+import { _HexclaveServerAppImpl } from "../implementations";
+import { StackClientApp, StackClientAppConstructorOptions } from "./client-app";
+
+
+/** @deprecated Use `HexclaveServerAppConstructorOptions` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackServerAppConstructorOptions<HasTokenStore extends boolean, ProjectId extends string> = StackClientAppConstructorOptions<HasTokenStore, ProjectId> & {
+  secretServerKey?: string,
+};
+
+/** @deprecated Use `HexclaveServerApp` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackServerApp<HasTokenStore extends boolean = boolean, ProjectId extends string = string> = (
+  & {
+    createTeam(data: ServerTeamCreateOptions): Promise<ServerTeam>,
+    /**
+     * @deprecated use `getUser()` instead
+     */
+    getServerUser(): Promise<ProjectCurrentServerUser<ProjectId> | null>,
+
+    createUser(options: ServerUserCreateOptions): Promise<ServerUser>,
+    grantProduct(options: (
+      ({ userId: string } | { teamId: string } | { customCustomerId: string }) &
+      ({ productId: string } | { product: InlineProduct }) &
+      { quantity?: number }
+    )): Promise<void>,
+
+
+    getUser(options: GetCurrentUserOptions<HasTokenStore> & { or: 'redirect' }): Promise<ProjectCurrentServerUser<ProjectId>>,
+    getUser(options: GetCurrentUserOptions<HasTokenStore> & { or: 'throw' }): Promise<ProjectCurrentServerUser<ProjectId>>,
+    getUser(options: GetCurrentUserOptions<HasTokenStore> & { or: 'anonymous' }): Promise<ProjectCurrentServerUser<ProjectId>>,
+    getUser(options?: GetCurrentUserOptions<HasTokenStore>): Promise<ProjectCurrentServerUser<ProjectId> | null>,
+    getUser(id: string): Promise<ServerUser | null>,
+    getUser(options: { apiKey: string, or?: "return-null" | "anonymous" }): Promise<ServerUser | null>,
+    getUser(options: { from: "convex", ctx: GenericQueryCtx<any>, or?: "return-null" | "anonymous" }): Promise<ServerUser | null>,
+
+    // note: we don't special-case 'anonymous' here to return non-null, see GetPartialUserOptions for more details
+    getPartialUser(options: GetCurrentPartialUserOptions<HasTokenStore> & { from: 'token' }): Promise<TokenPartialUser | null>,
+    getPartialUser(options: GetCurrentPartialUserOptions<HasTokenStore> & { from: 'convex' }): Promise<TokenPartialUser | null>,
+    getPartialUser(options: GetCurrentPartialUserOptions<HasTokenStore>): Promise<SyncedPartialServerUser | TokenPartialUser | null>,
+    getTeam(id: string): Promise<ServerTeam | null>,
+    getTeam(options: { apiKey: string }): Promise<ServerTeam | null>,
+
+
+    listUsers(options?: ServerListUsersOptions): Promise<ServerUser[] & { nextCursor: string | null }>,
+
+    /**
+     * Returns every direct (or recursive) team permission grant for every
+     * member of the given team in one request. Use this instead of calling
+     * `user.listPermissions(team)` per row when rendering a roster — that
+     * pattern produces an N+1 over the team-member endpoint.
+     */
+    listTeamMemberPermissions(teamId: string, options?: { recursive?: boolean }): Promise<{ userId: string, permissionId: string }[]>,
+
+    // TODO this should actually be on ServerUser
+    createOAuthProvider(options: {
+      userId: string,
+      accountId: string,
+      providerConfigId: string,
+      email: string,
+      allowSignIn: boolean,
+      allowConnectedAccounts: boolean,
+    }): Promise<Result<ServerOAuthProvider, InstanceType<typeof KnownErrors.OAuthProviderAccountIdAlreadyUsedForSignIn>>>,
+
+    sendEmail(options: SendEmailOptions): Promise<void>,
+
+    getEmailDeliveryStats(): Promise<EmailDeliveryInfo>,
+
+    activateEmailCapacityBoost(): Promise<void>,
+  }
+  & AsyncStoreProperty<"user", [id: string], ServerUser | null, false>
+  & Omit<AsyncStoreProperty<"users", [], ServerUser[], true>, "listUsers" | "useUsers">
+  & AsyncStoreProperty<"teams", [options?: ServerListTeamsOptions], ServerTeam[] & { nextCursor: string | null }, true>
+  & AsyncStoreProperty<"dataVaultStore", [id: string], DataVaultStore, false>
+  & AsyncStoreProperty<
+    "item",
+    [{ itemId: string, userId: string } | { itemId: string, teamId: string } | { itemId: string, customCustomerId: string }],
+    ServerItem,
+    false
+  >
+  & AsyncStoreProperty<
+    "products",
+    [options: CustomerProductsRequestOptions],
+    CustomerProductsList,
+    true
+  >
+  & StackClientApp<HasTokenStore, ProjectId>
+);
+/** @deprecated Use `HexclaveServerAppConstructor` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export type StackServerAppConstructor = {
+  new <
+    TokenStoreType extends string,
+    HasTokenStore extends (TokenStoreType extends {} ? true : boolean),
+    ProjectId extends string
+  >(options: StackServerAppConstructorOptions<HasTokenStore, ProjectId>): StackServerApp<HasTokenStore, ProjectId>,
+  new (options: StackServerAppConstructorOptions<boolean, string>): StackServerApp<boolean, string>,
+};
+export type HexclaveServerAppConstructorOptions<HasTokenStore extends boolean, ProjectId extends string> = StackServerAppConstructorOptions<HasTokenStore, ProjectId>;
+export type HexclaveServerApp<HasTokenStore extends boolean = boolean, ProjectId extends string = string> = StackServerApp<HasTokenStore, ProjectId>;
+export type HexclaveServerAppConstructor = StackServerAppConstructor;
+export const HexclaveServerApp: HexclaveServerAppConstructor = _HexclaveServerAppImpl;
+/** @deprecated Use `HexclaveServerApp` from the `@hexclave/*` package instead — same symbol, new brand name. See https://docs.hexclave.com/migration. */
+export const StackServerApp: StackServerAppConstructor = HexclaveServerApp;