@loopback/openapi-spec-builder 4.0.0-alpha.6 → 4.0.0

package/dist/openapi-spec-builder.js

@@ -0,0 +1,352 @@
+"use strict";
+// Copyright IBM Corp. 2017,2020. All Rights Reserved.
+// Node module: @loopback/openapi-spec-builder
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComponentsSpecBuilder = exports.OperationSpecBuilder = exports.OpenApiSpecBuilder = exports.BuilderBase = exports.aComponentsSpec = exports.anOperationSpec = exports.anOpenApiSpec = void 0;
+const tslib_1 = require("tslib");
+const assert_1 = (0, tslib_1.__importDefault)(require("assert"));
+/**
+ * Create a new instance of OpenApiSpecBuilder.
+ *
+ * @param basePath - The base path on which the API is served.
+ */
+function anOpenApiSpec() {
+    return new OpenApiSpecBuilder();
+}
+exports.anOpenApiSpec = anOpenApiSpec;
+/**
+ * Create a new instance of OperationSpecBuilder.
+ */
+function anOperationSpec() {
+    return new OperationSpecBuilder();
+}
+exports.anOperationSpec = anOperationSpec;
+/**
+ * Create a new instance of ComponentsSpecBuilder.
+ */
+function aComponentsSpec() {
+    return new ComponentsSpecBuilder();
+}
+exports.aComponentsSpec = aComponentsSpec;
+class BuilderBase {
+    constructor(initialSpec) {
+        this._spec = initialSpec;
+    }
+    /**
+     * Add a custom (extension) property to the spec object.
+     *
+     * @param key - The property name starting with "x-".
+     * @param value - The property value.
+     */
+    withExtension(key, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    value) {
+        (0, assert_1.default)(key.startsWith('x-'), `Invalid extension ${key}, extension keys must be prefixed with "x-"`);
+        // `this._spec[key] = value;` is broken in TypeScript 3.5
+        // See https://github.com/microsoft/TypeScript/issues/31661
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        this._spec[key] = value;
+        return this;
+    }
+    /**
+     * Build the spec object.
+     */
+    build() {
+        // TODO(bajtos): deep-clone
+        return this._spec;
+    }
+}
+exports.BuilderBase = BuilderBase;
+/**
+ * A builder for creating OpenApiSpec documents.
+ */
+class OpenApiSpecBuilder extends BuilderBase {
+    /**
+     * @param basePath - The base path on which the API is served.
+     */
+    constructor() {
+        super({
+            openapi: '3.0.0',
+            info: {
+                title: 'LoopBack Application',
+                version: '1.0.0',
+            },
+            paths: {},
+            servers: [{ url: '/' }],
+        });
+    }
+    /**
+     * Define a new OperationObject at the given path and verb (method).
+     *
+     * @param verb - The HTTP verb.
+     * @param path - The path relative to basePath.
+     * @param spec - Additional specification of the operation.
+     */
+    withOperation(verb, path, spec) {
+        if (spec instanceof OperationSpecBuilder)
+            spec = spec.build();
+        if (!this._spec.paths[path])
+            this._spec.paths[path] = {};
+        this._spec.paths[path][verb] = spec;
+        return this;
+    }
+    /**
+     * Define a new operation that returns a string response.
+     *
+     * @param verb - The HTTP verb.
+     * @param path - The path relative to basePath.
+     * @param operationName - The name of the controller method implementing
+     * this operation (`x-operation-name` field).
+     */
+    withOperationReturningString(verb, path, operationName) {
+        const spec = anOperationSpec().withStringResponse(200);
+        if (operationName)
+            spec.withOperationName(operationName);
+        return this.withOperation(verb, path, spec);
+    }
+    /**
+     * Define a new ComponentsObject.
+     *
+     * @param spec - Specification of the components.
+     */
+    withComponents(spec) {
+        if (spec instanceof ComponentsSpecBuilder)
+            spec = spec.build();
+        if (!this._spec.components)
+            this._spec.components = spec;
+        return this;
+    }
+}
+exports.OpenApiSpecBuilder = OpenApiSpecBuilder;
+/**
+ * A builder for creating OperationObject specifications.
+ */
+class OperationSpecBuilder extends BuilderBase {
+    constructor() {
+        super({
+            responses: { '200': { description: 'An undocumented response body.' } },
+        });
+    }
+    /**
+     * Describe a response for a given HTTP status code.
+     * @param status - HTTP status code or string "default"
+     * @param responseSpec - Specification of the response
+     */
+    withResponse(status, responseSpec) {
+        // OpenAPI spec uses string indices, i.e. 200 OK uses "200" as the index
+        this._spec.responses[status.toString()] = responseSpec;
+        return this;
+    }
+    withStringResponse(status = 200) {
+        return this.withResponse(status, {
+            description: 'The string result.',
+            content: {
+                'text/plain': {
+                    schema: { type: 'string' },
+                },
+            },
+        });
+    }
+    /**
+     * Describe one more parameters accepted by the operation.
+     * Note that parameters are positional in OpenAPI Spec, therefore
+     * the first call of `withParameter` defines the first parameter,
+     * the second call defines the second parameter, etc.
+     * @param parameterSpecs
+     */
+    withParameter(...parameterSpecs) {
+        if (!this._spec.parameters)
+            this._spec.parameters = [];
+        this._spec.parameters.push(...parameterSpecs);
+        return this;
+    }
+    withRequestBody(requestBodySpec) {
+        this._spec.requestBody = requestBodySpec;
+        return this;
+    }
+    /**
+     * Define the operation name (controller method name).
+     *
+     * @param name - The name of the controller method implementing this operation.
+     */
+    withOperationName(name) {
+        this.withExtension('x-operation-name', name);
+        this.setupOperationId();
+        return this;
+    }
+    /**
+     * Define the controller name (controller name).
+     *
+     * @param name - The name of the controller containing this operation.
+     */
+    withControllerName(name) {
+        this.withExtension('x-controller-name', name);
+        this.setupOperationId();
+        return this;
+    }
+    /**
+     * Set up the `operationId` if not configured
+     */
+    setupOperationId() {
+        if (this._spec.operationId)
+            return;
+        const controllerName = this._spec['x-controller-name'];
+        const operationName = this._spec['x-operation-name'];
+        if (controllerName && operationName) {
+            // Build the operationId as `<controllerName>.<operationName>`
+            // Please note API explorer (https://github.com/swagger-api/swagger-js/)
+            // will normalize it as `<controllerName>_<operationName>`
+            this._spec.operationId = controllerName + '.' + operationName;
+        }
+    }
+    /**
+     * Define the operationId
+     * @param operationId - Operation id
+     */
+    withOperationId(operationId) {
+        this._spec.operationId = operationId;
+        return this;
+    }
+    /**
+     * Describe tags associated with the operation
+     * @param tags
+     */
+    withTags(tags) {
+        if (!this._spec.tags)
+            this._spec.tags = [];
+        if (typeof tags === 'string')
+            tags = [tags];
+        this._spec.tags.push(...tags);
+        return this;
+    }
+}
+exports.OperationSpecBuilder = OperationSpecBuilder;
+/**
+ * A builder for creating ComponentsObject specifications.
+ */
+class ComponentsSpecBuilder extends BuilderBase {
+    constructor() {
+        super({});
+    }
+    /**
+     * Define a component schema.
+     *
+     * @param name - The name of the schema
+     * @param schema - Specification of the schema
+     *
+     */
+    withSchema(name, schema) {
+        if (!this._spec.schemas)
+            this._spec.schemas = {};
+        this._spec.schemas[name] = schema;
+        return this;
+    }
+    /**
+     * Define a component response.
+     *
+     * @param name - The name of the response
+     * @param response - Specification of the response
+     *
+     */
+    withResponse(name, response) {
+        if (!this._spec.responses)
+            this._spec.responses = {};
+        this._spec.responses[name] = response;
+        return this;
+    }
+    /**
+     * Define a component parameter.
+     *
+     * @param name - The name of the parameter
+     * @param parameter - Specification of the parameter
+     *
+     */
+    withParameter(name, parameter) {
+        if (!this._spec.parameters)
+            this._spec.parameters = {};
+        this._spec.parameters[name] = parameter;
+        return this;
+    }
+    /**
+     * Define a component example.
+     *
+     * @param name - The name of the example
+     * @param example - Specification of the example
+     *
+     */
+    withExample(name, example) {
+        if (!this._spec.examples)
+            this._spec.examples = {};
+        this._spec.examples[name] = example;
+        return this;
+    }
+    /**
+     * Define a component request body.
+     *
+     * @param name - The name of the request body
+     * @param requestBody - Specification of the request body
+     *
+     */
+    withRequestBody(name, requestBody) {
+        if (!this._spec.requestBodies)
+            this._spec.requestBodies = {};
+        this._spec.requestBodies[name] = requestBody;
+        return this;
+    }
+    /**
+     * Define a component header.
+     *
+     * @param name - The name of the header
+     * @param header - Specification of the header
+     *
+     */
+    withHeader(name, header) {
+        if (!this._spec.headers)
+            this._spec.headers = {};
+        this._spec.headers[name] = header;
+        return this;
+    }
+    /**
+     * Define a component security scheme.
+     *
+     * @param name - The name of the security scheme
+     * @param securityScheme - Specification of the security scheme
+     *
+     */
+    withSecurityScheme(name, securityScheme) {
+        if (!this._spec.securitySchemes)
+            this._spec.securitySchemes = {};
+        this._spec.securitySchemes[name] = securityScheme;
+        return this;
+    }
+    /**
+     * Define a component link.
+     *
+     * @param name - The name of the link
+     * @param link - Specification of the link
+     *
+     */
+    withLink(name, link) {
+        if (!this._spec.links)
+            this._spec.links = {};
+        this._spec.links[name] = link;
+        return this;
+    }
+    /**
+     * Define a component callback.
+     *
+     * @param name - The name of the callback
+     * @param callback - Specification of the callback
+     *
+     */
+    withCallback(name, callback) {
+        if (!this._spec.callbacks)
+            this._spec.callbacks = {};
+        this._spec.callbacks[name] = callback;
+        return this;
+    }
+}
+exports.ComponentsSpecBuilder = ComponentsSpecBuilder;
+//# sourceMappingURL=openapi-spec-builder.js.map

