@botpress/cli 5.5.0 → 5.5.2

package/dist/linter/rulesets/bot.ruleset.js

@@ -22,13 +22,14 @@ __export(bot_ruleset_exports, {
 });
 module.exports = __toCommonJS(bot_ruleset_exports);
 var import_spectral_functions = require("@stoplight/spectral-functions");
+var import_ruleset_functions = require("../ruleset-functions");
 var import_spectral_functions2 = require("../spectral-functions");
-const BOT_RULESET = {
+const BOT_RULESET = (0, import_ruleset_functions.preprocessRuleset)({
   extends: [],
   rules: {
     "event-outputparams-should-have-title": {
-      description: "All event output parameters SHOULD have a title",
-      message: "{{description}}: {{error}} SHOULD provide a non-empty title by using .title() in its Zod schema",
+      description: "All event output parameters {{callToAction}} have a title",
+      message: "{{description}}: {{error}} {{callToAction}} provide a non-empty title by using .title() in its Zod schema",
       severity: "warn",
       given: "$.events[*]..schema.properties[*]",
       then: [
@@ -42,8 +43,8 @@ const BOT_RULESET = {
       ]
     },
     "event-outputparams-must-have-description": {
-      description: "All event output parameters MUST have a description",
-      message: "{{description}}: {{error}} SHOULD provide a non-empty description by using .describe() in its Zod schema",
+      description: "All event output parameters {{callToAction}} have a description",
+      message: "{{description}}: {{error}} {{callToAction}} provide a non-empty description by using .describe() in its Zod schema",
       severity: "error",
       given: "$.events[*]..schema.properties[*]",
       then: [
@@ -57,8 +58,8 @@ const BOT_RULESET = {
       ]
     },
     "configuration-fields-must-have-a-title": {
-      description: "All configuration fields MUST have a title",
-      message: "{{description}}: {{error}} MUST provide a non-empty title by using .title() in its Zod schema",
+      description: "All configuration fields {{callToAction}} have a title",
+      message: "{{description}}: {{error}} {{callToAction}} provide a non-empty title by using .title() in its Zod schema",
       severity: "error",
       given: "$.configuration..schema.properties[*].x-zui",
       then: [
@@ -72,8 +73,8 @@ const BOT_RULESET = {
       ]
     },
     "configuration-fields-must-have-a-description": {
-      description: "All configuration fields MUST have a description",
-      message: "{{description}}: {{error}} MUST provide a non-empty description by using .describe() in its Zod schema",
+      description: "All configuration fields {{callToAction}} have a description",
+      message: "{{description}}: {{error}} {{callToAction}} provide a non-empty description by using .describe() in its Zod schema",
       severity: "error",
       given: "$.configuration..schema.properties[*]",
       then: [
@@ -87,8 +88,8 @@ const BOT_RULESET = {
       ]
     },
     "user-tags-should-have-a-title": {
-      description: "All user tags SHOULD have a title",
-      message: "{{description}}: {{error}} SHOULD have a non-empty title",
+      description: "All user tags {{callToAction}} have a title",
+      message: "{{description}}: {{error}} {{callToAction}} have a non-empty title",
       severity: "warn",
       given: "$.user.tags[*]",
       then: [
@@ -99,8 +100,8 @@ const BOT_RULESET = {
       ]
     },
     "user-tags-must-have-a-description": {
-      description: "All user tags MUST have a description",
-      message: "{{description}}: {{error}} MUST have a non-empty description",
+      description: "All user tags {{callToAction}} have a description",
+      message: "{{description}}: {{error}} {{callToAction}} have a non-empty description",
       severity: "error",
       given: "$.user.tags[*]",
       then: [
@@ -111,8 +112,8 @@ const BOT_RULESET = {
       ]
     },
     "conversation-tags-should-have-a-title": {
-      description: "All conversation tags SHOULD have a title",
-      message: "{{description}}: {{error}} SHOULD have a non-empty title",
+      description: "All conversation tags {{callToAction}} have a title",
+      message: "{{description}}: {{error}} {{callToAction}} have a non-empty title",
       severity: "warn",
       given: "$.conversation.tags[*]",
       then: [
@@ -123,8 +124,8 @@ const BOT_RULESET = {
       ]
     },
     "conversation-tags-must-have-a-description": {
-      description: "All conversation tags MUST have a description",
-      message: "{{description}}: {{error}} MUST have a non-empty description",
+      description: "All conversation tags {{callToAction}} have a description",
+      message: "{{description}}: {{error}} {{callToAction}} have a non-empty description",
       severity: "error",
       given: "$.conversation.tags[*]",
       then: [
@@ -135,8 +136,8 @@ const BOT_RULESET = {
       ]
     },
     "message-tags-should-have-a-title": {
-      description: "All message tags SHOULD have a title",
-      message: "{{description}}: {{error}} SHOULD have a non-empty title",
+      description: "All message tags {{callToAction}} have a title",
+      message: "{{description}}: {{error}} {{callToAction}} have a non-empty title",
       severity: "warn",
       given: "$.message.tags[*]",
       then: [
@@ -147,8 +148,8 @@ const BOT_RULESET = {
       ]
     },
     "message-tags-must-have-a-description": {
-      description: "All message tags MUST have a description",
-      message: "{{description}}: {{error}} MUST have a non-empty description",
+      description: "All message tags {{callToAction}} have a description",
+      message: "{{description}}: {{error}} {{callToAction}} have a non-empty description",
       severity: "error",
       given: "$.message.tags[*]",
       then: [
@@ -159,20 +160,20 @@ const BOT_RULESET = {
       ]
     },
     "legacy-zui-title-should-be-removed": {
-      description: "Legacy ZUI title fields (ui.title) SHOULD be removed. Please use .title() in your Zod schemas instead",
+      description: "Legacy ZUI title fields (ui.title) {{callToAction}} be removed. Please use .title() in your Zod schemas instead",
       severity: "error",
       given: "$..ui[*].title",
       then: [{ function: import_spectral_functions.falsy }]
     },
     "legacy-zui-examples-should-be-removed": {
-      description: "Legacy ZUI examples fields (ui.examples) SHOULD be removed. There are currently no alternatives",
+      description: "Legacy ZUI examples fields (ui.examples) {{callToAction}} be removed. There are currently no alternatives",
       severity: "hint",
       given: "$..ui[*].examples",
       then: [{ function: import_spectral_functions.falsy }]
     },
     "state-fields-should-have-title": {
-      description: "All state fields SHOULD have a title",
-      message: "{{description}}: {{error}} SHOULD provide a non-empty title by using .title() in its Zod schema",
+      description: "All state fields {{callToAction}} have a title",
+      message: "{{description}}: {{error}} {{callToAction}} provide a non-empty title by using .title() in its Zod schema",
       severity: "warn",
       given: "$.states[*]..schema.properties[*]",
       then: [
@@ -186,8 +187,8 @@ const BOT_RULESET = {
       ]
     },
     "state-fields-must-have-description": {
-      description: "All state fields MUST have a description",
-      message: "{{description}}: {{error}} SHOULD provide a non-empty description by using .describe() in its Zod schema",
+      description: "All state fields {{callToAction}} have a description",
+      message: "{{description}}: {{error}} {{callToAction}} provide a non-empty description by using .describe() in its Zod schema",
       severity: "error",
       given: "$.states[*]..schema.properties[*]",
       then: [
@@ -201,7 +202,7 @@ const BOT_RULESET = {
       ]
     }
   }
-};
+});
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   BOT_RULESET

package/dist/linter/rulesets/bot.ruleset.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/linter/rulesets/bot.ruleset.ts"],
-  "sourcesContent": ["import { type RulesetDefinition } from '@stoplight/spectral-core'\nimport { falsy } from '@stoplight/spectral-functions'\nimport { descriptionFallbackExtractor, titleFallbackExtractor, truthyWithMessage } from '../spectral-functions'\n\nexport const BOT_RULESET = {\n  extends: [],\n  rules: {\n    'event-outputparams-should-have-title': {\n      description: 'All event output parameters SHOULD have a title',\n      message: '{{description}}: {{error}} SHOULD provide a non-empty title by using .title() in its Zod schema',\n      severity: 'warn',\n      given: '$.events[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'x-zui.title',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) =>\n              `output parameter \"${path.at(isFallback ? -5 : -3)}\" of event \"${path[1]}\"`,\n            fallbackExtractor: titleFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'event-outputparams-must-have-description': {\n      description: 'All event output parameters MUST have a description',\n      message:\n        '{{description}}: {{error}} SHOULD provide a non-empty description by using .describe() in its Zod schema',\n      severity: 'error',\n      given: '$.events[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) =>\n              `output parameter \"${path.at(isFallback ? -4 : -2)}\" of event \"${path[1]}\"`,\n            fallbackExtractor: descriptionFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'configuration-fields-must-have-a-title': {\n      description: 'All configuration fields MUST have a title',\n      message: '{{description}}: {{error}} MUST provide a non-empty title by using .title() in its Zod schema',\n      severity: 'error',\n      given: '$.configuration..schema.properties[*].x-zui',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) => `configuration parameter \"${path.at(isFallback ? -5 : -3)}\"`,\n            fallbackExtractor: titleFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'configuration-fields-must-have-a-description': {\n      description: 'All configuration fields MUST have a description',\n      message: '{{description}}: {{error}} MUST provide a non-empty description by using .describe() in its Zod schema',\n      severity: 'error',\n      given: '$.configuration..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) => `configuration parameter \"${path.at(isFallback ? -4 : -2)}\"`,\n            fallbackExtractor: descriptionFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'user-tags-should-have-a-title': {\n      description: 'All user tags SHOULD have a title',\n      message: '{{description}}: {{error}} SHOULD have a non-empty title',\n      severity: 'warn',\n      given: '$.user.tags[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `user tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'user-tags-must-have-a-description': {\n      description: 'All user tags MUST have a description',\n      message: '{{description}}: {{error}} MUST have a non-empty description',\n      severity: 'error',\n      given: '$.user.tags[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `user tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'conversation-tags-should-have-a-title': {\n      description: 'All conversation tags SHOULD have a title',\n      message: '{{description}}: {{error}} SHOULD have a non-empty title',\n      severity: 'warn',\n      given: '$.conversation.tags[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `conversation tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'conversation-tags-must-have-a-description': {\n      description: 'All conversation tags MUST have a description',\n      message: '{{description}}: {{error}} MUST have a non-empty description',\n      severity: 'error',\n      given: '$.conversation.tags[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `conversation tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'message-tags-should-have-a-title': {\n      description: 'All message tags SHOULD have a title',\n      message: '{{description}}: {{error}} SHOULD have a non-empty title',\n      severity: 'warn',\n      given: '$.message.tags[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `message tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'message-tags-must-have-a-description': {\n      description: 'All message tags MUST have a description',\n      message: '{{description}}: {{error}} MUST have a non-empty description',\n      severity: 'error',\n      given: '$.message.tags[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `message tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'legacy-zui-title-should-be-removed': {\n      description:\n        'Legacy ZUI title fields (ui.title) SHOULD be removed. Please use .title() in your Zod schemas instead',\n      severity: 'error',\n      given: '$..ui[*].title',\n      then: [{ function: falsy }],\n    },\n    'legacy-zui-examples-should-be-removed': {\n      description: 'Legacy ZUI examples fields (ui.examples) SHOULD be removed. There are currently no alternatives',\n      severity: 'hint',\n      given: '$..ui[*].examples',\n      then: [{ function: falsy }],\n    },\n    'state-fields-should-have-title': {\n      description: 'All state fields SHOULD have a title',\n      message: '{{description}}: {{error}} SHOULD provide a non-empty title by using .title() in its Zod schema',\n      severity: 'warn',\n      given: '$.states[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'x-zui.title',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) => `field \"${path.at(isFallback ? -5 : -3)}\" of state \"${path[1]}\"`,\n            fallbackExtractor: titleFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'state-fields-must-have-description': {\n      description: 'All state fields MUST have a description',\n      message:\n        '{{description}}: {{error}} SHOULD provide a non-empty description by using .describe() in its Zod schema',\n      severity: 'error',\n      given: '$.states[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) => `field \"${path.at(isFallback ? -4 : -2)}\" of state \"${path[1]}\"`,\n            fallbackExtractor: descriptionFallbackExtractor,\n          }),\n        },\n      ],\n    },\n  },\n} satisfies RulesetDefinition\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,gCAAsB;AACtB,IAAAA,6BAAwF;AAEjF,MAAM,cAAc;AAAA,EACzB,SAAS,CAAC;AAAA,EACV,OAAO;AAAA,IACL,wCAAwC;AAAA,MACtC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MACjC,qBAAqB,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC;AAAA,YAC1E,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,4CAA4C;AAAA,MAC1C,aAAa;AAAA,MACb,SACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MACjC,qBAAqB,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC;AAAA,YAC1E,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,0CAA0C;AAAA,MACxC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MAAM,4BAA4B,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC;AAAA,YAClG,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,gDAAgD;AAAA,MAC9C,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MAAM,4BAA4B,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC;AAAA,YAClG,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,iCAAiC;AAAA,MAC/B,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,GAAG;AAAA,QACnE;AAAA,MACF;AAAA,IACF;AAAA,IACA,qCAAqC;AAAA,MACnC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,GAAG;AAAA,QACnE;AAAA,MACF;AAAA,IACF;AAAA,IACA,yCAAyC;AAAA,MACvC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,qBAAqB,KAAK,CAAC,CAAC,GAAG;AAAA,QAC3E;AAAA,MACF;AAAA,IACF;AAAA,IACA,6CAA6C;AAAA,MAC3C,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,qBAAqB,KAAK,CAAC,CAAC,GAAG;AAAA,QAC3E;AAAA,MACF;AAAA,IACF;AAAA,IACA,oCAAoC;AAAA,MAClC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,gBAAgB,KAAK,CAAC,CAAC,GAAG;AAAA,QACtE;AAAA,MACF;AAAA,IACF;AAAA,IACA,wCAAwC;AAAA,MACtC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,gBAAgB,KAAK,CAAC,CAAC,GAAG;AAAA,QACtE;AAAA,MACF;AAAA,IACF;AAAA,IACA,sCAAsC;AAAA,MACpC,aACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,UAAU,gCAAM,CAAC;AAAA,IAC5B;AAAA,IACA,yCAAyC;AAAA,MACvC,aAAa;AAAA,MACb,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,UAAU,gCAAM,CAAC;AAAA,IAC5B;AAAA,IACA,kCAAkC;AAAA,MAChC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MAAM,UAAU,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC;AAAA,YACtG,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,sCAAsC;AAAA,MACpC,aAAa;AAAA,MACb,SACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MAAM,UAAU,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC;AAAA,YACtG,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;",
+  "sourcesContent": ["import { falsy } from '@stoplight/spectral-functions'\nimport { preprocessRuleset } from '../ruleset-functions'\nimport { descriptionFallbackExtractor, titleFallbackExtractor, truthyWithMessage } from '../spectral-functions'\n\nexport const BOT_RULESET = preprocessRuleset({\n  extends: [],\n  rules: {\n    'event-outputparams-should-have-title': {\n      description: 'All event output parameters {{callToAction}} have a title',\n      message:\n        '{{description}}: {{error}} {{callToAction}} provide a non-empty title by using .title() in its Zod schema',\n      severity: 'warn',\n      given: '$.events[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'x-zui.title',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) =>\n              `output parameter \"${path.at(isFallback ? -5 : -3)}\" of event \"${path[1]}\"`,\n            fallbackExtractor: titleFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'event-outputparams-must-have-description': {\n      description: 'All event output parameters {{callToAction}} have a description',\n      message:\n        '{{description}}: {{error}} {{callToAction}} provide a non-empty description by using .describe() in its Zod schema',\n      severity: 'error',\n      given: '$.events[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) =>\n              `output parameter \"${path.at(isFallback ? -4 : -2)}\" of event \"${path[1]}\"`,\n            fallbackExtractor: descriptionFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'configuration-fields-must-have-a-title': {\n      description: 'All configuration fields {{callToAction}} have a title',\n      message:\n        '{{description}}: {{error}} {{callToAction}} provide a non-empty title by using .title() in its Zod schema',\n      severity: 'error',\n      given: '$.configuration..schema.properties[*].x-zui',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) => `configuration parameter \"${path.at(isFallback ? -5 : -3)}\"`,\n            fallbackExtractor: titleFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'configuration-fields-must-have-a-description': {\n      description: 'All configuration fields {{callToAction}} have a description',\n      message:\n        '{{description}}: {{error}} {{callToAction}} provide a non-empty description by using .describe() in its Zod schema',\n      severity: 'error',\n      given: '$.configuration..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) => `configuration parameter \"${path.at(isFallback ? -4 : -2)}\"`,\n            fallbackExtractor: descriptionFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'user-tags-should-have-a-title': {\n      description: 'All user tags {{callToAction}} have a title',\n      message: '{{description}}: {{error}} {{callToAction}} have a non-empty title',\n      severity: 'warn',\n      given: '$.user.tags[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `user tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'user-tags-must-have-a-description': {\n      description: 'All user tags {{callToAction}} have a description',\n      message: '{{description}}: {{error}} {{callToAction}} have a non-empty description',\n      severity: 'error',\n      given: '$.user.tags[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `user tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'conversation-tags-should-have-a-title': {\n      description: 'All conversation tags {{callToAction}} have a title',\n      message: '{{description}}: {{error}} {{callToAction}} have a non-empty title',\n      severity: 'warn',\n      given: '$.conversation.tags[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `conversation tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'conversation-tags-must-have-a-description': {\n      description: 'All conversation tags {{callToAction}} have a description',\n      message: '{{description}}: {{error}} {{callToAction}} have a non-empty description',\n      severity: 'error',\n      given: '$.conversation.tags[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `conversation tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'message-tags-should-have-a-title': {\n      description: 'All message tags {{callToAction}} have a title',\n      message: '{{description}}: {{error}} {{callToAction}} have a non-empty title',\n      severity: 'warn',\n      given: '$.message.tags[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `message tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'message-tags-must-have-a-description': {\n      description: 'All message tags {{callToAction}} have a description',\n      message: '{{description}}: {{error}} {{callToAction}} have a non-empty description',\n      severity: 'error',\n      given: '$.message.tags[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `message tag \"${path[2]}\"`),\n        },\n      ],\n    },\n    'legacy-zui-title-should-be-removed': {\n      description:\n        'Legacy ZUI title fields (ui.title) {{callToAction}} be removed. Please use .title() in your Zod schemas instead',\n      severity: 'error',\n      given: '$..ui[*].title',\n      then: [{ function: falsy }],\n    },\n    'legacy-zui-examples-should-be-removed': {\n      description:\n        'Legacy ZUI examples fields (ui.examples) {{callToAction}} be removed. There are currently no alternatives',\n      severity: 'hint',\n      given: '$..ui[*].examples',\n      then: [{ function: falsy }],\n    },\n    'state-fields-should-have-title': {\n      description: 'All state fields {{callToAction}} have a title',\n      message:\n        '{{description}}: {{error}} {{callToAction}} provide a non-empty title by using .title() in its Zod schema',\n      severity: 'warn',\n      given: '$.states[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'x-zui.title',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) => `field \"${path.at(isFallback ? -5 : -3)}\" of state \"${path[1]}\"`,\n            fallbackExtractor: titleFallbackExtractor,\n          }),\n        },\n      ],\n    },\n    'state-fields-must-have-description': {\n      description: 'All state fields {{callToAction}} have a description',\n      message:\n        '{{description}}: {{error}} {{callToAction}} provide a non-empty description by using .describe() in its Zod schema',\n      severity: 'error',\n      given: '$.states[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage({\n            failMsgMapper: ({ path, isFallback }) => `field \"${path.at(isFallback ? -4 : -2)}\" of state \"${path[1]}\"`,\n            fallbackExtractor: descriptionFallbackExtractor,\n          }),\n        },\n      ],\n    },\n  },\n})\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gCAAsB;AACtB,+BAAkC;AAClC,IAAAA,6BAAwF;AAEjF,MAAM,kBAAc,4CAAkB;AAAA,EAC3C,SAAS,CAAC;AAAA,EACV,OAAO;AAAA,IACL,wCAAwC;AAAA,MACtC,aAAa;AAAA,MACb,SACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MACjC,qBAAqB,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC;AAAA,YAC1E,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,4CAA4C;AAAA,MAC1C,aAAa;AAAA,MACb,SACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MACjC,qBAAqB,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC;AAAA,YAC1E,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,0CAA0C;AAAA,MACxC,aAAa;AAAA,MACb,SACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MAAM,4BAA4B,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC;AAAA,YAClG,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,gDAAgD;AAAA,MAC9C,aAAa;AAAA,MACb,SACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MAAM,4BAA4B,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC;AAAA,YAClG,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,iCAAiC;AAAA,MAC/B,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,GAAG;AAAA,QACnE;AAAA,MACF;AAAA,IACF;AAAA,IACA,qCAAqC;AAAA,MACnC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,aAAa,KAAK,CAAC,CAAC,GAAG;AAAA,QACnE;AAAA,MACF;AAAA,IACF;AAAA,IACA,yCAAyC;AAAA,MACvC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,qBAAqB,KAAK,CAAC,CAAC,GAAG;AAAA,QAC3E;AAAA,MACF;AAAA,IACF;AAAA,IACA,6CAA6C;AAAA,MAC3C,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,qBAAqB,KAAK,CAAC,CAAC,GAAG;AAAA,QAC3E;AAAA,MACF;AAAA,IACF;AAAA,IACA,oCAAoC;AAAA,MAClC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,gBAAgB,KAAK,CAAC,CAAC,GAAG;AAAA,QACtE;AAAA,MACF;AAAA,IACF;AAAA,IACA,wCAAwC;AAAA,MACtC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,gBAAgB,KAAK,CAAC,CAAC,GAAG;AAAA,QACtE;AAAA,MACF;AAAA,IACF;AAAA,IACA,sCAAsC;AAAA,MACpC,aACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,UAAU,gCAAM,CAAC;AAAA,IAC5B;AAAA,IACA,yCAAyC;AAAA,MACvC,aACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,UAAU,gCAAM,CAAC;AAAA,IAC5B;AAAA,IACA,kCAAkC;AAAA,MAChC,aAAa;AAAA,MACb,SACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MAAM,UAAU,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC;AAAA,YACtG,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,IACA,sCAAsC;AAAA,MACpC,aAAa;AAAA,MACb,SACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU,8CAAkB;AAAA,YAC1B,eAAe,CAAC,EAAE,MAAM,WAAW,MAAM,UAAU,KAAK,GAAG,aAAa,KAAK,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC;AAAA,YACtG,mBAAmB;AAAA,UACrB,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF,CAAC;",
   "names": ["import_spectral_functions"]
 }

package/dist/linter/rulesets/integration.ruleset.d.ts

@@ -1,336 +1 @@
-export declare const INTEGRATION_RULESET: {
-    extends: never[];
-    rules: {
-        'integration-title-must-be-present': {
-            description: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunctionWithValidator<unknown, null>;
-            }[];
-        };
-        'integration-description-must-be-present': {
-            description: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunctionWithValidator<unknown, null>;
-            }[];
-        };
-        'integration-must-have-an-icon': {
-            description: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunctionWithValidator<unknown, null>;
-            }[];
-        };
-        'integration-must-have-a-readme-file': {
-            description: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunctionWithValidator<unknown, null>;
-            }[];
-        };
-        'actions-should-have-a-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'actions-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'action-inputparams-should-have-a-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'action-inputparams-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'action-outputparams-should-have-a-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'action-outputparams-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'event-outputparams-should-have-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'event-outputparams-must-have-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'events-must-have-a-title': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'events-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'consider-migrating-to-configurations': {
-            description: string;
-            severity: "off";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunctionWithValidator<unknown, null>;
-            }[];
-        };
-        'configuration-fields-must-have-a-title': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'configuration-fields-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'multiple-configurations-must-have-a-title': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'multiple-configurations-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'multipes-configurations-fields-must-have-a-title': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'multipes-configurations-fields-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'user-tags-should-have-a-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'user-tags-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'channels-should-have-a-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'channels-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'channels-conversation-tags-should-have-a-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'channels-conversation-tags-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'channels-message-tags-should-have-a-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'channels-message-tags-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'legacy-zui-title-should-be-removed': {
-            description: string;
-            severity: "error";
-            given: string;
-            then: {
-                function: import("@stoplight/spectral-core").RulesetFunctionWithValidator<unknown, null>;
-            }[];
-        };
-        'legacy-zui-examples-should-be-removed': {
-            description: string;
-            severity: "hint";
-            given: string;
-            then: {
-                function: import("@stoplight/spectral-core").RulesetFunctionWithValidator<unknown, null>;
-            }[];
-        };
-        'state-fields-should-have-title': {
-            description: string;
-            message: string;
-            severity: "warn";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'state-fields-must-have-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-        'secrets-must-have-a-description': {
-            description: string;
-            message: string;
-            severity: "error";
-            given: string;
-            then: {
-                field: string;
-                function: import("@stoplight/spectral-core").RulesetFunction<any, any> | import("@stoplight/spectral-core").RulesetFunctionWithValidator<any, any>;
-            }[];
-        };
-    };
-};
+export declare const INTEGRATION_RULESET: import("@stoplight/spectral-core").RulesetDefinition & import("../ruleset-tests/common").Ruleset;