@cparra/apexdocs 2.8.1 → 2.9.0-alpha.0

package/src/transpiler/openapi/parsers/__tests__/RequestBodyBuilder.spec.ts

@@ -0,0 +1,60 @@
+import { RequestBodyBuilder } from '../RequestBodyBuilder';
+import { Reference } from '../ReferenceBuilder';
+import { ReferenceObject } from '../../../../model/openapi/open-api-types';
+import { ApexDocHttpRequestBody } from '../../../../model/openapi/apex-doc-types';
+
+jest.mock('../ReferenceBuilder', () => {
+  return {
+    ReferenceBuilder: jest.fn().mockImplementation(() => {
+      return {
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        build: (): Reference => {
+          return {
+            referencedClass: 'MySampleClass',
+            referenceObject: {
+              $ref: '/mySampleClass',
+            },
+            schema: {
+              type: 'string',
+            },
+          };
+        },
+      };
+    }),
+  };
+});
+
+it('should build a RequestBody based on the received schema', function () {
+  const apexRequestBody: ApexDocHttpRequestBody = {
+    description: 'Sample Request Body Description',
+    required: true,
+    schema: {
+      type: 'object',
+      properties: {
+        Prop1: {
+          type: 'string',
+          description: 'A Property',
+        },
+      },
+    },
+  };
+
+  const response = new RequestBodyBuilder().build(apexRequestBody);
+
+  expect(response.reference).toBeUndefined();
+  expect(response.body.description).toBe('Sample Request Body Description');
+  expect(response.body.required).toBe(true);
+  expect(response.body.content).toHaveProperty('application/json');
+  expect(response.body.content['application/json'].schema).toBe(apexRequestBody.schema);
+});
+
+it('should build a RequestBody with a reference when receiving a reference class name', function () {
+  const apexRequestBody: ApexDocHttpRequestBody = {
+    schema: 'MyClassName',
+  };
+
+  const response = new RequestBodyBuilder().build(apexRequestBody);
+
+  expect(response.reference).not.toBeUndefined();
+  expect((response.body.content['application/json']?.schema as ReferenceObject).$ref).toBe('/mySampleClass');
+});

package/src/transpiler/openapi/parsers/__tests__/ResponsesBuilder.spec.ts

@@ -0,0 +1,51 @@
+import { ResponsesBuilder } from '../ResponsesBuilder';
+import { Reference } from '../ReferenceBuilder';
+import { ApexDocHttpResponse } from '../../../../model/openapi/apex-doc-types';
+
+jest.mock('../ReferenceBuilder', () => {
+  return {
+    ReferenceBuilder: jest.fn().mockImplementation(() => {
+      return {
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        build: (): Reference => {
+          return {
+            referencedClass: 'MySampleClass',
+            referenceObject: {
+              $ref: '/mySampleClass',
+            },
+            schema: {
+              type: 'string',
+            },
+          };
+        },
+      };
+    }),
+  };
+});
+
+it('should build a ResponseObject based on the received schema', function () {
+  const apexDocResponse: ApexDocHttpResponse = {
+    statusCode: 200,
+    schema: {
+      type: 'string',
+    },
+  };
+
+  const response = new ResponsesBuilder().build(apexDocResponse);
+
+  expect(response.reference).toBeUndefined();
+  expect(response.body.description).toContain('200');
+  expect(response.body.content).toHaveProperty('application/json');
+  expect(response.body.content!['application/json'].schema).toBe(apexDocResponse.schema);
+});
+
+it('should build a ResponseObject with a reference', function () {
+  const apexDocResponse: ApexDocHttpResponse = {
+    statusCode: 200,
+    schema: 'SomeClass',
+  };
+
+  const response = new ResponsesBuilder().build(apexDocResponse);
+
+  expect(response.reference).not.toBeUndefined();
+});

package/src/transpiler/processor-type-transpiler.ts

@@ -12,5 +12,7 @@ export default abstract class ProcessorTypeTranspiler {
 
   abstract fileBuilder(): FileContainer;
 
-  abstract getLinkingStrategy(): LinkingStrategy;
+  getLinkingStrategy(): LinkingStrategy {
+    return 'root-relative';
+  }
 }

package/tsconfig.json

@@ -5,7 +5,10 @@
     "declaration": true,
     "outDir": "./lib",
     "strict": true,
-    "sourceMap": true
+    "sourceMap": true,
+    "lib": [
+      "ES2021"
+    ]
   },
   "include": [
     "src"

package/lib/model/file.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"file.js","sourceRoot":"","sources":["../../src/model/file.ts"],"names":[],"mappings":";;;AAAA,2BAA4B;AAC5B,0CAAuC;AAEvC,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC;IAClC,SAAS,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;CAChE,CAAC,CAAC;AAEH,MAAsB,IAAI;IAGxB,YAAmB,QAAgB,EAAS,GAAW;QAApC,aAAQ,GAAR,QAAQ,CAAQ;QAAS,QAAG,GAAH,GAAG,CAAQ;QAFvD,cAAS,GAAG,EAAE,CAAC;IAE2C,CAAC;IAI3D,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QACrC,MAAM,YAAY,GAAG,UAAU,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,CAAC;QACvE,MAAM,SAAS,GAAG,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,IAAI,CAAC,SAAS,IAAI,SAAS,CAAC;QAC5B,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,YAAY;QACV,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC;IACzB,CAAC;CACF;AArBD,oBAqBC"}