feat(openapi-v3): remove dependency on openapi-v3-types

bajtos · bajtos · commit 4c2096c6ebe1 · 2019-06-25T08:41:15.000+02:00
Move the definition of the type alias `OpenApiSpec` to a new file
`types.ts`.

Rework all imports from `@loopback/openapi-v3-types` to import from
`types.ts` instead, remove the openapi-v3-types package from the
dependencies too.

Add the helper `createEmptyApiSpec()` to preserve backwards
compatibility for code importing the helper from this package or its
dependants like `@loopback/rest`.

Signed-off-by: Miroslav Bajtoš &lt;mbajtoss@gmail.com&gt;
diff --git a/packages/openapi-v3/package-lock.json b/packages/openapi-v3/package-lock.json
diff --git a/packages/openapi-v3/package.json b/packages/openapi-v3/package.json
@@ -5,6 +5,13 @@
   "engines": {
     "node": ">=8.9"
   },
+  "dependencies": {
+    "@loopback/context": "^1.20.1",
+    "openapi3-ts": "^1.3.0",
+    "@loopback/repository-json-schema": "^1.7.2",
+    "debug": "^4.1.1",
+    "lodash": "^4.17.11"
+  },
   "devDependencies": {
     "@loopback/build": "^2.0.2",
     "@loopback/eslint-config": "^1.1.2",
@@ -46,12 +53,5 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/strongloop/loopback-next.git"
-  },
-  "dependencies": {
-    "@loopback/context": "^1.20.1",
-    "@loopback/openapi-v3-types": "^1.1.4",
-    "@loopback/repository-json-schema": "^1.7.2",
-    "debug": "^4.1.1",
-    "lodash": "^4.17.11"
   }
 }
