@instructure/platform-mock-canvas-api 0.1.1

package/README.md

@@ -0,0 +1,84 @@
+# @instructure/platform-mock-canvas-api
+
+Mock Canvas API handlers using MSW (Mock Service Worker) for development and testing.
+
+## Installation
+
+```bash
+pnpm add -D @instructure/platform-mock-canvas-api msw
+```
+
+## Usage
+
+### In Browser (Demo App, Storybook)
+
+```typescript
+import { setupWorker } from 'msw/browser'
+import { handlers } from '@instructure/platform-mock-canvas-api'
+
+const worker = setupWorker(...handlers)
+worker.start()
+```
+
+### In Tests (Vitest, Jest)
+
+```typescript
+import { setupServer } from 'msw/node'
+import { handlers } from '@instructure/platform-mock-canvas-api'
+
+const server = setupServer(...handlers)
+
+beforeAll(() => server.listen())
+afterEach(() => server.resetHandlers())
+afterAll(() => server.close())
+```
+
+### Using Individual Handler Groups
+
+```typescript
+import { courseHandlers, submissionHandlers } from '@instructure/platform-mock-canvas-api'
+
+// Use only course handlers
+const worker = setupWorker(...courseHandlers)
+
+// Or combine with your own handlers
+const worker = setupWorker(...courseHandlers, ...myCustomHandlers)
+```
+
+### Using Fixtures
+
+```typescript
+import { courses, submissions, stickerDescriptions } from '@instructure/platform-mock-canvas-api/fixtures'
+
+// Access mock data directly
+console.log(courses) // Array of 5 courses
+console.log(submissions) // Array of 5 submissions
+```
+
+## Included Endpoints
+
+### Courses
+- `GET /api/v1/courses` - List all courses
+- `GET /api/v1/courses/:courseId` - Get single course
+
+### Submissions
+- `GET /api/v1/courses/:courseId/assignments/:assignmentId/submissions/:submissionId`
+- `PATCH /api/v1/courses/:courseId/assignments/:assignmentId/submissions/:submissionId`
+- `GET /api/v1/courses/:courseId/assignments/:assignmentId/submissions`
+
+## Mock Data
+
+- **5 Courses**: CS 101, MATH 201, ENG 150, BIO 110, HIST 100
+- **5 Submissions**: With various stickers and grades
+- **51 Sticker Descriptions**: Full i18n support
+- **Sticker Translations**: UI text translations
+
+## Development
+
+```bash
+# Build the package
+pnpm build
+
+# Type check
+pnpm type-check
+```

package/dist/constants.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Mock Canvas API constants
+ */
+/**
+ * Simulated network delay for API requests in milliseconds
+ */
+export declare const MOCK_API_DELAY_MS = 300;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;GAEG;AACH,eAAO,MAAM,iBAAiB,MAAM,CAAA"}

package/dist/fixtures/courses.d.ts

@@ -0,0 +1,4 @@
+import { Course } from '../types';
+
+export declare const courses: Course[];
+//# sourceMappingURL=courses.d.ts.map

package/dist/fixtures/courses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"courses.d.ts","sourceRoot":"","sources":["../../src/fixtures/courses.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEtC,eAAO,MAAM,OAAO,EAAE,MAAM,EAoC3B,CAAA"}

package/dist/fixtures/index.d.ts

@@ -0,0 +1,5 @@
+export { courses } from './courses';
+export { stickerDescriptions } from './stickerDescriptions';
+export { stickerTranslations } from './stickerTranslations';
+export { submissions, submissionsStore } from './submissions';
+//# sourceMappingURL=index.d.ts.map

package/dist/fixtures/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fixtures/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA"}

package/dist/fixtures/stickerDescriptions.d.ts

@@ -0,0 +1,4 @@
+import { StickerDescriptions } from '../types';
+
+export declare const stickerDescriptions: StickerDescriptions;
+//# sourceMappingURL=stickerDescriptions.d.ts.map

package/dist/fixtures/stickerDescriptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stickerDescriptions.d.ts","sourceRoot":"","sources":["../../src/fixtures/stickerDescriptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAEnD,eAAO,MAAM,mBAAmB,EAAE,mBAoDjC,CAAA"}

