@crimson-education/sdk 0.2.2 → 0.2.4

package/README.md

@@ -116,11 +116,13 @@ const page = await client.missions.listPaginated("student-uid", undefined, {
 涉及接口：
 
 - `GET /roadmap/action-items`
+- `GET /roadmap/action-items/creators`
 - `POST /roadmap/action-items`
 - `PUT /roadmap/action-items/:id`
 - `DELETE /roadmap/action-items/:id`
 - `POST /roadmap/action-items/:actionItemId/resources`
 - `POST /roadmap/upload`
+- `GET /roadmap/download`
 
 主要方法：
 
@@ -138,6 +140,10 @@ const page = await client.missions.listPaginated("student-uid", undefined, {
   - 当 **同时提供** `roadmapId` 且提供 `start/limit` 时：返回 `PaginatedResult<Task>`
 - `listPaginated(roadmapId, userId, filters?, pagination?)`
   - 始终返回 `PaginatedResult<Task>`（内部复用 `list`）
+- `getCreators(roadmapId)`
+  - 获取指定 roadmap 下所有任务的创建者列表
+- `getDownloadUrl(key)`
+  - 获取 S3 资源的预签名下载 URL
 - `create(data: Partial<Task>)`
   - 支持两种模式：
     - Mission 关联任务：提供 `roadmapMissionId`（或 `missionId`）
@@ -203,6 +209,8 @@ SDK 会将后端返回的 action item 做归一化，保证至少返回以下核
 涉及接口：
 
 - `GET /roadmap/library/missions`
+- `POST /roadmap/library/missions`
+- `PUT /roadmap/library/missions/:missionId`
 - `GET /roadmap/library/tasks`
 - `POST /roadmap/library/missions/copy`
 - `POST /roadmap/library/missions/assign-bulk`
@@ -213,6 +221,8 @@ SDK 会将后端返回的 action item 做归一化，保证至少返回以下核
 主要方法：
 
 - `listTemplateMissions(filters?: TemplateMissionFilters): Promise<PaginatedResult<TemplateMission>>`
+- `createTemplateMission(input: TemplateMissionCreateInput): Promise<TemplateMission>`
+- `updateTemplateMission(id: string, raw: TemplateMission, update: TemplateMissionUpdateInput): Promise<TemplateMission>`
 - `listTemplateTasks(filters?: TemplateTaskFilters): Promise<PaginatedResult<TemplateTask>>`
 - `copyTemplateMission(input: CopyTemplateMissionInput): Promise<TemplateMission[]>`
 - `assignBulkMission(input: AssignBulkMissionInput[]): Promise<{ code: number; msg?: string }>`
@@ -314,9 +324,16 @@ Props：
 - `useTasks(missionId, enabled)`：拉取某 mission 的 tasks
 - `useTasksInfinite(roadmapId, userId, filters?, options?)`：分页拉取 tasks
 - `useRoadmapContext(userId, enabled)`：拉取 roadmap context
+- `useTaskCreators(roadmapId, enabled)`：获取任务创建者列表
 - CRUD mutation：
   - `useCreateMission/useUpdateMission/useDeleteMission`
   - `useCreateTask/useUpdateTask/useDeleteTask`
+  - `useCreateTemplateMission/useUpdateTemplateMission`
+  - `useGetDownloadUrl`：获取文件下载地址
+- 模板库相关：
+  - `useTemplateMissions/useTemplateMissionsInfinite`
+  - `useTemplateTasks/useTemplateTasksInfinite`
+  - `useTemplateMissionDetail(missionId)`
 
 ---
 

package/dist/core/account.js

@@ -38,8 +38,9 @@ class AccountApi {
      */
     getMyStudents() {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.client.fetch("/api/v1/account/me/students");
-            return response.data;
+            // Note: client.fetch() automatically unwraps { data: [...] } responses,
+            // so we get StudentSummary[] directly
+            return this.client.fetch("/api/v1/account/me/students");
         });
     }
 }

package/dist/core/missionLibrary.d.ts

@@ -39,6 +39,17 @@ export interface CreateFromPredefinedInput {
     missionId: string;
     predefinedTaskIds: string[];
 }
+export interface TemplateMissionCreateInput {
+    title: string;
+    description: string;
+    category: string;
+    subcategory: string;
+    tasks: {
+        id?: string | null;
+        description: string;
+        content: string;
+    }[];
+}
 export declare class MissionLibraryApi {
     private client;
     constructor(client: CrimsonClient);
@@ -46,6 +57,10 @@ export declare class MissionLibraryApi {
      * List template missions with pagination
      */
     listTemplateMissions(filters?: TemplateMissionFilters): Promise<PaginatedResult<TemplateMission>>;
+    /**
+     * Create a new template mission
+     */
+    createTemplateMission(input: TemplateMissionCreateInput): Promise<TemplateMission>;
     /**
      * List template tasks with pagination
      */

package/dist/core/missionLibrary.js

@@ -49,6 +49,17 @@ class MissionLibraryApi {
             return this.client.fetch(path);
         });
     }
+    /**
+     * Create a new template mission
+     */
+    createTemplateMission(input) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.client.fetch("/roadmap/library/missions", {
+                method: "POST",
+                body: JSON.stringify(Object.assign(Object.assign({}, input), { type: "custom" })),
+            });
+        });
+    }
     /**
      * List template tasks with pagination
      */

