packaton 0.0.8 → 0.0.9

package/README.md

@@ -12,7 +12,7 @@ computes their corresponding CSP nonce and injects it as well.
 
 
 ## Images and Videos (immutable naming)
-For long-term caching, [media-remaper.js](src/plugins-prod/media-remaper.js) appends a SHA-1 hash
+For long-term caching, [media-remaper.js](src/plugins-prod/media-remaper.js) appends an SHA-1 hash
 to the filenames and takes care of rewriting their `src` in HTML (**only in HTML**).
 
 If you want to use media files in CSS, create a similar function to
@@ -45,6 +45,6 @@ To avoid minifying, you can pass `a=>a`
 - can't write inline scripts or css (all must be in an external file, packaton inlines them)
 - must have an index
 - Ignored Documents start with `_`, so you can't have routes that begin with _
-- Non-Documents and Files outside /static are not automatically copied over,
+- Non-Documents and Files outside config.assetsDir are not automatically copied over,
   you need to specify them. 
-- static/media only files at the top level get hashed-named. But files within subdirs are not (by design).
+- assets/media only files at the top level get hashed-named. But files within subdirs are not (by design).

package/index.d.ts

@@ -1,7 +1,7 @@
 export interface Config {
 	mode?: 'development' | 'production';
 	srcPath?: string
-	staticDir?: string
+	assetsDir?: string
 	ignore?: RegExp
 	
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "packaton",
-	"version": "0.0.8",
+	"version": "0.0.9",
 	"type": "module",
 	"author": "Eric Fortis",
 	"license": "MIT",

package/src/app-prod.js

@@ -19,11 +19,11 @@ import { netiflyAndCloudflareHeadersPlugin } from './plugins-prod/netiflyAndClou
  */
 export async function buildStaticPages(config) {
 	return new Promise((resolve, reject) => {
-		const MEDIA_REL_URL = join(config.staticDir, 'media')
+		const MEDIA_REL_URL = join(config.assetsDir, 'media')
 
 		const pSource = config.srcPath
 		const pDist = config.outputDir
-		const pDistStatic = join(config.outputDir, config.staticDir)
+		const pDistAssets = join(config.outputDir, config.assetsDir)
 		const pDistMedia = join(pDist, MEDIA_REL_URL)
 
 		const server = createServer(router(config))
@@ -32,7 +32,7 @@ export async function buildStaticPages(config) {
 			docs.init(config.srcPath, config.ignore)
 			try {
 				removeDir(pDist)
-				cpSync(join(pSource, config.staticDir), pDistStatic, {
+				cpSync(join(pSource, config.assetsDir), pDistAssets, {
 					recursive: true,
 					dereference: true,
 					filter(src) {

package/src/config.js

@@ -17,7 +17,7 @@ import { minifyHTML } from './plugins-prod/minifyHTML.js'
 const schema = {
 	mode: ['development', val => ['development', 'production'].includes(val)],
 	srcPath: [resolve('src'), isDirectory],
-	staticDir: ['static', optional(String)],
+	assetsDir: ['assets', optional(String)],
 	ignore: [/^_/, optional(RegExp)],
 
 	// Development

package/src/plugins-prod/netiflyAndCloudflareHeadersPlugin.js

@@ -2,8 +2,13 @@ import { join } from 'node:path'
 import { write } from '../utils/fs-utils.js'
 
 
-export function netiflyAndCloudflareHeadersPlugin(config, cspByRoute, MEDIA_URL) {
-	const out = join(join(config.outputDir, config.staticDir), '_headers')
+/**
+ * @param {Config} config
+ * @param {string} cspByRoute
+ * @param {string} relMediaURL
+ */
+export function netiflyAndCloudflareHeadersPlugin(config, cspByRoute, relMediaURL) {
+	const out = join(join(config.outputDir, config.assetsDir), '_headers')
 
 	const cspHeaders = cspByRoute.map(([route, csp]) => {
 		const r = route === '/index'
@@ -15,7 +20,7 @@ export function netiflyAndCloudflareHeadersPlugin(config, cspByRoute, MEDIA_URL)
 			`  Cache-Control: public,max-age=60`
 		].join('\n')
 	})
-	cspHeaders.push(`${MEDIA_URL}/*`)
+	cspHeaders.push(`/${relMediaURL}/*`)
 	cspHeaders.push('  Cache-Control: public,max-age=31536000,immutable')
 
 	write(out, cspHeaders.join('\n'))

package/src/router.js

@@ -4,7 +4,7 @@ import { readFile } from 'node:fs/promises'
 import { docs } from './app.js'
 import { mimeFor } from './utils/mimes.js'
 import { devClientWatcher } from './plugins-dev/WatcherDevClient.js'
-import { sendError, sendJSON, servePartialContent, serveStaticAsset } from './utils/http-response.js'
+import { sendError, sendJSON, servePartialContent, serveAsset } from './utils/http-response.js'
 
 
 const WATCHER_DEV = '/plugins-dev/watcherDev.js'
@@ -26,7 +26,7 @@ export function router({ srcPath, ignore, mode }) {
 				longPollDevHotReload(req, response)
 				
 			else if (url === WATCHER_DEV)
-				serveStaticAsset(response, join(import.meta.dirname, url))
+				serveAsset(response, join(import.meta.dirname, url))
 				
 			else if (docs.hasRoute(url))
 				await serveDocument(response, docs.fileFor(url), isDev)
@@ -38,7 +38,7 @@ export function router({ srcPath, ignore, mode }) {
 				await servePartialContent(response, req.headers, join(srcPath, url))
 				
 			else
-				serveStaticAsset(response, join(srcPath, url))
+				serveAsset(response, join(srcPath, url))
 		}
 		catch (error) {
 			sendError(response, error)

package/src/utils/http-response.js

@@ -15,7 +15,7 @@ export function sendJSON(response, payload) {
 	response.end(JSON.stringify(payload))
 }
 
-export function serveStaticAsset(response, file) {
+export function serveAsset(response, file) {
 	response.setHeader('Content-Type', mimeFor(file))
 	const reader = fs.createReadStream(file)
 	reader.on('open', function () { this.pipe(response) })