@hexclave/js 1.0.2 → 1.0.5

package/src/lib/hexclave-app/projects/index.ts

@@ -0,0 +1,234 @@
+
+//===========================================
+// THIS FILE IS AUTO-GENERATED FROM TEMPLATE. DO NOT EDIT IT DIRECTLY UNLESS YOU ALSO EDIT THE CORRESPONDING FILE IN packages/template
+//===========================================
+import { ProductionModeError } from "@hexclave/shared/dist/helpers/production-mode";
+import { AdminUserProjectsCrud, ProjectsCrud } from "@hexclave/shared/dist/interface/crud/projects";
+import { ProjectOnboardingStatus } from "@hexclave/shared/dist/schema-fields";
+
+import { CompleteConfig, EnvironmentConfigNormalizedOverride, EnvironmentConfigOverrideOverride } from "@hexclave/shared/dist/config/schema";
+import { StackAdminApp } from "../apps/interfaces/admin-app";
+import { AdminProjectConfig, AdminProjectConfigUpdateOptions, ProjectConfig } from "../project-configs";
+
+/**
+ * SDK type for pushed config source (camelCase for SDK).
+ * Represents where the branch config was pushed from.
+ */
+export type PushedConfigSource =
+  | { type: "pushed-from-github", owner: string, repo: string, branch: string, commitHash: string, configFilePath: string, workflowPath?: string }
+  | { type: "pushed-from-unknown" }
+  | { type: "unlinked" };
+
+export type PushConfigOptions = {
+  /**
+   * The source of this config push.
+   */
+  source: PushedConfigSource,
+};
+
+
+export type Project = {
+  readonly id: string,
+  readonly displayName: string,
+  readonly config: ProjectConfig,
+};
+
+export type AdminProject = {
+  readonly id: string,
+  readonly displayName: string,
+  readonly description: string | null,
+  readonly createdAt: Date,
+  readonly isProductionMode: boolean,
+  readonly isDevelopmentEnvironment: boolean,
+  readonly ownerTeamId: string | null,
+  readonly onboardingStatus: ProjectOnboardingStatus,
+  readonly logoUrl: string | null | undefined,
+  readonly logoFullUrl: string | null | undefined,
+  readonly logoDarkModeUrl: string | null | undefined,
+  readonly logoFullDarkModeUrl: string | null | undefined,
+
+  readonly config: AdminProjectConfig,
+
+  update(this: AdminProject, update: AdminProjectUpdateOptions): Promise<void>,
+  delete(this: AdminProject): Promise<void>,
+
+  getConfig(this: AdminProject): Promise<CompleteConfig>,
+
+  /**
+   * Updates the environment's config by merging the provided config into the existing config.
+   *
+   * Changes made with `updateConfig` always take precedence over those made with `pushConfig`, even if the `pushConfig`
+   * config was pushed after the changes were made with `updateConfig`. This is best for environment-specific
+   * configuration like secrets, API keys, and other values that you wouldn't push into a source repository.
+   */
+  // We have some strict types here in order to prevent accidental overwriting of a top-level property of a config object
+  updateConfig(
+    this: AdminProject,
+    config: EnvironmentConfigOverrideOverride,
+  ): Promise<void>,
+
+  /**
+   * Pushes a config, replacing any previous config pushed with `pushConfig`.
+   *
+   * **Note:** This function does **not** replace any changes made with `updateConfig`. Changes made with
+   * `updateConfig` always take precedence over those made with `pushConfig`, even if the `pushConfig`
+   * config was pushed after the changes were made with `updateConfig`.
+   *
+   * This is useful for programmatically deploying configuration. More often than not, you'll want to use
+   * `updateConfig` instead.
+   */
+  pushConfig(
+    this: AdminProject,
+    config: EnvironmentConfigOverrideOverride,
+    options: PushConfigOptions,
+  ): Promise<void>,
+
+  /**
+   * Updates the pushed config by merging the provided config into the existing pushed config.
+   *
+   * **Warning:** This is almost always **not** the function you want to call. Changes made with
+   * `updatePushedConfig` will be replaced entirely the next time `pushConfig` is called. Consider using
+   * `pushConfig` to set the full pushed config, or `updateConfig` for environment-specific values that
+   * should persist across pushes.
+   *
+   * This function is useful for making temporary modifications to the pushed config before the next push.
+   */
+  updatePushedConfig(
+    this: AdminProject,
+    config: EnvironmentConfigOverrideOverride
+  ): Promise<void>,
+
+  /**
+   * Gets the source metadata for the pushed config, indicating where it was pushed from.
+   *
+   * The source can be:
+   * - `pushed-from-github`: Config was pushed from a GitHub repository
+   * - `pushed-from-unknown`: Config was pushed via CLI but source details unknown
+   * - `unlinked`: Config can be edited directly on the dashboard
+   */
+  getPushedConfigSource(this: AdminProject): Promise<PushedConfigSource>,
+
+  /**
+   * Unlinks the pushed config source, setting it to "unlinked".
+   * This allows the config to be edited directly on the dashboard without external push restrictions.
+   */
+  unlinkPushedConfigSource(this: AdminProject): Promise<void>,
+
+  /**
+   * Resets (removes) specific keys from the config override at the specified level.
+   * Uses the same nested key logic as the override algorithm: resetting key "a.b" also resets "a.b.c".
+   *
+   * This is useful when updating the pushed config (branch level) and wanting to remove the same keys
+   * from the environment config override so that the branch config values take precedence.
+   */
+  resetConfigOverrideKeys(this: AdminProject, level: "branch" | "environment", keys: string[]): Promise<void>,
+
+  /**
+   * Gets the raw config override at the specified level (before merging/defaults).
+   * Useful for inspecting exactly what's been set at each level.
+   */
+  getConfigOverride(this: AdminProject, level: "branch" | "environment"): Promise<Record<string, unknown>>,
+
+  /**
+   * Replaces the entire config override at the specified level.
+   * For branch level, preserves the existing source metadata.
+   */
+  replaceConfigOverride(this: AdminProject, level: "branch" | "environment", config: Record<string, unknown>): Promise<void>,
+
+  getProductionModeErrors(this: AdminProject): Promise<ProductionModeError[]>,
+} & Project;
+
+export type AdminOwnedProject = {
+  readonly app: StackAdminApp<false>,
+} & AdminProject;
+
+export type AdminProjectUpdateOptions = {
+  displayName?: string,
+  description?: string,
+  isProductionMode?: boolean,
+  onboardingStatus?: ProjectOnboardingStatus,
+  /**
+   * Updates `project.requirePublishableClientKey` in the project-level config override.
+   */
+  requirePublishableClientKey?: boolean,
+  logoUrl?: string | null,
+  logoFullUrl?: string | null,
+  logoDarkModeUrl?: string | null,
+  logoFullDarkModeUrl?: string | null,
+  config?: AdminProjectConfigUpdateOptions,
+};
+export function adminProjectUpdateOptionsToCrud(options: AdminProjectUpdateOptions): ProjectsCrud["Admin"]["Update"] {
+  return {
+    display_name: options.displayName,
+    description: options.description,
+    is_production_mode: options.isProductionMode,
+    onboarding_status: options.onboardingStatus,
+    logo_url: options.logoUrl,
+    logo_full_url: options.logoFullUrl,
+    logo_dark_mode_url: options.logoDarkModeUrl,
+    logo_full_dark_mode_url: options.logoFullDarkModeUrl,
+    /**
+     * NOTE: Do not update this config anymore. It's been superseded by the new config in schema.ts.
+     * @deprecated
+     */
+    config: {
+      domains: options.config?.domains?.map((d) => ({
+        domain: d.domain,
+        handler_path: d.handlerPath
+      })),
+      oauth_providers: options.config?.oauthProviders?.map((p) => ({
+        id: p.id as any,
+        type: p.type,
+        ...(p.type === 'standard' && {
+          client_id: p.clientId,
+          client_secret: p.clientSecret,
+          facebook_config_id: p.facebookConfigId,
+          microsoft_tenant_id: p.microsoftTenantId,
+          apple_bundle_ids: p.appleBundleIds,
+        }),
+      })),
+      email_config: options.config?.emailConfig && (
+        options.config.emailConfig.type === 'shared' ? {
+          type: 'shared',
+        } : {
+          type: 'standard',
+          host: options.config.emailConfig.host,
+          port: options.config.emailConfig.port,
+          username: options.config.emailConfig.username,
+          password: options.config.emailConfig.password,
+          sender_name: options.config.emailConfig.senderName,
+          sender_email: options.config.emailConfig.senderEmail,
+        }
+      ),
+      email_theme: options.config?.emailTheme,
+      sign_up_enabled: options.config?.signUpEnabled,
+      credential_enabled: options.config?.credentialEnabled,
+      magic_link_enabled: options.config?.magicLinkEnabled,
+      passkey_enabled: options.config?.passkeyEnabled,
+      allow_localhost: options.config?.allowLocalhost,
+      create_team_on_sign_up: options.config?.createTeamOnSignUp,
+      client_team_creation_enabled: options.config?.clientTeamCreationEnabled,
+      client_user_deletion_enabled: options.config?.clientUserDeletionEnabled,
+      team_creator_default_permissions: options.config?.teamCreatorDefaultPermissions,
+      team_member_default_permissions: options.config?.teamMemberDefaultPermissions,
+      user_default_permissions: options.config?.userDefaultPermissions,
+      oauth_account_merge_strategy: options.config?.oauthAccountMergeStrategy,
+      allow_user_api_keys: options.config?.allowUserApiKeys,
+      allow_team_api_keys: options.config?.allowTeamApiKeys,
+    },
+  };
+}
+
+export type AdminProjectCreateOptions = Omit<AdminProjectUpdateOptions, 'displayName'> & {
+  displayName: string,
+  teamId: string,
+  isDevelopmentEnvironment?: boolean,
+};
+export function adminProjectCreateOptionsToCrud(options: AdminProjectCreateOptions): AdminUserProjectsCrud["Server"]["Create"] {
+  return {
+    ...adminProjectUpdateOptionsToCrud(options),
+    display_name: options.displayName,
+    is_development_environment: options.isDevelopmentEnvironment,
+    owner_team_id: options.teamId,
+  };
+}

