Merge branch 'release'

Author: b41ex

.gitignore

@@ -5,7 +5,6 @@ temp
 coverage
 .idea
 .DS_store
-export
 dist/
 *.iml
 test/versions/

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@netcracker/qubership-apihub-api-processor",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "",
   "license": "Apache-2.0",
   "module": "dist/esm/src/index.js",
@@ -31,10 +31,10 @@
     "update-lock-file": "update-lock-file @netcracker"
   },
   "dependencies": {
-    "@netcracker/qubership-apihub-api-diff": "2.0.1",
-    "@netcracker/qubership-apihub-api-unifier": "2.0.0",
-    "@netcracker/qubership-apihub-json-crawl": "1.0.4",
+    "@netcracker/qubership-apihub-api-diff": "2.0.2",
+    "@netcracker/qubership-apihub-api-unifier": "2.1.0",
     "@netcracker/qubership-apihub-graphapi": "1.0.8",
+    "@netcracker/qubership-apihub-json-crawl": "1.0.4",
     "adm-zip": "0.5.10",
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
@@ -53,6 +53,7 @@
     "@types/adm-zip": "0.5.7",
     "@types/jest": "^29.5.12",
     "@types/js-yaml": "^4.0.5",
+    "@types/mime-types": "^3.0.0",
     "@types/node": "^18.0.0",
     "@types/object-hash": "^3.0.2",
     "@types/slug": "^5.0.3",
@@ -64,6 +65,7 @@
     "eslint-plugin-sort-exports": "^0.8.0",
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
+    "mime-types": "^3.0.1",
     "openapi-types": "^12.1.0",
     "ts-jest": "29.1.2",
     "ts-node": "^10.9.1",
@@ -80,4 +82,4 @@
   "engines": {
     "node": ">=18.0.0"
   }
-}
+}

package.json

@@ -16,7 +16,7 @@
 
 import { OpenAPIV3 } from 'openapi-types'
 
-import { buildRestDocument, dumpRestDocument } from './rest.document'
+import { buildRestDocument, createRestExportDocument, dumpRestDocument } from './rest.document'
 import { REST_API_TYPE, REST_DOCUMENT_TYPE } from './rest.consts'
 import { compareRestOperationsData } from './rest.changes'
 import { buildRestOperations, createNormalizedOperationId } from './rest.operations'
@@ -35,4 +35,5 @@ export const restApiBuilder: ApiBuilder<OpenAPIV3.Document> = {
   dumpDocument: dumpRestDocument,
   compareOperationsData: compareRestOperationsData,
   createNormalizedOperationId: createNormalizedOperationId,
+  createExportDocument: createRestExportDocument,
 }

src/apitypes/rest/index.ts

@@ -15,6 +15,8 @@
  */
 
 import { FILE_FORMAT_JSON, FILE_FORMAT_YAML, FILE_FORMAT_YML } from '../../consts'
+import { KeyOfConstType, ResolvedVersionDocument, ZippableDocument } from '../../types'
+import { TEXT_DOCUMENT_TYPE, TextDocumentType } from '../text'
 
 export const REST_API_TYPE = 'rest' as const
 
@@ -33,12 +35,22 @@ export const REST_DOCUMENT_TYPE = {
   SWAGGER: 'openapi-2-0',
 } as const
 
+export type RestDocumentType = KeyOfConstType<typeof REST_DOCUMENT_TYPE>
+
 export const REST_FILE_FORMAT = {
   YAML: FILE_FORMAT_YAML,
   YML: FILE_FORMAT_YML,
   JSON: FILE_FORMAT_JSON,
-}
+} as const
 
 export const REST_KIND_KEY = 'x-api-kind'
 
 export const DEPRECATED_META_KEY = 'x-deprecated-meta'
+
+export function isRestDocument(document: ZippableDocument | ResolvedVersionDocument): boolean {
+  return Object.values(REST_DOCUMENT_TYPE).includes(document.type as RestDocumentType)
+}
+
+export function isTextDocument(document: ResolvedVersionDocument): boolean {
+  return Object.values(TEXT_DOCUMENT_TYPE).includes(document.type as TextDocumentType)
+}

src/apitypes/rest/rest.consts.ts

@@ -20,10 +20,24 @@ import { convertObj } from 'swagger2openapi'
 import { REST_DOCUMENT_TYPE, REST_KIND_KEY } from './rest.consts'
 import type { RestDocumentInfo } from './rest.types'
 
