@useairfoil/producer-github 0.0.2 → 0.0.3

package/src/schemas/releases.ts

@@ -1,41 +1,58 @@
 import { Iceberg } from "@useairfoil/connector-kit";
 import { Schema, Struct } from "effect";
 
-import { Long, Text, Timestamp, deleted, field, list, user, version } from "./shared";
+import { Long, Text, Timestamp, deleted, user, version } from "./shared";
 
-const asset = (baseId: number) =>
-  Schema.Struct({
-    id: Long.pipe(field(baseId, "Asset ID.")),
-    name: Schema.String.pipe(field(baseId + 1, "File name.")),
-    label: Schema.NullOr(Schema.String).pipe(field(baseId + 2, "Label shown instead of the name.")),
-    state: Schema.String.pipe(field(baseId + 3, "State: uploaded or open.")),
-    content_type: Schema.String.pipe(field(baseId + 4, "Media type of the file.")),
-    size: Long.pipe(field(baseId + 5, "Size in bytes.")),
-    download_count: Long.pipe(
-      field(baseId + 6, "Number of downloads when the release last changed."),
-    ),
-    created_at: Timestamp.pipe(field(baseId + 7, "Time the asset was uploaded.")),
-    updated_at: Timestamp.pipe(field(baseId + 8, "Time the asset last changed.")),
-    browser_download_url: Schema.String.pipe(field(baseId + 9, "Download link.")),
-  });
+const asset = Schema.Struct({
+  id: Long.pipe(Schema.annotateKey({ description: "Asset ID." })),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "File name." })),
+  label: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Label shown instead of the name." }),
+  ),
+  state: Schema.String.pipe(Schema.annotateKey({ description: "State: uploaded or open." })),
+  content_type: Schema.String.pipe(Schema.annotateKey({ description: "Media type of the file." })),
+  size: Long.pipe(Schema.annotateKey({ description: "Size in bytes." })),
+  download_count: Long.pipe(
+    Schema.annotateKey({ description: "Number of downloads when the release last changed." }),
+  ),
+  created_at: Timestamp.pipe(Schema.annotateKey({ description: "Time the asset was uploaded." })),
+  updated_at: Timestamp.pipe(Schema.annotateKey({ description: "Time the asset last changed." })),
+  browser_download_url: Schema.String.pipe(Schema.annotateKey({ description: "Download link." })),
+});
 
 export const ReleaseSchema = Schema.Struct({
-  id: Long.pipe(field(1, "Unique release ID.")),
-  version: version(2, "release"),
-  node_id: Schema.String.pipe(field(3, "GraphQL node ID of the release.")),
-  repository_id: Long.pipe(field(4, "ID of the repository the release belongs to.")),
-  tag_name: Schema.String.pipe(field(5, "Tag of the release.")),
-  target_commitish: Schema.String.pipe(field(6, "Branch or commit the tag was created from.")),
-  name: Text.pipe(field(7, "Release title. Empty when not set.")),
-  body: Text.pipe(field(8, "Release notes in Markdown. Empty when not set.")),
-  draft: Schema.Boolean.pipe(field(9, "Whether the release is a draft.")),
-  prerelease: Schema.Boolean.pipe(field(10, "Whether the release is a pre-release.")),
-  author: user(100).pipe(field(11, "Account that created the release.")),
-  assets: list(103, asset(104)).pipe(field(12, "Files attached to the release.")),
-  created_at: Timestamp.pipe(field(13, "Time the release was created.")),
-  published_at: Schema.NullOr(Timestamp).pipe(field(14, "Time the release was published.")),
-  html_url: Schema.String.pipe(field(15, "Release page on GitHub.")),
-  _deleted: deleted(16, "release"),
+  id: Long.pipe(Schema.annotateKey({ description: "Unique release ID." })),
+  version: version("release"),
+  node_id: Schema.String.pipe(
+    Schema.annotateKey({ description: "GraphQL node ID of the release." }),
+  ),
+  repository_id: Long.pipe(
+    Schema.annotateKey({ description: "ID of the repository the release belongs to." }),
+  ),
+  tag_name: Schema.String.pipe(Schema.annotateKey({ description: "Tag of the release." })),
+  target_commitish: Schema.String.pipe(
+    Schema.annotateKey({ description: "Branch or commit the tag was created from." }),
+  ),
+  name: Text.pipe(Schema.annotateKey({ description: "Release title. Empty when not set." })),
+  body: Text.pipe(
+    Schema.annotateKey({ description: "Release notes in Markdown. Empty when not set." }),
+  ),
+  draft: Schema.Boolean.pipe(
+    Schema.annotateKey({ description: "Whether the release is a draft." }),
+  ),
+  prerelease: Schema.Boolean.pipe(
+    Schema.annotateKey({ description: "Whether the release is a pre-release." }),
+  ),
+  author: user.pipe(Schema.annotateKey({ description: "Account that created the release." })),
+  assets: Schema.Array(asset).pipe(
+    Schema.annotateKey({ description: "Files attached to the release." }),
+  ),
+  created_at: Timestamp.pipe(Schema.annotateKey({ description: "Time the release was created." })),
+  published_at: Schema.NullOr(Timestamp).pipe(
+    Schema.annotateKey({ description: "Time the release was published." }),
+  ),
+  html_url: Schema.String.pipe(Schema.annotateKey({ description: "Release page on GitHub." })),
+  _deleted: deleted("release"),
 })
   .annotate({
     description: "Releases in the installation's repositories, with their assets.",

package/src/schemas/repositories.ts

@@ -1,29 +1,49 @@
 import { Iceberg } from "@useairfoil/connector-kit";
 import { Effect, Schema, Struct } from "effect";
 
-import { Long, Text, Timestamp, deleted, field, list, optionalList, user, version } from "./shared";
+import { Long, Text, Timestamp, deleted, optionalList, user, version } from "./shared";
 
 export const RepositorySchema = Schema.Struct({
-  id: Long.pipe(field(1, "Unique repository ID.")),
-  version: version(2, "repository"),
-  node_id: Schema.String.pipe(field(3, "GraphQL node ID of the repository.")),
-  name: Schema.String.pipe(field(4, "Repository name.")),
-  full_name: Schema.String.pipe(field(5, "Owner and name, such as octo-org/octo-repo.")),
-  owner: user(100).pipe(field(6, "Account that owns the repository.")),
-  private: Schema.Boolean.pipe(field(7, "Whether the repository is private.")),
+  id: Long.pipe(Schema.annotateKey({ description: "Unique repository ID." })),
+  version: version("repository"),
+  node_id: Schema.String.pipe(
+    Schema.annotateKey({ description: "GraphQL node ID of the repository." }),
+  ),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "Repository name." })),
+  full_name: Schema.String.pipe(
+    Schema.annotateKey({ description: "Owner and name, such as octo-org/octo-repo." }),
+  ),
+  owner: user.pipe(Schema.annotateKey({ description: "Account that owns the repository." })),
+  private: Schema.Boolean.pipe(
+    Schema.annotateKey({ description: "Whether the repository is private." }),
+  ),
   visibility: Schema.optionalKey(Schema.String).pipe(
-    field(8, "Visibility: public, private, or internal."),
-  ),
-  description: Text.pipe(field(9, "Repository description. Empty when not set.")),
-  fork: Schema.Boolean.pipe(field(10, "Whether the repository is a fork.")),
-  archived: Schema.Boolean.pipe(field(11, "Whether the repository is archived.")),
-  disabled: Schema.Boolean.pipe(field(12, "Whether the repository is disabled.")),
-  default_branch: Schema.String.pipe(field(13, "Default branch name.")),
-  language: Schema.NullOr(Schema.String).pipe(field(14, "Main language GitHub detected.")),
-  topics: list(103, Schema.String).pipe(field(15, "Repository topics.")),
-  html_url: Schema.String.pipe(field(16, "Repository page on GitHub.")),
-  created_at: Timestamp.pipe(field(17, "Time the repository was created.")),
-  _deleted: deleted(18, "repository"),
+    Schema.annotateKey({ description: "Visibility: public, private, or internal." }),
+  ),
+  description: Text.pipe(
+    Schema.annotateKey({ description: "Repository description. Empty when not set." }),
+  ),
+  fork: Schema.Boolean.pipe(
+    Schema.annotateKey({ description: "Whether the repository is a fork." }),
+  ),
+  archived: Schema.Boolean.pipe(
+    Schema.annotateKey({ description: "Whether the repository is archived." }),
+  ),
+  disabled: Schema.Boolean.pipe(
+    Schema.annotateKey({ description: "Whether the repository is disabled." }),
+  ),
+  default_branch: Schema.String.pipe(Schema.annotateKey({ description: "Default branch name." })),
+  language: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Main language GitHub detected." }),
+  ),
+  topics: Schema.Array(Schema.String).pipe(
+    Schema.annotateKey({ description: "Repository topics." }),
+  ),
+  html_url: Schema.String.pipe(Schema.annotateKey({ description: "Repository page on GitHub." })),
+  created_at: Timestamp.pipe(
+    Schema.annotateKey({ description: "Time the repository was created." }),
+  ),
+  _deleted: deleted("repository"),
 })
   .annotate({
     description: "Repositories the GitHub App installation can read.",

package/src/schemas/shared.ts

@@ -1,9 +1,5 @@
-import { Iceberg } from "@useairfoil/connector-kit";
 import { Schema, SchemaTransformation } from "effect";
 
-export const field = (fieldId: number, description: string) =>
-  Iceberg.field(fieldId, { description });
-
 /** IDs and counts. Connector Kit maps whole numbers to Iceberg longs. */
 export const Long = Schema.Int.pipe(
   Schema.decodeTo(
@@ -42,45 +38,39 @@ export const optionalList = <S extends Schema.Top>(item: S) =>
     ),
   );
 
-// Each helper takes the first field ID of its block.
-export const user = (baseId: number) =>
-  Schema.Struct({
-    id: Long.pipe(field(baseId, "GitHub user ID.")),
-    login: Schema.String.pipe(field(baseId + 1, "GitHub username.")),
-    type: Schema.String.pipe(
-      field(baseId + 2, "Account type, such as User, Bot, or Organization."),
-    ),
-  });
-
-export const label = (baseId: number) =>
-  Schema.Struct({
-    id: Long.pipe(field(baseId, "Label ID.")),
-    name: Schema.String.pipe(field(baseId + 1, "Label name.")),
-  });
+export const user = Schema.Struct({
+  id: Long.pipe(Schema.annotateKey({ description: "GitHub user ID." })),
+  login: Schema.String.pipe(Schema.annotateKey({ description: "GitHub username." })),
+  type: Schema.String.pipe(
+    Schema.annotateKey({ description: "Account type, such as User, Bot, or Organization." }),
+  ),
+});
 
-export const milestone = (baseId: number) =>
-  Schema.Struct({
-    id: Long.pipe(field(baseId, "Milestone ID.")),
-    number: Long.pipe(field(baseId + 1, "Milestone number in the repository.")),
-    title: Schema.String.pipe(field(baseId + 2, "Milestone title.")),
-  });
+export const label = Schema.Struct({
+  id: Long.pipe(Schema.annotateKey({ description: "Label ID." })),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "Label name." })),
+});
 
