@useairfoil/producer-linear 0.0.2 → 0.0.3

package/src/schemas/customers.ts

@@ -1,22 +1,28 @@
 import { Iceberg } from "@useairfoil/connector-kit";
 import { Schema, Struct } from "effect";
 
-import { Long, OptionalRef, OptionalString, Ref, common, deleted, field, list } from "./shared";
+import { Long, OptionalRef, OptionalString, Ref, common, deleted } from "./shared";
 
 export const CustomerSchema = Schema.Struct({
   ...common("Customer"),
   _deleted: deleted("customer"),
-  name: Schema.String.pipe(field(10, "Customer name.")),
-  domains: list(101, Schema.String).pipe(field(11, "Email domains of the customer.")),
-  external_ids: list(102, Schema.String).pipe(field(12, "IDs in other systems.")),
-  logo_url: OptionalString.pipe(field(13, "Logo URL.")),
-  owner_id: OptionalRef.pipe(field(14, "User who owns the customer.")),
-  status_id: Ref.pipe(field(15, "Customer status.")),
-  tier_id: OptionalRef.pipe(field(16, "Customer tier.")),
-  revenue: Schema.NullOr(Long).pipe(field(17, "Annual revenue.")),
-  size: Schema.NullOr(Schema.Finite).pipe(field(18, "Company size.")),
-  approximate_need_count: Schema.Finite.pipe(field(19, "About how many requests it has.")),
-  url: Schema.String.pipe(field(20, "Customer URL.")),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "Customer name." })),
+  domains: Schema.Array(Schema.String).pipe(
+    Schema.annotateKey({ description: "Email domains of the customer." }),
+  ),
+  external_ids: Schema.Array(Schema.String).pipe(
+    Schema.annotateKey({ description: "IDs in other systems." }),
+  ),
+  logo_url: OptionalString.pipe(Schema.annotateKey({ description: "Logo URL." })),
+  owner_id: OptionalRef.pipe(Schema.annotateKey({ description: "User who owns the customer." })),
+  status_id: Ref.pipe(Schema.annotateKey({ description: "Customer status." })),
+  tier_id: OptionalRef.pipe(Schema.annotateKey({ description: "Customer tier." })),
+  revenue: Schema.NullOr(Long).pipe(Schema.annotateKey({ description: "Annual revenue." })),
+  size: Schema.NullOr(Schema.Finite).pipe(Schema.annotateKey({ description: "Company size." })),
+  approximate_need_count: Schema.Finite.pipe(
+    Schema.annotateKey({ description: "About how many requests it has." }),
+  ),
+  url: Schema.String.pipe(Schema.annotateKey({ description: "Customer URL." })),
 })
   .annotate({ description: "Linear customers." })
   .pipe(Iceberg.identifier("id"));
