import {z} from 'zod' export type DumpDataScopes = 'users' | 'folders' | 'groups' | 'admins' | 'api_keys' | 'shares' | 'actions' | 'rules' | 'roles' | 'ip_lists' | 'configs'; export type GetApiDumpdataArgs = {'output-file'?: string | undefined, 'output-data'?: (0 | 1) | undefined, indent?: (0 | 1) | undefined, scopes?: Array | undefined}; export type GetApiDumpdataOptions = {baseUrl: string, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const apiResponse = z.object({message: z.string().optional(), error: z.string().optional()}); export const fsProviders = z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6)]); export const oSFsConfig = z.object({read_buffer_size: z.number().int().gte(0).lte(10).optional(), write_buffer_size: z.number().int().gte(0).lte(10).optional()}); export const secret = z.object({status: z.enum(["Plain", "AES-256-GCM", "Secretbox", "GCP", "AWS", "VaultTransit", "AzureKeyVault", "Redacted"]).optional(), payload: z.string().optional(), key: z.string().optional(), additional_data: z.string().optional(), mode: z.number().int().optional()}); export const s3Config = z.object({bucket: z.string().min(1).optional(), region: z.string().min(1).optional(), access_key: z.string().optional(), access_secret: secret.optional(), role_arn: z.string().optional(), session_token: z.string().optional(), endpoint: z.string().optional(), storage_class: z.string().optional(), acl: z.string().optional(), upload_part_size: z.number().int().optional(), upload_concurrency: z.number().int().optional(), upload_part_max_time: z.number().int().optional(), download_part_size: z.number().int().optional(), download_concurrency: z.number().int().optional(), download_part_max_time: z.number().int().optional(), force_path_style: z.boolean().optional(), key_prefix: z.string().optional()}); export const gCSConfig = z.object({bucket: z.string().min(1).optional(), credentials: secret.optional(), automatic_credentials: z.union([z.literal(0), z.literal(1)]).optional(), storage_class: z.string().optional(), acl: z.string().optional(), key_prefix: z.string().optional(), upload_part_size: z.number().int().optional(), upload_part_max_time: z.number().int().optional()}); export const azureBlobFsConfig = z.object({container: z.string().optional(), account_name: z.string().optional(), account_key: secret.optional(), sas_url: secret.optional(), endpoint: z.string().optional(), upload_part_size: z.number().int().optional(), upload_concurrency: z.number().int().optional(), download_part_size: z.number().int().optional(), download_concurrency: z.number().int().optional(), access_tier: z.enum(["", "Archive", "Hot", "Cool"]).optional(), key_prefix: z.string().optional(), use_emulator: z.boolean().optional()}); export const cryptFsConfig = z.object({passphrase: secret.optional(), read_buffer_size: z.number().int().gte(0).lte(10).optional(), write_buffer_size: z.number().int().gte(0).lte(10).optional()}); export const sFTPFsConfig = z.object({endpoint: z.string().optional(), username: z.string().optional(), password: secret.optional(), private_key: secret.optional(), key_passphrase: secret.optional(), fingerprints: z.array(z.string()).optional(), prefix: z.string().optional(), disable_concurrent_reads: z.boolean().optional(), buffer_size: z.number().int().gte(0).lte(16).optional(), equality_check_mode: z.union([z.literal(0), z.literal(1)]).optional()}); export const hTTPFsConfig = z.object({endpoint: z.string().optional(), username: z.string().optional(), password: secret.optional(), api_key: secret.optional(), skip_tls_verify: z.boolean().optional(), equality_check_mode: z.union([z.literal(0), z.literal(1)]).optional()}); export const filesystemConfig = z.object({provider: fsProviders.optional(), osconfig: oSFsConfig.optional(), s3config: s3Config.optional(), gcsconfig: gCSConfig.optional(), azblobconfig: azureBlobFsConfig.optional(), cryptconfig: cryptFsConfig.optional(), sftpconfig: sFTPFsConfig.optional(), httpconfig: hTTPFsConfig.optional()}); export const virtualFolder = z.object({id: z.number().int().gte(1).optional(), name: z.string().optional(), mapped_path: z.string().optional(), description: z.string().optional(), used_quota_size: z.number().int().optional(), used_quota_files: z.number().int().optional(), last_quota_update: z.number().int().optional(), users: z.array(z.string()).optional(), filesystem: filesystemConfig.optional(), virtual_path: z.string(), quota_size: z.number().int().optional(), quota_files: z.number().int().optional()}); export const permission = z.enum(["*", "list", "download", "upload", "overwrite", "delete", "delete_files", "delete_dirs", "rename", "rename_files", "rename_dirs", "create_dirs", "create_symlinks", "chmod", "chown", "chtimes", "copy"]); export const loginMethods = z.enum(["publickey", "password", "password-over-SSH", "keyboard-interactive", "publickey+password", "publickey+keyboard-interactive", "TLSCertificate", "TLSCertificate+password"]); export const supportedProtocols = z.enum(["SSH", "FTP", "DAV", "HTTP"]); export const patternsFilter = z.object({path: z.string().optional(), allowed_patterns: z.array(z.string()).optional(), denied_patterns: z.array(z.string()).optional(), deny_policy: z.union([z.literal(0), z.literal(1)]).optional()}); export const hooksFilter = z.object({external_auth_disabled: z.boolean().optional(), pre_login_disabled: z.boolean().optional(), check_password_disabled: z.boolean().optional()}); export const webClientOptions = z.enum(["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 const userType = z.enum(["", "LDAPUser", "OSUser"]); export const bandwidthLimit = z.object({sources: z.array(z.string()).optional(), upload_bandwidth: z.number().int().optional(), download_bandwidth: z.number().int().optional()}); export const mFAProtocols = z.enum(["SSH", "FTP", "HTTP"]); export const timePeriod = z.object({day_of_week: z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6)]).optional(), from: z.string().optional(), to: z.string().optional()}); export const userTOTPConfig = z.object({enabled: z.boolean().optional(), config_name: z.string().optional(), secret: secret.optional(), protocols: z.array(mFAProtocols).optional()}); export const recoveryCode = z.object({secret: secret.optional(), used: z.boolean().optional()}); export const userFilters = z.object({allowed_ip: z.array(z.string()).optional(), denied_ip: z.array(z.string()).optional(), denied_login_methods: z.array(loginMethods).optional(), denied_protocols: z.array(supportedProtocols).optional(), file_patterns: z.array(patternsFilter).optional(), max_upload_file_size: z.number().int().optional(), tls_username: z.string().optional(), tls_certs: z.array(z.string()).optional(), hooks: hooksFilter.optional(), disable_fs_checks: z.boolean().optional(), web_client: z.array(webClientOptions).optional(), allow_api_key_auth: z.boolean().optional(), user_type: userType.optional(), bandwidth_limits: z.array(bandwidthLimit).optional(), external_auth_cache_time: z.number().int().optional(), start_directory: z.string().optional(), two_factor_protocols: z.array(mFAProtocols).optional(), ftp_security: z.union([z.literal(0), z.literal(1)]).optional(), is_anonymous: z.boolean().optional(), default_shares_expiration: z.number().int().optional(), max_shares_expiration: z.number().int().optional(), password_expiration: z.number().int().optional(), password_strength: z.number().int().optional(), access_time: z.array(timePeriod).optional(), require_password_change: z.boolean().optional(), totp_config: userTOTPConfig.optional(), recovery_codes: z.array(recoveryCode).optional()}); export const groupMapping = z.object({name: z.string().optional(), type: z.unknown()}); export const user = z.object({id: z.number().int().gte(1).optional(), status: z.union([z.literal(0), z.literal(1)]).optional(), username: z.string().optional(), email: z.string().optional(), description: z.string().optional(), expiration_date: z.number().int().optional(), password: z.string().optional(), public_keys: z.array(z.string()).optional(), has_password: z.boolean().optional(), home_dir: z.string().optional(), virtual_folders: z.array(virtualFolder).optional(), uid: z.number().int().gte(0).lte(2147483647).optional(), gid: z.number().int().gte(0).lte(2147483647).optional(), max_sessions: z.number().int().optional(), quota_size: z.number().int().optional(), quota_files: z.number().int().optional(), permissions: z.record(z.string(), z.array(permission)).optional(), used_quota_size: z.number().int().optional(), used_quota_files: z.number().int().optional(), last_quota_update: z.number().int().optional(), upload_bandwidth: z.number().int().optional(), download_bandwidth: z.number().int().optional(), upload_data_transfer: z.number().int().optional(), download_data_transfer: z.number().int().optional(), total_data_transfer: z.number().int().optional(), used_upload_data_transfer: z.number().int().optional(), used_download_data_transfer: z.number().int().optional(), created_at: z.number().int().optional(), updated_at: z.number().int().optional(), last_login: z.number().int().optional(), first_download: z.number().int().optional(), first_upload: z.number().int().optional(), last_password_change: z.number().int().optional(), filters: userFilters.optional(), filesystem: filesystemConfig.optional(), additional_info: z.string().optional(), groups: z.array(groupMapping).optional(), oidc_custom_fields: z.record(z.string(), z.unknown()).optional(), role: z.string().optional()}); export const baseVirtualFolder = z.object({id: z.number().int().gte(1).optional(), name: z.string().optional(), mapped_path: z.string().optional(), description: z.string().optional(), used_quota_size: z.number().int().optional(), used_quota_files: z.number().int().optional(), last_quota_update: z.number().int().optional(), users: z.array(z.string()).optional(), filesystem: filesystemConfig.optional()}); export const baseUserFilters = z.object({allowed_ip: z.array(z.string()).optional(), denied_ip: z.array(z.string()).optional(), denied_login_methods: z.array(loginMethods).optional(), denied_protocols: z.array(supportedProtocols).optional(), file_patterns: z.array(patternsFilter).optional(), max_upload_file_size: z.number().int().optional(), tls_username: z.string().optional(), tls_certs: z.array(z.string()).optional(), hooks: hooksFilter.optional(), disable_fs_checks: z.boolean().optional(), web_client: z.array(webClientOptions).optional(), allow_api_key_auth: z.boolean().optional(), user_type: userType.optional(), bandwidth_limits: z.array(bandwidthLimit).optional(), external_auth_cache_time: z.number().int().optional(), start_directory: z.string().optional(), two_factor_protocols: z.array(mFAProtocols).optional(), ftp_security: z.union([z.literal(0), z.literal(1)]).optional(), is_anonymous: z.boolean().optional(), default_shares_expiration: z.number().int().optional(), max_shares_expiration: z.number().int().optional(), password_expiration: z.number().int().optional(), password_strength: z.number().int().optional(), access_time: z.array(timePeriod).optional()}); export const groupUserSettings = z.object({home_dir: z.string().optional(), max_sessions: z.number().int().optional(), quota_size: z.number().int().optional(), quota_files: z.number().int().optional(), permissions: z.record(z.string(), z.array(permission)).optional(), upload_bandwidth: z.number().int().optional(), download_bandwidth: z.number().int().optional(), upload_data_transfer: z.number().int().optional(), download_data_transfer: z.number().int().optional(), total_data_transfer: z.number().int().optional(), expires_in: z.number().int().optional(), filters: baseUserFilters.optional(), filesystem: filesystemConfig.optional()}); export const group = z.object({id: z.number().int().gte(1).optional(), name: z.string().optional(), description: z.string().optional(), created_at: z.number().int().optional(), updated_at: z.number().int().optional(), user_settings: groupUserSettings.optional(), virtual_folders: z.array(virtualFolder).optional(), users: z.array(z.string()).optional(), admins: z.array(z.string()).optional()}); export const adminPermissions = z.enum(["*", "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 const adminTOTPConfig = z.object({enabled: z.boolean().optional(), config_name: z.string().optional(), secret: secret.optional()}); export const adminPreferences = z.object({hide_user_page_sections: z.number().int().optional(), default_users_expiration: z.number().int().optional()}); export const adminFilters = z.object({allow_list: z.array(z.string()).optional(), allow_api_key_auth: z.boolean().optional(), require_two_factor: z.boolean().optional(), require_password_change: z.boolean().optional(), totp_config: adminTOTPConfig.optional(), recovery_codes: z.array(recoveryCode).optional(), preferences: adminPreferences.optional()}); export const adminGroupMappingOptions = z.object({add_to_users_as: z.unknown()}); export const adminGroupMapping = z.object({name: z.string().optional(), options: adminGroupMappingOptions.optional()}); export const admin = z.object({id: z.number().int().gte(1).optional(), status: z.union([z.literal(0), z.literal(1)]).optional(), username: z.string().optional(), description: z.string().optional(), password: z.string().optional(), email: z.string().optional(), permissions: z.array(adminPermissions).optional(), filters: adminFilters.optional(), additional_info: z.string().optional(), groups: z.array(adminGroupMapping).optional(), created_at: z.number().int().optional(), updated_at: z.number().int().optional(), last_login: z.number().int().optional(), role: z.string().optional()}); export const aPIKeyScope = z.union([z.literal(1), z.literal(2)]); export const aPIKey = z.object({id: z.string().optional(), name: z.string().optional(), key: z.string().optional(), scope: aPIKeyScope.optional(), created_at: z.number().int().optional(), updated_at: z.number().int().optional(), last_use_at: z.number().int().optional(), expires_at: z.number().int().optional(), description: z.string().optional(), user: z.string().optional(), admin: z.string().optional()}); export const shareScope = z.union([z.literal(1), z.literal(2)]); export const share = z.object({id: z.string().optional(), name: z.string().optional(), description: z.string().optional(), scope: shareScope.optional(), paths: z.array(z.string()).optional(), username: z.string().optional(), created_at: z.number().int().optional(), updated_at: z.number().int().optional(), last_use_at: z.number().int().optional(), expires_at: z.number().int().optional(), password: z.string().optional(), max_tokens: z.number().int().optional(), used_tokens: z.number().int().optional(), allow_from: z.array(z.string()).optional()}); export const eventActionTypes = z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6), z.literal(7), z.literal(8), z.literal(9), z.literal(11), z.literal(12), z.literal(13), z.literal(14), z.literal(15)]); export const keyValue = z.object({key: z.string().optional(), value: z.string().optional()}); export const hTTPPart = z.object({name: z.string().optional(), headers: z.array(keyValue).optional(), filepath: z.string().optional(), body: z.string().optional()}); export const eventActionHTTPConfig = z.object({endpoint: z.string().optional(), username: z.string().optional(), password: secret.optional(), headers: z.array(keyValue).optional(), timeout: z.number().int().gte(1).lte(180).optional(), skip_tls_verify: z.boolean().optional(), method: z.enum(["GET", "POST", "PUT", "DELETE"]).optional(), query_parameters: z.array(keyValue).optional(), body: z.string().optional(), parts: z.array(hTTPPart).optional()}); export const eventActionCommandConfig = z.object({cmd: z.string().optional(), args: z.array(z.string()).optional(), timeout: z.number().int().gte(1).lte(120).optional(), env_vars: z.array(keyValue).optional()}); export const eventActionEmailConfig = z.object({recipients: z.array(z.string()).optional(), bcc: z.array(z.string()).optional(), subject: z.string().optional(), body: z.string().optional(), content_type: z.union([z.literal(0), z.literal(1)]).optional(), attachments: z.array(z.string()).optional()}); export const folderRetention = z.object({path: z.string().optional(), retention: z.number().int().optional(), delete_empty_dirs: z.boolean().optional(), ignore_user_permissions: z.boolean().optional()}); export const eventActionDataRetentionConfig = z.object({folders: z.array(folderRetention).optional()}); export const filesystemActionTypes = z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6)]); export const eventActionFsCompress = z.object({name: z.string().optional(), paths: z.array(z.string()).optional()}); export const eventActionFilesystemConfig = z.object({type: filesystemActionTypes.optional(), renames: z.array(keyValue).optional(), mkdirs: z.array(z.string()).optional(), deletes: z.array(z.string()).optional(), exist: z.array(z.string()).optional(), copy: z.array(keyValue).optional(), compress: eventActionFsCompress.optional()}); export const eventActionPasswordExpiration = z.object({threshold: z.number().int().optional()}); export const eventActionUserInactivity = z.object({disable_threshold: z.number().int().optional(), delete_threshold: z.number().int().optional()}); export const eventActionIDPAccountCheck = z.object({mode: z.union([z.literal(0), z.literal(1)]).optional(), template_user: z.string().optional(), template_admin: z.string().optional()}); export const baseEventActionOptions = z.object({http_config: eventActionHTTPConfig.optional(), cmd_config: eventActionCommandConfig.optional(), email_config: eventActionEmailConfig.optional(), retention_config: eventActionDataRetentionConfig.optional(), fs_config: eventActionFilesystemConfig.optional(), pwd_expiration_config: eventActionPasswordExpiration.optional(), user_inactivity_config: eventActionUserInactivity.optional(), idp_config: eventActionIDPAccountCheck.optional()}); export const eventActionOptions = z.object({is_failure_action: z.boolean().optional(), stop_on_failure: z.boolean().optional(), execute_sync: z.boolean().optional()}); export const eventAction = z.object({id: z.number().int().gte(1).optional(), name: z.string().optional(), description: z.string().optional(), type: eventActionTypes.optional(), options: baseEventActionOptions.optional(), rules: z.array(z.string()).optional(), order: z.number().int().optional(), relation_options: eventActionOptions.optional()}); export const eventTriggerTypes = z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5), z.literal(6), z.literal(7)]); export const schedule = z.object({hour: z.string().optional(), day_of_week: z.string().optional(), day_of_month: z.string().optional(), month: z.string().optional()}); export const conditionPattern = z.object({pattern: z.string().optional(), inverse_match: z.boolean().optional()}); export const conditionOptions = z.object({names: z.array(conditionPattern).optional(), group_names: z.array(conditionPattern).optional(), role_names: z.array(conditionPattern).optional(), fs_paths: z.array(conditionPattern).optional(), protocols: z.array(z.enum(["SFTP", "SCP", "SSH", "FTP", "DAV", "HTTP", "HTTPShare", "OIDC"])).optional(), provider_objects: z.array(z.enum(["user", "group", "admin", "api_key", "share", "event_action", "event_rule"])).optional(), min_size: z.number().int().optional(), max_size: z.number().int().optional(), concurrent_execution: z.boolean().optional()}); export const eventConditions = z.object({fs_events: z.array(z.enum(["upload", "download", "delete", "rename", "mkdir", "rmdir", "copy", "ssh_cmd", "pre-upload", "pre-download", "pre-delete", "first-upload", "first-download"])).optional(), provider_events: z.array(z.enum(["add", "update", "delete"])).optional(), schedules: z.array(schedule).optional(), idp_login_event: z.union([z.literal(0), z.literal(1), z.literal(2)]).optional(), options: conditionOptions.optional()}); export const eventRule = z.object({id: z.number().int().gte(1).optional(), name: z.string().optional(), status: z.union([z.literal(0), z.literal(1)]).optional(), description: z.string().optional(), created_at: z.number().int().optional(), updated_at: z.number().int().optional(), trigger: eventTriggerTypes.optional(), conditions: eventConditions.optional(), actions: z.array(eventAction).optional()}); export const role = z.object({id: z.number().int().gte(1).optional(), name: z.string().optional(), description: z.string().optional(), created_at: z.number().int().optional(), updated_at: z.number().int().optional(), users: z.array(z.string()).optional(), admins: z.array(z.string()).optional()}); export const backupData = z.object({users: z.array(user).optional(), folders: z.array(baseVirtualFolder).optional(), groups: z.array(group).optional(), admins: z.array(admin).optional(), api_keys: z.array(aPIKey).optional(), shares: z.array(share).optional(), event_actions: z.array(eventAction).optional(), event_rules: z.array(eventRule).optional(), roles: z.array(role).optional(), version: z.number().int().optional()}); export const getApiDumpdataResponse = z.union([apiResponse, backupData]); 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 }; /** * Dump data * * GET /dumpdata * * Also accepts auth: APIKeyAuth */ export const getApiDumpdata = async (args: GetApiDumpdataArgs, options: GetApiDumpdataOptions) => { const {baseUrl, fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['output-file'] != null) query.append("output-file", String(args['output-file'])) if (args['output-data'] != null) query.append("output-data", String(args['output-data'])) if (args.indent != null) query.append("indent", String(args.indent)) if (args.scopes != null) query.append("scopes", args.scopes.join(',')) if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/dumpdata${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiDumpdataResponse, await res.json()) };