diff --git a/packages/openapi-v3/src/__tests__/integration/controller-spec.integration.ts b/packages/openapi-v3/src/__tests__/integration/controller-spec.integration.ts
@@ -3,22 +3,20 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {
-  OperationObject,
-  ParameterObject,
-  SchemaObject,
-} from '@loopback/openapi-v3-types';
 import {Entity, model, property} from '@loopback/repository';
 import {expect} from '@loopback/testlab';
 import {
   api,
   ControllerSpec,
   get,
   getControllerSpec,
+  getModelSchemaRef,
+  OperationObject,
   param,
+  ParameterObject,
   post,
   requestBody,
-  getModelSchemaRef,
+  SchemaObject,
 } from '../..';
 
 describe('controller spec', () => {
diff --git a/packages/openapi-v3/src/__tests__/unit/create-empty-spec.unit.ts b/packages/openapi-v3/src/__tests__/unit/create-empty-spec.unit.ts
@@ -0,0 +1,28 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/openapi-v3
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {expect} from '@loopback/testlab';
+import {createEmptyApiSpec} from '../../types';
+
+describe('createEmptyApiSpec', () => {
+  it('sets version 3', () => {
+    expect(createEmptyApiSpec().openapi).to.equal('3.0.0');
+  });
+
+  it('sets the spec info object', () => {
+    expect(createEmptyApiSpec().info).to.deepEqual({
+      title: 'LoopBack Application',
+      version: '1.0.0',
+    });
+  });
+
+  it('creates an empty paths object', () => {
+    expect(createEmptyApiSpec().paths).to.deepEqual({});
+  });
+
+  it('creates a default servers array', () => {
+    expect(createEmptyApiSpec().servers).to.deepEqual([{url: '/'}]);
+  });
+});
diff --git a/packages/openapi-v3/src/__tests__/unit/decorators/param/param-query.decorator.unit.ts b/packages/openapi-v3/src/__tests__/unit/decorators/param/param-query.decorator.unit.ts
@@ -3,9 +3,8 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {get, param, getControllerSpec} from '../../../..';
 import {expect} from '@loopback/testlab';
-import {ParameterObject} from '@loopback/openapi-v3-types';
+import {get, getControllerSpec, param, ParameterObject} from '../../../..';
 
 describe('Routing metadata for parameters', () => {
   describe('@param.query.string', () => {
diff --git a/packages/openapi-v3/src/__tests__/unit/decorators/param/param.decorator.unit.ts b/packages/openapi-v3/src/__tests__/unit/decorators/param/param.decorator.unit.ts
@@ -4,13 +4,17 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {anOperationSpec} from '@loopback/openapi-spec-builder';
+import {expect} from '@loopback/testlab';
 import {
+  get,
+  getControllerSpec,
+  operation,
   OperationObject,
+  param,
   ParameterObject,
+  patch,
   ResponsesObject,
-} from '@loopback/openapi-v3-types';
-import {expect} from '@loopback/testlab';
-import {get, getControllerSpec, operation, param, patch} from '../../../../';
+} from '../../../../';
 
 describe('Routing metadata for parameters', () => {
   describe('@param', () => {
diff --git a/packages/openapi-v3/src/__tests__/unit/decorators/request-body/request-body-primitives.decorator.unit.ts b/packages/openapi-v3/src/__tests__/unit/decorators/request-body/request-body-primitives.decorator.unit.ts
@@ -3,15 +3,16 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {Class} from '@loopback/repository';
+import {expect} from '@loopback/testlab';
 import {
+  ContentObject,
   ControllerSpec,
+  getControllerSpec,
   post,
   requestBody,
-  getControllerSpec,
+  SchemaObject,
 } from '../../../../';
-import {ContentObject, SchemaObject} from '@loopback/openapi-v3-types';
-import {Class} from '@loopback/repository';
-import {expect} from '@loopback/testlab';
 
 describe('requestBody decorator', () => {
   context('for a primitive type', () => {
diff --git a/packages/openapi-v3/src/__tests__/unit/json-to-schema.unit.ts b/packages/openapi-v3/src/__tests__/unit/json-to-schema.unit.ts
@@ -3,11 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {expect} from '@loopback/testlab';
-
-import {SchemaObject} from '@loopback/openapi-v3-types';
-import {jsonToSchemaObject, jsonOrBooleanToJSON} from '../..';
 import {JsonSchema} from '@loopback/repository-json-schema';
+import {expect} from '@loopback/testlab';
+import {jsonOrBooleanToJSON, jsonToSchemaObject, SchemaObject} from '../..';
 
 describe('jsonToSchemaObject', () => {
   it('does nothing when given an empty object', () => {
diff --git a/packages/openapi-v3/src/controller-spec.ts b/packages/openapi-v3/src/controller-spec.ts
@@ -4,6 +4,15 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {DecoratorFactory, MetadataInspector} from '@loopback/context';
+import {
+  getJsonSchema,
+  getJsonSchemaRef,
+  JsonSchemaOptions,
+} from '@loopback/repository-json-schema';
+import * as _ from 'lodash';
+import {resolveSchema} from './generate-schema';
+import {jsonToSchemaObject, SchemaRef} from './json-to-schema';
+import {OAI3Keys} from './keys';
 import {
   ComponentsObject,
   ISpecificationExtension,
@@ -16,16 +25,7 @@ import {
   ResponseObject,
   SchemaObject,
   SchemasObject,
-} from '@loopback/openapi-v3-types';
-import {
-  getJsonSchema,
-  getJsonSchemaRef,
-  JsonSchemaOptions,
-} from '@loopback/repository-json-schema';
-import * as _ from 'lodash';
-import {resolveSchema} from './generate-schema';
-import {jsonToSchemaObject, SchemaRef} from './json-to-schema';
-import {OAI3Keys} from './keys';
+} from './types';
 
 const debug = require('debug')('loopback:openapi3:metadata:controller-spec');
 
diff --git a/packages/openapi-v3/src/decorators/operation.decorator.ts b/packages/openapi-v3/src/decorators/operation.decorator.ts
@@ -3,10 +3,10 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {OperationObject} from '@loopback/openapi-v3-types';
 import {MethodDecoratorFactory} from '@loopback/context';
 import {RestEndpoint} from '../controller-spec';
 import {OAI3Keys} from '../keys';
+import {OperationObject} from '../types';
 
 /**
  * Expose a Controller method as a REST API operation
diff --git a/packages/openapi-v3/src/decorators/parameter.decorator.ts b/packages/openapi-v3/src/decorators/parameter.decorator.ts
@@ -3,16 +3,16 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
+import {MetadataInspector, ParameterDecoratorFactory} from '@loopback/context';
+import {resolveSchema} from '../generate-schema';
+import {OAI3Keys} from '../keys';
 import {
   isSchemaObject,
-  ParameterObject,
   ParameterLocation,
+  ParameterObject,
   ReferenceObject,
   SchemaObject,
-} from '@loopback/openapi-v3-types';
-import {MetadataInspector, ParameterDecoratorFactory} from '@loopback/context';
-import {resolveSchema} from '../generate-schema';
-import {OAI3Keys} from '../keys';
+} from '../types';
 
 /**
  * Describe an input parameter of a Controller method.
diff --git a/packages/openapi-v3/src/decorators/request-body.decorator.ts b/packages/openapi-v3/src/decorators/request-body.decorator.ts
@@ -4,15 +4,11 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {MetadataInspector, ParameterDecoratorFactory} from '@loopback/context';
-import {
-  ReferenceObject,
-  RequestBodyObject,
-  SchemaObject,
-} from '@loopback/openapi-v3-types';
 import * as _ from 'lodash';
 import {inspect} from 'util';
 import {resolveSchema} from '../generate-schema';
 import {OAI3Keys} from '../keys';
+import {ReferenceObject, RequestBodyObject, SchemaObject} from '../types';
 
 const debug = require('debug')('loopback:openapi3:metadata:requestbody');
 export const REQUEST_BODY_INDEX = 'x-parameter-index';
diff --git a/packages/openapi-v3/src/filter-schema.ts b/packages/openapi-v3/src/filter-schema.ts
@@ -3,13 +3,13 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {SchemaObject} from '@loopback/openapi-v3-types';
 import {
   getFilterJsonSchemaFor,
   getWhereJsonSchemaFor,
   Model,
 } from '@loopback/repository-json-schema';
 import {jsonToSchemaObject} from './json-to-schema';
+import {SchemaObject} from './types';
 
 /**
  * Build an OpenAPI schema describing the format of the "filter" object
diff --git a/packages/openapi-v3/src/generate-schema.ts b/packages/openapi-v3/src/generate-schema.ts
@@ -3,7 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {SchemaObject} from '@loopback/openapi-v3-types';
+import {SchemaObject} from './types';
 
 /**
  * Generate the `type` and `format` property in a Schema Object according to a
diff --git a/packages/openapi-v3/src/index.ts b/packages/openapi-v3/src/index.ts
@@ -3,9 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-export * from './decorators';
+export * from '@loopback/repository-json-schema';
 export * from './controller-spec';
-export * from './json-to-schema';
+export * from './decorators';
 export * from './filter-schema';
-
-export * from '@loopback/repository-json-schema';
+export * from './json-to-schema';
+export * from './types';
diff --git a/packages/openapi-v3/src/json-to-schema.ts b/packages/openapi-v3/src/json-to-schema.ts
@@ -3,13 +3,9 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {
-  ReferenceObject,
-  SchemaObject,
-  SchemasObject,
-} from '@loopback/openapi-v3-types';
 import {JsonSchema} from '@loopback/repository-json-schema';
 import * as _ from 'lodash';
+import {ReferenceObject, SchemaObject, SchemasObject} from './types';
 
 /**
  * Custom LoopBack extension: a reference to Schema object that's bundled
diff --git a/packages/openapi-v3/src/keys.ts b/packages/openapi-v3/src/keys.ts
@@ -4,8 +4,8 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {MetadataAccessor} from '@loopback/context';
-import {RestEndpoint, ControllerSpec} from '.';
-import {ParameterObject, RequestBodyObject} from '@loopback/openapi-v3-types';
+import {ControllerSpec, RestEndpoint} from './controller-spec';
+import {ParameterObject, RequestBodyObject} from './types';
 
 // Copyright IBM Corp. 2018. All Rights Reserved.
 // Node module: @loopback/openapi-v3
diff --git a/packages/openapi-v3/src/types.ts b/packages/openapi-v3/src/types.ts
@@ -0,0 +1,30 @@
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/openapi-v3
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+import {OpenAPIObject} from 'openapi3-ts';
+/*
+ * OpenApiSpec - A typescript representation of OpenApi 3.0.0
+ */
+export type OpenApiSpec = OpenAPIObject;
+
+// Export also all spec interfaces
+export * from 'openapi3-ts';
+
+/**
+ * Create an empty OpenApiSpec object that's still a valid openapi document.
+ *
+ * @deprecated Use `OpenApiBuilder` from `openapi3-ts` instead.
+ */
+export function createEmptyApiSpec(): OpenApiSpec {
+  return {
+    openapi: '3.0.0',
+    info: {
+      title: 'LoopBack Application',
+      version: '1.0.0',
+    },
+    paths: {},
+    servers: [{url: '/'}],
+  };
+}