@@ -30,16 +36,26 @@ export const CustomerObjectSchema = CustomerSchema.mapFields((fields) =>
 export const CustomerNeedSchema = Schema.Struct({
   ...common("Request"),
   _deleted: deleted("request"),
-  customer_id: OptionalRef.pipe(field(10, "Customer.")),
-  issue_id: OptionalRef.pipe(field(11, "Issue the request is linked to.")),
-  project_id: OptionalRef.pipe(field(12, "Project the request is linked to.")),
-  original_issue_id: OptionalRef.pipe(field(13, "Issue the request was first linked to.")),
-  comment_id: OptionalRef.pipe(field(14, "Comment the request came from.")),
-  attachment_id: OptionalRef.pipe(field(15, "Attachment the request came from.")),
-  creator_id: OptionalRef.pipe(field(16, "User who added the request.")),
-  body: OptionalString.pipe(field(17, "Request text in markdown.")),
-  priority: Schema.Finite.pipe(field(18, "0 normal, 1 important.")),
-  url: OptionalString.pipe(field(19, "Source URL.")),
+  customer_id: OptionalRef.pipe(Schema.annotateKey({ description: "Customer." })),
+  issue_id: OptionalRef.pipe(
+    Schema.annotateKey({ description: "Issue the request is linked to." }),
+  ),
+  project_id: OptionalRef.pipe(
+    Schema.annotateKey({ description: "Project the request is linked to." }),
+  ),
+  original_issue_id: OptionalRef.pipe(
+    Schema.annotateKey({ description: "Issue the request was first linked to." }),
+  ),
+  comment_id: OptionalRef.pipe(
+    Schema.annotateKey({ description: "Comment the request came from." }),
+  ),
+  attachment_id: OptionalRef.pipe(
+    Schema.annotateKey({ description: "Attachment the request came from." }),
+  ),
+  creator_id: OptionalRef.pipe(Schema.annotateKey({ description: "User who added the request." })),
+  body: OptionalString.pipe(Schema.annotateKey({ description: "Request text in markdown." })),
+  priority: Schema.Finite.pipe(Schema.annotateKey({ description: "0 normal, 1 important." })),
+  url: OptionalString.pipe(Schema.annotateKey({ description: "Source URL." })),
 })
   .annotate({ description: "Linear customer requests, linked to issues or projects." })
   .pipe(Iceberg.identifier("id"));
@@ -52,11 +68,11 @@ export const CustomerNeedObjectSchema = CustomerNeedSchema.mapFields((fields) =>
 
 const levelFields = (object: string) => ({
   ...common(object),
-  name: Schema.String.pipe(field(10, "Name.")),
-  display_name: Schema.String.pipe(field(11, "Name shown in Linear.")),
-  description: OptionalString.pipe(field(12, "Description.")),
-  color: Schema.String.pipe(field(13, "Color, as hex.")),
-  position: Schema.Finite.pipe(field(14, "Order in the list.")),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "Name." })),
+  display_name: Schema.String.pipe(Schema.annotateKey({ description: "Name shown in Linear." })),
+  description: OptionalString.pipe(Schema.annotateKey({ description: "Description." })),
+  color: Schema.String.pipe(Schema.annotateKey({ description: "Color, as hex." })),
+  position: Schema.Finite.pipe(Schema.annotateKey({ description: "Order in the list." })),
 });
 
 export const CustomerStatusSchema = Schema.Struct(levelFields("Status"))

package/src/schemas/documents.ts

@@ -1,26 +1,34 @@
 import { Iceberg } from "@useairfoil/connector-kit";
 import { Schema, Struct } from "effect";
 