package/dist/fixtures/stickerTranslations.d.ts

@@ -0,0 +1,4 @@
+import { StickerTranslations } from '../types';
+
+export declare const stickerTranslations: StickerTranslations;
+//# sourceMappingURL=stickerTranslations.d.ts.map

package/dist/fixtures/stickerTranslations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stickerTranslations.d.ts","sourceRoot":"","sources":["../../src/fixtures/stickerTranslations.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAEnD,eAAO,MAAM,mBAAmB,EAAE,mBAMjC,CAAA"}

package/dist/fixtures.js

@@ -0,0 +1,151 @@
+const t = [
+  {
+    id: "1",
+    name: "Introduction to Computer Science",
+    course_code: "CS 101",
+    enrollment_term_id: "1",
+    term: { id: "1", name: "Fall 2024" }
+  },
+  {
+    id: "2",
+    name: "Advanced Mathematics",
+    course_code: "MATH 201",
+    enrollment_term_id: "1",
+    term: { id: "1", name: "Fall 2024" }
+  },
+  {
+    id: "3",
+    name: "English Literature",
+    course_code: "ENG 150",
+    enrollment_term_id: "1",
+    term: { id: "1", name: "Fall 2024" }
+  },
+  {
+    id: "4",
+    name: "Biology Fundamentals",
+    course_code: "BIO 110",
+    enrollment_term_id: "2",
+    term: { id: "2", name: "Spring 2025" }
+  },
+  {
+    id: "5",
+    name: "World History",
+    course_code: "HIST 100",
+    enrollment_term_id: "2",
+    term: { id: "2", name: "Spring 2025" }
+  }
+], a = {
+  default: "A placeholder sticker with a smiley face and a plus sign.",
+  star: "A sticker with a picture of a smiling star.",
+  trophy: "A sticker with a picture of a golden trophy.",
+  target: "A sticker with a picture of an archery target with an arrow in the center.",
+  apple: "A sticker with a picture of an apple.",
+  paintbrush: "A sticker with a picture of a paint brush.",
+  pencil: "A sticker with a picture of a pencil.",
+  design: "A sticker with a picture of a fountain pen nib.",
+  pen: "A sticker with a picture of a pen.",
+  science2: "A sticker with a picture of an atom.",
+  microscope: "A sticker with a picture of a microscope.",
+  telescope: "A sticker with a picture of a telescope.",
+  beaker: "A sticker with a picture of a triangular lab beaker with a narrow neck.",
+  chem: "A sticker with a picture of a circular lab beaker with a narrow neck.",
+  science: "A sticker with a picture of a molecule.",
+  basketball: "A sticker with a picture of a basketball.",
+  gym: "A sticker with a picture of a jumping rope.",
+  book: "A sticker with a picture of a book.",
+  composite_notebook: "A sticker with a picture of a composite notebook.",
+  notebook: "A sticker with a picture of a spiral-bound notebook.",
+  page: "A sticker with a picture of a piece of paper.",
+  mail: "A sticker with a picture of an envelope.",
+  music: "A sticker with a picture of a musical note.",
+  globe: "A sticker with a picture of a globe.",
+  computer: "A sticker with a picture of a computer.",
+  tablet: "A sticker with a picture of a tablet computer.",
+  calculator: "A sticker with a picture of a calculator.",
+  mouse: "A sticker with a picture of a computer mouse.",
+  panda1: "A sticker with a picture of an open-mouth smiling panda crying tears of joy.",
+  panda2: "A sticker with a picture of an open-mouth smiling panda with hearts in its eyes.",
+  panda3: "A sticker with a picture of a closed-mouth panda smiling.",
+  panda4: "A sticker with a picture of an open-mouth panda making a surprised face.",
+  panda5: "A sticker with a picture of an open-mouth panda smiling.",
+  panda6: "A sticker with a picture of a panda with a half-open mouth, smiling.",
+  panda7: "A sticker with a picture of a panda grinning.",
+  panda8: "A sticker with a picture of a panda smiling.",
+  panda9: "A sticker with a picture of a panda grinning.",
+  bookbag: "A sticker with a picture of a bookbag.",
+  briefcase: "A sticker with a picture of a briefcase.",
+  grad: "A sticker with a picture of a graduation cap.",
+  bus: "A sticker with a picture of a school bus.",
+  bell: "A sticker with a picture of a bell.",
+  clock: "A sticker with a picture of a wall clock.",
+  calendar: "A sticker with a picture of a calendar.",
+  paperclip: "A sticker with a picture of a paperclip.",
+  scissors: "A sticker with a picture of scissors.",
+  ruler: "A sticker with a picture of a ruler.",
+  tape: "A sticker with a picture of a tape roll dispenser.",
+  tag: "A sticker with a picture of a clip-on identification tag.",
+  presentation: "A sticker with a picture of a projector screen with presentation content on it.",
+  column: "A sticker with a picture of a roman column."
+}, r = {
+  chooseASticker: "Choose a sticker",
+  close: "Close",
+  removeSticker: "Remove sticker",
+  removedSticker: "Removed sticker",
+  selectedSticker: "Selected sticker"
+}, i = [
+  {
+    id: "1",
+    course_id: "1",
+    assignment_id: "100",
+    user_id: "10",
+    sticker: "grad",
+    submitted_at: "2024-11-15T10:30:00Z",
+    grade: "A",
+    score: 95
+  },
+  {
+    id: "2",
+    course_id: "1",
+    assignment_id: "100",
+    user_id: "11",
+    sticker: "star",
+    submitted_at: "2024-11-15T11:00:00Z",
+    grade: "B+",
+    score: 88
+  },
+  {
+    id: "3",
+    course_id: "1",
+    assignment_id: "100",
+    user_id: "12",
+    sticker: null,
+    submitted_at: "2024-11-15T12:00:00Z"
+  },
+  {
+    id: "4",
+    course_id: "1",
+    assignment_id: "100",
+    user_id: "13",
+    sticker: "panda5",
+    submitted_at: "2024-11-15T14:30:00Z",
+    grade: "A-",
+    score: 92
+  },
+  {
+    id: "5",
+    course_id: "1",
+    assignment_id: "100",
+    user_id: "14",
+    sticker: "trophy",
+    submitted_at: "2024-11-15T15:00:00Z",
+    grade: "A+",
+    score: 98
+  }
+], c = new Map(i.map((e) => [e.id, { ...e }]));
+export {
+  t as courses,
+  a as stickerDescriptions,
+  r as stickerTranslations,
+  i as submissions,
+  c as submissionsStore
+};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './fixtures';
+export { courseHandlers, handlers, submissionHandlers } from './handlers';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AACzE,mBAAmB,SAAS,CAAA"}

