@redocly/openapi-core 1.2.0 → 1.2.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @redocly/openapi-core
 
+## 1.2.1
+
+### Patch Changes
+
+- Fixed an issue with nested refs in the `join` command.
+- Fixed pattern for no-server-example.com rule to improve detection accuracy.
+- Changed the report location for `pattern` and `notPattern` assertions to be more precise.
+- Updated `unevaluatedItems` type definition to resolve either boolean or object schema per JSON Schema 2019-09 specification.
+- Enhanced public API by small typescript typing fix and exporting new function `bundleFromString`.
+
 ## 1.2.0
 
 ### Minor Changes

package/README.md

@@ -2,24 +2,267 @@
 
 See https://github.com/Redocly/redocly-cli
 
+> [!IMPORTANT]
+The `openapi-core package` is designed for our internal use; the interfaces that are considered safe to use are documented below.
+Some of the function arguments are not documented below because they are not intended for public use.
+Avoid using any functions or features that are not documented below.
+If your use case is not documented below, please open an issue.
+
 ## Basic usage
 
-### Lint
+### Lint from file system
+
+[Lint](https://redocly.com/docs/cli/commands/lint/) a file, optionally with a [config file](https://redocly.com/docs/cli/configuration/).
 
 ```js
-import { formatProblems, lint, loadConfig } from '@redocly/openapi-core';
+import { lint, loadConfig } from '@redocly/openapi-core';
 
 const pathToApi = 'openapi.yaml';
-const config = loadConfig({ configPath: 'optional/path/to/.redocly.yaml' });
+const config = await loadConfig({ configPath: 'optional/path/to/redocly.yaml' });
 const lintResults = await lint({ ref: pathToApi, config });
 ```
 
-### Bundle
+The content of `lintResults` describes any errors or warnings found during linting; an empty array means no problems were found.
+For each problem, the rule, severity, feedback message and a location object are provided.
+To learn more, [check the `lint` function section](#lint).
+
+### Bundle from file system
+
+[Bundle](https://redocly.com/docs/cli/commands/bundle/) an API description into a single structure, optionally with a [config file](https://redocly.com/docs/cli/configuration/).
 
 ```js
-import { formatProblems, bundle, loadConfig } from '@redocly/openapi-core';
+import { bundle, loadConfig } from '@redocly/openapi-core';
 
 const pathToApi = 'openapi.yaml';
-const config = loadConfig({ configPath: 'optional/path/to/.redocly.yaml' });
-const { bundle, problems } = await bundle({ ref: pathToApi, config });
+const config = await loadConfig({ configPath: 'optional/path/to/redocly.yaml' });
+const bundleResults = await bundle({ ref: pathToApi, config });
+```
+
+In `bundleResults`, the `bundle.parsed` field has the bundled API description.
+For more information, [check the `bundle` function section](#bundle).
+
+### Lint from memory with config
+
+[Lint](https://redocly.com/docs/cli/commands/lint/) an API description, with configuration defined. This is useful if the API description you're working with isn't a file on disk.
+
+```js
+import { lintFromString, createConfig, stringifyYaml } from '@redocly/openapi-core';
+
+const config = await createConfig(
+  {
+    extends: ['minimal'],
+    rules: {
+      'operation-description': 'error',
+    },
+  },
+  {
+    // optionally provide config path for resolving $refs and proper error locations
+    configPath: 'optional/path/to/redocly.yaml',
+  }
+);
+const source = stringifyYaml({ openapi: '3.0.1' /* ... */ }); // you can also use JSON.stringify
+const lintResults = await lintFromString({
+  source,
+  // optionally pass path to the file for resolving $refs and proper error locations
+  absoluteRef: 'optional/path/to/openapi.yaml',
+  config,
+});
+```
+
+### Lint from memory with a custom plugin
+
+[Lint](https://redocly.com/docs/cli/commands/lint/) an API description, with configuration including a [custom plugin](https://redocly.com/docs/cli/custom-plugins/) to define a rule.
+
+```js
+import { lintFromString, createConfig, stringifyYaml } from '@redocly/openapi-core';
+
+const CustomRule = (ruleOptions) => {
+  return {
+    Operation() {
+      // some rule logic
+    },
+  };
+};
+
+const config = await createConfig({
+  extends: ['recommended'],
+  plugins: [
+    {
+      id: 'pluginId',
+      rules: {
+        oas3: {
+          customRule1: CustomRule,
+        },
+        oas2: {
+          customRule1: CustomRule, // if the same rule can handle both oas3 and oas2
+        },
+      },
+      decorators: {
+        // ...
+      },
+    },
+  ],
+  // enable rule
+  rules: {
+    'pluginId/customRule1': 'error',
+  },
+  decorators: {
+    // ...
+  },
+});
+
+const source = stringifyYaml({ openapi: '3.0.1' /* ... */ }); // you can also use JSON.stringify
+const lintResults = await lintFromString({
+  source,
+  // optionally pass path to the file for resolving $refs and proper error locations
+  absoluteRef: 'optional/path/to/openapi.yaml',
+  config,
+});
+```
+
+### Bundle from memory
+
+[Bundle](https://redocly.com/docs/cli/commands/bundle/) an API description into a single structure, using default configuration.
+
+```js
+import { bundleFromString, createConfig } from '@redocly/openapi-core';
+
+const config = await createConfig({}); // create empty config
+const source = stringifyYaml({ openapi: '3.0.1' /* ... */ }); // you can also use JSON.stringify
+const bundleResults = await bundleFromString({
+  source,
+  // optionally pass path to the file for resolving $refs and proper error locations
+  absoluteRef: 'optional/path/to/openapi.yaml',
+  config,
+});
 ```
+
+## API
+
+### `createConfig`
+
+Creates a config object from a JSON or YAML string or JS object.
+Resolves remote config from `extends` (if there are URLs or local fs paths).
+
+```ts
+async function createConfig(
+  // JSON or YAML string or object with Redocly config
+  config: string | RawUniversalConfig,
+  options?: {
+    // optional path to the config file for resolving $refs and proper error locations
+    configPath?: string;
+  }
+): Promise<Config>;
+```
+
+### `loadConfig`
+
+Loads a config object from a file system. If `configPath` is not provided,
+it tries to find `redocly.yaml` in the current working directory.
+
+```ts
+async function loadConfig(options?: {
+  // optional path to the config file for resolving $refs and proper error locations
+  configPath?: string;
+  // allows to add custom `extends` additionally to one from the config file
+  customExtends?: string[];
+}): Promise<Config>;
+```
+
+### `lint`
+
+Lint an OpenAPI document from the file system.
+
+```ts
+async function lint(options: {
+  // path to the OpenAPI document root
+  ref: string;
+  // config object
+  config: Config;
+}): Promise<NormalizedProblem[]>;
+```
+
+### `lintFromString`
+
+Lint an OpenAPI document from a string.
+
+```ts
+async function lintFromString(options: {
+  // OpenAPI document string
+  source: string;
+  // optional path to the OpenAPI document for resolving $refs and proper error locations
+  absoluteRef?: string;
+  // config object
+  config: Config;
+}): Promise<NormalizedProblem[]>;
+```
+
+### `bundle`
+
+Bundle an OpenAPI document from the file system.
+
+```ts
+async function bundle(options: {
+  // path to the OpenAPI document root
+  ref: string;
+  // config object
+  config: Config;
+  // whether to fully dereference $refs, resulting document won't have any $ref
+  // warning: this can produce circular objects
+  dereference?: boolean;
+  // whether to remove unused components (schemas, parameters, responses, etc)
+  removeUnusedComponents?: boolean;
+  // whether to keep $ref pointers to the http URLs and resolve only local fs $refs
+  keepUrlRefs?: boolean;
+}): Promise<{
+    bundle: {
+      parsed: object; // OpenAPI document object as js object
+    };
+    problems: NormalizedProblem[]
+    fileDependencies
+    rootType
+    refTypes
+    visitorsData
+
+  }>;
+```
+
+### `bundleFromString`
+
+Bundle an OpenAPI document from a string.
+
+```ts
+async function bundleFromString(options: {
+  // OpenAPI document string
+  source: string;
+  // optional path to the OpenAPI document for resolving $refs and proper error locations
+  absoluteRef?: string;
+  // config object
+  config: Config;
+  // whether to fully dereference $refs, resulting document won't have any $ref
+  // warning: this can produce circular objects
+  dereference?: boolean;
+  // whether to remove unused components (schemas, parameters, responses, etc)
+  removeUnusedComponents?: boolean;
+  // whether to keep $ref pointers to the http URLs and resolve only local fs $refs
+  keepUrlRefs?: boolean;
+}): Promise<{
+    bundle: {
+      parsed: object; // OpenAPI document object as js object
+    };
+    problems: NormalizedProblem[]
+    fileDependencies
+    rootType
+    refTypes
+    visitorsData
+
+  }>;
+```
+
+### `stringifyYaml`
+
+Helper function to stringify a javascript object to YAML.
+
+```ts
+function stringifyYaml(obj: object): string;
+```

package/lib/bundle.d.ts

@@ -10,9 +10,7 @@ export declare enum OasVersion {
     Version3_0 = "oas3_0",
     Version3_1 = "oas3_1"
 }
-export declare function bundle(opts: {
-    ref?: string;
-    doc?: Document;
+export declare type BundleOptions = {
     externalRefResolver?: BaseResolver;
     config: Config;
     dereference?: boolean;
@@ -20,7 +18,15 @@ export declare function bundle(opts: {
     skipRedoclyRegistryRefs?: boolean;
     removeUnusedComponents?: boolean;
     keepUrlRefs?: boolean;
-}): Promise<BundleResult>;
+};
+export declare function bundle(opts: {
+    ref?: string;
+    doc?: Document;
+} & BundleOptions): Promise<BundleResult>;
+export declare function bundleFromString(opts: {
+    source: string;
+    absoluteRef?: string;
+} & BundleOptions): Promise<BundleResult>;
 export declare type BundleResult = {
     bundle: Document;
     problems: NormalizedProblem[];

package/lib/bundle.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = exports.OasVersion = void 0;
+exports.mapTypeToComponent = exports.bundleDocument = exports.bundleFromString = exports.bundle = exports.OasVersion = void 0;
 const isEqual = require("lodash.isequal");
 const resolve_1 = require("./resolve");
 const visitors_1 = require("./visitors");
@@ -35,7 +35,7 @@ function bundle(opts) {
         if (!(ref || doc)) {
             throw new Error('Document or reference is required.\n');
         }
-        const document = doc !== undefined ? doc : yield externalRefResolver.resolveDocument(base, ref, true);
+        const document = doc === undefined ? yield externalRefResolver.resolveDocument(base, ref, true) : doc;
         if (document instanceof Error) {
             throw document;
         }
@@ -43,6 +43,14 @@ function bundle(opts) {
     });
 }
 exports.bundle = bundle;
+function bundleFromString(opts) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { source, absoluteRef, externalRefResolver = new resolve_1.BaseResolver(opts.config.resolve) } = opts;
+        const document = resolve_1.makeDocumentFromString(source, absoluteRef || '/');
+        return bundleDocument(Object.assign(Object.assign({ document }, opts), { externalRefResolver, config: opts.config.styleguide }));
+    });
+}
+exports.bundleFromString = bundleFromString;
 function bundleDocument(opts) {
     return __awaiter(this, void 0, void 0, function* () {
         const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, removeUnusedComponents = false, keepUrlRefs = false, } = opts;

package/lib/config/load.d.ts

@@ -1,5 +1,5 @@
 import { Config } from './config';
-import type { RawConfig, Region } from './types';
+import type { RawConfig, RawUniversalConfig, Region } from './types';
 import { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
 export declare function loadConfig(options?: {
     configPath?: string;
@@ -14,6 +14,7 @@ export declare function getConfig(configPath?: string | undefined, processRawCon
 declare type CreateConfigOptions = {
     extends?: string[];
     tokens?: RegionalTokenWithValidity[];
+    configPath?: string;
 };
-export declare function createConfig(config: string | RawConfig, options?: CreateConfigOptions): Promise<Config>;
+export declare function createConfig(config: string | RawUniversalConfig, options?: CreateConfigOptions): Promise<Config>;
 export {};

package/lib/config/load.js

@@ -82,8 +82,8 @@ function findConfig(dir) {
     const existingConfigFiles = exports.CONFIG_FILE_NAMES.map((name) => dir ? path.resolve(dir, name) : name).filter(fs.existsSync);
     if (existingConfigFiles.length > 1) {
         throw new Error(`
-      Multiple configuration files are not allowed. 
-      Found the following files: ${existingConfigFiles.join(', ')}. 
+      Multiple configuration files are not allowed.
+      Found the following files: ${existingConfigFiles.join(', ')}.
       Please use 'redocly.yaml' instead.
     `);
     }

package/lib/config/types.d.ts

@@ -134,6 +134,7 @@ export declare type RawConfig = {
     files?: string[];
     telemetry?: Telemetry;
 } & ThemeConfig;
+export declare type RawUniversalConfig = Omit<RawConfig, 'styleguide'> & StyleguideRawConfig;
 export declare type FlatApi = Omit<Api, 'styleguide'> & Omit<ApiStyleguideRawConfig, 'doNotResolveExamples'>;
 export declare type FlatRawConfig = Omit<RawConfig, 'styleguide' | 'resolve' | 'apis'> & Omit<StyleguideRawConfig, 'doNotResolveExamples'> & {
     resolve?: RawResolveConfig;

package/lib/index.d.ts

@@ -2,13 +2,14 @@ export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy
 export { Oas3_1Types } from './types/oas3_1';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';
+export { AsyncApi2Types } from './types/asyncapi';
 export { ConfigTypes } from './types/redocly-yaml';
 export type { Oas3Definition, Oas3_1Definition, Oas3Components, Oas3PathItem, Oas3Paths, Oas3ComponentName, Oas3Schema, Oas3_1Schema, Oas3Tag, Oas3_1Webhooks, Referenced, OasRef, } from './typings/openapi';
 export type { Oas2Definition } from './typings/swagger';
 export type { StatsAccumulator, StatsName } from './typings/common';
 export { normalizeTypes } from './types';
 export { Stats } from './rules/other/stats';
-export { Config, StyleguideConfig, RawConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, ResolvedApi, } from './config';
+export { Config, StyleguideConfig, RawConfig, RawUniversalConfig, IGNORE_FILE, Region, getMergedConfig, transformConfig, loadConfig, getConfig, findConfig, CONFIG_FILE_NAMES, RuleSeverity, createConfig, ResolvedApi, } from './config';
 export { RedoclyClient, isRedoclyRegistryURL } from './redocly';
 export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
 export { parseYaml, stringifyYaml } from './js-yaml';
@@ -19,4 +20,4 @@ export { WalkContext, walkDocument, NormalizedProblem, ProblemSeverity, LineColL
 export { getAstNodeByPointer, getLineColLocation } from './format/codeframes';
 export { formatProblems, OutputFormat, getTotals, Totals } from './format/format';
 export { lint, lint as validate, lintDocument, lintFromString, lintConfig } from './lint';
-export { bundle, bundleDocument, mapTypeToComponent } from './bundle';
+export { bundle, bundleDocument, mapTypeToComponent, bundleFromString } from './bundle';

package/lib/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.bundle = exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
-exports.mapTypeToComponent = exports.bundleDocument = void 0;
+exports.lintConfig = exports.lintFromString = exports.lintDocument = exports.validate = exports.lint = exports.getTotals = exports.formatProblems = exports.getLineColLocation = exports.getAstNodeByPointer = exports.walkDocument = exports.normalizeVisitors = exports.getTypes = exports.detectSpec = exports.SpecVersion = exports.getMajorSpecVersion = exports.SpecMajorVersion = exports.isAbsoluteUrl = exports.isRef = exports.unescapePointer = exports.stringifyYaml = exports.parseYaml = exports.makeDocumentFromString = exports.YamlParseError = exports.ResolveError = exports.resolveDocument = exports.BaseResolver = exports.Source = exports.isRedoclyRegistryURL = exports.RedoclyClient = exports.createConfig = exports.CONFIG_FILE_NAMES = exports.findConfig = exports.getConfig = exports.loadConfig = exports.transformConfig = exports.getMergedConfig = exports.IGNORE_FILE = exports.StyleguideConfig = exports.Config = exports.Stats = exports.normalizeTypes = exports.ConfigTypes = exports.AsyncApi2Types = exports.Oas2Types = exports.Oas3Types = exports.Oas3_1Types = exports.isTruthy = exports.doesYamlFileExist = exports.slash = exports.readFileFromUrl = void 0;
+exports.bundleFromString = exports.mapTypeToComponent = exports.bundleDocument = exports.bundle = void 0;
 var utils_1 = require("./utils");
 Object.defineProperty(exports, "readFileFromUrl", { enumerable: true, get: function () { return utils_1.readFileFromUrl; } });
 Object.defineProperty(exports, "slash", { enumerable: true, get: function () { return utils_1.slash; } });
@@ -13,6 +13,8 @@ var oas3_1 = require("./types/oas3");
 Object.defineProperty(exports, "Oas3Types", { enumerable: true, get: function () { return oas3_1.Oas3Types; } });
 var oas2_1 = require("./types/oas2");
 Object.defineProperty(exports, "Oas2Types", { enumerable: true, get: function () { return oas2_1.Oas2Types; } });
+var asyncapi_1 = require("./types/asyncapi");
+Object.defineProperty(exports, "AsyncApi2Types", { enumerable: true, get: function () { return asyncapi_1.AsyncApi2Types; } });
 var redocly_yaml_1 = require("./types/redocly-yaml");
 Object.defineProperty(exports, "ConfigTypes", { enumerable: true, get: function () { return redocly_yaml_1.ConfigTypes; } });
 var types_1 = require("./types");
@@ -73,3 +75,4 @@ var bundle_1 = require("./bundle");
 Object.defineProperty(exports, "bundle", { enumerable: true, get: function () { return bundle_1.bundle; } });
 Object.defineProperty(exports, "bundleDocument", { enumerable: true, get: function () { return bundle_1.bundleDocument; } });
 Object.defineProperty(exports, "mapTypeToComponent", { enumerable: true, get: function () { return bundle_1.mapTypeToComponent; } });
+Object.defineProperty(exports, "bundleFromString", { enumerable: true, get: function () { return bundle_1.bundleFromString; } });

package/lib/rules/common/assertions/asserts.js

@@ -35,7 +35,7 @@ exports.runOnValuesSet = new Set([
     'const',
 ]);
 exports.asserts = {
-    pattern: (value, condition, { baseLocation }) => {
+    pattern: (value, condition, { baseLocation, rawValue }) => {
         if (typeof value === 'undefined' || utils_1.isPlainObject(value))
             return []; // property doesn't exist or is an object, no need to lint it with this assert
         const values = Array.isArray(value) ? value : [value];
@@ -43,11 +43,15 @@ exports.asserts = {
         return values
             .map((_val) => !(regex === null || regex === void 0 ? void 0 : regex.test(_val)) && {
             message: `"${_val}" should match a regex ${condition}`,
-            location: utils_1.isString(value) ? baseLocation : baseLocation.key(),
+            location: utils_1.isString(value)
+                ? baseLocation
+                : utils_1.isPlainObject(rawValue)
+                    ? baseLocation.child(_val).key()
+                    : baseLocation.key(),
         })
             .filter(utils_1.isTruthy);
     },
-    notPattern: (value, condition, { baseLocation }) => {
+    notPattern: (value, condition, { baseLocation, rawValue }) => {
         if (typeof value === 'undefined' || utils_1.isPlainObject(value))
             return []; // property doesn't exist or is an object, no need to lint it with this assert
         const values = Array.isArray(value) ? value : [value];
@@ -55,7 +59,11 @@ exports.asserts = {
         return values
             .map((_val) => (regex === null || regex === void 0 ? void 0 : regex.test(_val)) && {
             message: `"${_val}" should not match a regex ${condition}`,
-            location: utils_1.isString(value) ? baseLocation : baseLocation.key(),
+            location: utils_1.isString(value)
+                ? baseLocation
+                : utils_1.isPlainObject(rawValue)
+                    ? baseLocation.child(_val).key()
+                    : baseLocation.key(),
         })
             .filter(utils_1.isTruthy);
     },

package/lib/rules/oas3/no-server-example.com.js

@@ -4,9 +4,10 @@ exports.NoServerExample = void 0;
 const NoServerExample = () => {
     return {
         Server(server, { report, location }) {
-            if (['example.com', 'localhost'].indexOf(server.url) !== -1) {
+            const pattern = /^(.*[\/.])?(example\.com|localhost)([\/:?].*|$)/;
+            if (server.url && pattern.test(server.url)) {
                 report({
-                    message: 'Server `url` should not point at example.com.',
+                    message: 'Server `url` should not point to example.com or localhost.',
                     location: location.child(['url']),
                 });
             }

package/lib/types/asyncapi.js

@@ -365,7 +365,14 @@ const Schema = {
         maxContains: { type: 'integer', minimum: 0 },
         patternProperties: { type: 'object' },
         propertyNames: 'Schema',
-        unevaluatedItems: 'Schema',
+        unevaluatedItems: (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return 'Schema';
+            }
+        },
         unevaluatedProperties: (value) => {
             if (typeof value === 'boolean') {
                 return { type: 'boolean' };

package/lib/types/oas3_1.js

@@ -135,7 +135,14 @@ const Schema = {
         maxContains: { type: 'integer', minimum: 0 },
         patternProperties: { type: 'object' },
         propertyNames: 'Schema',
-        unevaluatedItems: 'Schema',
+        unevaluatedItems: (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return 'Schema';
+            }
+        },
         unevaluatedProperties: (value) => {
             if (typeof value === 'boolean') {
                 return { type: 'boolean' };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "",
   "main": "lib/index.js",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=14.19.0",
+    "npm": ">=7.0.0"
   },
   "engineStrict": true,
   "license": "MIT",

package/src/__tests__/__snapshots__/bundle.test.ts.snap

@@ -308,7 +308,7 @@ components:
 
 `;
 
-exports[`bundle should not place referened schema inline when component in question is not of type "schemas" 1`] = `
+exports[`bundle should not place referenced schema inline when component in question is not of type "schemas" 1`] = `
 openapi: 3.0.0
 paths:
   /pet:

package/src/__tests__/bundle.test.ts

@@ -1,11 +1,32 @@
 import outdent from 'outdent';
 import * as path from 'path';
 
-import { bundleDocument, bundle } from '../bundle';
+import { bundleDocument, bundle, bundleFromString } from '../bundle';
 import { parseYamlToDocument, yamlSerializer, makeConfig } from '../../__tests__/utils';
-import { StyleguideConfig, Config, ResolvedConfig } from '../config';
+import { StyleguideConfig, Config, ResolvedConfig, createConfig, loadConfig } from '../config';
 import { BaseResolver } from '../resolve';
 
+const stringDocument = outdent`
+  openapi: 3.0.0
+  paths:
+    /pet:
+      get:
+        operationId: get
+        parameters:
+          - $ref: '#/components/parameters/shared_a'
+          - name: get_b
+      post:
+        operationId: post
+        parameters:
+          - $ref: '#/components/parameters/shared_a'
+  components:
+    parameters:
+      shared_a:
+        name: shared-a
+`;
+
+const testDocument = parseYamlToDocument(stringDocument, '');
+
 describe('bundle', () => {
   const fetchMock = jest.fn(() =>
     Promise.resolve({
@@ -19,28 +40,6 @@ describe('bundle', () => {
 
   expect.addSnapshotSerializer(yamlSerializer);
 
-  const testDocument = parseYamlToDocument(
-    outdent`
-      openapi: 3.0.0
-      paths:
-        /pet:
-          get:
-            operationId: get
-            parameters:
-              - $ref: '#/components/parameters/shared_a'
-              - name: get_b
-          post:
-            operationId: post
-            parameters:
-              - $ref: '#/components/parameters/shared_a'
-      components:
-        parameters:
-          shared_a:
-            name: shared-a
-    `,
-    ''
-  );
-
   it('change nothing with only internal refs', async () => {
     const { bundle, problems } = await bundleDocument({
       document: testDocument,
@@ -97,7 +96,7 @@ describe('bundle', () => {
     expect(res.parsed).toMatchSnapshot();
   });
 
-  it('should not place referened schema inline when component in question is not of type "schemas"', async () => {
+  it('should not place referenced schema inline when component in question is not of type "schemas"', async () => {
     const { bundle: res, problems } = await bundle({
       config: new Config({} as ResolvedConfig),
       ref: path.join(__dirname, 'fixtures/refs/external-request-body.yaml'),
@@ -233,4 +232,45 @@ describe('bundle', () => {
 
     `);
   });
+
+  it('should throw an error when there is no document to bundle', () => {
+    const wrapper = () =>
+      bundle({
+        config: new Config({} as ResolvedConfig),
+      });
+
+    expect(wrapper()).rejects.toThrowError('Document or reference is required.\n');
+  });
+
+  it('should bundle with a doc provided', async () => {
+    const {
+      bundle: { parsed },
+      problems,
+    } = await bundle({
+      config: await loadConfig({ configPath: path.join(__dirname, 'fixtures/redocly.yaml') }),
+      doc: testDocument,
+    });
+
+    const origCopy = JSON.parse(JSON.stringify(testDocument.parsed));
+
+    expect(problems).toHaveLength(0);
+    expect(parsed).toEqual(origCopy);
+  });
+});
+
+describe('bundleFromString', () => {
+  it('should bundle from string using bundleFromString', async () => {
+    const {
+      bundle: { parsed, ...rest },
+      problems,
+    } = await bundleFromString({
+      config: await createConfig(`
+        extends:
+        - recommended
+      `),
+      source: testDocument.source.body,
+    });
+    expect(problems).toHaveLength(0);
+    expect(rest.source.body).toEqual(stringDocument);
+  });
 });