@speakableio/core 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,90 @@
+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 } from 'firebase/firestore';
+import { FirebaseFirestoreTypes } from '@react-native-firebase/firestore';
+
+interface AssignmentWithId extends Assignment {
+    ltiLineItemId: null;
+    id: string;
+}
+interface Assignment {
+    name: string;
+    scheduledTime: string | null;
+    dueTime?: {
+        hours: number;
+        minutes: number;
+        nanos: number;
+    };
+    speakableio: boolean;
+    owners: string[];
+    image: {
+        path: string | null;
+        url: string;
+    };
+    dueDate: {
+        day: number;
+        month: number;
+        year: number;
+    };
+    teacherName: string;
+    courseWorkId: string | null;
+    dueDateTimestamp: {
+        seconds: number;
+        nanoseconds: number;
+    };
+    scheduledTimeTimestamp: number;
+    active: boolean;
+    voice: string | null;
+    setId: string;
+    dateMade: {
+        seconds: number;
+        nanoseconds: number;
+    };
+    maxPoints: number;
+    courseId: string;
+    isAssessment: boolean;
+    isAvailable: boolean;
+}
+type AssignmentAnalyticsType = 'macro' | 'gradebook' | 'cards' | 'student' | 'student_summary';
+
+type FirebaseInstance = FirebaseFirestoreTypes.Module | Firestore;
+type FirestoreDB = Firestore;
+type FirestoreHelpers = typeof firebase_firestore;
+
+declare const createAssignmentRepo: (db: FirestoreDB, h: FirestoreHelpers) => {
+    get(id: string): Promise<AssignmentWithId | null>;
+    list(): Promise<AssignmentWithId[]>;
+};
+
+declare const assignmentQueryKeys: {
+    all: readonly ["assignments"];
+    byId: (id: string) => readonly ["assignments", string];
+    list: () => readonly ["assignments", "list"];
+};
+declare function useAssignment(id: string): _tanstack_react_query.UseQueryResult<AssignmentWithId | null, Error>;
+
+type FsClient = ReturnType<typeof createFsClient>;
+declare function createFsClient(db: FirebaseInstance, platform: 'web' | 'native'): Promise<{
+    assignmentRepo: {
+        get(id: string): Promise<AssignmentWithId | null>;
+        list(): Promise<AssignmentWithId[]>;
+    };
+}>;
+
+interface FsContext {
+    fs: Awaited<FsClient>;
+    queryClient: QueryClient;
+}
+declare const FsCtx: React.Context<FsContext | null>;
+declare function SpeakableProvider({ db, platform, children, queryClient, }: {
+    db: FirebaseInstance;
+    platform: 'web' | 'native';
+    children: React.ReactNode;
+    queryClient: QueryClient;
+}): react_jsx_runtime.JSX.Element | null;
+declare function useFs(): FsContext;
+
+export { type Assignment, type AssignmentAnalyticsType, type AssignmentWithId, type FsClient, FsCtx, SpeakableProvider, assignmentQueryKeys, createAssignmentRepo, createFsClient, useAssignment, useFs };

package/dist/index.d.ts

