@mintlify/validation 0.1.38 → 0.1.40

package/dist/schemas/favicon.d.ts

@@ -0,0 +1,2 @@
+import { z } from "zod";
+export declare const faviconSchema: z.ZodEffects<z.ZodString, string, string>;

package/dist/schemas/name.d.ts

@@ -0,0 +1,2 @@
+import { z } from "zod";
+export declare const nameSchema: z.ZodString;

package/dist/schemas/navigation.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+import { NavigationType } from '../types/navigation';
+export declare const navigationConfigSchema: z.ZodArray<z.ZodType<NavigationType, z.ZodTypeDef, NavigationType>, "many">;

package/dist/schemas/tabs.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const tabsSchema: z.ZodArray<z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    url: string;
+}, {
+    name: string;
+    url: string;
+}>, "many">;

package/dist/schemas/versions.d.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+export declare const versionsSchema: z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodObject<{
+    name: z.ZodString;
+    url: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    name: string;
+    url: string;
+}, {
+    name: string;
+    url: string;
+}>]>, "many">;

package/dist/types/analytics.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { analyticsSchema } from "../schemas/analytics";
+export type AnalyticsType = z.infer<typeof analyticsSchema>;

package/dist/types/anchors.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { anchorsSchema } from "../schemas/anchors";
+export type AnchorsType = z.infer<typeof anchorsSchema>;

package/dist/types/colors.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { colorsSchema } from "../schemas/colors";
+export type ColorsType = z.infer<typeof colorsSchema>;

package/dist/types/config.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { configSchema } from "../schemas/config";
+export type ConfigType = z.infer<typeof configSchema>;

package/dist/types/endpoint.d.ts

@@ -0,0 +1,125 @@
+export type Endpoint = {
+    description?: string;
+    path: string;
+    method: HttpMethod;
+    servers?: Server[];
+    request: RequestSchema;
+    response: ResponseSchema;
+    deprecated: boolean;
+};
+export type Server = {
+    url: string;
+    description?: string;
+    variables?: {
+        [variableName: string]: ServerVariableSchema;
+    };
+};
+export type ServerVariableSchema = ServerVariableStringSchema | ServerVariableStringEnumSchema;
+export type ServerVariableStringSchema = {
+    type: 'string';
+    default: string;
+    description?: string;
+};
+export type ServerVariableStringEnumSchema = {
+    type: 'stringEnum';
+    enum: string[];
+    default: string;
+    description?: string;
+};
+export type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace";
+export type RequestSchema = {
+    security: SecurityOption[];
+    parameters: ParameterSections;
+    body: BodySchema;
+};
+export type SecurityOption = NonPathParameterSections & {
+    title: string;
+};
+export type BodySchema = {
+    [contentType: string]: DataSchemaArray;
+};
+export type ParameterSchema = {
+    required: boolean;
+    description?: string;
+    deprecated: boolean;
+    schema: DataSchemaArray | 'basic' | 'bearer';
+};
+export type PathParameterSchema = ParameterSchema & {
+    required: true;
+};
+export type ParameterGroup = {
+    [name: string]: ParameterSchema;
+};
+export type PathParameterGroup = {
+    [name: string]: PathParameterSchema;
+};
+type NonPathParameterLocations = 'query' | 'header' | 'cookie';
+type PathParameterLocations = 'path';
+export type ParameterLocations = NonPathParameterLocations | PathParameterLocations;
+type NonPathParameterSections = Record<NonPathParameterLocations, ParameterGroup>;
+type PathParameterSections = Record<PathParameterLocations, PathParameterGroup>;
+export type ParameterSections = NonPathParameterSections & PathParameterSections;
+export type ResponseSchema = {
+    [code: string]: BodySchema;
+};
+export type DataSchemaArray = [DataSchema, ...DataSchema[]];
+export declare const typeList: readonly ["boolean", "string", "number", "integer", "object", "array", "stringEnum", "numberEnum", "integerEnum", "null"];
+export type SchemaType = typeof typeList[number];
+export type DataSchema = BooleanSchema | StringSchema | NumberSchema | ObjectSchema | ArraySchema | StringEnumSchema | NumberEnumSchema | NullSchema;
+export type BaseSchema<T> = {
+    type: SchemaType;
+    title?: string;
+    description?: string;
+    default?: T;
+    example?: T;
+    required?: boolean;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    deprecated?: boolean;
+};
+export type BooleanSchema = {
+    type: 'boolean';
+} & BaseSchema<boolean>;
+export type StringSchema = {
+    type: 'string';
+    format?: string;
+    pattern?: string;
+    maxLength?: number;
+    minLength?: number;
+} & BaseSchema<string>;
+export type NumberSchema = {
+    type: 'number' | 'integer';
+    multipleOf?: number;
+    maximum?: number;
+    exclusiveMaximum?: boolean;
+    minimum?: number;
+    exclusiveMinimum?: boolean;
+} & BaseSchema<number>;
+export type ObjectSchema = {
+    type: 'object';
+    additionalProperties?: boolean | DataSchemaArray;
+    maxProperties?: number;
+    minProperties?: number;
+    properties: {
+        [key: string]: DataSchemaArray;
+    };
+} & BaseSchema<object>;
+export type ArraySchema = {
+    type: 'array';
+    items: DataSchemaArray;
+    maxItems?: number;
+    minItems?: number;
+    uniqueItems?: boolean;
+} & BaseSchema<unknown[]>;
+export type StringEnumSchema = {
+    type: 'stringEnum';
+    enum: string[];
+} & BaseSchema<string>;
+export type NumberEnumSchema = {
+    type: 'numberEnum' | 'integerEnum';
+    enum: number[];
+} & BaseSchema<number>;
+export type NullSchema = {
+    type: 'null';
+} & BaseSchema<null>;
+export {};

