@useairfoil/producer-linear 0.0.1 → 0.0.2

package/src/demo/issues.ts

@@ -0,0 +1,320 @@
+import type { Demo } from "@useairfoil/connector-kit";
+
+import type { Comment } from "../schemas/comments";
+
+import {
+  clock,
+  customerCount,
+  customerId,
+  cycleId,
+  cyclesBack,
+  cycleWeeks,
+  dateOnly,
+  day,
+  hour,
+  issueId,
+  issueLabels,
+  labelId,
+  milestoneId,
+  months,
+  priorities,
+  projectId,
+  projects,
+  releaseId,
+  type Rows,
+  stamp,
+  stateId,
+  states,
+  teamId,
+  teams,
+  userCount,
+  userId,
+  uuid,
+  verbs,
+  workspace,
+} from "./shared";
+
+/** One group is one issue, with its history, comments, and links. */
+export const issueRows = (index: number, context: Demo.DemoContext): Rows => {
+  const { faker, now } = context;
+  const { at, later } = clock(context);
+
+  const rows: Rows = {
+    issues: [],
+    issue_history: [],
+    comments: [],
+    issue_relations: [],
+    attachments: [],
+    customer_needs: [],
+    issue_to_releases: [],
+  };
+
+  const t = index % teams.length;
+  const team = teams[t] ?? teams[0];
+  const number = Math.floor(index / teams.length) + 1;
+  const identifier = `${team.key}-${number}`;
+  const id = issueId(index);
+  const title = `${faker.helpers.arrayElement(verbs)} ${faker.hacker.adjective()} ${faker.hacker.noun()}`;
+  const slug = title.toLowerCase().replaceAll(" ", "-");
+  const url = `${workspace}/issue/${identifier}/${slug}`;
+
+  const creator = faker.number.int({ max: userCount - 1 });
+
+  const assignee = faker.helpers.maybe(() => faker.number.int({ max: userCount - 1 }), {
+    probability: 0.85,
+  });
+
+  const created = at(now.getTime() - faker.number.int({ min: day, max: 360 * day }));
+
+  const outcome = faker.helpers.weightedArrayElement([
+    { weight: 55, value: "Done" },
+    { weight: 8, value: "Canceled" },
+    { weight: 12, value: "In Progress" },
+    { weight: 5, value: "In Review" },
+    { weight: 10, value: "Todo" },
+    { weight: 10, value: "Backlog" },
+  ] as const);
+
+  const started =
+    outcome === "Done" || outcome === "In Progress" || outcome === "In Review"
+      ? later(created, hour, 20 * day)
+      : null;
+
+  const completed = outcome === "Done" && started ? later(started, hour, 14 * day) : null;
+  const canceled = outcome === "Canceled" ? later(created, day, 30 * day) : null;
+  const triaged = team.triage ? later(created, 60_000, day) : null;
+
+  const project = faker.helpers.maybe(() => faker.number.int({ max: projects.length - 1 }), {
+    probability: 0.6,
+  });
+
+  const cycleNumber =
+    team.cycles && started
+      ? Math.max(
+          0,
+          Math.min(
+            cyclesBack,
+            cyclesBack - Math.ceil((now.getTime() - started.getTime()) / (cycleWeeks * 7 * day)),
+          ),
+        )
+      : null;
+
+  const label = faker.number.int({ max: issueLabels.length - 1 });
+
+  const priority = faker.helpers.weightedArrayElement([
+    { weight: 10, value: 0 },
+    { weight: 5, value: 1 },
+    { weight: 25, value: 2 },
+    { weight: 40, value: 3 },
+    { weight: 20, value: 4 },
+  ]);
+
+  const estimate = team.key === "ENG" ? faker.helpers.arrayElement([1, 2, 3, 5, 8]) : null;
+  const stateIndex = states.findIndex((state) => state.name === outcome);
+
+  // History: created, assigned, then each state change.
+  const changes: Array<{ readonly at: Date; readonly from: number | null; readonly to: number }> = [
+    { at: created, from: null, to: team.triage ? 0 : 1 },
+  ];
+
+  if (triaged) changes.push({ at: triaged, from: 0, to: 1 });
+  if (started) changes.push({ at: started, from: 1, to: 3 });
+
+  if (outcome === "In Review" && started)
+    changes.push({ at: later(started, day, 5 * day), from: 3, to: 4 });
+
+  if (completed) changes.push({ at: completed, from: 3, to: 5 });
+  if (canceled) changes.push({ at: canceled, from: 1, to: 6 });
+  if (outcome === "Todo") changes.push({ at: later(created, 60_000, 3 * day), from: 1, to: 2 });
+
+  changes.forEach((change, h) => {
+    rows.issue_history.push({
+      id: uuid(30, index, h),
+      ...stamp(change.at, change.at),
+      issue_id: id,
+      actor_id: userId(h === 0 ? creator : (assignee ?? creator)),
+      from_state_id: change.from === null ? null : stateId(t, change.from),
+      to_state_id: stateId(t, change.to),
+      from_assignee_id: null,
+      to_assignee_id: h === 0 && assignee !== undefined ? userId(assignee) : null,
+      from_cycle_id: null,
+      to_cycle_id: change.to === 3 && cycleNumber !== null ? cycleId(t, cycleNumber) : null,
+      from_project_id: null,
+      to_project_id: h === 0 && project !== undefined ? projectId(project) : null,
+      from_parent_id: null,
+      to_parent_id: null,
+      from_team_id: null,
+      to_team_id: null,
+      from_priority: null,
+      to_priority: h === 0 ? priority : null,
+      from_estimate: null,
+      to_estimate: h === 0 ? estimate : null,
+      from_due_date: null,
+      to_due_date: null,
+      from_title: null,
+      to_title: null,
+      added_label_ids: h === 0 ? [labelId(label)] : null,
+      removed_label_ids: null,
+      attachment_id: null,
+      customer_need_id: null,
+      to_converted_project_id: null,
+      updated_description: null,
+      archived: null,
+      trashed: null,
+      auto_archived: null,
+      auto_closed: null,
+    });
+  });
+
+  const comments = Array.from({ length: faker.number.int({ max: 3 }) }, (_, c) => {
+    const posted = later(created, 60_000, 10 * day);
+
+    return {
+      id: uuid(31, index, c),
+      ...stamp(posted, posted),
+      _deleted: false,
+      body: faker.helpers.arrayElement([
+        "I can reproduce this on staging.",
+        "Picking this up now.",
+        "Added a fix behind a feature flag.",
+        "Can we pair on this tomorrow?",
+        "Customer confirmed it works now.",
+      ]),
+      user_id: userId(faker.number.int({ max: userCount - 1 })),
+      external_user_id: null,
+      issue_id: id,
+      project_id: null,
+      project_update_id: null,
+      initiative_id: null,
+      initiative_update_id: null,
+      document_content_id: null,
+      parent_id: null,
+      quoted_text: null,
+      edited_at: null,
+      resolved_at: null,
+      resolving_user_id: null,
+      url: `${url}#comment-${uuid(31, index, c).slice(-8)}`,
+    } satisfies Comment;
+  });
+
+  rows.comments.push(...comments);
+
+  if (index >= teams.length && faker.datatype.boolean({ probability: 0.1 })) {
+    rows.issue_relations.push({
+      id: uuid(32, index),
+      ...stamp(created, created),
+      issue_id: id,
+      // The issue before this one in the same team.
+      related_issue_id: issueId(index - teams.length),
+      type: faker.helpers.arrayElement(["blocks", "related", "duplicate"]),
+    });
+  }
+
+  if (team.key === "ENG" && started) {
+    const prNumber = 1000 + index;
+
+    rows.attachments.push({
+      id: uuid(33, index),
+      ...stamp(started, completed ?? started),
+      _deleted: false,
+      issue_id: id,
+      creator_id: assignee === undefined ? null : userId(assignee),
+      external_user_creator_id: null,
+      title: `${title} #${prNumber}`,
+      subtitle: completed ? "Merged" : "Open",
+      url: `https://github.com/acme-labs/web/pull/${prNumber}`,
+      source_type: "github",
+    });
+  }
+
+  if (faker.datatype.boolean({ probability: 0.15 })) {
+    const asked = later(created, 0, 5 * day);
+
+    rows.customer_needs.push({
+      id: uuid(34, index),
+      ...stamp(asked, asked),
+      _deleted: false,
+      customer_id: customerId(faker.number.int({ max: customerCount - 1 })),
+      issue_id: id,
+      project_id: null,
+      original_issue_id: id,
+      comment_id: null,
+      attachment_id: null,
+      creator_id: userId(creator),
+      body: "Their team asked for this on the last call.",
+      priority: faker.helpers.arrayElement([0, 0, 1]),
+      url: null,
+    });
+  }
+
+  // Engineering work ships in the monthly release after it's done.
+  if (team.key === "ENG" && completed) {
+    const month = Math.floor((now.getTime() - completed.getTime()) / (30 * day));
+
+    if (month < months) {
+      rows.issue_to_releases.push({
+        id: uuid(35, index),
+        ...stamp(completed, completed),
+        issue_id: id,
+        release_id: releaseId(month),
+      });
+    }
+  }
+
+  const updated = new Date(
+    Math.max(
+      ...changes.map((change) => change.at.getTime()),
+      ...comments.map((row) => row.created_at.getTime()),
+    ),
+  );
+
+  rows.issues.push({
+    id,
+    ...stamp(created, updated),
+    _deleted: false,
+    identifier,
+    number,
+    title,
+    description: `${faker.hacker.phrase()}\n\n**Steps**\n\n1. Open the page\n2. Try the action\n3. See the error`,
+    url,
+    branch_name: `${identifier.toLowerCase()}-${slug}`,
+    priority,
+    priority_label: priorities[priority] ?? "No priority",
+    estimate,
+    due_date: priority === 1 ? dateOnly(new Date(created.getTime() + 7 * day)) : null,
+    creator_id: userId(creator),
+    assignee_id: assignee === undefined ? null : userId(assignee),
+    delegate_id: null,
+    snoozed_by_id: null,
+    state_id: stateId(t, stateIndex),
+    team_id: teamId(t),
+    project_id: project === undefined ? null : projectId(project),
+    project_milestone_id:
+      project === undefined ? null : milestoneId(project, faker.number.int({ max: 2 })),
+    cycle_id: cycleNumber === null ? null : cycleId(t, cycleNumber),
+    parent_id: null,
+    source_comment_id: null,
+    external_user_creator_id: null,
+    label_ids: [labelId(label)],
+    previous_identifiers: [],
+    started_at: started,
+    completed_at: completed,
+    canceled_at: canceled,
+    started_triage_at: team.triage ? created : null,
+    triaged_at: triaged,
+    auto_closed_at: null,
+    auto_archived_at: null,
+    added_to_cycle_at: cycleNumber === null ? null : started,
+    added_to_project_at: project === undefined ? null : created,
+    added_to_team_at: created,
+    snoozed_until_at: null,
+    sla_type: null,
+    sla_started_at: null,
+    sla_breaches_at: null,
+    customer_ticket_count: BigInt(rows.customer_needs.length),
+    integration_source_type: null,
+    trashed: false,
+  });
+
+  return rows;
+};

