@botpress/adk-cli 1.2.1 → 1.4.0

package/dist/bp-cli/dist/linter/rulesets/integration.ruleset.js

@@ -0,0 +1,378 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var integration_ruleset_exports = {};
+__export(integration_ruleset_exports, {
+  INTEGRATION_RULESET: () => INTEGRATION_RULESET
+});
+module.exports = __toCommonJS(integration_ruleset_exports);
+var import_spectral_functions = require("@stoplight/spectral-functions");
+var import_spectral_functions2 = require("../spectral-functions");
+const INTEGRATION_RULESET = {
+  extends: [],
+  rules: {
+    "integration-title-must-be-present": {
+      description: "The integration MUST have a non-empty title",
+      severity: "error",
+      given: "$",
+      then: [{ field: "title", function: import_spectral_functions.truthy }]
+    },
+    "integration-description-must-be-present": {
+      description: "The integration MUST have a non-empty description",
+      severity: "error",
+      given: "$",
+      then: [{ field: "description", function: import_spectral_functions.truthy }]
+    },
+    "integration-must-have-an-icon": {
+      description: "The integration MUST have an icon",
+      severity: "error",
+      given: "$",
+      then: [{ field: "icon", function: import_spectral_functions.truthy }]
+    },
+    "integration-must-have-a-readme-file": {
+      description: "The integration MUST have a readme file",
+      severity: "error",
+      given: "$",
+      then: [{ field: "readme", function: import_spectral_functions.truthy }]
+    },
+    "actions-should-have-a-title": {
+      description: "All actions SHOULD have a title",
+      message: "{{description}}: {{error}} SHOULD have a non-empty title",
+      severity: "warn",
+      given: "$.actions[*]",
+      then: [{ field: "title", function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `action "${path[1]}"`) }]
+    },
+    "actions-must-have-a-description": {
+      description: "All actions MUST have a description",
+      message: "{{description}}: {{error}} MUST have a non-empty description",
+      severity: "error",
+      given: "$.actions[*]",
+      then: [{ field: "description", function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `action "${path[1]}"`) }]
+    },
+    "action-inputparams-should-have-a-title": {
+      description: "All action input parameters SHOULD have a title",
+      message: "{{description}}: {{error}} SHOULD provide a non-empty title by using .title() in its Zod schema",
+      severity: "warn",
+      given: "$.actions[*].input..schema.properties[*]",
+      then: [
+        {
+          field: "x-zui.title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `input parameter "${path.at(-3)}" of action "${path[1]}"`)
+        }
+      ]
+    },
+    "action-inputparams-must-have-a-description": {
+      description: "All action input parameters MUST have a description",
+      message: "{{description}}: {{error}} MUST provide a non-empty description by using .describe() in its Zod schema",
+      severity: "error",
+      given: "$.actions[*].input..schema.properties[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `input parameter "${path.at(-2)}" of action "${path[1]}"`)
+        }
+      ]
+    },
+    "action-outputparams-should-have-a-title": {
+      description: "All action output parameters SHOULD have a title",
+      message: "{{description}}: {{error}} SHOULD provide a non-empty title by using .title() in its Zod schema",
+      severity: "warn",
+      given: "$.actions[*].output..schema.properties[*].x-zui",
+      then: [
+        {
+          field: "title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `output parameter "${path.at(-3)}" of action "${path[1]}"`)
+        }
+      ]
+    },
+    "action-outputparams-must-have-a-description": {
+      description: "All action output parameters MUST have a description",
+      message: "{{description}}: {{error}} MUST provide a non-empty description by using .describe() in its Zod schema",
+      severity: "error",
+      given: "$.actions[*].output..schema.properties[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `output parameter "${path.at(-2)}" of action "${path[1]}"`)
+        }
+      ]
+    },
+    "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",
+      severity: "warn",
+      given: "$.events[*]..schema.properties[*]",
+      then: [
+        {
+          field: "x-zui.title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `output parameter "${path.at(-3)}" of event "${path[1]}"`)
+        }
+      ]
+    },
+    "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",
+      severity: "error",
+      given: "$.events[*]..schema.properties[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `output parameter "${path.at(-2)}" of event "${path[1]}"`)
+        }
+      ]
+    },
+    "events-must-have-a-title": {
+      description: "All events MUST have a title",
+      message: "{{description}}: {{error}} MUST be a non-empty string",
+      severity: "error",
+      given: "$.events[*]",
+      then: [{ field: "title", function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `event "${path[1]}"`) }]
+    },
+    "events-must-have-a-description": {
+      description: "All events MUST have a description",
+      message: "{{description}}: {{error}} MUST be a non-empty string",
+      severity: "error",
+      given: "$.events[*]",
+      then: [{ field: "description", function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `event "${path[1]}"`) }]
+    },
+    "consider-migrating-to-configurations": {
+      description: 'Consider migrating to the new multiple configuration format: you MAY move your configuration from "configuration" to "configurations" and remove the "configuration" property',
+      severity: "off",
+      given: "$",
+      then: [
+        { field: "configuration", function: import_spectral_functions.falsy },
+        { field: "configurations", function: import_spectral_functions.truthy }
+      ]
+    },
+    "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",
+      severity: "error",
+      given: "$.configuration..schema.properties[*].x-zui",
+      then: [
+        {
+          field: "title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `configuration parameter "${path.at(-3)}"`)
+        }
+      ]
+    },
+    "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",
+      severity: "error",
+      given: "$.configuration..schema.properties[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `configuration parameter "${path.at(-2)}"`)
+        }
+      ]
+    },
+    "multiple-configurations-must-have-a-title": {
+      description: "Multiple configuration definitions MUST have a title",
+      message: "{{description}}: {{error}} MUST have a title",
+      severity: "error",
+      given: "$.configurations[*]",
+      then: [{ field: "title", function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `configuration "${path[1]}"`) }]
+    },
+    "multiple-configurations-must-have-a-description": {
+      description: "Multiple configuration definitions MUST have a description",
+      message: "{{description}}: {{error}} MUST have a description",
+      severity: "error",
+      given: "$.configurations[*]",
+      then: [{ field: "description", function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `configuration "${path[1]}"`) }]
+    },
+    "multipes-configurations-fields-must-have-a-title": {
+      description: "All configuration fields in multiple configurations MUST have a title",
+      message: "{{description}}: {{error}} MUST provide a non-empty title by using .title() in its Zod schema",
+      severity: "error",
+      given: "$.configurations[*]..schema.properties[*].x-zui",
+      then: [
+        {
+          field: "title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(
+            ({ path }) => `configuration field "${path.at(-3)}" of configuration "${path[1]}"`
+          )
+        }
+      ]
+    },
+    "multipes-configurations-fields-must-have-a-description": {
+      description: "All configuration fields in multiple configurations MUST have a description",
+      message: "{{description}}: {{error}} MUST provide a non-empty description by using .describe() in its Zod schema",
+      severity: "error",
+      given: "$.configurations[*]..schema.properties[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(
+            ({ path }) => `configuration field "${path.at(-2)}" of configuration "${path[1]}"`
+          )
+        }
+      ]
+    },
+    "user-tags-should-have-a-title": {
+      description: "All user tags SHOULD have a title",
+      message: "{{description}}: {{error}} SHOULD have a non-empty title",
+      severity: "warn",
+      given: "$.user.tags[*]",
+      then: [
+        {
+          field: "title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `user tag "${path[2]}"`)
+        }
+      ]
+    },
+    "user-tags-must-have-a-description": {
+      description: "All user tags MUST have a description",
+      message: "{{description}}: {{error}} MUST have a non-empty description",
+      severity: "error",
+      given: "$.user.tags[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `user tag "${path[2]}"`)
+        }
+      ]
+    },
+    "channels-should-have-a-title": {
+      description: "All channels SHOULD have a title",
+      message: "{{description}}: {{error}} SHOULD have a non-empty title",
+      severity: "warn",
+      given: "$.channels[*]",
+      then: [
+        {
+          field: "title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `channel "${path[1]}"`)
+        }
+      ]
+    },
+    "channels-must-have-a-description": {
+      description: "All channels MUST have a description",
+      message: "{{description}}: {{error}} MUST have a non-empty description",
+      severity: "error",
+      given: "$.channels[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `channel "${path[1]}"`)
+        }
+      ]
+    },
+    "channels-conversation-tags-should-have-a-title": {
+      description: "All conversation tags SHOULD have a title",
+      message: "{{description}}: {{error}} SHOULD have a non-empty title",
+      severity: "warn",
+      given: "$.channels[*].conversation.tags[*]",
+      then: [
+        {
+          field: "title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `conversation tag "${path.at(-2)}" of channel "${path[1]}"`)
+        }
+      ]
+    },
+    "channels-conversation-tags-must-have-a-description": {
+      description: "All conversation tags MUST have a description",
+      message: "{{description}}: {{error}} MUST have a non-empty description",
+      severity: "error",
+      given: "$.channels[*].conversation.tags[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `conversation tag "${path.at(-2)}" of channel "${path[1]}"`)
+        }
+      ]
+    },
+    "channels-message-tags-should-have-a-title": {
+      description: "All message tags SHOULD have a title",
+      message: "{{description}}: {{error}} SHOULD have a non-empty title",
+      severity: "warn",
+      given: "$.channels[*].message.tags[*]",
+      then: [
+        {
+          field: "title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `message tag "${path.at(-2)}" of channel "${path[1]}"`)
+        }
+      ]
+    },
+    "channels-message-tags-must-have-a-description": {
+      description: "All message tags MUST have a description",
+      message: "{{description}}: {{error}} MUST have a non-empty description",
+      severity: "error",
+      given: "$.channels[*].message.tags[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `message tag "${path.at(-2)}" of channel "${path[1]}"`)
+        }
+      ]
+    },
+    "legacy-zui-title-should-be-removed": {
+      description: "Legacy ZUI title fields (ui.title) SHOULD 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",
+      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",
+      severity: "warn",
+      given: "$.states[*]..schema.properties[*]",
+      then: [
+        {
+          field: "x-zui.title",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `field "${path.at(-3)}" of state "${path[1]}"`)
+        }
+      ]
+    },
+    "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",
+      severity: "error",
+      given: "$.states[*]..schema.properties[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `field "${path.at(-2)}" of state "${path[1]}"`)
+        }
+      ]
+    },
+    "secrets-must-have-a-description": {
+      description: "All secrets MUST have a description",
+      message: "{{description}}: {{error}} MUST have a non-empty description",
+      severity: "error",
+      given: "$.secrets[*]",
+      then: [
+        {
+          field: "description",
+          function: (0, import_spectral_functions2.truthyWithMessage)(({ path }) => `secret "${path[1]}"`)
+        }
+      ]
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  INTEGRATION_RULESET
+});
+//# sourceMappingURL=integration.ruleset.js.map

