import {z} from 'zod' export type GetApiMetadataUpgradeResourcesJsonArgs = {'filter[is-shared]'?: boolean | undefined}; export type GetApiMetadataUpgradeResourcesJsonOptions = {baseUrl?: string | undefined, bearerHttpAuthentication?: string | undefined, fetch?: typeof fetch | undefined}; export const headerWithPagination = 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(), pagination: z.object({count: z.number().int(), page: z.number().int(), limit: z.number().int()})}); export const favorite = z.object({id: z.string(), user_id: z.string(), foreign_key: z.string(), foreign_model: z.literal("Resource"), created: z.string(), modified: z.string()}); export const groupsUsersIndexAndView = z.object({id: z.string(), group_id: z.string(), user_id: z.string(), is_admin: z.boolean(), created: z.string(), user: z.lazy(() => userIndexAndView.optional())}); export const gpgkey = z.object({id: z.string(), user_id: z.string(), armored_key: z.string(), bits: z.number().int(), uid: z.string(), key_id: z.string(), fingerprint: z.string(), type: z.enum(["RSA", "ECC"]), expires: z.string(), deleted: z.boolean(), created: z.string(), modified: z.string()}); export const role = z.object({id: z.string(), name: z.enum(["admin", "guest", "user"]), description: z.string(), created: z.string(), modified: z.string()}); export const userIndexAndView: z.ZodType = z.object({is_mfa_enabled: z.boolean().optional(), id: z.string(), role_id: z.string(), username: z.string(), active: z.boolean(), deleted: z.boolean(), created: z.string(), modified: z.string(), disabled: z.string(), profile: z.object({id: z.string(), user_id: z.string(), first_name: z.string(), last_name: z.string(), created: z.string(), modified: z.string(), avatar: z.object({id: z.string().optional(), profile_id: z.string().optional(), created: z.string().optional(), modified: z.string().optional(), url: z.object({medium: z.string(), small: z.string()})})}).optional(), groups_users: groupsUsersIndexAndView.optional(), gpgkey: gpgkey.optional(), role: role.optional(), missing_metadata_key_ids: z.array(z.string()).optional(), last_logged_in: z.string().optional()}); export const secretIndex = z.object({id: z.string(), user_id: z.string(), resource_id: z.string(), data: z.string(), created: z.string(), modified: z.string()}); export const resourceType = z.object({id: z.string(), slug: z.enum(["password-string", "password-and-description", "totp", "password-description-totp", "v5-default-with-totp", "v5-password-string (Deprecated)", "v5-totp-standalone", "v5-default"]), name: z.string(), description: z.string(), definition: z.object({}), deleted: z.string(), created: z.string(), modified: z.string()}); export const permissionLevel = z.union([z.literal(1), z.literal(7), z.literal(15)]); export const groupIndexAndView = z.object({id: z.string(), name: z.string(), deleted: z.boolean(), created: z.string(), modified: z.string(), created_by: z.string(), modified_by: z.string(), my_group_user: groupsUsersIndexAndView.optional(), groups_users: z.array(groupsUsersIndexAndView).optional(), user_count: z.number().int().optional()}); export const permissionIndexAndView = z.object({id: z.string(), aco: z.enum(["Resource", "Folder"]), aco_foreign_key: z.string(), aro: z.enum(["User", "Group"]), aro_foreign_key: z.string(), type: permissionLevel, created: z.string(), modified: z.string(), user: userIndexAndView.optional(), group: groupIndexAndView.optional()}); export const resourceV4IndexAndView = z.object({id: z.string(), name: z.string(), username: z.string(), uri: z.string(), description: z.string(), deleted: z.boolean(), created: z.string(), created_by: z.string(), modified_by: z.string(), resource_type_id: z.string(), expired: z.string(), folder_parent_id: z.string(), personal: z.boolean(), favorite: favorite.optional(), modifier: userIndexAndView.optional(), creator: userIndexAndView.optional(), secrets: z.array(secretIndex).optional(), resource_type: resourceType.optional(), permission: permissionIndexAndView.optional(), permissions: z.array(permissionIndexAndView).optional()}); export const getApiMetadataUpgradeResourcesJsonResponse = z.object({header: headerWithPagination, body: z.array(resourceV4IndexAndView)}); 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 Upgradable Resources * * GET /metadata/upgrade/resources.json */ export const getApiMetadataUpgradeResourcesJson = async (args: GetApiMetadataUpgradeResourcesJsonArgs, options?: GetApiMetadataUpgradeResourcesJsonOptions) => { const {baseUrl = "https://passbolt.local", fetch: fetchFn = fetch, bearerHttpAuthentication} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['filter[is-shared]'] != null) query.append("filter[is-shared]", String(args['filter[is-shared]'])) if (bearerHttpAuthentication !== undefined) headers.set('authorization', `Bearer ${bearerHttpAuthentication}`) const url = `${baseUrl.replace(/\/+$/, '')}/metadata/upgrade/resources.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(getApiMetadataUpgradeResourcesJsonResponse, await res.json()) };