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

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/index.d.ts

@@ -3,3 +3,4 @@ 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 * from './typed-object';

package/dist/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useObjectStorage = exports.ObjectStorageProvider = exports.createObjectStorage = exports.FirebaseObjectStorage = exports.DemoObjectStorage = void 0;
 var demo_object_storage_1 = require("./demo-object-storage");
@@ -10,3 +24,4 @@ Object.defineProperty(exports, "createObjectStorage", { enumerable: true, get: f
 var object_storage_context_1 = require("./object-storage-context");
 Object.defineProperty(exports, "ObjectStorageProvider", { enumerable: true, get: function () { return object_storage_context_1.ObjectStorageProvider; } });
 Object.defineProperty(exports, "useObjectStorage", { enumerable: true, get: function () { return object_storage_context_1.useObjectStorage; } });
+__exportStar(require("./typed-object"), exports);

package/dist/typed-object.d.ts

@@ -0,0 +1,70 @@
+import { StoredObject } from "./types";
+export type AddImageOptions = {
+    id?: string;
+    name: string;
+    url: string;
+    width?: number;
+    height?: number;
+    description?: string;
+    subType?: string;
+};
+export type AddDataTableOptions = {
+    id?: string;
+    name: string;
+    cols: string[];
+    rows: any[][];
+    description?: string;
+    subType?: string;
+};
+export type AddTypedTextOptions = {
+    id?: string;
+    name: string;
+    text: string;
+    description?: string;
+    subType?: string;
+};
+export type AddTypedObjectOptions = {
+    id?: string;
+    name: string;
+    data: Record<string, any>;
+    description?: string;
+    subType?: string;
+};
+export type TypedImageMetadata = {
+    type: "image";
+} & Omit<AddImageOptions, "id" | "url">;
+export type TypedDataTableMetadata = {
+    type: "dataTable";
+} & Omit<AddDataTableOptions, "id" | "rows">;
+export type TypedTextMetadata = {
+    type: "text";
+} & Omit<AddTypedTextOptions, "id" | "text">;
+export type TypedObjectMetadata = {
+    type: "object";
+    keys: string[];
+} & Omit<AddTypedObjectOptions, "id" | "data">;
+export type TypedMetadataItem = TypedImageMetadata | TypedDataTableMetadata | TypedTextMetadata | TypedObjectMetadata;
+export type TypedMetadataItems = Record<string, TypedMetadataItem>;
+export type TypedMetadata = {
+    version: 1;
+    type: "typed";
+    items: TypedMetadataItems;
+    name?: string;
+    description?: string;
+};
+export type TypedData = Record<string, any>;
+export type TypedObjectOptions = {
+    id?: string;
+    name?: string;
+    description?: string;
+};
+export declare class TypedObject implements StoredObject {
+    id: string;
+    metadata: TypedMetadata;
+    data: TypedData;
+    constructor(options?: TypedObjectOptions);
+    addImage(options: AddImageOptions): void;
+    addDataTable(options: AddDataTableOptions): void;
+    addText(options: AddTypedTextOptions): void;
+    addObject(options: AddTypedObjectOptions): void;
+}

package/dist/typed-object.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypedObject = void 0;
+const nanoid_1 = require("nanoid");
+class TypedObject {
+    constructor(options) {
+        this.id = options?.id || (0, nanoid_1.nanoid)();
+        this.metadata = {
+            version: 1,
+            type: "typed",
+            items: {},
+        };
+        if (options?.name !== undefined) {
+            this.metadata.name = options.name;
+        }
+        if (options?.description !== undefined) {
+            this.metadata.description = options.description;
+        }
+        this.data = {};
+    }
+    addImage(options) {
+        const id = options.id || (0, nanoid_1.nanoid)();
+        this.metadata.items[id] = {
+            type: "image",
+            name: options.name
+        };
+        if (options.subType !== undefined) {
+            this.metadata.items[id].subType = options.subType;
+        }
+        if (options.width !== undefined) {
+            this.metadata.items[id].width = options.width;
+        }
+        if (options.height !== undefined) {
+            this.metadata.items[id].height = options.height;
+        }
+        if (options.description !== undefined) {
+            this.metadata.items[id].description = options.description;
+        }
+        this.data[id] = {
+            url: options.url
+        };
+    }
+    addDataTable(options) {
+        const id = options.id || (0, nanoid_1.nanoid)();
+        this.metadata.items[id] = {
+            type: "dataTable",
+            name: options.name,
+            cols: options.cols,
+        };
+        if (options.subType !== undefined) {
+            this.metadata.items[id].subType = options.subType;
+        }
+        if (options.description !== undefined) {
+            this.metadata.items[id].description = options.description;
+        }
+        this.data[id] = {
+            rows: options.rows
+        };
+    }
+    addText(options) {
+        const id = options.id || (0, nanoid_1.nanoid)();
+        this.metadata.items[id] = {
+            type: "text",
+            name: options.name,
+        };
+        if (options.subType !== undefined) {
+            this.metadata.items[id].subType = options.subType;
+        }
+        if (options.description !== undefined) {
+            this.metadata.items[id].description = options.description;
+        }
+        this.data[id] = {
+            text: options.text
+        };
+    }
+    addObject(options) {
+        const id = options.id || (0, nanoid_1.nanoid)();
+        this.metadata.items[id] = {
+            type: "object",
+            name: options.name,
+            keys: Object.keys(options.data),
+        };
+        if (options.subType !== undefined) {
+            this.metadata.items[id].subType = options.subType;
+        }
+        if (options.description !== undefined) {
+            this.metadata.items[id].description = options.description;
+        }
+        this.data[id] = options.data;
+    }
+}
+exports.TypedObject = TypedObject;

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.3",
   "description": "A TypeScript library for object storage",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",