style: change some names to make the code more readable

nestjs · Dec 7, 2022 · 866b731 · 866b731
1 parent 3f8129f
commit 866b731
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 29 deletions.
diff --git a/lib/document-builder.ts b/lib/document-builder.ts
@@ -1,4 +1,3 @@
-import { GlobalParameterStorage } from './storages/global-parameter.storage';
 import { Logger } from '@nestjs/common';
 import { isString, isUndefined, negate, pickBy } from 'lodash';
 import { buildDocumentBase } from './fixtures/document.base';
@@ -11,6 +10,7 @@ import {
   ServerVariableObject,
   TagObject
 } from './interfaces/open-api-spec.interface';
+import { GlobalParametersStorage } from './storages/global-parameters.storage';
 
 export class DocumentBuilder {
   private readonly logger = new Logger(DocumentBuilder.name);
@@ -94,7 +94,7 @@ export class DocumentBuilder {
   }
 
   public addGlobalParameters(...parameters: ParameterObject[]): this {
-    GlobalParameterStorage.addGlobalParameters(...parameters);
+    GlobalParametersStorage.add(...parameters);
     return this;
   }
 

diff --git a/lib/explorers/api-parameters.explorer.ts b/lib/explorers/api-parameters.explorer.ts
@@ -10,7 +10,7 @@ import {
 import { ParametersMetadataMapper } from '../services/parameters-metadata-mapper';
 import { SchemaObjectFactory } from '../services/schema-object-factory';
 import { SwaggerTypesMapper } from '../services/swagger-types-mapper';
-import { GlobalParameterStorage } from '../storages/global-parameter.storage';
+import { GlobalParametersStorage } from '../storages/global-parameters.storage';
 
 const parameterMetadataAccessor = new ParameterMetadataAccessor();
 const modelPropertiesAccessor = new ModelPropertiesAccessor();
@@ -33,7 +33,7 @@ export const exploreApiParametersMetadata = (
     DECORATORS.API_PARAMETERS,
     method
   );
-  const globalParameters = GlobalParameterStorage.getGlobalParameters();
+  const globalParameters = GlobalParametersStorage.getAll();
   const parametersMetadata = parameterMetadataAccessor.explore(
     instance,
     prototype,

diff --git a/lib/storages/global-parameter.storage.ts b/lib/storages/global-parameter.storage.ts
diff --git a/lib/storages/global-parameters.storage.ts b/lib/storages/global-parameters.storage.ts
@@ -0,0 +1,23 @@
+import { ParameterObject } from '../interfaces/open-api-spec.interface';
+
+export class GlobalParametersStorageHost {
+  private parameters = new Array<ParameterObject>();
+
+  add(...parameters: ParameterObject[]) {
+    this.parameters.push(...parameters);
+  }
+
+  getAll() {
+    return this.parameters;
+  }
+
+  clear() {
+    this.parameters = [];
+  }
+}
+
+const globalRef = global as any;
+export const GlobalParametersStorage: GlobalParametersStorageHost =
+  globalRef.SwaggerGlobalParametersStorage ||
+  (globalRef.SwaggerGlobalParametersStorage =
+    new GlobalParametersStorageHost());
diff --git a/test/explorer/swagger-explorer.spec.ts b/test/explorer/swagger-explorer.spec.ts
@@ -1,4 +1,3 @@
-import { GlobalParameterStorage } from './../../lib/storages/global-parameter.storage';
 import {
   Body,
   Controller,
@@ -34,6 +33,7 @@ import { ModelPropertiesAccessor } from '../../lib/services/model-properties-acc
 import { SchemaObjectFactory } from '../../lib/services/schema-object-factory';
 import { SwaggerTypesMapper } from '../../lib/services/swagger-types-mapper';
 import { SwaggerExplorer } from '../../lib/swagger-explorer';
+import { GlobalParametersStorage } from '../../lib/storages/global-parameters.storage';
 
 describe('SwaggerExplorer', () => {
   const schemaObjectFactory = new SchemaObjectFactory(
@@ -1438,7 +1438,7 @@ describe('SwaggerExplorer', () => {
     }
 
     it('should properly define global paramters', () => {
-      GlobalParameterStorage.addGlobalParameters(
+      GlobalParametersStorage.add(
         {
           name: 'x-tenant-id',
           in: 'header',
@@ -1473,7 +1473,7 @@ describe('SwaggerExplorer', () => {
           schema: { type: 'string' }
         }
       ]);
-      GlobalParameterStorage.cleanGlobalParamters();
+      GlobalParametersStorage.clear();
     });
   });
 });