fix(apidom): fix refract structures hydration (#227)

char0n · web-flow · commit 3309a70637b1 · 2021-01-06T10:19:45.000+01:00
- fix security problem in axios https://npmjs.com/advisories/1594 Closes #226
diff --git a/apidom/package-lock.json b/apidom/package-lock.json
diff --git a/apidom/packages/@types/minim.d.ts b/apidom/packages/@types/minim.d.ts
@@ -43,7 +43,9 @@ declare module 'minim' {
 
     toRefract(element: Element): JSON;
 
-    fromRefract(doc: JSON): Element;
+    toElement(value: any): Element;
+
+    fromRefract(doc: Record<string, any> | Array<any>): Element;
 
     register(name: string, elementClass: any): Namespace;
 
diff --git a/apidom/packages/apidom-ns-asyncapi-2-0/src/elements/AsyncApi2-0.ts b/apidom/packages/apidom-ns-asyncapi-2-0/src/elements/AsyncApi2-0.ts
@@ -8,7 +8,7 @@ import ChannelsElement from './Channels';
 class AsyncApi2_0 extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);
-    this.element = 'asyncApi2-0';
+    this.element = 'asyncApi2_0';
     this.classes.push('api');
   }
 
diff --git a/apidom/packages/apidom-ns-openapi-3-1/src/elements/OpenApi3-1.ts b/apidom/packages/apidom-ns-openapi-3-1/src/elements/OpenApi3-1.ts
@@ -7,7 +7,7 @@ import ComponentsElement from './Components';
 class OpenApi3_1 extends ObjectElement {
   constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {
     super(content, meta, attributes);
-    this.element = 'openApi3-1';
+    this.element = 'openApi3_1';
     this.classes.push('api');
   }
 
diff --git a/apidom/packages/apidom-parser-adapter-asyncapi-json-2-0/test/index.ts b/apidom/packages/apidom-parser-adapter-asyncapi-json-2-0/test/index.ts
@@ -14,6 +14,6 @@ describe('apidom-parser-adapter-asyncapi-json-2-0', function () {
 
     const parseResult = await adapter.parse(spec, { sourceMap: true });
     console.log(JSON.stringify(apiDOM.toValue(parseResult), null, 2));
-    // console.log  (JSON.stringify(apiDOM.toJSON(namespace, parseResult), null, null));
+    // console.log  (JSON.stringify(apiDOM.dehydrate(parseResult, namespace), null, null));
   });
 });
diff --git a/apidom/packages/apidom-parser-adapter-asyncapi-yaml-2-0/test/index.ts b/apidom/packages/apidom-parser-adapter-asyncapi-yaml-2-0/test/index.ts
@@ -13,6 +13,6 @@ describe('apidom-parser-adapter-asyncapi-yaml-2-0', function () {
 
     const parseResult = await adapter.parse(spec, { sourceMap: true });
     console.log(JSON.stringify(apiDOM.toValue(parseResult), null, 2));
-    // console.log(JSON.stringify(apiDOM.toJSON(adapter.namespace, parseResult), null, null));
+    // console.log(JSON.stringify(apiDOM.dehydrate(parseResult, adapter.namespace), null, null));
   });
 });
diff --git a/apidom/packages/apidom-parser-adapter-json/test/index.ts b/apidom/packages/apidom-parser-adapter-json/test/index.ts
@@ -13,6 +13,6 @@ describe('apidom-parser-adapter-json', function () {
 
     const parseResult = await adapter.parse(spec, { sourceMap: true });
     console.log(JSON.stringify(apiDOM.toValue(parseResult), null, 2));
-    // console.log(JSON.stringify(apiDOM.toJSON(adapter.namespace, parseResult), null, null));
+    // console.log(JSON.stringify(apiDOM.toJSON(parseResult, adapter.namespace), null, null));
   });
 });
diff --git a/apidom/packages/apidom-parser-adapter-openapi-json-3-1/test/index.ts b/apidom/packages/apidom-parser-adapter-openapi-json-3-1/test/index.ts
@@ -14,6 +14,6 @@ describe('apidom-parser-adapter-openapi-json-3-1', function () {
 
     const parseResult = await adapter.parse(spec, { sourceMap: true });
     console.log(JSON.stringify(apiDOM.toValue(parseResult), null, 2));
-    // console.log  (JSON.stringify(apiDOM.toJSON(namespace, parseResult), null, null));
+    // console.log  (JSON.stringify(apiDOM.dehydrate(parseResult, namespace), null, null));
   });
 });
diff --git a/apidom/packages/apidom-parser-adapter-openapi-yaml-3-1/test/index.ts b/apidom/packages/apidom-parser-adapter-openapi-yaml-3-1/test/index.ts
@@ -13,6 +13,6 @@ describe('apidom-parser-adapter-openapi-yaml-3-1', function () {
 
     const parseResult = await adapter.parse(spec, { sourceMap: true });
     console.log(JSON.stringify(apiDOM.toValue(parseResult), null, 2));
-    // console.log(JSON.stringify(apiDOM.toJSON(adapter.namespace, parseResult), null, null));
+    // console.log(JSON.stringify(apiDOM.toJSON(parseResult, adapter.namespace), null, null));
   });
 });
diff --git a/apidom/packages/apidom-parser-adapter-yaml-1-2/test/index.ts b/apidom/packages/apidom-parser-adapter-yaml-1-2/test/index.ts
@@ -13,6 +13,6 @@ describe('apidom-parser-adapter-yaml-1-2', function () {
 
     const parseResult = await adapter.parse(spec, { sourceMap: true });
     console.log(JSON.stringify(apiDOM.toValue(parseResult), null, 2));
-    // console.log(JSON.stringify(apiDOM.toJSON(adapter.namespace, parseResult), null, null));
+    // console.log(JSON.stringify(apiDOM.dehydrate(parseResult, adapter.namespace), null, null));
   });
 });