-import { OptionalRef, OptionalString, OptionalTimestamp, common, deleted, field } from "./shared";
+import { OptionalRef, OptionalString, OptionalTimestamp, common, deleted } from "./shared";
 
 export const DocumentSchema = Schema.Struct({
   ...common("Document"),
   _deleted: deleted("document"),
-  title: Schema.String.pipe(field(10, "Title.")),
-  content: OptionalString.pipe(field(11, "Content in markdown.")),
-  url: Schema.String.pipe(field(12, "Document URL.")),
-  icon: OptionalString.pipe(field(13, "Icon.")),
-  color: OptionalString.pipe(field(14, "Icon color.")),
-  creator_id: OptionalRef.pipe(field(15, "User who made the document.")),
-  updated_by_id: OptionalRef.pipe(field(16, "User who last changed the document.")),
-  project_id: OptionalRef.pipe(field(17, "Project the document is in.")),
-  initiative_id: OptionalRef.pipe(field(18, "Initiative the document is in.")),
-  issue_id: OptionalRef.pipe(field(19, "Issue the document is in.")),
-  cycle_id: OptionalRef.pipe(field(20, "Cycle the document is in.")),
-  team_id: OptionalRef.pipe(field(21, "Team the document is in.")),
-  parent_document_id: OptionalRef.pipe(field(22, "Parent document.")),
-  hidden_at: OptionalTimestamp.pipe(field(23, "Time the document was hidden.")),
-  trashed: Schema.NullOr(Schema.Boolean).pipe(field(24, "Whether the document is in the trash.")),
+  title: Schema.String.pipe(Schema.annotateKey({ description: "Title." })),
+  content: OptionalString.pipe(Schema.annotateKey({ description: "Content in markdown." })),
+  url: Schema.String.pipe(Schema.annotateKey({ description: "Document URL." })),
+  icon: OptionalString.pipe(Schema.annotateKey({ description: "Icon." })),
+  color: OptionalString.pipe(Schema.annotateKey({ description: "Icon color." })),
+  creator_id: OptionalRef.pipe(Schema.annotateKey({ description: "User who made the document." })),
+  updated_by_id: OptionalRef.pipe(
+    Schema.annotateKey({ description: "User who last changed the document." }),
+  ),
+  project_id: OptionalRef.pipe(Schema.annotateKey({ description: "Project the document is in." })),
+  initiative_id: OptionalRef.pipe(
+    Schema.annotateKey({ description: "Initiative the document is in." }),
+  ),
+  issue_id: OptionalRef.pipe(Schema.annotateKey({ description: "Issue the document is in." })),
+  cycle_id: OptionalRef.pipe(Schema.annotateKey({ description: "Cycle the document is in." })),
+  team_id: OptionalRef.pipe(Schema.annotateKey({ description: "Team the document is in." })),
+  parent_document_id: OptionalRef.pipe(Schema.annotateKey({ description: "Parent document." })),
+  hidden_at: OptionalTimestamp.pipe(
+    Schema.annotateKey({ description: "Time the document was hidden." }),
+  ),
+  trashed: Schema.NullOr(Schema.Boolean).pipe(
+    Schema.annotateKey({ description: "Whether the document is in the trash." }),
+  ),
 })
   .annotate({ description: "Linear documents, including archived and trashed ones." })
   .pipe(Iceberg.identifier("id"));

package/src/schemas/initiatives.ts