package/dist/types/navigation.d.ts

@@ -0,0 +1,6 @@
+export type NavigationEntry = string | NavigationType;
+export type NavigationType = {
+    group: string;
+    pages: NavigationEntry[];
+    version?: string;
+};

package/dist/types/versions.d.ts

@@ -0,0 +1,3 @@
+import { z } from "zod";
+import { versionsSchema } from "../schemas/versions";
+export type VersionsType = z.infer<typeof versionsSchema>;

package/dist/utils/common.d.ts

@@ -0,0 +1,6 @@
+export declare class MintValidationResults {
+    status: "error" | "success";
+    errors: string[];
+    warnings: string[];
+    constructor();
+}

package/dist/utils/convertOpenApi.d.ts

@@ -0,0 +1,43 @@
+import { OpenAPIV3_1 } from 'openapi-types';
+import type { BodySchema, DataSchemaArray, Endpoint, HttpMethod, ParameterSections, ResponseSchema, SecurityOption, Server } from '../types/endpoint';
+export declare class InvalidSchemaError extends Error {
+    constructor(message?: string);
+}
+export declare class ImpossibleSchemaError extends Error {
+    constructor(message?: string);
+}
+export declare class ConversionError extends Error {
+    constructor(message?: string);
+}
+type ConvertServersParams = OpenAPIV3_1.ServerObject[] | undefined;
+type ConvertServersType = Server[] | undefined;
+export declare const convertServers: (servers: ConvertServersParams) => ConvertServersType;
+type ConvertParametersParams = {
+    pathParameters?: OpenAPIV3_1.ParameterObject[];
+    operationParameters?: OpenAPIV3_1.ParameterObject[];
+};
+export declare const convertParameters: ({ pathParameters, operationParameters, }: ConvertParametersParams) => ParameterSections;
+export declare const convertSchema: (schema?: OpenAPIV3_1.SchemaObject, required?: boolean) => DataSchemaArray;
+export declare const combineTopLevelSchemas: (schema1: OpenAPIV3_1.SchemaObject, schema2: OpenAPIV3_1.SchemaObject) => OpenAPIV3_1.SchemaObject;
+export declare const convertProperties: (properties?: {
+    [key: string]: OpenAPIV3_1.SchemaObject;
+} | undefined, required?: string[]) => {
+    [key: string]: DataSchemaArray;
+};
+type ConvertSecurityParams = {
+    securityRequirements?: OpenAPIV3_1.SecurityRequirementObject[];
+    securitySchemes: OpenAPIV3_1.ComponentsObject['securitySchemes'];
+};
+export declare const convertSecurity: ({ securityRequirements, securitySchemes, }: ConvertSecurityParams) => SecurityOption[];
+type AddSecurityParametersParams = {
+    securityScheme: OpenAPIV3_1.SecuritySchemeObject;
+    parameterSections: SecurityOption;
+};
+export declare const addSecurityParameters: ({ securityScheme, parameterSections, }: AddSecurityParametersParams) => void;
+export declare const convertBody: (body?: OpenAPIV3_1.RequestBodyObject) => BodySchema;
+export declare const convertResponses: (responses: OpenAPIV3_1.ResponsesObject) => ResponseSchema;
+export declare const convertResponse: (response: OpenAPIV3_1.ResponseObject) => {
+    [contentType: string]: DataSchemaArray;
+};
+export declare const convertOpenAPIV3_1ToEndpoint: (spec: OpenAPIV3_1.Document, path: string, method: HttpMethod) => Endpoint | undefined;
+export {};

package/dist/utils/flattenUnionErrorMessages.d.ts

@@ -0,0 +1,7 @@
+type UnionError = {
+    message: string;
+    code?: string;
+    unionErrors?: UnionError[];
+};
+export declare function flattenUnionErrorMessages(unionErrors: UnionError[]): string[];
+export {};

package/dist/utils/hexadecimalPattern.d.ts

@@ -0,0 +1 @@
+export declare const hexadecimalPattern: RegExp;

package/dist/utils/validateAnchorsWarnings.d.ts