package/dist/index.js

@@ -0,0 +1,46 @@
+import { courses as m, submissionsStore as u } from "./fixtures.js";
+import { stickerDescriptions as v, stickerTranslations as k, submissions as l } from "./fixtures.js";
+import { http as e, HttpResponse as n } from "msw";
+const a = [
+  // GET /api/v1/courses
+  e.get("/api/v1/courses", () => n.json(m)),
+  // GET /api/v1/courses/:courseId
+  e.get("/api/v1/courses/:courseId", ({ params: o }) => {
+    const s = m.find((i) => i.id === o.courseId);
+    return s ? n.json(s) : n.json({ errors: [{ message: "Course not found" }] }, { status: 404 });
+  })
+], d = 300, b = [
+  // GET submission
+  e.get(
+    "/api/v1/courses/:courseId/assignments/:assignmentId/submissions/:submissionId",
+    ({ params: o }) => {
+      const s = u.get(o.submissionId);
+      return s ? n.json(s) : n.json({ errors: [{ message: "Submission not found" }] }, { status: 404 });
+    }
+  ),
+  // PATCH submission (update sticker)
+  e.patch(
+    "/api/v1/courses/:courseId/assignments/:assignmentId/submissions/:submissionId",
+    async ({ params: o, request: s }) => {
+      const { submissionId: i } = o, r = await s.json(), t = u.get(i);
+      return t ? (r.submission && "sticker" in r.submission && r.submission.sticker !== void 0 && (t.sticker = r.submission.sticker, u.set(i, t)), await new Promise((c) => setTimeout(c, d)), n.json(t)) : n.json({ errors: [{ message: "Submission not found" }] }, { status: 404 });
+    }
+  ),
+  // GET all submissions for an assignment
+  e.get("/api/v1/courses/:courseId/assignments/:assignmentId/submissions", ({ params: o }) => {
+    const s = Array.from(u.values()).filter(
+      (i) => i.course_id === o.courseId && i.assignment_id === o.assignmentId
+    );
+    return n.json(s);
+  })
+], f = [...a, ...b];
+export {
+  a as courseHandlers,
+  m as courses,
+  f as handlers,
+  v as stickerDescriptions,
+  k as stickerTranslations,
+  b as submissionHandlers,
+  l as submissions,
+  u as submissionsStore
+};

