import {z} from 'zod' export type GetApiWorkspaceArgs = {sort?: (Array<'branch' | '-branch' | 'description' | '-description' | 'folder' | '-folder' | 'locked' | '-locked' | 'name' | '-name' | 'source' | '-source' | 'terraformVersion' | '-terraformVersion' | 'id' | '-id'>) | undefined, 'fields[workspace]'?: (Array<'branch' | 'description' | 'folder' | 'locked' | 'name' | 'source' | 'terraformVersion' | 'history' | 'job' | 'organization' | 'schedule' | 'ssh' | 'variable' | 'vcs'>) | undefined, include?: (Array<'history' | 'job' | 'organization' | 'schedule' | 'ssh' | 'variable' | 'vcs'>) | undefined, 'filter[workspace]'?: string | undefined, filter?: string | undefined, 'page[number]'?: number | undefined, 'page[size]'?: number | undefined, 'page[offset]'?: number | undefined, 'page[limit]'?: number | undefined, 'page[totals]'?: string | undefined}; export type GetApiWorkspaceOptions = {baseUrl: string, fetch?: typeof fetch | undefined}; export const workspace = z.object({type: z.string().optional(), id: z.string().optional(), attributes: z.object({branch: z.string().optional(), description: z.string().optional(), folder: z.string().optional(), locked: z.boolean().optional(), name: z.string().optional(), source: z.string().optional(), terraformVersion: z.string().optional()}).optional(), relationships: z.object({history: z.object({id: z.string().optional(), type: z.literal("history").optional()}).optional(), job: z.object({id: z.string().optional(), type: z.literal("job").optional()}).optional(), organization: z.object({id: z.string().optional(), type: z.literal("organization").optional()}).optional(), schedule: z.object({id: z.string().optional(), type: z.literal("schedule").optional()}).optional(), ssh: z.object({id: z.string().optional(), type: z.literal("ssh").optional()}).optional(), variable: z.object({id: z.string().optional(), type: z.literal("variable").optional()}).optional(), vcs: z.object({id: z.string().optional(), type: z.literal("vcs").optional()}).optional()}).optional()}); export const getApiWorkspaceResponse = z.object({data: z.array(workspace).optional(), included: z.array(z.object({attributes: z.object({}).optional(), id: z.string().optional(), relationships: z.object({}).optional(), type: z.string().optional()})).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 }; /** * Returns the collection of type workspace * * GET /workspace */ export const getApiWorkspace = async (args: GetApiWorkspaceArgs, options: GetApiWorkspaceOptions) => { const {baseUrl, fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.api+json") for (const item of args.sort ?? []) query.append("sort", String(item)) for (const item of args['fields[workspace]'] ?? []) query.append("fields[workspace]", String(item)) for (const item of args.include ?? []) query.append("include", String(item)) if (args['filter[workspace]'] != null) query.append("filter[workspace]", String(args['filter[workspace]'])) if (args.filter != null) query.append("filter", String(args.filter)) if (args['page[number]'] != null) query.append("page[number]", String(args['page[number]'])) if (args['page[size]'] != null) query.append("page[size]", String(args['page[size]'])) if (args['page[offset]'] != null) query.append("page[offset]", String(args['page[offset]'])) if (args['page[limit]'] != null) query.append("page[limit]", String(args['page[limit]'])) if (args['page[totals]'] != null) query.append("page[totals]", String(args['page[totals]'])) const url = `${baseUrl.replace(/\/+$/, '')}/workspace${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(getApiWorkspaceResponse, await res.json()) };