@mintlify/cli 4.0.1511 → 4.0.1512

package/bin/vendor/converter.js

@@ -173,8 +173,10 @@ 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 ICON_DESCRIPTION = "Font Awesome, Lucide or Tabler icon name, URL, path to an icon file, or SVG code.";
+var ICON_TYPE_DESCRIPTION = "Font Awesome icon style. Ignored for other icon libraries.";
+var HEX_COLOR_PLACEHOLDER = "#FF6B6B";
+var URL_PLACEHOLDER = "https://example.com/page";
 var BADGE_COLOR_OPTIONS = [
   "gray",
   "blue",
@@ -194,12 +196,8 @@ var CARD_TYPE_OPTIONS = ["info", "warning", "note", "tip", "check", "danger"];
 var STEP_ATTRS = [
   { 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: "stepNumber", type: "number", placeholder: "1" },
+  { name: "titleSize", type: "string" },
   { name: "isLast", type: "boolean" }
 ];
 var CARD_ATTRS = [
@@ -207,46 +205,32 @@ var CARD_ATTRS = [
     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."
+    description: "Callout-style theme for the background, border and default icon."
   },
   {
     name: "color",
     type: "string",
-    description: "Icon color as a hex code (for example, #FF6B6B)."
+    placeholder: HEX_COLOR_PLACEHOLDER,
+    description: "Color of the card icon."
   },
   { 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: "horizontal", type: "boolean", description: "Compact horizontal layout." },
+  { name: "href", type: "string", placeholder: URL_PLACEHOLDER },
   {
     name: "img",
     type: "string",
-    description: "URL or local path to an image displayed at the top of the card."
+    placeholder: "/images/hero.png",
+    description: "Shown at the top of the card."
   },
-  { name: "cta", type: "string", description: "Custom text for the action button." }
+  { name: "cta", type: "string", placeholder: "Learn more" }
 ];
 var COLUMNS_ATTRS = [
-  {
-    name: "cols",
-    type: "number",
-    description: "The number of columns per row. Accepts values from 1 to 4."
-  }
+  { name: "cols", type: "number" }
 ];
 var ACCORDION_ATTRS = [
-  {
-    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: "description", type: "string", placeholder: "Shown below the title" },
+  { name: "defaultOpen", type: "boolean" },
   { name: "icon", type: "expression", description: ICON_DESCRIPTION },
   { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION }
 ];
@@ -257,7 +241,8 @@ var CALLOUT_ATTRS = [
   {
     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."
+    placeholder: "#FFC107",
+    description: "Border, background tint and text color."
   }
 ];
 var TAB_ATTRS = [
@@ -265,7 +250,8 @@ var TAB_ATTRS = [
     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."
+    placeholder: "macOS",
+    description: "Tabs with matching titles sync their selection."
   },
   { name: "icon", type: "expression", description: ICON_DESCRIPTION },
   { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION }
@@ -274,43 +260,21 @@ var TABS_ATTRS = [
   {
     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."
+    placeholder: "0",
+    description: "Zero-based index of the tab shown on page load."
   }
 ];
 var BADGE_ATTRS = [
-  {
-    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: "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,
-    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."
+    description: "Outline instead of a filled background."
   },
+  { name: "disabled", type: "boolean", default: false },
   { name: "icon", type: "expression", description: ICON_DESCRIPTION },
   { name: "iconType", type: "string", description: ICON_TYPE_DESCRIPTION }
 ];
@@ -320,46 +284,35 @@ var TOOLTIP_ATTRS = [
     type: "string",
     default: "",
     required: true,
-    description: "The text displayed in the tooltip."
+    placeholder: "Application Programming Interface"
   },
   {
     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."
+    placeholder: "Did you know?",
+    description: "Shown above the tip text."
   },
+  { name: "cta", type: "string", default: "", placeholder: "Learn more" },
   {
     name: "href",
     type: "string",
     default: "",
-    description: "URL for the call-to-action link. Required when using cta."
+    placeholder: URL_PLACEHOLDER,
+    description: "Required when a call to action is set."
   }
 ];
 var FRAME_ATTRS = [
   {
     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."
+    placeholder: "Figure 1: request flow",
+    description: "Centered below the content. Supports Markdown."
   }
 ];
 var EXPANDABLE_ATTRS = [
-  {
-    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."
-  }
+  { name: "title", type: "string", required: true, placeholder: "user" },
+  { name: "defaultOpen", type: "boolean" }
 ];
 var VISIBILITY_AUDIENCE_OPTIONS = ["humans", "agents"];
 var VISIBILITY_ATTRS = [
@@ -368,7 +321,7 @@ var VISIBILITY_ATTRS = [
     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)."
+    description: "Humans: visible on the web, excluded from Markdown output. Agents: hidden on the web, included in Markdown output."
   }
 ];
 var UPDATE_ATTRS = [
@@ -376,18 +329,16 @@ var UPDATE_ATTRS = [
     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."
+    placeholder: "v1.2.0",
+    description: "Shown next to the update and used as its anchor link. Keep labels 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."
+    placeholder: '["feature", "fix"]',
+    description: "Shown as filters in the side panel."
   },
+  { name: "description", type: "string", placeholder: "Short summary of the update" },
   {
     name: "rss",
     type: "expression",
@@ -398,50 +349,36 @@ var ICON_ATTRS = [
   { name: "name", type: "string" },
   { 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." }
+  { name: "color", type: "string", placeholder: HEX_COLOR_PLACEHOLDER },
+  { name: "size", type: "number", placeholder: "16", description: "In pixels." }
 ];
 var CODE_BLOCK_ATTRS = [
-  {
-    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: "language", type: "string", placeholder: "typescript" },
+  { name: "filename", type: "string", placeholder: "index.ts" },
   { name: "filenameSyntax", type: "string" },
-  { 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: "expandable", type: "boolean" },
+  { name: "icon", type: "expression", description: ICON_DESCRIPTION },
   { name: "lang", type: "string" },
-  { name: "lines", type: "boolean", description: "Whether to show line numbers." },
-  { name: "wrap", type: "boolean", description: "Whether to wrap the code block." },
+  { name: "lines", type: "boolean", description: "Show line numbers." },
+  { name: "wrap", type: "boolean", description: "Wrap long lines." },
   {
     name: "highlight",
     type: "expression",
-    description: 'The lines to highlight. Provide a stringified array of numbers. Example: "[1,3,4,5]".'
+    placeholder: "[1, 3, 4]",
+    description: "Line numbers to highlight."
   },
   {
     name: "focus",
     type: "expression",
-    description: 'The lines to focus on. Provide a stringified array of numbers. Example: "[1,3,4,5]".'
+    placeholder: "[1, 3, 4]",
+    description: "Line numbers to focus on."
   },
   { name: "add", type: "expression" },
   { name: "remove", type: "expression" },
   {
     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."
+    description: "Interactive type information for JavaScript and TypeScript."
   },
   { name: "nocopy", type: "boolean" }
 ];
@@ -452,7 +389,8 @@ var PROMPT_BLOCK_ATTRS = [
     name: "actions",
     type: "expression",
     default: ["copy"],
-    description: 'Array of available actions. Valid values are "copy" (copy to clipboard) and "cursor" (open in Cursor).'
+    placeholder: '["copy", "cursor"]',
+    description: "Available actions: copy (clipboard) and cursor (open in Cursor)."
   }
 ];
 var MERMAID_BLOCK_ATTRS = [
@@ -460,52 +398,47 @@ var MERMAID_BLOCK_ATTRS = [
     name: "placement",
     type: "string",
     default: DEFAULT_MERMAID_PLACEMENT2,
-    description: "Position of the interactive controls. Options: top-left, top-right, bottom-left, bottom-right."
+    placeholder: DEFAULT_MERMAID_PLACEMENT2,
+    description: "Position of the controls: top-left, top-right, bottom-left or 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)."
+    description: "Force the controls on or off. By default they appear when the diagram is taller than 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", 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: "query", type: "string", placeholder: "limit" },
+  { name: "path", type: "string", placeholder: "userId" },
+  { name: "body", type: "string", placeholder: "email" },
+  { name: "header", type: "string", placeholder: "Authorization" },
   {
     name: "default",
     type: "string",
-    description: "Default value populated when the request value is empty."
+    placeholder: "10",
+    description: "Used 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."
+    placeholder: "string",
+    description: "number, string, boolean or object. Arrays use the [] suffix, for example string[]."
   },
+  { name: "required", type: "boolean" },
+  { name: "deprecated", type: "boolean" },
   {
     name: "placeholder",
     type: "string",
-    description: "Placeholder text for the input in the playground."
+    placeholder: "sk_live_...",
+    description: "Shown in the API playground input."
   }
 ];
 var RESPONSE_FIELD_ATTRS = [
-  { 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." }
+  { name: "name", type: "string", required: true, placeholder: "id" },
+  { name: "type", type: "string", placeholder: "string" },
+  { name: "default", type: "string", placeholder: "null" },
+  { name: "required", type: "boolean" },
+  { name: "deprecated", type: "boolean" }
 ];
 
 // ../editor/dist/schemas/utils.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/cli",
-  "version": "4.0.1511",
+  "version": "4.0.1512",
   "description": "The Mintlify CLI",
   "engines": {
     "node": ">=18.0.0"
@@ -86,7 +86,7 @@
     "keytar": "7.9.0"
   },
   "devDependencies": {
-    "@mintlify/editor": "0.0.395",
+    "@mintlify/editor": "0.0.396",
     "@mintlify/ts-config": "2.0.2",
     "@tsconfig/recommended": "1.0.2",
     "@types/detect-port": "1.3.2",
@@ -105,5 +105,5 @@
     "vitest": "2.1.9",
     "vitest-mock-process": "1.0.4"
   },
-  "gitHead": "992dfe00b7789227fed0ec5c4d23e317074ddff5"
+  "gitHead": "530e1c462ce7a1fcc61331c4d688fb05c6266f72"
 }