fix(typescript): identifiers containing dashes (#315)

Co-authored-by: Alan Poulain <[email protected]>

Author: 4rthem

package.json

@@ -37,19 +37,20 @@
     "jest-light-runner": "^0.3.0",
     "lint-staged": "^13.0.0",
     "start-server-and-test": "^1.14.0",
-    "tmp": "^0.2.1"
+    "tmp": "^0.2.0"
   },
   "dependencies": {
     "@api-platform/api-doc-parser": "^0.15.0",
     "@babel/runtime": "^7.0.0",
     "chalk": "^5.0.0",
     "commander": "^9.4.0",
-    "handlebars": "^4.0.12",
+    "esutils": "^2.0.0",
+    "handlebars": "^4.0.0",
     "handlebars-helpers": "^0.10.0",
     "isomorphic-fetch": "^3.0.0",
-    "mkdirp": "^1.0.4",
+    "mkdirp": "^1.0.0",
     "prettier": "^2.7.0",
-    "sprintf-js": "^1.1.1"
+    "sprintf-js": "^1.1.0"
   },
   "scripts": {
     "prepare": "husky install",

src/generators/TypescriptInterfaceGenerator.js

@@ -1,10 +1,16 @@
+import handlebars from "handlebars";
+import { keyword } from "esutils";
 import BaseGenerator from "./BaseGenerator.js";
 
 export default class TypescriptInterfaceGenerator extends BaseGenerator {
   constructor(params) {
     super(params);
 
     this.registerTemplates(`typescript/`, ["interface.ts"]);
+
+    handlebars.registerHelper("isIdentifier", (name) =>
+      keyword.isIdentifierES5(name)
+    );
   }
 
   help(resource) {
@@ -18,14 +24,16 @@ export default class TypescriptInterfaceGenerator extends BaseGenerator {
     const dest = `${dir}/interfaces`;
     const { fields, imports } = this.parseFields(resource);
 
+    const normalizeTypeName = (name) => name.replace(/-/g, "_");
+
     this.createDir(dest, false);
     this.createFile(
       "interface.ts",
       `${dest}/${resource.title.toLowerCase()}.ts`,
       {
         fields,
         imports,
-        name: resource.title,
+        name: normalizeTypeName(resource.title),
       }
     );
   }

src/generators/TypescriptInterfaceGenerator.test.js

@@ -173,3 +173,61 @@ test("Generate a typescript interface with an explicit id field in the readableF
 
   tmpobj.removeCallback();
 });
+
+test("Generate a typescript interface with invalid JS identifiers for fields and title", () => {
+  const generator = new TypescriptInterfaceGenerator({
+    templateDirectory: `${dirname}/../../templates`,
+  });
+  const tmpobj = tmp.dirSync({ unsafeCleanup: true });
+
+  const resource = new Resource("abc", "http://example.com/foos", {
+    id: "foo",
+    title: "Foo-foo",
+    readableFields: [
+      new Field("bar-bar", {
+        id: "http://schema.org/url",
+        range: "http://www.w3.org/2001/XMLSchema#string",
+        reference: null,
+        required: true,
+        description: "An URL",
+      }),
+      new Field("id", {
+        id: "http://schema.org/url",
+        range: "http://www.w3.org/2001/XMLSchema#string",
+        reference: null,
+        required: false,
+        description: "Id",
+      }),
+    ],
+    writableFields: [
+      new Field("foo-foo", {
+        id: "http://schema.org/url",
+        range: "http://www.w3.org/2001/XMLSchema#datetime",
+        reference: null,
+        required: true,
+        description: "An URL",
+      }),
+    ],
+  });
+  const api = new Api("http://example.com", {
+    entrypoint: "http://example.com:8080",
+    title: "My API",
+    resources: [resource],
+  });
+  generator.generate(api, resource, tmpobj.name);
+
+  expect(fs.existsSync(tmpobj.name + "/interfaces/foo-foo.ts")).toBe(true);
+
+  const res = `export interface Foo_foo {
+  "@id"?: string;
+  "foo-foo": any;
+  readonly "bar-bar": string;
+  readonly id?: string;
+}
+`;
+  expect(
+    fs.readFileSync(tmpobj.name + "/interfaces/foo-foo.ts").toString()
+  ).toEqual(res);
+
+  tmpobj.removeCallback();
+});

templates/typescript/interface.ts

@@ -1,6 +1,8 @@
 export interface {{{name}}} {
   '@id'?: string;
-{{#each fields}}
- {{#if readonly}} readonly{{/if}} {{{name}}}{{#if notrequired}}?{{/if}}: {{{type}}};
-{{/each}}
+  {{#each fields}}
+    {{#if readonly}} readonly{{/if}} {{#unless (isIdentifier name)}}"{{/unless}}
+      {{~ name ~}}
+    {{#unless (isIdentifier name)}}"{{/unless}}{{#if notrequired}}?{{/if}}: {{{type}}};
+  {{/each}}
 }

yarn.lock

@@ -2809,7 +2809,7 @@ estraverse@^5.1.0, estraverse@^5.2.0:
   resolved "https://registry.yarnpkg.com/estraverse/-/estraverse-5.3.0.tgz#2eea5290702f26ab8fe5370370ff86c965d21123"
   integrity sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==
 
-esutils@^2.0.2:
+esutils@^2.0.0, esutils@^2.0.2:
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64"
   integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==
@@ -3283,7 +3283,7 @@ handlebars-utils@^1.0.2, handlebars-utils@^1.0.4, handlebars-utils@^1.0.6:
     kind-of "^6.0.0"
     typeof-article "^0.1.1"
 
-handlebars@^4.0.11, handlebars@^4.0.12:
+handlebars@^4.0.0, handlebars@^4.0.11:
   version "4.7.7"
   resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.7.tgz#9ce33416aad02dbd6c8fafa8240d5d98004945a1"
   integrity sha512-aAcXm5OAfE/8IXkcZvCepKU3VzW1/39Fb5ZuqMtgI/hT8X2YgoMvBY5dLhq/cpOvw7Lk1nK/UF71aLG/ZnVYRA==
@@ -4608,7 +4608,7 @@ mixin-deep@^1.2.0:
     for-in "^1.0.2"
     is-extendable "^1.0.1"
 
-mkdirp@^1.0.4:
+mkdirp@^1.0.0:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e"
   integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==
@@ -5454,7 +5454,7 @@ [email protected]:
   dependencies:
     through "2"
 
-sprintf-js@^1.1.1:
+sprintf-js@^1.1.0:
   version "1.1.2"
   resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.1.2.tgz#da1765262bf8c0f571749f2ad6c26300207ae673"
   integrity sha512-VE0SOVEHCk7Qc8ulkWw3ntAzXuqf7S2lvwQaDLRnUeIEaKNQJzV6BwmLKhOqT61aGhfUMrXeaBk+oDGCzvhcug==
@@ -5683,7 +5683,7 @@ time-stamp@^1.0.1:
   resolved "https://registry.yarnpkg.com/time-stamp/-/time-stamp-1.1.0.tgz#764a5a11af50561921b133f3b44e618687e0f5c3"
   integrity sha512-gLCeArryy2yNTRzTGKbZbloctj64jkZ57hj5zdraXue6aFgd6PmvVtEyiUU+hvU0v7q08oVv8r8ev0tRo6bvgw==
 
-tmp@^0.2.1:
+tmp@^0.2.0:
   version "0.2.1"
   resolved "https://registry.yarnpkg.com/tmp/-/tmp-0.2.1.tgz#8457fc3037dcf4719c251367a1af6500ee1ccf14"
   integrity sha512-76SUhtfqR2Ijn+xllcI5P1oyannHNHByD80W1q447gU3mp9G9PSpGdWmjUOHRDPiHYacIk66W7ubDTuPF3BEtQ==