@mintlify/models - npm Package Compare versions

Comparing version 0.0.300 to 0.0.301

dist/types/cliScoreResponse.d.ts

+/**
+ * Shared contract for the Mintlify CLI `mint score` command.
+ *
+ * The server owns this shape — it is the source of truth for field names, nesting,
+ * and semantics. The CLI consumes the contract read-only. Any change here must be
+ * published as a new `@mintlify/models` version and rolled out to BOTH:
+ *   - `server`      (handler: `agentReadinessScore.controller.ts` → `getCliSiteScore`)
+ *   - `mint/cli`    (consumer: `packages/cli/src/score/`)
+ *
+ * Keep this in sync with the afdocs check/score types the server already uses
+ * (`CheckStatus`, `Grade`) rather than inventing CLI-only semantics.
+ */
+export type CliCheckStatus = 'pass' | 'warn' | 'fail' | 'skip' | 'error';
+export type CliGrade = 'A+' | 'A' | 'B' | 'C' | 'D' | 'F';
+export type CliScoreCheck = {
+    id: string;
+    name: string;
+    status: CliCheckStatus;
+    message?: string;
+    category?: string;
+    children?: CliScoreCheck[];
+};
+export type CliScoreResponseStatus = 'ready' | 'stale_refresh_queued';
+export type CliScoreResponse = {
+    canonicalUrl: string;
+    slug: string;
+    displayDomain: string;
+    displayName: string;
+    computedAt: string;
+    overallScore: number;
+    overallGrade: CliGrade;
+    passedChecks: number;
+    totalChecks: number;
+    checks: CliScoreCheck[];
+    status: CliScoreResponseStatus;
+};
+export type CliScorePendingResponse = {
+    canonicalUrl: string;
+    slug: string;
+    displayDomain: string;
+    displayName: string;
+    jobId?: string;
+    status: 'queued';
+};
+export type CliScoreResolveStatus = 'ready' | 'stale_refresh_queued' | 'queued';
+export type CliScoreResolveResponse = {
+    canonicalUrl: string;
+    slug: string;
+    status: CliScoreResolveStatus;
+    trackedSiteId: string;
+};

dist/types/cliScoreResponse.js

+/**
+ * Shared contract for the Mintlify CLI `mint score` command.
+ *
+ * The server owns this shape — it is the source of truth for field names, nesting,
+ * and semantics. The CLI consumes the contract read-only. Any change here must be
+ * published as a new `@mintlify/models` version and rolled out to BOTH:
+ *   - `server`      (handler: `agentReadinessScore.controller.ts` → `getCliSiteScore`)
+ *   - `mint/cli`    (consumer: `packages/cli/src/score/`)
+ *
+ * Keep this in sync with the afdocs check/score types the server already uses
+ * (`CheckStatus`, `Grade`) rather than inventing CLI-only semantics.
+ */
+export {};

dist/types/index.d.ts

@@ -8,2 +8,3 @@ import { ApiPlaygroundDisplayType, apiPlaygroundDisplayTypes, ResolvedApiPlaygroundDisplayType } from './apiPlaygroundDisplayType.js';
 import { IMAGE_EXTENSION_MIME_MAP, DOCUMENT_EXTENSION_MIME_MAP, CODE_EXTENSION_MIME_MAP, AttachmentFileKind, SUPPORTED_ATTACHMENT_MIME_TYPES, SupportedAttachmentMimeType, SUPPORTED_ATTACHMENT_EXTENSIONS, SupportedAttachmentExtension, MAX_ATTACHMENT_SIZE_BYTES, MAX_ATTACHMENTS_PER_MESSAGE } from './chat-attachment.js';
+import { CliCheckStatus, CliGrade, CliScoreCheck, CliScorePendingResponse, CliScoreResolveResponse, CliScoreResolveStatus, CliScoreResponse, CliScoreResponseStatus } from './cliScoreResponse.js';
 import { ConfigType, configTypes } from './configType.js';
@@ -33,3 +34,3 @@ import { CreditTierId, CreditTierIds, CreditTierConfig, CREDIT_TIERS, CREDIT_TIER_OVERAGE_PRICE_PER_CREDIT } from './creditTier.js';
 import { UserMetadata, UserWithMetadata } from './userMetadata.js';
