@redocly/openapi-docs 3.11.0-next.9 → 3.11.0-rc.1

package/lib-esm/models/types.d.ts

@@ -0,0 +1,265 @@
+import type { REDOCLY_TEAMS_RBAC } from '@redocly/config';
+import type { Node } from '@markdoc/markdoc';
+import type { OpenAPISecurityScheme, OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterLocation, OpenAPIParameterStyle, OpenAPIExternalDocumentation, OpenAPIServer, OpenAPIXCodeSample, OpenAPIXBadges, OpenAPISchema, Referenced, OpenAPIInfo } from '../types';
+import type { OpenAPIParser } from '../services/OpenAPIParser';
+import type { Options } from '../services/config-options';
+import type { ExtendedOpenAPIOperation, MenuItemGroupType, MenuItemType, MergedOpenAPISchema, Unstable_ExternalCodeSample } from '../services/types';
+export type ContentItemModel = GroupModel | OperationMenuItem;
+export interface SecurityCredentials {
+    'x-defaultClientId'?: string;
+    'x-defaultClientSecret'?: string;
+    'x-defaultUsername'?: string;
+    'x-defaultPassword'?: string;
+    'x-defaultAccessToken'?: string;
+    'x-defaultTokenType'?: string;
+    scopes?: string[];
+}
+export interface ExtendedOpenAPISecurityScheme extends OpenAPISecurityScheme, SecurityCredentials {
+    id: string;
+    sectionId: string;
+    scopes: string[];
+    serverUrl?: string;
+    serverValues?: {
+        [serverUrl: string]: SecurityCredentials;
+    };
+}
+export interface SecurityRequirement {
+    schemes: ExtendedOpenAPISecurityScheme[];
+}
+export interface SecurityScheme {
+    id: string;
+    sectionId: string;
+    type: OpenAPISecurityScheme['type'];
+    description: string | GenericObject;
+    apiKey?: {
+        name: string;
+        in: OpenAPISecurityScheme['in'];
+    };
+    http?: {
+        scheme: string;
+        bearerFormat?: string;
+    };
+    openId?: {
+        connectUrl: string;
+    };
+    flows: OpenAPISecurityScheme['flows'];
+}
+export type RequestBodyModel = {
+    description: string | GenericObject;
+    required?: boolean;
+    content: MediaContentModel | undefined;
+};
+export type ExampleModel = {
+    value: any;
+    rawValue: any;
+    summary?: string | GenericObject;
+    description?: string | GenericObject;
+    mime: string;
+    encoding?: {
+        [field: string]: OpenAPIEncoding;
+    };
+    serverValues?: {
+        [serverUrl: string]: {
+            value: any;
+            rawValue: any;
+        };
+    };
+};
+export type MediaTypeModel = {
+    examples?: {
+        [name: string]: ExampleModel;
+    };
+    formExamples?: {
+        [name: string]: ExampleModel;
+    };
+    schema?: SchemaModel;
+    name: string;
+    isRequestType: boolean;
+    onlyRequiredInSamples: boolean;
+    operation: OperationModel;
+};
+export type MediaContentModel = {
+    mediaTypes: MediaTypeModel[];
+    isRequestType: boolean;
+    hasSample: boolean;
+    operation: OperationModel;
+};
+export type MediaContentModelInput = {
+    parser: OpenAPIParser;
+    info: Record<string, OpenAPIMediaType>;
+    isRequestType: boolean;
+    options: Options;
+    data: {
+        operation: OperationModel;
+        type?: 'request' | 'response';
+        response?: ResponseModel;
+        absolutePointer?: string;
+    };
+};
+export type ResponseModel = {
+    content?: MediaContentModel;
+    code: string;
+    summary: string | GenericObject;
+    description: string | GenericObject;
+    type: string;
+    headers: FieldModel[];
+};
+export type FieldModel = {
+    schema: SchemaModel;
+    name: string;
+    required: boolean;
+    description: string | GenericObject;
+    example?: string;
+    examples?: Record<string, ExampleModel>;
+    deprecated: boolean;
+    in?: OpenAPIParameterLocation;
+    kind: string;
+    extensions?: GenericObject;
+    explode: boolean;
+    style?: OpenAPIParameterStyle;
+    const?: any;
+    serializationMime?: string;
+    fieldFullPath?: string;
+    deps: Deps;
+    absolutePointer?: string;
+    serverValues?: {
+        [serverUrl: string]: {
+            example?: string;
+        };
+    };
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type CallbackModel = {
+    name: string;
+    operations: OperationModel[];
+};
+export type OperationModel = {
+    id: string;
+    absoluteIdx?: number;
+    name: string;
+    description?: string | GenericObject;
+    ast?: Node[];
+    href: string;
+    type: MenuItemType;
+    parent?: GroupModel;
+    externalDocs?: OpenAPIExternalDocumentation;
+    items: ContentItemModel[];
+    depth: number;
+    pointer: string;
+    operationId?: string;
+    httpVerb: string;
+    deprecated: boolean;
+    path: string;
+    servers: OpenAPIServer[];
+    security: SecurityRequirement[];
+    extensions: GenericObject;
+    isCallback: boolean;
+    isWebhook: boolean;
+    isEvent: boolean;
+    callbackId: string;
+    requestBody?: RequestBodyModel;
+    payload?: {
+        lang: string;
+        label?: string;
+        source: string;
+        requestBodyContent?: MediaContentModel;
+    };
+    definitionSamples: OpenAPIXCodeSample[] | Unstable_ExternalCodeSample[];
+    badges: OpenAPIXBadges[];
+    hasSamples: boolean;
+    hideReplay: boolean;
+    parameters: FieldModel[];
+    responses: ResponseModel[];
+    callbacks: CallbackModel[];
+    envVariables?: {
+        values?: Record<string, string>;
+        serverValues?: {
+            [serverUrl: string]: Record<string, string>;
+        };
+    };
+};
+export type GroupModel = {
+    id: string;
+    href: string;
+    name: string;
+    description?: string | GenericObject;
+    isSchema?: boolean;
+    type: MenuItemGroupType;
+    items: ContentItemModel[];
+    ast?: Node[];
+    parent?: GroupModel;
+    externalDocs?: OpenAPIExternalDocumentation;
+    infoDefinition?: OpenAPIInfo;
+    depth: number;
+    level: number;
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type OperationMenuItem = {
+    id: string;
+    href: string;
+    name: string;
+    operationDefinition: ExtendedOpenAPIOperation;
+    depth: number;
+    items: ContentItemModel[];
+    parent?: GroupModel;
+    deprecated: boolean;
+    type: 'operation';
+    httpVerb: string;
+    path: string;
+    isWebhook: boolean;
+    operationId?: string;
+    badges?: OpenAPIXBadges[];
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type SchemaModel = {
+    operationPointer: string;
+    schemaOrRef: Referenced<OpenAPISchema>;
+    isChild: boolean;
+    refsStack: string[];
+    pointer: string;
+    absolutePointer?: string;
+    type: string | string[];
+    displayType: string;
+    typePrefix: string;
+    title: string;
+    description: string | GenericObject;
+    externalDocs?: OpenAPIExternalDocumentation;
+    isPrimitive: boolean;
+    isCircular: boolean;
+    isComplex: boolean;
+    format?: string;
+    displayFormat?: string;
+    nullable: boolean;
+    deprecated: boolean;
+    pattern?: string;
+    example?: any;
+    enum: any[];
+    default?: any;
+    readOnly: boolean;
+    writeOnly: boolean;
+    constraints: string[];
+    fields?: FieldModel[];
+    items?: SchemaModel;
+    oneOf?: SchemaModel[];
+    oneOfType: string;
+    discriminatorProp?: string;
+    rawSchema: OpenAPISchema;
+    schema: MergedOpenAPISchema;
+    extensions?: GenericObject;
+    'x-enumDescriptions'?: {
+        [name: string]: string;
+    };
+    const: any;
+    contentEncoding?: string;
+    contentMediaType?: string;
+    minItems?: number;
+    maxItems?: number;
+    [REDOCLY_TEAMS_RBAC]?: Record<string, string>;
+};
+export type Deps = {
+    parentFieldFullPath?: string;
+    operation: OperationModel;
+    type?: 'request' | 'response';
+    response?: ResponseModel;
+    in?: string;
+};

package/lib-esm/models/types.js

@@ -0,0 +1,2 @@
+export{};
+//# sourceMappingURL=types.js.map

package/lib-esm/services/OpenAPIParser.d.ts

@@ -0,0 +1,52 @@
+import type { OpenAPIRef, OpenAPIDefinition } from '../types';
+import type { MergedOpenAPISchema } from './types';
+import type { Options } from './config-options/types';
+/**
+ * Loads and keeps spec. Provides raw spec operations
+ */
+export declare function pushRef(stack: string[], ref?: string): string[];
+export declare function concatRefStacks(base: string[], stack?: string[]): string[];
+export declare class OpenAPIParser {
+    private options;
+    definitionUrl?: string;
+    definition: OpenAPIDefinition;
+    private readonly allowMergeRefs;
+    constructor(definition: OpenAPIDefinition, definitionUrl?: string, options?: Options & {
+        versionId?: string;
+    });
+    validate(spec: GenericObject): void;
+    /**
+     * get spec part by JsonPointer ($ref)
+     */
+    byRef: <T>(ref: string) => T | undefined;
+    /**
+     * checks if the object is OpenAPI reference (contains $ref property)
+     */
+    isRef<T>(obj: OpenAPIRef | T): obj is OpenAPIRef;
+    /**
+     * Resolve given reference object or return as is if it is not a reference
+     * @param obj object to dereference
+     * @param baseRefsStack
+     * @param mergeAsAllOf
+     */
+    deref<T>(obj: OpenAPIRef | T, baseRefsStack?: string[], mergeAsAllOf?: boolean, level?: number): {
+        resolved: T;
+        refsStack: string[];
+    };
+    mergeRefs<T>(ref: OpenAPIRef, resolved: T, mergeAsAllOf: boolean): T;
+    /**
+     * Merge allOf constraints.
+     * @param schema schema with allOF
+     * @param $ref pointer of the schema
+     * @param refsStack
+     * @param absolutePointer
+     */
+    mergeAllOf(schema: MergedOpenAPISchema, $ref: string | undefined, refsStack: string[], absolutePointer?: string, level?: number): MergedOpenAPISchema;
+    /**
+     * Find all derived definitions among #/components/schemas from any of $refs
+     * returns map of definition pointer to definition name
+     * @param $refs array of references to find derived from
+     */
+    findDerived($refs: string[]): Record<string, string[] | string>;
+    private hoistOneOfs;
+}

package/lib-esm/services/OpenAPIParser.js

@@ -0,0 +1,2 @@
+var __rest=this&&this.__rest||function(e,t){var i={};for(var r in e)Object.prototype.hasOwnProperty.call(e,r)&&t.indexOf(r)<0&&(i[r]=e[r]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var n=0;for(r=Object.getOwnPropertySymbols(e);n<r.length;n++)t.indexOf(r[n])<0&&Object.prototype.propertyIsEnumerable.call(e,r[n])&&(i[r[n]]=e[r[n]])}return i};import{IS_BROWSER,isObject,isString,isUndefined}from"@redocly/theme";import{tryDecodeURIComponent,getDefinitionName}from"../utils";import{JsonPointer}from"../utils/JsonPointer";import{normalizeOptions}from"./config-options/normalizeOptions";export function pushRef(e,t){return t&&e[e.length-1]!==t?[...e,t]:e}export function concatRefStacks(e,t){return t?e.concat(t):e}export class OpenAPIParser{constructor(e,t,i=normalizeOptions({})){Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:i}),Object.defineProperty(this,"definitionUrl",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"allowMergeRefs",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"byRef",{enumerable:!0,configurable:!0,writable:!0,value:e=>{let t;if(this.definition){"#"!==e.charAt(0)&&(e="#"+e),e=tryDecodeURIComponent(e);try{t=JsonPointer.get(this.definition,e)}catch(e){}return t||{}}}}),this.definition=Object.assign({},e),this.validate(e),this.definition=e,this.allowMergeRefs=e.openapi.startsWith("3.1");const r=IS_BROWSER?window.location.href:"";isString(t)&&(this.definitionUrl=new URL(t,r).href)}validate(e){if(isUndefined(e.openapi))throw new Error("Document must be valid OpenAPI 3.0.0 definition")}isRef(e){return!!e&&(void 0!==e.$ref&&null!==e.$ref)}deref(e,t=[],i=!1,r=0){const n=null==e?void 0:e["x-refsStack"];if(t=concatRefStacks(t,n),r>5)return{resolved:Object.assign({},e,{"x-complex":!0}),refsStack:t};if(this.isRef(e)){const n=getDefinitionName(e.$ref);if(n&&this.options.ignoreNamedSchemas.has(n))return{resolved:{type:"object",title:n},refsStack:t};let s=this.byRef(e.$ref);if(!s)throw new Error(`Failed to resolve $ref "${e.$ref}"`);if(t.includes(e.$ref))s=Object.assign({},s,{"x-circular-ref":!0});else if(this.isRef(s)){s=this.deref(s,t,i,r).resolved}return this.allowMergeRefs&&(s=this.mergeRefs(e,s,i)),{resolved:s,refsStack:pushRef(t,e.$ref)}}return{resolved:e,refsStack:concatRefStacks(t,n)}}mergeRefs(e,t,i){const{$ref:r}=e,n=__rest(e,["$ref"]),s=Object.keys(n);if(0===s.length)return t;if(i&&s.some((e=>!["description","title","externalDocs","x-refsStack","x-parentRefs","readOnly","writeOnly","x-complex"].includes(e)))){const e=n,{description:i,title:r,readOnly:s,writeOnly:o}=e;return{allOf:[{description:i,title:r,readOnly:s,writeOnly:o},t,__rest(e,["description","title","readOnly","writeOnly"])]}}return Object.assign(Object.assign({},t),n)}mergeAllOf(e,t,i,r="",n=0){var s;if(e["x-circular-ref"])return e;if(void 0===(e=this.hoistOneOfs(e)).allOf)return Object.assign({absolutePointer:r},e);let o=Object.assign(Object.assign({},e),{"x-parentRefs":[],absolutePointer:JsonPointer.join(r,["allOf"]),allOf:void 0,title:0===n?e.title||getDefinitionName(t):e.title});!isUndefined(o.properties)&&isObject(o.properties)&&(o.properties=Object.assign({},o.properties)),!isUndefined(o.items)&&isObject(o.items)&&(o.items=Object.assign({},o.items));const f=e.allOf.map(((e,t)=>{var s;const{resolved:f,refsStack:l}=this.deref(e,i,!0,n),a=e.$ref,c=a||JsonPointer.join(r,[String(t)]);if(f["x-complex"])return{$ref:a,refsStack:pushRef(l,a),schema:{"x-complex":!0},absolutePointer:c};const d=this.mergeAllOf(f,a,l,c,n+1);return d["x-circular-ref"]&&d.allOf?void 0:(a&&(null===(s=o["x-parentRefs"])||void 0===s||s.push(...d["x-parentRefs"]||[],a)),{$ref:a,refsStack:pushRef(l,a),schema:d,absolutePointer:c})})).filter(Boolean);for(const[e,{schema:i,refsStack:r,absolutePointer:l}]of f.entries()){const f=i||{},{type:a,enum:c,properties:d,items:p,required:O,title:u,description:m,readOnly:y,writeOnly:b,oneOf:h,anyOf:g,"x-circular-ref":x,"x-complex":j}=f,v=__rest(f,["type","enum","properties","items","required","title","description","readOnly","writeOnly","oneOf","anyOf","x-circular-ref","x-complex"]);if(o.type===a||isUndefined(o.type)||isUndefined(a)||n){if(isUndefined(a)||(Array.isArray(a)&&Array.isArray(o.type)?o.type=[...a,...o.type]:o.type=a),isUndefined(c)||(Array.isArray(c)&&Array.isArray(o.enum)?o.enum=Array.from(new Set([...c,...o.enum])):o.enum=c),!isUndefined(d)&&isObject(d)){o.properties=o.properties||{};for(const i in d){const f=concatRefStacks(r,null===(s=d[i])||void 0===s?void 0:s["x-refsStack"]);if(o.properties[i]){if(!x){const r=this.mergeAllOf({allOf:[o.properties[i],d[i]],"x-refsStack":f},t+"/properties/"+i,f,JsonPointer.join(l,["allOf",String(e),"properties",i]),n+1);o.properties[i]=r}}else o.properties[i]=Object.assign(Object.assign({},d[i]),{absolutePointer:JsonPointer.join(l,["properties",i]),"x-refsStack":f})}}if(!isUndefined(p)&&!x&&!j){const e="boolean"==typeof o.items?{}:Object.assign({},o.items),s="boolean"==typeof i.items?{}:Object.assign({},i.items);o.items=this.mergeAllOf({allOf:[e,s]},t+"/items",r,"",n+1)}isUndefined(h)||(o.oneOf=h),isUndefined(g)||(o.anyOf=g),Array.isArray(O)&&(o.required=[...o.required||[],...O]),o=Object.assign(Object.assign(Object.assign({},o),{title:o.title||u,description:o.description||m,readOnly:isUndefined(o.readOnly)?y:o.readOnly,writeOnly:isUndefined(o.writeOnly)?b:o.writeOnly,"x-circular-ref":o["x-circular-ref"]||x,"x-complex":o["x-complex"]||j}),v)}}return o}findDerived(e){const t={},i=this.definition.components&&this.definition.components.schemas||{};for(const r in i){const{resolved:n}=this.deref(i[r]);!isUndefined(n.allOf)&&n.allOf.find((t=>!isUndefined(t.$ref)&&e.indexOf(t.$ref)>-1))&&(t["#/components/schemas/"+r]=[n["x-discriminator-value"]||r])}return t}hoistOneOfs(e){if(isUndefined(e.allOf))return e;const{allOf:t}=e,i=__rest(e,["allOf"]);for(let e=0;e<t.length;e++){const r=t[e],{oneOf:n}=r,s=__rest(r,["oneOf"]);if(n&&Array.isArray(n)){const r=t.slice(0,e),o=t.slice(e+1),f=Object.keys(s).length>0?[s]:[];return Object.assign(Object.assign({},i),{oneOf:n.map((e=>({allOf:[...r,...f,e,...o]})))})}}return e}}
+//# sourceMappingURL=OpenAPIParser.js.map

package/lib-esm/services/check.d.ts

@@ -0,0 +1,13 @@
+export type LicenseInfo = {
+    t?: boolean;
+    i?: number;
+    e?: number;
+    h?: string[] | true;
+    valid?: boolean;
+    expired?: boolean;
+    allowed?: boolean;
+    local?: boolean;
+    cryptoMissing?: boolean;
+};
+export declare function isHostAllowed(hostname: string, hosts: string[] | boolean | undefined): boolean;
+export default function parse(key?: string): Promise<LicenseInfo>;

package/lib-esm/services/check.js

@@ -0,0 +1,2 @@
+var __awaiter=this&&this.__awaiter||function(t,e,n,o){return new(n||(n=Promise))((function(r,i){function a(t){try{c(o.next(t))}catch(t){i(t)}}function s(t){try{c(o.throw(t))}catch(t){i(t)}}function c(t){var e;t.done?r(t.value):(e=t.value,e instanceof n?e:new n((function(t){t(e)}))).then(a,s)}c((o=o.apply(t,e||[])).next())}))};import{cryptoLib}from"./utils";function promisifyIECryptoRes(t){return"then"in t?t:new Promise((e=>{t.oncomplete=t=>{e(t.target.result)}}))}function str2ab(t){const e=new ArrayBuffer(t.length),n=new Uint8Array(e);for(let e=0,o=t.length;e<o;e++)n[e]=t.charCodeAt(e);return e}const getKey=()=>{const t=str2ab(atob("undefined"!=typeof REDOCLY_PUBLIC_KEY?REDOCLY_PUBLIC_KEY:"MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAMHjNir5fXx/ZXoaEeXQ5XyxbNJ4YJYczoCRdSkL6NLzw1FHnng5Vfcgk5+bvox9QRYRbuk84mA4f2NhywDbXKECAwEAAQ=="));return promisifyIECryptoRes(null==cryptoLib?void 0:cryptoLib.subtle.importKey("spki",t,{name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},!0,["verify"]))};function textEncode(t){if(window.TextEncoder)return(new TextEncoder).encode(t);const e=unescape(encodeURIComponent(t)),n=new Uint8Array(e.length);for(let t=0;t<e.length;t++)n[t]=e.charCodeAt(t);return n}function verify(t,e){return __awaiter(this,void 0,void 0,(function*(){return promisifyIECryptoRes(null==cryptoLib?void 0:cryptoLib.subtle.verify({name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},yield getKey(),str2ab(atob(e)),textEncode(t)))}))}export function isHostAllowed(t,e){return!0===e||!(!Array.isArray(e)||"undefined"==typeof window)&&(!("localhost"!==t&&"127.0.0.1"!==t&&!t.endsWith(".localhost")&&!e.find((e=>e===t||t.endsWith("."+e))))||!!e.find((e=>{if(e.indexOf("*")!==e.lastIndexOf("*"))return;const[n,o]=e.split("*");return o&&t.startsWith(n)&&t.endsWith(o)&&o.split(".").length>2})))}export default function parse(t){return __awaiter(this,void 0,void 0,(function*(){if("development"===process.env.NODE_ENV)return{valid:!0,allowed:!0};const e=window.location.hostname;if(!t)return"localhost"===e||"127.0.0.1"===e||e.endsWith(".localhost")?{local:!0}:{};const[n,o]=t.split(".");let r;try{if(!(yield verify(atob(n),o)))return{valid:!1};r=JSON.parse(atob(n))}catch(t){return{valid:!1,cryptoMissing:!0}}return r.valid=!0,(!r.e||Date.now()/1e3>r.e)&&(r.expired=!0),r.allowed=isHostAllowed(e,r.h),r}))}
+//# sourceMappingURL=check.js.map

package/lib-esm/services/code-samples/constants.d.ts

@@ -0,0 +1,2 @@
+import type { Languages as LanguagesType } from './types';
+export declare const Languages: Record<string, LanguagesType | 'Payload'>;

package/lib-esm/services/code-samples/constants.js

@@ -0,0 +1,2 @@
+export const Languages={curl:"curl",JavaScript:"JavaScript",NodeJs:"Node.js",Python:"Python",Java:"Java",CSharp:"C#",PHP:"PHP",Go:"Go",Ruby:"Ruby",R:"R",Payload:"Payload"};
+//# sourceMappingURL=constants.js.map

package/lib-esm/services/code-samples/generator.d.ts

@@ -0,0 +1,29 @@
+import type { OperationModel } from '../../models';
+import type * as HAR from './har';
+import type { Languages } from './types';
+import type { TFunction } from '@redocly/theme';
+export type CustomHAR = HAR.Request & {
+    securityOAuth2ExtraCalls?: HAR.Request[];
+    basicAuth?: {
+        username: string;
+        password: string;
+    };
+    pathParameters?: {
+        [key in string]: string;
+    };
+    serverVariables?: Record<string, string>;
+    allResponseCodes?: string[];
+};
+export declare function getCodeSample({ lang, operation, exampleName, pathParams, properties, options, environment, translate, }: {
+    lang: Languages;
+    operation: OperationModel;
+    exampleName?: string;
+    pathParams?: GenericObject;
+    properties?: GenericObject;
+    options?: GenericObject;
+    environment: Record<string, string>;
+    translate: TFunction;
+}): string;
+export declare function getDataRequest(exampleValue: any, properties: any): boolean | any;
+export declare function isDefined<T>(arg?: T): arg is T;
+export declare function capitalizeFirst(str: string): string;

package/lib-esm/services/code-samples/generator.js

@@ -0,0 +1,2 @@
+import*as Sampler from"openapi-sampler";import merge from"deepmerge";import{isObject}from"@redocly/theme";import{areArraysEqual,serializeParameterValue,getSecurityDetails,getParameterValue,queryString,isArrayOfObjects,deleteEmptyArrayItem}from"../../utils";import{normalizeMimeType,arrayMergeStrategy}from"../utils";import{MediaTypes}from"../../constants";import{HTTPSnippet}from"./httpsnippet";import{getActiveMediaType}from"../../models/mediaContent";import StringUtility from"./httpsnippet/helpers/string-utility";function getSelectedSecurityScheme(e,t){return e.find((e=>{const a=e.schemes.map((e=>e.id));return areArraysEqual(a,t||[])}))}function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:i,generatedPayloadSamplesMaxDepth:s=8,pathParams:n={},properties:l={},activeMimeName:o=""},{environment:u,requestValues:c,activeSecuritySchemeIds:p}){var d,m,v,f,y,h,g,O;const S=u.server,T=e.servers.find((e=>e.url===S))||e.servers[0],b=getSelectedSecurityScheme(e.security,p),{securityHeaders:_,securityCookies:C,securityQueries:j,securityOAuth2ExtraCalls:k,basicAuth:x}=getSecurityData(b||(null===(d=e.security)||void 0===d?void 0:d[0]),r,u),A=(null===(m=null==e?void 0:e.requestBody)||void 0===m?void 0:m.content)&&getActiveMediaType(e.requestBody.content,o),E={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s,quiet:!0},w=c;let P=!1;const M=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t,a,r;return{name:e.name,value:(null===(t=w.header)||void 0===t?void 0:t[e.name])||getParameterValue("header",e.name)||(null===(r=null===(a=e.serverValues)||void 0===a?void 0:a[S])||void 0===r?void 0:r.example)||e.example||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,E,i))}})).map((e=>((null==A?void 0:A.name)&&"content-type"===e.name.toLowerCase()&&(P=!0,e.value=A.name),e))).concat(_);!P&&(null==A?void 0:A.name)&&M.unshift({name:"Content-Type",value:null==A?void 0:A.name});const R=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t,a;return queryString.parse(serializeParameterValue(e,(null===(a=null===(t=e.serverValues)||void 0===t?void 0:t[S])||void 0===a?void 0:a.example)||e.example||Sampler.sample(e.schema.rawSchema,E,i)))})).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=w.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(C),D=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t,a;return queryString.parse(serializeParameterValue(e,(null===(a=null===(t=e.serverValues)||void 0===t?void 0:t[S])||void 0===a?void 0:a.example)||e.example||Sampler.sample(e.schema.rawSchema,E,i)))})).reduce(((e,t)=>{var a,r,i;for(const[s,n]of Object.entries(t))e.push({name:s,value:isArrayOfObjects(null===(a=w.query)||void 0===a?void 0:a[s])&&JSON.stringify(deleteEmptyArrayItem(null===(r=w.query)||void 0===r?void 0:r[s]))||String((null===(i=w.query)||void 0===i?void 0:i[s])||n)});return e}),[]).concat(j),N=`${null==T?void 0:T.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,q=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a,r,i;const{in:s,name:l}=t;return e[l]=(null===(a=w.path)||void 0===a?void 0:a[l])||(null===(i=null===(r=t.serverValues)||void 0===r?void 0:r[S])||void 0===i?void 0:i.example)||t.example||n[l]||getParameterValue(s,l),e}),{}),H=null==A?void 0:A.name.toLowerCase(),U=H===MediaTypes.MULTIPART||H===MediaTypes.URL_ENCODED,V=U?null===(v=null==A?void 0:A.formExamples)||void 0===v?void 0:v[t]:null===(f=null==A?void 0:A.examples)||void 0===f?void 0:f[t],I=U?(null==A?void 0:A.formExamples)||{}:(null==A?void 0:A.examples)||{},[L]=Object.values(I),$=(null===(h=null===(y=null==V?void 0:V.serverValues)||void 0===y?void 0:y[S])||void 0===h?void 0:h.value)||(null===(O=null===(g=null==L?void 0:L.serverValues)||void 0===g?void 0:g[S])||void 0===O?void 0:O.value),z=e=>{var t;return e&&"object"==typeof e&&(null===(t=null==A?void 0:A.schema)||void 0===t?void 0:t.rawSchema)?Sampler.sample(populateXmlSchemaFields(A.schema.rawSchema,e),Object.assign(Object.assign({},E),{format:"xml"}),i):null},J=(()=>{if(null==w?void 0:w.body)return w.body;if(H!==MediaTypes.XML)return $||(null==V?void 0:V.value)||(null==L?void 0:L.value)||(null==A?void 0:A.schema)&&Sampler.sample(A.schema.rawSchema,Object.assign(Object.assign({},E),{format:"json"}),i);{const e=z($)||z(null==V?void 0:V.value)||z(null==L?void 0:L.value);if(e)return e;if(null==A?void 0:A.schema)return Sampler.sample(A.schema.rawSchema,Object.assign(Object.assign({},E),{format:"xml"}),i)}return""})();let Y="",B=[];switch(normalizeMimeType(H)){case MediaTypes.JSON:Y=JSON.stringify(getDataRequest(J,l));break;case MediaTypes.XML:Y=J;break;case MediaTypes.URL_ENCODED:case MediaTypes.MULTIPART:Y=queryString.stringify(getDataRequest(J,l)),B=objectToHarParams(getDataRequest(J,l));break;default:Y=String(J||"")}const F=Y?{mimeType:(null==A?void 0:A.name)||MediaTypes.OCTET_STREAM,text:Y,params:B}:void 0,K=e.responses.map((e=>e.code));return{method:e.httpVerb,url:N,httpVersion:"HTTP/1.1",cookies:R,headers:M,queryString:D,postData:F,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:k,basicAuth:x,pathParameters:q,serverVariables:u,allResponseCodes:K}}const defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:Object.assign(Object.assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:Object.assign(Object.assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:Object.assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:Object.assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:Object.assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#+Newtonsoft":{code:"csharpNewtonsoft",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:Object.assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:Object.assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:Object.assign({},defaultOptions)},R:{code:"r",defaultTarget:"httr",defaultOptions:Object.assign({},defaultOptions)}};export function getCodeSample({lang:e,operation:t,exampleName:a,pathParams:r,properties:i,options:s={},environment:n,translate:l}){try{const{skipOptionalParameters:o,withOAuth2Call:u,spec:c,generatedPayloadSamplesMaxDepth:p,store:d,activeMimeName:m}=s,v=mapOperationToHAR(t,{exampleName:a,pathParams:r,properties:i,skipOptionalParameters:o,withOAuth2Call:u,spec:c,generatedPayloadSamplesMaxDepth:p,activeMimeName:m},{environment:n,requestValues:d.requestValues,activeSecuritySchemeIds:d.activeSecuritySchemeIds}),f=new HTTPSnippet(v);return langToSnippetConfig[e]?f.convert(langToSnippetConfig[e].code,langToSnippetConfig[e].defaultTarget,Object.assign(Object.assign({},langToSnippetConfig[e].defaultOptions),s)):l("openapi.unsupportedLanguage","Language is not supported.")}catch(e){return console.error(e),l("openapi.failedToGenerateCodeSample","Failed to generate code sample.")}}function getSecurityData(e,t,a){var r,i,s,n,l;const o={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0},u=null==a?void 0:a.server;for(const c of(null==e?void 0:e.schemes)||[]){const e=getSecurityDetails(c.id,a),p=u&&c.serverValues&&c.serverValues[u],d={access_token:(null==p?void 0:p["x-defaultAccessToken"])||c["x-defaultAccessToken"],token_type:(null==p?void 0:p["x-defaultTokenType"])||c["x-defaultTokenType"],client_id:(null==p?void 0:p["x-defaultClientId"])||c["x-defaultClientId"],client_secret:(null==p?void 0:p["x-defaultClientSecret"])||c["x-defaultClientSecret"]},m=(null==p?void 0:p["x-defaultUsername"])||c["x-defaultUsername"],v=(null==p?void 0:p["x-defaultPassword"])||c["x-defaultPassword"],f=p&&"scopes"in p?p.scopes||[]:c.scopes||[];switch(c.type){case"openIdConnect":null===(r=o.securityHeaders)||void 0===r||r.push({name:"Authorization",value:d.access_token?`${d.token_type||"Bearer"} ${d.access_token}`:e.token?`${d.token_type||e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":{const a=d.access_token?`${d.token_type||"Bearer"} ${d.access_token}`:e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>";c.flows.clientCredentials&&t?o.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(c.flows.clientCredentials,f,Object.assign(Object.assign({},e),{client_id:d.client_id||e.client_id,client_secret:d.client_secret||e.client_secret}))):c.flows.password&&t&&o.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(c.flows.password,f,Object.assign(Object.assign({},e),{client_id:d.client_id||e.client_id,client_secret:d.client_secret||e.client_secret}))),null===(i=o.securityHeaders)||void 0===i||i.push({name:"Authorization",value:a});break}case"apiKey":{const t=d.access_token||e.raw||"YOUR_API_KEY_HERE";"header"===c.in&&(null===(s=o.securityHeaders)||void 0===s||s.push({name:c.name,value:t})),"cookie"===c.in&&o.securityCookies.push({name:c.name,value:t}),"query"===c.in&&o.securityQueries.push({name:c.name,value:t});break}case"http":if("basic"===c.scheme)o.basicAuth={username:m||e.username||`<${StringUtility.toSnakeCase("Username")}>`,password:v||e.password||`<${StringUtility.toSnakeCase("Password")}>`};else{const t=(null==d?void 0:d.access_token)||(null===(n=e.token)||void 0===n?void 0:n.access_token)||`<YOUR_${c.bearerFormat||"TOKEN"}_HERE>`;null===(l=o.securityHeaders)||void 0===l||l.push({name:"Authorization",value:`${capitalizeFirst(c.scheme||"bearer")} ${t}`})}}}return o}function getOAuth2PasswordCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:a.username||"<username>"},{name:"password",value:a.password||"<password>"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}export function getDataRequest(e,t){if(e){if(isObject(e))return Object.keys(e).length>0&&0===Object.keys(t).length?e:merge(e,t,{arrayMerge:arrayMergeStrategy});try{return merge(JSON.parse(e),t,{arrayMerge:arrayMergeStrategy})}catch(e){return!1}}return!1}function objectToHarParams(e,t=""){const a=[];for(const[r,i]of Object.entries(e)){const s=t?`${t}[${r}]`:r;if("object"==typeof i&&null!==i)a.push(...objectToHarParams(i,s));else{const r=Array.isArray(e)&&"string"==typeof i&&t?t:s;a.push({name:r,value:String(i)})}}return a}export function isDefined(e){return void 0!==e}export function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}function populateXmlSchemaFields(e,t){if(!e||"object"!=typeof e||!t||"object"!=typeof t)return e;const a=JSON.parse(JSON.stringify(e));return function e(t,a){if(t&&a&&"object"==typeof t&&"object"==typeof a&&t.properties)for(const r in t.properties)if(void 0!==a[r]){const i=t.properties[r],s=a[r];if("object"!==i.type||"object"!=typeof s||Array.isArray(s))if("array"===i.type&&Array.isArray(s)&&s.length>0){const t=s[0];i.items&&i.items.properties&&e(i.items,t)}else i.example=s;else e(i,s)}}(a,t),a}
+//# sourceMappingURL=generator.js.map

