@theholocron/react-template 0.5.3 → 0.5.4

package/README.md

@@ -6,6 +6,8 @@ A modern React template with pre-configured tools, best practices, and CI/CD set
 
 <!-- /holocron:description -->
 
+<!-- holocron:template-only -->
+
 ## Getting Started
 
 Use the [Holocron CLI](https://github.com/theholocron/holocron) to scaffold a new React project. It clones the template, renames all placeholder references, wires up your vault provider, and runs `holocron setup` in one step:
@@ -25,8 +27,12 @@ This will:
 3. Run `pnpm install` (including Playwright browser download)
 4. Run `holocron setup` to configure branch protection, labels, workflows, and repo settings
 
+<!-- /holocron:template-only -->
+
 ## Development
 
+<!-- holocron:development -->
+
 This repo uses [pnpm workspaces](https://pnpm.io/workspaces).
 
 ```bash
@@ -39,6 +45,8 @@ pnpm typecheck     # tsc --noEmit
 pnpm lint          # lint via super-linter (Docker)
 ```
 
+<!-- /holocron:development -->
+
 ## What's Included
 
 | Tool                                                    | Purpose                                       |
@@ -57,4 +65,8 @@ pnpm lint          # lint via super-linter (Docker)
 
 ## Releases
 
+<!-- holocron:releases -->
+
 Releases are automated via [semantic-release](https://semantic-release.gitbook.io) on push to `main`. See [CHANGELOG.md](CHANGELOG.md) for the release history.
+
+<!-- /holocron:releases -->

package/dist/mockServiceWorker.js

@@ -7,111 +7,114 @@
  * - Please do NOT modify this file.
  */
 
-const PACKAGE_VERSION = "2.15.0";
-const INTEGRITY_CHECKSUM = "03cb67ac84128e63d7cd722a6e5b7f1e";
-const IS_MOCKED_RESPONSE = Symbol("isMockedResponse");
-const activeClientIds = new Set();
-
-addEventListener("install", function () {
-	self.skipWaiting();
-});
-
-addEventListener("activate", function (event) {
-	event.waitUntil(self.clients.claim());
-});
-
-addEventListener("message", async function (event) {
-	const clientId = Reflect.get(event.source || {}, "id");
-
-	if (!clientId || !self.clients) {
-		return;
-	}
-
-	const client = await self.clients.get(clientId);
-
-	if (!client) {
-		return;
-	}
-
-	const allClients = await self.clients.matchAll({
-		type: "window",
-	});
-
-	switch (event.data) {
-		case "KEEPALIVE_REQUEST": {
-			sendToClient(client, {
-				type: "KEEPALIVE_RESPONSE",
-			});
-			break;
-		}
-
-		case "INTEGRITY_CHECK_REQUEST": {
-			sendToClient(client, {
-				type: "INTEGRITY_CHECK_RESPONSE",
-				payload: {
-					packageVersion: PACKAGE_VERSION,
-					checksum: INTEGRITY_CHECKSUM,
-				},
-			});
-			break;
-		}
-
-		case "MOCK_ACTIVATE": {
-			activeClientIds.add(clientId);
-
-			sendToClient(client, {
-				type: "MOCKING_ENABLED",
-				payload: {
-					client: {
-						id: client.id,
-						frameType: client.frameType,
-					},
-				},
-			});
-			break;
-		}
-
-		case "CLIENT_CLOSED": {
-			activeClientIds.delete(clientId);
-
-			const remainingClients = allClients.filter((client) => {
-				return client.id !== clientId;
-			});
-
-			// Unregister itself when there are no more clients
-			if (remainingClients.length === 0) {
-				self.registration.unregister();
-			}
-
-			break;
-		}
-	}
-});
-
-addEventListener("fetch", function (event) {
-	const requestInterceptedAt = Date.now();
-
-	// Bypass navigation requests.
-	if (event.request.mode === "navigate") {
-		return;
-	}
-
-	// Opening the DevTools triggers the "only-if-cached" request
-	// that cannot be handled by the worker. Bypass such requests.
-	if (event.request.cache === "only-if-cached" && event.request.mode !== "same-origin") {
-		return;
-	}
-
-	// Bypass all requests when there are no active clients.
-	// Prevents the self-unregistered worked from handling requests
-	// after it's been terminated (still remains active until the next reload).
-	if (activeClientIds.size === 0) {
-		return;
-	}
-
-	const requestId = crypto.randomUUID();
-	event.respondWith(handleRequest(event, requestId, requestInterceptedAt));
-});
+const PACKAGE_VERSION = '2.15.0'
+const INTEGRITY_CHECKSUM = '03cb67ac84128e63d7cd722a6e5b7f1e'
+const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
+const activeClientIds = new Set()
+
+addEventListener('install', function () {
+  self.skipWaiting()
+})
+
+addEventListener('activate', function (event) {
+  event.waitUntil(self.clients.claim())
+})
+
+addEventListener('message', async function (event) {
+  const clientId = Reflect.get(event.source || {}, 'id')
+
+  if (!clientId || !self.clients) {
+    return
+  }
+
+  const client = await self.clients.get(clientId)
+
+  if (!client) {
+    return
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  switch (event.data) {
+    case 'KEEPALIVE_REQUEST': {
+      sendToClient(client, {
+        type: 'KEEPALIVE_RESPONSE',
+      })
+      break
+    }
+
+    case 'INTEGRITY_CHECK_REQUEST': {
+      sendToClient(client, {
+        type: 'INTEGRITY_CHECK_RESPONSE',
+        payload: {
+          packageVersion: PACKAGE_VERSION,
+          checksum: INTEGRITY_CHECKSUM,
+        },
+      })
+      break
+    }
+
+    case 'MOCK_ACTIVATE': {
+      activeClientIds.add(clientId)
+
+      sendToClient(client, {
+        type: 'MOCKING_ENABLED',
+        payload: {
+          client: {
+            id: client.id,
+            frameType: client.frameType,
+          },
+        },
+      })
+      break
+    }
+
+    case 'CLIENT_CLOSED': {
+      activeClientIds.delete(clientId)
+
+      const remainingClients = allClients.filter((client) => {
+        return client.id !== clientId
+      })
+
+      // Unregister itself when there are no more clients
+      if (remainingClients.length === 0) {
+        self.registration.unregister()
+      }
+
+      break
+    }
+  }
+})
+
+addEventListener('fetch', function (event) {
+  const requestInterceptedAt = Date.now()
+
+  // Bypass navigation requests.
+  if (event.request.mode === 'navigate') {
+    return
+  }
+
+  // Opening the DevTools triggers the "only-if-cached" request
+  // that cannot be handled by the worker. Bypass such requests.
+  if (
+    event.request.cache === 'only-if-cached' &&
+    event.request.mode !== 'same-origin'
+  ) {
+    return
+  }
+
+  // Bypass all requests when there are no active clients.
+  // Prevents the self-unregistered worked from handling requests
+  // after it's been terminated (still remains active until the next reload).
+  if (activeClientIds.size === 0) {
+    return
+  }
+
+  const requestId = crypto.randomUUID()
+  event.respondWith(handleRequest(event, requestId, requestInterceptedAt))
+})
 
 /**
  * @param {FetchEvent} event
@@ -119,53 +122,60 @@ addEventListener("fetch", function (event) {
  * @param {number} requestInterceptedAt
  */
 async function handleRequest(event, requestId, requestInterceptedAt) {
-	const client = await resolveMainClient(event);
-	const requestCloneForEvents = event.request.clone();
-	const response = await getResponse(event, client, requestId, requestInterceptedAt);
-
-	// Send back the response clone for the "response:*" life-cycle events.
-	// Ensure MSW is active and ready to handle the message, otherwise
-	// this message will pend indefinitely.
-	if (client && activeClientIds.has(client.id)) {
-		const serializedRequest = await serializeRequest(requestCloneForEvents);
-
-		// Omit the body of server-sent event stream responses.
-		// Cloning such responses would prevent client-side stream cancelations
-		// from reaching the original stream (a teed stream only cancels its
-		// source once both of its branches cancel) and would buffer the
-		// entire stream into the unconsumed clone indefinitely.
-		const isEventStreamResponse = response.headers
-			.get("content-type")
-			?.toLowerCase()
-			.startsWith("text/event-stream");
-
-		// Clone the response so both the client and the library could consume it.
-		const responseClone = isEventStreamResponse ? null : response.clone();
-
-		sendToClient(
-			client,
-			{
-				type: "RESPONSE",
-				payload: {
-					isMockedResponse: IS_MOCKED_RESPONSE in response,
-					request: {
-						id: requestId,
-						...serializedRequest,
-					},
-					response: {
-						type: response.type,
-						status: response.status,
-						statusText: response.statusText,
-						headers: Object.fromEntries(response.headers.entries()),
-						body: responseClone ? responseClone.body : null,
-					},
-				},
-			},
-			responseClone && responseClone.body ? [serializedRequest.body, responseClone.body] : []
-		);
-	}
-
-	return response;
+  const client = await resolveMainClient(event)
+  const requestCloneForEvents = event.request.clone()
+  const response = await getResponse(
+    event,
+    client,
+    requestId,
+    requestInterceptedAt,
+  )
+
+  // Send back the response clone for the "response:*" life-cycle events.
+  // Ensure MSW is active and ready to handle the message, otherwise
+  // this message will pend indefinitely.
+  if (client && activeClientIds.has(client.id)) {
+    const serializedRequest = await serializeRequest(requestCloneForEvents)
+
+    // Omit the body of server-sent event stream responses.
+    // Cloning such responses would prevent client-side stream cancelations
+    // from reaching the original stream (a teed stream only cancels its
+    // source once both of its branches cancel) and would buffer the
+    // entire stream into the unconsumed clone indefinitely.
+    const isEventStreamResponse = response.headers
+      .get('content-type')
+      ?.toLowerCase()
+      .startsWith('text/event-stream')
+
+    // Clone the response so both the client and the library could consume it.
+    const responseClone = isEventStreamResponse ? null : response.clone()
+
+    sendToClient(
+      client,
+      {
+        type: 'RESPONSE',
+        payload: {
+          isMockedResponse: IS_MOCKED_RESPONSE in response,
+          request: {
+            id: requestId,
+            ...serializedRequest,
+          },
+          response: {
+            type: response.type,
+            status: response.status,
+            statusText: response.statusText,
+            headers: Object.fromEntries(response.headers.entries()),
+            body: responseClone ? responseClone.body : null,
+          },
+        },
+      },
+      responseClone && responseClone.body
+        ? [serializedRequest.body, responseClone.body]
+        : [],
+    )
+  }
+
+  return response
 }
 
 /**
@@ -177,30 +187,30 @@ async function handleRequest(event, requestId, requestInterceptedAt) {
  * @returns {Promise<Client | undefined>}
  */
 async function resolveMainClient(event) {
-	const client = await self.clients.get(event.clientId);
-
-	if (activeClientIds.has(event.clientId)) {
-		return client;
-	}
-
-	if (client?.frameType === "top-level") {
-		return client;
-	}
-
-	const allClients = await self.clients.matchAll({
-		type: "window",
-	});
-
-	return allClients
-		.filter((client) => {
-			// Get only those clients that are currently visible.
-			return client.visibilityState === "visible";
-		})
-		.find((client) => {
-			// Find the client ID that's recorded in the
-			// set of clients that have registered the worker.
-			return activeClientIds.has(client.id);
-		});
+  const client = await self.clients.get(event.clientId)
+
+  if (activeClientIds.has(event.clientId)) {
+    return client
+  }
+
+  if (client?.frameType === 'top-level') {
+    return client
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  return allClients
+    .filter((client) => {
+      // Get only those clients that are currently visible.
+      return client.visibilityState === 'visible'
+    })
+    .find((client) => {
+      // Find the client ID that's recorded in the
+      // set of clients that have registered the worker.
+      return activeClientIds.has(client.id)
+    })
 }
 
 /**
@@ -211,72 +221,74 @@ async function resolveMainClient(event) {
  * @returns {Promise<Response>}
  */
 async function getResponse(event, client, requestId, requestInterceptedAt) {
-	// Clone the request because it might've been already used
-	// (i.e. its body has been read and sent to the client).
-	const requestClone = event.request.clone();
-
-	function passthrough() {
-		// Cast the request headers to a new Headers instance
-		// so the headers can be manipulated with.
-		const headers = new Headers(requestClone.headers);
-
-		// Remove the "accept" header value that marked this request as passthrough.
-		// This prevents request alteration and also keeps it compliant with the
-		// user-defined CORS policies.
-		const acceptHeader = headers.get("accept");
-		if (acceptHeader) {
-			const values = acceptHeader.split(",").map((value) => value.trim());
-			const filteredValues = values.filter((value) => value !== "msw/passthrough");
-
-			if (filteredValues.length > 0) {
-				headers.set("accept", filteredValues.join(", "));
-			} else {
-				headers.delete("accept");
-			}
-		}
-
-		return fetch(requestClone, { headers });
-	}
-
-	// Bypass mocking when the client is not active.
-	if (!client) {
-		return passthrough();
-	}
-
-	// Bypass initial page load requests (i.e. static assets).
-	// The absence of the immediate/parent client in the map of the active clients
-	// means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
-	// and is not ready to handle requests.
-	if (!activeClientIds.has(client.id)) {
-		return passthrough();
-	}
-
-	// Notify the client that a request has been intercepted.
-	const serializedRequest = await serializeRequest(event.request);
-	const clientMessage = await sendToClient(
-		client,
-		{
-			type: "REQUEST",
-			payload: {
-				id: requestId,
-				interceptedAt: requestInterceptedAt,
-				...serializedRequest,
-			},
-		},
-		[serializedRequest.body]
-	);
-
-	switch (clientMessage.type) {
-		case "MOCK_RESPONSE": {
-			return respondWithMock(clientMessage.data);
-		}
-
-		case "PASSTHROUGH": {
-			return passthrough();
-		}
-	}
-
-	return passthrough();
+  // Clone the request because it might've been already used
+  // (i.e. its body has been read and sent to the client).
+  const requestClone = event.request.clone()
+
+  function passthrough() {
+    // Cast the request headers to a new Headers instance
+    // so the headers can be manipulated with.
+    const headers = new Headers(requestClone.headers)
+
+    // Remove the "accept" header value that marked this request as passthrough.
+    // This prevents request alteration and also keeps it compliant with the
+    // user-defined CORS policies.
+    const acceptHeader = headers.get('accept')
+    if (acceptHeader) {
+      const values = acceptHeader.split(',').map((value) => value.trim())
+      const filteredValues = values.filter(
+        (value) => value !== 'msw/passthrough',
+      )
+
+      if (filteredValues.length > 0) {
+        headers.set('accept', filteredValues.join(', '))
+      } else {
+        headers.delete('accept')
+      }
+    }
+
+    return fetch(requestClone, { headers })
+  }
+
+  // Bypass mocking when the client is not active.
+  if (!client) {
+    return passthrough()
+  }
+
+  // Bypass initial page load requests (i.e. static assets).
+  // The absence of the immediate/parent client in the map of the active clients
+  // means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
+  // and is not ready to handle requests.
+  if (!activeClientIds.has(client.id)) {
+    return passthrough()
+  }
+
+  // Notify the client that a request has been intercepted.
+  const serializedRequest = await serializeRequest(event.request)
+  const clientMessage = await sendToClient(
+    client,
+    {
+      type: 'REQUEST',
+      payload: {
+        id: requestId,
+        interceptedAt: requestInterceptedAt,
+        ...serializedRequest,
+      },
+    },
+    [serializedRequest.body],
+  )
+
+  switch (clientMessage.type) {
+    case 'MOCK_RESPONSE': {
+      return respondWithMock(clientMessage.data)
+    }
+
+    case 'PASSTHROUGH': {
+      return passthrough()
+    }
+  }
+
+  return passthrough()
 }
 
 /**
@@ -286,19 +298,22 @@ async function getResponse(event, client, requestId, requestInterceptedAt) {
  * @returns {Promise<any>}
  */
 function sendToClient(client, message, transferrables = []) {
-	return new Promise((resolve, reject) => {
-		const channel = new MessageChannel();
-
-		channel.port1.onmessage = (event) => {
-			if (event.data && event.data.error) {
-				return reject(event.data.error);
-			}
-
-			resolve(event.data);
-		};
-
-		client.postMessage(message, [channel.port2, ...transferrables.filter(Boolean)]);
-	});
+  return new Promise((resolve, reject) => {
+    const channel = new MessageChannel()
+
+    channel.port1.onmessage = (event) => {
+      if (event.data && event.data.error) {
+        return reject(event.data.error)
+      }
+
+      resolve(event.data)
+    }
+
+    client.postMessage(message, [
+      channel.port2,
+      ...transferrables.filter(Boolean),
+    ])
+  })
 }
 
 /**
@@ -306,41 +321,41 @@ function sendToClient(client, message, transferrables = []) {
  * @returns {Response}
  */
 function respondWithMock(response) {
-	// Setting response status code to 0 is a no-op.
-	// However, when responding with a "Response.error()", the produced Response
-	// instance will have status code set to 0. Since it's not possible to create
-	// a Response instance with status code 0, handle that use-case separately.
-	if (response.status === 0) {
-		return Response.error();
-	}
-
-	const mockedResponse = new Response(response.body, response);
-
-	Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, {
-		value: true,
-		enumerable: true,
-	});
-
-	return mockedResponse;
+  // Setting response status code to 0 is a no-op.
+  // However, when responding with a "Response.error()", the produced Response
+  // instance will have status code set to 0. Since it's not possible to create
+  // a Response instance with status code 0, handle that use-case separately.
+  if (response.status === 0) {
+    return Response.error()
+  }
+
+  const mockedResponse = new Response(response.body, response)
+
+  Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, {
+    value: true,
+    enumerable: true,
+  })
+
+  return mockedResponse
 }
 
 /**
  * @param {Request} request
  */
 async function serializeRequest(request) {
-	return {
-		url: request.url,
-		mode: request.mode,
-		method: request.method,
-		headers: Object.fromEntries(request.headers.entries()),
-		cache: request.cache,
-		credentials: request.credentials,
-		destination: request.destination,
-		integrity: request.integrity,
-		redirect: request.redirect,
-		referrer: request.referrer,
-		referrerPolicy: request.referrerPolicy,
-		body: await request.arrayBuffer(),
-		keepalive: request.keepalive,
-	};
+  return {
+    url: request.url,
+    mode: request.mode,
+    method: request.method,
+    headers: Object.fromEntries(request.headers.entries()),
+    cache: request.cache,
+    credentials: request.credentials,
+    destination: request.destination,
+    integrity: request.integrity,
+    redirect: request.redirect,
+    referrer: request.referrer,
+    referrerPolicy: request.referrerPolicy,
+    body: await request.arrayBuffer(),
+    keepalive: request.keepalive,
+  }
 }

package/package.json

@@ -1,27 +1,29 @@
 {
   "name": "@theholocron/react-template",
-  "version": "0.5.3",
+  "version": "0.5.4",
   "description": "A modern React template with pre-configured tools, best practices, and CI/CD setup for rapid project development.",
+  "keywords": [
+    "react",
+    "template",
+    "theholocron"
+  ],
   "homepage": "https://docs.theholocron.dev/react-template/",
   "bugs": "https://github.com/theholocron/react-template/issues",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/theholocron/react-template.git"
-  },
+  "repository": "theholocron/react-template",
   "license": "GPL-3.0",
   "author": "Newton Koumantzelis",
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/react-template.es.js",
-      "require": "./dist/react-template.cjs.js"
+      "require": "./dist/react-template.cjs.js",
+      "default": "./dist/react-template.cjs.js"
     },
     "./style": "./dist/style.css"
   },
-  "main": "dist/react-template.cjs.js",
-  "module": "dist/react-template.es.js",
-  "types": "dist/index.d.ts",
-  "style": "dist/style.css",
+  "style": "./dist/style.css",
   "files": [
     "dist/*"
   ],
@@ -73,7 +75,7 @@
     "@theholocron/cli": "^3.29.2",
     "@theholocron/commitlint-config": "^7.19.1",
     "@theholocron/docs-theme": "^1.3.5",
-    "@theholocron/eslint-config": "^7.19.1",
+    "@theholocron/eslint-config": "^7.23.2",
     "@theholocron/holocron-config": "^7.19.1",
     "@theholocron/holocron-plugin-github": "^3.29.2",
     "@theholocron/lighthouse-config": "^7.19.1",
@@ -143,7 +145,7 @@
     ],
     "overrides": {
       "@commitlint/config-conventional>conventional-changelog-conventionalcommits": "7",
-      "conventional-changelog-conventionalcommits": "10.2.1"
+      "conventional-changelog-conventionalcommits": "9.3.1"
     }
   },
   "msw": {