@@ -0,0 +1,90 @@
+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 } from 'firebase/firestore';
+import { FirebaseFirestoreTypes } from '@react-native-firebase/firestore';
+
+interface AssignmentWithId extends Assignment {
+    ltiLineItemId: null;
+    id: string;
+}
+interface Assignment {
+    name: string;
+    scheduledTime: string | null;
+    dueTime?: {
+        hours: number;
+        minutes: number;
+        nanos: number;
+    };
+    speakableio: boolean;
+    owners: string[];
+    image: {
+        path: string | null;
+        url: string;
+    };
+    dueDate: {
+        day: number;
+        month: number;
+        year: number;
+    };
+    teacherName: string;
+    courseWorkId: string | null;
+    dueDateTimestamp: {
+        seconds: number;
+        nanoseconds: number;
+    };
+    scheduledTimeTimestamp: number;
+    active: boolean;
+    voice: string | null;
+    setId: string;
+    dateMade: {
+        seconds: number;
+        nanoseconds: number;
+    };
+    maxPoints: number;
+    courseId: string;
+    isAssessment: boolean;
+    isAvailable: boolean;
+}
+type AssignmentAnalyticsType = 'macro' | 'gradebook' | 'cards' | 'student' | 'student_summary';
+
+type FirebaseInstance = FirebaseFirestoreTypes.Module | Firestore;
+type FirestoreDB = Firestore;
+type FirestoreHelpers = typeof firebase_firestore;
+
+declare const createAssignmentRepo: (db: FirestoreDB, h: FirestoreHelpers) => {
+    get(id: string): Promise<AssignmentWithId | null>;
+    list(): Promise<AssignmentWithId[]>;
+};
+
+declare const assignmentQueryKeys: {
+    all: readonly ["assignments"];
+    byId: (id: string) => readonly ["assignments", string];
+    list: () => readonly ["assignments", "list"];
+};
+declare function useAssignment(id: string): _tanstack_react_query.UseQueryResult<AssignmentWithId | null, Error>;
+
+type FsClient = ReturnType<typeof createFsClient>;
+declare function createFsClient(db: FirebaseInstance, platform: 'web' | 'native'): Promise<{
+    assignmentRepo: {
+        get(id: string): Promise<AssignmentWithId | null>;
+        list(): Promise<AssignmentWithId[]>;
+    };
+}>;
+
+interface FsContext {
+    fs: Awaited<FsClient>;
+    queryClient: QueryClient;
+}
+declare const FsCtx: React.Context<FsContext | null>;
+declare function SpeakableProvider({ db, platform, children, queryClient, }: {
+    db: FirebaseInstance;
+    platform: 'web' | 'native';
+    children: React.ReactNode;
+    queryClient: QueryClient;
+}): react_jsx_runtime.JSX.Element | null;
+declare function useFs(): FsContext;
+
+export { type Assignment, type AssignmentAnalyticsType, type AssignmentWithId, type FsClient, FsCtx, SpeakableProvider, assignmentQueryKeys, createAssignmentRepo, createFsClient, useAssignment, useFs };

package/dist/index.js

@@ -0,0 +1,86 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } }// src/providers/SpeakableProvider.tsx
+var _react = require('react');
+
+// src/domains/assignment/assignment.repo.ts
+var createAssignmentRepo = (db, h) => {
+  const { doc, collection, getDoc, getDocs } = h;
+  return {
+    async get(id) {
+      const snap = await getDoc(doc(db, `assignments/${id}`));
+      if (!snap.exists()) return null;
+      const data = snap.data();
+      return { id, ...data };
+    },
+    async list() {
+      const col = collection(db, "assignments");
+      const snap = await getDocs(col);
+      return snap.docs.map((d) => ({ id: d.id, ...d.data() }));
+    }
+  };
+};
+
+// src/domains/assignment/hooks.ts
+var _reactquery = require('@tanstack/react-query');
+var assignmentQueryKeys = {
+  all: ["assignments"],
+  byId: (id) => [...assignmentQueryKeys.all, id],
+  list: () => [...assignmentQueryKeys.all, "list"]
+};
+function useAssignment(id) {
+  const { fs } = useFs();
+  return _reactquery.useQuery.call(void 0, {
+    queryKey: assignmentQueryKeys.byId(id),
+    queryFn: () => fs.assignmentRepo.get(id)
+  });
+}
+
+// src/lib/create-firebase-client.ts
+async function createFsClient(db, platform) {
+  const dbAsFirestore = db;
+  const helpers = platform === "web" ? await Promise.resolve().then(() => _interopRequireWildcard(require("firebase/firestore"))) : await Promise.resolve().then(() => _interopRequireWildcard(require("@react-native-firebase/firestore")));
+  return {
+    assignmentRepo: createAssignmentRepo(dbAsFirestore, helpers)
+  };
+}
+
+// src/providers/SpeakableProvider.tsx
+var _jsxruntime = require('react/jsx-runtime');
+var FsCtx = _react.createContext.call(void 0, null);
+function SpeakableProvider({
+  db,
+  platform,
+  children,
+  queryClient
+}) {
+  const [fs, setFs] = _react.useState.call(void 0, null);
+  _react.useEffect.call(void 0, () => {
+    createFsClient(db, platform).then((repos) => {
+      setFs(repos);
+    });
+  }, [db, platform]);
+  if (!fs) return null;
+  return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, 
+    FsCtx.Provider,
+    {
+      value: {
+        fs,
+        queryClient
+      },
+      children
+    }
+  );
+}
+function useFs() {
+  const ctx = _react.useContext.call(void 0, FsCtx);
+  if (!ctx) throw new Error("useFs must be used within a SpeakableProvider");
+  return ctx;
+}
+
+
+
+
+
+
+
+
+exports.FsCtx = FsCtx; exports.SpeakableProvider = SpeakableProvider; exports.assignmentQueryKeys = assignmentQueryKeys; exports.createAssignmentRepo = createAssignmentRepo; exports.createFsClient = createFsClient; exports.useAssignment = useAssignment; exports.useFs = useFs;

