@redocly/config 0.5.0 → 0.6.0

package/lib/redoc-config-schema.js

@@ -0,0 +1,185 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.redocConfigSchema = void 0;
+const codeSamplesConfigSchema = {
+    type: 'object',
+    properties: {
+        languages: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    lang: {
+                        type: 'string',
+                        enum: [
+                            'curl',
+                            'JavaScript',
+                            'Node.js',
+                            'Python',
+                            'Java8+Apache',
+                            'Java',
+                            'C#',
+                            'C#+Newtonsoft',
+                            'PHP',
+                            'Go',
+                            'Ruby',
+                            'R',
+                            'Payload',
+                        ],
+                    },
+                    label: { type: 'string' },
+                    options: {
+                        type: 'object',
+                        properties: {
+                            indent: { type: 'string' },
+                            withImports: { type: 'boolean' },
+                            withComments: { type: 'boolean' },
+                            binary: { type: 'boolean' },
+                            credentials: {
+                                type: 'string',
+                                enum: ['omit', 'same-origin', 'include'],
+                            },
+                        },
+                        additionalProperties: false,
+                    },
+                },
+                required: ['lang'],
+                additionalProperties: false,
+            },
+        },
+        skipOptionalParameters: { type: 'boolean' },
+        withOAuth2Call: { type: 'boolean' },
+    },
+    required: ['languages'],
+    additionalProperties: false,
+};
+const downloadUrlsSchema = {
+    type: 'array',
+    items: {
+        type: 'object',
+        properties: {
+            title: { type: 'string' },
+            url: { type: 'string' },
+        },
+        required: ['url'],
+        additionalProperties: false,
+    },
+};
+exports.redocConfigSchema = {
+    type: 'object',
+    properties: {
+        licenseKey: { type: 'string' },
+        hideLoading: { type: 'boolean' },
+        disableRouter: { type: 'boolean' },
+        hideSidebar: { type: 'boolean' },
+        feedback: {
+            type: 'object',
+            properties: {
+                hide: {
+                    type: 'boolean',
+                    default: false,
+                },
+                type: {
+                    type: 'string',
+                    enum: ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'],
+                    default: 'sentiment',
+                },
+                settings: {
+                    type: 'object',
+                    properties: {
+                        label: { type: 'string' },
+                        submitText: { type: 'string' },
+                        buttonText: { type: 'string' },
+                        component: {
+                            type: 'string',
+                            enum: ['radio', 'checkbox'],
+                            default: 'checkbox',
+                        },
+                        items: { type: 'array', items: { type: 'string' }, minItems: 1 },
+                        leftScaleLabel: { type: 'string' },
+                        rightScaleLabel: { type: 'string' },
+                        reasons: {
+                            type: 'object',
+                            properties: {
+                                hide: {
+                                    type: 'boolean',
+                                    default: false,
+                                },
+                                component: {
+                                    type: 'string',
+                                    enum: ['radio', 'checkbox'],
+                                    default: 'checkbox',
+                                },
+                                label: { type: 'string' },
+                                items: { type: 'array', items: { type: 'string' } },
+                            },
+                            additionalProperties: false,
+                        },
+                        comment: {
+                            type: 'object',
+                            properties: {
+                                hide: {
+                                    type: 'boolean',
+                                    default: false,
+                                },
+                                label: { type: 'string' },
+                                likeLabel: { type: 'string' },
+                                dislikeLabel: { type: 'string' },
+                                satisfiedLabel: { type: 'string' },
+                                neutralLabel: { type: 'string' },
+                                dissatisfiedLabel: { type: 'string' },
+                            },
+                            additionalProperties: false,
+                        },
+                    },
+                    additionalProperties: false,
+                },
+            },
+            additionalProperties: false,
+            default: null,
+            nullable: true,
+        },
+        hideReplay: { type: 'boolean' },
+        oAuth2RedirectURI: { type: 'string', nullable: true },
+        corsProxyUrl: { type: 'string' },
+        sortRequiredPropsFirst: { type: 'boolean' },
+        sanitize: { type: 'boolean' },
+        hideDownloadButtons: { type: 'boolean' },
+        downloadUrls: downloadUrlsSchema,
+        onlyRequiredInSamples: { type: 'boolean' },
+        generatedSamplesMaxDepth: { oneOf: [{ type: 'number' }, { type: 'string' }] },
+        showExtensions: {
+            oneOf: [
+                { type: 'boolean' },
+                { type: 'string' },
+                { type: 'array', items: { type: 'string' } },
+            ],
+        },
+        hideSchemaTitles: { type: 'boolean' },
+        jsonSamplesExpandLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
+        schemasExpansionLevel: { oneOf: [{ type: 'number' }, { type: 'string' }] },
+        mockServer: {
+            type: 'object',
+            properties: {
+                url: { type: 'string' },
+                position: { enum: ['first', 'last', 'replace', 'off'] },
+                description: { type: 'string' },
+            },
+        },
+        maxDisplayedEnumValues: { type: 'number' },
+        schemaDefinitionsTagName: { type: 'string' },
+        layout: { type: 'string', enum: ['stacked', 'three-panel'] },
+        hideInfoMetadata: { type: 'boolean' },
+        events: { type: 'object' },
+        skipBundle: { type: 'boolean' },
+        routingBasePath: { type: 'string' },
+        codeSamples: codeSamplesConfigSchema,
+        ignoreNamedSchemas: {
+            oneOf: [{ type: 'array', items: { type: 'string' } }, { type: 'string' }],
+        },
+        hidePropertiesPrefix: { type: 'boolean' },
+        excludeFromSearch: { type: 'boolean' },
+    },
+    additionalProperties: false,
+};
+//# sourceMappingURL=redoc-config-schema.js.map

