@shipfox/api-integration-linear-dto 12.2.0 → 15.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-integration-linear-dto",
   "license": "MIT",
-  "version": "12.2.0",
+  "version": "15.0.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",
@@ -19,7 +19,7 @@
   },
   "dependencies": {
     "zod": "^4.4.3",
-    "@shipfox/api-integration-core-dto": "12.2.0"
+    "@shipfox/api-integration-core-dto": "15.0.0"
   },
   "imports": {
     "#*": "./dist/*"

package/src/event-catalog.test.ts

@@ -0,0 +1,20 @@
+import {linearEventCatalog, linearWebhookEventNames} from './index.js';
+
+describe('linearEventCatalog', () => {
+  it('lists exactly the event names the webhook handler accepts', () => {
+    expect(linearEventCatalog.events.map((event) => event.name)).toEqual([
+      ...linearWebhookEventNames,
+    ]);
+  });
+
+  it('covers every supported resource type and action pair', () => {
+    const names = linearEventCatalog.events.map((event) => event.name);
+    for (const name of [
+      'Issue.create',
+      'IssueLabel.update',
+      'Cycle.remove',
+      'agentSession.created',
+    ])
+      expect(names).toContain(name);
+  });
+});

package/src/event-catalog.ts

@@ -0,0 +1,65 @@
+import type {IntegrationEventCatalog} from '@shipfox/api-integration-core-dto';
+import {
+  linearAgentSessionWebhookEventNames,
+  linearWebhookActions,
+  linearWebhookResourceTypes,
+} from './schemas/index.js';
+
+const linearWebhookDocsUrl = 'https://linear.app/developers/webhooks';
+const linearAgentInteractionDocsUrl = 'https://linear.app/developers/agent-interaction';
+
+const resourceLabels = {
+  Issue: 'issue',
+  Comment: 'comment',
+  IssueLabel: 'issue label',
+  Project: 'project',
+  Cycle: 'cycle',
+} as const satisfies Record<(typeof linearWebhookResourceTypes)[number], string>;
+
+const dataEventSummaryByAction = {
+  create: 'is created.',
+  update: 'changes.',
+  remove: 'is removed.',
+} as const satisfies Record<(typeof linearWebhookActions)[number], string>;
+
+const agentSessionDetails = {
+  'agentSession.created': {
+    summary: 'A Linear agent session is created.',
+    emittedWhen: 'Linear creates an agent session after a user mentions or delegates to the app.',
+  },
+  'agentSession.prompted': {
+    summary: 'A user adds a prompt to a Linear agent session.',
+    emittedWhen: 'Linear sends an AgentSessionEvent webhook with the prompted action.',
+  },
+} as const satisfies Record<
+  (typeof linearAgentSessionWebhookEventNames)[number],
+  {
+    summary: string;
+    emittedWhen: string;
+  }
+>;
+
+export const linearEventCatalog = {
+  provider: 'Linear',
+  events: [
+    ...linearWebhookResourceTypes.flatMap((type) =>
+      linearWebhookActions.map((action) => ({
+        name: `${type}.${action}`,
+        summary: dataEventSummary(resourceLabels[type], action),
+        emittedWhen: `Linear sends a webhook for ${type} with the ${action} action.`,
+        payloadKind: 'raw-provider' as const,
+        payloadDocUrl: linearWebhookDocsUrl,
+      })),
+    ),
+    ...linearAgentSessionWebhookEventNames.map((name) => ({
+      name,
+      ...agentSessionDetails[name],
+      payloadKind: 'raw-provider' as const,
+      payloadDocUrl: linearAgentInteractionDocsUrl,
+    })),
+  ],
+} as const satisfies IntegrationEventCatalog;
+
+function dataEventSummary(resource: string, action: (typeof linearWebhookActions)[number]): string {
+  return `A Linear ${resource} ${dataEventSummaryByAction[action]}`;
+}

package/src/index.ts

@@ -1 +1,2 @@
+export * from './event-catalog.js';
 export * from './schemas/index.js';