Merge branch 'main' into joan/order-from-config

Author: SamVerschueren

packages/types/package.json

@@ -14,12 +14,14 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsc -b"
+    "build": "tsc -b tsconfig.build.json",
+    "test": "vitest"
   },
   "dependencies": {
     "zod": "3.23.8"
   },
   "devDependencies": {
-    "typescript": "^5.4.5"
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0"
   }
 }

packages/types/src/files-ref.spec.ts

@@ -0,0 +1,21 @@
+import { describe, it, expect } from 'vitest';
+import { folderPathToFilesRef } from './files-ref.js';
+
+describe('folderPathToFilesRef', () => {
+  const testCases = [
+    ['path/to/folder', 'path-to-folder.json'],
+    ['path/to///folder', 'path-to-folder.json'],
+    ['files', 'files.json'],
+    ['path/to/folder_2', 'path-to-folder2.json'],
+    ['path\\to\\folder', 'path-to-folder.json'],
+    ['path\\to\\\\\\folder', 'path-to-folder.json'],
+  ];
+
+  testCases.forEach(([folderPath, expectedFilesRef]) => {
+    it(`should return the files ref for a given folder path - ${folderPath}`, () => {
+      const filesRef = folderPathToFilesRef(folderPath);
+
+      expect(filesRef).toBe(expectedFilesRef);
+    });
+  });
+});

packages/types/src/schemas/chapter.spec.ts

@@ -0,0 +1,40 @@
+import { describe, it, expect } from 'vitest';
+import { chapterSchema } from './chapter.js';
+
+describe('chapterSchema', () => {
+  it('should validate a valid chapter object', () => {
+    expect(() =>
+      chapterSchema.parse({
+        title: 'Chapter 1',
+        type: 'chapter',
+        slug: 'chapter-one',
+      }),
+    ).not.toThrow();
+  });
+
+  it('should validate a chapter object without optional properties', () => {
+    expect(() =>
+      chapterSchema.parse({
+        title: 'Chapter 1',
+        type: 'chapter',
+      }),
+    ).not.toThrow();
+  });
+
+  it('should throw an error for a chapter object with invalid type', () => {
+    expect(() =>
+      chapterSchema.parse({
+        title: 'Chapter 1',
+        type: 'invalid',
+      }),
+    ).toThrow();
+  });
+
+  it('should throw an error for a chapter object with missing type property', () => {
+    expect(() =>
+      chapterSchema.parse({
+        title: 'Chapter 1',
+      }),
+    ).toThrow();
+  });
+});