@mintlify/cli 4.0.1425 → 4.0.1426

package/bin/vendor/converter.js

@@ -179,6 +179,8 @@ import { Schema } from "prosemirror-model";
 
 // ../editor/dist/schemas/component-attrs.js
 var DEFAULT_MERMAID_PLACEMENT2 = "bottom-right";
+var ICON_DESCRIPTION = "The icon to display. Options: Font Awesome icon name, Lucide icon name, Tabler icon name, URL to an externally hosted icon, path to an icon file in your project, or SVG code.";
+var ICON_TYPE_DESCRIPTION = "The Font Awesome icon style. Only used with Font Awesome icons. Options: regular, solid, light, thin, sharp-solid, duotone, brands.";
 var BADGE_COLOR_OPTIONS = [
   "gray",
   "blue",
@@ -196,126 +198,320 @@ var BADGE_SHAPE_OPTIONS = ["rounded", "pill"];
 var BADGE_SIZE_OPTIONS = ["xs", "sm", "md", "lg"];
 var CARD_TYPE_OPTIONS = ["info", "warning", "note", "tip", "check", "danger"];
 var STEP_ATTRS = [
-  { name: "icon", type: "expression" },
-  { name: "iconType", type: "string" },
-  { name: "stepNumber", type: "number" },
-  { name: "titleSize", type: "string" },
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
+  { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION },
+  { name: "stepNumber", type: "number", description: "The number of the step." },
+  {
+    name: "titleSize",
+    type: "string",
+    description: "The size of the step titles. One of p, h2, h3, and h4."
+  },
   { name: "isLast", type: "boolean" }
 ];
 var CARD_ATTRS = [
-  { name: "type", type: "string", options: CARD_TYPE_OPTIONS },
-  { name: "color", type: "string" },
-  { name: "icon", type: "expression" },
-  { name: "iconType", type: "string" },
-  { name: "horizontal", type: "boolean" },
-  { name: "href", type: "string" },
-  { name: "img", type: "string" },
-  { name: "cta", type: "string" }
+  {
+    name: "type",
+    type: "string",
+    options: CARD_TYPE_OPTIONS,
+    description: "Apply a callout-style theme to the card. Sets the card's background, border, and default icon to match the selected type."
+  },
+  {
+    name: "color",
+    type: "string",
+    description: "Icon color as a hex code (for example, #FF6B6B)."
+  },
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
+  { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION },
+  {
+    name: "horizontal",
+    type: "boolean",
+    description: "Display the card in a compact horizontal layout."
+  },
+  { name: "href", type: "string", description: "URL to navigate to when the card is clicked." },
+  {
+    name: "img",
+    type: "string",
+    description: "URL or local path to an image displayed at the top of the card."
+  },
+  { name: "cta", type: "string", description: "Custom text for the action button." }
 ];
 var COLUMNS_ATTRS = [
-  { name: "cols", type: "number" }
+  {
+    name: "cols",
+    type: "number",
+    description: "The number of columns per row. Accepts values from 1 to 4."
+  }
 ];
 var ACCORDION_ATTRS = [
-  { name: "description", type: "string" },
-  { name: "defaultOpen", type: "boolean" },
-  { name: "icon", type: "expression" },
-  { name: "iconType", type: "string" }
+  {
+    name: "description",
+    type: "string",
+    description: "Detail below the title in the Accordion preview."
+  },
+  {
+    name: "defaultOpen",
+    type: "boolean",
+    description: "Whether the Accordion is open by default."
+  },
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
+  { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION }
 ];
 var CALLOUT_ATTRS = [
   { name: "type", type: "string" },
-  { name: "icon", type: "expression" },
-  { name: "iconType", type: "string" },
-  { name: "color", type: "string" }
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
+  { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION },
+  {
+    name: "color",
+    type: "string",
+    description: "Custom color as a hex code (for example, #FFC107). Sets the border, background tint, and text color of the callout."
+  }
 ];
 var TAB_ATTRS = [
-  { name: "title", type: "string", required: true },
-  { name: "icon", type: "expression" },
-  { name: "iconType", type: "string" }
+  {
+    name: "title",
+    type: "string",
+    required: true,
+    description: "The title of the tab. Short titles are easier to navigate. Tabs with matching titles synchronize their selections."
+  },
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
+  { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION }
 ];
 var TABS_ATTRS = [
-  { name: "defaultTabIndex", type: "number" }
+  {
+    name: "defaultTabIndex",
+    type: "number",
+    description: "The index of the tab to display by default (zero-based). For example, set to 1 to show the second tab on page load."
+  }
 ];
 var BADGE_ATTRS = [
-  { name: "color", type: "string", default: "gray", options: BADGE_COLOR_OPTIONS },
-  { name: "size", type: "string", default: "md", options: BADGE_SIZE_OPTIONS },
-  { name: "shape", type: "string", default: "rounded", options: BADGE_SHAPE_OPTIONS },
-  { name: "stroke", type: "boolean", default: false },
-  { name: "disabled", type: "boolean", default: false },
-  { name: "icon", type: "expression" },
-  { name: "iconType", type: "string" }
+  {
+    name: "color",
+    type: "string",
+    default: "gray",
+    options: BADGE_COLOR_OPTIONS,
+    description: "Badge color variant."
+  },
+  {
+    name: "size",
+    type: "string",
+    default: "md",
+    options: BADGE_SIZE_OPTIONS,
+    description: "Badge size."
+  },
+  {
+    name: "shape",
+    type: "string",
+    default: "rounded",
+    options: BADGE_SHAPE_OPTIONS,
+    description: "Badge shape."
+  },
+  {
+    name: "stroke",
+    type: "boolean",
+    default: false,
+    description: "Display badge with an outline instead of filled background."
+  },
+  {
+    name: "disabled",
+    type: "boolean",
+    default: false,
+    description: "Display badge in a disabled state with reduced opacity."
+  },
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
+  { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION }
 ];
 var TOOLTIP_ATTRS = [
-  { name: "tip", type: "string", default: "", required: true },
-  { name: "headline", type: "string", default: "" },
-  { name: "cta", type: "string", default: "" },
-  { name: "href", type: "string", default: "" }
+  {
+    name: "tip",
+    type: "string",
+    default: "",
+    required: true,
+    description: "The text displayed in the tooltip."
+  },
+  {
+    name: "headline",
+    type: "string",
+    default: "",
+    description: "Text displayed before the tip text."
+  },
+  {
+    name: "cta",
+    type: "string",
+    default: "",
+    description: "The call-to-action text for a link within the tooltip."
+  },
+  {
+    name: "href",
+    type: "string",
+    default: "",
+    description: "URL for the call-to-action link. Required when using cta."
+  }
 ];
 var FRAME_ATTRS = [
-  { name: "caption", type: "string" }
+  {
+    name: "caption",
+    type: "string",
+    description: "Text that appears as part of the frame, centered below the content. Supports markdown formatting including links and bold text."
+  }
 ];
 var EXPANDABLE_ATTRS = [
-  { name: "title", type: "string", required: true },
-  { name: "defaultOpen", type: "boolean" }
+  {
+    name: "title",
+    type: "string",
+    required: true,
+    description: "The name of the object you are showing."
+  },
+  {
+    name: "defaultOpen",
+    type: "boolean",
+    description: "Set to true for the expandable to open when the page loads."
+  }
 ];
 var VISIBILITY_AUDIENCE_OPTIONS = ["humans", "agents"];
 var VISIBILITY_ATTRS = [
-  { name: "for", type: "string", required: true, options: VISIBILITY_AUDIENCE_OPTIONS }
+  {
+    name: "for",
+    type: "string",
+    required: true,
+    options: VISIBILITY_AUDIENCE_OPTIONS,
+    description: "The audience for the wrapped content: humans (visible on the web, excluded from Markdown output) or agents (hidden on the web, included in Markdown output)."
+  }
 ];
 var UPDATE_ATTRS = [
-  { name: "label", type: "string", required: true },
-  { name: "tags", type: "expression" },
-  { name: "description", type: "string" },
-  { name: "rss", type: "expression" }
+  {
+    name: "label",
+    type: "string",
+    required: true,
+    description: "Label for the update. Appears to the left of the update and creates an anchor link. Labels should be unique."
+  },
+  {
+    name: "tags",
+    type: "expression",
+    description: "Tags for the update. Shown as filters in the right side panel."
+  },
+  {
+    name: "description",
+    type: "string",
+    description: "Description of the update. Appears below the label and tag."
+  },
+  {
+    name: "rss",
+    type: "expression",
+    description: "Creates a single RSS feed entry with a custom title and description."
+  }
 ];
 var ICON_ATTRS = [
   { name: "name", type: "string" },
-  { name: "icon", type: "expression" },
-  { name: "iconType", type: "string" },
-  { name: "color", type: "string" },
-  { name: "size", type: "number" }
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
+  { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION },
+  {
+    name: "color",
+    type: "string",
+    description: "The color of the icon as a hex code (for example, #FF5733)."
+  },
+  { name: "size", type: "number", description: "The size of the icon in pixels." }
 ];
 var CODE_BLOCK_ATTRS = [
-  { name: "language", type: "string" },
-  { name: "filename", type: "string" },
+  {
+    name: "language",
+    type: "string",
+    description: "The programming language for syntax highlighting."
+  },
+  {
+    name: "filename",
+    type: "string",
+    description: "The filename to display in the code block header."
+  },
   { name: "filenameSyntax", type: "string" },
-  { name: "expandable", type: "boolean" },
-  { name: "icon", type: "expression" },
+  { name: "expandable", type: "boolean", description: "Whether to expand the code block." },
+  {
+    name: "icon",
+    type: "expression",
+    description: "The icon to display in the code block header."
+  },
   { name: "lang", type: "string" },
-  { name: "lines", type: "boolean" },
-  { name: "wrap", type: "boolean" },
-  { name: "highlight", type: "expression" },
-  { name: "focus", type: "expression" },
+  { name: "lines", type: "boolean", description: "Whether to show line numbers." },
+  { name: "wrap", type: "boolean", description: "Whether to wrap the code block." },
+  {
+    name: "highlight",
+    type: "expression",
+    description: 'The lines to highlight. Provide a stringified array of numbers. Example: "[1,3,4,5]".'
+  },
+  {
+    name: "focus",
+    type: "expression",
+    description: 'The lines to focus on. Provide a stringified array of numbers. Example: "[1,3,4,5]".'
+  },
   { name: "add", type: "expression" },
   { name: "remove", type: "expression" },
-  { name: "twoslash", type: "boolean" },
+  {
+    name: "twoslash",
+    type: "boolean",
+    description: "Enable interactive type information in JavaScript and TypeScript code blocks. Hover over variables, functions, and parameters to see types and errors like in an IDE."
+  },
   { name: "nocopy", type: "boolean" }
 ];
 var PROMPT_BLOCK_ATTRS = [
-  { name: "icon", type: "expression" },
-  { name: "iconType", type: "string" },
-  { name: "actions", type: "expression", default: ["copy"] }
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
+  { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION },
+  {
+    name: "actions",
+    type: "expression",
+    default: ["copy"],
+    description: 'Array of available actions. Valid values are "copy" (copy to clipboard) and "cursor" (open in Cursor).'
+  }
 ];
 var MERMAID_BLOCK_ATTRS = [
-  { name: "placement", type: "string", default: DEFAULT_MERMAID_PLACEMENT2 },
-  { name: "actions", type: "boolean" }
+  {
+    name: "placement",
+    type: "string",
+    default: DEFAULT_MERMAID_PLACEMENT2,
+    description: "Position of the interactive controls. Options: top-left, top-right, bottom-left, bottom-right."
+  },
+  {
+    name: "actions",
+    type: "boolean",
+    description: "Show or hide the interactive controls. When set, this overrides the default behavior (controls shown when diagram height exceeds 120px)."
+  }
 ];
+var PARAM_LOCATION_DESCRIPTION = "Whether the parameter is a query, path, body, or header. Followed by the parameter name.";
 var PARAM_FIELD_ATTRS = [
-  { name: "query", type: "string" },
-  { name: "path", type: "string" },
-  { name: "body", type: "string" },
-  { name: "header", type: "string" },
-  { name: "default", type: "string" },
-  { name: "type", type: "string" },
-  { name: "required", type: "boolean" },
-  { name: "deprecated", type: "boolean" },
-  { name: "placeholder", type: "string" }
+  { name: "query", type: "string", description: PARAM_LOCATION_DESCRIPTION },
+  { name: "path", type: "string", description: PARAM_LOCATION_DESCRIPTION },
+  { name: "body", type: "string", description: PARAM_LOCATION_DESCRIPTION },
+  { name: "header", type: "string", description: PARAM_LOCATION_DESCRIPTION },
+  {
+    name: "default",
+    type: "string",
+    description: "Default value populated when the request value is empty."
+  },
+  {
+    name: "type",
+    type: "string",
+    description: "Expected type of the parameter's value. Supports number, string, boolean, object. Define arrays using the [] suffix. For example string[]."
+  },
+  { name: "required", type: "boolean", description: "Indicate whether you require the parameter." },
+  {
+    name: "deprecated",
+    type: "boolean",
+    description: "Indicate whether you have deprecated the parameter."
+  },
+  {
+    name: "placeholder",
+    type: "string",
+    description: "Placeholder text for the input in the playground."
+  }
 ];
 var RESPONSE_FIELD_ATTRS = [
-  { name: "name", type: "string", required: true },
-  { name: "type", type: "string" },
-  { name: "default", type: "string" },
-  { name: "required", type: "boolean" },
-  { name: "deprecated", type: "boolean" }
+  { name: "name", type: "string", required: true, description: "The name of the response value." },
+  {
+    name: "type",
+    type: "string",
+    description: "Expected type of the response value. This can be any arbitrary string."
+  },
+  { name: "default", type: "string", description: "The default value." },
+  { name: "required", type: "boolean", description: "Indicate whether you require the response." },
+  { name: "deprecated", type: "boolean", description: "Whether you have deprecated a field." }
 ];
 
 // ../editor/dist/schemas/utils.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1425",
+  "version": "4.0.1426",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -82,7 +82,7 @@
     "keytar": "7.9.0"
   },
   "devDependencies": {
-    "@mintlify/editor": "0.0.319",
+    "@mintlify/editor": "0.0.320",
     "@mintlify/ts-config": "2.0.2",
     "@tsconfig/recommended": "1.0.2",
     "@types/detect-port": "1.3.2",
@@ -101,5 +101,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "fa20775643b3d5ea378e246611f0adb728d2b0c2"
+  "gitHead": "493248997c157b876149cda72cd1b58b8d2aabb9"
 }