package/dist/index.mjs

@@ -0,0 +1,86 @@
+// src/providers/SpeakableProvider.tsx
+import { createContext, useContext, useEffect, useState } from "react";
+
+// src/domains/assignment/assignment.repo.ts
+var createAssignmentRepo = (db, h) => {
+  const { doc, collection, getDoc, getDocs } = h;
+  return {
+    async get(id) {
+      const snap = await getDoc(doc(db, `assignments/${id}`));
+      if (!snap.exists()) return null;
+      const data = snap.data();
+      return { id, ...data };
+    },
+    async list() {
+      const col = collection(db, "assignments");
+      const snap = await getDocs(col);
+      return snap.docs.map((d) => ({ id: d.id, ...d.data() }));
+    }
+  };
+};
+
+// src/domains/assignment/hooks.ts
+import { useQuery } from "@tanstack/react-query";
+var assignmentQueryKeys = {
+  all: ["assignments"],
+  byId: (id) => [...assignmentQueryKeys.all, id],
+  list: () => [...assignmentQueryKeys.all, "list"]
+};
+function useAssignment(id) {
+  const { fs } = useFs();
+  return useQuery({
+    queryKey: assignmentQueryKeys.byId(id),
+    queryFn: () => fs.assignmentRepo.get(id)
+  });
+}
+
+// src/lib/create-firebase-client.ts
+async function createFsClient(db, platform) {
+  const dbAsFirestore = db;
+  const helpers = platform === "web" ? await import("firebase/firestore") : await import("@react-native-firebase/firestore");
+  return {
+    assignmentRepo: createAssignmentRepo(dbAsFirestore, helpers)
+  };
+}
+
+// src/providers/SpeakableProvider.tsx
+import { jsx } from "react/jsx-runtime";
+var FsCtx = createContext(null);
+function SpeakableProvider({
+  db,
+  platform,
+  children,
+  queryClient
+}) {
+  const [fs, setFs] = useState(null);
+  useEffect(() => {
+    createFsClient(db, platform).then((repos) => {
+      setFs(repos);
+    });
+  }, [db, platform]);
+  if (!fs) return null;
+  return /* @__PURE__ */ jsx(
+    FsCtx.Provider,
+    {
+      value: {
+        fs,
+        queryClient
+      },
+      children
+    }
+  );
+}
+function useFs() {
+  const ctx = useContext(FsCtx);
+  if (!ctx) throw new Error("useFs must be used within a SpeakableProvider");
+  return ctx;
+}
+export {
+  FsCtx,
+  SpeakableProvider,
+  assignmentQueryKeys,
+  createAssignmentRepo,
+  createFsClient,
+  useAssignment,
+  useFs
+};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@speakableio/core",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Speakable-io/speakable-core.git"
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "devDependencies": {
+    "react": "^18.2.0",
+    "@types/react": "^18",
+    "@react-native-firebase/firestore": ">=21",
+    "@types/firebase": "^3.2.1",
+    "firebase": "^10.1.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.5.0",
+    "vitest": "^1.5.0",
+    "@typescript-eslint/eslint-plugin": "^7.10.0",
+    "@typescript-eslint/parser": "^7.10.0",
+    "@vercel/style-guide": "^6.0.0",
+    "@vitejs/plugin-react": "^3.1.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.6",
+    "prettier": "^3.2.5"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "firebase": "^10.1.0",
+    "@react-native-firebase/app": ">=21",
+    "@react-native-firebase/firestore": ">=21",
+    "@tanstack/react-query": "^5.54.1"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "bugs": {
+    "url": "https://github.com/Speakable-io/speakable-core/issues"
+  },
+  "description": "Shared data layer for Speakable web & mobile",
+  "files": ["dist"],
+  "homepage": "https://github.com/Speakable-io/speakable-core#readme",
+  "license": "UNLICENSED",
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --dts --format esm,cjs --splitting",
+    "dev":   "tsup src/index.ts --watch --dts --format esm,cjs --out-dir dist",
+    "test": "vitest"
+  },  
+  "types": "dist/index.d.ts"
+}