@instructure/platform-notebook 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,9 @@
1
+ import { RefObject } from 'react';
2
+ import { HighlightTheme } from './highlighter';
3
+ export interface ContentWithNoteWrapperProps {
4
+ containerRef: RefObject<HTMLElement | null>;
5
+ highlightTheme: HighlightTheme;
6
+ debounceTime?: number;
7
+ }
8
+ export declare function ContentWithNoteWrapper({ containerRef, highlightTheme, debounceTime, }: ContentWithNoteWrapperProps): import('react').ReactPortal | null;
9
+ //# sourceMappingURL=ContentWithNoteWrapper.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ContentWithNoteWrapper.d.ts","sourceRoot":"","sources":["../src/ContentWithNoteWrapper.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,SAAS,EAA4C,MAAM,OAAO,CAAA;AAEhF,OAAO,EAAyC,KAAK,cAAc,EAAE,MAAM,eAAe,CAAA;AAmB1F,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAC3C,cAAc,EAAE,cAAc,CAAA;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAID,wBAAgB,sBAAsB,CAAC,EACrC,YAAY,EACZ,cAAc,EACd,YAAkB,GACnB,EAAE,2BAA2B,sCA6R7B"}
@@ -1 +1 @@
1
- {"version":3,"file":"NoteCard.d.ts","sourceRoot":"","sources":["../src/NoteCard.tsx"],"names":[],"mappings":"AAQA,OAAO,EAAsB,KAAK,SAAS,EAAY,MAAM,OAAO,CAAA;AAEpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAInD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,MAAM,aAAa,GAAG;IAC1B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,oBAAoB,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,IAAI,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,aAAa,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;IACpB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACnC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;IACvD,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,KAAK,IAAI,CAAA;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,cAAc,CAAA;IAC9B,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,SAAS,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAA;IAC5F,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAWD,eAAO,MAAM,QAAQ,GAAI,+KAkBtB,aAAa,iHA0Qf,CAAA"}
1
+ {"version":3,"file":"NoteCard.d.ts","sourceRoot":"","sources":["../src/NoteCard.tsx"],"names":[],"mappings":"AAQA,OAAO,EAAsB,KAAK,SAAS,EAAY,MAAM,OAAO,CAAA;AAEpE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAInD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,MAAM,aAAa,GAAG;IAC1B,oBAAoB,EAAE,MAAM,CAAA;IAC5B,oBAAoB,EAAE,MAAM,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,IAAI,GAAG,MAAM,CAAA;IACnB,IAAI,EAAE,aAAa,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,IAAI,CAAA;IACpB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACnC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAA;IACvD,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,KAAK,IAAI,CAAA;IAC5D,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,EAAE,cAAc,CAAA;IAC9B,SAAS,EAAE,aAAa,CAAA;IACxB,UAAU,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,SAAS,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAA;IAC5F,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAWD,eAAO,MAAM,QAAQ,GAAI,+KAkBtB,aAAa,iHAiRf,CAAA"}
@@ -0,0 +1,6 @@
1
+ import { ReactNode } from 'react';
2
+ export type NotebookTrayProps = {
3
+ children: ReactNode;
4
+ };
5
+ export declare const NotebookTray: ({ children }: NotebookTrayProps) => import("react/jsx-runtime").JSX.Element;
6
+ //# sourceMappingURL=NotebookTray.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NotebookTray.d.ts","sourceRoot":"","sources":["../src/NotebookTray.tsx"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAItC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,SAAS,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,YAAY,GAAI,cAAc,iBAAiB,4CAgC3D,CAAA"}
@@ -0,0 +1,30 @@
1
+ import { ReactNode } from 'react';
2
+ import { HighlightTheme } from './highlighter';
3
+ import { NoteCardTheme } from './NoteCard';
4
+ import { NoteType, PageInfoType, REACTION_TYPE } from './types';
5
+ export type NotesListViewProps = {
6
+ notes: NoteType[];
7
+ isLoading: boolean;
8
+ isError: boolean;
9
+ pageInfo?: PageInfoType;
10
+ onPreviousPage: () => void;
11
+ onNextPage: () => void;
12
+ onNoteSelect?: (noteId: string) => void;
13
+ onNoteDelete?: (noteId: string) => void;
14
+ onNoteSave?: (noteId: string, text: string) => void;
15
+ onNoteTypeChange?: (noteId: string, type: REACTION_TYPE) => void;
16
+ selectedNoteId?: string;
17
+ hasActiveFilter?: boolean;
18
+ columnCount?: number;
19
+ highlightTheme: HighlightTheme;
20
+ cardTheme: NoteCardTheme;
21
+ locale?: string;
22
+ renderNoteLink?: (props: {
23
+ href: string;
24
+ children: ReactNode;
25
+ ariaLabel?: string;
26
+ }) => ReactNode;
27
+ noteHref?: (noteId: string, note: NoteType) => string;
28
+ };
29
+ export declare const NotesListView: ({ notes, isLoading, isError, pageInfo, onPreviousPage, onNextPage, onNoteSelect, onNoteDelete, onNoteSave, onNoteTypeChange, selectedNoteId, hasActiveFilter, columnCount, highlightTheme, cardTheme, locale, renderNoteLink, noteHref, }: NotesListViewProps) => import("react/jsx-runtime").JSX.Element;
30
+ //# sourceMappingURL=NotesListView.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"NotesListView.d.ts","sourceRoot":"","sources":["../src/NotesListView.tsx"],"names":[],"mappings":"AAOA,OAAO,EAAsB,KAAK,SAAS,EAAW,MAAM,OAAO,CAAA;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,EAAY,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AAEzD,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEzE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE,QAAQ,EAAE,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,OAAO,CAAA;IAChB,QAAQ,CAAC,EAAE,YAAY,CAAA;IACvB,cAAc,EAAE,MAAM,IAAI,CAAA;IAC1B,UAAU,EAAE,MAAM,IAAI,CAAA;IACtB,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACvC,YAAY,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;IACvC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IACnD,gBAAgB,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,KAAK,IAAI,CAAA;IAChE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;IAC9B,SAAS,EAAE,aAAa,CAAA;IACxB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,cAAc,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,SAAS,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,SAAS,CAAA;IAChG,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,KAAK,MAAM,CAAA;CACtD,CAAA;AA2BD,eAAO,MAAM,aAAa,GAAI,2OAmB3B,kBAAkB,4CAwGpB,CAAA"}
@@ -0,0 +1,15 @@
1
+ import { HighlightTheme } from './highlighter';
2
+ import { REACTION_TYPE } from './types';
3
+ export type SingleNoteProps = {
4
+ noteText?: string;
5
+ reaction: REACTION_TYPE;
6
+ highlightText?: string | null;
7
+ highlightTheme: HighlightTheme;
8
+ onSave: (text: string) => void;
9
+ onDelete?: () => void;
10
+ onTypeChange?: (type: REACTION_TYPE) => void;
11
+ onBack?: () => void;
12
+ editing?: boolean;
13
+ };
14
+ export declare const SingleNote: ({ noteText, reaction, highlightText, highlightTheme, onSave, onDelete, onTypeChange, onBack, editing, }: SingleNoteProps) => import("react/jsx-runtime").JSX.Element;
15
+ //# sourceMappingURL=SingleNote.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SingleNote.d.ts","sourceRoot":"","sources":["../src/SingleNote.tsx"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AAGnD,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAEvC,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,aAAa,CAAA;IACvB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,cAAc,EAAE,cAAc,CAAA;IAC9B,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;IAC9B,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAA;IACrB,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,CAAA;IAC5C,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED,eAAO,MAAM,UAAU,GAAI,yGAUxB,eAAe,4CAgJjB,CAAA"}
package/dist/index.d.ts CHANGED
@@ -1,19 +1,17 @@
1
+ export { ContentWithNoteWrapper, type ContentWithNoteWrapperProps, } from './ContentWithNoteWrapper';
1
2
  export { Highlight, HighlightError, type HighlightProps } from './Highlight';
