@xyd-js/openapi 0.1.0-xyd.1 → 0.1.0-xyd.10

package/examples/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../semi/index.ts","../../src/const.ts","../../src/parameters.ts","../../src/properties.ts","../../src/requestBody.ts","../../src/responses.ts","../../src/schema.ts","../../src/paths.ts","../../src/utils.ts","../../src/examples.ts"],"sourcesContent":["import path from 'path';\n\nimport {\n    deferencedOpenAPI,\n    oapSchemaToReferences,\n} from \"../../src\";\nimport fs from \"fs\";\n\n(async () => {\n    const openApiPath = path.join(process.cwd(), './examples/semi/openapi.yaml');\n    const schema = await deferencedOpenAPI(openApiPath)\n    const references = oapSchemaToReferences(schema)\n\n    console.log(path.join(process.cwd(), './examples/semi/references.json'))\n    fs.writeFileSync(path.join(process.cwd(), './examples/semi/references.json'), JSON.stringify(references, null, 2))\n    console.log(2)\n})()\n\n","export const SUPPORTED_HTTP_METHODS: string[] = [\n    'get',\n    'put',\n    'patch',\n    'post',\n    'delete',\n    // 'options',\n    // 'head',\n    // 'trace'\n];","import {OpenAPIV3} from \"openapi-types\";\nimport {DefinitionProperty} from \"@xyd-js/uniform\";\n\n// oapParametersToDefinitionProperties converts OpenAPI parameters to uniform DefinitionProperties\nexport function oapParametersToDefinitionProperties(\n    parameters: OpenAPIV3.ParameterObject[]\n): { [key: string]: DefinitionProperty[] } {\n    const parameterIn: { [key: string]: DefinitionProperty[] } = {}\n\n    parameters.forEach((param) => {\n        if (!parameterIn[param.in]) {\n            parameterIn[param.in] = []\n        }\n\n        const schema = param.schema as OpenAPIV3.SchemaObject\n\n        const property: DefinitionProperty = {\n            name: param.name,\n            type: schema.type || \"\",\n            description: param.description || \"\"\n        }\n\n        parameterIn[param.in].push(property)\n    })\n\n    return parameterIn\n}\n","import {OpenAPIV3} from \"openapi-types\";\nimport {DefinitionProperty} from \"@xyd-js/uniform\";\n\n// schemaObjectToDefinitionProperties converts OpenAPI schema object to uniform DefinitionProperty[]\nexport function schemaObjectToDefinitionProperties(v: OpenAPIV3.SchemaObject): DefinitionProperty[] {\n    return Object.entries(v.properties || {}).map(([name, prop]) => {\n        let objProp = prop as OpenAPIV3.SchemaObject\n\n        let merged: DefinitionProperty[] = []\n\n        if (objProp.allOf) {\n            merged = objProp.allOf.reduce((acc, of) => {\n                return [\n                    ...acc,\n                    ...schemaObjectToDefinitionProperties(of as OpenAPIV3.SchemaObject)\n                ]\n            }, [] as DefinitionProperty[])\n        }\n\n        if (objProp.type === \"array\") {\n            const items = objProp.items as OpenAPIV3.SchemaObject\n\n            merged = schemaObjectToDefinitionProperties(items)\n        }\n\n        return {\n            name: name,\n            type: objProp.type || \"\",\n            description: objProp.description || \"\",\n            properties: (\n                merged?.length\n                    ? merged\n                    : objProp.properties ? schemaObjectToDefinitionProperties(objProp) : []\n            )\n        }\n    })\n}","import {OpenAPIV3} from \"openapi-types\";\nimport {DefinitionProperty} from \"@xyd-js/uniform\";\n\nimport {schemaObjectToDefinitionProperties} from \"./properties\";\n\n// oapRequestBodyToDefinitionProperties converts OpenAPI request body to uniform DefinitionProperties\nexport function oapRequestBodyToDefinitionProperties(\n    reqBody: OpenAPIV3.RequestBodyObject\n): DefinitionProperty[] | null {\n    // TODO: support other content types ???\n    const schema = reqBody.content['application/json'].schema as OpenAPIV3.SchemaObject\n\n    let schemaObject: OpenAPIV3.SchemaObject | undefined\n\n    if (schema.allOf) {\n        return schema.allOf.reduce((acc, of) => {\n            const fakeBody: OpenAPIV3.RequestBodyObject = {\n                content: {\n                    'application/json': {\n                        schema: of\n                    }\n                }\n            }\n\n            return [\n                ...acc,\n                ...oapRequestBodyToDefinitionProperties(fakeBody) || []\n            ]\n        }, [] as DefinitionProperty[])\n    }\n\n    switch (schema.type) {\n        case 'object': {\n            schemaObject = schema\n            break\n        }\n        case 'array': {\n            const arrSchema = schema as OpenAPIV3.ArraySchemaObject\n\n            const items = arrSchema.items as OpenAPIV3.SchemaObject\n\n            schemaObject = items\n            break\n        }\n        default:\n            // TODO: primitive types ???\n            break\n    }\n\n    if (!schemaObject) {\n        return null\n    }\n\n    return schemaObjectToDefinitionProperties(schemaObject)\n}","import {OpenAPIV3} from \"openapi-types\";\nimport {DefinitionProperty} from \"@xyd-js/uniform\";\n\nimport {schemaObjectToDefinitionProperties} from \"./properties\";\n\nexport function oapResponseToDefinitionProperties(\n    responses: OpenAPIV3.ResponsesObject\n): DefinitionProperty[] | null {\n    let schemaObject: OpenAPIV3.SchemaObject | undefined\n    // TODO: support another statuses\n    if (responses[\"default\"]) {\n        const w = responses[\"default\"] as OpenAPIV3.ResponseObject\n\n        schemaObject = w?.content?.['application/json']?.schema as OpenAPIV3.SchemaObject\n    } else if (responses[\"200\"]) {\n        const w = responses[\"200\"] as OpenAPIV3.ResponseObject\n\n        schemaObject = w?.content?.['application/json']?.schema as OpenAPIV3.SchemaObject\n    }\n\n    if (!schemaObject) {\n        return null\n    }\n\n    switch (schemaObject.type) {\n        case 'array':\n            const arrSchema = schemaObject as OpenAPIV3.ArraySchemaObject\n\n            const items = arrSchema.items as OpenAPIV3.SchemaObject\n\n            schemaObject = items\n            break\n        default:\n            break\n    }\n\n    return schemaObjectToDefinitionProperties(schemaObject)\n}","import {OpenAPIV3} from \"openapi-types\";\nimport Oas from \"oas\";\n\nimport type {Reference, OpenAPIReferenceContext} from \"@xyd-js/uniform\";\n\nimport {SUPPORTED_HTTP_METHODS} from \"./const\";\nimport {oapPathToReference} from \"./paths\";\nimport {oapExamples} from \"./examples\";\n\n// TODO: support one-of\n// TODO: support $ref - currently we use $refParser.dereference that converts $ref into objects\n// TODO: better method check system - currently we need to manually check that in few methods\n\n// oapSchemaToReferences converts an OpenAPI schema to a list of uniform References\nexport function oapSchemaToReferences(\n    schema: OpenAPIV3.Document\n): Reference[] {\n    const references: Reference[] = [];\n    const oas = new Oas(schema as any);\n\n    const server = schema.servers?.[0]?.url || \"\"\n\n    Object.entries(schema.paths).forEach(([path, oapPath]) => {\n        SUPPORTED_HTTP_METHODS.forEach((eachMethod) => {\n            const httpMethod = eachMethod.toLowerCase()\n\n            switch (httpMethod) {\n                case 'get':\n                    break\n                case 'put':\n                    break\n                case 'post':\n                    break\n                case 'delete':\n                    break\n                case 'patch':\n                    break\n                default:\n                    console.error(`Unsupported method v111: ${httpMethod}`)\n                    return\n            }\n\n            const reference = oapPathToReference(\n                httpMethod,\n                path,\n                oapPath as OpenAPIV3.PathItemObject\n            )\n\n            if (reference) {\n                const ctx = reference.context as OpenAPIReferenceContext\n                ctx.path = `${encodeURIComponent(server)}${encodeURIComponent(path)}` // TODO: it should be inside `oapPathToReference` ?\n\n                const operation = oas.operation(path, httpMethod);\n                reference.examples.groups = oapExamples(oas, operation)\n\n                references.push(reference)\n            }\n        })\n    })\n\n    return references\n}\n","import {OpenAPIV3} from \"openapi-types\";\nimport {Definition, ExampleGroup, Reference, ReferenceCategory} from \"@xyd-js/uniform\";\n\nimport {oapParametersToDefinitionProperties} from \"./parameters\";\nimport {oapRequestBodyToDefinitionProperties} from \"./requestBody\";\nimport {oapResponseToDefinitionProperties} from \"./responses\";\nimport {\n    httpMethodToUniformMethod,\n    toPascalCase\n} from \"./utils\";\n\n// oapPathToReference converts an OpenAPI path to a uniform Reference\nexport function oapPathToReference(\n    httpMethod: \"get\" | \"put\" | \"post\" | \"delete\" | \"patch\", // TODO: ts type\n    path: string,\n    oapPath: OpenAPIV3.PathItemObject,\n): Reference | null {\n    const mType = httpMethodToUniformMethod(httpMethod)\n\n    if (!mType) {\n        console.error(`Unsupported method v222: ${httpMethod}`)\n        return null\n    }\n\n    const definitions: Definition[] = []\n    const exampleGroups: ExampleGroup[] = []\n\n    const oapMethod = oapPath?.[httpMethod] as OpenAPIV3.OperationObject\n\n    if (!oapMethod) {\n        return null\n    }\n\n    const endpointRef: Reference = {\n        title: oapMethod?.summary || \"\",\n        canonical: toPascalCase(oapMethod?.summary || \"\"),\n        description: oapMethod?.description || \"\",\n\n        category: ReferenceCategory.REST,\n        type: mType,\n\n        context: {\n            method: httpMethod,\n\n            path: `${encodeURIComponent(path)}`,\n        },\n\n        examples: {\n            groups: exampleGroups,\n        },\n        definitions: definitions,\n    }\n\n    if (oapMethod.parameters) {\n        const parameters = oapMethod.parameters as OpenAPIV3.ParameterObject[]\n\n        const paramtersMap = oapParametersToDefinitionProperties(parameters) // TODO: finish\n\n        Object.entries(paramtersMap).forEach(([key, definitionProperties]) => {\n            let title: string\n\n            // TODO: add context to definition\n            switch (key) {\n                case 'path':\n                    title = \"Paths\"\n                    break\n                case 'query':\n                    title = \"Query\"\n                    break\n                case 'header':\n                    title = \"Header\"\n                    break\n                default:\n                    console.error(`Unsupported parameter type: ${key} for ${httpMethod} ${path}`)\n                    return\n            }\n\n            definitions.push({\n                title,\n                properties: definitionProperties\n            })\n        })\n    }\n\n    if (oapMethod.requestBody) {\n        const reqBody = oapMethod.requestBody as OpenAPIV3.RequestBodyObject\n\n        definitions.push({\n            title: 'Request body',\n            properties: oapRequestBodyToDefinitionProperties(reqBody) || []\n        })\n    }\n\n    if (oapMethod.responses) {\n        const responses = oapMethod.responses as OpenAPIV3.ResponsesObject\n\n        definitions.push({\n            title: 'Response',\n            properties: oapResponseToDefinitionProperties(responses) || []\n        })\n    }\n\n    return endpointRef\n}\n","import path from \"path\";\nimport fs from \"fs\";\nimport yaml from \"js-yaml\";\nimport $refParser from \"json-schema-ref-parser\";\nimport {OpenAPIV3} from \"openapi-types\";\n\nimport {ReferenceType} from \"@xyd-js/uniform\";\n\ntype Parameters = {\n    query?: Record<string, string | number | boolean>;\n    headers?: Record<string, string>;\n};\n\nexport function toPascalCase(str: string): string {\n    return str\n        .split(/[\\s_-]+/)\n        .map(word => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())\n        .join('');\n}\n\n// readOpenApiSpec reads an OpenAPI spec file and returns the content\nfunction readOpenApiSpec(filePath: string) {\n    const ext = path.extname(filePath).toLowerCase();\n    const content = fs.readFileSync(filePath, 'utf-8');\n\n    if (ext === '.yaml' || ext === '.yml') {\n        return yaml.load(content);\n    } else if (ext === '.json') {\n        return JSON.parse(content);\n    } else {\n        throw new Error('Unsupported file format. Use JSON or YAML.');\n    }\n}\n\n// deferencedOpenAPI reads an OpenAPI spec file and returns a dereferenced OpenAPIV3.Document\n// dereferenced means that all $ref references are resolved automatically\nexport async function deferencedOpenAPI(openApiPath: string) {\n    const openApiSpec = readOpenApiSpec(openApiPath);\n\n    //@ts-ignore TODO: fix ts\n    await $refParser.dereference(openApiSpec);\n\n    return openApiSpec as OpenAPIV3.Document\n}\n\n// httpMethodToUniformMethod converts an HTTP method to a uniform ReferenceType\nexport function httpMethodToUniformMethod(method: string): ReferenceType | null {\n    switch (method) {\n        case 'get':\n            return ReferenceType.REST_HTTP_GET\n        case 'put':\n            return ReferenceType.REST_HTTP_PUT\n        case 'patch':\n            return ReferenceType.REST_HTTP_PATCH\n        case 'post':\n            return ReferenceType.REST_HTTP_POST\n        case 'delete':\n            return ReferenceType.REST_HTTP_DELETE\n        // case 'options':\n        //     return ReferenceType.REST_HTTP_OPTIONS\n        // case 'head':\n        //     return ReferenceType.REST_HTTP_HEAD\n        // case 'trace':\n        //     return ReferenceType.REST_HTTP_TRACE\n        default:\n            return null\n    }\n}\n\n// schemaToRequestBody generates a request body from an OpenAPI schema\nfunction schemaToRequestBody(schema: OpenAPIV3.SchemaObject): string {\n    const requestBody: any = {};\n\n    if (schema.type === 'object' && schema.properties) {\n        for (const [key, value] of Object.entries(schema.properties)) {\n            if ((value as OpenAPIV3.SchemaObject).default !== undefined) {\n                requestBody[key] = (value as OpenAPIV3.SchemaObject).default;\n            } else {\n                requestBody[key] = null; // or some placeholder value\n            }\n        }\n    }\n\n    return JSON.stringify(requestBody);\n}\n\n// generateRequestInitFromOpenAPIObject generates a RequestInit object from an OpenAPI object\nexport function generateRequestInitFromOapOperation(\n    urlPath: string,\n    operation: OpenAPIV3.OperationObject\n): { url: string, reqInit: RequestInit } {\n    const reqInit: RequestInit = {}\n    let queryParams = '';\n\n    if (operation.parameters) {\n        const parameters = operation.parameters as OpenAPIV3.ParameterObject[]\n\n        const params = new URLSearchParams(\n            Object.entries(parameters).map(([key, value]) => [key, String(value)])\n        ).toString();\n\n        queryParams += `?${params}`;\n    }\n\n    if (operation.requestBody) {\n        const reqBody = operation.requestBody as OpenAPIV3.RequestBodyObject;\n        const contentType = Object.keys(reqBody.content || {})[0];\n\n        if (contentType === \"application/json\") {\n            const schema = reqBody.content['application/json'].schema as OpenAPIV3.SchemaObject\n\n            reqInit.body = schemaToRequestBody(schema);\n            reqInit.headers = {\n                'Content-Type': 'application/json',\n            }\n        }\n    }\n\n    return {\n        url: `${urlPath}${queryParams}`,\n        reqInit,\n    };\n}\n\n","import {OpenAPIV3} from \"openapi-types\";\nimport Oas from \"oas\";\n// @ts-ignore\nimport {Operation} from 'oas/operation'; // TODO: fix ts\nimport oasToSnippet from \"@readme/oas-to-snippet\";\nimport OpenAPISampler from \"openapi-sampler\";\nimport type {JSONSchema7} from \"json-schema\";\n\nimport {ExampleGroup, Example} from \"@xyd-js/uniform\";\n\n// TODO: option with another languages\n// TODO: uniform plugins\n// TODO: fs uniform plugins\nexport function oapExamples(\n    oas: Oas,\n    operation: Operation\n): ExampleGroup[] {\n    const exampleGroups: ExampleGroup[] = []\n\n    if (operation.schema.requestBody) {\n        const body = operation.schema.requestBody as OpenAPIV3.RequestBodyObject\n        const schema = fixAllOfBug(\n            body.content[\"application/json\"].schema as JSONSchema7\n        )\n\n        if (!schema) {\n            return exampleGroups\n        }\n\n        const fakeData = OpenAPISampler.sample(schema)\n\n        // TODO: snippet languages options\n        const {code} = oasToSnippet(oas, operation, {\n            body: fakeData\n        }, null, \"shell\");\n\n        const examples: Example[] = []\n\n        examples.push({\n            codeblock: {\n                tabs: [{\n                    title: \"curl\",\n                    language: \"curl\",\n                    code: code || \"\",\n                }]\n            }\n        })\n\n        exampleGroups.push({\n            description: \"Example request\",\n            examples\n        })\n    }\n\n    if (operation.schema.responses) {\n        const responses = operation.schema.responses as OpenAPIV3.ResponsesObject\n\n        const examples: Example[] = []\n\n        Object.entries(responses).forEach(([status, r]) => {\n            const response = r as OpenAPIV3.ResponseObject\n            const schema = response?.content?.[\"application/json\"].schema as JSONSchema7\n\n            if (!schema) {\n                return\n            }\n\n            const fakeData = OpenAPISampler.sample(schema)\n\n            examples.push({\n                codeblock: {\n                    title: status,\n                    tabs: [{\n                        title: \"json\",\n                        language: \"json\",\n                        code: JSON.stringify(fakeData, null, 2) || \"\",\n                    }]\n                }\n            })\n        })\n\n        exampleGroups.push({\n            description: \"Response\",\n            examples\n        })\n    }\n\n    return exampleGroups\n}\n\n/*\nfixAllOfBug fixes below case:\n\n```yaml\n  allOf:\n    - $ref: '#/components/schemas/SomeSchema'\n    - type: object\n      required:\n      properties:\n```\n*/\nfunction fixAllOfBug(schema: JSONSchema7) {\n    const modifiedSchema = {...schema}\n\n    if (schema.allOf) {\n        schema.allOf.forEach((prop, i) => {\n            const propObj = prop as object\n\n            if (\"properties\" in propObj && !propObj[\"properties\"]) {\n                delete modifiedSchema.allOf?.[i]\n            }\n        })\n    }\n\n    return modifiedSchema\n}"],"mappings":"AAAA,OAAOA,MAAU,OCAV,IAAMC,EAAmC,CAC5C,MACA,MACA,QACA,OACA,QAIJ,ECLO,SAASC,EACZC,EACuC,CACvC,IAAMC,EAAuD,CAAC,EAE9D,OAAAD,EAAW,QAASE,GAAU,CACrBD,EAAYC,EAAM,EAAE,IACrBD,EAAYC,EAAM,EAAE,EAAI,CAAC,GAG7B,IAAMC,EAASD,EAAM,OAEfE,EAA+B,CACjC,KAAMF,EAAM,KACZ,KAAMC,EAAO,MAAQ,GACrB,YAAaD,EAAM,aAAe,EACtC,EAEAD,EAAYC,EAAM,EAAE,EAAE,KAAKE,CAAQ,CACvC,CAAC,EAEMH,CACX,CCtBO,SAASI,EAAmCC,EAAiD,CAChG,OAAO,OAAO,QAAQA,EAAE,YAAc,CAAC,CAAC,EAAE,IAAI,CAAC,CAACC,EAAMC,CAAI,IAAM,CAC5D,IAAIC,EAAUD,EAEVE,EAA+B,CAAC,EAWpC,GATID,EAAQ,QACRC,EAASD,EAAQ,MAAM,OAAO,CAACE,EAAKC,IACzB,CACH,GAAGD,EACH,GAAGN,EAAmCO,CAA4B,CACtE,EACD,CAAC,CAAyB,GAG7BH,EAAQ,OAAS,QAAS,CAC1B,IAAMI,EAAQJ,EAAQ,MAEtBC,EAASL,EAAmCQ,CAAK,CACrD,CAEA,MAAO,CACH,KAAMN,EACN,KAAME,EAAQ,MAAQ,GACtB,YAAaA,EAAQ,aAAe,GACpC,WACIC,GAAA,MAAAA,EAAQ,OACFA,EACAD,EAAQ,WAAaJ,EAAmCI,CAAO,EAAI,CAAC,CAElF,CACJ,CAAC,CACL,CC9BO,SAASK,EACZC,EAC2B,CAE3B,IAAMC,EAASD,EAAQ,QAAQ,kBAAkB,EAAE,OAE/CE,EAEJ,GAAID,EAAO,MACP,OAAOA,EAAO,MAAM,OAAO,CAACE,EAAKC,IAAO,CACpC,IAAMC,EAAwC,CAC1C,QAAS,CACL,mBAAoB,CAChB,OAAQD,CACZ,CACJ,CACJ,EAEA,MAAO,CACH,GAAGD,EACH,GAAGJ,EAAqCM,CAAQ,GAAK,CAAC,CAC1D,CACJ,EAAG,CAAC,CAAyB,EAGjC,OAAQJ,EAAO,KAAM,CACjB,IAAK,SAAU,CACXC,EAAeD,EACf,KACJ,CACA,IAAK,QAAS,CAKVC,EAJkBD,EAEM,MAGxB,KACJ,CACA,QAEI,KACR,CAEA,OAAKC,EAIEI,EAAmCJ,CAAY,EAH3C,IAIf,CCjDO,SAASK,EACZC,EAC2B,CAP/B,IAAAC,EAAAC,EAAAC,EAAAC,EAQI,IAAIC,EAEJ,GAAIL,EAAU,QAAY,CACtB,IAAMM,EAAIN,EAAU,QAEpBK,GAAeH,GAAAD,EAAAK,GAAA,YAAAA,EAAG,UAAH,YAAAL,EAAa,sBAAb,YAAAC,EAAkC,MACrD,SAAWF,EAAU,GAAK,EAAG,CACzB,IAAMM,EAAIN,EAAU,GAAK,EAEzBK,GAAeD,GAAAD,EAAAG,GAAA,YAAAA,EAAG,UAAH,YAAAH,EAAa,sBAAb,YAAAC,EAAkC,MACrD,CAEA,GAAI,CAACC,EACD,OAAO,KAGX,OAAQA,EAAa,KAAM,CACvB,IAAK,QAKDA,EAJkBA,EAEM,MAGxB,MACJ,QACI,KACR,CAEA,OAAOE,EAAmCF,CAAY,CAC1D,CCpCA,OAAOG,MAAS,MCAhB,OAA6C,qBAAAC,MAAwB,kBCDrE,OAAOC,MAAU,OACjB,OAAOC,MAAQ,KACf,OAAOC,MAAU,UACjB,OAAOC,MAAgB,yBAGvB,OAAQ,iBAAAC,MAAoB,kBAOrB,SAASC,EAAaC,EAAqB,CAC9C,OAAOA,EACF,MAAM,SAAS,EACf,IAAIC,GAAQA,EAAK,OAAO,CAAC,EAAE,YAAY,EAAIA,EAAK,MAAM,CAAC,EAAE,YAAY,CAAC,EACtE,KAAK,EAAE,CAChB,CAGA,SAASC,EAAgBC,EAAkB,CACvC,IAAMC,EAAMV,EAAK,QAAQS,CAAQ,EAAE,YAAY,EACzCE,EAAUV,EAAG,aAAaQ,EAAU,OAAO,EAEjD,GAAIC,IAAQ,SAAWA,IAAQ,OAC3B,OAAOR,EAAK,KAAKS,CAAO,EACrB,GAAID,IAAQ,QACf,OAAO,KAAK,MAAMC,CAAO,EAEzB,MAAM,IAAI,MAAM,4CAA4C,CAEpE,CAIA,eAAsBC,EAAkBC,EAAqB,CACzD,IAAMC,EAAcN,EAAgBK,CAAW,EAG/C,aAAMV,EAAW,YAAYW,CAAW,EAEjCA,CACX,CAGO,SAASC,EAA0BC,EAAsC,CAC5E,OAAQA,EAAQ,CACZ,IAAK,MACD,OAAOZ,EAAc,cACzB,IAAK,MACD,OAAOA,EAAc,cACzB,IAAK,QACD,OAAOA,EAAc,gBACzB,IAAK,OACD,OAAOA,EAAc,eACzB,IAAK,SACD,OAAOA,EAAc,iBAOzB,QACI,OAAO,IACf,CACJ,CDvDO,SAASa,EACZC,EACAC,EACAC,EACgB,CAChB,IAAMC,EAAQC,EAA0BJ,CAAU,EAElD,GAAI,CAACG,EACD,eAAQ,MAAM,4BAA4BH,CAAU,EAAE,EAC/C,KAGX,IAAMK,EAA4B,CAAC,EAC7BC,EAAgC,CAAC,EAEjCC,EAAYL,GAAA,YAAAA,EAAUF,GAE5B,GAAI,CAACO,EACD,OAAO,KAGX,IAAMC,EAAyB,CAC3B,OAAOD,GAAA,YAAAA,EAAW,UAAW,GAC7B,UAAWE,GAAaF,GAAA,YAAAA,EAAW,UAAW,EAAE,EAChD,aAAaA,GAAA,YAAAA,EAAW,cAAe,GAEvC,SAAUG,EAAkB,KAC5B,KAAMP,EAEN,QAAS,CACL,OAAQH,EAER,KAAM,GAAG,mBAAmBC,CAAI,CAAC,EACrC,EAEA,SAAU,CACN,OAAQK,CACZ,EACA,YAAaD,CACjB,EAEA,GAAIE,EAAU,WAAY,CACtB,IAAMI,EAAaJ,EAAU,WAEvBK,EAAeC,EAAoCF,CAAU,EAEnE,OAAO,QAAQC,CAAY,EAAE,QAAQ,CAAC,CAACE,EAAKC,CAAoB,IAAM,CAClE,IAAIC,EAGJ,OAAQF,EAAK,CACT,IAAK,OACDE,EAAQ,QACR,MACJ,IAAK,QACDA,EAAQ,QACR,MACJ,IAAK,SACDA,EAAQ,SACR,MACJ,QACI,QAAQ,MAAM,+BAA+BF,CAAG,QAAQd,CAAU,IAAIC,CAAI,EAAE,EAC5E,MACR,CAEAI,EAAY,KAAK,CACb,MAAAW,EACA,WAAYD,CAChB,CAAC,CACL,CAAC,CACL,CAEA,GAAIR,EAAU,YAAa,CACvB,IAAMU,EAAUV,EAAU,YAE1BF,EAAY,KAAK,CACb,MAAO,eACP,WAAYa,EAAqCD,CAAO,GAAK,CAAC,CAClE,CAAC,CACL,CAEA,GAAIV,EAAU,UAAW,CACrB,IAAMY,EAAYZ,EAAU,UAE5BF,EAAY,KAAK,CACb,MAAO,WACP,WAAYe,EAAkCD,CAAS,GAAK,CAAC,CACjE,CAAC,CACL,CAEA,OAAOX,CACX,CEnGA,OAAOa,MAAkB,yBACzB,OAAOC,MAAoB,kBAQpB,SAASC,EACZC,EACAC,EACc,CACd,IAAMC,EAAgC,CAAC,EAEvC,GAAID,EAAU,OAAO,YAAa,CAC9B,IAAME,EAAOF,EAAU,OAAO,YACxBG,EAASC,EACXF,EAAK,QAAQ,kBAAkB,EAAE,MACrC,EAEA,GAAI,CAACC,EACD,OAAOF,EAGX,IAAMI,EAAWR,EAAe,OAAOM,CAAM,EAGvC,CAAC,KAAAG,CAAI,EAAIV,EAAaG,EAAKC,EAAW,CACxC,KAAMK,CACV,EAAG,KAAM,OAAO,EAEVE,EAAsB,CAAC,EAE7BA,EAAS,KAAK,CACV,UAAW,CACP,KAAM,CAAC,CACH,MAAO,OACP,SAAU,OACV,KAAMD,GAAQ,EAClB,CAAC,CACL,CACJ,CAAC,EAEDL,EAAc,KAAK,CACf,YAAa,kBACb,SAAAM,CACJ,CAAC,CACL,CAEA,GAAIP,EAAU,OAAO,UAAW,CAC5B,IAAMQ,EAAYR,EAAU,OAAO,UAE7BO,EAAsB,CAAC,EAE7B,OAAO,QAAQC,CAAS,EAAE,QAAQ,CAAC,CAACC,EAAQC,CAAC,IAAM,CA3D3D,IAAAC,EA4DY,IAAMC,EAAWF,EACXP,GAASQ,EAAAC,GAAA,YAAAA,EAAU,UAAV,YAAAD,EAAoB,oBAAoB,OAEvD,GAAI,CAACR,EACD,OAGJ,IAAME,EAAWR,EAAe,OAAOM,CAAM,EAE7CI,EAAS,KAAK,CACV,UAAW,CACP,MAAOE,EACP,KAAM,CAAC,CACH,MAAO,OACP,SAAU,OACV,KAAM,KAAK,UAAUJ,EAAU,KAAM,CAAC,GAAK,EAC/C,CAAC,CACL,CACJ,CAAC,CACL,CAAC,EAEDJ,EAAc,KAAK,CACf,YAAa,WACb,SAAAM,CACJ,CAAC,CACL,CAEA,OAAON,CACX,CAaA,SAASG,EAAYD,EAAqB,CACtC,IAAMU,EAAiB,CAAC,GAAGV,CAAM,EAEjC,OAAIA,EAAO,OACPA,EAAO,MAAM,QAAQ,CAACW,EAAMC,IAAM,CAzG1C,IAAAJ,EA0GY,IAAMK,EAAUF,EAEZ,eAAgBE,GAAW,CAACA,EAAQ,cACpCL,EAAOE,EAAe,QAAtB,aAAAF,EAA8BI,GAEtC,CAAC,EAGEF,CACX,CHrGO,SAASI,EACZC,EACW,CAhBf,IAAAC,EAAAC,EAiBI,IAAMC,EAA0B,CAAC,EAC3BC,EAAM,IAAIC,EAAIL,CAAa,EAE3BM,IAASJ,GAAAD,EAAAD,EAAO,UAAP,YAAAC,EAAiB,KAAjB,YAAAC,EAAqB,MAAO,GAE3C,cAAO,QAAQF,EAAO,KAAK,EAAE,QAAQ,CAAC,CAACO,EAAMC,CAAO,IAAM,CACtDC,EAAuB,QAASC,GAAe,CAC3C,IAAMC,EAAaD,EAAW,YAAY,EAE1C,OAAQC,EAAY,CAChB,IAAK,MACD,MACJ,IAAK,MACD,MACJ,IAAK,OACD,MACJ,IAAK,SACD,MACJ,IAAK,QACD,MACJ,QACI,QAAQ,MAAM,4BAA4BA,CAAU,EAAE,EACtD,MACR,CAEA,IAAMC,EAAYC,EACdF,EACAJ,EACAC,CACJ,EAEA,GAAII,EAAW,CACX,IAAME,EAAMF,EAAU,QACtBE,EAAI,KAAO,GAAG,mBAAmBR,CAAM,CAAC,GAAG,mBAAmBC,CAAI,CAAC,GAEnE,IAAMQ,EAAYX,EAAI,UAAUG,EAAMI,CAAU,EAChDC,EAAU,SAAS,OAASI,EAAYZ,EAAKW,CAAS,EAEtDZ,EAAW,KAAKS,CAAS,CAC7B,CACJ,CAAC,CACL,CAAC,EAEMT,CACX,CNvDA,OAAOc,MAAQ,MAEd,SAAY,CACT,IAAMC,EAAcC,EAAK,KAAK,QAAQ,IAAI,EAAG,8BAA8B,EACrEC,EAAS,MAAMC,EAAkBH,CAAW,EAC5CI,EAAaC,EAAsBH,CAAM,EAE/C,QAAQ,IAAID,EAAK,KAAK,QAAQ,IAAI,EAAG,iCAAiC,CAAC,EACvEF,EAAG,cAAcE,EAAK,KAAK,QAAQ,IAAI,EAAG,iCAAiC,EAAG,KAAK,UAAUG,EAAY,KAAM,CAAC,CAAC,EACjH,QAAQ,IAAI,CAAC,CACjB,GAAG","names":["path","SUPPORTED_HTTP_METHODS","oapParametersToDefinitionProperties","parameters","parameterIn","param","schema","property","schemaObjectToDefinitionProperties","v","name","prop","objProp","merged","acc","of","items","oapRequestBodyToDefinitionProperties","reqBody","schema","schemaObject","acc","of","fakeBody","schemaObjectToDefinitionProperties","oapResponseToDefinitionProperties","responses","_a","_b","_c","_d","schemaObject","w","schemaObjectToDefinitionProperties","Oas","ReferenceCategory","path","fs","yaml","$refParser","ReferenceType","toPascalCase","str","word","readOpenApiSpec","filePath","ext","content","deferencedOpenAPI","openApiPath","openApiSpec","httpMethodToUniformMethod","method","oapPathToReference","httpMethod","path","oapPath","mType","httpMethodToUniformMethod","definitions","exampleGroups","oapMethod","endpointRef","toPascalCase","ReferenceCategory","parameters","paramtersMap","oapParametersToDefinitionProperties","key","definitionProperties","title","reqBody","oapRequestBodyToDefinitionProperties","responses","oapResponseToDefinitionProperties","oasToSnippet","OpenAPISampler","oapExamples","oas","operation","exampleGroups","body","schema","fixAllOfBug","fakeData","code","examples","responses","status","r","_a","response","modifiedSchema","prop","i","propObj","oapSchemaToReferences","schema","_a","_b","references","oas","Oas","server","path","oapPath","SUPPORTED_HTTP_METHODS","eachMethod","httpMethod","reference","oapPathToReference","ctx","operation","oapExamples","fs","openApiPath","path","schema","deferencedOpenAPI","references","oapSchemaToReferences"]}