-/** A list column. The element ID is separate from the column's field ID. */
-export const list = <S extends Schema.Top>(elementId: number, item: S) =>
-  Schema.Array(item.annotate({ fieldId: elementId }));
+export const milestone = Schema.Struct({
+  id: Long.pipe(Schema.annotateKey({ description: "Milestone ID." })),
+  number: Long.pipe(Schema.annotateKey({ description: "Milestone number in the repository." })),
+  title: Schema.String.pipe(Schema.annotateKey({ description: "Milestone title." })),
+});
 
-export const version = (fieldId: number, object: string) =>
-  Schema.Date.pipe(field(fieldId, `Time GitHub last updated the ${object}.`));
+export const version = (object: string) =>
+  Schema.Date.pipe(Schema.annotateKey({ description: `Time GitHub last updated the ${object}.` }));
 
 /** For objects without an update time. A newer read wins. */
-export const readVersion = (fieldId: number, object: string) =>
+export const readVersion = (object: string) =>
   Schema.Date.pipe(
-    field(fieldId, `Time the connector read the ${object}. GitHub has no update time for it.`),
+    Schema.annotateKey({
+      description: `Time the connector read the ${object}. GitHub has no update time for it.`,
+    }),
   );
 
-export const deleted = (fieldId: number, object: string) =>
+export const deleted = (object: string) =>
   Schema.optional(Schema.Boolean).pipe(
-    field(fieldId, `Whether the ${object} was deleted in GitHub.`),
+    Schema.annotateKey({ description: `Whether the ${object} was deleted in GitHub.` }),
   );
 
 export const ObjectRefSchema = Schema.Struct({ id: Long });