-export type { ApiPlaygroundResponseType, ApiPlaygroundResultType, ApiPlaygroundDisplayType, ResolvedApiPlaygroundDisplayType, TierId, TierConfig, CreditTierId, CreditTierConfig, EditContext, GitBranchesResponse, GithubInstallationType, GitlabInstallationType, DiscordInstallationType, GrowthDataType, InkeepType, OpenApiFile, OpenApiMetadata, PageMetaTags, UsageType, UserMetadata, UserWithMetadata, PrimaryChart, PopularPages, Referrals, Feedback, DashboardAnalytics, TotalMetric, ConfigType, EntitlementConfiguration, ExportPdfHistory, ExportFormat, ExportOptions, QueueUpdateStatus, SlackInstallationType, StarterQuestionType, Translation, CodeSnippetFeedbackSubmission, ContextualFeedbackSubmission, ThumbsOnlyFeedbackSubmission, AgentFeedbackSubmission, CodeSnippetFeedback, ContextualFeedback, ThumbsOnlyFeedback, AgentFeedback, UserFeedback, UserFeedbackData, FeedbackSource, FeedbackState, PageType, SupportedAttachmentMimeType, SupportedAttachmentExtension, AttachmentFileKind, Role, OrgResource, UserResource, DeploymentResource, Resource, Action, Permission, TemplateSource, OnboardingTemplateId, };
+export type { ApiPlaygroundResponseType, ApiPlaygroundResultType, ApiPlaygroundDisplayType, ResolvedApiPlaygroundDisplayType, TierId, TierConfig, CreditTierId, CreditTierConfig, EditContext, GitBranchesResponse, GithubInstallationType, GitlabInstallationType, DiscordInstallationType, GrowthDataType, InkeepType, OpenApiFile, OpenApiMetadata, PageMetaTags, UsageType, UserMetadata, UserWithMetadata, PrimaryChart, PopularPages, Referrals, Feedback, DashboardAnalytics, TotalMetric, ConfigType, CliCheckStatus, CliGrade, CliScoreCheck, CliScorePendingResponse, CliScoreResolveResponse, CliScoreResolveStatus, CliScoreResponse, CliScoreResponseStatus, EntitlementConfiguration, ExportPdfHistory, ExportFormat, ExportOptions, QueueUpdateStatus, SlackInstallationType, StarterQuestionType, Translation, CodeSnippetFeedbackSubmission, ContextualFeedbackSubmission, ThumbsOnlyFeedbackSubmission, AgentFeedbackSubmission, CodeSnippetFeedback, ContextualFeedback, ThumbsOnlyFeedback, AgentFeedback, UserFeedback, UserFeedbackData, FeedbackSource, FeedbackState, PageType, SupportedAttachmentMimeType, SupportedAttachmentExtension, AttachmentFileKind, Role, OrgResource, UserResource, DeploymentResource, Resource, Action, Permission, TemplateSource, OnboardingTemplateId, };
 export { apiPlaygroundDisplayTypes, configTypes, queueUpdateStatuses, exportFormats, feedbackSources, feedbackStates, roles, roleIsMintlifyRole, ACTIONS, ORG_RESOURCES, USER_RESOURCES, DEPLOYMENT_RESOURCES, ALL_RESOURCES, ALL_PERMISSIONS, ROLE_PERMISSIONS, validResourceSet, validActionSet, validPermissionSet, isValidPermission, NATIVE_METADATA_TAG_KEYS_SET, TierIds, ASSISTANT_TIERS, ASSISTANT_TIER_OVERAGE_PRICE_PER_CREDIT, CreditTierIds, CREDIT_TIERS, CREDIT_TIER_OVERAGE_PRICE_PER_CREDIT, IMAGE_EXTENSION_MIME_MAP, DOCUMENT_EXTENSION_MIME_MAP, CODE_EXTENSION_MIME_MAP, SUPPORTED_ATTACHMENT_MIME_TYPES, SUPPORTED_ATTACHMENT_EXTENSIONS, MAX_ATTACHMENT_SIZE_BYTES, MAX_ATTACHMENTS_PER_MESSAGE, defaultOnboardingTemplateIdIfOmitted, getOnboardingTemplateById, isOnboardingTemplateIdString, ONBOARDING_TEMPLATES, DEFAULT_ONBOARDING_TEMPLATE_ID, };

package.json

 {
   "name": "@mintlify/models",
-  "version": "0.0.300",
+  "version": "0.0.301",
   "description": "Mintlify models",
@@ -62,3 +62,3 @@ "engines": {
   },
-  "gitHead": "3e8d555db4676611ad81b7de15e7a93d33b98902"
+  "gitHead": "a80a1002ca8c971f0dbdbe2ff5090e27193708d8"
 }

No alert changes

Improved metrics

Total package byte prevSize

225646

1.31%

Number of package files

164

1.23%

Lines of code

2449

2.73%

No dependency changes