import {z} from 'zod' export type GetApiReleasesReleaseIdProgressionArgs = {releaseId: string}; export type GetApiReleasesReleaseIdProgressionOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const changeRequestSettings = z.object({Type: z.enum(["ServiceNow", "JiraServiceManagement"]).optional()}); 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 stepLogContext = z.object({CorrelationId: z.string(), Slug: z.string().min(1)}); export const executionPlanLogContext = z.object({Steps: z.array(stepLogContext)}); export const retentionPeriod = z.object({QuantityToKeep: z.number().int().optional(), ShouldKeepForever: z.boolean().optional(), Strategy: z.string().optional(), Unit: z.enum(["Days", "Items"]).optional()}); export const deploymentResource = z.object({ChangeRequestSettings: z.array(changeRequestSettings).optional(), Changes: z.array(releaseChangesResource).optional(), ChangesMarkdown: z.string().optional(), ChannelId: z.string().optional(), Comments: z.string().optional(), Created: z.string().optional(), DebugMode: z.string().optional(), DeployedBy: z.string().optional(), DeployedByActorType: z.enum(["Unknown", "System", "User", "Agent", "ServiceAccount"]).optional(), DeployedById: z.string().optional(), DeployedToMachineIds: z.array(z.string()).optional(), DeploymentProcessId: z.string().optional(), EnvironmentId: z.string(), ExcludedMachineIds: z.array(z.string()).optional(), ExcludedTargetTagIds: z.array(z.string()).optional(), ExecutionPlanLogContext: executionPlanLogContext.optional(), FailTargetDiscovery: z.boolean().optional(), FailureEncountered: z.boolean().optional(), ForcePackageDownload: z.boolean().optional(), ForcePackageRedeployment: z.boolean().optional(), FormValues: z.record(z.string(), z.string()).optional(), Id: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), ManifestVariableSetId: z.string().optional(), Name: z.string().optional(), Priority: z.string().optional(), ProjectId: z.string().optional(), QueueTime: z.string().optional(), QueueTimeExpiry: z.string().optional(), ReleaseId: z.string(), SkipActions: z.array(z.string()).optional(), SpaceId: z.string().optional(), SpecificMachineIds: z.array(z.string()).optional(), SpecificTargetTagIds: z.array(z.string()).optional(), TaskId: z.string().optional(), TenantId: z.string().optional(), TentacleRetentionPeriod: retentionPeriod.optional(), UseGuidedFailure: z.boolean().optional()}); export const taskResource = z.object({Arguments: z.record(z.string(), z.unknown()).optional(), CanRerun: z.boolean().optional(), Completed: z.string().optional(), CompletedTime: z.string().optional(), Description: z.string().optional(), Duration: z.string().optional(), ErrorMessage: z.string().optional(), EstimatedRemainingQueueDurationSeconds: z.number().int().optional(), FinishedSuccessfully: z.boolean().optional(), HasBeenPickedUpByProcessor: z.boolean().optional(), HasPendingInterruptions: z.boolean().optional(), HasPendingPreconditions: z.boolean().optional(), HasWarningsOrErrors: z.boolean().optional(), Id: z.string().optional(), IsCompleted: z.boolean().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), LastUpdatedTime: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), Name: z.string().optional(), PendingInterruptionTypes: z.array(z.enum(["ManualIntervention", "GuidedFailure", "PullRequestCompletion", "ArgoCDApplicationSync", "KubernetesResourceVerification"])).optional(), PendingPreconditionTypes: z.array(z.string()).optional(), ProjectId: z.string().optional(), QueueTime: z.string().optional(), QueueTimeExpiry: z.string().optional(), ServerNode: z.string().optional(), SpaceId: z.string().optional(), StartTime: z.string().optional(), State: z.enum(["Queued", "Executing", "Failed", "Canceled", "TimedOut", "Success", "Cancelling"]).optional()}); export const phaseDeploymentResource = z.object({Deployment: deploymentResource.optional(), Task: taskResource.optional()}); export const phaseProgressionResource = z.object({AutomaticDeploymentTargets: z.array(z.string()).optional(), Blocked: z.boolean().optional(), Deployments: z.array(phaseDeploymentResource).optional(), Id: z.string().optional(), IsOptionalPhase: z.boolean().optional(), IsPriorityPhase: z.boolean().optional(), MinimumEnvironmentsBeforePromotion: z.number().int().optional(), Name: z.string().optional(), OptionalDeploymentTargets: z.array(z.string()).optional(), Progress: z.enum(["Pending", "Current", "Complete"]).optional()}); export const lifecycleProgressionResource = z.object({Id: z.string().optional(), LastModifiedBy: z.string().optional(), LastModifiedOn: z.string().optional(), Links: z.record(z.string(), z.string()).optional(), NextDeployments: z.array(z.string()).optional(), NextDeploymentsMinimumRequired: z.number().int().optional(), Phases: z.array(phaseProgressionResource).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 all of the information necessary for creating or editing a deployment for this release. * * GET /releases/{releaseId}/progression * * Also accepts auth: APIKeyQuery, NugetApiKeyHeader */ export const getApiReleasesReleaseIdProgression = async (args: GetApiReleasesReleaseIdProgressionArgs, options?: GetApiReleasesReleaseIdProgressionOptions) => { 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 (APIKeyHeader !== undefined) headers.set("X-Octopus-ApiKey", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/releases/${encodeURIComponent(String(args.releaseId))}/progression${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(lifecycleProgressionResource, await res.json()) };