package/examples/semi/index.ts

@@ -0,0 +1,16 @@
+import path from 'path';
+
+import {
+    deferencedOpenAPI,
+    oapSchemaToReferences,
+} from "../../src";
+import fs from "fs";
+
+(async () => {
+    const openApiPath = path.join(process.cwd(), './examples/semi/openapi.yaml');
+    const schema = await deferencedOpenAPI(openApiPath)
+    const references = oapSchemaToReferences(schema)
+
+    fs.writeFileSync(path.join(process.cwd(), './examples/semi/references.json'), JSON.stringify(references, null, 2))
+})()
+

package/examples/semi/openapi.yaml

@@ -0,0 +1,365 @@
+openapi: 3.1.0
+
+info:
+  title: LiveSession API
+  version: v1
+
+servers:
+  - url: https://api.livesession.io/v1
+    description: Production server (uses live data)
+
+paths:
+  # BEGIN Sessions
+  /sessions:
+    get:
+      summary: Get Sessions
+      security:
+        - livesession_oauth: [ users.sessions:read ]
+        - api_token: [ users.sessions:read ]
+      description: |
+        ---
+        title: List sessions
+        group: [ENDPOINTS]
+        ---
+        
+        List of all sessions
+      tags:
+        - Sessions
+      parameters:
+        - name: page
+          in: query
+          description: The number of page to start with (default 0, max 10000).
+          schema:
+            type: integer
+        - name: size
+          in: query
+          description: The number of page's size (default 25, max 100).
+          schema:
+            type: integer
+        - name: email
+          in: query
+          description: The email address that you have associated with a session via [identify](https://developers.livesession.io/javascript-api/methods/#identify).
+          schema:
+            type: string
+        - name: visitor_id
+          in: query
+          description: The visitor ID.
+          schema:
+            type: string
+        - name: tz
+          in: query
+          description: IANA timezone. Default Europe/London if RelativeDateString is applied.
+          schema:
+            type: string
+        - name: date_from
+          in: query
+          description: ISO 8601 string or RelativeDateString. For RelativeDateString see table below for possible values.
+          schema:
+            oneOf:
+              - type: string
+              - $ref: '#/components/schemas/RelativeDateString'
+        - name: date_to
+          in: query
+          description: ISO 8601 string or [RelativeDateString](#/components/schemas/RelativeDateString). For RelativeDateString see table below for possible values.
+          schema:
+            oneOf:
+              - type: string
+              - $ref: '#/components/schemas/RelativeDateString'
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetListSessionsResponse'
+        '400':
+          description: 400 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: 500 response
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+
+components:
+  securitySchemes:
+    api_token:
+      type: apiKey
+      name: Authorization
+      description: "[API Tokens](https://developers.livesession.io/rest-api/introduction/#creating-a-personal-access-token)"
+      in: header
+
+    livesession_oauth:
+      type: oauth2
+      flows:
+        authorizationCode:
+          authorizationUrl: https://apis.livesession.io/accounts/v1/oauth2/authorize # TODO: more friendly url
+          tokenUrl: https://apis.livesession.io/accounts/v1/oauth2/access_token # TODO: more friendly url
+          refreshUrl: https://apis.livesession.io/accounts/v1/oauth2/access_token # TODO: more friendly url
+          scopes:
+            users.sessions:read: read user sessions
+
+            webhooks:read: read webhooks
+            webhooks:write: write webhooks
+
+            alerts:read: read alerts
+            alerts:write: write alerts
+
+            websites:read: read websites
+            websites:write: write websites
+
+            payment_intents:write: write payment intents
+            payment_intents.confirm: confirm payment intents
+
+  schemas:
+
+    # BEGIN Errors
+    ErrorResponse:
+      type: object
+      properties:
+        error:
+          type: object
+          properties:
+            type:
+              type: string
+            code:
+              type: string
+            param:
+              type: string
+            message:
+              type: string
+            http_status_code:
+              type: integer
+            request_id:
+              type: string
+
+    # END Errors
+
+    # BEGIN Sessions
+    Session:
+      type: object
+      properties:
+        id:
+          type: string
+        website_id:
+          type: string
+        session_url:
+          type: string
+        creation_timestamp:
+          type: integer
+        duration:
+          type: integer
+        end_timestamp:
+          type: integer
+        active_time:
+          type: integer
+        end_url:
+          type: string
+        expiration_timestamp:
+          type: integer
+        last_event_timestamp:
+          type: integer
+        product:
+          type: string
+        device:
+          type: string
+        tags:
+          type: array
+          items:
+            type: string
+        last_seen_page_view_id:
+          type: string
+        seen:
+          type: boolean
+        referrer:
+          type: string
+        start_url:
+          type: string
+        visitor_first_session:
+          type: boolean
+        engagment_score:
+          type: number
+        visitor:
+          $ref: '#/components/schemas/SessionVisitorData'
+        resolution:
+          $ref: '#/components/schemas/SessionResolutionData'
+        os:
+          $ref: '#/components/schemas/SessionOsData'
+        browser:
+          $ref: '#/components/schemas/SessionBrowserData'
+        utm:
+          $ref: '#/components/schemas/SessionUTMData'
+        page_views_statistics:
+          $ref: '#/components/schemas/SessionPageViewsStatisticsData'
+        events_statistics:
+          $ref: '#/components/schemas/SessionEventsStatisticsData'
+
+    SessionVisitorData:
+      type: object
+      properties:
+        id:
+          type: string
+        ip:
+          type: string
+        geolocation:
+          $ref: '#/components/schemas/SessionVisitorDataGeolocation'
+        name:
+          type: string
+        email:
+          type: string
+        email_hash:
+          type: string
+        params:
+          type: array
+          items:
+            $ref: '#/components/schemas/SessionVisitorDataParams'
+        last_session_timestamp:
+          type: integer
+        first_session_timestamp:
+          type: integer
+
+    SessionOsData:
+      type: object
+      properties:
+        name:
+          type: string
+        version:
+          type: string
+
+    SessionBrowserData:
+      type: object
+      properties:
+        description:
+          type: string
+        name:
+          type: string
+        version:
+          type: string
+
+    SessionUTMData:
+      type: object
+      properties:
+        source:
+          type: string
+        medium:
+          type: string
+        campaign:
+          type: string
+        term:
+          type: string
+        content:
+          type: string
+
+    SessionEventsStatisticsData:
+      type: object
+      properties:
+        clicks:
+          type: integer
+        error_clicks:
+          type: integer
+        rage_clicks:
+          type: integer
+        error_logs:
+          type: integer
+        net_errors:
+          type: integer
+
+    SessionPageViewLocationData:
+      type: object
+      properties:
+        base:
+          type: string
+        href:
+          type: string
+        origin:
+          type: string
+        referrer:
+          type: string
+
+    SessionPageViewViewPortData:
+      type: object
+      properties:
+        height:
+          type: integer
+        width:
+          type: integer
+
+    SessionVisitorDataGeolocation:
+      type: object
+      properties:
+        country_code:
+          type: string
+        city:
+          type: string
+        region:
+          type: string
+
+    SessionVisitorDataParams:
+      type: object
+      properties:
+        name:
+          type: string
+        value:
+          type: string
+
+    SessionResolutionData:
+      type: object
+      properties:
+        height:
+          type: integer
+        width:
+          type: integer
+        resolution:
+          type: string
+
+    SessionPageViewsStatisticsData:
+      type: object
+      properties:
+        count:
+          type: integer
+
+    GetListSessionsResponse:
+      type: object
+      properties:
+        total:
+          type: integer
+        page:
+          $ref: '#/components/schemas/Pagination'
+        sessions:
+          type: array
+          items:
+            $ref: '#/components/schemas/Session'
+
+    Pagination:
+      type: object
+      properties:
+        num:
+          type: integer
+        size:
+          type: integer
+
+    RelativeDateString:
+      type: string
+      description: |
+        * `TODAY` - Today since midnight
+        * `YESTERDAY` - Yesterday since midnight
+        * `BEGINNING_OF_WEEK` - Nearest monday since midnight
+        * `BEGINNING_OF_MONTH` - 1st of the month since midnight
+        * `BEGINNING_OF_PREV_MONTH` - Previous 1st of the month since midnight
+        * `TODAY-7DAYS` - Exact 7 days ago since midnight
+        * `TODAY-30DAYS` - Exact 30 days ago since midnight
+      enum:
+        - TODAY
+        - YESTERDAY
+        - BEGINNING_OF_WEEK
+        - BEGINNING_OF_MONTH
+        - BEGINNING_OF_PREV_MONTH
+        - TODAY-7DAYS
+        - TODAY-30DAYS
+    # END Sessions
+
+