2
- export { addHighlight, createTransparentColor, type DomHighlightConfig, type HighlightTheme, removeHighlights, } from './highlighter';
3
+ export { createTransparentColor, type DomHighlightConfig, type HighlightTheme, } from './highlighter';
3
4
  export { useCreateNote } from './hooks/useCreateNote';
4
5
  export { useDeleteNote } from './hooks/useDeleteNote';
5
6
  export { type UseGetNotesOptions, useGetNotes } from './hooks/useGetNotes';
6
7
  export { type UpdateNoteParams, useUpdateNote } from './hooks/useUpdateNote';
7
8
  export { type NotebookContextValue, NotebookProvider, type NotebookProviderProps, useNotebook, } from './NotebookProvider';
9
+ export { NotebookTray, type NotebookTrayProps } from './NotebookTray';
8
10
  export { NoteCard, type NoteCardProps, type NoteCardTheme } from './NoteCard';
9
11
  export { NoteChip, type NoteChipProps } from './NoteChip';
10
12
  export { NoteReactionMenu, type NoteReactionMenuProps } from './NoteReactionMenu';
11
- export { RangeAnchor } from './RangeAnchor';
12
- export { TextPosition } from './TextPosition';
13
- export { TextPositionAnchor } from './TextPositionAnchor';
14
- export { TextRange } from './TextRange';
13
+ export { NotesListView, type NotesListViewProps } from './NotesListView';
14
+ export { SingleNote, type SingleNoteProps } from './SingleNote';
15
15
  export { type NotebookTranslations, type TranslateFunction, useNotebookTranslations, } from './TranslationsContext';
