PR changes

gsoft-inc · Jul 17, 2024 · 2df9bcb · 2df9bcb
1 parent abe13b6
commit 2df9bcb
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 11 deletions.
diff --git a/packages/create-schemas/src/plugins/header-plugin.ts b/packages/create-schemas/src/plugins/header-plugin.ts
@@ -4,7 +4,7 @@ interface HeaderPluginOptions {
     header?: string;
 }
 
-export function headerPlugin({ header = "Do not modify. This file has been generated by @workleap/create-schemas" }: HeaderPluginOptions = {}): Plugin {
+export function headerPlugin({ header = "This file has been generated by @workleap/create-schemas (https://github.com/gsoft-inc/wl-openapi-typescript). Do not modify manually." }: HeaderPluginOptions = {}): Plugin {
     return {
         name: "internal:header-plugin",
         async transform({ code }) {

diff --git a/packages/create-schemas/src/plugins/types-plugin.ts b/packages/create-schemas/src/plugins/types-plugin.ts
@@ -34,9 +34,13 @@ export function typesPlugin(): Plugin {
                 .map(name => {
                     if (RESERVED_IDENTIFIERS.has(name)) {
                         throw new Error(`Invalid schema name: ${name}`);
-                    } else {
-                        return name;
                     }
+
+                    if (toSafeName(name).length === 0) {
+                        throw new Error(`Invalid schema name: ${name}`);
+                    }
+
+                    return name;
                 })
                 .map(name => `export type ${toSafeName(name)} = ${componentsIdentifier}["${schemasIdentifier}"]["${name}"];`)
                 .flatMap(stringToAST) as ts.Node[];
@@ -60,7 +64,6 @@ export function isComponentsSchema(node: ts.Node): node is ts.PropertySignature
     && node.name.text === schemasIdentifier;
 }
 
-
 /**
  * OpenAPI field names must match `^[a-zA-Z0-9\.\-_]+$` which allows names that
  * are not valid JavaScript/TypeScript identifiers. This function converts an

diff --git a/packages/create-schemas/tests/__snapshots__/e2e.test.ts.snap b/packages/create-schemas/tests/__snapshots__/e2e.test.ts.snap
@@ -1,7 +1,7 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`e2e > officevice.yaml / file URLs 1`] = `
-"/** Do not modify. This file has been generated by @workleap/create-schemas */
+"/** This file has been generated by @workleap/create-schemas (https://github.com/gsoft-inc/wl-openapi-typescript). Do not modify manually. */
 export interface paths {
     "/good-vibes-points/{userId}": {
         parameters: {
@@ -86,7 +86,7 @@ export type Endpoints = keyof paths;
 `;
 
 exports[`e2e > officevice.yaml / file paths 1`] = `
-"/** Do not modify. This file has been generated by @workleap/create-schemas */
+"/** This file has been generated by @workleap/create-schemas (https://github.com/gsoft-inc/wl-openapi-typescript). Do not modify manually. */
 export interface paths {
     "/good-vibes-points/{userId}": {
         parameters: {
@@ -171,7 +171,7 @@ export type Endpoints = keyof paths;
 `;
 
 exports[`e2e > officevice.yaml / relative path 1`] = `
-"/** Do not modify. This file has been generated by @workleap/create-schemas */
+"/** This file has been generated by @workleap/create-schemas (https://github.com/gsoft-inc/wl-openapi-typescript). Do not modify manually. */
 export interface paths {
     "/good-vibes-points/{userId}": {
         parameters: {
@@ -256,7 +256,7 @@ export type Endpoints = keyof paths;
 `;
 
 exports[`e2e > petstore.json / remote URL 1`] = `
-"/** Do not modify. This file has been generated by @workleap/create-schemas */
+"/** This file has been generated by @workleap/create-schemas (https://github.com/gsoft-inc/wl-openapi-typescript). Do not modify manually. */
 export interface paths {
     "/pet": {
         parameters: {
@@ -1267,7 +1267,7 @@ export type Endpoints = keyof paths;
 `;
 
 exports[`e2e > petstore.json 1`] = `
-"/** Do not modify. This file has been generated by @workleap/create-schemas */
+"/** This file has been generated by @workleap/create-schemas (https://github.com/gsoft-inc/wl-openapi-typescript). Do not modify manually. */
 export interface paths {
     "/pets": {
         parameters: {

diff --git a/packages/create-schemas/tests/__snapshots__/watch.test.ts.snap b/packages/create-schemas/tests/__snapshots__/watch.test.ts.snap
@@ -1,7 +1,7 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`watch > changing the input 1`] = `
-"/** Do not modify. This file has been generated by @workleap/create-schemas */
+"/** This file has been generated by @workleap/create-schemas (https://github.com/gsoft-inc/wl-openapi-typescript). Do not modify manually. */
 export interface paths {
     "/pets": {
         parameters: {
@@ -166,7 +166,7 @@ export type Endpoints = keyof paths;
 `;
 
 exports[`watch > changing the input 2`] = `
-"/** Do not modify. This file has been generated by @workleap/create-schemas */
+"/** This file has been generated by @workleap/create-schemas (https://github.com/gsoft-inc/wl-openapi-typescript). Do not modify manually. */
 export interface paths {
     "/task": {
         parameters: {

diff --git a/packages/create-schemas/tests/data/invalid-name.json b/packages/create-schemas/tests/data/invalid-name.json
@@ -0,0 +1,18 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Ambiguous Name",
+    "license": {
+      "name": "MIT",
+      "url": "https://opensource.org/licenses/MIT"
+    }
+  },
+  "components": {
+    "schemas": {
+      "...": {
+        "type": "string"
+      }
+    }
+  }
+}
diff --git a/packages/create-schemas/tests/generate.test.ts b/packages/create-schemas/tests/generate.test.ts
@@ -31,4 +31,14 @@ describe.concurrent("generate", () => {
 
         expect(fn).rejects.toThrow();
     });
+
+    test("reject invalid names", async ({ expect }) => {
+        const fn = async () => {
+            await generate(await resolveConfig({
+                input: join(dataFolder, "invalid-name.json")
+            }));
+        };
+
+        expect(fn).rejects.toThrow();
+    });
 });