package/dist/types/index.d.ts

@@ -0,0 +1,32 @@
+export interface Course {
+    id: string;
+    name: string;
+    course_code: string;
+    enrollment_term_id: string;
+    term?: {
+        id: string;
+        name: string;
+    };
+}
+export type StickerTitle = 'star' | 'trophy' | 'target' | 'apple' | 'paintbrush' | 'pencil' | 'design' | 'pen' | 'science2' | 'microscope' | 'telescope' | 'beaker' | 'chem' | 'science' | 'basketball' | 'gym' | 'book' | 'composite_notebook' | 'notebook' | 'page' | 'mail' | 'music' | 'globe' | 'computer' | 'tablet' | 'calculator' | 'mouse' | 'panda1' | 'panda2' | 'panda3' | 'panda4' | 'panda5' | 'panda6' | 'panda7' | 'panda8' | 'panda9' | 'bookbag' | 'briefcase' | 'grad' | 'bus' | 'bell' | 'clock' | 'calendar' | 'paperclip' | 'scissors' | 'ruler' | 'tape' | 'tag' | 'presentation' | 'column';
+export interface Submission {
+    id: string;
+    course_id: string;
+    assignment_id: string;
+    user_id?: string;
+    sticker: StickerTitle | null;
+    submitted_at?: string;
+    grade?: string;
+    score?: number;
+}
+export type StickerDescriptions = {
+    [key in StickerTitle | 'default']: string;
+};
+export interface StickerTranslations {
+    chooseASticker: string;
+    removeSticker: string;
+    removedSticker: string;
+    selectedSticker: string;
+    close: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,MAAM;IACrB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,IAAI,CAAC,EAAE;QACL,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF;AAED,MAAM,MAAM,YAAY,GACpB,MAAM,GACN,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,UAAU,GACV,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,MAAM,GACN,SAAS,GACT,YAAY,GACZ,KAAK,GACL,MAAM,GACN,oBAAoB,GACpB,UAAU,GACV,MAAM,GACN,MAAM,GACN,OAAO,GACP,OAAO,GACP,UAAU,GACV,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,WAAW,GACX,MAAM,GACN,KAAK,GACL,MAAM,GACN,OAAO,GACP,UAAU,GACV,WAAW,GACX,UAAU,GACV,OAAO,GACP,MAAM,GACN,KAAK,GACL,cAAc,GACd,QAAQ,CAAA;AAEZ,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,aAAa,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,YAAY,GAAG,IAAI,CAAA;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,mBAAmB,GAAG;KAC/B,GAAG,IAAI,YAAY,GAAG,SAAS,GAAG,MAAM;CAC1C,CAAA;AAED,MAAM,WAAW,mBAAmB;IAClC,cAAc,EAAE,MAAM,CAAA;IACtB,aAAa,EAAE,MAAM,CAAA;IACrB,cAAc,EAAE,MAAM,CAAA;IACtB,eAAe,EAAE,MAAM,CAAA;IACvB,KAAK,EAAE,MAAM,CAAA;CACd"}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@instructure/platform-mock-canvas-api",
+  "version": "0.1.1",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./fixtures": {
+      "types": "./dist/fixtures/index.d.ts",
+      "import": "./dist/fixtures/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "msw": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "msw": "^2.0.0",
+    "typescript": "^5.3.0",
+    "vite": "^5.0.0",
+    "vite-plugin-dts": "^3.7.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "type-check": "tsc --noEmit"
+  }
+}