package/src/lib/hexclave-app/session-replays/index.ts

@@ -0,0 +1,72 @@
+
+//===========================================
+// THIS FILE IS AUTO-GENERATED FROM TEMPLATE. DO NOT EDIT IT DIRECTLY UNLESS YOU ALSO EDIT THE CORRESPONDING FILE IN packages/template
+//===========================================
+export type AdminSessionReplay = {
+  id: string,
+  projectUser: {
+    id: string,
+    displayName: string | null,
+    primaryEmail: string | null,
+  },
+  startedAt: Date,
+  lastEventAt: Date,
+  chunkCount: number,
+  eventCount: number,
+};
+
+export type AdminSessionReplayChunk = {
+  id: string,
+  batchId: string,
+  sessionReplaySegmentId: string | null,
+  browserSessionId: string | null,
+  eventCount: number,
+  byteLength: number,
+  firstEventAt: Date,
+  lastEventAt: Date,
+  createdAt: Date,
+};
+
+export type ListSessionReplaysOptions = {
+  limit?: number,
+  cursor?: string,
+  userIds?: string[],
+  teamIds?: string[],
+  durationMsMin?: number,
+  durationMsMax?: number,
+  lastEventAtFromMillis?: number,
+  lastEventAtToMillis?: number,
+  clickCountMin?: number,
+};
+
+export type ListSessionReplaysResult = {
+  items: AdminSessionReplay[],
+  nextCursor: string | null,
+};
+
+export type ListSessionReplayChunksOptions = {
+  limit?: number,
+  cursor?: string,
+};
+
+export type ListSessionReplayChunksResult = {
+  items: AdminSessionReplayChunk[],
+  nextCursor: string | null,
+};
+
+export type SessionReplayAllEventsResult = {
+  chunks: Array<{
+    id: string,
+    batchId: string,
+    sessionReplaySegmentId: string | null,
+    eventCount: number,
+    byteLength: number,
+    firstEventAt: Date,
+    lastEventAt: Date,
+    createdAt: Date,
+  }>,
+  chunkEvents: Array<{
+    chunkId: string,
+    events: unknown[],
+  }>,
+};

