@crimson-education/sdk 0.3.0 → 0.3.1

package/dist/core/tasks.d.ts

@@ -1,5 +1,5 @@
 import type { CrimsonClient } from "./client";
-import type { Task, PaginationParams, PaginatedResult, ActionItemResource, AddResourceInput, UploadUrlResponse, DownloadUrlResponse, UpdateTaskResourceInput, User } from "./types";
+import type { Task, PaginationParams, PaginatedResult, ActionItemResource, AddResourceInput, UploadUrlResponse, DownloadUrlResponse, UpdateTaskResourceInput, User, ActionItemActivityBrief } from "./types";
 export type TaskOrderBy = "priority" | "dueDate" | "missionTitle" | "createdAt" | "description";
 export interface TaskFilters extends PaginationParams {
     status?: string[];
@@ -143,4 +143,8 @@ export declare class TasksApi {
         url: string;
         key: string;
     }>;
+    /**
+     * Get activities (e.g. strict due date history) for tasks
+     */
+    getActivities(actionItemIds: string[], type?: string): Promise<Record<string, ActionItemActivityBrief[]>>;
 }

package/dist/core/tasks.js

@@ -322,5 +322,14 @@ class TasksApi {
             return { url, key };
         });
     }
+    /**
+     * Get activities (e.g. strict due date history) for tasks
+     */
+    getActivities(actionItemIds, type = "duedate") {
+        return this.client.fetch("/roadmap/action-items/activities", {
+            method: "POST",
+            body: JSON.stringify({ actionItemIds, type }),
+        });
+    }
 }
 exports.TasksApi = TasksApi;

package/dist/core/types.d.ts

