import {z} from 'zod' export type GetApiProjectsProjectIdGitRefRunbooksIdRunbookRunsPreviewEnvironmentTenantArgs = {projectId: string, gitRef: string, id: string, environment: string, tenant: string, includeDisabledSteps?: boolean | undefined}; export type GetApiProjectsProjectIdGitRefRunbooksIdRunbookRunsPreviewEnvironmentTenantOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const control = z.object({Type: z.enum(["Checkbox", "TextArea", "Paragraph", "SubmitButtonGroup", "VariableValue"]).optional()}); export const formElement = z.object({Control: control.optional(), IsValueRequired: z.boolean().optional(), Name: z.string().optional()}); export const form = z.object({Elements: z.array(formElement).optional(), Values: z.record(z.string(), z.string()).optional()}); export const targetTagPreview = z.object({SortOrder: z.number().int().optional(), TagId: z.string().min(1), TagName: z.string().min(1)}); export const tagSetPreview = z.object({AvailableTags: z.array(targetTagPreview).optional(), SortOrder: z.number().int().optional(), TagSetId: z.string().min(1), TagSetName: z.string().min(1), TagSetType: z.string()}); export const referenceDataItem = z.object({Id: z.string().optional(), Name: z.string().optional()}); export const machineDeploymentPreview = z.object({HasLatestCalamari: z.boolean().optional(), HealthStatus: z.enum(["Healthy", "HasWarnings", "Unhealthy", "Unavailable"]).optional(), Id: z.string().optional(), Name: z.string().optional()}); export const deploymentTemplateStep = z.object({ActionId: z.string().optional(), ActionName: z.string().optional(), ActionNumber: z.string().optional(), AvailableTagSets: z.array(tagSetPreview).optional(), CanBeSkipped: z.boolean().optional(), ExcludedMachines: z.array(referenceDataItem).optional(), HasNoApplicableMachines: z.boolean().optional(), IsDisabled: z.boolean().optional(), MachineNames: z.array(z.string()).optional(), Machines: z.array(machineDeploymentPreview).optional(), Roles: z.array(z.string()).optional(), UnavailableMachines: z.array(referenceDataItem).optional()}); export const runbookRunPreviewResource = z.object({Form: form.optional(), Id: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), StepsToExecute: z.array(deploymentTemplateStep).optional(), UseGuidedFailureModeByDefault: z.boolean().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 }; /** * Get a Runbook Run Preview for a Runbook * * GET /projects/{projectId}/{gitRef}/runbooks/{id}/runbookRuns/preview/{environment}/{tenant} * * Also accepts auth: APIKeyQuery, NugetApiKeyHeader */ export const getApiProjectsProjectIdGitRefRunbooksIdRunbookRunsPreviewEnvironmentTenant = async (args: GetApiProjectsProjectIdGitRefRunbooksIdRunbookRunsPreviewEnvironmentTenantArgs, options?: GetApiProjectsProjectIdGitRefRunbooksIdRunbookRunsPreviewEnvironmentTenantOptions) => { const {baseUrl = "https://demo.octopus.app/api", fetch: fetchFn = fetch, APIKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.includeDisabledSteps != null) query.append("includeDisabledSteps", String(args.includeDisabledSteps)) if (APIKeyHeader !== undefined) headers.set("X-Octopus-ApiKey", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/projects/${encodeURIComponent(String(args.projectId))}/${encodeURIComponent(String(args.gitRef))}/runbooks/${encodeURIComponent(String(args.id))}/runbookRuns/preview/${encodeURIComponent(String(args.environment))}/${encodeURIComponent(String(args.tenant))}${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(runbookRunPreviewResource, await res.json()) };