@instructure/platform-notebook 0.4.0 → 0.4.2

package/dist/hooks/useNotesData.d.ts

@@ -0,0 +1,55 @@
+import { NotebookApi, REACTION_TYPE } from '../types';
+export type UseNotesDataProps = {
+    api: NotebookApi;
+    courseId?: string;
+    enableCourseFilter?: boolean;
+    learningObject?: {
+        type: string;
+        id: string;
+    };
+    pageSize?: number;
+};
+export declare function useNotesData({ api, courseId, enableCourseFilter, learningObject, pageSize, }: UseNotesDataProps): {
+    notes: {
+        id: string;
+        rootAccountUuid: string;
+        userId: string;
+        courseId: string;
+        objectId: string;
+        objectType: string;
+        reaction: REACTION_TYPE[];
+        highlightData: {
+            selectedText: string;
+            textPosition: {
+                start: number;
+                end: number;
+            } | null;
+            range: {
+                startContainer: string;
+                endContainer: string;
+                startOffset: number;
+                endOffset: number;
+            } | null;
+            pageLastModifiedAt: string;
+            hasNoHighlightAnymore?: boolean | undefined;
+        };
+        createdAt: string;
+        updatedAt: string;
+        userText?: string | undefined;
+    }[];
+    pageInfo: {
+        startCursor?: string | null | undefined;
+        endCursor?: string | null | undefined;
+        hasNextPage?: boolean | null | undefined;
+        hasPreviousPage?: boolean | null | undefined;
+    } | undefined;
+    isLoading: boolean;
+    isError: boolean;
+    filter: REACTION_TYPE | null;
+    courseFilter: string | null;
+    setFilter: (newFilter: REACTION_TYPE | null) => void;
+    setCourseFilter: (newCourseFilter: string | null) => void;
+    fetchNextPage: () => void;
+    fetchPreviousPage: () => void;
+};
+//# sourceMappingURL=useNotesData.d.ts.map

package/dist/hooks/useNotesData.d.ts.map

@@ -0,0 +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

@@ -4,6 +4,7 @@ export { createTransparentColor, type DomHighlightConfig, type HighlightTheme, }
 export { useCreateNote } from './hooks/useCreateNote';
 export { useDeleteNote } from './hooks/useDeleteNote';
 export { type UseGetNotesOptions, useGetNotes } from './hooks/useGetNotes';
+export { type UseNotesDataProps, useNotesData } from './hooks/useNotesData';
 export { type UpdateNoteParams, useUpdateNote } from './hooks/useUpdateNote';
 export { type NotebookContextValue, NotebookProvider, type NotebookProviderProps, useNotebook, } from './NotebookProvider';
 export { NotebookTray, type NotebookTrayProps } from './NotebookTray';
@@ -12,6 +13,6 @@ export { NoteChip, type NoteChipProps } from './NoteChip';
 export { NoteReactionMenu, type NoteReactionMenuProps } from './NoteReactionMenu';
 export { NotesListView, type NotesListViewProps } from './NotesListView';
 export { SingleNote, type SingleNoteProps } from './SingleNote';
-export { type NotebookTranslations, type TranslateFunction, useNotebookTranslations, } from './TranslationsContext';
+export { type NotebookTranslations, NotebookTranslationsProvider, type TranslateFunction, useNotebookTranslations, } from './TranslationsContext';
 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';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -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,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"}
+{"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"}