@instructure/platform-notebook 0.2.0

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAIvB,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;EAKxB,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAE7D,eAAO,MAAM,oBAAoB;;;;;;;;;EAG/B,CAAA;AACF,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AAE3E,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMxB,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAI7D,oBAAY,aAAa;IACvB,SAAS,cAAc;IACvB,SAAS,cAAc;CACxB;AAED,eAAO,MAAM,YAAY,+DAA6D,CAAA;AAItF,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;EAKnB,CAAA;AACF,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAA;AAEnD,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,MAAM,CAAA;AAIjD,eAAO,MAAM,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYf,CAAA;AACF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,CAAA;AAS3C,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMzB,CAAA;AACF,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAA;AAS/D,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;GAMf,CAAA;AAEb,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMxB,CAAA;AACF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAI7D,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAO1B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAEjE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE7B,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEvE,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAK1B,CAAA;AACF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;AAEjE,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAE7B,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAEvE,eAAO,MAAM,kBAAkB;;;;;;EAE7B,CAAA;AACF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AAIvE,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,QAAQ,EAAE,CAAA;IACjB,QAAQ,EAAE,YAAY,CAAA;CACvB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAA;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,mBAAmB,CAAA;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAA;IACzD,UAAU,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IACzD,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;IACrE,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACtC;AAID,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB"}

package/dist/utils.d.ts

@@ -0,0 +1,25 @@
+import { TextPositionAnchor } from './TextPositionAnchor';
+import { NoteType, TextPositionSelectorType, UpdateNoteInputType } from './types';
+export declare const nodeTextLength: (node: Node) => number;
+export declare const previousSiblingsTextLength: (node: Node) => number;
+export declare const resolveOffsets: (element: Element, ...offsets: number[]) => Array<{
+    node: Text;
+    offset: number;
+}>;
+export declare const recalculateRangeFromPreviousTextPosition: (root: Element, selectedText: string, targetStart: number, targetEnd: number) => TextPositionAnchor | null;
+export type TextSelectionPlacement = {
+    top: number;
+    left: number;
+};
+export type RecoverHighlightsResult = {
+    notesForUpdate: UpdateNoteInputType[];
+    noteIdsForDelete: string[];
+};
+export declare const recoverHighlights: (parentRef: Element, notes: NoteType[], pageLastModifiedAt: string) => RecoverHighlightsResult;
+export declare const scrollToHighlight: (id: string) => void;
+export declare const getPlacement: (range: Range) => TextSelectionPlacement | null;
+export declare const isOverlapping: (newRange: TextPositionSelectorType, existingRanges: TextPositionSelectorType[]) => boolean;
+export declare const createHighlightWrapperId: (id: string) => string;
+export declare const createHighlightWrapperIdStart: (id: string) => string;
+export declare const createHighlightWrapperIdEnd: (id: string) => string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,KAAK,EAAE,QAAQ,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAA;AAEtF,eAAO,MAAM,cAAc,GAAI,MAAM,IAAI,KAAG,MAQ3C,CAAA;AAED,eAAO,MAAM,0BAA0B,GAAI,MAAM,IAAI,KAAG,MAQvD,CAAA;AAED,eAAO,MAAM,cAAc,GACzB,SAAS,OAAO,EAChB,GAAG,SAAS,MAAM,EAAE,KACnB,KAAK,CAAC;IAAE,IAAI,EAAE,IAAI,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CA8BtC,CAAA;AAmBD,eAAO,MAAM,wCAAwC,GACnD,MAAM,OAAO,EACb,cAAc,MAAM,EACpB,aAAa,MAAM,EACnB,WAAW,MAAM,KAChB,kBAAkB,GAAG,IAgDvB,CAAA;AAED,MAAM,MAAM,sBAAsB,GAAG;IACnC,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,cAAc,EAAE,mBAAmB,EAAE,CAAA;IACrC,gBAAgB,EAAE,MAAM,EAAE,CAAA;CAC3B,CAAA;AAcD,eAAO,MAAM,iBAAiB,GAC5B,WAAW,OAAO,EAClB,OAAO,QAAQ,EAAE,EACjB,oBAAoB,MAAM,KACzB,uBAsCF,CAAA;AAED,eAAO,MAAM,iBAAiB,GAAI,IAAI,MAAM,KAAG,IAc9C,CAAA;AAKD,eAAO,MAAM,YAAY,GAAI,OAAO,KAAK,KAAG,sBAAsB,GAAG,IAmEpE,CAAA;AAED,eAAO,MAAM,aAAa,GACxB,UAAU,wBAAwB,EAClC,gBAAgB,wBAAwB,EAAE,KACzC,OAOF,CAAA;AAED,eAAO,MAAM,wBAAwB,GAAI,IAAI,MAAM,KAAG,MAErD,CAAA;AAED,eAAO,MAAM,6BAA6B,GAAI,IAAI,MAAM,KAAG,MAE1D,CAAA;AAED,eAAO,MAAM,2BAA2B,GAAI,IAAI,MAAM,KAAG,MAExD,CAAA"}