package/dist/bp-cli/dist/linter/rulesets/integration.ruleset.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/linter/rulesets/integration.ruleset.ts"],
+  "sourcesContent": ["import { type RulesetDefinition } from '@stoplight/spectral-core'\nimport { falsy, truthy } from '@stoplight/spectral-functions'\nimport { truthyWithMessage } from '../spectral-functions'\n\nexport const INTEGRATION_RULESET = {\n  extends: [],\n  rules: {\n    'integration-title-must-be-present': {\n      description: 'The integration MUST have a non-empty title',\n      severity: 'error',\n      given: '$',\n      then: [{ field: 'title', function: truthy }],\n    },\n    'integration-description-must-be-present': {\n      description: 'The integration MUST have a non-empty description',\n      severity: 'error',\n      given: '$',\n      then: [{ field: 'description', function: truthy }],\n    },\n    'integration-must-have-an-icon': {\n      description: 'The integration MUST have an icon',\n      severity: 'error',\n      given: '$',\n      then: [{ field: 'icon', function: truthy }],\n    },\n    'integration-must-have-a-readme-file': {\n      description: 'The integration MUST have a readme file',\n      severity: 'error',\n      given: '$',\n      then: [{ field: 'readme', function: truthy }],\n    },\n    'actions-should-have-a-title': {\n      description: 'All actions SHOULD have a title',\n      message: '{{description}}: {{error}} SHOULD have a non-empty title',\n      severity: 'warn',\n      given: '$.actions[*]',\n      then: [{ field: 'title', function: truthyWithMessage(({ path }) => `action \"${path[1]}\"`) }],\n    },\n    'actions-must-have-a-description': {\n      description: 'All actions MUST have a description',\n      message: '{{description}}: {{error}} MUST have a non-empty description',\n      severity: 'error',\n      given: '$.actions[*]',\n      then: [{ field: 'description', function: truthyWithMessage(({ path }) => `action \"${path[1]}\"`) }],\n    },\n    'action-inputparams-should-have-a-title': {\n      description: 'All action input 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: '$.actions[*].input..schema.properties[*]',\n      then: [\n        {\n          field: 'x-zui.title',\n          function: truthyWithMessage(({ path }) => `input parameter \"${path.at(-3)}\" of action \"${path[1]}\"`),\n        },\n      ],\n    },\n    'action-inputparams-must-have-a-description': {\n      description: 'All action input parameters 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: '$.actions[*].input..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `input parameter \"${path.at(-2)}\" of action \"${path[1]}\"`),\n        },\n      ],\n    },\n    'action-outputparams-should-have-a-title': {\n      description: 'All action 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: '$.actions[*].output..schema.properties[*].x-zui',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `output parameter \"${path.at(-3)}\" of action \"${path[1]}\"`),\n        },\n      ],\n    },\n    'action-outputparams-must-have-a-description': {\n      description: 'All action output parameters 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: '$.actions[*].output..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `output parameter \"${path.at(-2)}\" of action \"${path[1]}\"`),\n        },\n      ],\n    },\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(({ path }) => `output parameter \"${path.at(-3)}\" of event \"${path[1]}\"`),\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(({ path }) => `output parameter \"${path.at(-2)}\" of event \"${path[1]}\"`),\n        },\n      ],\n    },\n    'events-must-have-a-title': {\n      description: 'All events MUST have a title',\n      message: '{{description}}: {{error}} MUST be a non-empty string',\n      severity: 'error',\n      given: '$.events[*]',\n      then: [{ field: 'title', function: truthyWithMessage(({ path }) => `event \"${path[1]}\"`) }],\n    },\n    'events-must-have-a-description': {\n      description: 'All events MUST have a description',\n      message: '{{description}}: {{error}} MUST be a non-empty string',\n      severity: 'error',\n      given: '$.events[*]',\n      then: [{ field: 'description', function: truthyWithMessage(({ path }) => `event \"${path[1]}\"`) }],\n    },\n    'consider-migrating-to-configurations': {\n      description:\n        'Consider migrating to the new multiple configuration format: you MAY move your configuration from \"configuration\" to \"configurations\" and remove the \"configuration\" property',\n      severity: 'off',\n      given: '$',\n      then: [\n        { field: 'configuration', function: falsy },\n        { field: 'configurations', function: truthy },\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(({ path }) => `configuration parameter \"${path.at(-3)}\"`),\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(({ path }) => `configuration parameter \"${path.at(-2)}\"`),\n        },\n      ],\n    },\n    'multiple-configurations-must-have-a-title': {\n      description: 'Multiple configuration definitions MUST have a title',\n      message: '{{description}}: {{error}} MUST have a title',\n      severity: 'error',\n      given: '$.configurations[*]',\n      then: [{ field: 'title', function: truthyWithMessage(({ path }) => `configuration \"${path[1]}\"`) }],\n    },\n    'multiple-configurations-must-have-a-description': {\n      description: 'Multiple configuration definitions MUST have a description',\n      message: '{{description}}: {{error}} MUST have a description',\n      severity: 'error',\n      given: '$.configurations[*]',\n      then: [{ field: 'description', function: truthyWithMessage(({ path }) => `configuration \"${path[1]}\"`) }],\n    },\n    'multipes-configurations-fields-must-have-a-title': {\n      description: 'All configuration fields in multiple configurations 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: '$.configurations[*]..schema.properties[*].x-zui',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(\n            ({ path }) => `configuration field \"${path.at(-3)}\" of configuration \"${path[1]}\"`\n          ),\n        },\n      ],\n    },\n    'multipes-configurations-fields-must-have-a-description': {\n      description: 'All configuration fields in multiple configurations 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: '$.configurations[*]..schema.properties[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(\n            ({ path }) => `configuration field \"${path.at(-2)}\" of configuration \"${path[1]}\"`\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    'channels-should-have-a-title': {\n      description: 'All channels SHOULD have a title',\n      message: '{{description}}: {{error}} SHOULD have a non-empty title',\n      severity: 'warn',\n      given: '$.channels[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `channel \"${path[1]}\"`),\n        },\n      ],\n    },\n    'channels-must-have-a-description': {\n      description: 'All channels MUST have a description',\n      message: '{{description}}: {{error}} MUST have a non-empty description',\n      severity: 'error',\n      given: '$.channels[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `channel \"${path[1]}\"`),\n        },\n      ],\n    },\n    'channels-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: '$.channels[*].conversation.tags[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `conversation tag \"${path.at(-2)}\" of channel \"${path[1]}\"`),\n        },\n      ],\n    },\n    'channels-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: '$.channels[*].conversation.tags[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `conversation tag \"${path.at(-2)}\" of channel \"${path[1]}\"`),\n        },\n      ],\n    },\n    'channels-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: '$.channels[*].message.tags[*]',\n      then: [\n        {\n          field: 'title',\n          function: truthyWithMessage(({ path }) => `message tag \"${path.at(-2)}\" of channel \"${path[1]}\"`),\n        },\n      ],\n    },\n    'channels-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: '$.channels[*].message.tags[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `message tag \"${path.at(-2)}\" of channel \"${path[1]}\"`),\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(({ path }) => `field \"${path.at(-3)}\" of state \"${path[1]}\"`),\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(({ path }) => `field \"${path.at(-2)}\" of state \"${path[1]}\"`),\n        },\n      ],\n    },\n    'secrets-must-have-a-description': {\n      description: 'All secrets MUST have a description',\n      message: '{{description}}: {{error}} MUST have a non-empty description',\n      severity: 'error',\n      given: '$.secrets[*]',\n      then: [\n        {\n          field: 'description',\n          function: truthyWithMessage(({ path }) => `secret \"${path[1]}\"`),\n        },\n      ],\n    },\n  },\n} satisfies RulesetDefinition\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,gCAA8B;AAC9B,IAAAA,6BAAkC;AAE3B,MAAM,sBAAsB;AAAA,EACjC,SAAS,CAAC;AAAA,EACV,OAAO;AAAA,IACL,qCAAqC;AAAA,MACnC,aAAa;AAAA,MACb,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,SAAS,UAAU,iCAAO,CAAC;AAAA,IAC7C;AAAA,IACA,2CAA2C;AAAA,MACzC,aAAa;AAAA,MACb,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,eAAe,UAAU,iCAAO,CAAC;AAAA,IACnD;AAAA,IACA,iCAAiC;AAAA,MAC/B,aAAa;AAAA,MACb,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,QAAQ,UAAU,iCAAO,CAAC;AAAA,IAC5C;AAAA,IACA,uCAAuC;AAAA,MACrC,aAAa;AAAA,MACb,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,UAAU,UAAU,iCAAO,CAAC;AAAA,IAC9C;AAAA,IACA,+BAA+B;AAAA,MAC7B,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,SAAS,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;AAAA,IAC7F;AAAA,IACA,mCAAmC;AAAA,MACjC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,eAAe,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,WAAW,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;AAAA,IACnG;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,CAAC,EAAE,KAAK,MAAM,oBAAoB,KAAK,GAAG,EAAE,CAAC,gBAAgB,KAAK,CAAC,CAAC,GAAG;AAAA,QACrG;AAAA,MACF;AAAA,IACF;AAAA,IACA,8CAA8C;AAAA,MAC5C,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,oBAAoB,KAAK,GAAG,EAAE,CAAC,gBAAgB,KAAK,CAAC,CAAC,GAAG;AAAA,QACrG;AAAA,MACF;AAAA,IACF;AAAA,IACA,2CAA2C;AAAA,MACzC,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,GAAG,EAAE,CAAC,gBAAgB,KAAK,CAAC,CAAC,GAAG;AAAA,QACtG;AAAA,MACF;AAAA,IACF;AAAA,IACA,+CAA+C;AAAA,MAC7C,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,GAAG,EAAE,CAAC,gBAAgB,KAAK,CAAC,CAAC,GAAG;AAAA,QACtG;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,qBAAqB,KAAK,GAAG,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC,GAAG;AAAA,QACrG;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,CAAC,EAAE,KAAK,MAAM,qBAAqB,KAAK,GAAG,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC,GAAG;AAAA,QACrG;AAAA,MACF;AAAA,IACF;AAAA,IACA,4BAA4B;AAAA,MAC1B,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,SAAS,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,UAAU,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;AAAA,IAC5F;AAAA,IACA,kCAAkC;AAAA,MAChC,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,eAAe,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,UAAU,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;AAAA,IAClG;AAAA,IACA,wCAAwC;AAAA,MACtC,aACE;AAAA,MACF,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ,EAAE,OAAO,iBAAiB,UAAU,gCAAM;AAAA,QAC1C,EAAE,OAAO,kBAAkB,UAAU,iCAAO;AAAA,MAC9C;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,CAAC,EAAE,KAAK,MAAM,4BAA4B,KAAK,GAAG,EAAE,CAAC,GAAG;AAAA,QACtF;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,CAAC,EAAE,KAAK,MAAM,4BAA4B,KAAK,GAAG,EAAE,CAAC,GAAG;AAAA,QACtF;AAAA,MACF;AAAA,IACF;AAAA,IACA,6CAA6C;AAAA,MAC3C,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,SAAS,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,kBAAkB,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;AAAA,IACpG;AAAA,IACA,mDAAmD;AAAA,MACjD,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM,CAAC,EAAE,OAAO,eAAe,cAAU,8CAAkB,CAAC,EAAE,KAAK,MAAM,kBAAkB,KAAK,CAAC,CAAC,GAAG,EAAE,CAAC;AAAA,IAC1G;AAAA,IACA,oDAAoD;AAAA,MAClD,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU;AAAA,YACR,CAAC,EAAE,KAAK,MAAM,wBAAwB,KAAK,GAAG,EAAE,CAAC,uBAAuB,KAAK,CAAC,CAAC;AAAA,UACjF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,IACA,0DAA0D;AAAA,MACxD,aAAa;AAAA,MACb,SAAS;AAAA,MACT,UAAU;AAAA,MACV,OAAO;AAAA,MACP,MAAM;AAAA,QACJ;AAAA,UACE,OAAO;AAAA,UACP,cAAU;AAAA,YACR,CAAC,EAAE,KAAK,MAAM,wBAAwB,KAAK,GAAG,EAAE,CAAC,uBAAuB,KAAK,CAAC,CAAC;AAAA,UACjF;AAAA,QACF;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,gCAAgC;AAAA,MAC9B,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,YAAY,KAAK,CAAC,CAAC,GAAG;AAAA,QAClE;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,YAAY,KAAK,CAAC,CAAC,GAAG;AAAA,QAClE;AAAA,MACF;AAAA,IACF;AAAA,IACA,kDAAkD;AAAA,MAChD,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,GAAG,EAAE,CAAC,iBAAiB,KAAK,CAAC,CAAC,GAAG;AAAA,QACvG;AAAA,MACF;AAAA,IACF;AAAA,IACA,sDAAsD;AAAA,MACpD,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,GAAG,EAAE,CAAC,iBAAiB,KAAK,CAAC,CAAC,GAAG;AAAA,QACvG;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,gBAAgB,KAAK,GAAG,EAAE,CAAC,iBAAiB,KAAK,CAAC,CAAC,GAAG;AAAA,QAClG;AAAA,MACF;AAAA,IACF;AAAA,IACA,iDAAiD;AAAA,MAC/C,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,GAAG,EAAE,CAAC,iBAAiB,KAAK,CAAC,CAAC,GAAG;AAAA,QAClG;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,CAAC,EAAE,KAAK,MAAM,UAAU,KAAK,GAAG,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC,GAAG;AAAA,QAC1F;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,CAAC,EAAE,KAAK,MAAM,UAAU,KAAK,GAAG,EAAE,CAAC,eAAe,KAAK,CAAC,CAAC,GAAG;AAAA,QAC1F;AAAA,MACF;AAAA,IACF;AAAA,IACA,mCAAmC;AAAA,MACjC,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,WAAW,KAAK,CAAC,CAAC,GAAG;AAAA,QACjE;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;",
+  "names": ["import_spectral_functions"]
+}

