feat(zui): revamp the API for simpler type manipulation (botpress#14947)

Author: franklevasseur

.gitignore

@@ -19,3 +19,4 @@ tilt_config.json
 hubspot.config.yml
 AGENTS.md
 CLAUDE.md
+.claude

integrations/browser/integration.definition.ts

@@ -3,7 +3,7 @@ import { IntegrationDefinition } from '@botpress/sdk'
 import { actionDefinitions } from 'src/definitions/actions'
 
 export const INTEGRATION_NAME = 'browser'
-export const INTEGRATION_VERSION = '0.8.4'
+export const INTEGRATION_VERSION = '0.8.5'
 
 export default new IntegrationDefinition({
   name: INTEGRATION_NAME,

integrations/browser/src/actions/discover-urls.ts

@@ -1,5 +1,5 @@
 import { RuntimeError } from '@botpress/client'
-import { IntegrationLogger, z, ZodIssueCode } from '@botpress/sdk'
+import { IntegrationLogger, z } from '@botpress/sdk'
 import Firecrawl, { SdkError } from '@mendable/firecrawl-js'
 import { trackEvent } from '../tracking'
 import { isValidGlob, matchGlob } from '../utils/globs'
@@ -11,37 +11,36 @@ const COST_PER_FIRECRAWL_MAP = 0.001
 
 type StopReason = Awaited<ReturnType<bp.IntegrationProps['actions']['discoverUrls']>>['stopReason']
 
-export const urlSchema = z.string().transform((url, ctx) => {
+type ZodIssueCode = z.ZodIssue['code']
+
+export const urlSchema = z.string().downstream((url) => {
   url = url.trim()
   if (!url.includes('://')) {
     url = `https://${url}`
   }
   try {
     const x = new URL(url)
     if (x.protocol !== 'http:' && x.protocol !== 'https:') {
-      ctx.addIssue({
-        code: ZodIssueCode.custom,
+      return z.ERR({
+        code: 'custom' satisfies ZodIssueCode,
         message: 'Invalid protocol, only URLs starting with HTTP and HTTPS are supported',
       })
-      return z.NEVER
     }
 
     if (!/.\.[a-zA-Z]{2,}$/.test(x.hostname)) {
-      ctx.addIssue({
-        code: ZodIssueCode.custom,
+      return z.ERR({
+        code: 'custom' satisfies ZodIssueCode,
         message: 'Invalid TLD',
       })
-      return z.NEVER
     }
     const pathName = x.pathname.endsWith('/') ? x.pathname.slice(0, -1) : x.pathname
-    return `${x.origin}${pathName}${x.search ? x.search : ''}`
+    return z.OK(`${x.origin}${pathName}${x.search ? x.search : ''}`)
   } catch (caught) {
     const err = caught instanceof Error ? caught : new Error('Unknown error while parsing URL')
-    ctx.addIssue({
-      code: ZodIssueCode.custom,
+    return z.ERR({
+      code: 'custom' satisfies ZodIssueCode,
       message: 'Invalid URL: ' + err.message,
     })
-    return z.NEVER
   }
 })
 

integrations/calendly/integration.definition.ts

@@ -5,7 +5,7 @@ import { inviteeEventOutputSchema } from 'definitions/events'
 export default new IntegrationDefinition({
   name: 'calendly',
   title: 'Calendly',
-  version: '0.0.2',
+  version: '0.0.3',
   readme: 'hub.md',
   icon: 'icon.svg',
   description: 'Schedule meetings and manage events using the Calendly scheduling platform.',

integrations/calendly/src/utils.ts

@@ -1,9 +1,9 @@
-import { RuntimeError, ZodError } from '@botpress/sdk'
+import { RuntimeError, z } from '@botpress/sdk'
 import axios from 'axios'
 import type { Result } from './types'
 
-const _isZodError = (error: any): error is ZodError => {
-  return error && typeof error === 'object' && error instanceof ZodError && 'errors' in error
+const _isZodError = (error: any): error is z.ZodError => {
+  return error && typeof error === 'object' && z.is.zuiError(error) && 'errors' in error
 }
 
 export function parseError(thrown: unknown): RuntimeError {

integrations/github/integration.definition.ts

@@ -7,7 +7,7 @@ import { actions, events, configuration, configurations, channels, user, secrets
 export default new sdk.IntegrationDefinition({
   name: INTEGRATION_NAME,
   title: 'GitHub',
-  version: '1.1.8',
+  version: '1.1.9',
   icon: 'icon.svg',
   readme: 'hub.md',
   description: 'Manage GitHub issues, pull requests, and repositories.',

integrations/github/src/definitions/events.ts

@@ -1,12 +1,12 @@
-import { z, ZodTypeAny } from '@botpress/sdk'
+import { z } from '@botpress/sdk'
 import * as sdk from '@botpress/sdk'
 import { Issue, PullRequest, User, PullRequestReview } from './entities'
 
 const COMMON_EVENT_FIELDS = {
   sender: {
     eventSender: User.title('Sender').describe('The user who triggered the event'),
   },
-} as const satisfies Record<string, Record<string, ZodTypeAny>>
+} as const satisfies Record<string, Record<string, z.ZodTypeAny>>
 
 const pullRequestOpened = {
   title: 'Pull Request opened',

integrations/github/src/definitions/index.ts

@@ -1,4 +1,4 @@
-import { z, ZodRawShape } from '@botpress/sdk'
+import { z } from '@botpress/sdk'
 import * as sdk from '@botpress/sdk'
 
 export { actions } from './actions'
@@ -23,7 +23,7 @@ const webhookSecret = {
     .describe(
       'A high-entropy string that only you and Botpress know. Must be set to the same value as in the GitHub organization settings.'
     ),
-} as const satisfies ZodRawShape
+} as const satisfies z.ZodRawShape
 
 export const configurations = {
   manualApp: {

integrations/mailchimp/integration.definition.ts

@@ -16,7 +16,7 @@ const INTEGRATION_NAME = 'mailchimp'
 export default new IntegrationDefinition({
   name: INTEGRATION_NAME,
   title: 'Mailchimp',
-  version: '0.3.10',
+  version: '0.3.11',
   readme: 'hub.md',
   icon: 'icon.svg',
   description: 'Send mass email campaigns from within your workflows. Manage customers, campaigns, lists and more.',

integrations/mailchimp/src/utils.ts

@@ -1,4 +1,4 @@
-import { ZodError, RuntimeError } from '@botpress/sdk'
+import { RuntimeError, z } from '@botpress/sdk'
 import { MailchimpApi } from './client'
 import { Customer, MailchimpAPIError } from './misc/custom-types'
 import { Logger } from './misc/types'
@@ -27,8 +27,8 @@ export const isMailchimpError = (error: any): error is MailchimpAPIError => {
   return 'status' in error && 'response' in error && 'body' in error.response
 }
 
-export const isZodError = (error: any): error is ZodError => {
-  return error && typeof error === 'object' && error instanceof ZodError && 'errors' in error
+export const isZodError = (error: any): error is z.ZodError => {
+  return error && typeof error === 'object' && z.is.zuiError(error) && 'errors' in error
 }
 
 export const parseError = (error: any): RuntimeError => {