-import { DocumentBuilder, DocumentDumper, YAML_EXPORT_GROUP_FORMAT } from '../../types'
-import { FILE_FORMAT } from '../../consts'
-import { createBundlingErrorHandler, getBundledFileDataWithDependencies, getDocumentTitle } from '../../utils'
-import YAML from 'js-yaml'
+import {
+  _TemplateResolver,
+  DocumentBuilder,
+  DocumentDumper,
+  ExportDocument,
+  ExportFormat,
+} from '../../types'
+import { FILE_FORMAT, FILE_FORMAT_HTML, FILE_FORMAT_JSON } from '../../consts'
+import {
+  createBundlingErrorHandler,
+  EXPORT_FORMAT_TO_FILE_FORMAT,
+  getBundledFileDataWithDependencies,
+  getDocumentTitle,
+} from '../../utils'
+import { dump } from './rest.utils'
+import { generateHtmlPage } from '../../utils/export'
+import { removeOasExtensions } from '../../utils/removeOasExtensions'
+import { OpenApiExtensionKey } from '@netcracker/qubership-apihub-api-unifier'
 
 const openApiDocumentMeta = (data: OpenAPIV3.Document): RestDocumentInfo => {
   if (typeof data !== 'object' || !data) {
@@ -99,8 +113,41 @@ export const buildRestDocument: DocumentBuilder<OpenAPIV3.Document> = async (par
 }
 
 export const dumpRestDocument: DocumentDumper<OpenAPIV3.Document> = (document, format) => {
-  if (format === YAML_EXPORT_GROUP_FORMAT) {
-    return new Blob([YAML.dump(document.data)], { type: 'application/yaml' })
+  return new Blob(...dump(document.data, format ?? FILE_FORMAT_JSON))
+}
+
+export async function createRestExportDocument(
+  filename: string,
+  data: string,
+  format: ExportFormat,
+  packageName: string,
+  version: string,
+  templateResolver: _TemplateResolver,
+  allowedOasExtensions?: OpenApiExtensionKey[],
+  generatedHtmlExportDocuments?: ExportDocument[],
+  addBackLink?: boolean,
+): Promise<ExportDocument> {
+  const exportFilename = `${getDocumentTitle(filename)}.${format}`
+  const [[document], blobProperties] = dump(removeOasExtensions(JSON.parse(data), allowedOasExtensions), EXPORT_FORMAT_TO_FILE_FORMAT.get(format)!)
+
+  if (format === FILE_FORMAT_HTML) {
+    const htmlExportDocument = {
+      data: await generateHtmlPage(
+        document,
+        getDocumentTitle(filename),
+        packageName,
+        version,
+        templateResolver,
+        addBackLink,
+      ),
+      filename: exportFilename,
+    }
+    generatedHtmlExportDocuments?.push(htmlExportDocument)
+    return htmlExportDocument
+  }
+
+  return {
+    data: new Blob([document], blobProperties),
+    filename: exportFilename,
   }
-  return new Blob([JSON.stringify(document.data, undefined, 2)], { type: 'application/json' })
 }

src/apitypes/rest/rest.document.ts

@@ -56,7 +56,7 @@ export const parseRestFile = async (fileId: string, source: Blob): Promise<TextF
         kind: FILE_KIND.TEXT,
       }
     }
-  } else if ([REST_FILE_FORMAT.YAML, REST_FILE_FORMAT.YML].includes(extension) || !extension) {
+  } else if (([REST_FILE_FORMAT.YAML, REST_FILE_FORMAT.YML] as string[]).includes(extension) || !extension) {
     if (/\s*?'?"?openapi'?"?\s*?:\s*?\|?\s*'?"?3\.[01]\..+?'?"?/g.test(sourceString)) {
       const data = YAML.load(sourceString) as OpenAPIV3.Document
 

src/apitypes/rest/rest.parser.ts

@@ -18,7 +18,8 @@ import { OpenAPIV3 } from 'openapi-types'
 import { CustomTags } from './rest.types'
 import { API_AUDIENCE_EXTERNAL, API_AUDIENCE_INTERNAL, API_AUDIENCE_UNKNOWN, ApiAudience } from '../../types'
 import { isObject } from '@netcracker/qubership-apihub-json-crawl'
-import { CUSTOM_PARAMETER_API_AUDIENCE } from '../../consts'
+import { CUSTOM_PARAMETER_API_AUDIENCE, FILE_FORMAT_JSON, FILE_FORMAT_YAML } from '../../consts'
+import YAML from 'js-yaml'
 
 export const getOperationBasePath = (servers?: OpenAPIV3.ServerObject[]): string => {
   if (!Array.isArray(servers) || !servers.length) { return '' }
@@ -65,3 +66,15 @@ export const resolveApiAudience = (info: unknown): ApiAudience => {
   apiAudience = [API_AUDIENCE_INTERNAL, API_AUDIENCE_EXTERNAL].includes(apiAudience) ? apiAudience : API_AUDIENCE_UNKNOWN
   return apiAudience
 }
+
+type TextBlobConstructorParameters = [[string], BlobPropertyBag]
+
+export const dump = (value: unknown, format: typeof FILE_FORMAT_YAML | typeof FILE_FORMAT_JSON): TextBlobConstructorParameters => {
+  if (format === FILE_FORMAT_YAML) {
+    return [[YAML.dump(value)], { type: 'application/yaml' }]
+  }
+  if (format === FILE_FORMAT_JSON) {
+    return [[JSON.stringify(value, undefined, 2)], { type: 'application/json' }]
+  }
+  throw new Error(`Unsupported format: ${format}`)
+}

src/apitypes/rest/rest.utils.ts

@@ -13,13 +13,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { KeyOfConstType } from '../../types'
 
 export const TEXT_API_TYPE = 'text' as const
 
 export const TEXT_DOCUMENT_TYPE = {
   MARKDOWN: 'markdown',
 } as const
 
+export type TextDocumentType = KeyOfConstType<typeof TEXT_DOCUMENT_TYPE>
+
 export const TEXT_FILE_FORMAT = {
   MD: 'md',
 } as const

src/apitypes/text/text.consts.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import { BuildConfigFile, DocumentBuilder, DocumentDumper, File, VersionDocument } from '../../types'
+import { BuildConfigFile, DocumentBuilder, DocumentDumper, SourceFile, VersionDocument } from '../../types'
 import { createBundlingErrorHandler, getBundledFileDataWithDependencies, getDocumentTitle } from '../../utils'
 import { FILE_FORMAT } from '../../consts'
 
@@ -57,7 +57,7 @@ export const buildUnknownDocument: DocumentBuilder<string> = async (parsedFile,
   }
 }
 
-export const buildBinaryDocument: (parsedFile: File, file: BuildConfigFile) => Promise<VersionDocument> = async (parsedFile, file) => {
+export const buildBinaryDocument: (parsedFile: SourceFile, file: BuildConfigFile) => Promise<VersionDocument> = async (parsedFile, file) => {
   const { fileId, slug = '', publish, ...metadata } = file
   const { type, format, source } = parsedFile