package/dist/xpath.d.ts

@@ -0,0 +1,3 @@
+export declare const xpathFromNode: (node: Node, root: Node) => string | undefined;
+export declare const nodeFromXPath: (xpath: string, root?: Element) => Node | null;
+//# sourceMappingURL=xpath.d.ts.map

package/dist/xpath.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xpath.d.ts","sourceRoot":"","sources":["../src/xpath.ts"],"names":[],"mappings":"AAuBA,eAAO,MAAM,aAAa,GAAI,MAAM,IAAI,EAAE,MAAM,IAAI,uBAgBnD,CAAA;AA4DD,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,EAAE,OAAM,OAAuB,KAAG,IAAI,GAAG,IAOnF,CAAA"}

package/locales/en.json

@@ -0,0 +1,38 @@
+{
+  "notebook": "Notebook",
+  "notes": "Notes",
+  "important": "Important",
+  "unclear": "Unclear",
+
+  "editNote": "Edit note",
+  "save": "Save",
+  "cancel": "Cancel",
+  "deleteNote": "Delete note",
+  "removeFromNotebook": "Remove from Notebook",
+  "addNoteOptional": "Add a note (optional).",
+  "markImportant": "Mark important",
+  "markUnclear": "Mark unclear",
+
+  "savedToNotebook": "Saved to Notebook.",
+  "noteUpdated": "Note updated",
+  "noteDeleted": "Note deleted",
+  "errorSavingNote": "Error saving to Notebook.",
+  "errorUpdatingNote": "Error updating note",
+  "noteDeletionFailed": "Note deletion failed",
+
+  "loadingNotes": "Loading notes",
+  "failedToLoadNotes": "Failed to load notes",
+  "emptyStateHeading": "Start capturing your notes",
+  "emptyStateDescription": "Your notes from learning materials will appear here. Highlight key ideas, reflections, or questions as you learn—they'll all be saved in your Notebook for easy review later.",
+  "nothingHereYet": "Nothing here yet",
+  "adjustFiltersOrCreate": "Adjust your filters or create a new note to get started.",
+  "noNotesForFilter": "You have no notes for the selected filter",
+
+  "previousPage": "Previous page",
+  "nextPage": "Next page",
+  "allCourses": "All courses",
+  "allNotes": "All notes",
+  "closeNotebookPanel": "Close Notebook panel",
+
+  "featureDescription": "To use the Notebook feature, highlight an excerpt from your learning material to flag it as 'confusing' or 'important' and leave an optional note."
+}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@instructure/platform-notebook",
+  "version": "0.2.0",
+  "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"
+    },
+    "./locales/en.json": "./locales/en.json"
+  },
+  "files": [
+    "dist",
+    "locales"
+  ],
+  "peerDependencies": {
+    "@instructure/ui": "^10.0.0",
+    "@tanstack/react-query": "^5.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
+    "styled-components": "^6.0.0"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.0.0",
+    "@testing-library/user-event": "^14.0.0",
+    "@types/diff-match-patch": "^1.0.36",
+    "@types/react": "^18.3.0",
+    "@types/react-dom": "^18.3.0",
+    "@vitejs/plugin-react": "^4.0.0",
+    "@vitest/coverage-v8": "^4.0.17",
+    "jsdom": "^25.0.0",
+    "typescript": "^5.3.0",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^4.0.0",
+    "vitest": "^4.0.0"
+  },
+  "dependencies": {
+    "diff-match-patch": "^1.0.5",
+    "zod": "^3.25.76"
+  },
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "biome check . && ast-grep scan . --report-style=short",
+    "lint:fix": "biome check --write .",
+    "type-check": "tsc -p tsconfig.check.json",
+    "pack:tarball": "pnpm build && pnpm pack"
+  }
+}