@shipfox/api-integration-webhook-dto 2.0.0 → 3.0.0

package/.turbo/turbo-build.log

@@ -1,2 +1,2 @@
 $ shipfox-swc
-Successfully compiled: 1 file with swc (71.89ms)
+Successfully compiled: 3 files with swc (289.24ms)

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @shipfox/api-integration-webhook-dto
 
+## 3.0.0
+
+### Minor Changes
+
+- 6b23868: Adds provider event and GitHub agent-tool catalogs for generated integration reference documentation.
+
+### Patch Changes
+
+- Updated dependencies [6b23868]
+  - @shipfox/api-integration-core-dto@3.0.0
+
 ## 2.0.0
 
 ### Minor Changes

package/dist/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const WEBHOOK_PROVIDER: "webhook";
+export declare const WEBHOOK_RECEIVED_EVENT: "received";
+export declare const WEBHOOK_RESERVED_SLUGS: readonly ["github", "gitea", "sentry", "manual", "cron"];
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,EAAG,SAAkB,CAAC;AACnD,eAAO,MAAM,sBAAsB,EAAG,UAAmB,CAAC;AAC1D,eAAO,MAAM,sBAAsB,0DAA2D,CAAC"}

package/dist/constants.js

@@ -0,0 +1,11 @@
+export const WEBHOOK_PROVIDER = 'webhook';
+export const WEBHOOK_RECEIVED_EVENT = 'received';
+export const WEBHOOK_RESERVED_SLUGS = [
+    'github',
+    'gitea',
+    'sentry',
+    'manual',
+    'cron'
+];
+
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts"],"sourcesContent":["export const WEBHOOK_PROVIDER = 'webhook' as const;\nexport const WEBHOOK_RECEIVED_EVENT = 'received' as const;\nexport const WEBHOOK_RESERVED_SLUGS = ['github', 'gitea', 'sentry', 'manual', 'cron'] as const;\n"],"names":["WEBHOOK_PROVIDER","WEBHOOK_RECEIVED_EVENT","WEBHOOK_RESERVED_SLUGS"],"mappings":"AAAA,OAAO,MAAMA,mBAAmB,UAAmB;AACnD,OAAO,MAAMC,yBAAyB,WAAoB;AAC1D,OAAO,MAAMC,yBAAyB;IAAC;IAAU;IAAS;IAAU;IAAU;CAAO,CAAU"}

package/dist/event-catalog.d.ts

@@ -0,0 +1,10 @@
+export declare const webhookEventCatalog: {
+    readonly provider: "Custom webhook";
+    readonly events: readonly [{
+        readonly name: "received";
+        readonly summary: "A custom webhook request is accepted.";
+        readonly emittedWhen: "Shipfox accepts a request at the integration connection ingest URL.";
+        readonly payloadKind: "shipfox-normalized";
+    }];
+};
+//# sourceMappingURL=event-catalog.d.ts.map

package/dist/event-catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"event-catalog.d.ts","sourceRoot":"","sources":["../src/event-catalog.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,mBAAmB;;;;;;;;CAUY,CAAC"}

package/dist/event-catalog.js

@@ -0,0 +1,14 @@
+import { WEBHOOK_RECEIVED_EVENT } from './constants.js';
+export const webhookEventCatalog = {
+    provider: 'Custom webhook',
+    events: [
+        {
+            name: WEBHOOK_RECEIVED_EVENT,
+            summary: 'A custom webhook request is accepted.',
+            emittedWhen: 'Shipfox accepts a request at the integration connection ingest URL.',
+            payloadKind: 'shipfox-normalized'
+        }
+    ]
+};
+
+//# sourceMappingURL=event-catalog.js.map

