openapi-typescript/dist/transform/path-item-object.cjs.map

Convert OpenAPI 3.0 & 3.1 schemas to TypeScript

{"version":3,"file":"path-item-object.cjs","sources":["../../src/transform/path-item-object.ts"],"sourcesContent":["import ts from \"typescript\";\nimport { NEVER, QUESTION_TOKEN, addJSDocComment, oapiRef, tsModifiers, tsPropertyIndex } from \"../lib/ts.js\";\nimport { createRef } from \"../lib/utils.js\";\nimport type {\n  OperationObject,\n  ParameterObject,\n  PathItemObject,\n  ReferenceObject,\n  TransformNodeOptions,\n} from \"../types.js\";\nimport transformOperationObject, { injectOperationObject } from \"./operation-object.js\";\nimport { transformParametersArray } from \"./parameters-array.js\";\n\nexport type Method = \"get\" | \"put\" | \"post\" | \"delete\" | \"options\" | \"head\" | \"patch\" | \"trace\";\n\n/**\n * Transform PathItem nodes (4.8.9)\n * @see https://spec.openapis.org/oas/v3.1.0#path-item-object\n */\nexport default function transformPathItemObject(pathItem: PathItemObject, options: TransformNodeOptions): ts.TypeNode {\n  const type: ts.TypeElement[] = [];\n\n  // parameters\n  type.push(\n    ...transformParametersArray(pathItem.parameters ?? [], {\n      ...options,\n      path: createRef([options.path, \"parameters\"]),\n    }),\n  );\n\n  // methods\n  for (const method of [\"get\", \"put\", \"post\", \"delete\", \"options\", \"head\", \"patch\", \"trace\"] as Method[]) {\n    const operationObject = pathItem[method];\n    if (\n      !operationObject ||\n      (options.ctx.excludeDeprecated &&\n        (\"$ref\" in operationObject ? options.ctx.resolve<OperationObject>(operationObject.$ref) : operationObject)\n          ?.deprecated)\n    ) {\n      type.push(\n        ts.factory.createPropertySignature(\n          /* modifiers     */ tsModifiers({ readonly: options.ctx.immutable }),\n          /* name          */ tsPropertyIndex(method),\n          /* questionToken */ QUESTION_TOKEN,\n          /* type          */ NEVER,\n        ),\n      );\n      continue;\n    }\n\n    // fold top-level PathItem parameters into method-level, with the latter overriding the former\n    const keyedParameters: Record<string, ParameterObject | ReferenceObject> = {};\n    if (!(\"$ref\" in operationObject)) {\n      // important: OperationObject parameters come last, and will override any conflicts with PathItem parameters\n      for (const parameter of [...(pathItem.parameters ?? []), ...(operationObject.parameters ?? [])]) {\n        // fix: #1798, use unique key\n        const name =\n          \"$ref\" in parameter\n            ? `${options.ctx.resolve<ParameterObject>(parameter.$ref)?.in}-${options.ctx.resolve<ParameterObject>(parameter.$ref)?.name}`\n            : `${parameter.in}-${parameter.name}`;\n        if (name) {\n          keyedParameters[name] = parameter;\n        }\n      }\n    }\n\n    let operationType: ts.TypeNode;\n    if (\"$ref\" in operationObject) {\n      operationType = oapiRef(operationObject.$ref);\n    }\n    // if operationId exists, move into an `operations` export and pass the reference in here\n    else if (operationObject.operationId) {\n      // workaround for issue caused by redocly ref parsing: https://github.com/openapi-ts/openapi-typescript/issues/1542\n      const operationId = operationObject.operationId.replace(HASH_RE, \"/\");\n      operationType = oapiRef(createRef([\"operations\", operationId]));\n      injectOperationObject(\n        operationId,\n        { ...operationObject, parameters: Object.values(keyedParameters) },\n        { ...options, path: createRef([options.path, method]) },\n      );\n    } else {\n      operationType = ts.factory.createTypeLiteralNode(\n        transformOperationObject(\n          { ...operationObject, parameters: Object.values(keyedParameters) },\n          { ...options, path: createRef([options.path, method]) },\n        ),\n      );\n    }\n    const property = ts.factory.createPropertySignature(\n      /* modifiers     */ tsModifiers({ readonly: options.ctx.immutable }),\n      /* name          */ tsPropertyIndex(method),\n      /* questionToken */ undefined,\n      /* type          */ operationType,\n    );\n    addJSDocComment(operationObject, property);\n    type.push(property);\n  }\n\n  return ts.factory.createTypeLiteralNode(type);\n}\n\nconst HASH_RE = /#/g;\n"],"names":["transformParametersArray","createRef","operationObject","ts","tsModifiers","tsPropertyIndex","QUESTION_TOKEN","NEVER","oapiRef","injectOperationObject","transformOperationObject","addJSDocComment"],"mappings":";;;;;;;;;;;;AAmBwB,SAAA,uBAAA,CAAwB,UAA0B,OAA4C,EAAA;AACpH,EAAA,MAAM,OAAyB,EAAC;AAGhC,EAAK,IAAA,CAAA,IAAA;AAAA,IACH,GAAGA,wCAAA,CAAyB,QAAS,CAAA,UAAA,IAAc,EAAI,EAAA;AAAA,MACrD,GAAG,OAAA;AAAA,MACH,MAAMC,eAAU,CAAA,CAAC,OAAQ,CAAA,IAAA,EAAM,YAAY,CAAC;AAAA,KAC7C;AAAA,GACH;AAGA,EAAW,KAAA,MAAA,MAAA,IAAU,CAAC,KAAA,EAAO,KAAO,EAAA,MAAA,EAAQ,UAAU,SAAW,EAAA,MAAA,EAAQ,OAAS,EAAA,OAAO,CAAe,EAAA;AACtG,IAAM,MAAAC,iBAAA,GAAkB,SAAS,MAAM,CAAA;AACvC,IAAA,IACE,CAACA,iBAAA,IACA,OAAQ,CAAA,GAAA,CAAI,sBACV,MAAU,IAAAA,iBAAA,GAAkB,OAAQ,CAAA,GAAA,CAAI,OAAyB,CAAAA,iBAAA,CAAgB,IAAI,CAAA,GAAIA,oBACtF,UACN,EAAA;AACA,MAAK,IAAA,CAAA,IAAA;AAAA,QACHC,YAAG,OAAQ,CAAA,uBAAA;AAAA;AAAA,UACWC,iBAAY,EAAE,QAAA,EAAU,OAAQ,CAAA,GAAA,CAAI,WAAW,CAAA;AAAA;AAAA,UAC/CC,qBAAgB,MAAM,CAAA;AAAA;AAAA,UACtBC,mBAAA;AAAA;AAAA,UACAC;AAAA;AACtB,OACF;AACA,MAAA;AAAA;AAIF,IAAA,MAAM,kBAAqE,EAAC;AAC5E,IAAI,IAAA,EAAE,UAAUL,iBAAkB,CAAA,EAAA;AAEhC,MAAA,KAAA,MAAW,SAAa,IAAA,CAAC,GAAI,QAAA,CAAS,UAAc,IAAA,EAAK,EAAA,GAAIA,iBAAgB,CAAA,UAAA,IAAc,EAAG,CAAG,EAAA;AAE/F,QAAM,MAAA,IAAA,GACJ,MAAU,IAAA,SAAA,GACN,CAAG,EAAA,OAAA,CAAQ,IAAI,OAAyB,CAAA,SAAA,CAAU,IAAI,CAAA,EAAG,EAAE,CAAA,CAAA,EAAI,QAAQ,GAAI,CAAA,OAAA,CAAyB,SAAU,CAAA,IAAI,CAAG,EAAA,IAAI,CACzH,CAAA,GAAA,CAAA,EAAG,SAAU,CAAA,EAAE,CAAI,CAAA,EAAA,SAAA,CAAU,IAAI,CAAA,CAAA;AACvC,QAAA,IAAI,IAAM,EAAA;AACR,UAAA,eAAA,CAAgB,IAAI,CAAI,GAAA,SAAA;AAAA;AAC1B;AACF;AAGF,IAAI,IAAA,aAAA;AACJ,IAAA,IAAI,UAAUA,iBAAiB,EAAA;AAC7B,MAAgB,aAAA,GAAAM,YAAA,CAAQN,kBAAgB,IAAI,CAAA;AAAA,KAC9C,MAAA,IAESA,kBAAgB,WAAa,EAAA;AAEpC,MAAA,MAAM,WAAc,GAAAA,iBAAA,CAAgB,WAAY,CAAA,OAAA,CAAQ,SAAS,GAAG,CAAA;AACpE,MAAA,aAAA,GAAgBM,aAAQP,eAAU,CAAA,CAAC,YAAc,EAAA,WAAW,CAAC,CAAC,CAAA;AAC9D,MAAAQ,qCAAA;AAAA,QACE,WAAA;AAAA,QACA,EAAE,GAAGP,iBAAA,EAAiB,YAAY,MAAO,CAAA,MAAA,CAAO,eAAe,CAAE,EAAA;AAAA,QACjE,EAAE,GAAG,OAAA,EAAS,IAAM,EAAAD,eAAA,CAAU,CAAC,OAAQ,CAAA,IAAA,EAAM,MAAM,CAAC,CAAE;AAAA,OACxD;AAAA,KACK,MAAA;AACL,MAAA,aAAA,GAAgBE,YAAG,OAAQ,CAAA,qBAAA;AAAA,QACzBO,uBAAA;AAAA,UACE,EAAE,GAAGR,iBAAA,EAAiB,YAAY,MAAO,CAAA,MAAA,CAAO,eAAe,CAAE,EAAA;AAAA,UACjE,EAAE,GAAG,OAAA,EAAS,IAAM,EAAAD,eAAA,CAAU,CAAC,OAAQ,CAAA,IAAA,EAAM,MAAM,CAAC,CAAE;AAAA;AACxD,OACF;AAAA;AAEF,IAAM,MAAA,QAAA,GAAWE,YAAG,OAAQ,CAAA,uBAAA;AAAA;AAAA,MACNC,iBAAY,EAAE,QAAA,EAAU,OAAQ,CAAA,GAAA,CAAI,WAAW,CAAA;AAAA;AAAA,MAC/CC,qBAAgB,MAAM,CAAA;AAAA;AAAA,MACtB,MAAA;AAAA;AAAA,MACA;AAAA,KACtB;AACA,IAAAM,oBAAA,CAAgBT,mBAAiB,QAAQ,CAAA;AACzC,IAAA,IAAA,CAAK,KAAK,QAAQ,CAAA;AAAA;AAGpB,EAAO,OAAAC,WAAA,CAAG,OAAQ,CAAA,qBAAA,CAAsB,IAAI,CAAA;AAC9C;AAEA,MAAM,OAAU,GAAA,IAAA;;;;"}