portapack 0.3.0 → 0.3.2

package/tests/unit/utils/mime.test.ts

@@ -8,89 +8,88 @@ import { describe, it, expect } from '@jest/globals';
 import type { Asset } from '../../../src/types'; // Import Asset type
 
 describe('🧪 MIME Utilities', () => {
+  describe('guessMimeType()', () => {
+    const defaultResult = { mime: 'application/octet-stream', assetType: 'other' as Asset['type'] };
 
-    describe('guessMimeType()', () => {
-        const defaultResult = { mime: 'application/octet-stream', assetType: 'other' as Asset['type'] };
+    // Test cases: [input, expectedMime, expectedAssetType]
+    const testCases: [string, string, Asset['type']][] = [
+      // CSS
+      ['style.css', 'text/css', 'css'],
+      ['path/to/style.CSS', 'text/css', 'css'], // Case-insensitive extension
+      ['style.css?v=1.0', 'text/css', 'css'], // With query string
+      ['/path/style.css#id', 'text/css', 'css'], // With fragment
+      ['https://example.com/a/b/c/style.css?q=1', 'text/css', 'css'], // Remote URL
 
-        // Test cases: [input, expectedMime, expectedAssetType]
-        const testCases: [string, string, Asset['type']][] = [
-            // CSS
-            ['style.css', 'text/css', 'css'],
-            ['path/to/style.CSS', 'text/css', 'css'], // Case-insensitive extension
-            ['style.css?v=1.0', 'text/css', 'css'], // With query string
-            ['/path/style.css#id', 'text/css', 'css'], // With fragment
-            ['https://example.com/a/b/c/style.css?q=1', 'text/css', 'css'], // Remote URL
+      // JS
+      ['script.js', 'application/javascript', 'js'],
+      ['script.mjs', 'application/javascript', 'js'],
+      ['https://cdn.com/lib.js', 'application/javascript', 'js'],
 
-            // JS
-            ['script.js', 'application/javascript', 'js'],
-            ['script.mjs', 'application/javascript', 'js'],
-            ['https://cdn.com/lib.js', 'application/javascript', 'js'],
+      // Images
+      ['logo.png', 'image/png', 'image'],
+      ['photo.jpg', 'image/jpeg', 'image'],
+      ['image.jpeg', 'image/jpeg', 'image'],
+      ['anim.gif', 'image/gif', 'image'],
+      ['icon.svg', 'image/svg+xml', 'image'],
+      ['image.webp', 'image/webp', 'image'],
+      ['favicon.ico', 'image/x-icon', 'image'],
+      ['image.avif', 'image/avif', 'image'],
 
-            // Images
-            ['logo.png', 'image/png', 'image'],
-            ['photo.jpg', 'image/jpeg', 'image'],
-            ['image.jpeg', 'image/jpeg', 'image'],
-            ['anim.gif', 'image/gif', 'image'],
-            ['icon.svg', 'image/svg+xml', 'image'],
-            ['image.webp', 'image/webp', 'image'],
-            ['favicon.ico', 'image/x-icon', 'image'],
-            ['image.avif', 'image/avif', 'image'],
+      // Fonts
+      ['font.woff', 'font/woff', 'font'],
+      ['font.woff2', 'font/woff2', 'font'],
+      ['font.ttf', 'font/ttf', 'font'],
+      ['font.otf', 'font/otf', 'font'],
+      ['font.eot', 'application/vnd.ms-fontobject', 'font'],
 
-            // Fonts
-            ['font.woff', 'font/woff', 'font'],
-            ['font.woff2', 'font/woff2', 'font'],
-            ['font.ttf', 'font/ttf', 'font'],
-            ['font.otf', 'font/otf', 'font'],
-            ['font.eot', 'application/vnd.ms-fontobject', 'font'],
+      // Audio/Video ('other')
+      ['audio.mp3', 'audio/mpeg', 'other'],
+      ['audio.ogg', 'audio/ogg', 'other'],
+      ['audio.wav', 'audio/wav', 'other'],
+      ['video.mp4', 'video/mp4', 'other'],
+      ['video.webm', 'video/webm', 'other'],
 
-            // Audio/Video ('other')
-            ['audio.mp3', 'audio/mpeg', 'other'],
-            ['audio.ogg', 'audio/ogg', 'other'],
-            ['audio.wav', 'audio/wav', 'other'],
-            ['video.mp4', 'video/mp4', 'other'],
-            ['video.webm', 'video/webm', 'other'],
+      // Other ('other')
+      ['data.json', 'application/json', 'other'],
+      ['manifest.webmanifest', 'application/manifest+json', 'other'],
+      ['document.xml', 'application/xml', 'other'],
+      ['page.html', 'text/html', 'other'],
+      ['notes.txt', 'text/plain', 'other'],
 
-            // Other ('other')
-            ['data.json', 'application/json', 'other'],
-            ['manifest.webmanifest', 'application/manifest+json', 'other'],
-            ['document.xml', 'application/xml', 'other'],
-            ['page.html', 'text/html', 'other'],
-            ['notes.txt', 'text/plain', 'other'],
+      // Edge cases
+      ['file_without_extension', defaultResult.mime, defaultResult.assetType],
+      ['file.unknown', defaultResult.mime, defaultResult.assetType],
+      ['.', defaultResult.mime, defaultResult.assetType], // Just a dot
+      ['image.', defaultResult.mime, defaultResult.assetType], // Dot at the end
+      // URLs with complex paths/queries but known extensions
+      ['https://example.com/complex/path.with.dots/image.png?a=1&b=2#frag', 'image/png', 'image'],
+      ['file:///C:/Users/Test/Documents/my%20font.ttf', 'font/ttf', 'font'], // File URI
+    ];
 
-            // Edge cases
-            ['file_without_extension', defaultResult.mime, defaultResult.assetType],
-            ['file.unknown', defaultResult.mime, defaultResult.assetType],
-            ['.', defaultResult.mime, defaultResult.assetType], // Just a dot
-            ['image.', defaultResult.mime, defaultResult.assetType], // Dot at the end
-             // URLs with complex paths/queries but known extensions
-             ['https://example.com/complex/path.with.dots/image.png?a=1&b=2#frag', 'image/png', 'image'],
-             ['file:///C:/Users/Test/Documents/my%20font.ttf', 'font/ttf', 'font'], // File URI
-        ];
+    // it.each(testCases)('should return correct type for "%s"', (input, expectedMime, expectedAssetType) => {
+    //      const result = guessMimeType(input);
+    //      expect(result.mime).toBe(expectedMime);
+    //      expect(result.assetType).toBe(expectedAssetType);
+    // });
 
-        // it.each(testCases)('should return correct type for "%s"', (input, expectedMime, expectedAssetType) => {
-        //      const result = guessMimeType(input);
-        //      expect(result.mime).toBe(expectedMime);
-        //      expect(result.assetType).toBe(expectedAssetType);
-        // });
-
-        it('should return default for null or empty input', () => {
-             // @ts-expect-error Testing invalid input
-             expect(guessMimeType(null)).toEqual(defaultResult);
-             expect(guessMimeType('')).toEqual(defaultResult);
-             expect(guessMimeType(undefined as any)).toEqual(defaultResult); // Test undefined
-        });
+    it('should return default for null or empty input', () => {
+      // @ts-expect-error Testing invalid input
+      expect(guessMimeType(null)).toEqual(defaultResult);
+      expect(guessMimeType('')).toEqual(defaultResult);
+      expect(guessMimeType(undefined as any)).toEqual(defaultResult); // Test undefined
     });
+  });
 
-     // Test deprecated getFontMimeType (should just delegate)
-     describe('getFontMimeType() [Deprecated]', () => {
-         it('should return correct font MIME type', () => {
-             expect(getFontMimeType('font.woff2')).toBe('font/woff2');
-             expect(getFontMimeType('font.ttf')).toBe('font/ttf');
-         });
+  // Test deprecated getFontMimeType (should just delegate)
+  describe('getFontMimeType() [Deprecated]', () => {
+    it('should return correct font MIME type', () => {
+      expect(getFontMimeType('font.woff2')).toBe('font/woff2');
+      expect(getFontMimeType('font.ttf')).toBe('font/ttf');
+    });
 
-         it('should delegate to guessMimeType and return default for non-fonts', () => {
-             expect(getFontMimeType('style.css')).toBe('text/css'); // Returns CSS mime
-             expect(getFontMimeType('unknown.ext')).toBe('application/octet-stream'); // Returns default
-         });
-     });
-});
+    it('should delegate to guessMimeType and return default for non-fonts', () => {
+      expect(getFontMimeType('style.css')).toBe('text/css'); // Returns CSS mime
+      expect(getFontMimeType('unknown.ext')).toBe('application/octet-stream'); // Returns default
+    });
+  });
+});

