@automate.ax/integration-contracts 0.86.2 → 0.87.0

package/src/github/resources.ts

@@ -0,0 +1,357 @@
+import type { Encodable } from "@automate.ax/codec"
+import type { Octokit } from "@octokit/rest"
+import * as z from "zod"
+
+/** Official repository response used by the exported runtime schema. */
+type GitHubRepository = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["get"]>
+>["data"] &
+  Encodable
+
+/** Official installation repository summary used by the list schema. */
+type GitHubRepositorySummary = Awaited<
+  ReturnType<Octokit["rest"]["apps"]["listReposAccessibleToInstallation"]>
+>["data"]["repositories"][number] &
+  Encodable
+
+/** Official repository content response used by the content schema. */
+type GitHubRepositoryContent = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["getContent"]>
+>["data"] &
+  Encodable
+
+/** Official file-write response used by the file commit schema. */
+type GitHubRepositoryFileCommit = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["createOrUpdateFileContents"]>
+>["data"] &
+  Encodable
+
+/** Official file-deletion response used by the deletion schema. */
+type GitHubRepositoryFileDeletion = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["deleteFile"]>
+>["data"] &
+  Encodable
+
+/** Official branch response used by the branch schema. */
+type GitHubBranch = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["getBranch"]>
+>["data"] &
+  Encodable
+
+/** Official branch summary used by the branch list schema. */
+type GitHubBranchSummary = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["listBranches"]>
+>["data"][number] &
+  Encodable
+
+/** Official Git reference response used by the reference schema. */
+type GitHubReference = Awaited<
+  ReturnType<Octokit["rest"]["git"]["createRef"]>
+>["data"] &
+  Encodable
+
+/** Official Actions workflow response used by the workflow schema. */
+type GitHubWorkflow = Awaited<
+  ReturnType<Octokit["rest"]["actions"]["getWorkflow"]>
+>["data"] &
+  Encodable
+
+/** Official Actions workflow-run response used by the run schema. */
+type GitHubWorkflowRun = Awaited<
+  ReturnType<Octokit["rest"]["actions"]["getWorkflowRun"]>
+>["data"] &
+  Encodable
+
+/** Official Actions job response used by the job schema. */
+type GitHubWorkflowJob = Awaited<
+  ReturnType<Octokit["rest"]["actions"]["listJobsForWorkflowRun"]>
+>["data"]["jobs"][number] &
+  Encodable
+
+/** Official pull request file response used by the file schema. */
+type GitHubPullRequestFile = Awaited<
+  ReturnType<Octokit["rest"]["pulls"]["listFiles"]>
+>["data"][number] &
+  Encodable
+
+/** Official pull request review response used by the review schema. */
+type GitHubPullRequestReview = Awaited<
+  ReturnType<Octokit["rest"]["pulls"]["createReview"]>
+>["data"] &
+  Encodable
+
+/** Official review-comment response used by the comment schema. */
+type GitHubPullRequestReviewComment = Awaited<
+  ReturnType<Octokit["rest"]["pulls"]["getReviewComment"]>
+>["data"] &
+  Encodable
+
+/** Official reviewer-request response used by the reviewer schema. */
+type GitHubPullRequestReviewRequest = Awaited<
+  ReturnType<Octokit["rest"]["pulls"]["requestReviewers"]>
+>["data"] &
+  Encodable
+
+/** Official pull request branch-update response used by its schema. */
+type GitHubPullRequestBranchUpdate = Awaited<
+  ReturnType<Octokit["rest"]["pulls"]["updateBranch"]>
+>["data"] &
+  Encodable
+
+/** Official release response used by the release schema. */
+type GitHubRelease = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["getRelease"]>
+>["data"] &
+  Encodable
+
+/** Official release-asset response used by the asset schema. */
+type GitHubReleaseAsset = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["getReleaseAsset"]>
+>["data"] &
+  Encodable
+
+/** Official deployment response used by the deployment schema. */
+type GitHubDeployment = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["getDeployment"]>
+>["data"] &
+  Encodable
+
+/** Official deployment-creation response used by its result schema. */
+type GitHubDeploymentCreation = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["createDeployment"]>
+>["data"] &
+  Encodable
+
+/** Official deployment-status response used by the status schema. */
+type GitHubDeploymentStatus = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["createDeploymentStatus"]>
+>["data"] &
+  Encodable
+
+/** Official commit-status response used by the status schema. */
+type GitHubCommitStatus = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["createCommitStatus"]>
+>["data"] &
+  Encodable
+
+/** Official check-run response used by the check-run schema. */
+type GitHubCheckRun = Awaited<
+  ReturnType<Octokit["rest"]["checks"]["get"]>
+>["data"] &
+  Encodable
+
+/** Official combined-status response used by the combined status schema. */
+type GitHubCombinedCommitStatus = Awaited<
+  ReturnType<Octokit["rest"]["repos"]["getCombinedStatusForRef"]>
+>["data"] &
+  Encodable
+
+/** Current GitHub REST response for a successful workflow dispatch. */
+export interface GitHubWorkflowDispatchResult
+  extends Record<string, Encodable> {
+  /** Web URL for the created workflow run. */
+  html_url: string
+
+  /** API URL for the created workflow run. */
+  run_url: string
+
+  /** Stable ID of the created workflow run. */
+  workflow_run_id: number
+}
+
+const GITHUB_REPOSITORY_BASE_SCHEMA = z.looseObject({
+  full_name: z.string(),
+  id: z.number().int().positive(),
+  name: z.string(),
+})
+const GITHUB_REPOSITORY_CONTENT_BASE_SCHEMA = z.union([
+  z.looseObject({ path: z.string(), sha: z.string(), type: z.string() }),
+  z
+    .looseObject({ path: z.string(), sha: z.string(), type: z.string() })
+    .array(),
+])
+const GITHUB_FILE_COMMIT_BASE_SCHEMA = z.looseObject({
+  commit: z.looseObject({ sha: z.string() }),
+  content: z.looseObject({ path: z.string(), sha: z.string() }).nullable(),
+})
+const GITHUB_BRANCH_BASE_SCHEMA = z.looseObject({
+  commit: z.looseObject({ sha: z.string() }),
+  name: z.string(),
+})
+const GITHUB_REFERENCE_BASE_SCHEMA = z.looseObject({
+  object: z.looseObject({ sha: z.string(), type: z.string() }),
+  ref: z.string(),
+})
+const GITHUB_WORKFLOW_BASE_SCHEMA = z.looseObject({
+  id: z.number().int().positive(),
+  name: z.string(),
+  path: z.string(),
+  state: z.string(),
+})
+const GITHUB_WORKFLOW_RUN_BASE_SCHEMA = z.looseObject({
+  conclusion: z.string().nullable(),
+  html_url: z.string(),
+  id: z.number().int().positive(),
+  status: z.string().nullable(),
+})
+const GITHUB_WORKFLOW_JOB_BASE_SCHEMA = z.looseObject({
+  conclusion: z.string().nullable(),
+  id: z.number().int().positive(),
+  name: z.string(),
+  status: z.string(),
+})
+const GITHUB_PULL_REQUEST_FILE_BASE_SCHEMA = z.looseObject({
+  filename: z.string(),
+  sha: z.string(),
+  status: z.string(),
+})
+const GITHUB_PULL_REQUEST_REVIEW_BASE_SCHEMA = z.looseObject({
+  id: z.number().int().positive(),
+  state: z.string(),
+})
+const GITHUB_PULL_REQUEST_REVIEW_COMMENT_BASE_SCHEMA = z.looseObject({
+  body: z.string(),
+  id: z.number().int().positive(),
+  path: z.string(),
+})
+const GITHUB_PULL_REQUEST_BRANCH_UPDATE_BASE_SCHEMA = z.looseObject({
+  message: z.string(),
+  url: z.string(),
+})
+const GITHUB_RELEASE_BASE_SCHEMA = z.looseObject({
+  draft: z.boolean(),
+  id: z.number().int().positive(),
+  prerelease: z.boolean(),
+  tag_name: z.string(),
+})
+const GITHUB_RELEASE_ASSET_BASE_SCHEMA = z.looseObject({
+  browser_download_url: z.string(),
+  id: z.number().int().positive(),
+  name: z.string(),
+  size: z.number().int().nonnegative(),
+  state: z.string(),
+})
+const GITHUB_DEPLOYMENT_BASE_SCHEMA = z.looseObject({
+  environment: z.string(),
+  id: z.number().int().positive(),
+  ref: z.string(),
+})
+const GITHUB_DEPLOYMENT_CREATION_BASE_SCHEMA = z.union([
+  GITHUB_DEPLOYMENT_BASE_SCHEMA,
+  z.looseObject({ message: z.string() }),
+])
+const GITHUB_DEPLOYMENT_STATUS_BASE_SCHEMA = z.looseObject({
+  id: z.number().int().positive(),
+  state: z.string(),
+})
+const GITHUB_COMMIT_STATUS_BASE_SCHEMA = z.looseObject({
+  context: z.string(),
+  id: z.number().int().positive(),
+  state: z.string(),
+})
+const GITHUB_CHECK_RUN_BASE_SCHEMA = z.looseObject({
+  conclusion: z.string().nullable(),
+  head_sha: z.string(),
+  id: z.number().int().positive(),
+  name: z.string(),
+  status: z.string(),
+})
+
+export const GITHUB_REPOSITORY_SCHEMA = githubResourceSchema<GitHubRepository>(
+  GITHUB_REPOSITORY_BASE_SCHEMA,
+)
+export const GITHUB_REPOSITORY_SUMMARY_SCHEMA =
+  githubResourceSchema<GitHubRepositorySummary>(GITHUB_REPOSITORY_BASE_SCHEMA)
+export const GITHUB_REPOSITORY_CONTENT_SCHEMA =
+  githubResourceSchema<GitHubRepositoryContent>(
+    GITHUB_REPOSITORY_CONTENT_BASE_SCHEMA,
+  )
+export const GITHUB_REPOSITORY_FILE_COMMIT_SCHEMA =
+  githubResourceSchema<GitHubRepositoryFileCommit>(
+    GITHUB_FILE_COMMIT_BASE_SCHEMA,
+  )
+export const GITHUB_REPOSITORY_FILE_DELETION_SCHEMA =
+  githubResourceSchema<GitHubRepositoryFileDeletion>(
+    GITHUB_FILE_COMMIT_BASE_SCHEMA,
+  )
+export const GITHUB_BRANCH_SCHEMA = githubResourceSchema<GitHubBranch>(
+  GITHUB_BRANCH_BASE_SCHEMA,
+)
+export const GITHUB_BRANCH_SUMMARY_SCHEMA =
+  githubResourceSchema<GitHubBranchSummary>(GITHUB_BRANCH_BASE_SCHEMA)
+export const GITHUB_REFERENCE_SCHEMA = githubResourceSchema<GitHubReference>(
+  GITHUB_REFERENCE_BASE_SCHEMA,
+)
+export const GITHUB_WORKFLOW_SCHEMA = githubResourceSchema<GitHubWorkflow>(
+  GITHUB_WORKFLOW_BASE_SCHEMA,
+)
+export const GITHUB_WORKFLOW_RUN_SCHEMA =
+  githubResourceSchema<GitHubWorkflowRun>(GITHUB_WORKFLOW_RUN_BASE_SCHEMA)
+export const GITHUB_WORKFLOW_JOB_SCHEMA =
+  githubResourceSchema<GitHubWorkflowJob>(GITHUB_WORKFLOW_JOB_BASE_SCHEMA)
+export const GITHUB_PULL_REQUEST_FILE_SCHEMA =
+  githubResourceSchema<GitHubPullRequestFile>(
+    GITHUB_PULL_REQUEST_FILE_BASE_SCHEMA,
+  )
+export const GITHUB_PULL_REQUEST_REVIEW_RESOURCE_SCHEMA =
+  githubResourceSchema<GitHubPullRequestReview>(
+    GITHUB_PULL_REQUEST_REVIEW_BASE_SCHEMA,
+  )
+export const GITHUB_PULL_REQUEST_REVIEW_REQUEST_SCHEMA =
+  githubResourceSchema<GitHubPullRequestReviewRequest>(
+    GITHUB_PULL_REQUEST_REVIEW_BASE_SCHEMA,
+  )
+export const GITHUB_PULL_REQUEST_REVIEW_COMMENT_SCHEMA =
+  githubResourceSchema<GitHubPullRequestReviewComment>(
+    GITHUB_PULL_REQUEST_REVIEW_COMMENT_BASE_SCHEMA,
+  )
+export const GITHUB_PULL_REQUEST_BRANCH_UPDATE_SCHEMA =
+  githubResourceSchema<GitHubPullRequestBranchUpdate>(
+    GITHUB_PULL_REQUEST_BRANCH_UPDATE_BASE_SCHEMA,
+  )
+export const GITHUB_RELEASE_SCHEMA = githubResourceSchema<GitHubRelease>(
+  GITHUB_RELEASE_BASE_SCHEMA,
+)
+export const GITHUB_RELEASE_ASSET_SCHEMA =
+  githubResourceSchema<GitHubReleaseAsset>(GITHUB_RELEASE_ASSET_BASE_SCHEMA)
+export const GITHUB_DEPLOYMENT_SCHEMA = githubResourceSchema<GitHubDeployment>(
+  GITHUB_DEPLOYMENT_BASE_SCHEMA,
+)
+export const GITHUB_DEPLOYMENT_CREATION_SCHEMA =
+  githubResourceSchema<GitHubDeploymentCreation>(
+    GITHUB_DEPLOYMENT_CREATION_BASE_SCHEMA,
+  )
+export const GITHUB_DEPLOYMENT_STATUS_SCHEMA =
+  githubResourceSchema<GitHubDeploymentStatus>(
+    GITHUB_DEPLOYMENT_STATUS_BASE_SCHEMA,
+  )
+export const GITHUB_COMMIT_STATUS_SCHEMA =
+  githubResourceSchema<GitHubCommitStatus>(GITHUB_COMMIT_STATUS_BASE_SCHEMA)
+export const GITHUB_CHECK_RUN_SCHEMA = githubResourceSchema<GitHubCheckRun>(
+  GITHUB_CHECK_RUN_BASE_SCHEMA,
+)
+export const GITHUB_COMBINED_COMMIT_STATUS_SCHEMA =
+  githubResourceSchema<GitHubCombinedCommitStatus>(
+    z.looseObject({
+      sha: z.string(),
+      state: z.string(),
+      statuses: GITHUB_COMMIT_STATUS_BASE_SCHEMA.array(),
+      total_count: z.number().int().nonnegative(),
+    }),
+  )
+export const GITHUB_WORKFLOW_DISPATCH_RESULT_SCHEMA: z.ZodType<GitHubWorkflowDispatchResult> =
+  z.object({
+    html_url: z.string(),
+    run_url: z.string(),
+    workflow_run_id: z.number().int().positive(),
+  })
+export const GITHUB_EMPTY_RESPONSE_SCHEMA = z.object({})
+
+/**
+ * Validates a provider resource while preserving its official Octokit type.
+ *
+ * @param schema - Runtime schema for the resource's stable fields.
+ */
+function githubResourceSchema<T>(schema: z.ZodType): z.ZodType<T> {
+  return z.custom<T>((value) => schema.safeParse(value).success)
+}

package/src/github/schemas.ts

@@ -3,6 +3,9 @@ import type { webhooks } from "@octokit/openapi-webhooks-types"
 import type { Octokit } from "@octokit/rest"
 import * as z from "zod"
 
+export * from "./resources"
+export * from "./additional-events"
+
 const GITHUB_EVENT_BASE_SCHEMA = z.looseObject({
   installation: z.looseObject({ id: z.number().int().positive() }),
   repository: z.looseObject({