feat: support option to remove OAS extension during export (#20)

Author: CountRedClaw

.gitignore

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

package-lock.json

@@ -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": "dev",
+    "@netcracker/qubership-apihub-api-unifier": "dev",
     "@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,7 +65,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

@@ -52,5 +52,11 @@ export const buildGraphQLDocument: DocumentBuilder<GraphApiSchema> = async (pars
 }
 
 export const dumpGraphQLDocument: DocumentDumper<GraphApiSchema> = (document) => {
-  return new Blob([printGraphApi(document.data)], { type: 'text/plain' })
+  if (document.data) {
+    return new Blob([printGraphApi(document.data)], { type: 'text/plain' })
+  }
+  if (document.source) {
+    return document.source
+  }
+  throw new Error(`Document ${document.fileId} has neither data nor source`)
 }

src/apitypes/graphql/graphql.document.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

@@ -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

@@ -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