@speakableio/core 0.1.106 → 1.0.0

package/dist/index.web.d.ts

@@ -1,9 +1,14 @@
 import { V as VerificationCardStatus } from './card.constants-DhKFipX3.js';
-import { F as FirebaseInstance, a as FirestoreHelpers, C as CallableFunction, A as AssignmentWithId, b as CustomTimestamp, c as ActivityPageType, P as PageActivity, d as PageActivityWithId } from './assignment.model-DLMWAp0Y.js';
+import { F as FirebaseInstance, c as FirestoreHelpers, d as CallableFunction, A as AssignmentWithId, C as CustomTimestamp, a as ActivityPageType, P as PageActivity, b as PageActivityWithId } from './assignment.model-Bm9gE2YK.js';
 import { A as AssignmentAnalyticsType } from './assignment.constants-BIKM6fYi.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { QueryClient } from '@tanstack/react-query';
+import { S as SpeakablePlanTypes } from './speakable-plans-BjWWEWrQ.js';
 import '@react-native-firebase/firestore';
 import 'firebase/firestore';
 
+type FsClient = ReturnType<typeof createFsClientBase>;
 type FsClientParams = Omit<Parameters<typeof createFsClientBase>[0], 'helpers'>;
 declare function createFsClientBase({ db, helpers, httpsCallable, logEvent, }: {
     db: FirebaseInstance;
@@ -402,4 +407,65 @@ declare const createFsClientWeb: ({ db, httpsCallable, logEvent }: FsClientParam
     };
 };
 
-export { createFsClientWeb as createFsClient };
+interface UserProfile {
+    googleClassroomUserId: string;
+    image: {
+        url: string;
+        path: string;
+    };
+    displayName: string;
+    isTeacher?: boolean;
+    isStudent?: boolean;
+    roles?: string[];
+}
+interface UserAuth {
+    uid: string;
+    email: string;
+    displayName: string | null;
+}
+interface Lti {
+    data: {
+        services: {
+            serviceKey: string;
+        };
+    };
+}
+interface User {
+    profile: UserProfile;
+    auth: UserAuth;
+    lti: Lti;
+    roles: string[];
+}
+
+interface Permissions {
+    loaded: boolean;
+    loading: boolean;
+    permissions: string[];
+    plan: keyof typeof SpeakablePlanTypes;
+    subscriptionId: string;
+    isInstitutionPlan: boolean;
+    type: string;
+    contact: string;
+    hasStudentPortfolios?: boolean;
+    refreshDate: string;
+    isStripePlan: boolean;
+    freeOrgTrialExpired?: boolean;
+}
+
+interface FsContext {
+    speakableApi: Awaited<FsClient>;
+    queryClient: QueryClient;
+    user: User;
+    permissions: Permissions;
+}
+declare const FsCtx: React.Context<FsContext | null>;
+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;
+
+export { FsCtx, SpeakableProvider, createFsClientWeb as createFsClient, useSpeakableApi };