16
16
  export { type CreateNoteInputType, type CreateNoteResponseType, type DeleteNoteResponseType, type GetNotesInputType, type GetNotesParams, type HighlightDataType, type NotebookAnalyticsEvent, type NotebookApi, type NoteConnectionType, type NoteType, type PageInfoType, type PaginatedNotes, type PaginationDirection, type RangeSelectorType, REACTION_TYPE, type TextPositionSelectorType, type UpdateNoteInputType, type UpdateNoteResponseType, } from './types';
17
- export { getPlacement, isOverlapping, recoverHighlights, scrollToHighlight, } from './utils';
18
- export { nodeFromXPath, xpathFromNode } from './xpath';
19
17
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5E,OAAO,EACL,YAAY,EACZ,sBAAsB,EACtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,gBAAgB,GACjB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC1E,OAAO,EAAE,KAAK,gBAAgB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EACL,KAAK,oBAAoB,EACzB,gBAAgB,EAChB,KAAK,qBAAqB,EAC1B,WAAW,GACZ,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AAC7E,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AACjF,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,uBAAuB,GACxB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,aAAa,EACb,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,SAAS,CAAA;AAChB,OAAO,EACL,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,KAAK,2BAA2B,GACjC,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,KAAK,cAAc,EAAE,MAAM,aAAa,CAAA;AAC5E,OAAO,EACL,sBAAsB,EACtB,KAAK,kBAAkB,EACvB,KAAK,cAAc,GACpB,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,EAAE,KAAK,kBAAkB,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAA;AAC1E,OAAO,EAAE,KAAK,gBAAgB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EACL,KAAK,oBAAoB,EACzB,gBAAgB,EAChB,KAAK,qBAAqB,EAC1B,WAAW,GACZ,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,KAAK,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACrE,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AAC7E,OAAO,EAAE,QAAQ,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAA;AACzD,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AACjF,OAAO,EAAE,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AACxE,OAAO,EAAE,UAAU,EAAE,KAAK,eAAe,EAAE,MAAM,cAAc,CAAA;AAC/D,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,iBAAiB,EACtB,uBAAuB,GACxB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EACL,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,sBAAsB,EAC3B,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,aAAa,EACb,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,SAAS,CAAA"}