@nocobase/plugin-mcp-server 2.1.0-alpha.16 → 2.1.0-alpha.18

package/dist/node_modules/openapi-mcp-generator/node_modules/@apidevtools/json-schema-ref-parser/lib/options.ts

@@ -0,0 +1,232 @@
+import jsonParser from "./parsers/json.js";
+import yamlParser from "./parsers/yaml.js";
+import textParser from "./parsers/text.js";
+import binaryParser from "./parsers/binary.js";
+import fileResolver from "./resolvers/file.js";
+import httpResolver from "./resolvers/http.js";
+
+import type { HTTPResolverOptions, JSONSchema, JSONSchemaObject, Plugin, ResolverOptions } from "./types/index.js";
+
+export type DeepPartial<T> = T extends object
+  ? {
+      [P in keyof T]?: DeepPartial<T[P]>;
+    }
+  : T;
+export interface DereferenceOptions {
+  /**
+   * Determines whether circular `$ref` pointers are handled.
+   *
+   * If set to `false`, then a `ReferenceError` will be thrown if the schema contains any circular references.
+   *
+   * If set to `"ignore"`, then circular references will simply be ignored. No error will be thrown, but the `$Refs.circular` property will still be set to `true`.
+   */
+  circular?: boolean | "ignore";
+
+  /**
+   * A function, called for each path, which can return true to stop this path and all
+   * subpaths from being dereferenced further. This is useful in schemas where some
+   * subpaths contain literal $ref keys that should not be dereferenced.
+   */
+  excludedPathMatcher?(path: string): boolean;
+
+  /**
+   * Callback invoked during dereferencing.
+   *
+   * @argument {string} path - The path being dereferenced (ie. the `$ref` string)
+   * @argument {JSONSchemaObject} value - The JSON-Schema that the `$ref` resolved to
+   * @argument {JSONSchemaObject} parent - The parent of the dereferenced object
+   * @argument {string} parentPropName - The prop name of the parent object whose value was dereferenced
+   */
+  onDereference?(path: string, value: JSONSchemaObject, parent?: JSONSchemaObject, parentPropName?: string): void;
+
+  /**
+   * Whether a reference should resolve relative to its directory/path, or from the cwd
+   *
+   * Default: `relative`
+   */
+  externalReferenceResolution?: "relative" | "root";
+}
+
+/**
+ * Options that determine how JSON schemas are parsed, resolved, and dereferenced.
+ *
+ * @param [options] - Overridden options
+ * @class
+ */
+export interface $RefParserOptions<S extends object = JSONSchema> {
+  /**
+   * The `parse` options determine how different types of files will be parsed.
+   *
+   * JSON Schema `$Ref` Parser comes with built-in JSON, YAML, plain-text, and binary parsers, any of which you can configure or disable. You can also add your own custom parsers if you want.
+   */
+  parse: {
+    json?: Plugin | boolean;
+    yaml?: Plugin | boolean;
+    binary?: Plugin | boolean;
+    text?: Plugin | boolean;
+    [key: string]: Plugin | boolean | undefined;
+  };
+
+  /**
+   * The `resolve` options control how JSON Schema $Ref Parser will resolve file paths and URLs, and how those files will be read/downloaded.
+   *
+   * JSON Schema `$Ref` Parser comes with built-in support for HTTP and HTTPS, as well as support for local files (when running in Node.js). You can configure or disable either of these built-in resolvers. You can also add your own custom resolvers if you want.
+   */
+  resolve: {
+    /**
+     * Determines whether external $ref pointers will be resolved. If this option is disabled, then external `$ref` pointers will simply be ignored.
+     */
+    external?: boolean;
+    file?: Partial<ResolverOptions<S>> | boolean;
+    http?: HTTPResolverOptions<S> | boolean;
+  } & {
+    [key: string]: Partial<ResolverOptions<S>> | HTTPResolverOptions<S> | boolean | undefined;
+  };
+
+  /**
+   * By default, JSON Schema $Ref Parser throws the first error it encounters. Setting `continueOnError` to `true`
+   * causes it to keep processing as much as possible and then throw a single error that contains all errors
+   * that were encountered.
+   */
+  continueOnError: boolean;
+
+  /**
+   * The `dereference` options control how JSON Schema `$Ref` Parser will dereference `$ref` pointers within the JSON schema.
+   */
+  dereference: DereferenceOptions;
+
+  /**
+   * Whether to clone the schema before dereferencing it.
+   * This is useful when you want to dereference the same schema multiple times, but you don't want to modify the original schema.
+   * Default: `true` due to mutating the input being the default behavior historically
+   */
+  mutateInputSchema?: boolean;
+
+  /**
+   * The maximum amount of time (in milliseconds) that JSON Schema $Ref Parser will spend dereferencing a single schema.
+   * It will throw a timeout error if the operation takes longer than this.
+   */
+  timeoutMs?: number;
+}
+
+export const getJsonSchemaRefParserDefaultOptions = () => {
+  const defaults = {
+    /**
+     * Determines how different types of files will be parsed.
+     *
+     * You can add additional parsers of your own, replace an existing one with
+     * your own implementation, or disable any parser by setting it to false.
+     */
+    parse: {
+      json: { ...jsonParser },
+      yaml: { ...yamlParser },
+      text: { ...textParser },
+      binary: { ...binaryParser },
+    },
+
+    /**
+     * Determines how JSON References will be resolved.
+     *
+     * You can add additional resolvers of your own, replace an existing one with
+     * your own implementation, or disable any resolver by setting it to false.
+     */
+    resolve: {
+      file: { ...fileResolver },
+      http: { ...httpResolver },
+
+      /**
+       * Determines whether external $ref pointers will be resolved.
+       * If this option is disabled, then none of above resolvers will be called.
+       * Instead, external $ref pointers will simply be ignored.
+       *
+       * @type {boolean}
+       */
+      external: true,
+    },
+
+    /**
+     * By default, JSON Schema $Ref Parser throws the first error it encounters. Setting `continueOnError` to `true`
+     * causes it to keep processing as much as possible and then throw a single error that contains all errors
+     * that were encountered.
+     */
+    continueOnError: false,
+
+    /**
+     * Determines the types of JSON references that are allowed.
+     */
+    dereference: {
+      /**
+       * Dereference circular (recursive) JSON references?
+       * If false, then a {@link ReferenceError} will be thrown if a circular reference is found.
+       * If "ignore", then circular references will not be dereferenced.
+       *
+       * @type {boolean|string}
+       */
+      circular: true,
+
+      /**
+       * A function, called for each path, which can return true to stop this path and all
+       * subpaths from being dereferenced further. This is useful in schemas where some
+       * subpaths contain literal $ref keys that should not be dereferenced.
+       *
+       * @type {function}
+       */
+      excludedPathMatcher: () => false,
+      referenceResolution: "relative",
+    },
+
+    mutateInputSchema: true,
+  } as $RefParserOptions<JSONSchema>;
+  return defaults;
+};
+
+export const getNewOptions = <S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+  options: O | undefined,
+): O & $RefParserOptions<S> => {
+  const newOptions = getJsonSchemaRefParserDefaultOptions();
+  if (options) {
+    merge(newOptions, options);
+  }
+  return newOptions as O & $RefParserOptions<S>;
+};
+
+export type Options<S extends object = JSONSchema> = $RefParserOptions<S>;
+export type ParserOptions<S extends object = JSONSchema> = DeepPartial<$RefParserOptions<S>>;
+/**
+ * Merges the properties of the source object into the target object.
+ *
+ * @param target - The object that we're populating
+ * @param source - The options that are being merged
+ * @returns
+ */
+function merge(target: any, source: any) {
+  if (isMergeable(source)) {
+    // prevent prototype pollution
+    const keys = Object.keys(source).filter((key) => !["__proto__", "constructor", "prototype"].includes(key));
+    for (let i = 0; i < keys.length; i++) {
+      const key = keys[i];
+      const sourceSetting = source[key];
+      const targetSetting = target[key];
+
+      if (isMergeable(sourceSetting)) {
+        // It's a nested object, so merge it recursively
+        target[key] = merge(targetSetting || {}, sourceSetting);
+      } else if (sourceSetting !== undefined) {
+        // It's a scalar value, function, or array. No merging necessary. Just overwrite the target value.
+        target[key] = sourceSetting;
+      }
+    }
+  }
+  return target;
+}
+/**
+ * Determines whether the given value can be merged,
+ * or if it is a scalar value that should just override the target value.
+ *
+ * @param val
+ * @returns
+ */
+function isMergeable(val: any) {
+  return val && typeof val === "object" && !Array.isArray(val) && !(val instanceof RegExp) && !(val instanceof Date);
+}
+export default $RefParserOptions;

