fix: 🐛 allow empty str author,generator,keywords in manifest (#71)

* fix: 🐛 allow empty str author,generator,keywords in manifest ✅ Closes: #70 * chore: 🤖 update changelog * chore: 🤖 fix typo
dotlottie · Apr 25, 2024 · 340d9aa · 340d9aa
1 parent a641781
commit 340d9aa
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 10 deletions.
diff --git a/.changeset/tall-flowers-scream.md b/.changeset/tall-flowers-scream.md
@@ -0,0 +1,5 @@
+---
+"@dotlottie/dotlottie-js": patch
+---
+
+fix: 🐛 allow empty str author,generator,keywords in manifest
diff --git a/packages/dotlottie-js/src/common/dotlottie-common.ts b/packages/dotlottie-js/src/common/dotlottie-common.ts
@@ -167,31 +167,31 @@ export class DotLottieCommon {
   }
 
   public setAuthor(author: string | undefined): DotLottieCommon {
-    this._author = author ?? 'LottieFiles';
+    this._author = typeof author === 'string' ? author : 'LottieFiles';
 
     return this;
   }
 
   public setDescription(description: string | undefined): DotLottieCommon {
-    this._description = description ?? '';
+    this._description = typeof description === 'string' ? description : '';
 
     return this;
   }
 
   public setGenerator(generator: string | undefined): DotLottieCommon {
-    this._generator = generator ?? `${pkg.name}@${pkg.version}`;
+    this._generator = typeof generator === 'string' ? generator : `${pkg.name}@${pkg.version}`;
 
     return this;
   }
 
   public setKeywords(keywords: string | undefined): DotLottieCommon {
-    this._keywords = keywords ?? 'dotLottie';
+    this._keywords = typeof keywords === 'string' ? keywords : 'dotLottie';
 
     return this;
   }
 
   public setVersion(version: string | undefined): DotLottieCommon {
-    this._version = version ?? '1.0';
+    this._version = typeof version === 'string' ? version : '1.0';
 
     return this;
   }
@@ -699,23 +699,23 @@ export class DotLottieCommon {
   }
 
   protected _requireValidAuthor(author: string | undefined): asserts author is string {
-    if (!author) throw createError('Invalid author');
+    if (typeof author !== 'string') throw createError('Invalid author');
   }
 
   protected _requireValidDescription(description: string | undefined): asserts description is string {
-    if (!description) throw createError('Invalid description');
+    if (typeof description !== 'string') throw createError('Invalid description');
   }
 
   protected _requireValidGenerator(generator: string | undefined): asserts generator is string {
-    if (!generator) throw createError('Invalid generator');
+    if (typeof generator !== 'string') throw createError('Invalid generator');
   }
 
   protected _requireValidKeywords(keywords: string | undefined): asserts keywords is string {
-    if (!keywords) throw createError('Invalid keywords');
+    if (typeof keywords !== 'string') throw createError('Invalid keywords');
   }
 
   protected _requireValidVersion(version: string | undefined): asserts version is string {
-    if (!version) throw createError('Invalid version');
+    if (typeof version !== 'string') throw createError('Invalid version');
   }
 
   protected _requireValidCustomData(

diff --git a/packages/dotlottie-js/src/tests/dotlottie-js-browser.spec.ts b/packages/dotlottie-js/src/tests/dotlottie-js-browser.spec.ts
@@ -53,6 +53,14 @@ describe('DotLottie', () => {
 
       expect(dotlottie.version).toBe(version);
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setVersion('');
+
+      expect(dotlottie.version).toBe('');
+    });
   });
 
   describe('setAuthor', () => {
@@ -71,6 +79,14 @@ describe('DotLottie', () => {
 
       expect(dotlottie.author).toBe('Design Barn');
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setAuthor('');
+
+      expect(dotlottie.author).toBe('');
+    });
   });
 
   describe('setRevision', () => {
@@ -109,6 +125,14 @@ describe('DotLottie', () => {
 
       expect(dotlottie.description).toBe('A description');
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setDescription('');
+
+      expect(dotlottie.description).toBe('');
+    });
   });
 
   describe('setGenerator', () => {
@@ -135,6 +159,14 @@ describe('DotLottie', () => {
 
       expect(dotLottie.generator).toBe(`${pkg.name}@${pkg.version}`);
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setGenerator('');
+
+      expect(dotlottie.generator).toBe('');
+    });
   });
 
   describe('setRevision', () => {
@@ -175,6 +207,14 @@ describe('DotLottie', () => {
 
       expect(dotlottie.keywords).toBe(keywords);
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setKeywords('');
+
+      expect(dotlottie.keywords).toBe('');
+    });
   });
 
   describe('addAnimation', () => {

diff --git a/packages/dotlottie-js/src/tests/dotlottie-js-node.spec.ts b/packages/dotlottie-js/src/tests/dotlottie-js-node.spec.ts
@@ -53,6 +53,14 @@ describe('DotLottie', () => {
 
       expect(dotlottie.version).toBe(version);
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setVersion('');
+
+      expect(dotlottie.version).toBe('');
+    });
   });
 
   describe('setAuthor', () => {
@@ -71,6 +79,14 @@ describe('DotLottie', () => {
 
       expect(dotlottie.author).toBe('Design Barn');
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setAuthor('');
+
+      expect(dotlottie.author).toBe('');
+    });
   });
 
   describe('setRevision', () => {
@@ -109,6 +125,14 @@ describe('DotLottie', () => {
 
       expect(dotlottie.description).toBe('A description');
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setDescription('');
+
+      expect(dotlottie.description).toBe('');
+    });
   });
 
   describe('setGenerator', () => {
@@ -135,6 +159,14 @@ describe('DotLottie', () => {
 
       expect(dotLottie.generator).toBe(`${pkg.name}/node@${pkg.version}`);
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setGenerator('');
+
+      expect(dotlottie.generator).toBe('');
+    });
   });
 
   describe('setRevision', () => {
@@ -175,6 +207,14 @@ describe('DotLottie', () => {
 
       expect(dotlottie.keywords).toBe(keywords);
     });
+
+    it('accepts empty string', () => {
+      const dotlottie = new DotLottie();
+
+      dotlottie.setKeywords('');
+
+      expect(dotlottie.keywords).toBe('');
+    });
   });
 
   describe('addAnimation', () => {