@speakableio/core 0.1.20 → 0.1.22

package/dist/index.d.mts

@@ -2,10 +2,12 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient } from '@tanstack/react-query';
+import * as firebase_firestore from 'firebase/firestore';
 import { Firestore, Timestamp as Timestamp$1, FieldValue } from 'firebase/firestore';
 import { FirebaseFirestoreTypes, Timestamp } from '@react-native-firebase/firestore';
 
 type FirebaseInstance = FirebaseFirestoreTypes.Module | Firestore;
+type FirestoreHelpers = typeof firebase_firestore;
 type CustomTimestamp = Timestamp | Timestamp$1;
 type CallableFunction<T = any, R = any> = (data: T) => Promise<R>;
 
@@ -728,12 +730,13 @@ declare const useCreateNotification: () => {
     createNotification: (type: SpeakableNotificationType, data: any) => Promise<any>;
 };
 
-type FsClient = ReturnType<typeof createFsClient>;
-declare function createFsClient({ db, platform, httpsCallable, }: {
+type FsClient = ReturnType<typeof createFsClientBase>;
+declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
     db: FirebaseInstance;
-    platform: 'web' | 'native';
+    helpers: FirestoreHelpers;
     httpsCallable: (name: string) => CallableFunction;
-}): Promise<{
+    logEvent: (name: string, data: any) => void;
+}): {
     assignmentRepo: {
         getAssignment: (params: {
             assignmentId: string;
@@ -908,7 +911,7 @@ declare function createFsClient({ db, platform, httpsCallable, }: {
             cardId: string;
         }) => Promise<CardActivityWithId | null>;
     };
-}>;
+};
 
 interface UserProfile {
     googleClassroomUserId: string;
@@ -969,21 +972,24 @@ interface FsContext {
     permissions: Permissions;
 }
 declare const FsCtx: React.Context<FsContext | null>;
-declare function SpeakableProvider({ db, platform, children, queryClient, user, permissions, httpsCallable, }: {
-    user: User;
-    db: FirebaseInstance;
-    platform: 'web' | 'native';
-    queryClient: QueryClient;
-    permissions: Permissions;
-    httpsCallable: (name: string) => CallableFunction;
+declare function SpeakableProvider({ user, children, queryClient, permissions, fsClient, }: {
     children: React.ReactNode;
+    fsClient: FsClient;
+    permissions: Permissions;
+    queryClient: QueryClient;
+    user: User;
 }): react_jsx_runtime.JSX.Element | null;
 declare function useSpeakableApi(): FsContext;
 
-declare function useActivity({ id, isAssignment, onAssignmentSubmitted, }: {
+declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData, }: {
     id: string;
     isAssignment: boolean;
     onAssignmentSubmitted: (assignmentId: string) => void;
+    ltiData?: {
+        lineItemId?: string;
+        lti_id?: string;
+        serviceKey?: string;
+    };
 }): {
     set: {
         data: SetWithId | null | undefined;
@@ -1093,9 +1099,16 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, }: {
                 message?: undefined;
             }>;
             updateCard: (cardId: string, cardScore: CardScore) => void;
-            logGradingStandardEntry: () => void;
+            logGradingStandardEntry: ({ cardId, gradingStandard, type, }: {
+                cardId: string;
+                gradingStandard: {
+                    level: string;
+                    justification: string;
+                };
+                type: "actfl" | "wida" | "custom";
+            }) => void;
         };
     };
 };
 
-export { ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY, type Assignment, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, type CardActivity, CardActivityType, type CardActivityWithId, type CardScore, FeedbackTypesCard, type FsClient, FsCtx, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES, REPEAT_CARD_ACTIVITY_TYPES, RESPOND_AUDIO_CARD_ACTIVITY_TYPES, RESPOND_CARD_ACTIVITY_TYPES, RESPOND_WRITE_CARD_ACTIVITY_TYPES, type RefsCardsFiresotre, type RefsSetsFirestore, SPEAKABLE_NOTIFICATIONS, STUDENT_LEVELS_OPTIONS, type Score, type ScoreWithId, type Set, type SetWithId, type SpeakableNotificationType, SpeakableNotificationTypes, SpeakableProvider, VerificationCardStatus, assignmentQueryKeys, cardsQueryKeys, createAssignmentRepo, createCardRepo, createFsClient, createSetRepo, getCardFromCache, getSetFromCache, refsCardsFiresotre, refsSetsFirestore, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useAssignment, useCards, useCreateCard, useCreateCards, useCreateNotification, useSet, useSpeakableApi };
+export { ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY, type Assignment, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, type CardActivity, CardActivityType, type CardActivityWithId, type CardScore, FeedbackTypesCard, type FsClient, FsCtx, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES, REPEAT_CARD_ACTIVITY_TYPES, RESPOND_AUDIO_CARD_ACTIVITY_TYPES, RESPOND_CARD_ACTIVITY_TYPES, RESPOND_WRITE_CARD_ACTIVITY_TYPES, type RefsCardsFiresotre, type RefsSetsFirestore, SPEAKABLE_NOTIFICATIONS, STUDENT_LEVELS_OPTIONS, type Score, type ScoreWithId, type Set, type SetWithId, type SpeakableNotificationType, SpeakableNotificationTypes, SpeakableProvider, VerificationCardStatus, assignmentQueryKeys, cardsQueryKeys, createAssignmentRepo, createCardRepo, createFsClientBase, createSetRepo, getCardFromCache, getSetFromCache, refsCardsFiresotre, refsSetsFirestore, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useAssignment, useCards, useCreateCard, useCreateCards, useCreateNotification, useSet, useSpeakableApi };

package/dist/index.d.ts

@@ -2,10 +2,12 @@ import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
 import * as _tanstack_react_query from '@tanstack/react-query';
 import { QueryClient } from '@tanstack/react-query';
+import * as firebase_firestore from 'firebase/firestore';
 import { Firestore, Timestamp as Timestamp$1, FieldValue } from 'firebase/firestore';
 import { FirebaseFirestoreTypes, Timestamp } from '@react-native-firebase/firestore';
 
 type FirebaseInstance = FirebaseFirestoreTypes.Module | Firestore;
+type FirestoreHelpers = typeof firebase_firestore;
 type CustomTimestamp = Timestamp | Timestamp$1;
 type CallableFunction<T = any, R = any> = (data: T) => Promise<R>;
 
@@ -728,12 +730,13 @@ declare const useCreateNotification: () => {
     createNotification: (type: SpeakableNotificationType, data: any) => Promise<any>;
 };
 
-type FsClient = ReturnType<typeof createFsClient>;
-declare function createFsClient({ db, platform, httpsCallable, }: {
+type FsClient = ReturnType<typeof createFsClientBase>;
+declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
     db: FirebaseInstance;
-    platform: 'web' | 'native';
+    helpers: FirestoreHelpers;
     httpsCallable: (name: string) => CallableFunction;
-}): Promise<{
+    logEvent: (name: string, data: any) => void;
+}): {
     assignmentRepo: {
         getAssignment: (params: {
             assignmentId: string;
@@ -908,7 +911,7 @@ declare function createFsClient({ db, platform, httpsCallable, }: {
             cardId: string;
         }) => Promise<CardActivityWithId | null>;
     };
-}>;
+};
 
 interface UserProfile {
     googleClassroomUserId: string;
@@ -969,21 +972,24 @@ interface FsContext {
     permissions: Permissions;
 }
 declare const FsCtx: React.Context<FsContext | null>;
-declare function SpeakableProvider({ db, platform, children, queryClient, user, permissions, httpsCallable, }: {
-    user: User;
-    db: FirebaseInstance;
-    platform: 'web' | 'native';
-    queryClient: QueryClient;
-    permissions: Permissions;
-    httpsCallable: (name: string) => CallableFunction;
+declare function SpeakableProvider({ user, children, queryClient, permissions, fsClient, }: {
     children: React.ReactNode;
+    fsClient: FsClient;
+    permissions: Permissions;
+    queryClient: QueryClient;
+    user: User;
 }): react_jsx_runtime.JSX.Element | null;
 declare function useSpeakableApi(): FsContext;
 
-declare function useActivity({ id, isAssignment, onAssignmentSubmitted, }: {
+declare function useActivity({ id, isAssignment, onAssignmentSubmitted, ltiData, }: {
     id: string;
     isAssignment: boolean;
     onAssignmentSubmitted: (assignmentId: string) => void;
+    ltiData?: {
+        lineItemId?: string;
+        lti_id?: string;
+        serviceKey?: string;
+    };
 }): {
     set: {
         data: SetWithId | null | undefined;
@@ -1093,9 +1099,16 @@ declare function useActivity({ id, isAssignment, onAssignmentSubmitted, }: {
                 message?: undefined;
             }>;
             updateCard: (cardId: string, cardScore: CardScore) => void;
-            logGradingStandardEntry: () => void;
+            logGradingStandardEntry: ({ cardId, gradingStandard, type, }: {
+                cardId: string;
+                gradingStandard: {
+                    level: string;
+                    justification: string;
+                };
+                type: "actfl" | "wida" | "custom";
+            }) => void;
         };
     };
 };
 
-export { ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY, type Assignment, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, type CardActivity, CardActivityType, type CardActivityWithId, type CardScore, FeedbackTypesCard, type FsClient, FsCtx, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES, REPEAT_CARD_ACTIVITY_TYPES, RESPOND_AUDIO_CARD_ACTIVITY_TYPES, RESPOND_CARD_ACTIVITY_TYPES, RESPOND_WRITE_CARD_ACTIVITY_TYPES, type RefsCardsFiresotre, type RefsSetsFirestore, SPEAKABLE_NOTIFICATIONS, STUDENT_LEVELS_OPTIONS, type Score, type ScoreWithId, type Set, type SetWithId, type SpeakableNotificationType, SpeakableNotificationTypes, SpeakableProvider, VerificationCardStatus, assignmentQueryKeys, cardsQueryKeys, createAssignmentRepo, createCardRepo, createFsClient, createSetRepo, getCardFromCache, getSetFromCache, refsCardsFiresotre, refsSetsFirestore, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useAssignment, useCards, useCreateCard, useCreateCards, useCreateNotification, useSet, useSpeakableApi };
+export { ALLOWED_CARD_ACTIVITY_TYPES_FOR_SUMMARY, type Assignment, type AssignmentWithId, BASE_MULTIPLE_CHOICE_FIELD_VALUES, BASE_REPEAT_FIELD_VALUES, BASE_RESPOND_FIELD_VALUES, type CardActivity, CardActivityType, type CardActivityWithId, type CardScore, FeedbackTypesCard, type FsClient, FsCtx, LENIENCY_OPTIONS, LeniencyCard, MULTIPLE_CHOICE_CARD_ACTIVITY_TYPES, REPEAT_CARD_ACTIVITY_TYPES, RESPOND_AUDIO_CARD_ACTIVITY_TYPES, RESPOND_CARD_ACTIVITY_TYPES, RESPOND_WRITE_CARD_ACTIVITY_TYPES, type RefsCardsFiresotre, type RefsSetsFirestore, SPEAKABLE_NOTIFICATIONS, STUDENT_LEVELS_OPTIONS, type Score, type ScoreWithId, type Set, type SetWithId, type SpeakableNotificationType, SpeakableNotificationTypes, SpeakableProvider, VerificationCardStatus, assignmentQueryKeys, cardsQueryKeys, createAssignmentRepo, createCardRepo, createFsClientBase, createSetRepo, getCardFromCache, getSetFromCache, refsCardsFiresotre, refsSetsFirestore, setsQueryKeys, updateCardInCache, updateSetInCache, useActivity, useAssignment, useCards, useCreateCard, useCreateCards, useCreateNotification, useSet, useSpeakableApi };