@concord-consortium/object-storage 1.0.0-pre.1 → 1.0.0-pre.2

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

@@ -1,4 +1,4 @@
-import { DemoObjectStorageConfig, IObjectStorage, ObjectMetadata, ObjectData, StoredObject, ObjectWithId, MonitorCallback, DemonitorFunction } from './types';
+import { DemoObjectStorageConfig, IObjectStorage, ObjectMetadata, ObjectData, StoredObject, ObjectWithId, MonitorCallback, DemonitorFunction, AddOptions } from './types';
 export declare class DemoObjectStorage implements IObjectStorage {
     private config;
     private objects;
@@ -36,9 +36,9 @@ export declare class DemoObjectStorage implements IObjectStorage {
     monitor(questionIds: string[], callback: MonitorCallback): DemonitorFunction;
     /**
      * Adds both metadata and data documents for a new object
-     * Returns the generated object ID (nanoid)
+     * Returns the generated object ID (nanoid) or the provided ID if specified in options
      */
-    add(object: StoredObject): Promise<string>;
+    add(object: StoredObject, options?: AddOptions): Promise<string>;
     /**
      * Reads both metadata and data documents for an object
      * Returns undefined if the object is not found
@@ -54,6 +54,10 @@ export declare class DemoObjectStorage implements IObjectStorage {
      * Returns undefined if the object is not found
      */
     readData(objectId: string): Promise<ObjectData | undefined>;
+    /**
+     * Generates a new unique ID using nanoid
+     */
+    genId(): string;
     /**
      * Notifies all active monitors of changes
      */

package/dist/demo-object-storage.js

@@ -91,10 +91,10 @@ class DemoObjectStorage {
     }
     /**
      * Adds both metadata and data documents for a new object
-     * Returns the generated object ID (nanoid)
+     * Returns the generated object ID (nanoid) or the provided ID if specified in options
      */
-    async add(object) {
-        const id = (0, nanoid_1.nanoid)();
+    async add(object, options) {
+        const id = options?.id ?? (0, nanoid_1.nanoid)();
         const objectWithId = {
             id,
             metadata: object.metadata,
@@ -141,6 +141,12 @@ class DemoObjectStorage {
         }
         return obj.data;
     }
+    /**
+     * Generates a new unique ID using nanoid
+     */
+    genId() {
+        return (0, nanoid_1.nanoid)();
+    }
     /**
      * Notifies all active monitors of changes
      */

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

@@ -1,4 +1,4 @@
-import { FirebaseObjectStorageConfig, IObjectStorage, ObjectMetadata, ObjectData, StoredObject, ObjectWithId, MonitorCallback, DemonitorFunction } from './types';
+import { FirebaseObjectStorageConfig, IObjectStorage, ObjectMetadata, ObjectData, StoredObject, ObjectWithId, MonitorCallback, DemonitorFunction, AddOptions } from './types';
 export declare class FirebaseObjectStorage implements IObjectStorage {
     private config;
     constructor(config: FirebaseObjectStorageConfig);
@@ -34,9 +34,9 @@ export declare class FirebaseObjectStorage implements IObjectStorage {
     monitor(questionIds: string[], callback: MonitorCallback): DemonitorFunction;
     /**
      * Adds both metadata and data documents for a new object
-     * Returns the generated object ID (nanoid)
+     * Returns the generated object ID (nanoid) or the provided ID if specified in options
      */
-    add(object: StoredObject): Promise<string>;
+    add(object: StoredObject, options?: AddOptions): Promise<string>;
     /**
      * Reads both metadata and data documents for an object
      */
@@ -49,4 +49,8 @@ export declare class FirebaseObjectStorage implements IObjectStorage {
      * Reads only the data document for an object
      */
     readData(objectId: string): Promise<ObjectData | undefined>;
+    /**
+     * Generates a new unique ID using nanoid
+     */
+    genId(): string;
 }

package/dist/firebase-object-storage.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FirebaseObjectStorage = void 0;
+const nanoid_1 = require("nanoid");
 class FirebaseObjectStorage {
     constructor(config) {
         if (config.version !== 1) {
@@ -67,13 +68,13 @@ class FirebaseObjectStorage {
     }
     /**
      * Adds both metadata and data documents for a new object
-     * Returns the generated object ID (nanoid)
+     * Returns the generated object ID (nanoid) or the provided ID if specified in options
      */
-    async add(object) {
-        // TODO: Generate nanoid
+    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 = 'placeholder-id';
+        const newObjectId = options?.id ?? 'placeholder-id';
         return newObjectId;
     }
     /**
@@ -101,5 +102,11 @@ class FirebaseObjectStorage {
         // TODO: Read data document from Firebase
         return {};
     }
+    /**
+     * Generates a new unique ID using nanoid
+     */
+    genId() {
+        return (0, nanoid_1.nanoid)();
+    }
 }
 exports.FirebaseObjectStorage = FirebaseObjectStorage;

package/dist/types.d.ts

@@ -7,6 +7,9 @@ export interface FirebaseObjectStorageConfig {
     version: 1;
 }
 export type ObjectStorageConfig = DemoObjectStorageConfig | FirebaseObjectStorageConfig;
+export interface AddOptions {
+    id?: string;
+}
 export interface IObjectStorage {
     listMine(): Promise<ObjectWithId[]>;
     listLinked(): Promise<ObjectWithId[]>;
@@ -14,10 +17,11 @@ export interface IObjectStorage {
     monitorMine(callback: MonitorCallback): DemonitorFunction;
     monitorLinked(callback: MonitorCallback): DemonitorFunction;
     monitor(questionIds: string[], callback: MonitorCallback): DemonitorFunction;
-    add(object: StoredObject): Promise<string>;
+    add(object: StoredObject, options?: AddOptions): Promise<string>;
     read(objectId: string): Promise<StoredObject | undefined>;
     readMetadata(objectId: string): Promise<ObjectMetadata | undefined>;
     readData(objectId: string): Promise<ObjectData | undefined>;
+    genId(): string;
 }
 export interface ObjectMetadata {
     [key: string]: any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@concord-consortium/object-storage",
-  "version": "1.0.0-pre.1",
+  "version": "1.0.0-pre.2",
   "description": "A TypeScript library for object storage",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",