WIP

Author: ianpaschal

convex/_generated/api.d.ts

@@ -82,8 +82,10 @@ import type * as _model_leagues_types from "../_model/leagues/types.js";
 import type * as _model_lists__helpers_checkListSubmittedOnTime from "../_model/lists/_helpers/checkListSubmittedOnTime.js";
 import type * as _model_lists__helpers_checkListVisibility from "../_model/lists/_helpers/checkListVisibility.js";
 import type * as _model_lists__helpers_deepenList from "../_model/lists/_helpers/deepenList.js";
+import type * as _model_lists__helpers_getAvailableActions from "../_model/lists/_helpers/getAvailableActions.js";
 import type * as _model_lists_index from "../_model/lists/index.js";
 import type * as _model_lists_mutations_createList from "../_model/lists/mutations/createList.js";
+import type * as _model_lists_mutations_deleteList from "../_model/lists/mutations/deleteList.js";
 import type * as _model_lists_mutations_toggleListApproval from "../_model/lists/mutations/toggleListApproval.js";
 import type * as _model_lists_mutations_updateList from "../_model/lists/mutations/updateList.js";
 import type * as _model_lists_queries_getList from "../_model/lists/queries/getList.js";
@@ -127,6 +129,7 @@ import type * as _model_photos_index from "../_model/photos/index.js";
 import type * as _model_photos_mutations_createPhoto from "../_model/photos/mutations/createPhoto.js";
 import type * as _model_photos_queries_getPhoto from "../_model/photos/queries/getPhoto.js";
 import type * as _model_photos_table from "../_model/photos/table.js";
+import type * as _model_tournamentCompetitors__helpers_checkUserIsTeamCaptain from "../_model/tournamentCompetitors/_helpers/checkUserIsTeamCaptain.js";
 import type * as _model_tournamentCompetitors__helpers_checkUsersAreTeammates from "../_model/tournamentCompetitors/_helpers/checkUsersAreTeammates.js";
 import type * as _model_tournamentCompetitors__helpers_deepenTournamentCompetitor from "../_model/tournamentCompetitors/_helpers/deepenTournamentCompetitor.js";
 import type * as _model_tournamentCompetitors__helpers_getAvailableActions from "../_model/tournamentCompetitors/_helpers/getAvailableActions.js";