package/tests/unit/utils/slugify.test.ts

@@ -1,21 +1,23 @@
+/**
+ * @file tests/unit/utils/slugify.test.ts
+ * @description Unit tests for the slugify util.
+ */
+
 import { slugify } from '../../../src/utils/slugify'; // Adjust path if needed
 import { describe, it, expect } from '@jest/globals';
 
 describe('slugify()', () => {
-    it('should handle typical URLs', () => {
-        // --- Expectations matching the corrected slugify logic ---
-        expect(slugify('https://site.com/path/page.html')).toBe('path-page');
-        expect(slugify('products/item-1.html')).toBe('products-item-1');
-        expect(slugify(' search?q=test page 2 ')).toBe('search-q-test-page-2');
-        expect(slugify('/path/with/slashes/')).toBe('path-with-slashes');
-        // ----------------------------------------------------------
-        expect(slugify('')).toBe('index');
-    });
-
+  it('should handle typical URLs', () => {
+    // --- Expectations matching the corrected slugify logic ---
+    expect(slugify('https://site.com/path/page.html')).toBe('path-page');
+    expect(slugify('products/item-1.html')).toBe('products-item-1');
+    expect(slugify(' search?q=test page 2 ')).toBe('search-q-test-page-2');
+    expect(slugify('/path/with/slashes/')).toBe('path-with-slashes');
+    // ----------------------------------------------------------
+    expect(slugify('')).toBe('index');
+  });
 });
 
