feat(api): creating LICENSE files and and SDK headings

packages/api/.eslintrc

@@ -0,0 +1,10 @@
+{
+  "rules": {
+    "camelcase": [
+      "error",
+      {
+        "allow": ["OpenAPIV3_1"]
+      }
+    ]
+  }
+}

packages/api/package.json

@@ -52,6 +52,7 @@
     "figures": "^5.0.0",
     "httpsnippet-client-api": "file:../httpsnippet-client-api",
     "js-yaml": "^4.1.0",
+    "license": "^1.0.3",
     "lodash.camelcase": "^4.3.0",
     "lodash.deburr": "^4.1.0",
     "lodash.setwith": "^4.3.2",
@@ -83,6 +84,7 @@
     "ajv-formats": "^2.1.1",
     "fetch-mock": "^9.11.0",
     "oas-normalize": "^11.0.1",
+    "openapi-types": "^12.1.3",
     "tsup": "^7.2.0",
     "type-fest": "^4.4.0",
     "typescript": "^5.2.2",

packages/api/src/codegen/languages/typescript/index.ts

@@ -2,6 +2,7 @@ import type { InstallerOptions } from '../../factory.js';
 import type Oas from 'oas';
 import type Operation from 'oas/operation';
 import type { HttpMethods, SchemaObject } from 'oas/rmoas.types';
+import type { OpenAPIV3_1 } from 'openapi-types';
 import type { SemVer } from 'semver';
 import type {
   ClassDeclaration,
@@ -18,6 +19,7 @@ import path from 'node:path';
 
 import corePkg from '@readme/api-core/package.json' assert { type: 'json' };
 import { execa } from 'execa';
+import { findLicense, getLicense } from 'license';
 import setWith from 'lodash.setwith';
 import semver from 'semver';
 import { IndentationText, Project, QuoteKind, ScriptTarget, VariableDeclarationKind } from 'ts-morph';
@@ -285,12 +287,13 @@ export default class TSGenerator extends CodeGenerator {
       { defaultImport: 'definition', moduleSpecifier: this.specPath },
     ]);
 
-    // @todo add TOS, License, info.* to a docblock at the top of the SDK.
     this.sdk = sourceFile.addClass({
       name: 'SDK',
       properties: [{ name: 'core', type: 'APICore' }],
     });
 
