@articles-media/articles-dev-box 1.3.1 → 1.3.3

package/README.md

@@ -5,7 +5,7 @@
 Shared code, functions, and components that are commonly used across Articles Media projects. 
 
 # Warning
-None of this is meant to work outside the Articles Media frontend React ecosystem. Breaking changes are being made in between patch releases until 1.1.0, when we switch to major release for breaking.
+A lot of this package is expected to be consumed in a Articles Media related React ecosystem. See Package Exports section for more details.
 
 ## Getting Started
 
@@ -63,6 +63,7 @@ npm run dev
 | useFullscreen | Hook for going fullscreen on the body or provided element | |
 | typicalZustandStoreExcludes | Array of strings that every game published by Articles Media would want to normally exclude from persisting in base game store. | Catching Game and School Run |
 | typicalZustandStoreStateSlice | Slice of zustand states that every game normally uses | Catching Game and School Run |
+| zustandSocketStoreSlice  | Slice of zustand states that every game normally uses for sockets | School Run
 | 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 |

package/dist/GlobalBody.js

@@ -8,8 +8,8 @@ var import_classnames = /* @__PURE__ */ __toESM(require_classnames(), 1);
 var StatusModal = lazy(() => import("./StatusModal-DkHAimHp.js"));
 function GlobalBody({ fontawesome = true }) {
 	const [statusModal, setStatusModal] = useState(false);
-	const { data: mainSiteStatus, error: mainSiteStatusError, isLoading: mainSiteStatusLoading, mutate: mainSiteStatusMutate } = useMainSiteStatus({ disable: process.env.NODE_ENV !== "development" });
-	const { data: authSiteStatus, error: authSiteStatusError, isLoading: authSiteStatusLoading, mutate: authSiteStatusMutate } = useAuthSiteStatus({ disable: process.env.NODE_ENV !== "development" });
+	const { data: mainSiteStatus, error: mainSiteStatusError, isLoading: mainSiteStatusLoading, mutate: mainSiteStatusMutate } = useMainSiteStatus({ disable: process.env.NODE_ENV !== "development" || process.env.NEXT_PUBLIC_ENABLE_ARTICLES === "false" });
+	const { data: authSiteStatus, error: authSiteStatusError, isLoading: authSiteStatusLoading, mutate: authSiteStatusMutate } = useAuthSiteStatus({ disable: process.env.NODE_ENV !== "development" || process.env.NEXT_PUBLIC_ENABLE_ARTICLES === "false" });
 	return /* @__PURE__ */ jsxs(Fragment, { children: [fontawesome && /* @__PURE__ */ jsx("link", {
 		rel: "stylesheet",
 		href: `https://cdn.articles.media/fonts/fontawesome/css/all.min.css`

package/dist/InfoModal.js

@@ -29,12 +29,15 @@ function InfoModal({ show, setShow, useStore, packageInfo, infoModalConfig }) {
 				children: [/* @__PURE__ */ jsx("div", {
 					className: "ratio ratio-16x9",
 					children: darkMode ? /* @__PURE__ */ jsx("img", { src: infoModalConfig?.previewImage }) : /* @__PURE__ */ jsx("img", { src: infoModalConfig?.previewImage })
-				}), /* @__PURE__ */ jsx("div", {
+				}), /* @__PURE__ */ jsxs("div", {
 					className: "p-3",
-					children: /* @__PURE__ */ jsx("div", {
+					children: [/* @__PURE__ */ jsx("div", {
 						className: "",
 						children: packageInfo?.description
-					})
+					}), infoModalConfig?.appendContent && /* @__PURE__ */ jsx("div", {
+						className: "mt-2",
+						children: infoModalConfig.appendContent
+					})]
 				})]
 			}),
 			/* @__PURE__ */ jsxs(Modal.Footer, {

package/dist/PageTemplateLandingPage.js

@@ -11,7 +11,7 @@ var SessionButton = lazy(() => import("./SessionButton.js"));
 var ReturnToLauncherButton = lazy(() => import("./ReturnToLauncherButton.js"));
 var GameScoreboard = lazy(() => import("./GameScoreboard.js"));
 var Ad = lazy(() => import("./Ad.js"));
-function PageTemplateLandingPage({ useStore, useSocketStore, RotatingMascot, Link, logoImage, backgroundImage, CardBodyOverride, singlePlayerConfig, multiplayerConfig, brandingTextClass, disableHero, disableAd, disableGameScoreboard, maxInnerWidth = "20rem", AdditionalContent = null, PostCardContent = null, PostExtrasContent = null, PreHeroContent = null, PostHeroContent = null, NicknameInputConfig = null, CardOverride = null, LandingBackgroundAnimation = null }) {
+function PageTemplateLandingPage({ useStore, useSocketStore, RotatingMascot, Link, logoImage, backgroundImage, CardBodyOverride, singlePlayerConfig, multiplayerConfig, brandingTextClass, disableHero, heroOverride, disableAd, disableGameScoreboard, gameScoreboardConfig, maxInnerWidth = "20rem", AdditionalContent = null, PostCardContent = null, PostExtrasContent = null, PreHeroContent = null, PostHeroContent = null, NicknameInputConfig = null, CardOverride = null, LandingBackgroundAnimation = null }) {
 	const { data: userToken, error: userTokenError, isLoading: userTokenLoading, mutate: userTokenMutate } = useUserToken(process.env.NEXT_PUBLIC_GAME_PORT);
 	const { data: userDetails, error: userDetailsError, isLoading: userDetailsLoading, mutate: userDetailsMutate } = useUserDetails({ token: userToken });
 	const darkMode = useStore((state) => state.darkMode);
@@ -42,7 +42,7 @@ function PageTemplateLandingPage({ useStore, useSocketStore, RotatingMascot, Lin
 						style: { "width": maxInnerWidth },
 						children: [
 							PreHeroContent && PreHeroContent,
-							!disableHero && /* @__PURE__ */ jsxs("div", {
+							heroOverride ? heroOverride : !disableHero && /* @__PURE__ */ jsxs("div", {
 								className: "landing-hero text-center mb-2",
 								children: [/* @__PURE__ */ jsx("img", {
 									src: logoImage,
@@ -157,7 +157,7 @@ function PageTemplateLandingPage({ useStore, useSocketStore, RotatingMascot, Lin
 								]
 							}),
 							PostCardContent && PostCardContent,
-							/* @__PURE__ */ jsxs("div", {
+							process.env.NEXT_PUBLIC_ENABLE_ARTICLES !== "false" && /* @__PURE__ */ jsxs("div", {
 								className: "extras",
 								children: [/* @__PURE__ */ jsx(SessionButton, {
 									port: process.env.NEXT_PUBLIC_GAME_PORT,
@@ -180,7 +180,8 @@ function PageTemplateLandingPage({ useStore, useSocketStore, RotatingMascot, Lin
 								alignItems: "center"
 							},
 							children: /* @__PURE__ */ jsx(RotatingMascot, {})
-						}) })
+						}) }),
+						...gameScoreboardConfig
 					}),
 					!disableAd && /* @__PURE__ */ jsx(Ad, {
 						style: "Default",

package/dist/{SettingsModal-BguWq4Q_.js → SettingsModal-Bud-D-3m.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.3.1",
+	version: "1.3.3",
 	type: "module",
 	sideEffects: false,
 	imports: { "#root/src/*": "./src/*" },
@@ -289,6 +289,8 @@ var package_default = {
 		"./useFullscreen": "./dist/useFullscreen.js",
 		"./typicalZustandStoreExcludes": "./dist/typicalZustandStoreExcludes.js",
 		"./typicalZustandStoreStateSlice": "./dist/typicalZustandStoreStateSlice.js",
+		"./zustandSocketStoreSlice": "./dist/zustandSocketStoreSlice.js",
+		"./useSocketStoreSlice": "./dist/useSocketStoreSlice.js",
 		"./defaultGameNextConfig": "./dist/defaultGameNextConfig.js",
 		"./defaultGameThemeConfig": "./dist/defaultGameThemeConfig.js",
 		"./getSignOutRedirectUrl": "./dist/getSignOutRedirectUrl.js",

package/dist/SettingsModal.js

@@ -1,2 +1,2 @@
-import { t as SettingsModal } from "./SettingsModal-BguWq4Q_.js";
+import { t as SettingsModal } from "./SettingsModal-Bud-D-3m.js";
 export { SettingsModal 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-BguWq4Q_.js";
+import { t as SettingsModal } from "./SettingsModal-Bud-D-3m.js";
 import CreditsModal from "./CreditsModal.js";
 import InfoModal from "./InfoModal.js";
 import DarkModeHandler from "./DarkModeHandler.js";
@@ -27,8 +27,9 @@ import InviteModal from "./InviteModal.js";
 import ReusedSocketLogicHandler from "./ReusedSocketLogicHandler.js";
 import typicalZustandStoreExcludes from "./typicalZustandStoreExcludes.js";
 import typicalZustandStoreStateSlice from "./typicalZustandStoreStateSlice.js";
+import zustandSocketStoreSlice from "./zustandSocketStoreSlice.js";
 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 };
+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 };

package/dist/typicalZustandStoreStateSlice.js

@@ -101,7 +101,9 @@ var typicalZustandStoreStateSlice = (set, get, generateRandomNickname) => ({
 	hasNoMouse: null,
 	setHasNoMouse: (value) => set({ hasNoMouse: value }),
 	isTouchCapable: null,
-	setIsTouchCapable: (value) => set({ isTouchCapable: value })
+	setIsTouchCapable: (value) => set({ isTouchCapable: value }),
+	modelSource: process.env.NEXT_PUBLIC_MODEL_SOURCE || "Local",
+	setModelSource: (value) => set({ modelSource: value })
 });
 //#endregion
 export { typicalZustandStoreStateSlice as default };

package/dist/useUserToken.js

@@ -5,7 +5,7 @@ var fetcher = (url) => fetch(url).then((res) => {
 	return res.json();
 });
 var useUserToken = (port) => {
-	const { data, error, isLoading, mutate } = useSWR(process.env.NODE_ENV === "development" ? `http://localhost:${port}/api/token` : "/api/token", fetcher, {
+	const { data, error, isLoading, mutate } = useSWR(process.env.NEXT_PUBLIC_ENABLE_ARTICLES !== "false" ? process.env.NODE_ENV === "development" ? `http://localhost:${port}/api/token` : "/api/token" : false, fetcher, {
 		revalidateOnFocus: false,
 		revalidateOnReconnect: false,
 		shouldRetryOnError: false,

package/dist/zustandSocketStoreSlice.js

@@ -0,0 +1,51 @@
+//#region src/constants/zustandSocketStoreSlice.js
+var game_name_key = process.env.NEXT_PUBLIC_GAME_KEY;
+function zustandSocketStoreSlice(set, get, io) {
+	return {
+		socket: io({ autoConnect: false }),
+		serverUrl: process.env.NEXT_PUBLIC_NODE_SERVER,
+		connectSocket: (url) => {
+			const newSocket = io(url || process.env.NEXT_PUBLIC_NODE_SERVER, {
+				transports: ["websocket"],
+				autoConnect: false,
+				reconnection: true,
+				reconnectionDelay: 5e3,
+				reconnectionDelayMax: 1e4,
+				query: { client: process.env.NEXT_PUBLIC_GAME_KEY }
+			});
+			newSocket.connect();
+			set({ socket: newSocket });
+		},
+		setServerUrl: (url) => set({ serverUrl: url }),
+		disconnectSocket: () => set((state) => {
+			state.socket?.disconnect();
+			return {};
+		}),
+		startGame: (gameId, status) => {
+			set((state) => {
+				state.socket.emit(`game:${game_name_key}:start`, {
+					game_id: gameId,
+					status
+				});
+				return {};
+			});
+		},
+		totalUsers: 0,
+		setTotalUsers: (total) => set({ totalUsers: total }),
+		connected: false,
+		setConnected: (total) => set({ connected: total }),
+		authenticated: false,
+		setAuthenticated: (value) => set({ authenticated: value }),
+		loginSocket: (data) => {
+			set((state) => {
+				state.socket.emit("login-socket", {
+					...data,
+					game_name: process.env.NEXT_PUBLIC_GAME_NAME
+				});
+				return {};
+			});
+		}
+	};
+}
+//#endregion
+export { zustandSocketStoreSlice 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.3.1",
+  "version": "1.3.3",
   "type": "module",
   "sideEffects": false,
   "imports": {
@@ -48,6 +48,8 @@
     "./useFullscreen": "./dist/useFullscreen.js",
     "./typicalZustandStoreExcludes": "./dist/typicalZustandStoreExcludes.js",
     "./typicalZustandStoreStateSlice": "./dist/typicalZustandStoreStateSlice.js",
+    "./zustandSocketStoreSlice": "./dist/zustandSocketStoreSlice.js",
+    "./useSocketStoreSlice": "./dist/useSocketStoreSlice.js",
     "./defaultGameNextConfig": "./dist/defaultGameNextConfig.js",
     "./defaultGameThemeConfig": "./dist/defaultGameThemeConfig.js",
     "./getSignOutRedirectUrl": "./dist/getSignOutRedirectUrl.js",