package/dist/node_modules/openapi-mcp-generator/node_modules/@apidevtools/json-schema-ref-parser/lib/parse.ts

@@ -0,0 +1,170 @@
+import { ono } from "@jsdevtools/ono";
+import * as url from "./util/url.js";
+import * as plugins from "./util/plugins.js";
+import {
+  ResolverError,
+  ParserError,
+  UnmatchedParserError,
+  UnmatchedResolverError,
+  isHandledError,
+} from "./util/errors.js";
+import type $Refs from "./refs.js";
+import type { ParserOptions } from "./options.js";
+import type { FileInfo, JSONSchema } from "./types/index.js";
+
+/**
+ * Reads and parses the specified file path or URL.
+ */
+async function parse<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+  path: string,
+  $refs: $Refs<S, O>,
+  options: O,
+) {
+  // Remove the URL fragment, if any
+  const hashIndex = path.indexOf("#");
+  let hash = "";
+  if (hashIndex >= 0) {
+    hash = path.substring(hashIndex);
+    // Remove the URL fragment, if any
+    path = path.substring(0, hashIndex);
+  }
+
+  // Add a new $Ref for this file, even though we don't have the value yet.
+  // This ensures that we don't simultaneously read & parse the same file multiple times
+  const $ref = $refs._add(path);
+
+  // This "file object" will be passed to all resolvers and parsers.
+  const file = {
+    url: path,
+    hash,
+    extension: url.getExtension(path),
+  } as FileInfo;
+
+  // Read the file and then parse the data
+  try {
+    const resolver = await readFile<S, O>(file, options, $refs);
+    $ref.pathType = resolver.plugin.name;
+    file.data = resolver.result;
+
+    const parser = await parseFile<S, O>(file, options, $refs);
+    $ref.value = parser.result;
+
+    return parser.result;
+  } catch (err) {
+    if (isHandledError(err)) {
+      $ref.value = err;
+    }
+
+    throw err;
+  }
+}
+
+/**
+ * Reads the given file, using the configured resolver plugins
+ *
+ * @param file           - An object containing information about the referenced file
+ * @param file.url       - The full URL of the referenced file
+ * @param file.extension - The lowercased file extension (e.g. ".txt", ".html", etc.)
+ * @param options
+ * @param $refs
+ * @returns
+ * The promise resolves with the raw file contents and the resolver that was used.
+ */
+async function readFile<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+  file: FileInfo,
+  options: O,
+  $refs: $Refs<S, O>,
+): Promise<any> {
+  // console.log('Reading %s', file.url);
+
+  // Find the resolvers that can read this file
+  let resolvers = plugins.all(options.resolve);
+  resolvers = plugins.filter(resolvers, "canRead", file);
+
+  // Run the resolvers, in order, until one of them succeeds
+  plugins.sort(resolvers);
+  try {
+    const data = await plugins.run(resolvers, "read", file, $refs);
+    return data;
+  } catch (err: any) {
+    if (!err && options.continueOnError) {
+      // No resolver could be matched
+      throw new UnmatchedResolverError(file.url);
+    } else if (!err || !("error" in err)) {
+      // Throw a generic, friendly error.
+      throw ono.syntax(`Unable to resolve $ref pointer "${file.url}"`);
+    }
+    // Throw the original error, if it's one of our own (user-friendly) errors.
+    else if (err.error instanceof ResolverError) {
+      throw err.error;
+    } else {
+      throw new ResolverError(err, file.url);
+    }
+  }
+}
+
+/**
+ * Parses the given file's contents, using the configured parser plugins.
+ *
+ * @param file           - An object containing information about the referenced file
+ * @param file.url       - The full URL of the referenced file
+ * @param file.extension - The lowercased file extension (e.g. ".txt", ".html", etc.)
+ * @param file.data      - The file contents. This will be whatever data type was returned by the resolver
+ * @param options
+ * @param $refs
+ *
+ * @returns
+ * The promise resolves with the parsed file contents and the parser that was used.
+ */
+async function parseFile<S extends object = JSONSchema, O extends ParserOptions<S> = ParserOptions<S>>(
+  file: FileInfo,
+  options: O,
+  $refs: $Refs<S, O>,
+) {
+  // Find the parsers that can read this file type.
+  // If none of the parsers are an exact match for this file, then we'll try ALL of them.
+  // This handles situations where the file IS a supported type, just with an unknown extension.
+  const allParsers = plugins.all(options.parse);
+  const filteredParsers = plugins.filter(allParsers, "canParse", file);
+  const parsers = filteredParsers.length > 0 ? filteredParsers : allParsers;
+
+  // Run the parsers, in order, until one of them succeeds
+  plugins.sort(parsers);
+  try {
+    const parser = await plugins.run<S, O>(parsers, "parse", file, $refs);
+    if (!parser.plugin.allowEmpty && isEmpty(parser.result)) {
+      throw ono.syntax(`Error parsing "${file.url}" as ${parser.plugin.name}. \nParsed value is empty`);
+    } else {
+      return parser;
+    }
+  } catch (err: any) {
+    if (!err && options.continueOnError) {
+      // No resolver could be matched
+      throw new UnmatchedParserError(file.url);
+    } else if (err && err.message && err.message.startsWith("Error parsing")) {
+      throw err;
+    } else if (!err || !("error" in err)) {
+      throw ono.syntax(`Unable to parse ${file.url}`);
+    } else if (err.error instanceof ParserError) {
+      throw err.error;
+    } else {
+      throw new ParserError(err.error.message, file.url);
+    }
+  }
+}
+
+/**
+ * Determines whether the parsed value is "empty".
+ *
+ * @param value
+ * @returns
+ */
+function isEmpty(value: any) {
+  return (
+    value === undefined ||
+    (typeof value === "object" && Object.keys(value).length === 0) ||
+    (typeof value === "string" && value.trim().length === 0) ||
+    (Buffer.isBuffer(value) && value.length === 0)
+  );
+}
+export default parse;