-
-
 // describe('🔧 sanitizeSlug()', () => {
 //   const tests: Array<[string, string]> = [
 //     // Basic pages

package/tsconfig.build.json

@@ -1,11 +1,10 @@
 {
-    "extends": "./tsconfig.json",  // Inherit from tsconfig.json
-    "compilerOptions": {
-      "noEmit": false,             // Ensure files are emitted
-      "declaration": true,         // Generate type declaration files
-      "emitDeclarationOnly": true, // Only generate .d.ts files
-      "outDir": "dist/types"       // Output directory for declaration files
-    },
-    "include": ["src/**/*"]         // Include all TypeScript files in src
-  }
-  
+  "extends": "./tsconfig.json", // Inherit from tsconfig.json
+  "compilerOptions": {
+    "noEmit": false, // Ensure files are emitted
+    "declaration": true, // Generate type declaration files
+    "emitDeclarationOnly": true, // Only generate .d.ts files
+    "outDir": "dist/types" // Output directory for declaration files
+  },
+  "include": ["src/**/*"] // Include all TypeScript files in src
+}

package/tsconfig.jest.json

@@ -6,6 +6,7 @@
     "isolatedModules": false, // Often better to set false when using CommonJS/ts-jest
     "esModuleInterop": true,
     "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
     "sourceMap": true,
     "noEmit": true,
     "target": "ES2022", // Keep target if your Node version supports it
@@ -14,4 +15,4 @@
   },
   "include": ["src/**/*", "tests/**/*"],
   "exclude": ["node_modules", "dist"]
-}
+}

package/tsconfig.json

@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
     "target": "ES2022",