diff --git a/apidom/packages/apidom-parser/test/index.ts b/apidom/packages/apidom-parser/test/index.ts
@@ -16,6 +16,6 @@ describe('apidom-parser', function () {
   it('test', async function () {
     const parseResult = await parser.parse(spec);
     console.log(parseResult);
-    console.log(apiDOM.toJSON(namespace, parseResult));
+    console.log(apiDOM.dehydrate(parseResult, namespace));
   });
 });
diff --git a/apidom/packages/apidom-reference/package.json b/apidom/packages/apidom-reference/package.json
@@ -28,7 +28,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "=7.12.5",
-    "axios": "=0.21.0",
+    "axios": "=0.21.1",
     "ramda": "=0.27.0",
     "@types/ramda": "=0.27.6",
     "ramda-adjunct": "=2.27.0",
diff --git a/apidom/packages/apidom/src/index.ts b/apidom/packages/apidom/src/index.ts
@@ -1,5 +1,6 @@
-import { NamespacePlugin, Element } from 'minim';
-import { isPlainObject } from 'ramda-adjunct';
+import { has } from 'ramda';
+import { isPlainObject, isString } from 'ramda-adjunct';
+import { NamespacePlugin, Element, Namespace as INamespace } from 'minim';
 
 import { Namespace as ApiDOMNamespace } from './namespace';
 
@@ -56,19 +57,44 @@ export const createNamespace = (namespacePlugin?: NamespacePlugin): ApiDOMNamesp
   return namespace;
 };
 
-export const toJSON = (namespace: ApiDOMNamespace, element: Element): JSON =>
-  namespace.toRefract(element);
-
-export const toJSONString = (namespace: ApiDOMNamespace, element: Element): string =>
-  JSON.stringify(toJSON(namespace, element));
+/**
+ * Transforms data to an Element from a particular namespace.
+ */
+export const from = (data: any, namespace: INamespace): Element => {
+  if (isString(data)) {
+    // JSON serialized refract
+    return namespace.fromRefract(JSON.parse(data));
+  }
+  if (isPlainObject(data) && has('element', data)) {
+    // refract javascript structure
+    return namespace.fromRefract(data);
+  }
+  if (isPlainObject(data)) {
+    // javascript POJO
+    return namespace.toElement(data);
+  }
+  throw new Error('Data was not recognized');
+};
 
-export const fromJSON = (namespace: ApiDOMNamespace, json: JSON): Element =>
-  namespace.fromRefract(json);
+/**
+ * Reconstructs the ApiDOM into JavaScript POJO.
+ * This POJO would be  the result of parsing the original
+ * JSON string with JSON.parse function.
+ */
+export const toValue = (element: Element): any => element.toValue();
 
-export const fromJSONString = (namespace: ApiDOMNamespace, jsonString: string): Element =>
-  fromJSON(namespace, JSON.parse(jsonString));
+/**
+ * Create a refract representation of Element.
+ * https://github.com/refractproject/refract-spec
+ */
+export const dehydrate = (element: Element, namespace: INamespace): Record<string, any> => {
+  return namespace.toRefract(element);
+};
 
-// Reconstructs the ApiDOM into JavaScript POJO.
-// This POJO would be  the result of parsing the original
-// JSON string with JSON.parse function.
-export const toValue = (element: Element): any => element.toValue();
+/**
+ * Create a string representation of Element.
+ */
+export const toString = (element: Element, namespace: INamespace): string => {
+  const refract = dehydrate(element, namespace);
+  return JSON.stringify(refract);
+};
diff --git a/apidom/packages/apidom/src/namespace.ts b/apidom/packages/apidom/src/namespace.ts
@@ -1,11 +1,11 @@
-import minim from 'minim';
+import { Namespace as MinimNamespace } from 'minim';
 
 import ParseResult from './elements/ParseResult';
 import Annotation from './elements/Annotation';
 import SourceMap from './elements/SourceMap';
 import Comment from './elements/Comment';
 
-export class Namespace extends minim.Namespace {
+export class Namespace extends MinimNamespace {
   constructor() {
     super();
 
diff --git a/apidom/packages/apidom/test/index.ts b/apidom/packages/apidom/test/index.ts
@@ -15,6 +15,6 @@ describe('apidom', function () {
   it('test', async function () {
     const parseResult = await parser.parse(spec);
 
-    console.dir(apiDOM.toJSON(namespace, parseResult));
+    console.dir(apiDOM.dehydrate(parseResult, namespace));
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ import ChannelsElement from './Channels';`
`8`	`8`	`class AsyncApi2_0 extends ObjectElement {`
`9`	`9`	`constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {`
`10`	`10`	`super(content, meta, attributes);`
`11`		`- this.element = 'asyncApi2-0';`
	`11`	`+ this.element = 'asyncApi2_0';`
`12`	`12`	`this.classes.push('api');`
`13`	`13`	`}`
`14`	`14`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ import ComponentsElement from './Components';`
`7`	`7`	`class OpenApi3_1 extends ObjectElement {`
`8`	`8`	`constructor(content?: Record<string, unknown>, meta?: Meta, attributes?: Attributes) {`
`9`	`9`	`super(content, meta, attributes);`
`10`		`- this.element = 'openApi3-1';`
	`10`	`+ this.element = 'openApi3_1';`
`11`	`11`	`this.classes.push('api');`
`12`	`12`	`}`
`13`	`13`