package/dist/openapi-spec-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-spec-builder.js","sourceRoot":"","sources":["../src/openapi-spec-builder.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,8CAA8C;AAC9C,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,iEAA4B;AAkB5B;;;;GAIG;AACH,SAAgB,aAAa;IAC3B,OAAO,IAAI,kBAAkB,EAAE,CAAC;AAClC,CAAC;AAFD,sCAEC;AAED;;GAEG;AACH,SAAgB,eAAe;IAC7B,OAAO,IAAI,oBAAoB,EAAE,CAAC;AACpC,CAAC;AAFD,0CAEC;AAED;;GAEG;AACH,SAAgB,eAAe;IAC7B,OAAO,IAAI,qBAAqB,EAAE,CAAC;AACrC,CAAC;AAFD,0CAEC;AAED,MAAa,WAAW;IAGtB,YAAY,WAAc;QACxB,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,aAAa,CACX,GAAW;IACX,8DAA8D;IAC9D,KAAU;QAEV,IAAA,gBAAM,EACJ,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EACpB,qBAAqB,GAAG,6CAA6C,CACtE,CAAC;QAEF,yDAAyD;QACzD,2DAA2D;QAC3D,8DAA8D;QAC7D,IAAI,CAAC,KAA6B,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACjD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK;QACH,2BAA2B;QAC3B,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF;AArCD,kCAqCC;AACD;;GAEG;AACH,MAAa,kBAAmB,SAAQ,WAA0B;IAChE;;OAEG;IACH;QACE,KAAK,CAAC;YACJ,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE;gBACJ,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,OAAO;aACjB;YACD,KAAK,EAAE,EAAE;YACT,OAAO,EAAE,CAAC,EAAC,GAAG,EAAE,GAAG,EAAC,CAAC;SACtB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CACX,IAAY,EACZ,IAAY,EACZ,IAA4C;QAE5C,IAAI,IAAI,YAAY,oBAAoB;YAAE,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACzD,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,4BAA4B,CAC1B,IAAY,EACZ,IAAY,EACZ,aAAsB;QAEtB,MAAM,IAAI,GAAG,eAAe,EAAE,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACvD,IAAI,aAAa;YAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC;QAEzD,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,IAA8C;QAC3D,IAAI,IAAI,YAAY,qBAAqB;YAAE,IAAI,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QAC/D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/DD,gDA+DC;AAED;;GAEG;AACH,MAAa,oBAAqB,SAAQ,WAA4B;IACpE;QACE,KAAK,CAAC;YACJ,SAAS,EAAE,EAAC,KAAK,EAAE,EAAC,WAAW,EAAE,gCAAgC,EAAC,EAAC;SACpE,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAA0B,EAAE,YAA4B;QACnE,wEAAwE;QACxE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC;QACvD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kBAAkB,CAAC,SAA6B,GAAG;QACjD,OAAO,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE;YAC/B,WAAW,EAAE,oBAAoB;YACjC,OAAO,EAAE;gBACP,YAAY,EAAE;oBACZ,MAAM,EAAE,EAAC,IAAI,EAAE,QAAQ,EAAC;iBACzB;aACF;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CAAC,GAAG,cAAiC;QAChD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC;QACvD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,eAAe,CAAC,eAAkC;QAChD,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,eAAe,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,IAAY;QAC5B,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAC;QAC7C,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,IAAY;QAC7B,IAAI,CAAC,aAAa,CAAC,mBAAmB,EAAE,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACK,gBAAgB;QACtB,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW;YAAE,OAAO;QACnC,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACvD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,cAAc,IAAI,aAAa,EAAE;YACnC,8DAA8D;YAC9D,wEAAwE;YACxE,0DAA0D;YAC1D,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,cAAc,GAAG,GAAG,GAAG,aAAa,CAAC;SAC/D;IACH,CAAC;IAED;;;OAGG;IACH,eAAe,CAAC,WAAmB;QACjC,IAAI,CAAC,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAuB;QAC9B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,CAAC;QAC3C,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAvGD,oDAuGC;AAED;;GAEG;AACH,MAAa,qBAAsB,SAAQ,WAA6B;IACtE;QACE,KAAK,CAAC,EAAE,CAAC,CAAC;IACZ,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,IAAY,EAAE,MAAsC;QAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;YAAE,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC;QACjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,IAAY,EAAE,QAA0C;QACnE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS;YAAE,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,aAAa,CACX,IAAY,EACZ,SAA4C;QAE5C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,IAAI,CAAC,KAAK,CAAC,UAAU,GAAG,EAAE,CAAC;QACvD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAC,IAAY,EAAE,OAAwC;QAChE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,eAAe,CACb,IAAY,EACZ,WAAgD;QAEhD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa;YAAE,IAAI,CAAC,KAAK,CAAC,aAAa,GAAG,EAAE,CAAC;QAC7D,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,UAAU,CAAC,IAAY,EAAE,MAAsC;QAC7D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;YAAE,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,EAAE,CAAC;QACjD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,kBAAkB,CAChB,IAAY,EACZ,cAAsD;QAEtD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe;YAAE,IAAI,CAAC,KAAK,CAAC,eAAe,GAAG,EAAE,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC;QAClD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,IAAY,EAAE,IAAkC;QACvD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;QAC7C,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,YAAY,CAAC,IAAY,EAAE,QAA0C;QACnE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS;YAAE,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAlID,sDAkIC"}

