@articles-media/articles-dev-box 1.4.1 → 1.5.0

package/README.md

@@ -67,6 +67,7 @@ npm run dev
 | getSignOutRedirectUrl | Handles signout redirect api logic | Catching Game |
 | GlobalClientModals | Imports all global client modals like FriendsList, CreditsModal, SettingsModal, InfoModal, and so on | USA Tycoon |
 | generateRandomNickname | Reusable way of doing random nicknames from package | USA Tycoon |
+| getAssetSource | Gets an assets source location based on the NEXT_PUBLIC_MODEL_SOURCE env value, allows easier/cheaper open sourcing of games by serving public site assets as CDN and dev/cloned site assets locally | School Run |
 | defaultGameNextConfig | Not usable, for reference | None |
 | defaultGameThemeConfig | Not usable, for reference | None |
 | useModalNavigation | Handles navigating a modal with controller | None |

package/dist/InfoModal.js

@@ -5,7 +5,7 @@ import { Modal } from "react-bootstrap";
 //#region src/components/Games/InfoModal.jsx
 function InfoModal({ show, setShow, useStore, packageInfo, infoModalConfig }) {
 	const [showModal, setShowModal] = useState(true);
-	const darkMode = useStore((state) => state.darkMode);
+	useStore((state) => state.darkMode);
 	useRef([]);
 	return /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsxs(Modal, {
 		className: "articles-modal games-info-modal",
@@ -24,21 +24,32 @@ function InfoModal({ show, setShow, useStore, packageInfo, infoModalConfig }) {
 				closeButton: true,
 				children: /* @__PURE__ */ jsxs(Modal.Title, { children: [process.env.NEXT_PUBLIC_GAME_NAME, " Info"] })
 			}),
-			/* @__PURE__ */ jsxs(Modal.Body, {
+			/* @__PURE__ */ jsx(Modal.Body, {
 				className: "flex-column p-0",
-				children: [/* @__PURE__ */ jsx("div", {
+				children: infoModalConfig?.contentOverride ? /* @__PURE__ */ jsx(Fragment, { children: infoModalConfig?.contentOverride }) : /* @__PURE__ */ jsxs(Fragment, { children: [!infoModalConfig?.hidePreviewImage && /* @__PURE__ */ jsx("div", {
 					className: "ratio ratio-16x9",
-					children: darkMode ? /* @__PURE__ */ jsx("img", { src: infoModalConfig?.previewImage }) : /* @__PURE__ */ jsx("img", { src: infoModalConfig?.previewImage })
+					children: /* @__PURE__ */ jsx("img", {
+						src: infoModalConfig?.previewImage,
+						alt: "Game Preview",
+						style: { objectFit: infoModalConfig?.previewImageObjectFit || "cover" }
+					})
 				}), /* @__PURE__ */ jsxs("div", {
 					className: "p-3",
-					children: [/* @__PURE__ */ jsx("div", {
-						className: "",
-						children: packageInfo?.description
-					}), infoModalConfig?.appendContent && /* @__PURE__ */ jsx("div", {
-						className: "mt-2",
-						children: infoModalConfig.appendContent
-					})]
-				})]
+					children: [
+						infoModalConfig?.prependContent && /* @__PURE__ */ jsx("div", {
+							className: "mt-2",
+							children: infoModalConfig.prependContent
+						}),
+						/* @__PURE__ */ jsx("div", {
+							className: "",
+							children: packageInfo?.description
+						}),
+						infoModalConfig?.appendContent && /* @__PURE__ */ jsx("div", {
+							className: "mt-2",
+							children: infoModalConfig.appendContent
+						})
+					]
+				})] })
 			}),
 			/* @__PURE__ */ jsxs(Modal.Footer, {
 				className: "justify-content-between",

package/dist/PageTemplateLandingPage.js

@@ -119,16 +119,13 @@ function PageTemplateLandingPage({ useStore, useSocketStore, RotatingMascot, Lin
 						game: process.env.NEXT_PUBLIC_GAME_NAME,
 						style: "Default",
 						darkMode: darkMode ? true : false,
-						prepend: RotatingMascot && /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsx("div", {
-							style: {
-								width: "100%",
-								height: "200px",
-								display: "flex",
-								justifyContent: "center",
-								alignItems: "center"
-							},
-							children: /* @__PURE__ */ jsx(RotatingMascot, {})
-						}) }),
+						prepend: typeof RotatingMascot === "function" && RotatingMascot ? /* @__PURE__ */ jsx(Fragment, { children: /* @__PURE__ */ jsx("div", { style: {
+							width: "100%",
+							height: "200px",
+							display: "flex",
+							justifyContent: "center",
+							alignItems: "center"
+						} }) }) : /* @__PURE__ */ jsx(Fragment, { children: RotatingMascot }),
 						...gameScoreboardConfig
 					}),
 					!disableAd && /* @__PURE__ */ jsx(Ad, {

package/dist/{SettingsModal-Bu7vqrqw.js → SettingsModal-DOJp07_e.js}

@@ -246,7 +246,7 @@ function OtherTab({ useStore, config }) {
 var package_default = {
 	name: "@articles-media/articles-dev-box",
 	description: "Shared code, functions, and components for different Articles Media projects.",
-	version: "1.4.1",
+	version: "1.5.0",
 	type: "module",
 	sideEffects: false,
 	imports: { "#root/src/*": "./src/*" },
@@ -295,6 +295,8 @@ var package_default = {
 		"./defaultGameThemeConfig": "./dist/defaultGameThemeConfig.js",
 		"./getSignOutRedirectUrl": "./dist/getSignOutRedirectUrl.js",
 		"./generateRandomNickname": "./dist/generateRandomNickname.js",
+		"./getAssetSource": "./dist/getAssetSource.js",
+		"./useAssetSource": "./dist/useAssetSource.js",
 		"./dist/style.css": "./dist/articles-dev-box.css",
 		"./dist/articles-dev-box.css": "./dist/articles-dev-box.css"
 	},
@@ -331,6 +333,8 @@ var package_default = {
 function DebugTab({ useStore, config }) {
 	const showStats = useStore((state) => state?.debugConfig?.showStats);
 	const setDebugConfigKey = useStore((state) => state?.setDebugConfigKey);
+	const modelSource = useStore((state) => state?.modelSource);
+	const setModelSource = useStore((state) => state?.setModelSource);
 	return /* @__PURE__ */ jsxs(Fragment, { children: [
 		/* @__PURE__ */ jsxs("div", {
 			className: "mb-3",
@@ -349,6 +353,25 @@ function DebugTab({ useStore, config }) {
 				}, i))
 			})]
 		}),
+		process.env.NODE_ENV === "development" && /* @__PURE__ */ jsxs("div", {
+			className: "mb-3",
+			children: [/* @__PURE__ */ jsx("div", { children: "Override Model Source" }), /* @__PURE__ */ jsxs("div", {
+				className: "",
+				children: [/* @__PURE__ */ jsx(ArticlesButton, {
+					active: modelSource === "CDN",
+					onClick: () => {
+						setModelSource("CDN");
+					},
+					children: "CDN"
+				}), /* @__PURE__ */ jsx(ArticlesButton, {
+					active: modelSource === "Local",
+					onClick: () => {
+						setModelSource("Local");
+					},
+					children: "Local"
+				})]
+			})]
+		}),
 		config?.tabs?.Debug?.children && /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsx("hr", {}), config?.tabs?.Debug?.children] })
 	] });
 }

package/dist/SettingsModal.js

@@ -1,2 +1,2 @@
-import { t as SettingsModal } from "./SettingsModal-Bu7vqrqw.js";
+import { t as SettingsModal } from "./SettingsModal-DOJp07_e.js";
 export { SettingsModal as default };

package/dist/getAssetSource.js

@@ -0,0 +1,19 @@
+//#region src/util/getAssetSource.js
+/**
+* Returns the appropriate model source URL based on the environment configuration.
+* 
+* @param {string} path - The local path to the model.
+* @returns {string} The full URL to the model.
+*/
+function getAssetSource(path, overrideSource = null) {
+	const source = overrideSource || process.env.NEXT_PUBLIC_MODEL_SOURCE;
+	switch (source) {
+		case "CDN": return `${process.env.NEXT_PUBLIC_CDN}games/${process.env.NEXT_PUBLIC_GAME_NAME}/public/${path}`;
+		case "Local": return `${path}`;
+		default:
+			console.warn(`Unknown model source: ${source} - defaulting to local model.`);
+			return `${path}`;
+	}
+}
+//#endregion
+export { getAssetSource as default };

package/dist/index.js

@@ -16,7 +16,7 @@ import { t as GameScoreboard } from "./GameScoreboard-BvE_sIDW.js";
 import PageTemplateLandingPage from "./PageTemplateLandingPage.js";
 import GlobalHead from "./GlobalHead.js";
 import GlobalBody_default from "./GlobalBody.js";
-import { t as SettingsModal } from "./SettingsModal-Bu7vqrqw.js";
+import { t as SettingsModal } from "./SettingsModal-DOJp07_e.js";
 import CreditsModal from "./CreditsModal.js";
 import InfoModal from "./InfoModal.js";
 import DarkModeHandler from "./DarkModeHandler.js";
@@ -32,4 +32,6 @@ import defaultGameNextConfig from "./defaultGameNextConfig.js";
 import getTheme from "./defaultGameThemeConfig.js";
 import getSignOutRedirectUrl from "./getSignOutRedirectUrl.js";
 import generateRandomNickname from "./generateRandomNickname.js";
-export { Ad_default as Ad, ArticlesAd, CreditsModal, DarkModeHandler, FriendsList, GameMenu, PrimaryButtonGroup as GameMenuPrimaryButtonGroup, GameScoreboard, GlobalBody_default as GlobalBody, GlobalHead, HasNoMouseHandler, InfoModal, InviteModal, NicknameInput, PageTemplateLandingPage, ReturnToLauncherButton, ReusedSocketLogicHandler, SessionButton, SettingsModal, SignInButton, SocketServerUrlHandler, ToontownModeHandler, ViewUserModal, defaultGameNextConfig, getTheme as defaultGameThemeConfig, generateRandomNickname, getSignOutRedirectUrl, typicalZustandStoreExcludes, typicalZustandStoreStateSlice, useFullscreen, useUserDetails, useUserFriends, useUserToken, zustandSocketStoreSlice };
+import getAssetSource from "./getAssetSource.js";
+import useAssetSource from "./useAssetSource.js";
+export { Ad_default as Ad, ArticlesAd, CreditsModal, DarkModeHandler, FriendsList, GameMenu, PrimaryButtonGroup as GameMenuPrimaryButtonGroup, GameScoreboard, GlobalBody_default as GlobalBody, GlobalHead, HasNoMouseHandler, InfoModal, InviteModal, NicknameInput, PageTemplateLandingPage, ReturnToLauncherButton, ReusedSocketLogicHandler, SessionButton, SettingsModal, SignInButton, SocketServerUrlHandler, ToontownModeHandler, ViewUserModal, defaultGameNextConfig, getTheme as defaultGameThemeConfig, generateRandomNickname, getAssetSource, getSignOutRedirectUrl, typicalZustandStoreExcludes, typicalZustandStoreStateSlice, useAssetSource, useFullscreen, useUserDetails, useUserFriends, useUserToken, zustandSocketStoreSlice };

package/dist/useAssetSource.js

@@ -0,0 +1,13 @@
+//#region src/hooks/useAssetSource.js
+function useAssetSource(path, useStore) {
+	const source = useStore((state) => state.modelSource);
+	switch (source) {
+		case "CDN": return `${process.env.NEXT_PUBLIC_CDN}games/${process.env.NEXT_PUBLIC_GAME_NAME}/public/${path}`;
+		case "Local": return `${path}`;
+		default:
+			console.warn(`Unknown model source: ${source} - defaulting to local model.`);
+			return `${path}`;
+	}
+}
+//#endregion
+export { useAssetSource as default };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@articles-media/articles-dev-box",
   "description": "Shared code, functions, and components for different Articles Media projects.",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "type": "module",
   "sideEffects": false,
   "imports": {
@@ -54,6 +54,8 @@
     "./defaultGameThemeConfig": "./dist/defaultGameThemeConfig.js",
     "./getSignOutRedirectUrl": "./dist/getSignOutRedirectUrl.js",
     "./generateRandomNickname": "./dist/generateRandomNickname.js",
+    "./getAssetSource": "./dist/getAssetSource.js",
+    "./useAssetSource": "./dist/useAssetSource.js",
     "./dist/style.css": "./dist/articles-dev-box.css",
     "./dist/articles-dev-box.css": "./dist/articles-dev-box.css"
   },