package/dist/node_modules/openapi-mcp-generator/node_modules/@apidevtools/json-schema-ref-parser/lib/parsers/binary.ts

@@ -0,0 +1,39 @@
+import type { FileInfo } from "../types/index.js";
+import type { Plugin } from "../types/index.js";
+
+const BINARY_REGEXP = /\.(jpeg|jpg|gif|png|bmp|ico)$/i;
+
+export default {
+  /**
+   * The order that this parser will run, in relation to other parsers.
+   */
+  order: 400,
+
+  /**
+   * Whether to allow "empty" files (zero bytes).
+   */
+  allowEmpty: true,
+
+  /**
+   * Determines whether this parser can parse a given file reference.
+   * Parsers that return true will be tried, in order, until one successfully parses the file.
+   * Parsers that return false will be skipped, UNLESS all parsers returned false, in which case
+   * every parser will be tried.
+   */
+  canParse(file: FileInfo) {
+    // Use this parser if the file is a Buffer, and has a known binary extension
+    return Buffer.isBuffer(file.data) && BINARY_REGEXP.test(file.url);
+  },
+
+  /**
+   * Parses the given data as a Buffer (byte array).
+   */
+  parse(file: FileInfo) {
+    if (Buffer.isBuffer(file.data)) {
+      return file.data;
+    } else {
+      // This will reject if data is anything other than a string or typed array
+      return Buffer.from(file.data);
+    }
+  },
+} as Plugin;