package/dist/event-catalog.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/event-catalog.ts"],"sourcesContent":["import type {IntegrationEventCatalog} from '@shipfox/api-integration-core-dto';\nimport {WEBHOOK_RECEIVED_EVENT} from './constants.js';\n\nexport const webhookEventCatalog = {\n  provider: 'Custom webhook',\n  events: [\n    {\n      name: WEBHOOK_RECEIVED_EVENT,\n      summary: 'A custom webhook request is accepted.',\n      emittedWhen: 'Shipfox accepts a request at the integration connection ingest URL.',\n      payloadKind: 'shipfox-normalized',\n    },\n  ],\n} as const satisfies IntegrationEventCatalog;\n"],"names":["WEBHOOK_RECEIVED_EVENT","webhookEventCatalog","provider","events","name","summary","emittedWhen","payloadKind"],"mappings":"AACA,SAAQA,sBAAsB,QAAO,iBAAiB;AAEtD,OAAO,MAAMC,sBAAsB;IACjCC,UAAU;IACVC,QAAQ;QACN;YACEC,MAAMJ;YACNK,SAAS;YACTC,aAAa;YACbC,aAAa;QACf;KACD;AACH,EAA6C"}

package/dist/index.d.ts

@@ -1,7 +1,6 @@
+export * from './event-catalog.js';
 import { z } from 'zod';