package/lib-esm/services/code-samples/httpsnippet/helpers/code-builder.d.ts

@@ -0,0 +1,83 @@
+import type { OpenAPIServerVariable } from '../../../../types';
+import { VariableType } from './constants';
+/**
+ * Helper object to format and aggragate lines of code.
+ * Lines are aggregated in a `code` array, and need to be joined to obtain a proper code snippet.
+ *
+ * @param {string} indentation Desired indentation character for aggregated lines of code
+ * @param {string} lineJoin Desired character to join each line of code
+ */
+export declare class CodeBuilder {
+    private code;
+    private indentation;
+    private variablesPrefix;
+    private lineJoin;
+    private capitalize;
+    private lang;
+    langOptions: {
+        stringLiteral: (t: string) => string;
+        variableWrapperFn: (variableName: string, variableValue?: OpenAPIServerVariable | string) => string;
+        variableDeclaration: (v: string) => string;
+        joinSymbol: string;
+        urlFieldName: string;
+        rawName: boolean;
+    };
+    constructor({ indentation, lineJoin, variablesPrefix, capitalize, lang, }: {
+        indentation: string;
+        lineJoin?: string;
+        variablesPrefix?: string;
+        capitalize?: boolean;
+        lang?: string;
+    });
+    /**
+     * Add given indentation level to given string and format the string (variadic)
+     * @param {number} [indentationLevel=0] - Desired level of indentation for this line
+     * @param {string} line - Line of code. Can contain formatting placeholders
+     * @param rest
+     * @param {...object} - Parameter to bind to `line`'s formatting placeholders
+     * @return {string}
+     *
+     * @example
+     *   const builder = CodeBuilder('\t')
+     *
+     *   builder.buildLine('console.log("hello world")')
+     *   // returns: 'console.log("hello world")'
+     *
+     *   builder.buildLine(2, 'console.log("hello world")')
+     *   // returns: 'console.log("\t\thello world")'
+     *
+     *   builder.buildLine(2, 'console.log("%s %s")', 'hello', 'world')
+     *   // returns: 'console.log("\t\thello world")'
+     */
+    buildLine(indentationLevel: number | string, line: string): string | null;
+    /**
+     * Invoke buildLine() and add the line at the top of current lines
+     * @return {this}
+     * @param args
+     */
+    unshift(...args: Array<string | number | undefined | unknown>): CodeBuilder;
+    /**
+     * Invoke buildLine() and add the line at the bottom of current lines
+     * @return {this}
+     * @param args
+     */
+    push(...args: Array<string | number | undefined | unknown>): CodeBuilder;
+    /**
+     * Add an empty line at the end of current lines
+     * @return {this}
+     */
+    blank(): CodeBuilder;
+    /**
+     * Concatenate all current lines using the given lineJoin
+     * @return {string}
+     */
+    join(): string;
+    clean(): void;
+    /**
+     * Get variable name, use variablesPrefix if specified
+     * @param {string} name
+     * @param {VariableType} type
+     * @return {string}
+     */
+    var(name: string, type?: VariableType): string;
+}

