@fluxbase/sdk 0.0.1-rc.24 → 0.0.1-rc.25

package/dist/index.d.cts

@@ -530,32 +530,6 @@ interface CustomSetting {
     created_at: string;
     updated_at: string;
 }
-/**
- * Request to create a custom setting
- */
-interface CreateCustomSettingRequest {
-    key: string;
-    value: Record<string, unknown>;
-    value_type?: 'string' | 'number' | 'boolean' | 'json';
-    description?: string;
-    editable_by?: string[];
-    metadata?: Record<string, unknown>;
-}
-/**
- * Request to update a custom setting
- */
-interface UpdateCustomSettingRequest {
-    value: Record<string, unknown>;
-    description?: string;
-    editable_by?: string[];
-    metadata?: Record<string, unknown>;
-}
-/**
- * Response containing all custom settings
- */
-interface ListCustomSettingsResponse {
-    settings: CustomSetting[];
-}
 /**
  * Authentication settings for the application
  */
@@ -2285,104 +2259,83 @@ declare class AppSettingsManager {
      * ```
      */
     setEmailVerificationRequired(required: boolean): Promise<AppSettings>;
-}
-/**
- * Custom Settings Manager
- *
- * Manages custom admin-created settings with flexible key-value storage.
- * Unlike system settings, custom settings allow admins to create arbitrary configuration entries
- * with role-based editing permissions.
- *
- * @example
- * ```typescript
- * const custom = client.admin.settings.custom
- *
- * // Create a custom setting
- * const setting = await custom.create({
- *   key: 'feature.dark_mode',
- *   value: { enabled: true, theme: 'dark' },
- *   value_type: 'json',
- *   description: 'Dark mode configuration',
- *   editable_by: ['dashboard_admin', 'admin']
- * })
- *
- * // List all custom settings
- * const { settings } = await custom.list()
- *
- * // Get specific setting
- * const darkMode = await custom.get('feature.dark_mode')
- *
- * // Update setting
- * await custom.update('feature.dark_mode', {
- *   value: { enabled: false, theme: 'light' }
- * })
- *
- * // Delete setting
- * await custom.delete('feature.dark_mode')
- * ```
- */
-declare class CustomSettingsManager {
-    private fetch;
-    constructor(fetch: FluxbaseFetch);
     /**
-     * Create a new custom setting
+     * Get a specific custom setting's value only (without metadata)
      *
-     * @param request - Custom setting creation request
-     * @returns Promise resolving to CustomSetting
+     * Convenience method that returns just the value field instead of the full CustomSetting object.
+     *
+     * @param key - Setting key (e.g., 'billing.tiers', 'features.beta_enabled')
+     * @returns Promise resolving to the setting's value
      *
      * @example
      * ```typescript
-     * const setting = await client.admin.settings.custom.create({
-     *   key: 'api.quotas',
-     *   value: { free: 1000, pro: 10000, enterprise: 100000 },
-     *   value_type: 'json',
-     *   description: 'API request quotas by tier',
-     *   metadata: { category: 'billing' }
-     * })
+     * const tiers = await client.admin.settings.app.getSetting('billing.tiers')
+     * console.log(tiers) // { free: 1000, pro: 10000, enterprise: 100000 }
      * ```
      */
-    create(request: CreateCustomSettingRequest): Promise<CustomSetting>;
+    getSetting(key: string): Promise<any>;
     /**
-     * List all custom settings
+     * Get multiple custom settings' values by keys
      *
-     * @returns Promise resolving to ListCustomSettingsResponse
+     * Fetches multiple settings in a single request and returns only their values.
+     *
+     * @param keys - Array of setting keys to fetch
+     * @returns Promise resolving to object mapping keys to values
      *
      * @example
      * ```typescript
-     * const response = await client.admin.settings.custom.list()
-     * console.log(response.settings)
+     * const values = await client.admin.settings.app.getSettings([
+     *   'billing.tiers',
+     *   'features.beta_enabled'
+     * ])
+     * console.log(values)
+     * // {
+     * //   'billing.tiers': { free: 1000, pro: 10000 },
+     * //   'features.beta_enabled': { enabled: true }
+     * // }
      * ```
      */
-    list(): Promise<ListCustomSettingsResponse>;
+    getSettings(keys: string[]): Promise<Record<string, any>>;
     /**
-     * Get a specific custom setting by key
+     * Set or create a custom setting
+     *
+     * Creates a new custom setting or updates an existing one.
      *
-     * @param key - Setting key (e.g., 'feature.dark_mode')
+     * @param key - Setting key
+     * @param value - Setting value (any JSON-serializable value)
+     * @param options - Optional configuration (description, is_public, is_secret, etc.)
      * @returns Promise resolving to CustomSetting
      *
      * @example
      * ```typescript
-     * const setting = await client.admin.settings.custom.get('feature.dark_mode')
-     * console.log(setting.value)
+     * await client.admin.settings.app.setSetting('billing.tiers', {
+     *   free: 1000,
+     *   pro: 10000,
+     *   enterprise: 100000
+     * }, {
+     *   description: 'API quotas per billing tier',
+     *   is_public: false
+     * })
      * ```
      */
-    get(key: string): Promise<CustomSetting>;
+    setSetting(key: string, value: any, options?: {
+        description?: string;
+        is_public?: boolean;
+        is_secret?: boolean;
+        value_type?: string;
+    }): Promise<CustomSetting>;
     /**
-     * Update an existing custom setting
+     * List all custom settings
      *
-     * @param key - Setting key
-     * @param request - Update request with new values
-     * @returns Promise resolving to CustomSetting
+     * @returns Promise resolving to array of CustomSetting objects
      *
      * @example
      * ```typescript
-     * const updated = await client.admin.settings.custom.update('feature.dark_mode', {
-     *   value: { enabled: false },
-     *   description: 'Updated description'
-     * })
+     * const settings = await client.admin.settings.app.listSettings()
+     * settings.forEach(s => console.log(s.key, s.value))
      * ```
      */
-    update(key: string, request: UpdateCustomSettingRequest): Promise<CustomSetting>;
+    listSettings(): Promise<CustomSetting[]>;
     /**
      * Delete a custom setting
      *
@@ -2391,10 +2344,10 @@ declare class CustomSettingsManager {
      *
      * @example
      * ```typescript
-     * await client.admin.settings.custom.delete('feature.dark_mode')
+     * await client.admin.settings.app.deleteSetting('billing.tiers')
      * ```
      */
-    delete(key: string): Promise<void>;
+    deleteSetting(key: string): Promise<void>;
 }
 /**
  * Email Template Manager
@@ -2511,7 +2464,8 @@ declare class EmailTemplateManager {
 /**
  * Settings Manager
  *
- * Provides access to system-level, application-level, and custom settings.
+ * Provides access to system-level and application-level settings.
+ * AppSettingsManager now handles both structured framework settings and custom key-value settings.
  *
  * @example
  * ```typescript
@@ -2520,19 +2474,104 @@ declare class EmailTemplateManager {
  * // Access system settings
  * const systemSettings = await settings.system.list()
  *
- * // Access app settings
+ * // Access app settings (structured)
  * const appSettings = await settings.app.get()
+ * await settings.app.enableSignup()
  *
- * // Access custom settings
- * const customSettings = await settings.custom.list()
+ * // Access custom settings (key-value)
+ * await settings.app.setSetting('billing.tiers', { free: 1000, pro: 10000 })
+ * const tiers = await settings.app.getSetting('billing.tiers')
  * ```
  */
 declare class FluxbaseSettings {
     system: SystemSettingsManager;
     app: AppSettingsManager;
-    custom: CustomSettingsManager;
     constructor(fetch: FluxbaseFetch);
 }
+/**
+ * Public Settings Client
+ *
+ * Provides read-only access to public settings for non-admin users.
+ * Access is controlled by RLS policies on the app.settings table.
+ *
+ * @example
+ * ```typescript
+ * const client = new FluxbaseClient(url, userToken)
+ *
+ * // Get single public setting
+ * const betaEnabled = await client.settings.get('features.beta_enabled')
+ * console.log(betaEnabled) // { enabled: true }
+ *
+ * // Get multiple public settings
+ * const values = await client.settings.getMany([
+ *   'features.beta_enabled',
+ *   'features.dark_mode',
+ *   'public.app_version'
+ * ])
+ * console.log(values)
+ * // {
+ * //   'features.beta_enabled': { enabled: true },
+ * //   'features.dark_mode': { enabled: false },
+ * //   'public.app_version': '1.0.0'
+ * // }
+ * ```
+ */
+declare class SettingsClient {
+    private fetch;
+    constructor(fetch: FluxbaseFetch);
+    /**
+     * Get a single setting's value
+     *
+     * Returns only the value field of the setting.
+     * Access is controlled by RLS policies - will return 403 if the user
+     * doesn't have permission to read the setting.
+     *
+     * @param key - Setting key (e.g., 'features.beta_enabled')
+     * @returns Promise resolving to the setting's value
+     * @throws Error if setting doesn't exist or user lacks permission
+     *
+     * @example
+     * ```typescript
+     * // Get public setting (any user)
+     * const value = await client.settings.get('features.beta_enabled')
+     * console.log(value) // { enabled: true }
+     *
+     * // Get restricted setting (requires permission)
+     * try {
+     *   const secret = await client.settings.get('internal.api_key')
+     * } catch (error) {
+     *   console.error('Access denied:', error)
+     * }
+     * ```
+     */
+    get(key: string): Promise<any>;
+    /**
+     * Get multiple settings' values by keys
+     *
+     * Fetches multiple settings in a single request.
+     * Only returns settings the user has permission to read based on RLS policies.
+     * Settings the user can't access will be omitted from the result (no error thrown).
+     *
+     * @param keys - Array of setting keys to fetch
+     * @returns Promise resolving to object mapping keys to values
+     *
+     * @example
+     * ```typescript
+     * const values = await client.settings.getMany([
+     *   'features.beta_enabled',  // public - will be returned
+     *   'features.dark_mode',      // public - will be returned
+     *   'internal.api_key'         // secret - will be omitted
+     * ])
+     * console.log(values)
+     * // {
+     * //   'features.beta_enabled': { enabled: true },
+     * //   'features.dark_mode': { enabled: false }
+     * //   // 'internal.api_key' is omitted (no error)
+     * // }
+     * ```
+     */
+    getMany(keys: string[]): Promise<Record<string, any>>;
+}
 
 /**
  * DDL (Data Definition Language) Manager
@@ -4251,6 +4290,8 @@ declare class FluxbaseClient<Database = any, _SchemaName extends string & keyof
     admin: FluxbaseAdmin;
     /** Management module for API keys, webhooks, and invitations */
     management: FluxbaseManagement;
+    /** Settings module for reading public application settings (respects RLS policies) */
+    settings: SettingsClient;
     /**
      * Create a new Fluxbase client instance
      *
@@ -4424,4 +4465,4 @@ declare class FluxbaseClient<Database = any, _SchemaName extends string & keyof
  */
 declare function createClient<Database = any, SchemaName extends string & keyof Database = any>(fluxbaseUrl: string, fluxbaseKey: string, options?: FluxbaseClientOptions): FluxbaseClient<Database, SchemaName>;
 
-export { type APIKey, APIKeysManager, type AcceptInvitationRequest, type AcceptInvitationResponse, type AdminAuthResponse, type AdminLoginRequest, type AdminMeResponse, type AdminRefreshRequest, type AdminRefreshResponse, type AdminSetupRequest, type AdminSetupStatusResponse, type AdminUser, type AppSettings, AppSettingsManager, type AuthResponse, type AuthSession, type AuthSettings, AuthSettingsManager, type AuthenticationSettings, type Column, type CreateAPIKeyRequest, type CreateAPIKeyResponse, type CreateColumnRequest, type CreateFunctionRequest, type CreateInvitationRequest, type CreateInvitationResponse, type CreateOAuthProviderRequest, type CreateOAuthProviderResponse, type CreateSchemaRequest, type CreateSchemaResponse, type CreateTableRequest, type CreateTableResponse, type CreateWebhookRequest, DDLManager, type DataResponse, type DeleteAPIKeyResponse, type DeleteOAuthProviderResponse, type DeleteTableResponse, type DeleteUserResponse, type DeleteWebhookResponse, type EdgeFunction, type EdgeFunctionExecution, type EmailSettings, type EmailTemplate, EmailTemplateManager, type EmailTemplateType, type EnrichedUser, type FeatureSettings, type FileObject, type FilterOperator, FluxbaseAdmin, FluxbaseAuth, type FluxbaseAuthResponse, FluxbaseClient, type FluxbaseClientOptions, type FluxbaseError, FluxbaseFetch, FluxbaseFunctions, FluxbaseManagement, FluxbaseOAuth, FluxbaseRealtime, type FluxbaseResponse, FluxbaseSettings, FluxbaseStorage, type FunctionInvokeOptions, type GetImpersonationResponse, type HttpMethod, type ImpersonateAnonRequest, type ImpersonateServiceRequest, type ImpersonateUserRequest, ImpersonationManager, type ImpersonationSession, type ImpersonationTargetUser, type ImpersonationType, type Invitation, InvitationsManager, type InviteUserRequest, type InviteUserResponse, type ListAPIKeysResponse, type ListEmailTemplatesResponse, type ListImpersonationSessionsOptions, type ListImpersonationSessionsResponse, type ListInvitationsOptions, type ListInvitationsResponse, type ListOAuthProvidersResponse, type ListOptions, type ListSchemasResponse, type ListSystemSettingsResponse, type ListTablesResponse, type ListUsersOptions, type ListUsersResponse, type ListWebhookDeliveriesResponse, type ListWebhooksResponse, type MailgunSettings, type OAuthProvider, OAuthProviderManager, type OrderBy, type OrderDirection, type PostgresChangesConfig, type PostgrestError, type PostgrestResponse, QueryBuilder, type QueryFilter, type RealtimeCallback, type RealtimeChangePayload, RealtimeChannel, type RealtimeMessage, type RealtimePostgresChangesPayload, type RequestOptions, type ResetUserPasswordResponse, type RevokeAPIKeyResponse, type RevokeInvitationResponse, type SESSettings, type SMTPSettings, type Schema, type SecuritySettings, type SendGridSettings, type SessionResponse, type SignInCredentials, type SignInWith2FAResponse, type SignUpCredentials, type SignedUrlOptions, type StartImpersonationResponse, type StopImpersonationResponse, StorageBucket, type StorageObject, type SupabaseAuthResponse, type SupabaseResponse, type SystemSetting, SystemSettingsManager, type Table, type TestEmailTemplateRequest, type TestWebhookResponse, type TwoFactorEnableResponse, type TwoFactorSetupResponse, type TwoFactorStatusResponse, type TwoFactorVerifyRequest, type UpdateAPIKeyRequest, type UpdateAppSettingsRequest, type UpdateAuthSettingsRequest, type UpdateAuthSettingsResponse, type UpdateEmailTemplateRequest, type UpdateFunctionRequest, type UpdateOAuthProviderRequest, type UpdateOAuthProviderResponse, type UpdateSystemSettingRequest, type UpdateUserRoleRequest, type UpdateWebhookRequest, type UploadOptions, type User, type UserResponse, type ValidateInvitationResponse, type VoidResponse, type Webhook, type WebhookDelivery, WebhooksManager, createClient };
+export { type APIKey, APIKeysManager, type AcceptInvitationRequest, type AcceptInvitationResponse, type AdminAuthResponse, type AdminLoginRequest, type AdminMeResponse, type AdminRefreshRequest, type AdminRefreshResponse, type AdminSetupRequest, type AdminSetupStatusResponse, type AdminUser, type AppSettings, AppSettingsManager, type AuthResponse, type AuthSession, type AuthSettings, AuthSettingsManager, type AuthenticationSettings, type Column, type CreateAPIKeyRequest, type CreateAPIKeyResponse, type CreateColumnRequest, type CreateFunctionRequest, type CreateInvitationRequest, type CreateInvitationResponse, type CreateOAuthProviderRequest, type CreateOAuthProviderResponse, type CreateSchemaRequest, type CreateSchemaResponse, type CreateTableRequest, type CreateTableResponse, type CreateWebhookRequest, DDLManager, type DataResponse, type DeleteAPIKeyResponse, type DeleteOAuthProviderResponse, type DeleteTableResponse, type DeleteUserResponse, type DeleteWebhookResponse, type EdgeFunction, type EdgeFunctionExecution, type EmailSettings, type EmailTemplate, EmailTemplateManager, type EmailTemplateType, type EnrichedUser, type FeatureSettings, type FileObject, type FilterOperator, FluxbaseAdmin, FluxbaseAuth, type FluxbaseAuthResponse, FluxbaseClient, type FluxbaseClientOptions, type FluxbaseError, FluxbaseFetch, FluxbaseFunctions, FluxbaseManagement, FluxbaseOAuth, FluxbaseRealtime, type FluxbaseResponse, FluxbaseSettings, FluxbaseStorage, type FunctionInvokeOptions, type GetImpersonationResponse, type HttpMethod, type ImpersonateAnonRequest, type ImpersonateServiceRequest, type ImpersonateUserRequest, ImpersonationManager, type ImpersonationSession, type ImpersonationTargetUser, type ImpersonationType, type Invitation, InvitationsManager, type InviteUserRequest, type InviteUserResponse, type ListAPIKeysResponse, type ListEmailTemplatesResponse, type ListImpersonationSessionsOptions, type ListImpersonationSessionsResponse, type ListInvitationsOptions, type ListInvitationsResponse, type ListOAuthProvidersResponse, type ListOptions, type ListSchemasResponse, type ListSystemSettingsResponse, type ListTablesResponse, type ListUsersOptions, type ListUsersResponse, type ListWebhookDeliveriesResponse, type ListWebhooksResponse, type MailgunSettings, type OAuthProvider, OAuthProviderManager, type OrderBy, type OrderDirection, type PostgresChangesConfig, type PostgrestError, type PostgrestResponse, QueryBuilder, type QueryFilter, type RealtimeCallback, type RealtimeChangePayload, RealtimeChannel, type RealtimeMessage, type RealtimePostgresChangesPayload, type RequestOptions, type ResetUserPasswordResponse, type RevokeAPIKeyResponse, type RevokeInvitationResponse, type SESSettings, type SMTPSettings, type Schema, type SecuritySettings, type SendGridSettings, type SessionResponse, SettingsClient, type SignInCredentials, type SignInWith2FAResponse, type SignUpCredentials, type SignedUrlOptions, type StartImpersonationResponse, type StopImpersonationResponse, StorageBucket, type StorageObject, type SupabaseAuthResponse, type SupabaseResponse, type SystemSetting, SystemSettingsManager, type Table, type TestEmailTemplateRequest, type TestWebhookResponse, type TwoFactorEnableResponse, type TwoFactorSetupResponse, type TwoFactorStatusResponse, type TwoFactorVerifyRequest, type UpdateAPIKeyRequest, type UpdateAppSettingsRequest, type UpdateAuthSettingsRequest, type UpdateAuthSettingsResponse, type UpdateEmailTemplateRequest, type UpdateFunctionRequest, type UpdateOAuthProviderRequest, type UpdateOAuthProviderResponse, type UpdateSystemSettingRequest, type UpdateUserRoleRequest, type UpdateWebhookRequest, type UploadOptions, type User, type UserResponse, type ValidateInvitationResponse, type VoidResponse, type Webhook, type WebhookDelivery, WebhooksManager, createClient };