import {z} from 'zod' export type GetApiHealthcheckJsonOptions = {baseUrl?: string | undefined, bearerHttpAuthentication?: string | undefined, fetch?: typeof fetch | undefined}; export const header = z.object({id: z.string(), status: z.enum(["success", "error"]), servertime: z.number().int(), action: z.string(), message: z.string(), url: z.string(), code: z.number().int()}); export const healthcheck = z.object({environment: z.object({gnupg: z.boolean(), info: z.object({phpVersion: z.string()}), phpVersion: z.boolean(), nextMinPhpVersion: z.boolean(), pcre: z.boolean(), mbstring: z.boolean(), intl: z.boolean(), image: z.boolean(), tmpWritable: z.boolean(), logWritable: z.boolean()}), configFile: z.object({app: z.boolean(), passbolt: z.boolean()}), core: z.object({cache: z.boolean(), debugDisabled: z.boolean(), salt: z.boolean(), info: z.object({fullBaseUrl: z.string()}), fullBaseUrl: z.boolean(), validFullBaseUrl: z.boolean(), fullBaseUrlReachable: z.boolean()}), ssl: z.object({info: z.string(), peerValid: z.boolean(), hostValid: z.boolean(), notSelfSigned: z.boolean()}), smtpSettings: z.object({isEnabled: z.boolean(), errorMessage: z.boolean(), source: z.string(), isInDb: z.boolean(), areEndpointsDisabled: z.boolean(), customSslOptions: z.boolean()}), gpg: z.object({lib: z.boolean(), gpgHome: z.boolean(), gpgHomeWritable: z.boolean(), gpgKeyPublicBlock: z.boolean(), gpgKeyPrivateBlock: z.boolean(), gpgKeyPublicReadable: z.boolean(), gpgKeyPrivateReadable: z.boolean(), gpgKeyPrivateFingerprint: z.boolean(), gpgKeyPublic: z.boolean(), gpgKeyPrivate: z.boolean(), gpgKey: z.boolean(), info: z.object({gpgKeyPrivate: z.string(), gpgHome: z.string()}), gpgKeyPublicFingerprint: z.boolean(), gpgKeyPublicInKeyring: z.boolean(), gpgKeyPublicEmail: z.boolean(), canEncrypt: z.boolean(), canSign: z.boolean(), canEncryptSign: z.boolean(), canDecrypt: z.boolean(), canDecryptVerify: z.boolean(), canVerify: z.boolean(), isPublicServerKeyGopengpgCompatible: z.boolean(), isPrivateServerKeyGopengpgCompatible: z.boolean()}), application: z.object({configPath: z.string(), info: z.object({remoteVersion: z.string(), currentVersion: z.string()}), latestVersion: z.boolean(), sslForce: z.boolean(), sslFullBaseUrl: z.boolean(), seleniumDisabled: z.boolean(), robotsIndexDisabled: z.boolean(), registrationClosed: z.object({isSelfRegistrationPluginEnabled: z.boolean(), selfRegistrationProvider: z.string(), isRegistrationPublicRemovedFromPassbolt: z.boolean()}), hostAvailabilityCheckEnabled: z.boolean(), jsProd: z.boolean(), emailNotificationEnabled: z.boolean(), schema: z.boolean()}), database: z.object({supportedBackend: z.boolean(), connect: z.boolean(), info: z.object({tablesCount: z.number().int()}), tablesCount: z.boolean(), defaultContent: z.boolean()})}); export const getApiHealthcheckJsonResponse = z.object({header: header, body: healthcheck}); 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 }; /** * Get healthcheck information. * * GET /healthcheck.json */ export const getApiHealthcheckJson = async (options?: GetApiHealthcheckJsonOptions) => { const {baseUrl = "https://passbolt.local", fetch: fetchFn = fetch, bearerHttpAuthentication} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (bearerHttpAuthentication !== undefined) headers.set('authorization', `Bearer ${bearerHttpAuthentication}`) const url = `${baseUrl.replace(/\/+$/, '')}/healthcheck.json${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(getApiHealthcheckJsonResponse, await res.json()) };