Merge pull request #451 from scottbenton/feat/campaign-types

Feat/campaign types

CHANGELOG.MD

@@ -8,12 +8,15 @@
 - Added asset clock and counter controls working for assets that use them (ex: Snub Fighter Ability #3, or Marked Ability #2).
 - Added scene challenges to Crew Link
 - Added a new Hinterlands theme
+- Added types to campaigns
 
 ### Changes
 
 - Re-added missing roll buttons for assets in the move dialog
 - Made tensions clocks available in Iron Fellowship
 - You can now enter other species into the NPC species box. They will use the default Ironlander name oracles (Ironsworn)
+- Guides can now view their player's bond progress (Starforged)
+- Bond progress is now only visible when you have a connection with a character (Starforged)
 
 ### Bug Fixes
 

firestore.rules

@@ -37,7 +37,7 @@ service cloud.firestore {
     	allow read: if true;
       allow create: if request.auth.uid != null;
       allow write: if request.auth.uid in resource.data.ownerIds;
-      allow update: if request.resource.data.diff(resource.data).affectedKeys().hasOnly(["ownerIds"])     
+      allow update: if request.resource.data.diff(resource.data).affectedKeys().hasOnly(["ownerIds", "campaignGuides", "campaignGuideCampaignIdMap"])     
 
       function checkIsOwner() {
       	let world = get(/databases/$(database)/documents/worlds/$(worldId)).data;

src/Router.tsx

@@ -7,10 +7,15 @@ import {
   RouterProvider,
   createBrowserRouter,
   createRoutesFromElements,
+  redirect,
 } from "react-router-dom";
 import { ErrorRoute } from "components/shared/ErrorRoute";
 import { CHARACTER_ROUTES, characterPaths } from "pages/Character/routes";
-import { CAMPAIGN_ROUTES, campaignPaths } from "pages/Campaign/routes";
+import {
+  CAMPAIGN_ROUTES,
+  campaignPaths,
+  constructCampaignSheetPath,
+} from "pages/Campaign/routes";
 import { WORLD_ROUTES, worldPaths } from "pages/World/routes";
 import { HeadProvider } from "providers/HeadProvider";
 import { useListenToCharacters } from "stores/character/useListenToCharacters";
@@ -21,6 +26,7 @@ import { useListenToOracleSettings } from "stores/settings/useListenToOracleSett
 import { useListenToAccessibilitySettings } from "stores/accessibilitySettings/useListenToAccessibilitySettings";
 import { useListenToHomebrew } from "stores/homebrew/useListenToHomebrew";
 import { HOMEBREW_ROUTES, homebrewPaths } from "pages/Homebrew/routes";
+import { useSyncCampaignWorldPermissions } from "stores/campaign/useSyncCampaignWorldPermissions";
 
 const router = createBrowserRouter(
   createRoutesFromElements(
@@ -65,11 +71,16 @@ const router = createBrowserRouter(
             />
             <Route
               path={campaignPaths[CAMPAIGN_ROUTES.SHEET]}
-              lazy={() => import("pages/Campaign/CampaignSheetPage")}
+              lazy={() => import("pages/Campaign/CampaignPage")}
             />
             <Route
               path={campaignPaths[CAMPAIGN_ROUTES.GM_SCREEN]}
-              lazy={() => import("pages/Campaign/CampaignGMScreenPage")}
+              loader={({ params }) => {
+                const campaignId = params.campaignId ?? "";
+                return redirect(
+                  constructCampaignSheetPath(campaignId, CAMPAIGN_ROUTES.SHEET)
+                );
+              }}
             />
             <Route
               path={campaignPaths[CAMPAIGN_ROUTES.JOIN]}
@@ -133,5 +144,7 @@ export function Router() {
   useListenToOracleSettings();
   useListenToHomebrew();
 
+  useSyncCampaignWorldPermissions();
+
   return <RouterProvider router={router} />;
 }

src/api-calls/campaign/_campaign.type.ts

@@ -1,5 +1,11 @@
 import { LegacyTrack } from "types/LegacyTrack.type";
 
+export enum CampaignType {
+  Solo = "solo",
+  Coop = "co-op",
+  Guided = "guided",
+}
+
 export interface CampaignDocument {
   name: string;
   users: string[];
@@ -10,4 +16,5 @@ export interface CampaignDocument {
   customTracks?: Record<string, number>;
   conditionMeters?: Record<string, number>;
   specialTracks?: Record<string, LegacyTrack>;
+  type?: CampaignType; // Todo - perhaps run a migration to set this so that we can remove the optional
 }

src/api-calls/campaign/createCampaign.ts

@@ -1,18 +1,23 @@
 import { addDoc } from "firebase/firestore";
-import { CampaignDocument } from "../../api-calls/campaign/_campaign.type";
+import {
+  CampaignDocument,
+  CampaignType,
+} from "../../api-calls/campaign/_campaign.type";
 import { getCampaignCollection } from "./_getRef";
 import { createApiFunction } from "api-calls/createApiFunction";
 
 export const createCampaign = createApiFunction<
-  { uid: string; campaignName: string },
+  { uid: string; campaignName: string; campaignType: CampaignType },
   string
 >((params) => {
-  const { uid, campaignName } = params;
+  const { uid, campaignName, campaignType } = params;
   return new Promise((resolve, reject) => {
     const storedCampaign: CampaignDocument = {
       name: campaignName,
       users: [uid],
+      gmIds: campaignType === CampaignType.Coop ? [uid] : [],
       characters: [],
+      type: campaignType,
     };
 
     addDoc(getCampaignCollection(), storedCampaign)

src/api-calls/world/_getRef.ts

@@ -6,8 +6,7 @@ import {
   doc,
   DocumentReference,
 } from "firebase/firestore";
-import { World } from "types/World.type";
-import { WorldDocument } from "./_world.type";
+import { WorldDocument, World } from "./_world.type";
 
 export function constructWorldsPath() {
   return `/worlds`;
@@ -46,11 +45,16 @@ export function encodeWorld(world: World): WorldDocument {
 }
 
 export function decodeWorld(encodedWorld: WorldDocument): World {
-  const { worldDescription, ...remainingWorld } = encodedWorld;
+  const { worldDescription, ownerIds, campaignGuides, ...remainingWorld } =
+    encodedWorld;
+
+  const newOwnerIds = [...ownerIds, ...(campaignGuides ?? [])];
 
   const world: World = {
     ...remainingWorld,
+    ownerIds: newOwnerIds,
     worldDescription: worldDescription?.toUint8Array(),
+    campaignGuides,
   };
 
   return world;

src/api-calls/world/_world.type.ts

@@ -1,6 +1,27 @@
 import { Bytes } from "firebase/firestore";
-import { World } from "types/World.type";
 
-export type WorldDocument = Omit<World, "worldDescription"> & {
+export interface WorldDocument {
+  name: string;
   worldDescription?: Bytes;
-};
+  newTruths?: Record<string, Truth>;
+  ownerIds: string[];
+  campaignGuides?: string[];
+}
+
+export interface World {
+  name: string;
+  newTruths?: Record<string, Truth>;
+  ownerIds: string[];
+  worldDescription?: Uint8Array;
+  campaignGuides?: string[];
+}
+
+export interface Truth {
+  selectedTruthOptionIndex?: number;
+  selectedSubItemIndex?: number | null;
+
+  customTruth?: {
+    description: string;
+    questStarter: string;
+  };
+}

src/api-calls/world/createWorld.ts

@@ -1,5 +1,5 @@
 import { addDoc } from "firebase/firestore";
-import { World } from "types/World.type";
+import { World } from "api-calls/world/_world.type";
 import { encodeWorld, getWorldCollection } from "./_getRef";
 import { createApiFunction } from "api-calls/createApiFunction";
 

src/api-calls/world/listenToUsersWorlds.ts

@@ -1,6 +1,6 @@
-import { World } from "types/World.type";
+import { World } from "api-calls/world/_world.type";
 import { decodeWorld, getWorldCollection } from "./_getRef";
-import { onSnapshot, query, where } from "firebase/firestore";
+import { onSnapshot, or, query, where } from "firebase/firestore";
 
 export function listenToUsersWorlds(
   uid: string,
@@ -12,8 +12,12 @@ export function listenToUsersWorlds(
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   onError: (error: any) => void
 ) {
+  const filter = or(
+    where("ownerIds", "array-contains", uid ?? ""),
+    where("campaignGuides", "array-contains", uid ?? "")
+  );
   return onSnapshot(
-    query(getWorldCollection(), where("ownerIds", "array-contains", uid ?? "")),
+    query(getWorldCollection(), filter),
     (snapshot) => {
       snapshot.docChanges().forEach((change) => {
         if (change.type === "removed") {

src/api-calls/world/listenToWorld.ts

@@ -1,5 +1,5 @@
 import { onSnapshot } from "firebase/firestore";
-import { World } from "types/World.type";
+import { World } from "api-calls/world/_world.type";
 import { decodeWorld, getWorldDoc } from "./_getRef";
 
 export function listenToWorld(

src/api-calls/world/updateWorld.ts

@@ -1,7 +1,7 @@
 import { updateDoc } from "firebase/firestore";
 import { getWorldDoc } from "./_getRef";
 import { createApiFunction } from "api-calls/createApiFunction";
-import { World } from "types/World.type";
+import { World } from "api-calls/world/_world.type";
 
 export const updateWorld = createApiFunction<
   { worldId: string; partialWorld: Partial<World> },

src/api-calls/world/updateWorldGuide.ts

@@ -0,0 +1,28 @@
+import { arrayRemove, arrayUnion, updateDoc } from "firebase/firestore";
+import { getWorldDoc } from "./_getRef";
+import { createApiFunction } from "api-calls/createApiFunction";
+
+export const updateWorldGuide = createApiFunction<
+  {
+    worldId: string;
+    guideId: string;
+    shouldRemove?: boolean;
+  },
+  void
+>((params) => {
+  const { worldId, guideId, shouldRemove } = params;
+
+  return new Promise((resolve, reject) => {
+    updateDoc(getWorldDoc(worldId), {
+      campaignGuides: !shouldRemove
+        ? arrayUnion(guideId)
+        : arrayRemove(guideId),
+    })
+      .then(() => {
+        resolve();
+      })
+      .catch((e) => {
+        reject(e);
+      });
+  });
+}, "Failed to update world guides.");

src/api-calls/world/updateWorldTruth.ts

@@ -1,7 +1,7 @@
 import { updateDoc } from "firebase/firestore";
 import { getWorldDoc } from "./_getRef";
 import { createApiFunction } from "api-calls/createApiFunction";
-import { Truth } from "types/World.type";
+import { Truth } from "api-calls/world/_world.type";
 
 export const updateWorldTruth = createApiFunction<
   { worldId: string; truthKey: string; truth: Truth },