+    this.createSDKHeading();
+
     this.sdk.addConstructor({
       statements: writer => {
         writer.write('this.core = new APICore(definition, ').quote(this.userAgent).write(');');
@@ -544,6 +547,84 @@ Generated at ${createdAt}
     return sourceFile;
   }
 
+  /**
+   * Fill out a JSDoc heading on the SDK we're creating based on various pieces of data that may be
+   * present in the OpenAPI definition `info` object.
+   *
+   * Additionally if a license in `info.license` is recognized by the SPDX we'll also create a
+   * `LICENSE` file in for their generated SDK. We're only supporting SPDX-recognized licenses for
+   * this because we otherwise have no idea what the license represents.
+   *
+   * @see {@link https://spdx.org/licenses/}
+   */
+  private createSDKHeading() {
+    let docblock: OptionalKind<JSDocStructure> = {};
+
+    // The OpenAPI 3.1 `info` object added some properties that aren't available in 3.0 but 3.1
+    // still contains everything that was available in 3.0 so to allow us to not have to do gross
+    // `as OpenAPIV3_1.InfoObject` typing everywhere we're just assuming that we have 3.1 object
+    // here.
+    const infoObject = this.spec.api.info as OpenAPIV3_1.InfoObject;
+    if (infoObject?.title || infoObject?.description) {
+      docblock.description = writer => {
+        if (infoObject.title) {
+          writer.writeLine(docblockEscape(wordWrap(infoObject.title)));
+        }
+
+        if (infoObject.description) {
+          writer.conditionalNewLine(!!infoObject.title);
+          writer.writeLine(docblockEscape(wordWrap(infoObject.description)));
+        }
+
+        writer.newLineIfLastNot();
+        return writer;
+      };
+    }
+
+    if (infoObject?.termsOfService) {
+      docblock = TSGenerator.#addTagToDocblock(docblock, {
+        tagName: 'see',
+        text: `{@link ${infoObject.termsOfService} Terms of Service}`,
+      });
+    }
+
+    if (infoObject?.license?.name || infoObject?.license?.identifier) {
+      let spdxLicense;
+      if (infoObject?.license?.identifier) {
+        spdxLicense = infoObject?.license?.identifier;
+      } else {
+        // Though `name` is required by the OpenAPI specification but most people seem to use `name`
+        // instead `identifier` for their licensing identifier so if they've done this we should
+        // try to make the license name recognizable by the `license` package. For example this'll
+        // change "Apache 2.0" to the SPDX-recognized "Apache-2.0".
+        spdxLicense = infoObject?.license?.name.replace(/ /g, '-');
+      }
+
+      // If the license they've got has too many matches we shouldn't try to pick a license because
+      // we'll run the risk of licensing it under a license they didn't intend.
+      if (findLicense(spdxLicense).length === 1) {
+        docblock = TSGenerator.#addTagToDocblock(docblock, {
+          tagName: 'license',
+          text: spdxLicense,
+        });
+
+        if (infoObject?.license?.url) {
+          docblock = TSGenerator.#addTagToDocblock(docblock, {
+            tagName: 'see',
+            text: `{@link ${infoObject.license.url}}`,
+          });
+        }
+
+        // We should add a LICENSE file to their SDK too.
+        this.project.createSourceFile('LICENSE', getLicense(spdxLicense));
+      }
+    }
+
+    if (Object.keys(docblock).length) {
+      this.sdk.addJsDoc(docblock);
+    }
+  }
+
   /**
    * Create our main schemas file. This is where all of the JSON Schema that our TypeScript typing
    * infrastructure sources its data from. Without this there are no types.

packages/api/src/storage.ts

@@ -83,15 +83,24 @@ export default class Storage {
    * Reset the state of the entire storage system.
    *
    * This will completely destroy the contents of the `.api/` directory!
+   *
+   * @internal
    */
   static async reset() {
+    const noop = () => {
+      // If any of these file and directory removals fail we don't need to throw any errors because
+      // this method is only used internally in unit tests.
+    };
+
     if (Storage.getLockfilePath()) {
-      await fs.promises.writeFile(Storage.getLockfilePath(), JSON.stringify(Storage.getDefaultLockfile(), null, 2));
+      await fs.promises
+        .writeFile(Storage.getLockfilePath(), JSON.stringify(Storage.getDefaultLockfile(), null, 2))
+        .catch(noop);
     }
 
     if (Storage.getAPIsDir()) {
-      await fs.promises.rm(Storage.getAPIsDir(), { recursive: true });
-      await fs.promises.mkdir(Storage.getAPIsDir(), { recursive: true });
+      await fs.promises.rm(Storage.getAPIsDir(), { recursive: true }).catch(noop);
+      await fs.promises.mkdir(Storage.getAPIsDir(), { recursive: true }).catch(noop);
     }
   }
 

packages/api/test/codegen/languages/typescript/index.test.ts