-    "module": "ESNext",                   // ✅ ESM output
-    "moduleResolution": "Bundler",       // ✅ lets TS handle extensions properly
+    "module": "ESNext", // ✅ ESM output
+    "moduleResolution": "Bundler", // ✅ lets TS handle extensions properly
     "declaration": true,
     "sourceMap": true,
     "outDir": "./dist",

package/tsup.config.ts

@@ -24,19 +24,19 @@ export default defineConfig([
       'cli-entry': 'src/cli/cli-entry.ts',
     },
     outDir: 'dist/cli',
-    format: ['cjs'],                     // ✅ Required for CLI to work with npx
+    format: ['cjs'], // ✅ Required for CLI to work with npx
     platform: 'node',
     target: 'node18',
     splitting: false,
-    clean: true,                         // Wipe dist/cli clean on each build
-    dts: false,                          // No types for CLI
+    clean: true, // Wipe dist/cli clean on each build
+    dts: false, // No types for CLI
     sourcemap: true,
     banner: {
-      js: '#!/usr/bin/env node',         // ✅ Required for CLI shebang
+      js: '#!/usr/bin/env node', // ✅ Required for CLI shebang
     },
     outExtension() {
       return {
-        js: '.cjs',                      // ✅ Required: prevents ESM misinterpretation
+        js: '.cjs', // ✅ Required: prevents ESM misinterpretation
       };
     },
     esbuildOptions(options) {
@@ -54,12 +54,12 @@ export default defineConfig([
       index: 'src/index.ts',
     },
     outDir: 'dist',
-    format: ['esm'],                     // ✅ Modern ESM output for consumers
+    format: ['esm'], // ✅ Modern ESM output for consumers
     platform: 'node',
     target: 'node18',
     splitting: false,
-    clean: false,                        // Don't wipe CLI build!
-    dts: true,                           // ✅ Generate TypeScript declarations
+    clean: false, // Don't wipe CLI build!
+    dts: true, // ✅ Generate TypeScript declarations
     sourcemap: true,
     outExtension() {
       return {

package/typedoc.json

@@ -1,9 +1,5 @@
 {
-  "entryPoints": [
-    "src/index.ts", 
-    "src/types.ts", 
-    "src/cli/cli.ts"
-  ],
+  "entryPoints": ["src/index.ts", "src/types.ts", "src/cli/cli.ts"],
   "out": "docs/api",
   "plugin": ["typedoc-plugin-markdown"],
   "tsconfig": "tsconfig.json",
@@ -15,9 +11,9 @@
   "theme": "markdown",
   "entryPointStrategy": "expand",
   "exclude": [
-    "**/node_modules/**", 
-    "**/test/**", 
-    "**/tests/**", 
+    "**/node_modules/**",
+    "**/test/**",
+    "**/tests/**",
     "**/dist/**",
     "**/*.spec.ts",
     "**/*.test.ts"
@@ -25,4 +21,4 @@
   "sort": ["alphabetical"],
   "categorizeByGroup": true,
   "sourceLinkTemplate": "https://github.com/manicinc/portapack/blob/master/{path}#L{line}"
-}
+}

package/docs/demo.md

@@ -1,46 +0,0 @@
----
-# 🌐 Live Demo
-
-## What You’ll See
-
-- A fully portable HTML site
-- Every internal page inlined
-- No external requests
-
----
-
-## Example Output
-
-> Download this page and open it offline. It works!
-
-<!-- [Download Demo Portable HTML](./bootstrap-packed.html) -->
-
----
-
-## How It Was Generated
-
-```bash
-portapack -i https://getbootstrap.com --recursive --max-depth 1 -o bootstrap-packed.html
-```
-
----
-
-## Client-Side Navigation
-
-Recursively packed pages are wrapped in `<template>` blocks with an embedded router.
-
-```html
-<template id="page-home">
-  <h1>Homepage</h1>
-</template>
-<template id="page-about">
-  <h1>About</h1>
-</template>
-```
-
-```js
-window.addEventListener('hashchange', () => {
-  const id = location.hash.replace('#', '') || 'home';
-  showPage(id);
-});
-```