-export declare const WEBHOOK_PROVIDER: "webhook";
-export declare const WEBHOOK_RECEIVED_EVENT: "received";
-export declare const WEBHOOK_RESERVED_SLUGS: readonly ["github", "gitea", "sentry", "manual", "cron"];
+export { WEBHOOK_PROVIDER, WEBHOOK_RECEIVED_EVENT, WEBHOOK_RESERVED_SLUGS, } from './constants.js';
 export declare const webhookSlugSchema: z.ZodPipe<z.ZodString, z.ZodString>;
 export declare const createWebhookConnectionBodySchema: z.ZodObject<{
     workspace_id: z.ZodString;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAEtB,eAAO,MAAM,gBAAgB,EAAG,SAAkB,CAAC;AACnD,eAAO,MAAM,sBAAsB,EAAG,UAAmB,CAAC;AAC1D,eAAO,MAAM,sBAAsB,0DAA2D,CAAC;AAI/F,eAAO,MAAM,iBAAiB,qCAK1B,CAAC;AAEL,eAAO,MAAM,iCAAiC;;;;iBAI5C,CAAC;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE/F,eAAO,MAAM,iCAAiC;;;;;iBAE5C,CAAC;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE/F,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;iBASrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,iCAAiC;;iBAE5C,CAAC;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE/F,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;iBAE/C,CAAC;AACH,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,oCAAoC,CAC5C,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AAGnC,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAC;AAGtB,OAAO,EACL,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,GACvB,MAAM,gBAAgB,CAAC;AAIxB,eAAO,MAAM,iBAAiB,qCAK1B,CAAC;AAEL,eAAO,MAAM,iCAAiC;;;;iBAI5C,CAAC;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE/F,eAAO,MAAM,iCAAiC;;;;;iBAE5C,CAAC;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE/F,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;iBASrC,CAAC;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,eAAO,MAAM,iCAAiC;;iBAE5C,CAAC;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE/F,eAAO,MAAM,oCAAoC;;;;;;;;;;;;;;;iBAE/C,CAAC;AACH,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CACrD,OAAO,oCAAoC,CAC5C,CAAC"}

package/dist/index.js

@@ -1,14 +1,8 @@
+export * from './event-catalog.js';
 import { connectionSlugSchema } from '@shipfox/api-integration-core-dto';
 import { z } from 'zod';
-export const WEBHOOK_PROVIDER = 'webhook';
-export const WEBHOOK_RECEIVED_EVENT = 'received';
-export const WEBHOOK_RESERVED_SLUGS = [
-    'github',
-    'gitea',
-    'sentry',
-    'manual',
-    'cron'
-];
+import { WEBHOOK_RESERVED_SLUGS } from './constants.js';
+export { WEBHOOK_PROVIDER, WEBHOOK_RECEIVED_EVENT, WEBHOOK_RESERVED_SLUGS } from './constants.js';
 const webhookReservedSlugSet = new Set(WEBHOOK_RESERVED_SLUGS);
 export const webhookSlugSchema = z.string().pipe(connectionSlugSchema).refine((slug)=>!webhookReservedSlugSet.has(slug), {
     message: 'Slug is reserved'

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import {connectionSlugSchema} from '@shipfox/api-integration-core-dto';\nimport {z} from 'zod';\n\nexport const WEBHOOK_PROVIDER = 'webhook' as const;\nexport const WEBHOOK_RECEIVED_EVENT = 'received' as const;\nexport const WEBHOOK_RESERVED_SLUGS = ['github', 'gitea', 'sentry', 'manual', 'cron'] as const;\n\nconst webhookReservedSlugSet = new Set<string>(WEBHOOK_RESERVED_SLUGS);\n\nexport const webhookSlugSchema = z\n  .string()\n  .pipe(connectionSlugSchema)\n  .refine((slug) => !webhookReservedSlugSet.has(slug), {\n    message: 'Slug is reserved',\n  });\n\nexport const createWebhookConnectionBodySchema = z.object({\n  workspace_id: z.string().uuid(),\n  name: z.string().min(1).max(100),\n  slug: webhookSlugSchema,\n});\nexport type CreateWebhookConnectionBodyDto = z.infer<typeof createWebhookConnectionBodySchema>;\n\nexport const updateWebhookConnectionBodySchema = z.object({\n  lifecycle_status: z.enum(['active', 'disabled']),\n});\nexport type UpdateWebhookConnectionBodyDto = z.infer<typeof updateWebhookConnectionBodySchema>;\n\nexport const webhookConnectionDtoSchema = z.object({\n  id: z.string().uuid(),\n  workspace_id: z.string().uuid(),\n  name: z.string(),\n  slug: connectionSlugSchema,\n  lifecycle_status: z.enum(['active', 'disabled', 'error']),\n  inbound_url: z.string().url(),\n  created_at: z.string(),\n  updated_at: z.string(),\n});\nexport type WebhookConnectionDto = z.infer<typeof webhookConnectionDtoSchema>;\n\nexport const listWebhookConnectionsQuerySchema = z.object({\n  workspace_id: z.string().uuid(),\n});\nexport type ListWebhookConnectionsQueryDto = z.infer<typeof listWebhookConnectionsQuerySchema>;\n\nexport const listWebhookConnectionsResponseSchema = z.object({\n  connections: z.array(webhookConnectionDtoSchema),\n});\nexport type ListWebhookConnectionsResponseDto = z.infer<\n  typeof listWebhookConnectionsResponseSchema\n>;\n"],"names":["connectionSlugSchema","z","WEBHOOK_PROVIDER","WEBHOOK_RECEIVED_EVENT","WEBHOOK_RESERVED_SLUGS","webhookReservedSlugSet","Set","webhookSlugSchema","string","pipe","refine","slug","has","message","createWebhookConnectionBodySchema","object","workspace_id","uuid","name","min","max","updateWebhookConnectionBodySchema","lifecycle_status","enum","webhookConnectionDtoSchema","id","inbound_url","url","created_at","updated_at","listWebhookConnectionsQuerySchema","listWebhookConnectionsResponseSchema","connections","array"],"mappings":"AAAA,SAAQA,oBAAoB,QAAO,oCAAoC;AACvE,SAAQC,CAAC,QAAO,MAAM;AAEtB,OAAO,MAAMC,mBAAmB,UAAmB;AACnD,OAAO,MAAMC,yBAAyB,WAAoB;AAC1D,OAAO,MAAMC,yBAAyB;IAAC;IAAU;IAAS;IAAU;IAAU;CAAO,CAAU;AAE/F,MAAMC,yBAAyB,IAAIC,IAAYF;AAE/C,OAAO,MAAMG,oBAAoBN,EAC9BO,MAAM,GACNC,IAAI,CAACT,sBACLU,MAAM,CAAC,CAACC,OAAS,CAACN,uBAAuBO,GAAG,CAACD,OAAO;IACnDE,SAAS;AACX,GAAG;AAEL,OAAO,MAAMC,oCAAoCb,EAAEc,MAAM,CAAC;IACxDC,cAAcf,EAAEO,MAAM,GAAGS,IAAI;IAC7BC,MAAMjB,EAAEO,MAAM,GAAGW,GAAG,CAAC,GAAGC,GAAG,CAAC;IAC5BT,MAAMJ;AACR,GAAG;AAGH,OAAO,MAAMc,oCAAoCpB,EAAEc,MAAM,CAAC;IACxDO,kBAAkBrB,EAAEsB,IAAI,CAAC;QAAC;QAAU;KAAW;AACjD,GAAG;AAGH,OAAO,MAAMC,6BAA6BvB,EAAEc,MAAM,CAAC;IACjDU,IAAIxB,EAAEO,MAAM,GAAGS,IAAI;IACnBD,cAAcf,EAAEO,MAAM,GAAGS,IAAI;IAC7BC,MAAMjB,EAAEO,MAAM;IACdG,MAAMX;IACNsB,kBAAkBrB,EAAEsB,IAAI,CAAC;QAAC;QAAU;QAAY;KAAQ;IACxDG,aAAazB,EAAEO,MAAM,GAAGmB,GAAG;IAC3BC,YAAY3B,EAAEO,MAAM;IACpBqB,YAAY5B,EAAEO,MAAM;AACtB,GAAG;AAGH,OAAO,MAAMsB,oCAAoC7B,EAAEc,MAAM,CAAC;IACxDC,cAAcf,EAAEO,MAAM,GAAGS,IAAI;AAC/B,GAAG;AAGH,OAAO,MAAMc,uCAAuC9B,EAAEc,MAAM,CAAC;IAC3DiB,aAAa/B,EAAEgC,KAAK,CAACT;AACvB,GAAG"}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './event-catalog.js';\n\nimport {connectionSlugSchema} from '@shipfox/api-integration-core-dto';\nimport {z} from 'zod';\nimport {WEBHOOK_RESERVED_SLUGS} from './constants.js';\n\nexport {\n  WEBHOOK_PROVIDER,\n  WEBHOOK_RECEIVED_EVENT,\n  WEBHOOK_RESERVED_SLUGS,\n} from './constants.js';\n\nconst webhookReservedSlugSet = new Set<string>(WEBHOOK_RESERVED_SLUGS);\n\nexport const webhookSlugSchema = z\n  .string()\n  .pipe(connectionSlugSchema)\n  .refine((slug) => !webhookReservedSlugSet.has(slug), {\n    message: 'Slug is reserved',\n  });\n\nexport const createWebhookConnectionBodySchema = z.object({\n  workspace_id: z.string().uuid(),\n  name: z.string().min(1).max(100),\n  slug: webhookSlugSchema,\n});\nexport type CreateWebhookConnectionBodyDto = z.infer<typeof createWebhookConnectionBodySchema>;\n\nexport const updateWebhookConnectionBodySchema = z.object({\n  lifecycle_status: z.enum(['active', 'disabled']),\n});\nexport type UpdateWebhookConnectionBodyDto = z.infer<typeof updateWebhookConnectionBodySchema>;\n\nexport const webhookConnectionDtoSchema = z.object({\n  id: z.string().uuid(),\n  workspace_id: z.string().uuid(),\n  name: z.string(),\n  slug: connectionSlugSchema,\n  lifecycle_status: z.enum(['active', 'disabled', 'error']),\n  inbound_url: z.string().url(),\n  created_at: z.string(),\n  updated_at: z.string(),\n});\nexport type WebhookConnectionDto = z.infer<typeof webhookConnectionDtoSchema>;\n\nexport const listWebhookConnectionsQuerySchema = z.object({\n  workspace_id: z.string().uuid(),\n});\nexport type ListWebhookConnectionsQueryDto = z.infer<typeof listWebhookConnectionsQuerySchema>;\n\nexport const listWebhookConnectionsResponseSchema = z.object({\n  connections: z.array(webhookConnectionDtoSchema),\n});\nexport type ListWebhookConnectionsResponseDto = z.infer<\n  typeof listWebhookConnectionsResponseSchema\n>;\n"],"names":["connectionSlugSchema","z","WEBHOOK_RESERVED_SLUGS","WEBHOOK_PROVIDER","WEBHOOK_RECEIVED_EVENT","webhookReservedSlugSet","Set","webhookSlugSchema","string","pipe","refine","slug","has","message","createWebhookConnectionBodySchema","object","workspace_id","uuid","name","min","max","updateWebhookConnectionBodySchema","lifecycle_status","enum","webhookConnectionDtoSchema","id","inbound_url","url","created_at","updated_at","listWebhookConnectionsQuerySchema","listWebhookConnectionsResponseSchema","connections","array"],"mappings":"AAAA,cAAc,qBAAqB;AAEnC,SAAQA,oBAAoB,QAAO,oCAAoC;AACvE,SAAQC,CAAC,QAAO,MAAM;AACtB,SAAQC,sBAAsB,QAAO,iBAAiB;AAEtD,SACEC,gBAAgB,EAChBC,sBAAsB,EACtBF,sBAAsB,QACjB,iBAAiB;AAExB,MAAMG,yBAAyB,IAAIC,IAAYJ;AAE/C,OAAO,MAAMK,oBAAoBN,EAC9BO,MAAM,GACNC,IAAI,CAACT,sBACLU,MAAM,CAAC,CAACC,OAAS,CAACN,uBAAuBO,GAAG,CAACD,OAAO;IACnDE,SAAS;AACX,GAAG;AAEL,OAAO,MAAMC,oCAAoCb,EAAEc,MAAM,CAAC;IACxDC,cAAcf,EAAEO,MAAM,GAAGS,IAAI;IAC7BC,MAAMjB,EAAEO,MAAM,GAAGW,GAAG,CAAC,GAAGC,GAAG,CAAC;IAC5BT,MAAMJ;AACR,GAAG;AAGH,OAAO,MAAMc,oCAAoCpB,EAAEc,MAAM,CAAC;IACxDO,kBAAkBrB,EAAEsB,IAAI,CAAC;QAAC;QAAU;KAAW;AACjD,GAAG;AAGH,OAAO,MAAMC,6BAA6BvB,EAAEc,MAAM,CAAC;IACjDU,IAAIxB,EAAEO,MAAM,GAAGS,IAAI;IACnBD,cAAcf,EAAEO,MAAM,GAAGS,IAAI;IAC7BC,MAAMjB,EAAEO,MAAM;IACdG,MAAMX;IACNsB,kBAAkBrB,EAAEsB,IAAI,CAAC;QAAC;QAAU;QAAY;KAAQ;IACxDG,aAAazB,EAAEO,MAAM,GAAGmB,GAAG;IAC3BC,YAAY3B,EAAEO,MAAM;IACpBqB,YAAY5B,EAAEO,MAAM;AACtB,GAAG;AAGH,OAAO,MAAMsB,oCAAoC7B,EAAEc,MAAM,CAAC;IACxDC,cAAcf,EAAEO,MAAM,GAAGS,IAAI;AAC/B,GAAG;AAGH,OAAO,MAAMc,uCAAuC9B,EAAEc,MAAM,CAAC;IAC3DiB,aAAa/B,EAAEgC,KAAK,CAACT;AACvB,GAAG"}