package/dist/node_modules/openapi-mcp-generator/node_modules/@apidevtools/json-schema-ref-parser/lib/parsers/json.ts

@@ -0,0 +1,64 @@
+import { ParserError } from "../util/errors.js";
+import type { FileInfo } from "../types/index.js";
+import type { Plugin } from "../types/index.js";
+
+export default {
+  /**
+   * The order that this parser will run, in relation to other parsers.
+   */
+  order: 100,
+
+  /**
+   * Whether to allow "empty" files. This includes zero-byte files, as well as empty JSON objects.
+   */
+  allowEmpty: true,
+
+  /**
+   * Determines whether this parser can parse a given file reference.
+   * Parsers that match will be tried, in order, until one successfully parses the file.
+   * Parsers that don't match will be skipped, UNLESS none of the parsers match, in which case
+   * every parser will be tried.
+   */
+  canParse: ".json",
+
+  /**
+   * Allow JSON files with byte order marks (BOM)
+   */
+  allowBOM: true,
+
+  /**
+   * Parses the given file as JSON
+   */
+  async parse(file: FileInfo): Promise<object | undefined> {
+    let data = file.data;
+    if (Buffer.isBuffer(data)) {
+      data = data.toString();
+    }
+
+    if (typeof data === "string") {
+      if (data.trim().length === 0) {
+        return; // This mirrors the YAML behavior
+      } else {
+        try {
+          return JSON.parse(data);
+        } catch (e: any) {
+          if (this.allowBOM) {
+            try {
+              // find the first curly brace
+              const firstCurlyBrace = data.indexOf("{");
+              // remove any characters before the first curly brace
+              data = data.slice(firstCurlyBrace);
+              return JSON.parse(data);
+            } catch (e: any) {
+              throw new ParserError(e.message, file.url);
+            }
+          }
+          throw new ParserError(e.message, file.url);
+        }
+      }
+    } else {
+      // data is already a JavaScript value (object, array, number, null, NaN, etc.)
+      return data as object;
+    }
+  },
+} as Plugin;