@@ -98,21 +98,15 @@ function assertSDKFixture(file: string, fixture: string) {
 describe('typescript', () => {
   beforeEach(() => {
     vi.setSystemTime(new Date('2023'));
+    Storage.setStorageDir(uniqueTempDir());
   });
 
   afterEach(() => {
     vi.useRealTimers();
+    Storage.reset();
   });
 
   describe('#install', () => {
-    beforeEach(() => {
-      Storage.setStorageDir(uniqueTempDir());
-    });
-
-    afterEach(() => {
-      Storage.reset();
-    });
-
     it('should install the required packages', async () => {
       const logger = vi.fn();
 

packages/test-utils/sdks/alby/src/index.ts

@@ -3,6 +3,19 @@ import type { ConfigOptions, FetchResponse } from '@readme/api-core/types';
 import APICore from '@readme/api-core';
 import definition from '@api/test-utils/definitions/alby.json';
 
+/**
+ * Control API v1
+ *
+ * Use the Control API to manage your applications, namespaces, keys, queues, rules, and
+ * more.
+ *
+ * Detailed information on using this API can be found in the Ably <a
+ * href="https://ably.com/documentation/control-api">developer documentation</a>.
+ *
+ * Control API is currently in Beta.
+ *
+ *
+ */
 class SDK {
   core: APICore;
 

packages/test-utils/sdks/metrotransit/src/index.ts

@@ -3,6 +3,13 @@ import type { ConfigOptions, FetchResponse } from '@readme/api-core/types';
 import APICore from '@readme/api-core';
 import definition from '@api/test-utils/definitions/metrotransit.json';
 
+/**
+ * NexTrip API
+ *
+ * API for creating Metro Transit real-time departure information display (beta, subject to
+ * change)
+ *
+ */
 class SDK {
   core: APICore;
 

packages/test-utils/sdks/operationid-quirks/src/index.ts

@@ -2,6 +2,10 @@ import type { ConfigOptions, FetchResponse } from '@readme/api-core/types';
 import APICore from '@readme/api-core';
 import definition from '@api/test-utils/definitions/operationid-quirks.json';
 
+/**
+ * Quirky `operationID` cases
+ *
+ */
 class SDK {
   core: APICore;
 

packages/test-utils/sdks/optional-payload/src/index.ts

@@ -3,6 +3,10 @@ import type { ConfigOptions, FetchResponse } from '@readme/api-core/types';
 import APICore from '@readme/api-core';
 import definition from '@api/test-utils/definitions/optional-payload.json';
 
+/**
+ * Example API with a requestBody payload that's optional.
+ *
+ */
 class SDK {
   core: APICore;
 

packages/test-utils/sdks/petstore/LICENSE

@@ -0,0 +1,97 @@
+Apache License
+
+Version 2.0, January 2004
+
+http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+
+
+      "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+
+
+      "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+
+
+      "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+
+
+      "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+
+
+      "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+
+
+      "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+
+
+      "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+
+
+      "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+
+
+      "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] <author>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+
+you may not use this file except in compliance with the License.
+
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+
+distributed under the License is distributed on an "AS IS" BASIS,
+
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
+See the License for the specific language governing permissions and
+
+limitations under the License.

packages/test-utils/sdks/petstore/src/index.ts

@@ -3,6 +3,18 @@ import type { ConfigOptions, FetchResponse } from '@readme/api-core/types';
 import APICore from '@readme/api-core';
 import definition from '@readme/oas-examples/3.0/json/petstore.json';
 
+/**
+ * Swagger Petstore
+ *
+ * This is a sample server Petstore server.  You can find out more about Swagger at
+ * [http://swagger.io](http://swagger.io) or on [irc.freenode.net,
+ * #swagger](http://swagger.io/irc/).  For this sample, you can use the api key
+ * `special-key` to test the authorization filters.
+ *
+ * @see {@link http://swagger.io/terms/ Terms of Service}
+ * @license Apache-2.0
+ * @see {@link http://www.apache.org/licenses/LICENSE-2.0.html}
+ */
 class SDK {
   core: APICore;
 

packages/test-utils/sdks/readme/src/index.ts

@@ -3,6 +3,12 @@ import type { ConfigOptions, FetchResponse } from '@readme/api-core/types';
 import APICore from '@readme/api-core';
 import definition from '@readme/oas-examples/3.0/json/readme.json';
 
+/**
+ * ReadMe API 🦉
+ *
+ * Create beautiful product and API documentation with our developer friendly platform.
+ *
+ */
 class SDK {
   core: APICore;