@concord-consortium/object-storage 1.0.0-pre.4 → 1.0.0-pre.5

package/dist/firebase-object-storage.d.ts

@@ -1,7 +1,17 @@
+import "firebase/compat/auth";
+import "firebase/compat/firestore";
 import { FirebaseObjectStorageConfig, IObjectStorage, ObjectMetadata, ObjectData, StoredObject, ObjectWithId, MonitorCallback, DemonitorFunction, AddOptions } from './types';
 export declare class FirebaseObjectStorage implements IObjectStorage {
     private config;
+    private initPromise;
+    private initialized;
+    private app;
     constructor(config: FirebaseObjectStorageConfig);
+    private initialize;
+    private ensureInitialized;
+    private createDocument;
+    private getPaths;
+    private getRefs;
     /**
      * Lists metadata documents for objects owned by the current user
      */

package/dist/firebase-object-storage.js

@@ -1,18 +1,79 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FirebaseObjectStorage = void 0;
 const nanoid_1 = require("nanoid");
+const app_1 = __importDefault(require("firebase/compat/app"));
+require("firebase/compat/auth");
+require("firebase/compat/firestore");
 class FirebaseObjectStorage {
     constructor(config) {
+        this.initialized = false;
         if (config.version !== 1) {
             throw new Error(`Unsupported config version: ${config.version}. Expected version 1.`);
         }
         this.config = config;
+        this.app = app_1.default.initializeApp(this.config.app);
+        this.app.firestore().settings({
+            ignoreUndefinedProperties: true,
+        });
+        // Start initialization immediately in constructor
+        this.initPromise = this.initialize();
+    }
+    async initialize() {
+        if (this.initialized)
+            return;
+        if (this.config.user.type === "authenticated") {
+            // ensure any previous auth state is cleared before signing in
+            await this.app.auth().signOut();
+            await this.app.auth().signInWithCustomToken(this.config.user.jwt);
+        }
+        this.initialized = true;
+    }
+    async ensureInitialized() {
+        await this.initPromise;
+    }
+    createDocument(contents) {
+        if (this.config.user.type === "authenticated") {
+            const { contextId, platformId, platformUserId, resourceLinkId } = this.config.user;
+            return {
+                created_at: app_1.default.firestore.FieldValue.serverTimestamp(),
+                platform_id: platformId,
+                platform_user_id: platformUserId.toString(),
+                context_id: contextId,
+                resource_link_id: resourceLinkId,
+                run_key: "",
+                ...contents
+            };
+        }
+        else {
+            const { runKey } = this.config.user;
+            return {
+                created_at: app_1.default.firestore.FieldValue.serverTimestamp(),
+                run_key: runKey,
+                platform_user_id: runKey,
+                ...contents
+            };
+        }
+    }
+    getPaths(objectId) {
+        const metadataPath = `${this.config.root}/object_store_metadata/${objectId}`;
+        const dataPath = `${this.config.root}/object_store_data/${objectId}`;
+        return { metadataPath, dataPath };
+    }
+    getRefs(objectId) {
+        const { metadataPath, dataPath } = this.getPaths(objectId);
+        const metadataRef = this.app.firestore().doc(metadataPath);
+        const dataRef = this.app.firestore().doc(dataPath);
+        return { metadataRef, dataRef };
     }
     /**
      * Lists metadata documents for objects owned by the current user
      */
     async listMine() {
+        await this.ensureInitialized();
         // TODO: Implement Firebase query for user's own objects
         return [];
     }
@@ -20,6 +81,7 @@ class FirebaseObjectStorage {
      * Lists metadata documents for objects linked to the current user
      */
     async listLinked() {
+        await this.ensureInitialized();
         // TODO: Implement Firebase query for linked objects
         return [];
     }
@@ -27,6 +89,7 @@ class FirebaseObjectStorage {
      * Lists metadata documents for objects associated with specific question IDs
      */
     async list(questionIds) {
+        await this.ensureInitialized();
         // TODO: Implement Firebase query for objects by question IDs
         return [];
     }
@@ -36,6 +99,7 @@ class FirebaseObjectStorage {
      * Returns a function to stop monitoring
      */
     monitorMine(callback) {
+        // await this.ensureInitialized();
         // TODO: Implement Firebase realtime listener for user's own objects
         callback([]);
         return () => {
@@ -48,6 +112,7 @@ class FirebaseObjectStorage {
      * Returns a function to stop monitoring
      */
     monitorLinked(callback) {
+        // await this.ensureInitialized();
         // TODO: Implement Firebase realtime listener for linked objects
         callback([]);
         return () => {
@@ -60,6 +125,7 @@ class FirebaseObjectStorage {
      * Returns a function to stop monitoring
      */
     monitor(questionIds, callback) {
+        // await this.ensureInitialized();
         // TODO: Implement Firebase realtime listener for objects by question IDs
         callback([]);
         return () => {
@@ -71,16 +137,23 @@ class FirebaseObjectStorage {
      * Returns the generated object ID (nanoid) or the provided ID if specified in options
      */
     async add(object, options) {
-        // TODO: Generate nanoid if not provided in options
-        // TODO: Add metadata document to Firebase
-        // TODO: Add data document to Firebase
-        const newObjectId = options?.id ?? 'placeholder-id';
+        await this.ensureInitialized();
+        const newObjectId = options?.id ?? (0, nanoid_1.nanoid)();
+        const { data, metadata } = object;
+        const { metadataRef, dataRef } = this.getRefs(newObjectId);
+        const dataDoc = this.createDocument({ data });
+        const metadataDoc = this.createDocument({ metadata });
+        const batch = this.app.firestore().batch();
+        batch.set(dataRef, dataDoc);
+        batch.set(metadataRef, metadataDoc);
+        await batch.commit();
         return newObjectId;
     }
     /**
      * Reads both metadata and data documents for an object
      */
     async read(objectId) {
+        await this.ensureInitialized();
         // TODO: Read metadata document from Firebase
         // TODO: Read data document from Firebase
         return {
@@ -92,6 +165,7 @@ class FirebaseObjectStorage {
      * Reads only the metadata document for an object
      */
     async readMetadata(objectId) {
+        await this.ensureInitialized();
         // TODO: Read metadata document from Firebase
         return {};
     }
@@ -99,6 +173,7 @@ class FirebaseObjectStorage {
      * Reads only the data document for an object
      */
     async readData(objectId) {
+        await this.ensureInitialized();
         // TODO: Read data document from Firebase
         return {};
     }

package/dist/index.d.ts

@@ -2,5 +2,5 @@ export { DemoObjectStorage } from './demo-object-storage';
 export { FirebaseObjectStorage } from './firebase-object-storage';
 export { createObjectStorage } from './object-storage';
 export { ObjectStorageProvider, useObjectStorage } from './object-storage-context';
-export { IObjectStorage, ObjectStorageConfig, DemoObjectStorageConfig, FirebaseObjectStorageConfig, ObjectMetadata, ObjectData, StoredObject, ObjectWithId, MonitorCallback, DemonitorFunction } from './types';
+export { IObjectStorage, ObjectStorageConfig, DemoObjectStorageConfig, FirebaseObjectStorageUser, FirebaseObjectStorageConfig, ObjectMetadata, ObjectData, StoredObject, ObjectWithId, MonitorCallback, DemonitorFunction } from './types';
 export * from './typed-object';

package/dist/typed-object.js

@@ -69,8 +69,13 @@ class TypedObject {
         if (options.description !== undefined) {
             this.metadata.items[id].description = options.description;
         }
+        // firebase does not support nested arrays well, so we store rows as an object with numeric keys
+        const rowsObj = {};
+        options.rows.forEach((row, index) => {
+            rowsObj[index.toString()] = row;
+        });
         this.data[id] = {
-            rows: options.rows
+            rows: rowsObj
         };
     }
     addText(options) {

package/dist/types.d.ts

@@ -1,10 +1,26 @@
 export interface DemoObjectStorageConfig {
-    type: "demo";
     version: 1;
+    type: "demo";
+}
+export interface AuthenticatedUser {
+    type: "authenticated";
+    jwt: string;
+    contextId: string;
+    platformId: string;
+    platformUserId: string;
+    resourceLinkId: string;
 }
+export interface AnonymousUser {
+    type: "anonymous";
+    runKey: string;
+}
+export type FirebaseObjectStorageUser = AuthenticatedUser | AnonymousUser;
 export interface FirebaseObjectStorageConfig {
-    type: "firebase";
     version: 1;
+    type: "firebase";
+    app: any;
+    root: string;
+    user: FirebaseObjectStorageUser;
 }
 export type ObjectStorageConfig = DemoObjectStorageConfig | FirebaseObjectStorageConfig;
 export interface AddOptions {

package/dist/types.js

@@ -1,2 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@concord-consortium/object-storage",
-  "version": "1.0.0-pre.4",
+  "version": "1.0.0-pre.5",
   "description": "A TypeScript library for object storage",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
+    "build:watch": "tsc --watch",
     "test": "jest",
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
@@ -25,6 +26,7 @@
     "access": "public"
   },
   "dependencies": {
+    "firebase": "^9.8.1",
     "nanoid": "^3.3.7"
   },
   "peerDependencies": {