feat: support doc and version export to html

Author: CountRedClaw

package-lock.json

@@ -33,8 +33,8 @@
   "dependencies": {
     "@netcracker/qubership-apihub-api-diff": "feature-remove-oas-extensions",
     "@netcracker/qubership-apihub-api-unifier": "feature-remove-oas-extensions",
-    "@netcracker/qubership-apihub-json-crawl": "1.0.4",
     "@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",
@@ -50,9 +50,11 @@
   },
   "devDependencies": {
     "@netcracker/qubership-apihub-npm-gitflow": "3.0.1",
+    "@rollup/plugin-url": "^8.0.2",
     "@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,7 +66,9 @@
     "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",
+    "rollup-plugin-copy": "^3.5.0",
     "ts-jest": "29.1.2",
     "ts-node": "^10.9.1",
     "tslint": "^6.1.3",

package.json

@@ -15,6 +15,7 @@
  */
 
 import { FILE_FORMAT_JSON, FILE_FORMAT_YAML, FILE_FORMAT_YML } from '../../consts'
+import { KeyOfConstType, ResolvedVersionDocument } from '../../types'
 
 export const REST_API_TYPE = 'rest' as const
 
@@ -33,6 +34,8 @@ 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,
@@ -42,3 +45,7 @@ export const REST_FILE_FORMAT = {
 export const REST_KIND_KEY = 'x-api-kind'
 
 export const DEPRECATED_META_KEY = 'x-deprecated-meta'
+
+export function isRestDocument(document: ResolvedVersionDocument): boolean {
+  return Object.values(REST_DOCUMENT_TYPE).includes(document.type as RestDocumentType)
+}

src/apitypes/rest/rest.consts.ts

@@ -30,9 +30,9 @@ import {
   ResolvedGroupDocuments,
   ResolvedOperations,
   ResolvedVersionDocuments,
-  ResolvedVersionOperationsHashMap,
   VersionId,
   VersionsComparison,
+  ZippableDocument,
 } from './types'
 import {
   ApiBuilder,
@@ -74,7 +74,7 @@ import { BuildStrategy, ChangelogStrategy, DocumentGroupStrategy, PrefixGroupsCh
 import { BuilderStrategyContext } from './builder-strategy'
 import { MergedDocumentGroupStrategy } from './strategies/merged-document-group.strategy'
 import { asyncDebugPerformance } from './utils/logs'
-import { ExportRestOperationsGroupStrategy } from './strategies/rest-operations-group.strategy'
+// import { ExportRestOperationsGroupStrategy } from './strategies/rest-operations-group.strategy'
 import { ExportVersionStrategy } from './strategies/export-version.strategy'
 import { ExportRestDocumentStrategy } from './strategies/export-rest-document.strategy'
 
@@ -85,7 +85,7 @@ export const DEFAULT_RUN_OPTIONS: BuilderRunOptions = {
 export class PackageVersionBuilder implements IPackageVersionBuilder {
   apiBuilders: ApiBuilder[] = []
   documents = new Map<string, VersionDocument>()
-  exportDocuments: VersionDocument[] = []
+  exportDocuments: ZippableDocument[] = []
   exportFileName: string = ''
   operations = new Map<string, ApiOperation>()
   comparisons: VersionsComparison[] = []
@@ -263,6 +263,7 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     // }
 
     if (buildType === BUILD_TYPE.EXPORT_REST_OPERATIONS_GROUP) {
+      const { ExportRestOperationsGroupStrategy } = await import('./strategies/rest-operations-group.strategy')
       builderStrategyContext.setStrategy(new ExportRestOperationsGroupStrategy())
     }
 
@@ -294,17 +295,17 @@ export class PackageVersionBuilder implements IPackageVersionBuilder {
     version: VersionId,
     packageId: PackageId,
     slug: string,
-  ): Promise<File | null> {
+  ): Promise<File> {
     if (!this.params.resolvers.rawDocumentResolver) {
-      return null
+      throw new Error('rawDocumentResolver is not provided')
     }
 
-    const source = await this.params.resolvers.rawDocumentResolver(version, packageId, slug)
-    if (!source) {
-      return null
+    const document = await this.params.resolvers.rawDocumentResolver(version, packageId, slug)
+    if (!document) {
+      throw new Error(`Raw document ${slug} is missing`)
     }
 
-    return source
+    return document
   }
 
   async versionComparisonResolver(