@@ -79,7 +79,8 @@ export interface Task {
     roadmapMissionId: string;
     userId: string;
     creatorId?: string;
-    roadmapId?: string;
+    /** null roadmapId is used to clear roadmapId when update */
+    roadmapId?: string | null;
     isComplete?: boolean;
     dueDate?: string | null;
     missionId?: string | null;
@@ -521,3 +522,7 @@ export interface StudentProfile {
     profileImageId?: string;
     [key: string]: unknown;
 }
+export interface ActionItemActivityBrief {
+    data: any;
+    createdAt: string;
+}

package/dist/react/hooks/index.d.ts

@@ -1,8 +1,9 @@
 export { useAuthState } from "./useAuthState";
+export { useQueryClient } from "@tanstack/react-query";
 export { useOAuth, useOAuthCallback } from "./useOAuth";
 export type { UseOAuthResult } from "./useOAuth";
 export { useMissions, useMissionsInfinite, useCreateMission, useUpdateMission, useDeleteMission, missionKeys, } from "./useMissions";
-export { useTasks, useAllUserTasks, useTasksByRoadmapId, useTasksInfinite, useCreateTask, useUpdateTask, useDeleteTask, useBulkDeleteTasks, useBulkUpdateTasks, taskKeys, useGetDownloadUrl, useTaskCreators, } from "./useTasks";
+export { useTasks, useAllUserTasks, useTasksByRoadmapId, useTasksInfinite, useCreateTask, useUpdateTask, useDeleteTask, useBulkDeleteTasks, useBulkUpdateTasks, taskKeys, useGetDownloadUrl, useTaskCreators, useTaskActivities, } from "./useTasks";
 export { useUsers, useUser, userKeys } from "./useUsers";
 export { useCurrentUserRoles, useMyStudents, accountKeys } from "./useAccount";
 export { useRoadmapContext } from "./useRoadmapContext";

package/dist/react/hooks/index.js

@@ -14,9 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.indigoKeys = exports.useTutorStudents = exports.useStudentTutors = exports.useIndigoMe = exports.studentProfileKeys = exports.useStudentPrefilledInfo = exports.useStudentProfile = exports.useDeleteTemplateMission = exports.useCreateTemplateMission = exports.missionLibraryKeys = exports.useCreateFromPredefinedTasks = exports.useAssignBulkTask = exports.useAssignBulkMission = exports.useCopyTemplateMission = exports.useUpdateTemplateMission = exports.useTemplateMissionDetail = exports.useTemplateTasksInfinite = exports.useTemplateTasks = exports.useTemplateMissionsInfinite = exports.useTemplateMissions = exports.useRoadmapContext = exports.accountKeys = exports.useMyStudents = exports.useCurrentUserRoles = exports.userKeys = exports.useUser = exports.useUsers = exports.useTaskCreators = exports.useGetDownloadUrl = exports.taskKeys = exports.useBulkUpdateTasks = exports.useBulkDeleteTasks = exports.useDeleteTask = exports.useUpdateTask = exports.useCreateTask = exports.useTasksInfinite = exports.useTasksByRoadmapId = exports.useAllUserTasks = exports.useTasks = exports.missionKeys = exports.useDeleteMission = exports.useUpdateMission = exports.useCreateMission = exports.useMissionsInfinite = exports.useMissions = exports.useOAuthCallback = exports.useOAuth = exports.useAuthState = void 0;
+exports.indigoKeys = exports.useTutorStudents = exports.useStudentTutors = exports.useIndigoMe = exports.studentProfileKeys = exports.useStudentPrefilledInfo = exports.useStudentProfile = exports.useDeleteTemplateMission = exports.useCreateTemplateMission = exports.missionLibraryKeys = exports.useCreateFromPredefinedTasks = exports.useAssignBulkTask = exports.useAssignBulkMission = exports.useCopyTemplateMission = exports.useUpdateTemplateMission = exports.useTemplateMissionDetail = exports.useTemplateTasksInfinite = exports.useTemplateTasks = exports.useTemplateMissionsInfinite = exports.useTemplateMissions = exports.useRoadmapContext = exports.accountKeys = exports.useMyStudents = exports.useCurrentUserRoles = exports.userKeys = exports.useUser = exports.useUsers = exports.useTaskActivities = exports.useTaskCreators = exports.useGetDownloadUrl = exports.taskKeys = exports.useBulkUpdateTasks = exports.useBulkDeleteTasks = exports.useDeleteTask = exports.useUpdateTask = exports.useCreateTask = exports.useTasksInfinite = exports.useTasksByRoadmapId = exports.useAllUserTasks = exports.useTasks = exports.missionKeys = exports.useDeleteMission = exports.useUpdateMission = exports.useCreateMission = exports.useMissionsInfinite = exports.useMissions = exports.useOAuthCallback = exports.useOAuth = exports.useQueryClient = exports.useAuthState = void 0;
 var useAuthState_1 = require("./useAuthState");
 Object.defineProperty(exports, "useAuthState", { enumerable: true, get: function () { return useAuthState_1.useAuthState; } });
+var react_query_1 = require("@tanstack/react-query");
+Object.defineProperty(exports, "useQueryClient", { enumerable: true, get: function () { return react_query_1.useQueryClient; } });
 var useOAuth_1 = require("./useOAuth");
 Object.defineProperty(exports, "useOAuth", { enumerable: true, get: function () { return useOAuth_1.useOAuth; } });
 Object.defineProperty(exports, "useOAuthCallback", { enumerable: true, get: function () { return useOAuth_1.useOAuthCallback; } });
@@ -40,6 +42,7 @@ Object.defineProperty(exports, "useBulkUpdateTasks", { enumerable: true, get: fu
 Object.defineProperty(exports, "taskKeys", { enumerable: true, get: function () { return useTasks_1.taskKeys; } });
 Object.defineProperty(exports, "useGetDownloadUrl", { enumerable: true, get: function () { return useTasks_1.useGetDownloadUrl; } });
 Object.defineProperty(exports, "useTaskCreators", { enumerable: true, get: function () { return useTasks_1.useTaskCreators; } });
+Object.defineProperty(exports, "useTaskActivities", { enumerable: true, get: function () { return useTasks_1.useTaskActivities; } });
 var useUsers_1 = require("./useUsers");
 Object.defineProperty(exports, "useUsers", { enumerable: true, get: function () { return useUsers_1.useUsers; } });
 Object.defineProperty(exports, "useUser", { enumerable: true, get: function () { return useUsers_1.useUser; } });

package/dist/react/hooks/useTasks.d.ts

@@ -1,5 +1,5 @@
 import { InfiniteData } from "@tanstack/react-query";
-import type { Task, PaginatedResult, User } from "../../core/types";
+import type { Task, PaginatedResult, User, ActionItemActivityBrief } from "../../core/types";
 import type { TaskFilters } from "../../core/tasks";
 export declare const taskKeys: {
     all: readonly ["tasks"];
@@ -9,9 +9,15 @@ export declare const taskKeys: {
     details: () => readonly ["tasks", "detail"];
     detail: (id: string) => readonly ["tasks", "detail", string];
     creators: (roadmapId: string) => readonly ["tasks", "creators", string];
+    activitiesOfTask: (id: string) => readonly ["task-activities", string];
+    activity: (id: string, type?: string) => readonly ["task-activities", string, string];
 };
 export declare function useTasks(missionId: string | null, enabled: boolean): import("@tanstack/react-query").UseQueryResult<Task[], Error>;
 export declare function useTaskCreators(roadmapId: string | null, enabled?: boolean): import("@tanstack/react-query").UseQueryResult<User[], Error>;
+export declare function useTaskActivities(actionItemIds: string[], type?: string, enabled?: boolean): {
+    data: Record<string, ActionItemActivityBrief[]>;
+    isLoading: boolean;
+};
 export declare function useAllUserTasks(missionLinkIds: string[], enabled: boolean): import("@tanstack/react-query").UseQueryResult<Task[], Error>;
 export declare function useTasksByRoadmapId(roadmapId: string | null, userId: string | null, enabled: boolean): import("@tanstack/react-query").UseQueryResult<Task[], Error>;
 /**

package/dist/react/hooks/useTasks.js

@@ -13,6 +13,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.taskKeys = void 0;
 exports.useTasks = useTasks;
 exports.useTaskCreators = useTaskCreators;
+exports.useTaskActivities = useTaskActivities;
 exports.useAllUserTasks = useAllUserTasks;
 exports.useTasksByRoadmapId = useTasksByRoadmapId;
 exports.useTasksInfinite = useTasksInfinite;
@@ -23,6 +24,7 @@ exports.useBulkDeleteTasks = useBulkDeleteTasks;
 exports.useBulkUpdateTasks = useBulkUpdateTasks;
 exports.useGetDownloadUrl = useGetDownloadUrl;
 const react_query_1 = require("@tanstack/react-query");
+const react_1 = require("react");
 const provider_1 = require("../provider");
 // Query keys
 exports.taskKeys = {
@@ -33,6 +35,8 @@ exports.taskKeys = {
     details: () => [...exports.taskKeys.all, "detail"],
     detail: (id) => [...exports.taskKeys.details(), id],
     creators: (roadmapId) => [...exports.taskKeys.all, "creators", roadmapId],
+    activitiesOfTask: (id) => ["task-activities", id],
+    activity: (id, type = "duedate") => [...exports.taskKeys.activitiesOfTask(id), type],
 };
 function useTasks(missionId, enabled) {
     const client = (0, provider_1.useCrimsonClient)();
@@ -61,6 +65,107 @@ function useTaskCreators(roadmapId, enabled = true) {
         enabled: !!roadmapId && enabled,
     });
 }
+function useTaskActivities(actionItemIds, type = "duedate", enabled = true) {
+    const client = (0, provider_1.useCrimsonClient)();
+    const queryClient = (0, react_query_1.useQueryClient)();
+    // Track which IDs we know are in the cache (or have been fetched)
+    const [cachedIds, setCachedIds] = (0, react_1.useState)(() => {
+        const s = new Set();
+        // We only check for existence, not staleness. Stale data will be refetched by useQueries if needed,
+        // but we want to prevent the *initial* fetch of empty data which causes the waterfall/storm.
+        // However, checking queryCache synchronously here is good for hydration.
+        return s;
+    });
+    // Sync effect to update cachedIds from props? 
+    // actually, we should just check the cache on render or effect.
+    // But doing it in effect allows the batch fetch to be the primary mechanism.
+    (0, react_1.useEffect)(() => {
+        if (!enabled)
+            return;
+        // Identify which IDs are missing from our "known cached" set
+        // AND missing from the actual query cache (double check to be safe)
+        const missing = actionItemIds.filter((id) => {
+            if (cachedIds.has(id))
+                return false;
+            const data = queryClient.getQueryData(exports.taskKeys.activity(id, type));
+            if (data) {
+                // If it's already there (maybe from another component), we can mark it as cached
+                // We'll update state later to avoid set-during-render warning if we did it synchronously above constantly
+                return false;
+            }
+            return true;
+        });
+        if (missing.length === 0) {
+            // If we found some inconsistencies (e.g. they were in queryClient but not in our local state), align them
+            if (actionItemIds.length !== cachedIds.size) {
+                // This logic is tricky. Let's simplify: 
+                // Just fetch what we really need.
+            }
+            return;
+        }
+        const fetchActivities = () => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield client.tasks.getActivities(missing, type);
+                // Populate Cache
+                Object.entries(result).forEach(([id, activities]) => {
+                    queryClient.setQueryData(exports.taskKeys.activity(id, type), activities);
+                });
+                // Also handling IDs that returned no result (empty array) to prevent infinite re-fetching?
+                // The API returns Record<string, ...>. If an ID is missing, we should probably set it to empty.
+                missing.forEach(id => {
+                    if (!result[id]) {
+                        queryClient.setQueryData(exports.taskKeys.activity(id, type), []);
+                    }
+                });
+                // Update local state to enable the queries
+                setCachedIds((prev) => {
+                    const next = new Set(prev);
+                    missing.forEach((id) => next.add(id));
+                    return next;
+                });
+            }
+            catch (e) {
+                console.error("Failed to batch fetch activities", e);
+            }
+        });
+        fetchActivities();
+    }, [actionItemIds, type, enabled, client, queryClient, cachedIds]); // cachedIds dep is important
+    // Also, we need to make sure we "discover" items that are already cached 
+    // without fetching them. Use an effect to sync "initially present" items?
+    (0, react_1.useEffect)(() => {
+        if (!enabled)
+            return;
+        const present = actionItemIds.filter(id => !cachedIds.has(id) && queryClient.getQueryData(exports.taskKeys.activity(id, type)));
+        if (present.length > 0) {
+            setCachedIds(prev => {
+                const next = new Set(prev);
+                present.forEach(id => next.add(id));
+                return next;
+            });
+        }
+    }, [actionItemIds, type, enabled, queryClient, cachedIds]);
+    const queries = (0, react_query_1.useQueries)({
+        queries: actionItemIds.map((id) => ({
+            queryKey: exports.taskKeys.activity(id, type),
+            queryFn: () => __awaiter(this, void 0, void 0, function* () {
+                const result = yield client.tasks.getActivities([id], type);
+                return result[id] || [];
+            }),
+            // Only enable if we have "acknowledged" that the data is ready/cached.
+            // OR if it was already in the cache (optimization).
+            enabled: enabled && !!id && cachedIds.has(id),
+            staleTime: 5 * 60 * 1000,
+        })),
+    });
+    const isLoading = queries.some((q) => q.isLoading);
+    const data = {};
+    queries.forEach((q, index) => {
+        if (q.data) {
+            data[actionItemIds[index]] = q.data;
+        }
+    });
+    return { data, isLoading };
+}
 function useAllUserTasks(missionLinkIds, enabled) {
     const client = (0, provider_1.useCrimsonClient)();
     return (0, react_query_1.useQuery)({
@@ -197,8 +302,13 @@ function useUpdateTask(options) {
                 queryClient.setQueryData(JSON.parse(keyStr), old);
             });
         },
-        onSettled: () => {
+        onSettled: (data, error, variables) => {
             queryClient.invalidateQueries({ queryKey: exports.taskKeys.all });
+            if (variables.id) {
+                queryClient.invalidateQueries({
+                    queryKey: exports.taskKeys.activitiesOfTask(variables.id),
+                });
+            }
         },
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crimson-education/sdk",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "description": "Crimson SDK for accessing Crimson App APIs",
   "main": "dist/index.js",
   "module": "dist/index.js",