package/lib/redoc-config-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redoc-config-schema.js","sourceRoot":"","sources":["../src/redoc-config-schema.ts"],"names":[],"mappings":";;;AAAA,MAAM,uBAAuB,GAAG;IAC9B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,SAAS,EAAE;YACT,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE;wBACJ,IAAI,EAAE,QAAQ;wBACd,IAAI,EAAE;4BACJ,MAAM;4BACN,YAAY;4BACZ,SAAS;4BACT,QAAQ;4BACR,cAAc;4BACd,MAAM;4BACN,IAAI;4BACJ,eAAe;4BACf,KAAK;4BACL,IAAI;4BACJ,MAAM;4BACN,GAAG;4BACH,SAAS;yBACV;qBACF;oBACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACzB,OAAO,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACV,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;4BAC1B,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;4BAChC,YAAY,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;4BACjC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;4BAC3B,WAAW,EAAE;gCACX,IAAI,EAAE,QAAQ;gCACd,IAAI,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,SAAS,CAAC;6BACzC;yBACF;wBACD,oBAAoB,EAAE,KAAK;qBAC5B;iBACF;gBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;gBAClB,oBAAoB,EAAE,KAAK;aAC5B;SACF;QACD,sBAAsB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3C,cAAc,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;KACpC;IACD,QAAQ,EAAE,CAAC,WAAW,CAAC;IACvB,oBAAoB,EAAE,KAAK;CACnB,CAAC;AAEX,MAAM,kBAAkB,GAAG;IACzB,IAAI,EAAE,OAAO;IACb,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACzB,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;SACxB;QACD,QAAQ,EAAE,CAAC,KAAK,CAAC;QACjB,oBAAoB,EAAE,KAAK;KAC5B;CACO,CAAC;AAEE,QAAA,iBAAiB,GAAG;IAC/B,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC9B,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAChC,aAAa,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAClC,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAChC,QAAQ,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,IAAI,EAAE;oBACJ,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,KAAK;iBACf;gBACD,IAAI,EAAE;oBACJ,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC;oBACpE,OAAO,EAAE,WAAW;iBACrB;gBACD,QAAQ,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACzB,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBAC9B,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBAC9B,SAAS,EAAE;4BACT,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC;4BAC3B,OAAO,EAAE,UAAU;yBACpB;wBACD,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE;wBAChE,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBAClC,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;wBACnC,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,IAAI,EAAE;oCACJ,IAAI,EAAE,SAAS;oCACf,OAAO,EAAE,KAAK;iCACf;gCACD,SAAS,EAAE;oCACT,IAAI,EAAE,QAAQ;oCACd,IAAI,EAAE,CAAC,OAAO,EAAE,UAAU,CAAC;oCAC3B,OAAO,EAAE,UAAU;iCACpB;gCACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCACzB,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;6BACpD;4BACD,oBAAoB,EAAE,KAAK;yBAC5B;wBACD,OAAO,EAAE;4BACP,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,IAAI,EAAE;oCACJ,IAAI,EAAE,SAAS;oCACf,OAAO,EAAE,KAAK;iCACf;gCACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCACzB,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCAC7B,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCAChC,cAAc,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCAClC,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gCAChC,iBAAiB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;6BACtC;4BACD,oBAAoB,EAAE,KAAK;yBAC5B;qBACF;oBACD,oBAAoB,EAAE,KAAK;iBAC5B;aACF;YACD,oBAAoB,EAAE,KAAK;YAC3B,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;SACf;QACD,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC/B,iBAAiB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACrD,YAAY,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAChC,sBAAsB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3C,QAAQ,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC7B,mBAAmB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACxC,YAAY,EAAE,kBAAkB;QAChC,qBAAqB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC1C,wBAAwB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE;QAC7E,cAAc,EAAE;YACd,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,SAAS,EAAE;gBACnB,EAAE,IAAI,EAAE,QAAQ,EAAE;gBAClB,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;aAC7C;SACF;QACD,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,sBAAsB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE;QAC3E,qBAAqB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,EAAE;QAC1E,UAAU,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACvB,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE;gBACvD,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aAChC;SACF;QACD,sBAAsB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1C,wBAAwB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC5C,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,SAAS,EAAE,aAAa,CAAC,EAAE;QAC5D,gBAAgB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACrC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,UAAU,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC/B,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACnC,WAAW,EAAE,uBAAuB;QACpC,kBAAkB,EAAE;YAClB,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;SAC1E;QACD,oBAAoB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QACzC,iBAAiB,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;KACvC;IACD,oBAAoB,EAAE,KAAK;CACnB,CAAC"}