package/src/schemas/workflow-jobs.ts

@@ -1,43 +1,67 @@
 import { Iceberg } from "@useairfoil/connector-kit";
 import { Schema, Struct } from "effect";
 
-import { Long, Timestamp, field, list, readVersion } from "./shared";
+import { Long, Timestamp, readVersion } from "./shared";
 
 const step = Schema.Struct({
-  number: Long.pipe(field(102, "Step number.")),
-  name: Schema.String.pipe(field(103, "Step name.")),
-  status: Schema.String.pipe(field(104, "Status, such as queued, in_progress, or completed.")),
-  conclusion: Schema.NullOr(Schema.String).pipe(field(105, "Result of a completed step.")),
+  number: Long.pipe(Schema.annotateKey({ description: "Step number." })),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "Step name." })),
+  status: Schema.String.pipe(
+    Schema.annotateKey({ description: "Status, such as queued, in_progress, or completed." }),
+  ),
+  conclusion: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Result of a completed step." }),
+  ),
   started_at: Schema.optionalKey(Schema.NullOr(Timestamp)).pipe(
-    field(106, "Time the step started."),
+    Schema.annotateKey({ description: "Time the step started." }),
   ),
   completed_at: Schema.optionalKey(Schema.NullOr(Timestamp)).pipe(
-    field(107, "Time the step completed."),
+    Schema.annotateKey({ description: "Time the step completed." }),
   ),
 });
 
 export const WorkflowJobSchema = Schema.Struct({
-  id: Long.pipe(field(1, "Unique job ID.")),
-  version: readVersion(2, "job"),
-  node_id: Schema.String.pipe(field(3, "GraphQL node ID of the job.")),
-  repository_id: Long.pipe(field(4, "ID of the repository the job belongs to.")),
-  run_id: Long.pipe(field(5, "ID of the workflow run.")),
-  run_attempt: Schema.optionalKey(Long).pipe(field(6, "Attempt of the run the job belongs to.")),
-  workflow_name: Schema.NullOr(Schema.String).pipe(field(7, "Workflow name.")),
-  name: Schema.String.pipe(field(8, "Job name.")),
-  head_sha: Schema.String.pipe(field(9, "SHA of the commit the job ran on.")),
-  head_branch: Schema.NullOr(Schema.String).pipe(field(10, "Branch the job ran on.")),
-  status: Schema.String.pipe(field(11, "Status, such as queued, in_progress, or completed.")),
+  id: Long.pipe(Schema.annotateKey({ description: "Unique job ID." })),
+  version: readVersion("job"),
+  node_id: Schema.String.pipe(Schema.annotateKey({ description: "GraphQL node ID of the job." })),
+  repository_id: Long.pipe(
+    Schema.annotateKey({ description: "ID of the repository the job belongs to." }),
+  ),
+  run_id: Long.pipe(Schema.annotateKey({ description: "ID of the workflow run." })),
+  run_attempt: Schema.optionalKey(Long).pipe(
+    Schema.annotateKey({ description: "Attempt of the run the job belongs to." }),
+  ),
+  workflow_name: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Workflow name." }),
+  ),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "Job name." })),
+  head_sha: Schema.String.pipe(
+    Schema.annotateKey({ description: "SHA of the commit the job ran on." }),
+  ),
+  head_branch: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Branch the job ran on." }),
+  ),
+  status: Schema.String.pipe(
+    Schema.annotateKey({ description: "Status, such as queued, in_progress, or completed." }),
+  ),
   conclusion: Schema.NullOr(Schema.String).pipe(
-    field(12, "Result of a completed job, such as success or failure."),
-  ),
-  created_at: Timestamp.pipe(field(13, "Time the job was queued.")),
-  started_at: Timestamp.pipe(field(14, "Time the job started.")),
-  completed_at: Schema.NullOr(Timestamp).pipe(field(15, "Time the job completed.")),
-  runner_name: Schema.NullOr(Schema.String).pipe(field(16, "Name of the runner.")),
-  labels: list(100, Schema.String).pipe(field(17, "Runner labels the job asked for.")),
-  steps: list(101, step).pipe(field(18, "Steps of the job.")),
-  html_url: Schema.NullOr(Schema.String).pipe(field(19, "Job page on GitHub.")),
+    Schema.annotateKey({ description: "Result of a completed job, such as success or failure." }),
+  ),
+  created_at: Timestamp.pipe(Schema.annotateKey({ description: "Time the job was queued." })),
+  started_at: Timestamp.pipe(Schema.annotateKey({ description: "Time the job started." })),
+  completed_at: Schema.NullOr(Timestamp).pipe(
+    Schema.annotateKey({ description: "Time the job completed." }),
+  ),
+  runner_name: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Name of the runner." }),
+  ),
+  labels: Schema.Array(Schema.String).pipe(
+    Schema.annotateKey({ description: "Runner labels the job asked for." }),
+  ),
+  steps: Schema.Array(step).pipe(Schema.annotateKey({ description: "Steps of the job." })),
+  html_url: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Job page on GitHub." }),
+  ),
 })
   .annotate({
     description: "Jobs of GitHub Actions workflow runs. Each run attempt has its own jobs.",

package/src/schemas/workflow-runs.ts

@@ -1,43 +1,60 @@
 import { Iceberg } from "@useairfoil/connector-kit";
 import { Schema, Struct } from "effect";
 
-import { Long, Timestamp, field, list, user, version } from "./shared";
+import { Long, Timestamp, user, version } from "./shared";
 
 export const WorkflowRunSchema = Schema.Struct({
-  id: Long.pipe(field(1, "Unique workflow run ID.")),
-  version: version(2, "workflow run"),
-  node_id: Schema.String.pipe(field(3, "GraphQL node ID of the run.")),
-  repository_id: Long.pipe(field(4, "ID of the repository the run belongs to.")),
-  workflow_id: Long.pipe(field(5, "ID of the workflow.")),
-  name: Schema.NullOr(Schema.String).pipe(field(6, "Workflow name.")),
-  display_title: Schema.String.pipe(field(7, "Title of the run, such as the commit message.")),
-  path: Schema.String.pipe(field(8, "Path of the workflow file.")),
-  event: Schema.String.pipe(field(9, "Event that started the run, such as push.")),
+  id: Long.pipe(Schema.annotateKey({ description: "Unique workflow run ID." })),
+  version: version("workflow run"),
+  node_id: Schema.String.pipe(Schema.annotateKey({ description: "GraphQL node ID of the run." })),
+  repository_id: Long.pipe(
+    Schema.annotateKey({ description: "ID of the repository the run belongs to." }),
+  ),
+  workflow_id: Long.pipe(Schema.annotateKey({ description: "ID of the workflow." })),
+  name: Schema.NullOr(Schema.String).pipe(Schema.annotateKey({ description: "Workflow name." })),
+  display_title: Schema.String.pipe(
+    Schema.annotateKey({ description: "Title of the run, such as the commit message." }),
+  ),
+  path: Schema.String.pipe(Schema.annotateKey({ description: "Path of the workflow file." })),
+  event: Schema.String.pipe(
+    Schema.annotateKey({ description: "Event that started the run, such as push." }),
+  ),
   status: Schema.NullOr(Schema.String).pipe(
-    field(10, "Status, such as queued, in_progress, or completed."),
+    Schema.annotateKey({ description: "Status, such as queued, in_progress, or completed." }),
   ),
   conclusion: Schema.NullOr(Schema.String).pipe(
-    field(11, "Result of a completed run, such as success or failure."),
-  ),
-  head_branch: Schema.NullOr(Schema.String).pipe(field(12, "Branch the run is for.")),
-  head_sha: Schema.String.pipe(field(13, "SHA of the commit the run is for.")),
-  run_number: Long.pipe(field(14, "Run number of the workflow.")),
-  run_attempt: Schema.optionalKey(Long).pipe(field(15, "Attempt number. Re-runs count up.")),
-  check_suite_id: Schema.optionalKey(Long).pipe(field(16, "ID of the run's check suite.")),
-  actor: Schema.optionalKey(user(100)).pipe(field(17, "Account that started the first attempt.")),
-  triggering_actor: Schema.optionalKey(user(103)).pipe(
-    field(18, "Account that started the latest attempt."),
-  ),
-  pull_requests: list(
-    106,
+    Schema.annotateKey({ description: "Result of a completed run, such as success or failure." }),
+  ),
+  head_branch: Schema.NullOr(Schema.String).pipe(
+    Schema.annotateKey({ description: "Branch the run is for." }),
+  ),
+  head_sha: Schema.String.pipe(
+    Schema.annotateKey({ description: "SHA of the commit the run is for." }),
+  ),
+  run_number: Long.pipe(Schema.annotateKey({ description: "Run number of the workflow." })),
+  run_attempt: Schema.optionalKey(Long).pipe(
+    Schema.annotateKey({ description: "Attempt number. Re-runs count up." }),
+  ),
+  check_suite_id: Schema.optionalKey(Long).pipe(
+    Schema.annotateKey({ description: "ID of the run's check suite." }),
+  ),
+  actor: Schema.optionalKey(user).pipe(
+    Schema.annotateKey({ description: "Account that started the first attempt." }),
+  ),
+  triggering_actor: Schema.optionalKey(user).pipe(
+    Schema.annotateKey({ description: "Account that started the latest attempt." }),
+  ),
+  pull_requests: Schema.Array(
     Schema.Struct({
-      id: Long.pipe(field(107, "Pull request ID.")),
-      number: Long.pipe(field(108, "Pull request number.")),
+      id: Long.pipe(Schema.annotateKey({ description: "Pull request ID." })),
+      number: Long.pipe(Schema.annotateKey({ description: "Pull request number." })),
     }),
-  ).pipe(field(19, "Pull requests the run is for. Empty for forks.")),
-  created_at: Timestamp.pipe(field(20, "Time the run was created.")),
-  run_started_at: Schema.optionalKey(Timestamp).pipe(field(21, "Time the latest attempt started.")),
-  html_url: Schema.String.pipe(field(22, "Run page on GitHub.")),
+  ).pipe(Schema.annotateKey({ description: "Pull requests the run is for. Empty for forks." })),
+  created_at: Timestamp.pipe(Schema.annotateKey({ description: "Time the run was created." })),
+  run_started_at: Schema.optionalKey(Timestamp).pipe(
+    Schema.annotateKey({ description: "Time the latest attempt started." }),
+  ),
+  html_url: Schema.String.pipe(Schema.annotateKey({ description: "Run page on GitHub." })),
 })
   .annotate({
     description: "GitHub Actions workflow runs in the installation's repositories.",

package/src/start.ts

@@ -30,7 +30,7 @@ export const startCommand = Command.make("start", {}, () =>
     const entrypoint = yield* GitHubConnector.GitHubConnector;
 
     return yield* ConnectorApp.start(entrypoint, { port }).pipe(
-      Effect.provide(Ingestor.layerWingsConfig(entrypoint)),
+      Effect.provide(Ingestor.layerArrowFlightConfig(entrypoint)),
     );
   }).pipe(
     Effect.annotateLogs({ component: "github" }),
@@ -44,4 +44,4 @@ export const startCommand = Command.make("start", {}, () =>
     ),
     Effect.provide(RuntimeConfig.layerHosted()),
   ),
-).pipe(Command.withDescription("Run the production connector against Wings"));
+).pipe(Command.withDescription("Run the connector"));