@@ -9,33 +9,57 @@ import {
   Ref,
   common,
   deleted,
-  field,
-  list,
 } from "./shared";
 
 export const InitiativeSchema = Schema.Struct({
   ...common("Initiative"),
   _deleted: deleted("initiative"),
-  name: Schema.String.pipe(field(10, "Initiative name.")),
-  description: OptionalString.pipe(field(11, "Short summary.")),
-  content: OptionalString.pipe(field(12, "Initiative overview in markdown.")),
-  url: Schema.String.pipe(field(13, "Initiative URL.")),
-  icon: OptionalString.pipe(field(14, "Icon.")),
-  color: OptionalString.pipe(field(15, "Color, as hex.")),
-  status: Schema.String.pipe(field(16, "Status: Planned, Active, or Completed.")),
-  health: OptionalString.pipe(field(17, "Health from the latest update.")),
-  health_updated_at: OptionalTimestamp.pipe(field(18, "Time the health last changed.")),
-  priority: Long.pipe(field(19, "0 none, 1 urgent, 2 high, 3 medium, 4 low.")),
-  owner_id: OptionalRef.pipe(field(20, "Initiative owner.")),
-  creator_id: OptionalRef.pipe(field(21, "User who made the initiative.")),
-  parent_initiative_id: OptionalRef.pipe(field(22, "Parent initiative.")),
-  target_date: OptionalString.pipe(field(23, "Target date, as YYYY-MM-DD.")),
-  started_at: OptionalTimestamp.pipe(field(24, "Time the initiative started.")),
-  completed_at: OptionalTimestamp.pipe(field(25, "Time the initiative was completed.")),
-  canceled_at: OptionalTimestamp.pipe(field(26, "Time the initiative was canceled.")),
-  label_ids: list(101, Schema.String).pipe(field(27, "Initiative labels.")),
-  visibility: Schema.String.pipe(field(28, "Who can see the initiative.")),
-  trashed: Schema.NullOr(Schema.Boolean).pipe(field(29, "Whether the initiative is in the trash.")),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "Initiative name." })),
+  description: OptionalString.pipe(Schema.annotateKey({ description: "Short summary." })),
+  content: OptionalString.pipe(
+    Schema.annotateKey({ description: "Initiative overview in markdown." }),
+  ),
+  url: Schema.String.pipe(Schema.annotateKey({ description: "Initiative URL." })),
+  icon: OptionalString.pipe(Schema.annotateKey({ description: "Icon." })),
+  color: OptionalString.pipe(Schema.annotateKey({ description: "Color, as hex." })),
+  status: Schema.String.pipe(
+    Schema.annotateKey({ description: "Status: Planned, Active, or Completed." }),
+  ),
+  health: OptionalString.pipe(
+    Schema.annotateKey({ description: "Health from the latest update." }),
+  ),
+  health_updated_at: OptionalTimestamp.pipe(
+    Schema.annotateKey({ description: "Time the health last changed." }),
+  ),
+  priority: Long.pipe(
+    Schema.annotateKey({ description: "0 none, 1 urgent, 2 high, 3 medium, 4 low." }),
+  ),
+  owner_id: OptionalRef.pipe(Schema.annotateKey({ description: "Initiative owner." })),
+  creator_id: OptionalRef.pipe(
+    Schema.annotateKey({ description: "User who made the initiative." }),
+  ),
+  parent_initiative_id: OptionalRef.pipe(Schema.annotateKey({ description: "Parent initiative." })),
+  target_date: OptionalString.pipe(
+    Schema.annotateKey({ description: "Target date, as YYYY-MM-DD." }),
+  ),
+  started_at: OptionalTimestamp.pipe(
+    Schema.annotateKey({ description: "Time the initiative started." }),
+  ),
+  completed_at: OptionalTimestamp.pipe(
+    Schema.annotateKey({ description: "Time the initiative was completed." }),
+  ),
+  canceled_at: OptionalTimestamp.pipe(
+    Schema.annotateKey({ description: "Time the initiative was canceled." }),
+  ),
+  label_ids: Schema.Array(Schema.String).pipe(
+    Schema.annotateKey({ description: "Initiative labels." }),
+  ),
+  visibility: Schema.String.pipe(
+    Schema.annotateKey({ description: "Who can see the initiative." }),
+  ),
+  trashed: Schema.NullOr(Schema.Boolean).pipe(
+    Schema.annotateKey({ description: "Whether the initiative is in the trash." }),
+  ),
 })
   .annotate({ description: "Linear initiatives, including archived and trashed ones." })
   .pipe(Iceberg.identifier("id"));