package/src/demo/projects.ts

@@ -0,0 +1,215 @@
+import type { Demo } from "@useairfoil/connector-kit";
+
+import type { Document } from "../schemas/documents";
+import type {
+  Project,
+  ProjectLabel,
+  ProjectMilestone,
+  ProjectRelation,
+  ProjectStatus,
+  ProjectUpdate,
+} from "../schemas/projects";
+
+import {
+  dateOnly,
+  day,
+  milestoneId,
+  priorities,
+  projectId,
+  projects,
+  projectStatuses,
+  stamp,
+  teamId,
+  teams,
+  userCount,
+  userId,
+  uuid,
+  workspace,
+} from "./shared";
+
+/** Projects with their milestones, updates, specs, and relations. */
+export const projectTables = ({ faker, now }: Demo.DemoContext, founded: Date) => {
+  const set = stamp(founded, founded);
+
+  const statusRows: Array<ProjectStatus> = projectStatuses.map((status, s) => ({
+    id: uuid(15, s),
+    ...set,
+    name: status.name,
+    type: status.type,
+    color: status.color,
+    description: null,
+    position: s,
+  }));
+
+  const projectLabels: Array<ProjectLabel> = ["Q1", "Q2", "Customer request", "Tech debt"].map(
+    (name, l) => ({
+      id: uuid(16, l),
+      ...set,
+      _deleted: false,
+      name,
+      description: null,
+      color: faker.color.rgb({ casing: "upper" }),
+      is_group: false,
+      parent_id: null,
+      creator_id: userId(1),
+      retired_at: null,
+    }),
+  );
+
+  const projectRows: Array<Project> = [];
+  const milestones: Array<ProjectMilestone> = [];
+  const updates: Array<ProjectUpdate> = [];
+  const documents: Array<Document> = [];
+
+  projects.forEach((name, p) => {
+    const started = new Date(now.getTime() - (360 - p * 40) * day);
+    const target = new Date(started.getTime() + 120 * day);
+    const completed = target < now;
+    const status = completed ? 4 : p % 3 === 2 ? 1 : 2;
+    const lead = (p * 3) % userCount;
+
+    const health = completed
+      ? null
+      : faker.helpers.arrayElement(["onTrack", "onTrack", "atRisk", "offTrack"]);
+
+    const updated = completed ? target : now;
+    const slug = name.toLowerCase().replaceAll(" ", "-");
+
+    projectRows.push({
+      id: projectId(p),
+      ...stamp(started, updated),
+      _deleted: false,
+      name,
+      description: `${name} for the ${teams[p % teams.length]?.name ?? "Engineering"} team`,
+      content: `## Goal\n\nShip ${name.toLowerCase()} by ${dateOnly(target)}.`,
+      url: `${workspace}/project/${slug}-${p.toString(16).padStart(12, "0")}`,
+      icon: null,
+      color: faker.color.rgb({ casing: "upper" }),
+      status_id: uuid(15, status),
+      priority: BigInt(1 + (p % 4)),
+      priority_label: priorities[1 + (p % 4)] ?? "Medium",
+      health,
+      health_updated_at: health ? new Date(now.getTime() - 3 * day) : null,
+      progress: completed ? 1 : faker.number.float({ min: 0.1, max: 0.8, fractionDigits: 2 }),
+      scope: faker.number.int({ min: 20, max: 80 }),
+      lead_id: userId(lead),
+      creator_id: userId(lead),
+      converted_from_issue_id: null,
+      start_date: dateOnly(started),
+      target_date: dateOnly(target),
+      started_at: status === 1 ? null : started,
+      completed_at: completed ? target : null,
+      canceled_at: null,
+      auto_archived_at: null,
+      label_ids: [uuid(16, p % 4)],
+      team_ids: [teamId(p % teams.length)],
+      member_ids: [userId(lead), userId((lead + 1) % userCount)],
+      trashed: false,
+    });
+
+    ["Alpha", "Beta", "GA"].forEach((stage, m) => {
+      const milestoneTarget = new Date(started.getTime() + (m + 1) * 40 * day);
+
+      milestones.push({
+        id: milestoneId(p, m),
+        ...stamp(started, started),
+        name: stage,
+        description: null,
+        project_id: projectId(p),
+        target_date: dateOnly(milestoneTarget),
+        status:
+          milestoneTarget <= now
+            ? "done"
+            : m === 0 || milestoneTarget.getTime() - now.getTime() < 40 * day
+              ? "next"
+              : "unstarted",
+        progress: milestoneTarget <= now ? 1 : 0,
+        sort_order: m,
+      });
+    });
+
+    // A weekly update while the project runs.
+    for (
+      let week = started.getTime() + 7 * day;
+      week <= Math.min(updated.getTime(), now.getTime());
+      week += 7 * day
+    ) {
+      const posted = new Date(week);
+
+      updates.push({
+        id: uuid(17, p, updates.length),
+        ...stamp(posted, posted),
+        _deleted: false,
+        project_id: projectId(p),
+        user_id: userId(lead),
+        body: faker.helpers.arrayElement([
+          "Good week. The main flows are done and we're testing edge cases.",
+          "We hit a snag with the migration. It may slip a few days.",
+          "On track. Design review is done and we start the rollout next week.",
+        ]),
+        health: faker.helpers.arrayElement(["onTrack", "onTrack", "atRisk"]),
+        url: `${workspace}/project/${slug}/updates#${updates.length}`,
+        edited_at: null,
+        comment_count: 0n,
+      });
+    }
+
+    documents.push({
+      id: uuid(18, p),
+      ...stamp(started, started),
+      _deleted: false,
+      title: `${name} spec`,
+      content: `# ${name}\n\n## Problem\n\nCustomers asked for this.\n\n## Plan\n\nShip it in three milestones.`,
+      url: `${workspace}/document/${slug}-spec-${p.toString(16).padStart(12, "0")}`,
+      icon: null,
+      color: null,
+      creator_id: userId(lead),
+      updated_by_id: userId(lead),
+      project_id: projectId(p),
+      initiative_id: null,
+      issue_id: null,
+      cycle_id: null,
+      team_id: null,
+      parent_document_id: null,
+      hidden_at: null,
+      trashed: false,
+    });
+  });
+
+  const projectRelations: Array<ProjectRelation> = [
+    {
+      id: uuid(19, 0),
+      ...set,
+      type: "dependency",
+      project_id: projectId(4),
+      project_milestone_id: null,
+      anchor_type: "start",
+      related_project_id: projectId(1),
+      related_project_milestone_id: null,
+      related_anchor_type: "end",
+      user_id: userId(0),
+    },
+    {
+      id: uuid(19, 1),
+      ...set,
+      type: "dependency",
+      project_id: projectId(6),
+      project_milestone_id: null,
+      anchor_type: "start",
+      related_project_id: projectId(3),
+      related_project_milestone_id: null,
+      related_anchor_type: "end",
+      user_id: userId(1),
+    },
+  ];
+
+  return {
+    project_statuses: statusRows,
+    project_labels: projectLabels,
+    projects: projectRows,
+    project_milestones: milestones,
+    project_updates: updates,
+    project_relations: projectRelations,
+    documents,
+  };
+};

