import {z} from 'zod' export type GetApiReleasesReleaseIdDeploymentsPreviewEnvironmentIdArgs = {releaseId: string, environmentId: string, includeDisabledSteps?: boolean | undefined, tenantId?: string | undefined}; export type GetApiReleasesReleaseIdDeploymentsPreviewEnvironmentIdOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const commitDetails = z.object({Comment: z.string().optional(), Id: z.string().optional(), LinkUrl: z.string().optional()}); export const workItemLink = z.object({Description: z.string().optional(), Id: z.string().optional(), LinkUrl: z.string().optional(), Source: z.string().optional()}); export const releasePackageVersionBuildInformation = z.object({Branch: z.string().optional(), BuildEnvironment: z.string().optional(), BuildNumber: z.string().optional(), BuildUrl: z.string().optional(), Commits: z.array(commitDetails).optional(), PackageId: z.string().optional(), VcsCommitNumber: z.string().optional(), VcsCommitUrl: z.string().optional(), VcsRoot: z.string().optional(), VcsType: z.string().optional(), Version: z.string().optional(), WorkItems: z.array(workItemLink).optional()}); export const releaseChangesResource = z.object({BuildInformation: z.array(releasePackageVersionBuildInformation).optional(), Commits: z.array(commitDetails).optional(), ReleaseNotes: z.string().optional(), Version: z.string().optional(), WorkItems: z.array(workItemLink).optional()}); 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 deploymentPreviewResource = z.object({Changes: z.array(releaseChangesResource).optional(), ChangesMarkdown: z.string().optional(), 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 document that describes what steps will/won't be run during a deployment to a given environment (and tenant if supplied). * * GET /releases/{releaseId}/deployments/preview/{environmentId} * * Also accepts auth: APIKeyQuery, NugetApiKeyHeader */ export const getApiReleasesReleaseIdDeploymentsPreviewEnvironmentId = async (args: GetApiReleasesReleaseIdDeploymentsPreviewEnvironmentIdArgs, options?: GetApiReleasesReleaseIdDeploymentsPreviewEnvironmentIdOptions) => { 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 (args.tenantId != null) query.append("tenantId", String(args.tenantId)) if (APIKeyHeader !== undefined) headers.set("X-Octopus-ApiKey", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/releases/${encodeURIComponent(String(args.releaseId))}/deployments/preview/${encodeURIComponent(String(args.environmentId))}${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(deploymentPreviewResource, await res.json()) };