@shipfox/api-integration-core-dto 12.0.0 → 12.2.0

package/dist/webhooks.d.ts

@@ -6,14 +6,14 @@ export declare const WEBHOOK_MAX_HEADER_BYTES: number;
 export declare const WEBHOOK_MAX_RAW_QUERY_STRING_LENGTH: number;
 export declare const webhookRouteIds: readonly ["github", "gitea", "linear", "sentry", "slack.event", "slack.command", "webhook.connection", "jira"];
 export declare const webhookRouteIdSchema: z.ZodEnum<{
-    github: "github";
     gitea: "gitea";
+    github: "github";
+    jira: "jira";
     linear: "linear";
     sentry: "sentry";
-    "slack.event": "slack.event";
     "slack.command": "slack.command";
+    "slack.event": "slack.event";
     "webhook.connection": "webhook.connection";
-    jira: "jira";
 }>;
 export type WebhookRouteId = z.infer<typeof webhookRouteIdSchema>;
 declare const webhookBodySchema: z.ZodObject<{
@@ -32,12 +32,12 @@ export declare const storedWebhookRequestSchema: z.ZodDiscriminatedUnion<[z.ZodO
         data: z.ZodString;
     }, z.core.$strict>;
     route_id: z.ZodEnum<{
-        github: "github";
         gitea: "gitea";
+        github: "github";
         linear: "linear";
         sentry: "sentry";
-        "slack.event": "slack.event";
         "slack.command": "slack.command";
+        "slack.event": "slack.event";
     }>;
     path_parameters: z.ZodObject<{}, z.core.$strict>;
 }, z.core.$strict>, z.ZodObject<{
@@ -82,12 +82,12 @@ export declare const webhookProcessingResultSchema: z.ZodDiscriminatedUnion<[z.Z
 }, z.core.$strict>, z.ZodObject<{
     outcome: z.ZodLiteral<"discarded">;
     reason: z.ZodEnum<{
-        missing_required_input: "missing_required_input";
+        connection_unavailable: "connection_unavailable";
         invalid_signature: "invalid_signature";
-        stale_at_receipt: "stale_at_receipt";
         malformed_payload: "malformed_payload";
+        missing_required_input: "missing_required_input";
+        stale_at_receipt: "stale_at_receipt";
         unsupported_event: "unsupported_event";
-        connection_unavailable: "connection_unavailable";
     }>;
     deliveryId: z.ZodOptional<z.ZodString>;
 }, z.core.$strict>], "outcome">;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@shipfox/api-integration-core-dto",
   "license": "MIT",
-  "version": "12.0.0",
+  "version": "12.2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ShipfoxHQ/shipfox.git",

package/src/events.test.ts

@@ -1,13 +1,22 @@
 import {
+  INTEGRATION_CONNECTION_AVAILABLE,
   INTEGRATION_EVENT_RECEIVED,
   INTEGRATION_SOURCE_COMMIT_PUSHED,
   INTEGRATION_SOURCE_REPOSITORY_UPDATED,
+  integrationConnectionAvailableSchema,
   integrationEventReceivedSchema,
   integrationSourceCommitPushedSchema,
   integrationSourceRepositoryUpdatedSchema,
   integrationsEventSchemas,
 } from './events.js';
 
+const validConnectionAvailable = {
+  provider: 'linear',
+  workspaceId: 'ws-1',
+  connectionId: 'conn-1',
+  slug: 'linear_shipfox',
+};
+
 const validEventReceived = {
   provider: 'github',
   source: 'github',
@@ -49,6 +58,20 @@ const validRepositoryUpdated = {
   },
 };
 
+describe('integrationConnectionAvailableSchema', () => {
+  it('parses a valid connection-available payload unchanged', () => {
+    expect(integrationConnectionAvailableSchema.parse(validConnectionAvailable)).toEqual(
+      validConnectionAvailable,
+    );
+  });
+
+  it('rejects a payload without a connection slug', () => {
+    const {slug: _slug, ...withoutSlug} = validConnectionAvailable;
+
+    expect(() => integrationConnectionAvailableSchema.parse(withoutSlug)).toThrow();
+  });
+});
+
 describe('integrationSourceCommitPushedSchema', () => {
   it('parses a valid commit-pushed payload unchanged', () => {
     const result = integrationSourceCommitPushedSchema.parse(validCommitPushed);
@@ -136,6 +159,7 @@ describe('integrationsEventSchemas', () => {
 
     expect(registeredTypes).toEqual(
       [
+        INTEGRATION_CONNECTION_AVAILABLE,
         INTEGRATION_EVENT_RECEIVED,
         INTEGRATION_SOURCE_COMMIT_PUSHED,
         INTEGRATION_SOURCE_REPOSITORY_UPDATED,

package/src/events.ts

@@ -1,6 +1,7 @@
 import {z} from 'zod';
 
 export const INTEGRATION_EVENT_RECEIVED = 'integrations.event.received' as const;
+export const INTEGRATION_CONNECTION_AVAILABLE = 'integrations.connection.available' as const;
 
 const nonEmptyStringSchema = z.string().nonempty();
 const isoDateTimeSchema = z.string().datetime();
@@ -22,6 +23,16 @@ export const integrationEventReceivedSchema = z.object({
 });
 export type IntegrationEventReceivedEvent = z.infer<typeof integrationEventReceivedSchema>;
 
+export const integrationConnectionAvailableSchema = z.object({
+  provider: nonEmptyStringSchema,
+  workspaceId: nonEmptyStringSchema,
+  connectionId: nonEmptyStringSchema,
+  slug: nonEmptyStringSchema,
+});
+export type IntegrationConnectionAvailableEvent = z.infer<
+  typeof integrationConnectionAvailableSchema
+>;
+
 // A source-control push, normalized by the producing provider and carried by
 // `INTEGRATION_SOURCE_COMMIT_PUSHED` for domain consumers.
 export const sourcePushSchema = z.object({
@@ -107,12 +118,14 @@ export const SENTRY_ISSUE_ACTIONS = [
 export type SentryIssueAction = (typeof SENTRY_ISSUE_ACTIONS)[number];
 
 export interface IntegrationsEventMap {
+  [INTEGRATION_CONNECTION_AVAILABLE]: IntegrationConnectionAvailableEvent;
   [INTEGRATION_EVENT_RECEIVED]: IntegrationEventReceivedEvent;
   [INTEGRATION_SOURCE_COMMIT_PUSHED]: IntegrationSourceCommitPushedEvent;
   [INTEGRATION_SOURCE_REPOSITORY_UPDATED]: IntegrationSourceRepositoryUpdatedEvent;
 }
 
 export const integrationsEventSchemas = {
+  [INTEGRATION_CONNECTION_AVAILABLE]: integrationConnectionAvailableSchema,
   [INTEGRATION_EVENT_RECEIVED]: integrationEventReceivedSchema,
   [INTEGRATION_SOURCE_COMMIT_PUSHED]: integrationSourceCommitPushedSchema,
   [INTEGRATION_SOURCE_REPOSITORY_UPDATED]: integrationSourceRepositoryUpdatedSchema,