package/dist/node_modules/openapi-mcp-generator/node_modules/@apidevtools/json-schema-ref-parser/lib/parsers/text.ts

@@ -0,0 +1,46 @@
+import { ParserError } from "../util/errors.js";
+import type { FileInfo } from "../types/index.js";
+import type { Plugin } from "../types/index.js";
+
+const TEXT_REGEXP = /\.(txt|htm|html|md|xml|js|min|map|css|scss|less|svg)$/i;
+
+export default {
+  /**
+   * The order that this parser will run, in relation to other parsers.
+   */
+  order: 300,
+
+  /**
+   * Whether to allow "empty" files (zero bytes).
+   */
+  allowEmpty: true,
+
+  /**
+   * The encoding that the text is expected to be in.
+   */
+  encoding: "utf8" as BufferEncoding,
+
+  /**
+   * Determines whether this parser can parse a given file reference.
+   * Parsers that return true will be tried, in order, until one successfully parses the file.
+   * Parsers that return false will be skipped, UNLESS all parsers returned false, in which case
+   * every parser will be tried.
+   */
+  canParse(file: FileInfo) {
+    // Use this parser if the file is a string or Buffer, and has a known text-based extension
+    return (typeof file.data === "string" || Buffer.isBuffer(file.data)) && TEXT_REGEXP.test(file.url);
+  },
+
+  /**
+   * Parses the given file as text
+   */
+  parse(file: FileInfo) {
+    if (typeof file.data === "string") {
+      return file.data;
+    } else if (Buffer.isBuffer(file.data)) {
+      return file.data.toString(this.encoding);
+    } else {
+      throw new ParserError("data is not text", file.url);
+    }
+  },
+} as Plugin;

package/dist/node_modules/openapi-mcp-generator/node_modules/@apidevtools/json-schema-ref-parser/lib/parsers/yaml.ts

@@ -0,0 +1,52 @@
+import { ParserError } from "../util/errors.js";
+import yaml from "js-yaml";
+import { JSON_SCHEMA } from "js-yaml";
+import type { FileInfo } from "../types/index.js";
+import type { Plugin } from "../types/index.js";
+
+export default {
+  /**
+   * The order that this parser will run, in relation to other parsers.
+   */
+  order: 200,
+
+  /**
+   * Whether to allow "empty" files. This includes zero-byte files, as well as empty JSON objects.
+   */
+  allowEmpty: true,
+
+  /**
+   * Determines whether this parser can parse a given file reference.
+   * Parsers that match will be tried, in order, until one successfully parses the file.
+   * Parsers that don't match will be skipped, UNLESS none of the parsers match, in which case
+   * every parser will be tried.
+   */
+  canParse: [".yaml", ".yml", ".json"], // JSON is valid YAML
+
+  /**
+   * Parses the given file as YAML
+   *
+   * @param file           - An object containing information about the referenced file
+   * @param file.url       - The full URL of the referenced file
+   * @param file.extension - The lowercased file extension (e.g. ".txt", ".html", etc.)
+   * @param file.data      - The file contents. This will be whatever data type was returned by the resolver
+   * @returns
+   */
+  async parse(file: FileInfo) {
+    let data = file.data;
+    if (Buffer.isBuffer(data)) {
+      data = data.toString();
+    }
+
+    if (typeof data === "string") {
+      try {
+        return yaml.load(data, { schema: JSON_SCHEMA });
+      } catch (e: any) {
+        throw new ParserError(e?.message || "Parser Error", file.url);
+      }
+    } else {
+      // data is already a JavaScript value (object, array, number, null, NaN, etc.)
+      return data;
+    }
+  },
+} as Plugin;