@instructure/platform-notebook 1.7.0 → 1.8.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.
@@ -1,5 +1,6 @@
1
1
  import { RefObject } from 'react';
2
2
  import { HighlightTheme } from './highlighter';
3
+ import { NoteType } from './types';
3
4
  export interface ContentWithNoteWrapperProps {
4
5
  containerRef: RefObject<HTMLElement | null>;
5
6
  highlightTheme: HighlightTheme;
@@ -7,6 +8,7 @@ export interface ContentWithNoteWrapperProps {
7
8
  onCreateError?: (error: Error) => void;
8
9
  onUpdateError?: (error: Error) => void;
9
10
  onDeleteError?: (error: Error) => void;
11
+ onNoteCreate?: (note: NoteType) => void;
10
12
  }
11
- export declare function ContentWithNoteWrapper({ containerRef, highlightTheme, debounceTime, onCreateError, onUpdateError, onDeleteError, }: ContentWithNoteWrapperProps): import('react').ReactPortal | null;
13
+ export declare function ContentWithNoteWrapper({ containerRef, highlightTheme, debounceTime, onCreateError, onUpdateError, onDeleteError, onNoteCreate, }: ContentWithNoteWrapperProps): import('react').ReactPortal | null;
12
14
  //# sourceMappingURL=ContentWithNoteWrapper.d.ts.map
@@ -1 +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;AAsB1F,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAC3C,cAAc,EAAE,cAAc,CAAA;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IACtC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IACtC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;CACvC;AAID,wBAAgB,sBAAsB,CAAC,EACrC,YAAY,EACZ,cAAc,EACd,YAAkB,EAClB,aAAa,EACb,aAAa,EACb,aAAa,GACd,EAAE,2BAA2B,sCAuS7B"}
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;AAY1F,OAAO,KAAK,EAAE,QAAQ,EAA4B,MAAM,SAAS,CAAA;AAUjE,MAAM,WAAW,2BAA2B;IAC1C,YAAY,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IAC3C,cAAc,EAAE,cAAc,CAAA;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IACtC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IACtC,aAAa,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;IACtC,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,IAAI,CAAA;CACxC;AAID,wBAAgB,sBAAsB,CAAC,EACrC,YAAY,EACZ,cAAc,EACd,YAAkB,EAClB,aAAa,EACb,aAAa,EACb,aAAa,EACb,YAAY,GACb,EAAE,2BAA2B,sCAwS7B"}
@@ -1,6 +1,6 @@
1
1
  import { ReactNode } from 'react';
2
2
  import { NotebookTranslationsProviderProps } from './TranslationsContext';
3
- import { NotebookAnalyticsEvent, NotebookApi } from './types';
3
+ import { NotebookApi } from './types';
4
4
  export interface NotebookContextValue {
5
5
  api: NotebookApi;
6
6
  currentUserId: string;
@@ -8,7 +8,6 @@ export interface NotebookContextValue {
8
8
  objectType: string;
9
9
  courseId: string;
10
10
  pageLastModifiedAt?: string;
11
- onAnalyticsEvent?: (event: NotebookAnalyticsEvent) => void;
12
11
  selectedNoteId: string | null;
13
12
  isNoteEditing: boolean;
14
13
  isTrayOpen: boolean;
@@ -25,13 +24,12 @@ export interface NotebookProviderProps {
25
24
  objectType: string;
26
25
  courseId: string;
27
26
  pageLastModifiedAt?: string;
28
- onAnalyticsEvent?: (event: NotebookAnalyticsEvent) => void;
29
27
  onOpen?: () => void;
30
28
  initialNoteId?: string;
31
29
  translations?: NotebookTranslationsProviderProps['translations'];
32
30
  translate?: NotebookTranslationsProviderProps['translate'];
33
31
  children: ReactNode;
34
32
  }
35
- export declare function NotebookProvider({ api, currentUserId, objectId, objectType, courseId, pageLastModifiedAt, onAnalyticsEvent, onOpen, initialNoteId, translations, translate, children, }: NotebookProviderProps): import("react/jsx-runtime").JSX.Element;
33
+ export declare function NotebookProvider({ api, currentUserId, objectId, objectType, courseId, pageLastModifiedAt, onOpen, initialNoteId, translations, translate, children, }: NotebookProviderProps): import("react/jsx-runtime").JSX.Element;
36
34
  export declare function useNotebook(): NotebookContextValue;
37
35
  //# sourceMappingURL=NotebookProvider.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"NotebookProvider.d.ts","sourceRoot":"","sources":["../src/NotebookProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,SAAS,EAA2C,MAAM,OAAO,CAAA;AAC9F,OAAO,EAEL,KAAK,iCAAiC,EACvC,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,sBAAsB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAgDlE,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,WAAW,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAA;IAC1D,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,OAAO,CAAA;IACtB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IACrD,iBAAiB,EAAE,MAAM,IAAI,CAAA;IAC7B,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAA;IACxC,QAAQ,EAAE,MAAM,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB;AAMD,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,WAAW,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,gBAAgB,CAAC,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,IAAI,CAAA;IAC1D,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,iCAAiC,CAAC,cAAc,CAAC,CAAA;IAChE,SAAS,CAAC,EAAE,iCAAiC,CAAC,WAAW,CAAC,CAAA;IAC1D,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,wBAAgB,gBAAgB,CAAC,EAC/B,GAAG,EACH,aAAa,EACb,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,gBAAgB,EAChB,MAAM,EACN,aAAa,EACb,YAAY,EACZ,SAAS,EACT,QAAQ,GACT,EAAE,qBAAqB,2CAkDvB;AAID,wBAAgB,WAAW,IAAI,oBAAoB,CAMlD"}
1
+ {"version":3,"file":"NotebookProvider.d.ts","sourceRoot":"","sources":["../src/NotebookProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAiB,KAAK,SAAS,EAA2C,MAAM,OAAO,CAAA;AAC9F,OAAO,EAEL,KAAK,iCAAiC,EACvC,MAAM,uBAAuB,CAAA;AAC9B,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAgD1C,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,WAAW,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,EAAE,OAAO,CAAA;IACtB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IACrD,iBAAiB,EAAE,MAAM,IAAI,CAAA;IAC7B,UAAU,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,CAAA;IACxC,QAAQ,EAAE,MAAM,IAAI,CAAA;IACpB,SAAS,EAAE,MAAM,IAAI,CAAA;CACtB;AAMD,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,WAAW,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,EAAE,MAAM,CAAA;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,IAAI,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,iCAAiC,CAAC,cAAc,CAAC,CAAA;IAChE,SAAS,CAAC,EAAE,iCAAiC,CAAC,WAAW,CAAC,CAAA;IAC1D,QAAQ,EAAE,SAAS,CAAA;CACpB;AAED,wBAAgB,gBAAgB,CAAC,EAC/B,GAAG,EACH,aAAa,EACb,QAAQ,EACR,UAAU,EACV,QAAQ,EACR,kBAAkB,EAClB,MAAM,EACN,aAAa,EACb,YAAY,EACZ,SAAS,EACT,QAAQ,GACT,EAAE,qBAAqB,2CAuCvB;AAID,wBAAgB,WAAW,IAAI,oBAAoB,CAMlD"}
package/dist/index.d.ts CHANGED
@@ -16,5 +16,5 @@ export { NoteReactionMenu, type NoteReactionMenuProps } from './NoteReactionMenu
16
16
  export { NotesListView, type NotesListViewProps } from './NotesListView';
17
17
  export { SingleNote, type SingleNoteProps } from './SingleNote';
18
18
  export { type NotebookTranslations, NotebookTranslationsProvider, type TranslateFunction, useNotebookTranslations, } from './TranslationsContext';
19
- 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 RangeSelectorType, REACTION_TYPE, type TextPositionSelectorType, type UpdateNoteInputType, type UpdateNoteResponseType, } from './types';
19
+ export { type CreateNoteInputType, type CreateNoteResponseType, type DeleteNoteResponseType, type GetNotesInputType, type GetNotesParams, type HighlightDataType, type NotebookApi, type NoteConnectionType, type NoteType, type PageInfoType, type PaginatedNotes, type RangeSelectorType, REACTION_TYPE, type TextPositionSelectorType, type UpdateNoteInputType, type UpdateNoteResponseType, } from './types';
20
20
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
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,iBAAiB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC3E,OAAO,EAAE,KAAK,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAC1F,OAAO,EAAE,KAAK,gBAAgB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EAAE,kBAAkB,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AACvF,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,MAAM,YAAY,CAAA;AACzD,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,4BAA4B,EAC5B,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,iBAAiB,EACtB,aAAa,EACb,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,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,iBAAiB,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAC3E,OAAO,EAAE,KAAK,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAC1F,OAAO,EAAE,KAAK,gBAAgB,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAA;AAC5E,OAAO,EAAE,kBAAkB,EAAE,KAAK,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AACvF,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,MAAM,YAAY,CAAA;AACzD,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,4BAA4B,EAC5B,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,WAAW,EAChB,KAAK,kBAAkB,EACvB,KAAK,QAAQ,EACb,KAAK,YAAY,EACjB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,aAAa,EACb,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,SAAS,CAAA"}