@@ -49,13 +73,17 @@ export const InitiativeObjectSchema = InitiativeSchema.mapFields((fields) =>
 export const InitiativeUpdateSchema = Schema.Struct({
   ...common("Update"),
   _deleted: deleted("update"),
-  initiative_id: Ref.pipe(field(10, "Initiative.")),
-  user_id: Ref.pipe(field(11, "User who posted the update.")),
-  body: Schema.String.pipe(field(12, "Update text in markdown.")),
-  health: Schema.String.pipe(field(13, "Health: onTrack, atRisk, or offTrack.")),
-  url: Schema.String.pipe(field(14, "Update URL.")),
-  edited_at: OptionalTimestamp.pipe(field(15, "Time the update was last edited.")),
-  comment_count: Long.pipe(field(16, "Comments on the update.")),
+  initiative_id: Ref.pipe(Schema.annotateKey({ description: "Initiative." })),
+  user_id: Ref.pipe(Schema.annotateKey({ description: "User who posted the update." })),
+  body: Schema.String.pipe(Schema.annotateKey({ description: "Update text in markdown." })),
+  health: Schema.String.pipe(
+    Schema.annotateKey({ description: "Health: onTrack, atRisk, or offTrack." }),
+  ),
+  url: Schema.String.pipe(Schema.annotateKey({ description: "Update URL." })),
+  edited_at: OptionalTimestamp.pipe(
+    Schema.annotateKey({ description: "Time the update was last edited." }),
+  ),
+  comment_count: Long.pipe(Schema.annotateKey({ description: "Comments on the update." })),
 })
   .annotate({ description: "Linear initiative updates: status posts with a health." })
   .pipe(Iceberg.identifier("id"));
@@ -68,13 +96,17 @@ export const InitiativeUpdateObjectSchema = InitiativeUpdateSchema.mapFields((fi
 
 export const InitiativeLabelSchema = Schema.Struct({
   ...common("Label"),
-  name: Schema.String.pipe(field(10, "Label name.")),
-  description: OptionalString.pipe(field(11, "Label description.")),
-  color: Schema.String.pipe(field(12, "Label color, as hex.")),
-  is_group: Schema.Boolean.pipe(field(13, "Whether the label groups other labels.")),
-  parent_id: OptionalRef.pipe(field(14, "Label group.")),
-  creator_id: OptionalRef.pipe(field(15, "User who made the label.")),
-  retired_at: OptionalTimestamp.pipe(field(16, "Time the label was retired.")),
+  name: Schema.String.pipe(Schema.annotateKey({ description: "Label name." })),
+  description: OptionalString.pipe(Schema.annotateKey({ description: "Label description." })),
+  color: Schema.String.pipe(Schema.annotateKey({ description: "Label color, as hex." })),
+  is_group: Schema.Boolean.pipe(
+    Schema.annotateKey({ description: "Whether the label groups other labels." }),
+  ),
+  parent_id: OptionalRef.pipe(Schema.annotateKey({ description: "Label group." })),
+  creator_id: OptionalRef.pipe(Schema.annotateKey({ description: "User who made the label." })),
+  retired_at: OptionalTimestamp.pipe(
+    Schema.annotateKey({ description: "Time the label was retired." }),
+  ),
 })
   .annotate({ description: "Linear initiative labels. Names the IDs in `initiatives.label_ids`." })
   .pipe(Iceberg.identifier("id"));
@@ -87,10 +119,12 @@ export const InitiativeLabelObjectSchema = InitiativeLabelSchema.mapFields((fiel
 
 export const InitiativeRelationSchema = Schema.Struct({
   ...common("Relation"),
-  initiative_id: Ref.pipe(field(10, "Initiative the relation starts from.")),
-  related_initiative_id: Ref.pipe(field(11, "Related initiative.")),
-  sort_order: Schema.Finite.pipe(field(12, "Order.")),
-  user_id: OptionalRef.pipe(field(13, "User who made the relation.")),
+  initiative_id: Ref.pipe(
+    Schema.annotateKey({ description: "Initiative the relation starts from." }),
+  ),
+  related_initiative_id: Ref.pipe(Schema.annotateKey({ description: "Related initiative." })),
+  sort_order: Schema.Finite.pipe(Schema.annotateKey({ description: "Order." })),
+  user_id: OptionalRef.pipe(Schema.annotateKey({ description: "User who made the relation." })),
 })
   .annotate({ description: "Linear initiative relations. Deleted relations aren't seen." })
   .pipe(Iceberg.identifier("id"));
@@ -103,9 +137,11 @@ export const InitiativeRelationObjectSchema = InitiativeRelationSchema.mapFields
 
 export const InitiativeToProjectSchema = Schema.Struct({
   ...common("Link"),
-  initiative_id: Ref.pipe(field(10, "Initiative.")),
-  project_id: Ref.pipe(field(11, "Project.")),
-  sort_order: Schema.String.pipe(field(12, "Order within the initiative.")),
+  initiative_id: Ref.pipe(Schema.annotateKey({ description: "Initiative." })),
+  project_id: Ref.pipe(Schema.annotateKey({ description: "Project." })),
+  sort_order: Schema.String.pipe(
+    Schema.annotateKey({ description: "Order within the initiative." }),
+  ),
 })
   .annotate({
     description: "Links between Linear initiatives and projects. Removed links aren't seen.",