@instructure/platform-notebook 0.4.1 → 0.4.2

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,55 @@
1
+ import { NotebookApi, REACTION_TYPE } from '../types';
2
+ export type UseNotesDataProps = {
3
+ api: NotebookApi;
4
+ courseId?: string;
5
+ enableCourseFilter?: boolean;
6
+ learningObject?: {
7
+ type: string;
8
+ id: string;
9
+ };
10
+ pageSize?: number;
11
+ };
12
+ export declare function useNotesData({ api, courseId, enableCourseFilter, learningObject, pageSize, }: UseNotesDataProps): {
13
+ notes: {
14
+ id: string;
15
+ rootAccountUuid: string;
16
+ userId: string;
17
+ courseId: string;
18
+ objectId: string;
19
+ objectType: string;
20
+ reaction: REACTION_TYPE[];
21
+ highlightData: {
22
+ selectedText: string;
23
+ textPosition: {
24
+ start: number;
25
+ end: number;
26
+ } | null;
27
+ range: {
28
+ startContainer: string;
29
+ endContainer: string;
30
+ startOffset: number;
31
+ endOffset: number;
32
+ } | null;
33
+ pageLastModifiedAt: string;
34
+ hasNoHighlightAnymore?: boolean | undefined;
35
+ };
36
+ createdAt: string;
37
+ updatedAt: string;
38
+ userText?: string | undefined;
39
+ }[];
40
+ pageInfo: {
41
+ startCursor?: string | null | undefined;
42
+ endCursor?: string | null | undefined;
43
+ hasNextPage?: boolean | null | undefined;
44
+ hasPreviousPage?: boolean | null | undefined;
45
+ } | undefined;
46
+ isLoading: boolean;
47
+ isError: boolean;
48
+ filter: REACTION_TYPE | null;
49
+ courseFilter: string | null;
50
+ setFilter: (newFilter: REACTION_TYPE | null) => void;
51
+ setCourseFilter: (newCourseFilter: string | null) => void;
52
+ fetchNextPage: () => void;
53
+ fetchPreviousPage: () => void;
54
+ };
55
+ //# sourceMappingURL=useNotesData.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useNotesData.d.ts","sourceRoot":"","sources":["../../src/hooks/useNotesData.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAqC,MAAM,UAAU,CAAA;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAyCxC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,WAAW,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B,cAAc,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,wBAAgB,YAAY,CAAC,EAC3B,GAAG,EACH,QAAQ,EACR,kBAA0B,EAC1B,cAAc,EACd,QAAa,GACd,EAAE,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAkDwB,aAAa,GAAG,IAAI;uCAIR,MAAM,GAAG,IAAI;;;EAgBpE"}
package/dist/index.d.ts CHANGED
@@ -4,6 +4,7 @@ export { createTransparentColor, type DomHighlightConfig, type HighlightTheme, }
4
4
  export { useCreateNote } from './hooks/useCreateNote';
5
5
  export { useDeleteNote } from './hooks/useDeleteNote';
6
6
  export { type UseGetNotesOptions, useGetNotes } from './hooks/useGetNotes';
7
+ export { type UseNotesDataProps, useNotesData } from './hooks/useNotesData';
7
8
  export { type UpdateNoteParams, useUpdateNote } from './hooks/useUpdateNote';
8
9
  export { type NotebookContextValue, NotebookProvider, type NotebookProviderProps, useNotebook, } from './NotebookProvider';
9
10
  export { NotebookTray, type NotebookTrayProps } from './NotebookTray';
@@ -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,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,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,mBAAmB,EACxB,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,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,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,mBAAmB,EACxB,KAAK,iBAAiB,EACtB,aAAa,EACb,KAAK,wBAAwB,EAC7B,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,GAC5B,MAAM,SAAS,CAAA"}