package/lib/redoc-types.d.ts

@@ -0,0 +1,84 @@
+import type { ReactElement, ComponentType } from 'react';
+import type { FromSchema } from 'json-schema-to-ts';
+import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
+import type { redocConfigSchema } from './redoc-config-schema';
+export type RedocConfigTypes = FromSchema<typeof redocConfigSchema> & {
+    markdocOptions?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
+    onDeepLinkClick?: ((link: string) => void) | undefined | null;
+    unstable_hooks?: HooksConfig;
+    requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
+    unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
+    scrollYOffset?: number | string | (() => number);
+};
+type HooksConfig = {
+    AfterApiTitle?: HookConfig<{
+        info: OpenAPIInfo;
+    }>;
+    BeforeOperation?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    BeforeOperationSummary?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    AfterOperationSummary?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    AfterOperation?: HookConfig<{
+        operation: OperationModel;
+    }>;
+    onInit?: (args: {
+        store: Record<string, any>;
+    }) => void;
+    replaceSecurityLink?: (args: {
+        securityRequirementId: string;
+    }) => string;
+    sanitize?: (raw: string) => string;
+    MiddlePanelFooter?: HookConfig<undefined>;
+    MiddlePanelHeader?: HookConfig<undefined>;
+};
+type OpenAPIInfo = {
+    title: string;
+    version: string;
+    description?: string;
+    summary?: string;
+    termsOfService?: string;
+    contact?: Record<string, any>;
+    license?: Record<string, any>;
+    'x-logo'?: Record<string, any>;
+    'x-metadata'?: Record<string, any>;
+    'x-seo'?: Record<string, any>;
+};
+type HookResult = ReactElement | {
+    html: string;
+} | null;
+type HookConfig<T> = (props: T) => HookResult;
+type Unstable_ExternalCodeSample = {
+    get: (source: ExternalSource) => string;
+    lang: string;
+    label?: string;
+};
+type ExternalSource = {
+    sample: Unstable_ExternalCodeSample;
+    operation: OperationModel;
+    exampleName?: string;
+    pathParams?: any;
+    properties?: any;
+};
+type OperationModel = {
+    id: string;
+    name: string;
+    description?: string | Record<string, any>;
+    href: string;
+    pointer: string;
+    httpVerb: string;
+    deprecated: boolean;
+    path: string;
+};
+export {};

package/lib/redoc-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=redoc-types.js.map

package/lib/redoc-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redoc-types.js","sourceRoot":"","sources":["../src/redoc-types.ts"],"names":[],"mappings":""}

package/lib/remove-property-recursively.d.ts

@@ -0,0 +1,5 @@
+type Removed<T, Drop> = T extends Record<string, any> ? T extends ArrayLike<any> ? Array<Removed<T[number], Drop>> : {
+    [K in Exclude<keyof T, Drop>]: Removed<T[K], Drop>;
+} : T;
+export declare function removePropertyRecursively<TObject extends object, TProp extends string>(object: TObject, propToRemove: TProp): Removed<TObject, TProp>;
+export {};

package/lib/remove-property-recursively.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removePropertyRecursively = void 0;
+function removePropertyRecursively(object, propToRemove) {
+    return Object.fromEntries(Object.entries(object)
+        .map(([key, value]) => {
+        if (key === propToRemove) {
+            return undefined;
+        }
+        if (typeof value !== 'object' || !value) {
+            return [key, value];
+        }
+        if (Array.isArray(value)) {
+            return [
+                key,
+                value.map((arrayItem) => typeof arrayItem === 'object'
+                    ? removePropertyRecursively(arrayItem, propToRemove)
+                    : arrayItem),
+            ];
+        }
+        return [key, removePropertyRecursively(value, propToRemove)];
+    })
+        .filter(Boolean));
+}
+exports.removePropertyRecursively = removePropertyRecursively;
+//# sourceMappingURL=remove-property-recursively.js.map

package/lib/remove-property-recursively.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-property-recursively.js","sourceRoot":"","sources":["../src/remove-property-recursively.ts"],"names":[],"mappings":";;;AAQA,SAAgB,yBAAyB,CACvC,MAAe,EACf,YAAmB;IAEnB,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;SACnB,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;QACpB,IAAI,GAAG,KAAK,YAAY,EAAE;YACxB,OAAO,SAAS,CAAC;SAClB;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE;YACvC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACrB;QAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YACxB,OAAO;gBACL,GAAG;gBACH,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CACtB,OAAO,SAAS,KAAK,QAAQ;oBAC3B,CAAC,CAAC,yBAAyB,CAAC,SAAS,EAAE,YAAY,CAAC;oBACpD,CAAC,CAAC,SAAS,CACd;aACF,CAAC;SACH;QAED,OAAO,CAAC,GAAG,EAAE,yBAAyB,CAAC,KAAgC,EAAE,YAAY,CAAC,CAAC,CAAC;IAC1F,CAAC,CAAC;SACD,MAAM,CAAC,OAAO,CAAwB,CACf,CAAC;AAC/B,CAAC;AA9BD,8DA8BC"}