@@ -0,0 +1,4 @@
+import { NavigationType } from "../types/navigation";
+import { AnchorsType } from "../types/anchors";
+import { MintValidationResults } from "./common";
+export declare function validateAnchorsWarnings(anchors: AnchorsType | undefined, navigation: NavigationType[] | undefined): MintValidationResults;

package/dist/utils/validateVersionsInNavigation.d.ts

@@ -0,0 +1,5 @@
+import { NavigationEntry, NavigationType } from "../types/navigation";
+import { VersionsType } from "../types/versions";
+import { MintValidationResults } from "./common";
+export declare function flattenNavigationVersions(nav: NavigationEntry[], versions?: string[]): string[];
+export declare function validateVersionsInNavigation(navigation: NavigationType[] | undefined, versions?: VersionsType | undefined): MintValidationResults;

package/package.json

@@ -1,72 +1,74 @@
-{
-  "name": "@mintlify/validation",
-  "version": "0.1.38",
-  "description": "Validates mint.json files",
-  "author": "Mintlify, Inc.",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/mintlify/mint",
-    "directory": "packages/mintlify-validation"
-  },
-  "bugs": {
-    "url": "https://github.com/mintlify/mint/issues"
-  },
-  "license": "Elastic-2.0",
-  "keywords": [
-    "mintlify",
-    "mint",
-    "validation"
-  ],
-  "type": "commonjs",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "jest": {
-    "verbose": true,
-    "moduleNameMapper": {
-      "@/utils/(.*)": "<rootDir>/src/utils/$1",
-      "@/schemas/(.*)": "<rootDir>/src/schemas/$1",
-      "@/types/(.*)": "<rootDir>/src/types/$1"
-    }
-  },
-  "scripts": {
-    "prepare": "npm run build",
-    "build": "webpack",
-    "test": "jest",
-    "lint": "eslint . --cache"
-  },
-  "dependencies": {
-    "mathjs": "^11.8.0",
-    "zod": "^3.20.6",
-    "zod-to-json-schema": "^3.20.3"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.20.2",
-    "@babel/preset-env": "^7.20.2",
-    "@babel/preset-typescript": "^7.18.6",
-    "@mintlify/eslint-config": "1.0.3",
-    "@mintlify/eslint-config-typescript": "1.0.7",
-    "@mintlify/ts-config": "1.0.7",
-    "@tsconfig/recommended": "1.x",
-    "@typescript-eslint/eslint-plugin": "5.x",
-    "@typescript-eslint/parser": "5.x",
-    "babel-jest": "^29.3.1",
-    "eslint": "8.x",
-    "eslint-config-prettier": "8.x",
-    "eslint-plugin-unused-imports": "2.x",
-    "jest": "^29.3.1",
-    "openapi-types": "^12.1.0",
-    "prettier": "2.x",
-    "ts-loader": "^9.4.2",
-    "typescript": "^4.8.2",
-    "webpack": "^5.75.0",
-    "webpack-cli": "^5.0.1"
-  },
-  "gitHead": "a6779f44676fa95f77a88610f0b15070791eff68"
-}
+{
+  "name": "@mintlify/validation",
+  "version": "0.1.40",
+  "description": "Validates mint.json files",
+  "author": "Mintlify, Inc.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mintlify/mint",
+    "directory": "packages/mintlify-validation"
+  },
+  "bugs": {
+    "url": "https://github.com/mintlify/mint/issues"
+  },
+  "license": "Elastic-2.0",
+  "keywords": [
+    "mintlify",
+    "mint",
+    "validation"
+  ],
+  "type": "commonjs",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "jest": {
+    "verbose": true,
+    "moduleNameMapper": {
+      "@/utils/(.*)": "<rootDir>/src/utils/$1",
+      "@/schemas/(.*)": "<rootDir>/src/schemas/$1",
+      "@/types/(.*)": "<rootDir>/src/types/$1"
+    }
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "webpack",
+    "test": "jest",
+    "lint": "eslint . --cache",
+    "format": "prettier \"./src/**/*.ts\" --write",
+    "format:check": "prettier \"./src/**/*.ts\" --check"
+  },
+  "dependencies": {
+    "mathjs": "^11.8.0",
+    "zod": "^3.20.6",
+    "zod-to-json-schema": "^3.20.3"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.2",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-typescript": "^7.18.6",
+    "@mintlify/eslint-config": "1.0.3",
+    "@mintlify/eslint-config-typescript": "1.0.7",
+    "@mintlify/prettier-config": "1.0.1",
+    "@mintlify/ts-config": "1.0.7",
+    "@tsconfig/recommended": "1.x",
+    "@typescript-eslint/eslint-plugin": "5.x",
+    "@typescript-eslint/parser": "5.x",
+    "babel-jest": "^29.3.1",
+    "eslint": "8.x",
+    "eslint-config-prettier": "8.x",
+    "eslint-plugin-unused-imports": "2.x",
+    "jest": "^29.3.1",
+    "openapi-types": "^12.1.0",
+    "prettier": "2.x",
+    "ts-loader": "^9.4.2",
+    "typescript": "^4.8.2",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.1"
+  }
+}