import {z} from 'zod' export type FsProviders = 0 | 1 | 2 | 3 | 4 | 5 | 6; export type OSFsConfig = {read_buffer_size?: number | undefined, write_buffer_size?: number | undefined}; export type Secret = {status?: ('Plain' | 'AES-256-GCM' | 'Secretbox' | 'GCP' | 'AWS' | 'VaultTransit' | 'AzureKeyVault' | 'Redacted') | undefined, payload?: string | undefined, key?: string | undefined, additional_data?: string | undefined, mode?: number | undefined}; export type S3Config = {bucket?: string | undefined, region?: string | undefined, access_key?: string | undefined, access_secret?: Secret | undefined, role_arn?: string | undefined, session_token?: string | undefined, endpoint?: string | undefined, storage_class?: string | undefined, acl?: string | undefined, upload_part_size?: number | undefined, upload_concurrency?: number | undefined, upload_part_max_time?: number | undefined, download_part_size?: number | undefined, download_concurrency?: number | undefined, download_part_max_time?: number | undefined, force_path_style?: boolean | undefined, key_prefix?: string | undefined}; export type GCSConfig = {bucket?: string | undefined, credentials?: Secret | undefined, automatic_credentials?: (0 | 1) | undefined, storage_class?: string | undefined, acl?: string | undefined, key_prefix?: string | undefined, upload_part_size?: number | undefined, upload_part_max_time?: number | undefined}; export type AzureBlobFsConfig = {container?: string | undefined, account_name?: string | undefined, account_key?: Secret | undefined, sas_url?: Secret | undefined, endpoint?: string | undefined, upload_part_size?: number | undefined, upload_concurrency?: number | undefined, download_part_size?: number | undefined, download_concurrency?: number | undefined, access_tier?: ('' | 'Archive' | 'Hot' | 'Cool') | undefined, key_prefix?: string | undefined, use_emulator?: boolean | undefined}; export type CryptFsConfig = {passphrase?: Secret | undefined, read_buffer_size?: number | undefined, write_buffer_size?: number | undefined}; export type SFTPFsConfig = {endpoint?: string | undefined, username?: string | undefined, password?: Secret | undefined, private_key?: Secret | undefined, key_passphrase?: Secret | undefined, fingerprints?: Array | undefined, prefix?: string | undefined, disable_concurrent_reads?: boolean | undefined, buffer_size?: number | undefined, equality_check_mode?: (0 | 1) | undefined}; export type HTTPFsConfig = {endpoint?: string | undefined, username?: string | undefined, password?: Secret | undefined, api_key?: Secret | undefined, skip_tls_verify?: boolean | undefined, equality_check_mode?: (0 | 1) | undefined}; export type FilesystemConfig = {provider?: FsProviders | undefined, osconfig?: OSFsConfig | undefined, s3config?: S3Config | undefined, gcsconfig?: GCSConfig | undefined, azblobconfig?: AzureBlobFsConfig | undefined, cryptconfig?: CryptFsConfig | undefined, sftpconfig?: SFTPFsConfig | undefined, httpconfig?: HTTPFsConfig | undefined}; export type VirtualFolder = {id?: number | undefined, name?: string | undefined, mapped_path?: string | undefined, description?: string | undefined, used_quota_size?: number | undefined, used_quota_files?: number | undefined, last_quota_update?: number | undefined, users?: Array | undefined, filesystem?: FilesystemConfig | undefined, virtual_path: string, quota_size?: number | undefined, quota_files?: number | undefined}; export type Permission = '*' | 'list' | 'download' | 'upload' | 'overwrite' | 'delete' | 'delete_files' | 'delete_dirs' | 'rename' | 'rename_files' | 'rename_dirs' | 'create_dirs' | 'create_symlinks' | 'chmod' | 'chown' | 'chtimes' | 'copy'; export type LoginMethods = 'publickey' | 'password' | 'password-over-SSH' | 'keyboard-interactive' | 'publickey+password' | 'publickey+keyboard-interactive' | 'TLSCertificate' | 'TLSCertificate+password'; export type SupportedProtocols = 'SSH' | 'FTP' | 'DAV' | 'HTTP'; export type PatternsFilter = {path?: string | undefined, allowed_patterns?: Array | undefined, denied_patterns?: Array | undefined, deny_policy?: (0 | 1) | undefined}; export type HooksFilter = {external_auth_disabled?: boolean | undefined, pre_login_disabled?: boolean | undefined, check_password_disabled?: boolean | undefined}; export type WebClientOptions = 'publickey-change-disabled' | 'tls-cert-change-disabled' | 'write-disabled' | 'mfa-disabled' | 'password-change-disabled' | 'api-key-auth-change-disabled' | 'info-change-disabled' | 'shares-disabled' | 'password-reset-disabled' | 'shares-without-password-disabled'; export type UserType = '' | 'LDAPUser' | 'OSUser'; export type BandwidthLimit = {sources?: Array | undefined, upload_bandwidth?: number | undefined, download_bandwidth?: number | undefined}; export type MFAProtocols = 'SSH' | 'FTP' | 'HTTP'; export type TimePeriod = {day_of_week?: (0 | 1 | 2 | 3 | 4 | 5 | 6) | undefined, from?: string | undefined, to?: string | undefined}; export type UserTOTPConfig = {enabled?: boolean | undefined, config_name?: string | undefined, secret?: Secret | undefined, protocols?: Array | undefined}; export type RecoveryCode = {secret?: Secret | undefined, used?: boolean | undefined}; export type UserFilters = {allowed_ip?: Array | undefined, denied_ip?: Array | undefined, denied_login_methods?: Array | undefined, denied_protocols?: Array | undefined, file_patterns?: Array | undefined, max_upload_file_size?: number | undefined, tls_username?: string | undefined, tls_certs?: Array | undefined, hooks?: HooksFilter | undefined, disable_fs_checks?: boolean | undefined, web_client?: Array | undefined, allow_api_key_auth?: boolean | undefined, user_type?: UserType | undefined, bandwidth_limits?: Array | undefined, external_auth_cache_time?: number | undefined, start_directory?: string | undefined, two_factor_protocols?: Array | undefined, ftp_security?: (0 | 1) | undefined, is_anonymous?: boolean | undefined, default_shares_expiration?: number | undefined, max_shares_expiration?: number | undefined, password_expiration?: number | undefined, password_strength?: number | undefined, access_time?: Array | undefined, require_password_change?: boolean | undefined, totp_config?: UserTOTPConfig | undefined, recovery_codes?: Array | undefined}; export type GroupMapping = {name?: string | undefined, type: unknown}; export type User = {id?: number | undefined, status?: (0 | 1) | undefined, username?: string | undefined, email?: string | undefined, description?: string | undefined, expiration_date?: number | undefined, password?: string | undefined, public_keys?: Array | undefined, has_password?: boolean | undefined, home_dir?: string | undefined, virtual_folders?: Array | undefined, uid?: number | undefined, gid?: number | undefined, max_sessions?: number | undefined, quota_size?: number | undefined, quota_files?: number | undefined, permissions?: {[key: string]: Array} | undefined, used_quota_size?: number | undefined, used_quota_files?: number | undefined, last_quota_update?: number | undefined, upload_bandwidth?: number | undefined, download_bandwidth?: number | undefined, upload_data_transfer?: number | undefined, download_data_transfer?: number | undefined, total_data_transfer?: number | undefined, used_upload_data_transfer?: number | undefined, used_download_data_transfer?: number | undefined, created_at?: number | undefined, updated_at?: number | undefined, last_login?: number | undefined, first_download?: number | undefined, first_upload?: number | undefined, last_password_change?: number | undefined, filters?: UserFilters | undefined, filesystem?: FilesystemConfig | undefined, additional_info?: string | undefined, groups?: Array | undefined, oidc_custom_fields?: {[key: string]: unknown} | undefined, role?: string | undefined}; export type BaseVirtualFolder = {id?: number | undefined, name?: string | undefined, mapped_path?: string | undefined, description?: string | undefined, used_quota_size?: number | undefined, used_quota_files?: number | undefined, last_quota_update?: number | undefined, users?: Array | undefined, filesystem?: FilesystemConfig | undefined}; export type BaseUserFilters = {allowed_ip?: Array | undefined, denied_ip?: Array | undefined, denied_login_methods?: Array | undefined, denied_protocols?: Array | undefined, file_patterns?: Array | undefined, max_upload_file_size?: number | undefined, tls_username?: string | undefined, tls_certs?: Array | undefined, hooks?: HooksFilter | undefined, disable_fs_checks?: boolean | undefined, web_client?: Array | undefined, allow_api_key_auth?: boolean | undefined, user_type?: UserType | undefined, bandwidth_limits?: Array | undefined, external_auth_cache_time?: number | undefined, start_directory?: string | undefined, two_factor_protocols?: Array | undefined, ftp_security?: (0 | 1) | undefined, is_anonymous?: boolean | undefined, default_shares_expiration?: number | undefined, max_shares_expiration?: number | undefined, password_expiration?: number | undefined, password_strength?: number | undefined, access_time?: Array | undefined}; export type GroupUserSettings = {home_dir?: string | undefined, max_sessions?: number | undefined, quota_size?: number | undefined, quota_files?: number | undefined, permissions?: {[key: string]: Array} | undefined, upload_bandwidth?: number | undefined, download_bandwidth?: number | undefined, upload_data_transfer?: number | undefined, download_data_transfer?: number | undefined, total_data_transfer?: number | undefined, expires_in?: number | undefined, filters?: BaseUserFilters | undefined, filesystem?: FilesystemConfig | undefined}; export type Group = {id?: number | undefined, name?: string | undefined, description?: string | undefined, created_at?: number | undefined, updated_at?: number | undefined, user_settings?: GroupUserSettings | undefined, virtual_folders?: Array | undefined, users?: Array | undefined, admins?: Array | undefined}; export type AdminPermissions = '*' | 'add_users' | 'edit_users' | 'del_users' | 'view_users' | 'view_conns' | 'close_conns' | 'view_status' | 'manage_folders' | 'manage_groups' | 'quota_scans' | 'manage_defender' | 'view_defender' | 'view_events' | 'disable_mfa'; export type AdminTOTPConfig = {enabled?: boolean | undefined, config_name?: string | undefined, secret?: Secret | undefined}; export type AdminPreferences = {hide_user_page_sections?: number | undefined, default_users_expiration?: number | undefined}; export type AdminFilters = {allow_list?: Array | undefined, allow_api_key_auth?: boolean | undefined, require_two_factor?: boolean | undefined, require_password_change?: boolean | undefined, totp_config?: AdminTOTPConfig | undefined, recovery_codes?: Array | undefined, preferences?: AdminPreferences | undefined}; export type AdminGroupMappingOptions = {add_to_users_as: unknown}; export type AdminGroupMapping = {name?: string | undefined, options?: AdminGroupMappingOptions | undefined}; export type Admin = {id?: number | undefined, status?: (0 | 1) | undefined, username?: string | undefined, description?: string | undefined, password?: string | undefined, email?: string | undefined, permissions?: Array | undefined, filters?: AdminFilters | undefined, additional_info?: string | undefined, groups?: Array | undefined, created_at?: number | undefined, updated_at?: number | undefined, last_login?: number | undefined, role?: string | undefined}; export type APIKeyScope = 1 | 2; export type APIKey = {id?: string | undefined, name?: string | undefined, key?: string | undefined, scope?: APIKeyScope | undefined, created_at?: number | undefined, updated_at?: number | undefined, last_use_at?: number | undefined, expires_at?: number | undefined, description?: string | undefined, user?: string | undefined, admin?: string | undefined}; export type ShareScope = 1 | 2; export type Share = {id?: string | undefined, name?: string | undefined, description?: string | undefined, scope?: ShareScope | undefined, paths?: Array | undefined, username?: string | undefined, created_at?: number | undefined, updated_at?: number | undefined, last_use_at?: number | undefined, expires_at?: number | undefined, password?: string | undefined, max_tokens?: number | undefined, used_tokens?: number | undefined, allow_from?: Array | undefined}; export type EventActionTypes = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 12 | 13 | 14 | 15; export type KeyValue = {key?: string | undefined, value?: string | undefined}; export type HTTPPart = {name?: string | undefined, headers?: Array | undefined, filepath?: string | undefined, body?: string | undefined}; export type EventActionHTTPConfig = {endpoint?: string | undefined, username?: string | undefined, password?: Secret | undefined, headers?: Array | undefined, timeout?: number | undefined, skip_tls_verify?: boolean | undefined, method?: ('GET' | 'POST' | 'PUT' | 'DELETE') | undefined, query_parameters?: Array | undefined, body?: string | undefined, parts?: Array | undefined}; export type EventActionCommandConfig = {cmd?: string | undefined, args?: Array | undefined, timeout?: number | undefined, env_vars?: Array | undefined}; export type EventActionEmailConfig = {recipients?: Array | undefined, bcc?: Array | undefined, subject?: string | undefined, body?: string | undefined, content_type?: (0 | 1) | undefined, attachments?: Array | undefined}; export type FolderRetention = {path?: string | undefined, retention?: number | undefined, delete_empty_dirs?: boolean | undefined, ignore_user_permissions?: boolean | undefined}; export type EventActionDataRetentionConfig = {folders?: Array | undefined}; export type FilesystemActionTypes = 1 | 2 | 3 | 4 | 5 | 6; export type EventActionFsCompress = {name?: string | undefined, paths?: Array | undefined}; export type EventActionFilesystemConfig = {type?: FilesystemActionTypes | undefined, renames?: Array | undefined, mkdirs?: Array | undefined, deletes?: Array | undefined, exist?: Array | undefined, copy?: Array | undefined, compress?: EventActionFsCompress | undefined}; export type EventActionPasswordExpiration = {threshold?: number | undefined}; export type EventActionUserInactivity = {disable_threshold?: number | undefined, delete_threshold?: number | undefined}; export type EventActionIDPAccountCheck = {mode?: (0 | 1) | undefined, template_user?: string | undefined, template_admin?: string | undefined}; export type BaseEventActionOptions = {http_config?: EventActionHTTPConfig | undefined, cmd_config?: EventActionCommandConfig | undefined, email_config?: EventActionEmailConfig | undefined, retention_config?: EventActionDataRetentionConfig | undefined, fs_config?: EventActionFilesystemConfig | undefined, pwd_expiration_config?: EventActionPasswordExpiration | undefined, user_inactivity_config?: EventActionUserInactivity | undefined, idp_config?: EventActionIDPAccountCheck | undefined}; export type EventActionOptions = {is_failure_action?: boolean | undefined, stop_on_failure?: boolean | undefined, execute_sync?: boolean | undefined}; export type EventAction = {id?: number | undefined, name?: string | undefined, description?: string | undefined, type?: EventActionTypes | undefined, options?: BaseEventActionOptions | undefined, rules?: Array | undefined, order?: number | undefined, relation_options?: EventActionOptions | undefined}; export type EventTriggerTypes = 1 | 2 | 3 | 4 | 5 | 6 | 7; export type Schedule = {hour?: string | undefined, day_of_week?: string | undefined, day_of_month?: string | undefined, month?: string | undefined}; export type ConditionPattern = {pattern?: string | undefined, inverse_match?: boolean | undefined}; export type ConditionOptions = {names?: Array | undefined, group_names?: Array | undefined, role_names?: Array | undefined, fs_paths?: Array | undefined, protocols?: (Array<'SFTP' | 'SCP' | 'SSH' | 'FTP' | 'DAV' | 'HTTP' | 'HTTPShare' | 'OIDC'>) | undefined, provider_objects?: (Array<'user' | 'group' | 'admin' | 'api_key' | 'share' | 'event_action' | 'event_rule'>) | undefined, min_size?: number | undefined, max_size?: number | undefined, concurrent_execution?: boolean | undefined}; export type EventConditions = {fs_events?: (Array<'upload' | 'download' | 'delete' | 'rename' | 'mkdir' | 'rmdir' | 'copy' | 'ssh_cmd' | 'pre-upload' | 'pre-download' | 'pre-delete' | 'first-upload' | 'first-download'>) | undefined, provider_events?: (Array<'add' | 'update' | 'delete'>) | undefined, schedules?: Array | undefined, idp_login_event?: (0 | 1 | 2) | undefined, options?: ConditionOptions | undefined}; export type EventRule = {id?: number | undefined, name?: string | undefined, status?: (0 | 1) | undefined, description?: string | undefined, created_at?: number | undefined, updated_at?: number | undefined, trigger?: EventTriggerTypes | undefined, conditions?: EventConditions | undefined, actions?: Array | undefined}; export type Role = {id?: number | undefined, name?: string | undefined, description?: string | undefined, created_at?: number | undefined, updated_at?: number | undefined, users?: Array | undefined, admins?: Array | undefined}; export type BackupData = {users?: Array | undefined, folders?: Array | undefined, groups?: Array | undefined, admins?: Array | undefined, api_keys?: Array | undefined, shares?: Array | undefined, event_actions?: Array | undefined, event_rules?: Array | undefined, roles?: Array | undefined, version?: number | undefined}; export type CreateApiLoaddataArgs = {body: BackupData}; export type CreateApiLoaddataOptions = {baseUrl: string, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const apiResponse = z.object({message: z.string().optional(), error: z.string().optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Load data * * POST /loaddata * * Also accepts auth: APIKeyAuth */ export const createApiLoaddata = async (args: CreateApiLoaddataArgs, options: CreateApiLoaddataOptions) => { const {baseUrl, fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/loaddata${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(apiResponse, await res.json()) };