package/src/demo/setup.ts

@@ -0,0 +1,151 @@
+import type { Demo } from "@useairfoil/connector-kit";
+
+import type { Customer, CustomerStatus, CustomerTier } from "../schemas/customers";
+import type { Release, ReleaseNote, ReleasePipeline, ReleaseStage } from "../schemas/releases";
+
+import { initiativeTables } from "./initiatives";
+import { projectTables } from "./projects";
+import {
+  customerCount,
+  customerId,
+  dateOnly,
+  day,
+  months,
+  pipelineId,
+  releaseId,
+  stamp,
+  userCount,
+  userId,
+  uuid,
+  workspace,
+} from "./shared";
+import { teamTables } from "./teams";
+
+/** The workspace, written once before any issue. */
+export const setupRows = (context: Demo.DemoContext) => {
+  const { faker, now } = context;
+  const founded = new Date(now.getTime() - 900 * day);
+  const set = stamp(founded, founded);
+
+  const teamSetup = teamTables(context, founded);
+  const projectSetup = projectTables(context, founded);
+  const initiativeSetup = initiativeTables(context, founded);
+
+  const customerStatuses: Array<CustomerStatus> = ["Active", "Trial", "Churned"].map((name, s) => ({
+    id: uuid(24, s),
+    ...set,
+    name: name.toLowerCase(),
+    display_name: name,
+    description: null,
+    color: ["#4CB782", "#F2C94C", "#95A2B3"][s] ?? "#95A2B3",
+    position: s,
+  }));
+
+  const customerTiers: Array<CustomerTier> = ["Enterprise", "Growth", "Starter"].map((name, s) => ({
+    id: uuid(25, s),
+    ...set,
+    name: name.toLowerCase(),
+    display_name: name,
+    description: null,
+    color: ["#5E6AD2", "#4EA7FC", "#BEC2C8"][s] ?? "#BEC2C8",
+    position: s,
+  }));
+
+  const customers: Array<Customer> = Array.from({ length: customerCount }, (_, c) => {
+    const name = faker.company.name();
+    const domain = `${name.toLowerCase().replaceAll(/[^a-z]+/g, "")}.example.com`;
+    const tier = c % 3;
+
+    return {
+      id: customerId(c),
+      ...stamp(founded, now),
+      _deleted: false,
+      name,
+      domains: [domain],
+      external_ids: [],
+      logo_url: null,
+      owner_id: userId(c % userCount),
+      status_id: uuid(24, c === customerCount - 1 ? 2 : c % 5 === 4 ? 1 : 0),
+      tier_id: uuid(25, tier),
+      revenue: BigInt([250_000, 60_000, 12_000][tier] ?? 12_000),
+      size: [2_000, 300, 40][tier] ?? 40,
+      approximate_need_count: 0,
+      url: `${workspace}/customer/${name.toLowerCase().replaceAll(/[^a-z]+/g, "-")}`,
+    };
+  });
+
+  const pipeline: Array<ReleasePipeline> = [
+    {
+      id: pipelineId,
+      ...set,
+      name: "Web app",
+      type: "scheduled",
+      is_production: true,
+      url: `${workspace}/releases/web-app`,
+      include_path_patterns: ["apps/web/**"],
+      approximate_release_count: BigInt(months),
+      trashed: false,
+    },
+  ];
+
+  const stages: Array<ReleaseStage> = ["Planned", "In progress", "Released"].map((name, s) => ({
+    id: uuid(26, s),
+    ...set,
+    name,
+    type: ["planned", "started", "completed"][s] ?? "completed",
+    color: ["#BEC2C8", "#F2C94C", "#5E6AD2"][s] ?? "#5E6AD2",
+    position: s,
+    frozen: false,
+    pipeline_id: pipelineId,
+  }));
+
+  // One release a month. The newest one is still in progress.
+  const releases: Array<Release> = Array.from({ length: months }, (_, m) => {
+    const released = new Date(now.getTime() - m * 30 * day);
+    const current = m === 0;
+
+    return {
+      id: releaseId(m),
+      ...stamp(new Date(released.getTime() - 30 * day), current ? now : released),
+      name: `Release 2.${months - m}.0`,
+      description: null,
+      release_version: `2.${months - m}.0`,
+      url: `${workspace}/releases/web-app/2.${months - m}.0`,
+      commit_sha: current ? null : faker.git.commitSha(),
+      pipeline_id: pipelineId,
+      stage_id: uuid(26, current ? 1 : 2),
+      creator_id: userId(0),
+      start_date: dateOnly(new Date(released.getTime() - 30 * day)),
+      target_date: dateOnly(released),
+      started_at: new Date(released.getTime() - 30 * day),
+      completed_at: current ? null : released,
+      canceled_at: null,
+      trashed: false,
+    };
+  });
+
+  const releaseNotes: Array<ReleaseNote> = releases
+    .filter((release) => release.completed_at !== null)
+    .map((release, k) => ({
+      id: uuid(27, k),
+      ...stamp(release.completed_at ?? now, release.completed_at ?? now),
+      title: `What's new in ${release.release_version}`,
+      content: "Faster search, clearer billing pages, and many small fixes.",
+      url: `${release.url}/notes`,
+      pipeline_id: pipelineId,
+      release_ids: [release.id],
+    }));
+
+  return {
+    ...teamSetup,
+    ...projectSetup,
+    ...initiativeSetup,
+    customer_statuses: customerStatuses,
+    customer_tiers: customerTiers,
+    customers,
+    release_pipelines: pipeline,
+    release_stages: stages,
+    releases,
+    release_notes: releaseNotes,
+  };
+};