@speakableio/core 0.1.10 → 0.1.12
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.
- package/dist/index.d.mts +118 -1
- package/dist/index.d.ts +118 -1
- package/dist/index.js +1076 -14
- package/dist/index.mjs +1064 -2
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -979,4 +979,121 @@ declare function SpeakableProvider({ db, platform, children, queryClient, user,
|
|
|
979
979
|
}): react_jsx_runtime.JSX.Element | null;
|
|
980
980
|
declare function useSpeakableApi(): FsContext;
|
|
981
981
|
|
|
982
|
-
|
|
982
|
+
declare function useActivity({ id, isAssignment, onAssignmentSubmitted, }: {
|
|
983
|
+
id: string;
|
|
984
|
+
isAssignment: boolean;
|
|
985
|
+
onAssignmentSubmitted: (assignmentId: string) => void;
|
|
986
|
+
}): {
|
|
987
|
+
set: {
|
|
988
|
+
data: SetWithId | null | undefined;
|
|
989
|
+
query: _tanstack_react_query.UseQueryResult<SetWithId | null, Error>;
|
|
990
|
+
};
|
|
991
|
+
cards: {
|
|
992
|
+
data: Record<string, CardActivityWithId> | null;
|
|
993
|
+
query: _tanstack_react_query.UseQueryResult<CardActivityWithId | null, Error>[];
|
|
994
|
+
};
|
|
995
|
+
assignment: {
|
|
996
|
+
data: AssignmentWithId | {
|
|
997
|
+
scores: any;
|
|
998
|
+
id: string;
|
|
999
|
+
isAvailable: boolean;
|
|
1000
|
+
name: string;
|
|
1001
|
+
description: string;
|
|
1002
|
+
scheduledTime?: string | null;
|
|
1003
|
+
dueTime?: {
|
|
1004
|
+
hours: number;
|
|
1005
|
+
minutes: number;
|
|
1006
|
+
nanos: number;
|
|
1007
|
+
};
|
|
1008
|
+
speakableio: boolean;
|
|
1009
|
+
owners: string[];
|
|
1010
|
+
image: {
|
|
1011
|
+
path: string | null;
|
|
1012
|
+
url: string;
|
|
1013
|
+
};
|
|
1014
|
+
dueDate: {
|
|
1015
|
+
day: number;
|
|
1016
|
+
month: number;
|
|
1017
|
+
year: number;
|
|
1018
|
+
};
|
|
1019
|
+
teacherName: string;
|
|
1020
|
+
courseWorkId: string | null;
|
|
1021
|
+
dueDateTimestamp: CustomTimestamp;
|
|
1022
|
+
scheduledTimeTimestamp: number;
|
|
1023
|
+
active: boolean;
|
|
1024
|
+
voice: string | null;
|
|
1025
|
+
setId: string;
|
|
1026
|
+
dateMade: {
|
|
1027
|
+
seconds: number;
|
|
1028
|
+
nanoseconds: number;
|
|
1029
|
+
};
|
|
1030
|
+
maxPoints: number;
|
|
1031
|
+
courseId: string;
|
|
1032
|
+
isAssessment: boolean;
|
|
1033
|
+
ltiDeeplink?: string;
|
|
1034
|
+
} | null | undefined;
|
|
1035
|
+
query: _tanstack_react_query.UseQueryResult<AssignmentWithId | {
|
|
1036
|
+
scores: any;
|
|
1037
|
+
id: string;
|
|
1038
|
+
isAvailable: boolean;
|
|
1039
|
+
name: string;
|
|
1040
|
+
description: string;
|
|
1041
|
+
scheduledTime?: string | null;
|
|
1042
|
+
dueTime?: {
|
|
1043
|
+
hours: number;
|
|
1044
|
+
minutes: number;
|
|
1045
|
+
nanos: number;
|
|
1046
|
+
};
|
|
1047
|
+
speakableio: boolean;
|
|
1048
|
+
owners: string[];
|
|
1049
|
+
image: {
|
|
1050
|
+
path: string | null;
|
|
1051
|
+
url: string;
|
|
1052
|
+
};
|
|
1053
|
+
dueDate: {
|
|
1054
|
+
day: number;
|
|
1055
|
+
month: number;
|
|
1056
|
+
year: number;
|
|
1057
|
+
};
|
|
1058
|
+
teacherName: string;
|
|
1059
|
+
courseWorkId: string | null;
|
|
1060
|
+
dueDateTimestamp: CustomTimestamp;
|
|
1061
|
+
scheduledTimeTimestamp: number;
|
|
1062
|
+
active: boolean;
|
|
1063
|
+
voice: string | null;
|
|
1064
|
+
setId: string;
|
|
1065
|
+
dateMade: {
|
|
1066
|
+
seconds: number;
|
|
1067
|
+
nanoseconds: number;
|
|
1068
|
+
};
|
|
1069
|
+
maxPoints: number;
|
|
1070
|
+
courseId: string;
|
|
1071
|
+
isAssessment: boolean;
|
|
1072
|
+
ltiDeeplink?: string;
|
|
1073
|
+
} | null, Error>;
|
|
1074
|
+
};
|
|
1075
|
+
scores: {
|
|
1076
|
+
data: ScoreWithId | undefined;
|
|
1077
|
+
query: _tanstack_react_query.UseQueryResult<ScoreWithId, Error>;
|
|
1078
|
+
actions: {
|
|
1079
|
+
update: (data: Partial<Score>) => void;
|
|
1080
|
+
clear: ({ cardId, wasCompleted, }: {
|
|
1081
|
+
cardId: string;
|
|
1082
|
+
wasCompleted?: boolean;
|
|
1083
|
+
}) => void;
|
|
1084
|
+
submit: () => Promise<{
|
|
1085
|
+
success: boolean;
|
|
1086
|
+
message: string;
|
|
1087
|
+
error?: undefined;
|
|
1088
|
+
} | {
|
|
1089
|
+
success: boolean;
|
|
1090
|
+
error: unknown;
|
|
1091
|
+
message?: undefined;
|
|
1092
|
+
}>;
|
|
1093
|
+
updateCard: (cardId: string, cardScore: CardScore) => void;
|
|
1094
|
+
logGradingStandardEntry: () => void;
|
|
1095
|
+
};
|
|
1096
|
+
};
|
|
1097
|
+
};
|
|
1098
|
+
|
|
1099
|
+
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -979,4 +979,121 @@ declare function SpeakableProvider({ db, platform, children, queryClient, user,
|
|
|
979
979
|
}): react_jsx_runtime.JSX.Element | null;
|
|
980
980
|
declare function useSpeakableApi(): FsContext;
|
|
981
981
|
|
|
982
|
-
|
|
982
|
+
declare function useActivity({ id, isAssignment, onAssignmentSubmitted, }: {
|
|
983
|
+
id: string;
|
|
984
|
+
isAssignment: boolean;
|
|
985
|
+
onAssignmentSubmitted: (assignmentId: string) => void;
|
|
986
|
+
}): {
|
|
987
|
+
set: {
|
|
988
|
+
data: SetWithId | null | undefined;
|
|
989
|
+
query: _tanstack_react_query.UseQueryResult<SetWithId | null, Error>;
|
|
990
|
+
};
|
|
991
|
+
cards: {
|
|
992
|
+
data: Record<string, CardActivityWithId> | null;
|
|
993
|
+
query: _tanstack_react_query.UseQueryResult<CardActivityWithId | null, Error>[];
|
|
994
|
+
};
|
|
995
|
+
assignment: {
|
|
996
|
+
data: AssignmentWithId | {
|
|
997
|
+
scores: any;
|
|
998
|
+
id: string;
|
|
999
|
+
isAvailable: boolean;
|
|
1000
|
+
name: string;
|
|
1001
|
+
description: string;
|
|
1002
|
+
scheduledTime?: string | null;
|
|
1003
|
+
dueTime?: {
|
|
1004
|
+
hours: number;
|
|
1005
|
+
minutes: number;
|
|
1006
|
+
nanos: number;
|
|
1007
|
+
};
|
|
1008
|
+
speakableio: boolean;
|
|
1009
|
+
owners: string[];
|
|
1010
|
+
image: {
|
|
1011
|
+
path: string | null;
|
|
1012
|
+
url: string;
|
|
1013
|
+
};
|
|
1014
|
+
dueDate: {
|
|
1015
|
+
day: number;
|
|
1016
|
+
month: number;
|
|
1017
|
+
year: number;
|
|
1018
|
+
};
|
|
1019
|
+
teacherName: string;
|
|
1020
|
+
courseWorkId: string | null;
|
|
1021
|
+
dueDateTimestamp: CustomTimestamp;
|
|
1022
|
+
scheduledTimeTimestamp: number;
|
|
1023
|
+
active: boolean;
|
|
1024
|
+
voice: string | null;
|
|
1025
|
+
setId: string;
|
|
1026
|
+
dateMade: {
|
|
1027
|
+
seconds: number;
|
|
1028
|
+
nanoseconds: number;
|
|
1029
|
+
};
|
|
1030
|
+
maxPoints: number;
|
|
1031
|
+
courseId: string;
|
|
1032
|
+
isAssessment: boolean;
|
|
1033
|
+
ltiDeeplink?: string;
|
|
1034
|
+
} | null | undefined;
|
|
1035
|
+
query: _tanstack_react_query.UseQueryResult<AssignmentWithId | {
|
|
1036
|
+
scores: any;
|
|
1037
|
+
id: string;
|
|
1038
|
+
isAvailable: boolean;
|
|
1039
|
+
name: string;
|
|
1040
|
+
description: string;
|
|
1041
|
+
scheduledTime?: string | null;
|
|
1042
|
+
dueTime?: {
|
|
1043
|
+
hours: number;
|
|
1044
|
+
minutes: number;
|
|
1045
|
+
nanos: number;
|
|
1046
|
+
};
|
|
1047
|
+
speakableio: boolean;
|
|
1048
|
+
owners: string[];
|
|
1049
|
+
image: {
|
|
1050
|
+
path: string | null;
|
|
1051
|
+
url: string;
|
|
1052
|
+
};
|
|
1053
|
+
dueDate: {
|
|
1054
|
+
day: number;
|
|
1055
|
+
month: number;
|
|
1056
|
+
year: number;
|
|
1057
|
+
};
|
|
1058
|
+
teacherName: string;
|
|
1059
|
+
courseWorkId: string | null;
|
|
1060
|
+
dueDateTimestamp: CustomTimestamp;
|
|
1061
|
+
scheduledTimeTimestamp: number;
|
|
1062
|
+
active: boolean;
|
|
1063
|
+
voice: string | null;
|
|
1064
|
+
setId: string;
|
|
1065
|
+
dateMade: {
|
|
1066
|
+
seconds: number;
|
|
1067
|
+
nanoseconds: number;
|
|
1068
|
+
};
|
|
1069
|
+
maxPoints: number;
|
|
1070
|
+
courseId: string;
|
|
1071
|
+
isAssessment: boolean;
|
|
1072
|
+
ltiDeeplink?: string;
|
|
1073
|
+
} | null, Error>;
|
|
1074
|
+
};
|
|
1075
|
+
scores: {
|
|
1076
|
+
data: ScoreWithId | undefined;
|
|
1077
|
+
query: _tanstack_react_query.UseQueryResult<ScoreWithId, Error>;
|
|
1078
|
+
actions: {
|
|
1079
|
+
update: (data: Partial<Score>) => void;
|
|
1080
|
+
clear: ({ cardId, wasCompleted, }: {
|
|
1081
|
+
cardId: string;
|
|
1082
|
+
wasCompleted?: boolean;
|
|
1083
|
+
}) => void;
|
|
1084
|
+
submit: () => Promise<{
|
|
1085
|
+
success: boolean;
|
|
1086
|
+
message: string;
|
|
1087
|
+
error?: undefined;
|
|
1088
|
+
} | {
|
|
1089
|
+
success: boolean;
|
|
1090
|
+
error: unknown;
|
|
1091
|
+
message?: undefined;
|
|
1092
|
+
}>;
|
|
1093
|
+
updateCard: (cardId: string, cardScore: CardScore) => void;
|
|
1094
|
+
logGradingStandardEntry: () => void;
|
|
1095
|
+
};
|
|
1096
|
+
};
|
|
1097
|
+
};
|
|
1098
|
+
|
|
1099
|
+
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 };
|