package/src/lib/hexclave-app/teams/index.ts

@@ -0,0 +1,203 @@
+
+//===========================================
+// THIS FILE IS AUTO-GENERATED FROM TEMPLATE. DO NOT EDIT IT DIRECTLY UNLESS YOU ALSO EDIT THE CORRESPONDING FILE IN packages/template
+//===========================================
+import { TeamsCrud } from "@hexclave/shared/dist/interface/crud/teams";
+import { ReadonlyJson } from "@hexclave/shared/dist/utils/json";
+
+import { ApiKeyCreationOptions, TeamApiKey, TeamApiKeyFirstView } from "../api-keys";
+import { AsyncStoreProperty } from "../common";
+import { Customer } from "../customers";
+import { ServerUser } from "../users";
+
+
+export type TeamMemberProfile = {
+  displayName: string | null,
+  profileImageUrl: string | null,
+}
+
+export type TeamMemberProfileUpdateOptions = {
+  displayName?: string,
+  profileImageUrl?: string | null,
+};
+
+export type EditableTeamMemberProfile = TeamMemberProfile & {
+  update(update: TeamMemberProfileUpdateOptions): Promise<void>,
+}
+
+export type TeamUser = {
+  id: string,
+  teamProfile: TeamMemberProfile,
+}
+
+/**
+ * A team invitation as seen from the team's perspective (ie. the sender).
+ *
+ * Returned by `team.listInvitations()`. Contains the recipient email and allows
+ * revoking the invitation.
+ */
+export type SentTeamInvitation = {
+  id: string,
+  recipientEmail: string | null,
+  expiresAt: Date,
+  revoke(): Promise<void>,
+}
+
+/**
+ * @deprecated Use `SentTeamInvitation` instead.
+ */
+export type TeamInvitation = SentTeamInvitation;
+
+/**
+ * A team invitation as seen from the invited user's perspective (ie. the receiver).
+ *
+ * Returned by `user.listTeamInvitations()`. Contains information about teams that have
+ * sent invitations to any of the user's verified email addresses, and allows accepting
+ * the invitation to join the team.
+ */
+export type ReceivedTeamInvitation = {
+  id: string,
+  teamId: string,
+  teamDisplayName: string,
+  recipientEmail: string,
+  expiresAt: Date,
+
+  /**
+   * Accepts the invitation, adding the current user to the team.
+   *
+   * The user must have a verified email address matching the invitation's recipient email.
+   */
+  accept(): Promise<void>,
+}
+
+export type Team = {
+  id: string,
+  displayName: string,
+  profileImageUrl: string | null,
+  clientMetadata: any,
+  clientReadOnlyMetadata: any,
+  inviteUser(options: { email: string, callbackUrl?: string }): Promise<void>,
+  listUsers(): Promise<TeamUser[]>,
+  listInvitations(): Promise<SentTeamInvitation[]>,
+  update(update: TeamUpdateOptions): Promise<void>,
+  delete(): Promise<void>,
+  createApiKey(options: ApiKeyCreationOptions<"team">): Promise<TeamApiKeyFirstView>,
+} & AsyncStoreProperty<"apiKeys", [], TeamApiKey[], true> & Customer;
+
+export type TeamUpdateOptions = {
+  displayName?: string,
+  profileImageUrl?: string | null,
+  clientMetadata?: ReadonlyJson,
+};
+export function teamUpdateOptionsToCrud(options: TeamUpdateOptions): TeamsCrud["Client"]["Update"] {
+  return {
+    display_name: options.displayName,
+    profile_image_url: options.profileImageUrl,
+    client_metadata: options.clientMetadata,
+  };
+}
+
+export type TeamCreateOptions = {
+  displayName: string,
+  profileImageUrl?: string,
+}
+export function teamCreateOptionsToCrud(options: TeamCreateOptions, creatorUserId: string): TeamsCrud["Client"]["Create"] {
+  return {
+    display_name: options.displayName,
+    profile_image_url: options.profileImageUrl,
+    creator_user_id: creatorUserId,
+  };
+}
+
+
+export type ServerTeamMemberProfile = TeamMemberProfile;
+
+export type ServerTeamUser = ServerUser & {
+  teamProfile: ServerTeamMemberProfile,
+}
+
+export type ServerTeam = {
+  createdAt: Date,
+  serverMetadata: any,
+  listUsers(): Promise<ServerTeamUser[]>,
+  update(update: ServerTeamUpdateOptions): Promise<void>,
+  delete(): Promise<void>,
+  addUser(userId: string): Promise<void>,
+  inviteUser(options: { email: string, callbackUrl?: string }): Promise<void>,
+  removeUser(userId: string): Promise<void>,
+} & Team;
+
+type ServerListUsersOptionsBase = {
+  cursor?: string,
+  limit?: number,
+  orderBy?: 'signedUpAt' | 'lastActiveAt',
+  desc?: boolean,
+  /**
+   * Free-text search. Matches user ID (exact UUID), display name, and contact channels (e.g. primary email).
+   */
+  query?: string,
+  /**
+   * Only return users who are members of the given team.
+   */
+  teamId?: string,
+  /**
+   * Whether to include restricted users (users who haven't completed onboarding requirements).
+   * Defaults to false.
+   */
+  includeRestricted?: boolean,
+  /**
+   * Whether to include anonymous users (and restricted users).
+   * Defaults to false.
+   */
+  includeAnonymous?: boolean,
+};
+
+export type ServerListUsersOptions = ServerListUsersOptionsBase & (
+  {
+    onlyAnonymous?: false,
+  } | {
+  /**
+   * Whether to return only anonymous users.
+   * Requires includeAnonymous=true.
+   * Defaults to false.
+   */
+    onlyAnonymous: true,
+    includeAnonymous: true,
+  }
+);
+
+export type ServerListTeamsOptions = {
+  orderBy?: 'createdAt',
+  desc?: boolean,
+  cursor?: string,
+  limit?: number,
+  /**
+   * Free-text search. Matches team ID (exact UUID) and display name.
+   */
+  query?: string,
+};
+
+export type ServerTeamCreateOptions = TeamCreateOptions & {
+  creatorUserId?: string,
+};
+export function serverTeamCreateOptionsToCrud(options: ServerTeamCreateOptions): TeamsCrud["Server"]["Create"] {
+  return {
+    display_name: options.displayName,
+    profile_image_url: options.profileImageUrl,
+    creator_user_id: options.creatorUserId,
+  };
+}
+
+export type ServerTeamUpdateOptions = TeamUpdateOptions & {
+  clientReadOnlyMetadata?: ReadonlyJson,
+  serverMetadata?: ReadonlyJson,
+};
+export function serverTeamUpdateOptionsToCrud(options: ServerTeamUpdateOptions): TeamsCrud["Server"]["Update"] {
+  return {
+    display_name: options.displayName,
+    profile_image_url: options.profileImageUrl,
+    client_metadata: options.clientMetadata,
+    client_read_only_metadata: options.clientReadOnlyMetadata,
+    server_metadata: options.serverMetadata,
+  };
+}