@@ -402,8 +405,10 @@ declare const fullApi: ApiFromModules<{
   "_model/lists/_helpers/checkListSubmittedOnTime": typeof _model_lists__helpers_checkListSubmittedOnTime;
   "_model/lists/_helpers/checkListVisibility": typeof _model_lists__helpers_checkListVisibility;
   "_model/lists/_helpers/deepenList": typeof _model_lists__helpers_deepenList;
+  "_model/lists/_helpers/getAvailableActions": typeof _model_lists__helpers_getAvailableActions;
   "_model/lists/index": typeof _model_lists_index;
   "_model/lists/mutations/createList": typeof _model_lists_mutations_createList;
+  "_model/lists/mutations/deleteList": typeof _model_lists_mutations_deleteList;
   "_model/lists/mutations/toggleListApproval": typeof _model_lists_mutations_toggleListApproval;
   "_model/lists/mutations/updateList": typeof _model_lists_mutations_updateList;
   "_model/lists/queries/getList": typeof _model_lists_queries_getList;
@@ -447,6 +452,7 @@ declare const fullApi: ApiFromModules<{
   "_model/photos/mutations/createPhoto": typeof _model_photos_mutations_createPhoto;
   "_model/photos/queries/getPhoto": typeof _model_photos_queries_getPhoto;
   "_model/photos/table": typeof _model_photos_table;
+  "_model/tournamentCompetitors/_helpers/checkUserIsTeamCaptain": typeof _model_tournamentCompetitors__helpers_checkUserIsTeamCaptain;
   "_model/tournamentCompetitors/_helpers/checkUsersAreTeammates": typeof _model_tournamentCompetitors__helpers_checkUsersAreTeammates;
   "_model/tournamentCompetitors/_helpers/deepenTournamentCompetitor": typeof _model_tournamentCompetitors__helpers_deepenTournamentCompetitor;
   "_model/tournamentCompetitors/_helpers/getAvailableActions": typeof _model_tournamentCompetitors__helpers_getAvailableActions;

convex/_model/lists/_helpers/deepenList.ts

@@ -1,6 +1,7 @@
 import { Doc } from '../../../_generated/dataModel';
 import { QueryCtx } from '../../../_generated/server';
 import { checkListSubmittedOnTime } from './checkListSubmittedOnTime';
+import { getAvailableActions } from './getAvailableActions';
 
 /* eslint-disable @typescript-eslint/explicit-function-return-type */
 /**
@@ -18,6 +19,8 @@ export const deepenList = async (
   doc: Doc<'lists'>,
 ) => ({
   ...doc,
+  displayName: '', // Future: Set displayName based on extracted list data
+  availableActions: await getAvailableActions(ctx, doc),
   onTime: await checkListSubmittedOnTime(ctx, doc),
 });
 // FUTURE: Deepen list based on game system

convex/_model/lists/_helpers/getAvailableActions.ts

@@ -0,0 +1,59 @@
+import { getAuthUserId } from '@convex-dev/auth/server';
+
+import { Doc } from '../../../_generated/dataModel';
+import { QueryCtx } from '../../../_generated/server';
+import { getDocStrict } from '../../common/_helpers/getDocStrict';
+import { checkUserIsTeamCaptain } from '../../tournamentCompetitors';
+import { checkUserIsTournamentOrganizer } from '../../tournamentOrganizers';
+
+export enum ListActionKey {
+  /** Delete this list. */
+  Delete = 'delete',
+  /** Download this list's file. */
+  Download = 'download',
+  /** Edit this list. */
+  Manage = 'manage',
+}
+
+/**
+ * Gets a list of list actions which are available to the current user.
+ *
+ * @param ctx - Convex query context
+ * @param doc - Raw list document
+ * @returns An array of ListActionKey(s)
+ */
+export const getAvailableActions = async (
+  ctx: QueryCtx,
+  doc: Doc<'lists'>,
+): Promise<ListActionKey[]> => {
+  const userId = await getAuthUserId(ctx);
+
+  const isSelf = userId && doc.userId === userId;
+
+  let isArchived = false;
+  let isOrganizer = false;
+  let isCaptain = false;
+
+  if (doc.tournamentRegistrationId) {
+    const registration = await getDocStrict(ctx, doc.tournamentRegistrationId);
+    const tournament = await getDocStrict(ctx, registration.tournamentId);
+
+    isOrganizer = await checkUserIsTournamentOrganizer(ctx, registration.tournamentId, userId);
+    isCaptain = await checkUserIsTeamCaptain(ctx, registration.tournamentCompetitorId, userId);
+    isArchived = tournament.status === 'archived';
+  }
+
+  // ---- PRIMARY ACTIONS ----
+  const actions: ListActionKey[] = [ListActionKey.Download];
+
+  if (isArchived) {
+    return actions;
+  }
+
+  if (isOrganizer || ((isSelf || isCaptain) && !doc.locked)) {
+    actions.push(ListActionKey.Delete);
+    actions.push(ListActionKey.Manage);
+  }
+
+  return actions;
+};

convex/_model/lists/index.ts

@@ -5,12 +5,19 @@ export type ListId = Id<'lists'>;
 export {
   type DeepList,
 } from './_helpers/deepenList';
+export {
+  ListActionKey,
+} from './_helpers/getAvailableActions';
 
 // Mutations
 export {
   createList,
   createListArgs,
 } from './mutations/createList';
+export {
+  deleteList,
+  deleteListArgs,
+} from './mutations/deleteList';
 export {
   toggleListApproval,
   toggleListApprovalArgs,

convex/_model/lists/mutations/deleteList.ts

@@ -0,0 +1,14 @@
+import { Infer, v } from 'convex/values';
+
+import { MutationCtx } from '../../../_generated/server';
+
+export const deleteListArgs = v.object({
+  id: v.id('lists'),
+});
+
+export const deleteList = async (
+  ctx: MutationCtx,
+  args: Infer<typeof deleteListArgs>,
+): Promise<void> => {
+  await ctx.db.delete(args.id);
+};

convex/_model/tournamentCompetitors/_helpers/checkUserIsTeamCaptain.ts

@@ -0,0 +1,19 @@
+import { Id } from '../../../_generated/dataModel';
+import { QueryCtx } from '../../../_generated/server';
+import { getDocStrict } from '../../common/_helpers/getDocStrict';
+
+export const checkUserIsTeamCaptain = async (
+  ctx: QueryCtx,
+  tournamentCompetitorId: Id<'tournamentCompetitors'>,
+  userId: Id<'users'> | null,
+): Promise<boolean> => {
+  if (!userId) {
+    return false;
+  }
+  const { tournamentId, captainUserId } = await getDocStrict(ctx, tournamentCompetitorId);
+  const { competitorSize } = await getDocStrict(ctx, tournamentId);
+  if (competitorSize <= 1) {
+    return false;
+  }
+  return captainUserId === userId;
+};

convex/_model/tournamentCompetitors/index.ts

@@ -7,6 +7,9 @@ export type TournamentCompetitorId = Id<'tournamentCompetitors'>;
 export type ScoreAdjustment = Infer<typeof scoreAdjustment>;
 
 // Helpers
+export {
+  checkUserIsTeamCaptain,
+} from './_helpers/checkUserIsTeamCaptain';
 export {
   deepenTournamentCompetitor,
   type DeepTournamentCompetitor,

convex/_model/tournamentRegistrations/_helpers/getAvailableActions.ts

@@ -13,9 +13,12 @@ export enum TournamentRegistrationActionKey {
   /** Delete this TournamentRegistration (and TournamentCompetitor if no remaining players). */
   Delete = 'delete',
 
+  /** Create a new list for this TournamentRegistration. */
+  CreateList = 'createList',
+
   // TODO
   // ApproveList = 'approveList',
-  
+
   // TODO
   // RejectList = 'rejectList',
 
@@ -75,6 +78,10 @@ export const getAvailableActions = async (
     actions.push(TournamentRegistrationActionKey.Edit);
   }
 
+  if (isOrganizer || isCaptain || isSelf) {
+    actions.push(TournamentRegistrationActionKey.CreateList);
+  }
+
   // if (isOrganizer) {
   //   actions.push(TournamentRegistrationActionKey.ApproveList);
   // }

convex/lists.ts

@@ -6,6 +6,11 @@ export const createList = mutation({
   handler: model.createList,
 });
 
+export const deleteList = mutation({
+  args: model.deleteListArgs,
+  handler: model.deleteList,
+});
+
 export const updateList = mutation({
   args: model.updateListArgs,
   handler: model.updateList,