package/dist/core/tasks.d.ts

@@ -1,5 +1,5 @@
 import type { CrimsonClient } from "./client";
-import type { Task, PaginationParams, PaginatedResult, ActionItemResource, AddResourceInput, UploadUrlResponse, UpdateTaskResourceInput } from "./types";
+import type { Task, PaginationParams, PaginatedResult, ActionItemResource, AddResourceInput, UploadUrlResponse, DownloadUrlResponse, UpdateTaskResourceInput, User } from "./types";
 export type TaskOrderBy = "priority" | "dueDate" | "missionTitle" | "createdAt" | "description";
 export interface TaskFilters extends PaginationParams {
     status?: string[];
@@ -28,6 +28,10 @@ export declare class TasksApi {
      * List tasks with pagination (requires roadmapId, always returns paginated result)
      */
     listPaginated(roadmapId: string, userId: string, filters?: Omit<TaskFilters, "start" | "limit">, pagination?: PaginationParams): Promise<PaginatedResult<Task>>;
+    /**
+     * Get all creators of tasks in a roadmap
+     */
+    getCreators(roadmapId: string): Promise<User[]>;
     /**
      * Create a new task/action item
      *
@@ -92,6 +96,13 @@ export declare class TasksApi {
      * await tasks.updateResources(taskId, [{ title: "Document", type: "Upload", url }]);
      */
     getUploadUrl(filename: string, contentType: string): Promise<UploadUrlResponse>;
+    /**
+     * Get a presigned URL for downloading a file from S3
+     *
+     * @param key - The S3 object key
+     * @returns Promise with url (presigned download URL)
+     */
+    getDownloadUrl(key: string): Promise<DownloadUrlResponse>;
     /**
      * Upload a file and get the S3 URL
      *

package/dist/core/tasks.js

@@ -149,6 +149,12 @@ class TasksApi {
         var _a, _b;
         return this.list({ roadmapId, userId }, Object.assign(Object.assign({}, filters), { start: (_a = pagination === null || pagination === void 0 ? void 0 : pagination.start) !== null && _a !== void 0 ? _a : 0, limit: (_b = pagination === null || pagination === void 0 ? void 0 : pagination.limit) !== null && _b !== void 0 ? _b : 20 }));
     }
+    /**
+     * Get all creators of tasks in a roadmap
+     */
+    getCreators(roadmapId) {
+        return this.client.fetch(`/roadmap/action-items/creators?roadmapId=${roadmapId}`);
+    }
     /**
      * Create a new task/action item
      *
@@ -246,6 +252,17 @@ class TasksApi {
             body: JSON.stringify({ filename, contentType }),
         });
     }
+    /**
+     * Get a presigned URL for downloading a file from S3
+     *
+     * @param key - The S3 object key
+     * @returns Promise with url (presigned download URL)
+     */
+    getDownloadUrl(key) {
+        return this.client.fetch(`/roadmap/download?key=${encodeURIComponent(key)}`, {
+            method: "GET",
+        });
+    }
     /**
      * Upload a file and get the S3 URL
      *

package/dist/core/types.d.ts

@@ -297,6 +297,10 @@ export interface UploadUrlResponse {
     /** S3 bucket name */
     bucket: string;
 }
+export interface DownloadUrlResponse {
+    /** Presigned URL for downloading the file */
+    url: string;
+}
 export interface UpdateTaskResourceInput {
     /** Resource ID - include to update existing, omit to create new */
     id?: string;

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

@@ -2,7 +2,7 @@ export { useAuthState } from "./useAuthState";
 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, taskKeys, } from "./useTasks";
+export { useTasks, useAllUserTasks, useTasksByRoadmapId, useTasksInfinite, useCreateTask, useUpdateTask, useDeleteTask, taskKeys, useGetDownloadUrl, useTaskCreators } from "./useTasks";
 export { useUsers, useUser, userKeys } from "./useUsers";
 export { useCurrentUserRoles, useMyStudents, accountKeys } from "./useAccount";
 export { useRoadmapContext } from "./useRoadmapContext";

package/dist/react/hooks/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.studentProfileKeys = exports.useStudentPrefilledInfo = exports.useStudentProfile = 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.taskKeys = 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.studentProfileKeys = exports.useStudentPrefilledInfo = exports.useStudentProfile = 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.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;
 var useAuthState_1 = require("./useAuthState");
 Object.defineProperty(exports, "useAuthState", { enumerable: true, get: function () { return useAuthState_1.useAuthState; } });
 var useOAuth_1 = require("./useOAuth");
@@ -22,6 +22,8 @@ Object.defineProperty(exports, "useCreateTask", { enumerable: true, get: functio
 Object.defineProperty(exports, "useUpdateTask", { enumerable: true, get: function () { return useTasks_1.useUpdateTask; } });
 Object.defineProperty(exports, "useDeleteTask", { enumerable: true, get: function () { return useTasks_1.useDeleteTask; } });
 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; } });
 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/useMissionLibrary.d.ts