package/lib-esm/services/code-samples/httpsnippet/helpers/code-builder.js

@@ -0,0 +1,2 @@
+import*as util from"util";import{Lang,NamingVariableConventions,VariableType}from"./constants";import StringUtility from"./string-utility";const langToVarNameConvention={[Lang.NODEJS]:NamingVariableConventions.CAMEL_CASE,[Lang.JAVASCRIPT]:NamingVariableConventions.CAMEL_CASE,[Lang.PYTHON]:NamingVariableConventions.UNDER_SCORES,[Lang.JAVA8]:NamingVariableConventions.CAMEL_CASE,[Lang.JAVA]:NamingVariableConventions.CAMEL_CASE,[Lang.CSHARP]:NamingVariableConventions.PASCAL_CASE,[Lang.CSHARPNEWTONSOFT]:NamingVariableConventions.PASCAL_CASE,[Lang.CURL]:NamingVariableConventions.CAMEL_CASE,[Lang.GO]:NamingVariableConventions.CAMEL_CASE,[Lang.PHP]:NamingVariableConventions.CAMEL_CASE,[Lang.RUBY]:NamingVariableConventions.UNDER_SCORES,[Lang.R]:NamingVariableConventions.UNDER_SCORES},langOptions={default:{joinSymbol:"",variableWrapperFn:a=>a,stringLiteral:a=>a,variableDeclaration:a=>a,urlFieldName:"url"},[Lang.CSHARP]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`var ${a} = "%s";`,urlFieldName:"fullUrl"},[Lang.CSHARPNEWTONSOFT]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`var ${a} = "%s";`,urlFieldName:"fullUrl"},[Lang.GO]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`${a} := "%s";`},[Lang.JAVA]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`var ${a} = "%s";`,urlFieldName:"pathname"},[Lang.JAVA8]:{joinSymbol:" + ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`String ${a} = "%s";`,urlFieldName:"fullUrl"},[Lang.JAVASCRIPT]:{variableWrapperFn:a=>"${"+a+"}",variableDeclaration:a=>`const ${a} = '%s';`},[Lang.NODEJS]:{variableWrapperFn:a=>"${"+a+"}",variableDeclaration:a=>`const ${a} = '%s';`},[Lang.PHP]:{joinSymbol:" . ",stringLiteral:a=>`"${a}"`,variableDeclaration:a=>`const ${a} = "%s";`},[Lang.PYTHON]:{stringLiteral:a=>`"${a}"`,joinSymbol:" + ",variableDeclaration:a=>`${a} = "%s"`},[Lang.RUBY]:{joinSymbol:" + ",stringLiteral:a=>`'${a}'`,variableDeclaration:a=>`${a} = '%s'`},[Lang.CURL]:{variableWrapperFn:(a,i)=>i||`{${a}}`,urlFieldName:"fullUrl",rawName:!0},[Lang.R]:{joinSymbol:" %&% ",variableDeclaration:a=>`${a} = "%s"`,urlFieldName:"fullUrl",stringLiteral:a=>`"${a}"`,variableWrapperFn:a=>`${a}`}},reservedVariableNames=["response","request","requests","data","url","payload","main","accessToken","resp","Program","client","postData","App","httpClient","params","pathname","host","body","fetch","query"];export class CodeBuilder{constructor({indentation:a,lineJoin:i="\n",variablesPrefix:e="",capitalize:n=!1,lang:r=Lang.CURL}){Object.defineProperty(this,"code",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"indentation",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"variablesPrefix",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"lineJoin",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"capitalize",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"lang",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"langOptions",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),this.code=[],this.indentation=a,this.variablesPrefix=e,this.lineJoin=i||"\n",this.capitalize=n,this.lang=r,this.langOptions=Object.assign(Object.assign({},langOptions.default),langOptions[r])}buildLine(a,i){let e="",n=2;if("string"==typeof a)n=1,i=a,a=0;else if(null===a)return null;for(;a;)e+=this.indentation,a--;const r=Array.prototype.slice.call(arguments,n,arguments.length);return r.unshift(e+i),util.format.apply(this,r)}unshift(...a){return this.code.unshift(this.buildLine.apply(this,a)),this}push(...a){return this.code.push(this.buildLine.apply(this,a)),this}blank(){return this.code.push(null),this}join(){return this.code.join(this.lineJoin)}clean(){this.code.splice(1)}var(a,i=VariableType.CUSTOM){if(i===VariableType.PATH){let i=this.variablesPrefix+a;switch(reservedVariableNames.includes(i)&&(i=`${i}_path`),langToVarNameConvention[this.lang]){case NamingVariableConventions.UNDER_SCORES:i=StringUtility.toSnakeCase(i);break;case NamingVariableConventions.PASCAL_CASE:i=StringUtility.toPascalCase(i);break;case NamingVariableConventions.CAMEL_CASE:default:i=StringUtility.toCamelCase(i)}return i}return this.variablesPrefix?this.variablesPrefix+(this.capitalize?StringUtility.toPascalCase(a):a):a}}
+//# sourceMappingURL=code-builder.js.map

package/lib-esm/services/code-samples/httpsnippet/helpers/code-helpers.d.ts

@@ -0,0 +1,28 @@
+import type { SnippetRequest } from '../index';
+import type { CodeBuilder } from './code-builder';
+export declare function getPreserveTransformer({ body, authorizationHeader, }: {
+    body?: boolean;
+    authorizationHeader?: boolean;
+}): (input: GenericObject, prop: string, originalResult: string) => string;
+export declare function addIndentation(str: string, { level, indent, firstLine }?: {
+    level?: number | undefined;
+    indent?: string | undefined;
+    firstLine?: boolean | undefined;
+}): string;
+export type CodeOperand = {
+    type: 'string';
+    value: string;
+} | {
+    type: 'variable';
+    name: string;
+};
+/**
+ * Parse url with arguments into concatenation operands array so it can be manipulated easily language-independently
+ *
+ * @example
+ * // returns [{type: 'string', value: '/var/'}, {type: 'variable', name: 'test'}, {type: "string", value: "/"}]
+ * parseUrlIntoOperands("/url/:test/", {test: 1})
+ **/
+export declare function parseUrlIntoOperands(url: string, params: Record<string, unknown>): CodeOperand[];
+export declare function buildUrlExpression(source: SnippetRequest, code: CodeBuilder): string;
+export declare function printUrlVariablesDeclarations({ pathParameters, serverVariables }: SnippetRequest, code: CodeBuilder, indentationLevel?: number): void;

package/lib-esm/services/code-samples/httpsnippet/helpers/code-helpers.js

@@ -0,0 +1,2 @@
+import{VariableType}from"./constants";export function getPreserveTransformer({body:e,authorizationHeader:r}){return function(n,t,a){return e&&"body"===t&&"string"==typeof n.body?n.body:r&&"Authorization"===t&&"string"==typeof n.Authorization?n.Authorization:a}}export function addIndentation(e,{level:r=0,indent:n="  ",firstLine:t=!0}={}){const a=n.repeat(r),i=e.replace(/(\r\n|\n|\r)/gm,`\n${a}`);return t?a.concat(i):i}export function parseUrlIntoOperands(e,r){const n=Object.keys(r).map((r=>({name:r,idx:e.indexOf(`{${r}}`)}))).filter((({idx:e})=>e>-1)).sort(((e,r)=>e.idx-r.idx)),t=[];let a=0;for(const{name:r,idx:i}of n)i>a&&t.push({type:"string",value:e.substring(a,i)}),t.push({type:"variable",name:r}),a=i+r.length+2;return a<e.length&&t.push({type:"string",value:e.substring(a)}),t}export function buildUrlExpression(e,r){const{joinSymbol:n,variableWrapperFn:t,stringLiteral:a,urlFieldName:i,rawName:o}=r.langOptions,{pathParameters:s={},serverVariables:p={}}=e,l=Object.assign(Object.assign({},s),p);return parseUrlIntoOperands(e[i]||"",l).map((e=>{if("variable"===e.type){const n=l[e.name],a=o?e.name:r.var(e.name,VariableType.PATH);return t(a,n)}return a(e.value)})).join(n)}export function printUrlVariablesDeclarations({pathParameters:e={},serverVariables:r={}},n,t){Object.entries(Object.assign(Object.assign({},e),r)).forEach((([e,r])=>{if("server"===e)return;const a=r||`YOUR_${e}_PARAMETER`,i=n.var(e,VariableType.PATH);void 0!==t?n.push(t,n.langOptions.variableDeclaration(i),a):n.push(n.langOptions.variableDeclaration(i),a)}))}
+//# sourceMappingURL=code-helpers.js.map

package/lib-esm/services/code-samples/httpsnippet/helpers/constants.d.ts

@@ -0,0 +1,24 @@
+export declare enum Lang {
+    NODEJS = "Node.js",
+    JAVASCRIPT = "javascript",
+    PYTHON = "Python",
+    JAVA8 = "Java8+Apache",
+    JAVA = "Java",
+    CSHARP = "C#",
+    CSHARPNEWTONSOFT = "C#+Newtonsoft",
+    CURL = "curl",
+    GO = "Go",
+    PHP = "PHP",
+    RUBY = "Ruby",
+    R = "R"
+}
+export declare enum NamingVariableConventions {
+    UNDER_SCORES = "under_scores",
+    CAMEL_CASE = "camelCase",
+    PASCAL_CASE = "PascalCase"
+}
+export declare enum VariableType {
+    IMPORT = "import",
+    CUSTOM = "custom",
+    PATH = "path"
+}

package/lib-esm/services/code-samples/httpsnippet/helpers/constants.js

@@ -0,0 +1,2 @@
+export var Lang;!function(a){a.NODEJS="Node.js",a.JAVASCRIPT="javascript",a.PYTHON="Python",a.JAVA8="Java8+Apache",a.JAVA="Java",a.CSHARP="C#",a.CSHARPNEWTONSOFT="C#+Newtonsoft",a.CURL="curl",a.GO="Go",a.PHP="PHP",a.RUBY="Ruby",a.R="R"}(Lang||(Lang={}));export var NamingVariableConventions;!function(a){a.UNDER_SCORES="under_scores",a.CAMEL_CASE="camelCase",a.PASCAL_CASE="PascalCase"}(NamingVariableConventions||(NamingVariableConventions={}));export var VariableType;!function(a){a.IMPORT="import",a.CUSTOM="custom",a.PATH="path"}(VariableType||(VariableType={}));
+//# sourceMappingURL=constants.js.map

package/lib-esm/services/code-samples/httpsnippet/helpers/lodash-int.d.ts

@@ -0,0 +1,5 @@
+declare const camelCase: (string: string) => string;
+declare const lowerCase: (string: string) => string;
+declare const snakeCase: (string: string) => string;
+declare const startCase: (string: string) => string;
+export { camelCase, lowerCase, snakeCase, startCase };

package/lib-esm/services/code-samples/httpsnippet/helpers/lodash-int.js

@@ -0,0 +1,2 @@
+const rsAstralRange="\\ud800-\\udfff",rsComboMarksRange="\\u0300-\\u036f",reComboHalfMarksRange="\\ufe20-\\ufe2f",rsComboSymbolsRange="\\u20d0-\\u20ff",rsComboMarksExtendedRange="\\u1ab0-\\u1aff",rsComboMarksSupplementRange="\\u1dc0-\\u1dff",rsComboRange="\\u0300-\\u036f\\ufe20-\\ufe2f\\u20d0-\\u20ff\\u1ab0-\\u1aff\\u1dc0-\\u1dff",rsDingbatRange="\\u2700-\\u27bf",rsLowerRange="a-z\\xdf-\\xf6\\xf8-\\xff",rsMathOpRange="\\xac\\xb1\\xd7\\xf7",rsNonCharRange="\\x00-\\x2f\\x3a-\\x40\\x5b-\\x60\\x7b-\\xbf",rsPunctuationRange="\\u2000-\\u206f",rsSpaceRange=" \\t\\x0b\\f\\xa0\\ufeff\\n\\r\\u2028\\u2029\\u1680\\u180e\\u2000\\u2001\\u2002\\u2003\\u2004\\u2005\\u2006\\u2007\\u2008\\u2009\\u200a\\u202f\\u205f\\u3000",rsUpperRange="A-Z\\xc0-\\xd6\\xd8-\\xde",rsVarRange="\\ufe0e\\ufe0f",rsBreakRange=rsMathOpRange+rsNonCharRange+"\\u2000-\\u206f"+rsSpaceRange,reQuotes=/['\u2019]/g,rsApos="['’]",rsBreak=`[${rsBreakRange}]`,rsCombo=`[${rsComboRange}]`,rsDigit="\\d",rsDingbat=`[${rsDingbatRange}]`,rsLower=`[${rsLowerRange}]`,rsMisc=`[^${rsAstralRange}${rsBreakRange+"\\d"+rsDingbatRange+rsLowerRange+rsUpperRange}]`,rsFitz="\\ud83c[\\udffb-\\udfff]",rsModifier=`(?:${rsCombo}|${rsFitz})`,rsNonAstral=`[^${rsAstralRange}]`,rsRegional="(?:\\ud83c[\\udde6-\\uddff]){2}",rsSurrPair="[\\ud800-\\udbff][\\udc00-\\udfff]",rsUpper=`[${rsUpperRange}]`,rsZWJ="\\u200d",rsMiscLower=`(?:${rsLower}|${rsMisc})`,rsMiscUpper=`(?:${rsUpper}|${rsMisc})`,rsOptContrLower="(?:['’](?:d|ll|m|re|s|t|ve))?",rsOptContrUpper="(?:['’](?:D|LL|M|RE|S|T|VE))?",reOptMod=`${rsModifier}?`,rsOptVar=`[${rsVarRange}]?`,rsOptJoin=`(?:${rsZWJ}(?:${[rsNonAstral,rsRegional,rsSurrPair].join("|")})${rsOptVar+reOptMod})*`,rsOrdLower="\\d*(?:1st|2nd|3rd|(?![123])\\dth)(?=\\b|[A-Z_])",rsOrdUpper="\\d*(?:1ST|2ND|3RD|(?![123])\\dTH)(?=\\b|[a-z_])",rsSeq=rsOptVar+reOptMod+rsOptJoin,rsEmoji=`(?:${[rsDingbat,rsRegional,rsSurrPair].join("|")})${rsSeq}`,reUnicodeWords=RegExp([`${rsUpper}?${rsLower}+${rsOptContrLower}(?=${[rsBreak,rsUpper,"$"].join("|")})`,`${rsMiscUpper}+${rsOptContrUpper}(?=${[rsBreak,rsUpper+rsMiscLower,"$"].join("|")})`,`${rsUpper}?${rsMiscLower}+${rsOptContrLower}`,`${rsUpper}+${rsOptContrUpper}`,rsOrdUpper,rsOrdLower,"\\d+",rsEmoji].join("|"),"g"),unicodeWords=r=>r.match(reUnicodeWords),reHasUnicode=RegExp(`[${rsZWJ+rsAstralRange+rsComboRange+rsVarRange}]`),hasUnicode=r=>reHasUnicode.test(r),rsAstral=`[${rsAstralRange}]`,rsNonAstralCombo=`${rsNonAstral}${rsCombo}?`,rsSymbol=`(?:${[rsNonAstralCombo,rsCombo,rsRegional,rsSurrPair,rsAstral].join("|")})`,reUnicode=RegExp(`${rsFitz}(?=${rsFitz})|${rsSymbol+rsSeq}`,"g"),unicodeToArray=r=>r.match(reUnicode)||[],asciiToArray=r=>r.split(""),getTag=r=>{const e=Object.prototype.toString;return null==r?void 0===r?"[object Undefined]":"[object Null]":e.call(r)},isSymbol=r=>{const e=typeof r;return"symbol"==e||"object"===e&&null!=r&&"[object Symbol]"==getTag(r)},INFINITY=1/0,toString=r=>{if(null==r)return"";if("string"==typeof r)return r;if(Array.isArray(r))return`${r.map((r=>null==r?r:toString(r)))}`;if(isSymbol(r))return r.toString();const e=`${r}`;return"0"==e&&1/r==-Infinity?"-0":e},hasUnicodeWord=RegExp.prototype.test.bind(/[a-z][A-Z]|[A-Z]{2}[a-z]|[0-9][a-zA-Z]|[a-zA-Z][0-9]|[^a-zA-Z0-9 ]/),reAsciiWord=/[^\x00-\x2f\x3a-\x40\x5b-\x60\x7b-\x7f]+/g,asciiWords=r=>r.match(reAsciiWord),slice=(r,e,s)=>{let o=null==r?0:r.length;if(!o)return[];(e=null==e?0:e)<0&&(e=-e>o?0:o+e),(s=(s=void 0===s?o:s)>o?o:s)<0&&(s+=o),o=e>s?0:s-e>>>0,e>>>=0;let a=-1;const t=new Array(o);for(;++a<o;)t[a]=r[a+e];return t},words=r=>(hasUnicodeWord(r)?unicodeWords(r):asciiWords(r))||[],castSlice=(r,e)=>{const{length:s}=r;return!e&&s>=s?r:slice(r,e,s)},stringToArray=r=>hasUnicode(r)?unicodeToArray(r):asciiToArray(r),createCaseFirst=r=>e=>{if(!e)return"";const s=hasUnicode(e)?stringToArray(e):void 0,o=s?s[0]:e[0],a=s?castSlice(s,1).join(""):e.slice(1);return o[r]()+a},upperFirst=createCaseFirst("toUpperCase"),camelCase=r=>words(toString(r).replace(/['\u2019]/g,"")).reduce(((r,e,s)=>(e=e.toLowerCase(),r+(s?upperFirst(e):e))),""),lowerCase=r=>words(toString(r).replace(reQuotes,"")).reduce(((r,e,s)=>r+(s?" ":"")+e.toLowerCase()),""),snakeCase=r=>words(toString(r).replace(/['\u2019]/g,"")).reduce(((r,e,s)=>r+(s?"_":"")+e.toLowerCase()),""),startCase=r=>words(`${r}`.replace(/['\u2019]/g,"")).reduce(((r,e,s)=>r+(s?" ":"")+upperFirst(e)),"");export{camelCase,lowerCase,snakeCase,startCase};
+//# sourceMappingURL=lodash-int.js.map

package/lib-esm/services/code-samples/httpsnippet/helpers/mocks/code-helpers-mock.d.ts

@@ -0,0 +1,30 @@
+export declare const commonVariablesInput: any;
+export declare const printUrlVariablesDeclarationsOutput: {
+    'Node.js': string;
+    javascript: string;
+    Python: string;
+    'Java8+Apache': string;
+    Java: string;
+    'C#': string;
+    'C#+Newtonsoft': string;
+    curl: string;
+    Go: string;
+    PHP: string;
+    Ruby: string;
+    R: string;
+};
+export declare const buildUrlExpressionCases: {};
+export declare const buildUrlExpressionData: {
+    'Node.js': string;
+    javascript: string;
+    Python: string;
+    'Java8+Apache': string;
+    Java: string;
+    'C#': string;
+    'C#+Newtonsoft': string;
+    curl: string;
+    Go: string;
+    PHP: string;
+    Ruby: string;
+    R: string;
+};