@redocly/openapi-docs 3.12.0 → 3.12.2

package/lib/utils/helpers.js

@@ -1,12 +1,222 @@
-import{isObject as i,isString as a,IS_BROWSER as u}from"@redocly/theme/core/openapi";import{isNamedDefinition as f}from"./openapi.js";import{JsonPointer as l}from"./JsonPointer.js";import{urlParse as c}from"./url.js";function w(r,e){const t=[];for(let n=0;n<r.length-1;n++)t.push(e(r[n],!1));return r.length!==0&&t.push(e(r[r.length-1],!0)),t}function O(r,e){const t={};for(const n in r)Object.prototype.hasOwnProperty.call(r,n)&&(t[n]=e(r[n],n,r));return t}function y(r,e){const t=[],n=o=>{for(const s of o)t.push(s),s[e]&&n(s[e])};return n(r),t}function p(r){return r.endsWith("/")?r.substring(0,r.length-1):r}function A(r){return!isNaN(parseFloat(r))&&isFinite(r)}function b(r,e,t){const n=new RegExp(`(^|\\n)#\\s?${e}\\s*\\n`,"i"),o=new RegExp(`((\\n|^)#\\s*${e}\\s*(\\n|$)(?:.|\\n)*?)(\\n#|$)`,"i");if(n.test(r))return r.replace(o,`$1
-
-${t}
-$4`);{const s=r===""||r.endsWith(`
-
-`)?"":r.endsWith(`
-`)?`
-`:`
-
-`;return`${r}${s}# ${e}
-
-${t}`}}const E=r=>Array.isArray(r)&&r.some(e=>i(e)),R=r=>r.filter(e=>!!e),W=r=>i(r)&&!Array.isArray(r);function d(r){return/(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(r)}function C(r,e){let t;if(e.startsWith("//"))t=`${c(r,!0)?.protocol||"https:"}${e}`;else if(d(e))t=e;else if(!e.startsWith("/"))t=p(r)+"/"+e;else{const n=c(r);n?(n.pathname=e,t=n.toString()):t=e}return p(t)}function I(r){return r.charAt(0).toUpperCase()+r.slice(1)}function L(r){try{if(!r)return"";const e=new URL(r);return e.search="",e.hash="",e.toString()}catch{return r}}function M(r){return r.replace(/["\\]/g,"\\$&")}function N(r){return r.replace(/&#(\d+);/g,(e,t)=>String.fromCharCode(parseInt(t,10))).replace(/&amp;/g,"&").replace(/&quot;/g,'"')}function P(r){return r&&r.replace(/#/g,"_").toLowerCase()}function T(r,e){return e||f(r)&&l.baseName(r)||""}function j(r={},e,t){return typeof e=="string"&&(e=e.split(".")),e.reduce((n,o)=>n&&n[o]?n[o]:t,r)}function x(r){return(...e)=>e.filter(Boolean).join(r)}const z=x(".");function D(r){return u?window?.REFERENCE_DOCS_OPTIONS?.[r]:null}function F(){if(!u)return"";const r=+new Date+Math.random();try{return(!document.currentScript||!(document.currentScript.async||document.currentScript.defer))&&document.write(`<script id="dummy${r}"></script>`),(document.getElementById("dummy"+r)?.previousSibling).src}catch{return""}}const _=r=>a(r)?r:r?.raw,B=(r,e)=>{const t=r?.[`x-parsed-md-${e}`]||r?.[e];if(!t)return;if(!r?.[`x-parsed-md-${e}`]&&e!=="x-enumDescriptions")return r?.[e];if(e!=="x-enumDescriptions")return g(r,e);let n={};for(const o in t)o.startsWith("x-parsed-md")||(n[o]=t?.[`x-parsed-md-${o}`]||t?.[o]);return Object.keys(n).length?n:t};function g(r,e){const t=r?.[`x-parsed-md-${e}`]||r?.[e];return t?.raw?t:{result:t?.result||r?.[e]?.result||r?.[e],raw:r?.[e]}}function H(r,e){return e===r.length-1}function U(r,e){const t=Object.keys(r);return t.indexOf(e)===t.length-1}export{b as appendToMdHeading,R as deleteEmptyArrayItem,z as dottedString,M as escapeHTMLAttrChars,y as flattenByProp,j as get,F as getJsUrl,B as getValueFromMdParsedExtension,D as getWindowReferenceOptions,d as isAbsoluteUrl,E as isArrayOfObjects,H as isLastInArray,U as isLastProperty,W as isMergeableObject,A as isNumeric,x as joinStringFactory,O as mapValues,w as mapWithLast,_ as normalizeText,L as removeQueryStringAndHash,C as resolveUrl,P as sanitizeItemId,p as stripTrailingSlash,I as titleize,N as unescapeHTMLChars,T as useSchemaTitle};
+import { isObject, isString, IS_BROWSER } from '@redocly/theme/core/openapi';
+import { isNamedDefinition } from './openapi.js';
+import { JsonPointer } from './JsonPointer.js';
+import { urlParse } from './url.js';
+/**
+ * Maps over array passing `isLast` bool to iterator as the second argument
+ */
+export function mapWithLast(array, iteratee) {
+    const res = [];
+    for (let i = 0; i < array.length - 1; i++) {
+        res.push(iteratee(array[i], false));
+    }
+    if (array.length !== 0) {
+        res.push(iteratee(array[array.length - 1], true));
+    }
+    return res;
+}
+/**
+ * Creates an object with the same keys as object and values generated by running each
+ * own enumerable string keyed property of object thru iteratee.
+ * The iteratee is invoked with three arguments: (value, key, object).
+ *
+ * @param object the object to iterate over
+ * @param iteratee the function invoked per iteration.
+ */
+export function mapValues(object, iteratee) {
+    const res = {};
+    for (const key in object) {
+        if (Object.prototype.hasOwnProperty.call(object, key)) {
+            res[key] = iteratee(object[key], key, object);
+        }
+    }
+    return res;
+}
+/**
+ * flattens collection using `prop` field as a children
+ * @param collectionItems collection items
+ * @param prop item property with child elements
+ */
+export function flattenByProp(collectionItems, prop) {
+    const res = [];
+    const iterate = (items) => {
+        for (const item of items) {
+            res.push(item);
+            if (item[prop]) {
+                iterate(item[prop]);
+            }
+        }
+    };
+    iterate(collectionItems);
+    return res;
+}
+export function stripTrailingSlash(path) {
+    if (path.endsWith('/')) {
+        return path.substring(0, path.length - 1);
+    }
+    return path;
+}
+export function isNumeric(value) {
+    return !isNaN(parseFloat(value)) && isFinite(value);
+}
+export function appendToMdHeading(md, heading, content) {
+    // if  heading is already in md and append to the end of it
+    const testRegex = new RegExp(`(^|\\n)#\\s?${heading}\\s*\\n`, 'i');
+    const replaceRegex = new RegExp(`((\\n|^)#\\s*${heading}\\s*(\\n|$)(?:.|\\n)*?)(\\n#|$)`, 'i');
+    if (testRegex.test(md)) {
+        return md.replace(replaceRegex, `$1\n\n${content}\n$4`);
+    }
+    else {
+        // else append heading itself
+        const br = md === '' || md.endsWith('\n\n') ? '' : md.endsWith('\n') ? '\n' : '\n\n';
+        return `${md}${br}# ${heading}\n\n${content}`;
+    }
+}
+export const isArrayOfObjects = (items) => {
+    return Array.isArray(items) && items.some((item) => isObject(item));
+};
+export const deleteEmptyArrayItem = (items) => {
+    return items.filter((item) => !!item);
+};
+export const isMergeableObject = (item) => {
+    return isObject(item) && !Array.isArray(item);
+};
+export function isAbsoluteUrl(url) {
+    return /(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(url);
+}
+/**
+ * simple resolve URL which doesn't break on strings with url fragments
+ * e.g. resolveUrl('http://test.com:{port}', 'path') results in http://test.com:{port}/path
+ */
+export function resolveUrl(url, to) {
+    let res;
+    if (to.startsWith('//')) {
+        res = `${urlParse(url, true)?.protocol || 'https:'}${to}`;
+    }
+    else if (isAbsoluteUrl(to)) {
+        res = to;
+    }
+    else if (!to.startsWith('/')) {
+        res = stripTrailingSlash(url) + '/' + to;
+    }
+    else {
+        const parsedUrl = urlParse(url);
+        if (parsedUrl) {
+            parsedUrl.pathname = to;
+            res = parsedUrl.toString();
+        }
+        else {
+            res = to;
+        }
+    }
+    return stripTrailingSlash(res);
+}
+export function titleize(text) {
+    return text.charAt(0).toUpperCase() + text.slice(1);
+}
+export function removeQueryStringAndHash(serverUrl) {
+    try {
+        if (!serverUrl) {
+            return '';
+        }
+        const url = new URL(serverUrl);
+        url.search = '';
+        url.hash = '';
+        return url.toString();
+    }
+    catch {
+        // when using with redoc-cli serverUrl can be empty resulting in crash
+        return serverUrl;
+    }
+}
+export function escapeHTMLAttrChars(str) {
+    return str.replace(/["\\]/g, '\\$&');
+}
+export function unescapeHTMLChars(str) {
+    return str
+        .replace(/&#(\d+);/g, (_m, code) => String.fromCharCode(parseInt(code, 10)))
+        .replace(/&amp;/g, '&')
+        .replace(/&quot;/g, '"');
+}
+export function sanitizeItemId(id) {
+    // we probably need to replace other symbols too
+    return id && id.replace(/#/g, '_').toLowerCase();
+}
+export function useSchemaTitle(pointer, title) {
+    return title || (isNamedDefinition(pointer) && JsonPointer.baseName(pointer)) || '';
+}
+export function get(object = {}, path, defval) {
+    if (typeof path === 'string')
+        path = path.split('.');
+    return path.reduce((xs, x) => (xs && xs[x] ? xs[x] : defval), object);
+}
+export function joinStringFactory(separator) {
+    return (...args) => args.filter(Boolean).join(separator);
+}
+export const dottedString = joinStringFactory('.');
+export function getWindowReferenceOptions(option) {
+    return IS_BROWSER ? window?.REFERENCE_DOCS_OPTIONS?.[option] : null;
+}
+export function getJsUrl() {
+    if (!IS_BROWSER) {
+        return '';
+    }
+    const id = +new Date() + Math.random();
+    try {
+        if (!document.currentScript || // IE doesn't have currentScript
+            !(document.currentScript.async ||
+                document.currentScript.defer)) {
+            // write empty script to the document. It will get placed directly after the current script
+            document.write(`<script id="dummy${id}"></script>`);
+        }
+        // find appended script and return src of the previous script which is the current script
+        return (document.getElementById('dummy' + id)?.previousSibling).src;
+    }
+    catch {
+        return '';
+    }
+}
+export const normalizeText = (text) => isString(text) ? text : text?.raw;
+export const getValueFromMdParsedExtension = (item, key) => {
+    const value = item?.[`x-parsed-md-${key}`] || item?.[key];
+    if (!value) {
+        return;
+    }
+    if (!item?.[`x-parsed-md-${key}`] && key !== 'x-enumDescriptions') {
+        return item?.[key];
+    }
+    if (key !== 'x-enumDescriptions') {
+        return normalizeMarkdownValue(item, key);
+    }
+    let result = {};
+    for (const property in value) {
+        if (property.startsWith('x-parsed-md')) {
+            continue;
+        }
+        result[property] = value?.[`x-parsed-md-${property}`] || value?.[property];
+    }
+    if (Object.keys(result).length) {
+        return result;
+    }
+    return value;
+};
+// We need to normalize the value when running inside Realm which parses md to markdoc AST.
+// The value can be a string or an object with result property (which contains AST)
+function normalizeMarkdownValue(item, key) {
+    const value = item?.[`x-parsed-md-${key}`] || item?.[key];
+    if (value?.raw) {
+        return value;
+    }
+    return {
+        result: value?.result || item?.[key]?.result || item?.[key],
+        raw: item?.[key],
+    };
+}
+export function isLastInArray(arr, index) {
+    return index === arr.length - 1;
+}
+export function isLastProperty(obj, key) {
+    const objectKeys = Object.keys(obj);
+    return objectKeys.indexOf(key) === objectKeys.length - 1;
+}
+//# sourceMappingURL=helpers.js.map

package/lib/utils/index.js

@@ -1 +1,25 @@
-export*from"./JsonPointer.js";export*from"./openapi.js";export*from"./helpers.js";export*from"./dom.js";export*from"./debug.js";export*from"./sort.js";export*from"./argValuesHelpers.js";export*from"./theme-helpers.js";export*from"./debounce.js";export*from"./security-details.js";export*from"./session-storage.js";export*from"./local-storage.js";export*from"./parameters.js";export*from"./string.js";export*from"./test-utils.js";export*from"./compose.js";export*from"./saveTextBeforeHeading.js";export*from"./path.js";export*from"./queryString.js";export*from"./isMobile.js";export*from"./replaceVariables.js";export*from"./areArraysEqual.js";export*from"./configure-helpers.js";export*from"./telemetry.js";
+export * from './JsonPointer.js';
+export * from './openapi.js';
+export * from './helpers.js';
+export * from './dom.js';
+export * from './debug.js';
+export * from './sort.js';
+export * from './argValuesHelpers.js';
+export * from './theme-helpers.js';
+export * from './debounce.js';
+export * from './security-details.js';
+export * from './session-storage.js';
+export * from './local-storage.js';
+export * from './parameters.js';
+export * from './string.js';
+export * from './test-utils.js';
+export * from './compose.js';
+export * from './saveTextBeforeHeading.js';
+export * from './path.js';
+export * from './queryString.js';
+export * from './isMobile.js';
+export * from './replaceVariables.js';
+export * from './areArraysEqual.js';
+export * from './configure-helpers.js';
+export * from './telemetry.js';
+//# sourceMappingURL=index.js.map

package/lib/utils/isMobile.js

@@ -1 +1,13 @@
-function s(e={}){const o=/(android|bb\d+|meego).+mobile|armv7l|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series[46]0|samsungbrowser.*mobile|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i,i=/CrOS/,n=/android|ipad|playbook|silk/i,a=o.test(navigator.userAgent)&&!i.test(navigator.userAgent),t=e.tablet&&n.test(navigator.userAgent),r=e.tablet&&navigator.maxTouchPoints>1&&navigator.userAgent.indexOf("Macintosh")!==-1&&navigator.userAgent.indexOf("Safari")!==-1;return!!(a||t||r)}export{s as isMobile};
+export function isMobile(opts = {}) {
+    const mobileRE = /(android|bb\d+|meego).+mobile|armv7l|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series[46]0|samsungbrowser.*mobile|symbian|treo|up\.(browser|link)|vodafone|wap|windows (ce|phone)|xda|xiino/i;
+    const notMobileRE = /CrOS/;
+    const tabletRE = /android|ipad|playbook|silk/i;
+    const isMobileUserAgent = mobileRE.test(navigator.userAgent) && !notMobileRE.test(navigator.userAgent);
+    const isTabletUserAgent = opts.tablet && tabletRE.test(navigator.userAgent);
+    const isMacSafariTablet = opts.tablet &&
+        navigator.maxTouchPoints > 1 &&
+        navigator.userAgent.indexOf('Macintosh') !== -1 &&
+        navigator.userAgent.indexOf('Safari') !== -1;
+    return !!(isMobileUserAgent || isTabletUserAgent || isMacSafariTablet);
+}
+//# sourceMappingURL=isMobile.js.map

package/lib/utils/loadAndBundleSpec.js

@@ -1 +1,32 @@
-import{bundle as s,Config as r}from"@redocly/openapi-core";import{IS_BROWSER as i}from"@redocly/theme/core/openapi";import{convertSwagger2OpenAPI as f}from"./convertSwagger2OpenAPI.js";async function l(o){const t=new r({}),e={config:t,base:i?window.location.origin:typeof globalThis.process<"u"?globalThis.process.cwd():""};i&&(t.resolve.http.customFetch=globalThis.fetch),typeof o=="object"&&o!==null?e.doc=a(o):e.ref=o;const{bundle:{parsed:n}}=await s(e);return n.swagger!==void 0?f(n):n}function a(o){return{source:{absoluteRef:""},parsed:o}}export{l as loadAndBundleDefinition};
+import { bundle, Config } from '@redocly/openapi-core';
+import { IS_BROWSER } from '@redocly/theme/core/openapi';
+import { convertSwagger2OpenAPI } from './convertSwagger2OpenAPI.js';
+export async function loadAndBundleDefinition(specUrlOrObject) {
+    const config = new Config({});
+    const bundleOpts = {
+        config,
+        base: IS_BROWSER
+            ? window.location.origin
+            : typeof globalThis.process !== 'undefined'
+                ? globalThis.process.cwd()
+                : '',
+    };
+    if (IS_BROWSER) {
+        config.resolve.http.customFetch = globalThis.fetch;
+    }
+    if (typeof specUrlOrObject === 'object' && specUrlOrObject !== null) {
+        bundleOpts['doc'] = createParsedDocument(specUrlOrObject);
+    }
+    else {
+        bundleOpts['ref'] = specUrlOrObject;
+    }
+    const { bundle: { parsed }, } = await bundle(bundleOpts);
+    return parsed.swagger !== undefined ? convertSwagger2OpenAPI(parsed) : parsed;
+}
+function createParsedDocument(specUrlOrObject) {
+    return {
+        source: { absoluteRef: '' },
+        parsed: specUrlOrObject,
+    };
+}
+//# sourceMappingURL=loadAndBundleSpec.js.map

package/lib/utils/local-storage.js

@@ -1 +1,12 @@
-import{IS_BROWSER as t}from"@redocly/theme/core/openapi";function a(o,r){t&&window.localStorage.setItem("redoc."+o,r)}function c(o){return t&&window.localStorage.getItem("redoc."+o)||""}export{c as fromLocalStorage,a as toLocalStorage};
+import { IS_BROWSER } from '@redocly/theme/core/openapi';
+export function toLocalStorage(key, value) {
+    if (IS_BROWSER) {
+        window.localStorage.setItem('redoc.' + key, value);
+    }
+}
+export function fromLocalStorage(key) {
+    if (!IS_BROWSER)
+        return '';
+    return (window.localStorage.getItem('redoc.' + key) || '');
+}
+//# sourceMappingURL=local-storage.js.map

package/lib/utils/object.js

@@ -1 +1,31 @@
-function o(t,e){let r=e;return typeof e=="string"&&(r=e.split(".")),r.every(n=>typeof t!="object"||t===null||!(n in t)?!1:(t=t[n],!0))}function u(t,e,r){let n=e;typeof e=="string"&&(n=e.split("."));const f=n.length-1;for(let i=0;i<f;++i){const s=n[i];t=t[s]??(t[s]={})}const l=n[f];t[l]=r}function p(t,e){return Object.fromEntries(Object.entries(t).map(([r,n])=>[r,e(n,r)]))}export{p as mapObject,o as objectHas,u as objectSet};
+export function objectHas(object, path) {
+    let _path = path;
+    if (typeof path === 'string') {
+        _path = path.split('.');
+    }
+    return _path.every((key) => {
+        if (typeof object != 'object' || object === null || !(key in object))
+            return false;
+        object = object[key];
+        return true;
+    });
+}
+export function objectSet(object, path, value) {
+    let _path = path;
+    if (typeof path === 'string') {
+        _path = path.split('.');
+    }
+    const limit = _path.length - 1;
+    for (let i = 0; i < limit; ++i) {
+        const key = _path[i];
+        object = object[key] ?? (object[key] = {});
+    }
+    const key = _path[limit];
+    object[key] = value;
+}
+export function mapObject(obj, fn) {
+    return Object.fromEntries(Object.entries(obj).map(([key, val]) => {
+        return [key, fn(val, key)];
+    }));
+}
+//# sourceMappingURL=object.js.map