@@ -1,5 +1,5 @@
 import type { TemplateMission, TemplateTask, MissionDetail, AssignBulkMissionInput, AssignBulkTaskInput } from "../../core/types";
-import type { TemplateMissionFilters, TemplateTaskFilters, CopyTemplateMissionInput, CreateFromPredefinedInput, TemplateMissionUpdateInput } from "../../core/missionLibrary";
+import type { TemplateMissionFilters, TemplateTaskFilters, CopyTemplateMissionInput, CreateFromPredefinedInput, TemplateMissionUpdateInput, TemplateMissionCreateInput } from "../../core/missionLibrary";
 export declare const missionLibraryKeys: {
     all: readonly ["missionLibrary"];
     missions: (filters?: TemplateMissionFilters) => readonly ["missionLibrary", "missions", TemplateMissionFilters | undefined];
@@ -24,6 +24,7 @@ export declare function useUpdateTemplateMission(): import("@tanstack/react-quer
     raw: TemplateMission;
     update: TemplateMissionUpdateInput;
 }, unknown>;
+export declare function useCreateTemplateMission(): import("@tanstack/react-query").UseMutationResult<TemplateMission, Error, TemplateMissionCreateInput, unknown>;
 export declare function useCopyTemplateMission(): import("@tanstack/react-query").UseMutationResult<TemplateMission[], Error, CopyTemplateMissionInput, unknown>;
 export declare function useAssignBulkMission(): import("@tanstack/react-query").UseMutationResult<{
     code: number;

package/dist/react/hooks/useMissionLibrary.js

@@ -17,6 +17,7 @@ exports.useTemplateTasks = useTemplateTasks;
 exports.useTemplateTasksInfinite = useTemplateTasksInfinite;
 exports.useTemplateMissionDetail = useTemplateMissionDetail;
 exports.useUpdateTemplateMission = useUpdateTemplateMission;
+exports.useCreateTemplateMission = useCreateTemplateMission;
 exports.useCopyTemplateMission = useCopyTemplateMission;
 exports.useAssignBulkMission = useAssignBulkMission;
 exports.useAssignBulkTask = useAssignBulkTask;
@@ -121,6 +122,20 @@ function useUpdateTemplateMission() {
         },
     });
 }