package/package.json

@@ -1,19 +1,7 @@
 {
   "name": "@loopback/openapi-spec-builder",
-  "version": "4.0.0-alpha.6",
   "description": "Make it easy to create OpenAPI (Swagger) specification documents in your tests using the builder pattern.",
-  "scripts": {
-    "build": "npm run build:lib && npm run build:lib6",
-    "build:current": "node ../../bin/compile-package",
-    "build:lib": "node ../../bin/compile-package es2017",
-    "build:lib6": "node ../../bin/compile-package es2015",
-    "build:apidocs": "node ../../bin/generate-apidocs",
-    "clean": "rm -rf loopback-openapi-spec*.tgz lib* package",
-    "prepublish": "npm run build && npm run build:apidocs",
-    "verify": "npm pack && tar xf loopback-openapi-spec*.tgz && tree package && npm run clean"
-  },
-  "author": "IBM",
-  "license": "MIT",
+  "version": "4.0.0",
   "keywords": [
     "Swagger",
     "OpenAPI Spec",
@@ -21,19 +9,44 @@
     "Builder",
     "Testing"
   ],
-  "dependencies": {
-    "@loopback/openapi-spec": "^4.0.0-alpha.8"
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "IBM Corp.",
+  "copyright.owner": "IBM Corp.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
+    "directory": "packages/openapi-spec-builder"
+  },
+  "engines": {
+    "node": "12 || 14 || 16 || 17"
+  },
+  "scripts": {
+    "build": "lb-tsc",
+    "clean": "lb-clean loopback-openapi-spec-builder*.tgz dist *.tsbuildinfo package",
+    "pretest": "npm run build",
+    "test": "lb-mocha \"dist/__tests__/**/*.js\"",
+    "verify": "npm pack && tar xf loopback-openapi-spec-builder*.tgz && tree package && npm run clean"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "files": [
     "README.md",
-    "index.js",
-    "index.d.ts",
-    "lib",
-    "lib6",
-    "api-docs"
+    "dist",
+    "src",
+    "!*/__tests__"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/strongloop/loopback-next.git"
-  }
+  "dependencies": {
+    "openapi3-ts": "^2.0.1",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@loopback/build": "^8.0.0",
+    "@loopback/eslint-config": "^12.0.0",
+    "@loopback/testlab": "^4.0.0",
+    "@types/node": "^10.17.60"
+  },
+  "gitHead": "00a62f630c19341ce399cec3a45563b1ead6e3b8"
 }

package/src/index.ts

@@ -0,0 +1,24 @@
+// Copyright IBM Corp. 2017,2020. All Rights Reserved.
+// Node module: @loopback/openapi-spec-builder
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * A package to simplify creating OpenAPI specification documents in your tests
+ * using the builder pattern.
+ *
+ * @remarks
+ * Creating a full OpenAPI spec document in automated tests is rather
+ * cumbersome, long JSON-like objects pollute the test test code and make it
+ * difficult for readers to distinguish between what's important in the test and
+ * what's just shared OpenAPI boilerplate.
+ *
+ * OpenApiSpecBuilder utilizes
+ * {@link http://www.natpryce.com/articles/000714.html | Test Data Builder pattern}
+ * to provide a TypeScript/JavaScript API allowing users to create full OpenAPI
+ * Specification 3 documents in few lines of code.
+ *
+ * @packageDocumentation
+ */
+
+export * from './openapi-spec-builder';