package/dist/bp-cli/dist/linter/rulesets/interface.ruleset.d.ts

@@ -0,0 +1,141 @@
+export declare const INTERFACE_RULESET: {
+    extends: never[];
+    rules: {
+        'action-inputparams-should-have-a-title': {
+            description: string;
+            message: string;
+            severity: "warn";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        'action-inputparams-must-have-a-description': {
+            description: string;
+            message: string;
+            severity: "error";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        'action-outputparams-should-have-a-title': {
+            description: string;
+            message: string;
+            severity: "warn";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        'action-outputparams-must-have-a-description': {
+            description: string;
+            message: string;
+            severity: "error";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        'event-outputparams-should-have-title': {
+            description: string;
+            message: string;
+            severity: "warn";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        'event-outputparams-must-have-description': {
+            description: string;
+            message: string;
+            severity: "error";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        '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>;
+            }[];
+        };
+        'entities-should-have-a-title': {
+            description: string;
+            message: string;
+            severity: "warn";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        'entities-must-have-a-description': {
+            description: string;
+            message: string;
+            severity: "error";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        'entity-fields-should-have-a-title': {
+            description: string;
+            message: string;
+            severity: "warn";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+        'entity-fields-must-have-a-description': {
+            description: string;
+            message: string;
+            severity: "error";
+            given: string;
+            then: {
+                field: string;
+                function: (input: string, _: unknown, context: import("@stoplight/spectral-core").RulesetFunctionContext) => {
+                    message: string;
+                }[];
+            }[];
+        };
+    };
+};