+function useCreateTemplateMission() {
+    const client = (0, provider_1.useCrimsonClient)();
+    const queryClient = (0, react_query_1.useQueryClient)();
+    return (0, react_query_1.useMutation)({
+        mutationFn: (input) => client.library.createTemplateMission(input),
+        onSuccess: () => {
+            queryClient.invalidateQueries({
+                queryKey: exports.missionLibraryKeys.missionsInfinite({
+                    groups: ["custom"],
+                }),
+            });
+        },
+    });
+}
 function useCopyTemplateMission() {
     const client = (0, provider_1.useCrimsonClient)();
     const queryClient = (0, react_query_1.useQueryClient)();

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

@@ -1,4 +1,4 @@
-import type { Task, PaginatedResult } from "../../core/types";
+import type { Task, PaginatedResult, User } from "../../core/types";
 import type { TaskFilters } from "../../core/tasks";
 export declare const taskKeys: {
     all: readonly ["tasks"];
@@ -7,8 +7,10 @@ export declare const taskKeys: {
     infinite: (roadmapId: string, userId: string, filters?: Omit<TaskFilters, "start" | "limit">) => readonly ["tasks", "infinite", string, string, Omit<TaskFilters, "start" | "limit"> | undefined];
     details: () => readonly ["tasks", "detail"];
     detail: (id: string) => readonly ["tasks", "detail", string];
+    creators: (roadmapId: string) => readonly ["tasks", "creators", 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 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>;
 /**
@@ -24,3 +26,4 @@ export declare function useUpdateTask(): import("@tanstack/react-query").UseMuta
     data: Partial<Task>;
 }, unknown>;
 export declare function useDeleteTask(): import("@tanstack/react-query").UseMutationResult<void, Error, string, unknown>;
+export declare function useGetDownloadUrl(): import("@tanstack/react-query").UseMutationResult<import("../../core/types").DownloadUrlResponse, Error, string, unknown>;

package/dist/react/hooks/useTasks.js

@@ -12,12 +12,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.taskKeys = void 0;
 exports.useTasks = useTasks;
+exports.useTaskCreators = useTaskCreators;
 exports.useAllUserTasks = useAllUserTasks;
 exports.useTasksByRoadmapId = useTasksByRoadmapId;
 exports.useTasksInfinite = useTasksInfinite;
 exports.useCreateTask = useCreateTask;
 exports.useUpdateTask = useUpdateTask;
 exports.useDeleteTask = useDeleteTask;
+exports.useGetDownloadUrl = useGetDownloadUrl;
 const react_query_1 = require("@tanstack/react-query");
 const provider_1 = require("../provider");
 // Query keys
@@ -28,6 +30,7 @@ exports.taskKeys = {
     infinite: (roadmapId, userId, filters) => [...exports.taskKeys.all, "infinite", roadmapId, userId, filters],
     details: () => [...exports.taskKeys.all, "detail"],
     detail: (id) => [...exports.taskKeys.details(), id],
+    creators: (roadmapId) => [...exports.taskKeys.all, "creators", roadmapId],
 };
 function useTasks(missionId, enabled) {
     const client = (0, provider_1.useCrimsonClient)();
@@ -43,6 +46,19 @@ function useTasks(missionId, enabled) {
         enabled: !!missionId && enabled,
     });
 }
+function useTaskCreators(roadmapId, enabled = true) {
+    const client = (0, provider_1.useCrimsonClient)();
+    return (0, react_query_1.useQuery)({
+        queryKey: exports.taskKeys.creators(roadmapId || ""),
+        queryFn: () => __awaiter(this, void 0, void 0, function* () {
+            if (!roadmapId) {
+                return [];
+            }
+            return client.tasks.getCreators(roadmapId);
+        }),
+        enabled: !!roadmapId && enabled,
+    });
+}
 function useAllUserTasks(missionLinkIds, enabled) {
     const client = (0, provider_1.useCrimsonClient)();
     return (0, react_query_1.useQuery)({
@@ -135,3 +151,9 @@ function useDeleteTask() {
         },
     });
 }
+function useGetDownloadUrl() {
+    const client = (0, provider_1.useCrimsonClient)();
+    return (0, react_query_1.useMutation)({
+        mutationFn: (key) => client.tasks.getDownloadUrl(key),
+    });
+}

package/package.json

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