@casual-simulation/aux-records 2.0.22-alpha.1651045562

package/DataRecordsController.d.ts

@@ -0,0 +1,67 @@
+import { NotLoggedInError, ServerError } from './Errors';
+import { DataRecordsStore, GetDataStoreResult, SetDataResult } from './DataRecordsStore';
+import { RecordsController, ValidatePublicRecordKeyFailure } from './RecordsController';
+/**
+ * Defines a class that is able to manage data (key/value) records.
+ */
+export declare class DataRecordsController {
+    private _manager;
+    private _store;
+    /**
+     * Creates a DataRecordsController.
+     * @param manager The records manager that should be used to validate record keys.
+     * @param store The store that should be used to save data.
+     */
+    constructor(manager: RecordsController, store: DataRecordsStore);
+    /**
+     * Records the given data in the given record and address.
+     * Uses the given record key to access the record and the given subject ID to store which user the data came from.
+     * @param recordKey The key that should be used to access the record.
+     * @param address The address that the record should be stored at inside the record.
+     * @param data The data that should be saved.
+     * @param subjectId The ID of the user that the data came from.
+     * @returns
+     */
+    recordData(recordKey: string, address: string, data: string, subjectId: string): Promise<RecordDataResult>;
+    getData(recordName: string, address: string): Promise<GetDataResult>;
+}
+export declare type RecordDataResult = RecordDataSuccess | RecordDataFailure;
+export interface RecordDataSuccess {
+    success: true;
+    recordName: string;
+    address: string;
+}
+export interface RecordDataFailure {
+    success: false;
+    errorCode: ServerError | NotLoggedInError | ValidatePublicRecordKeyFailure['errorCode'] | SetDataResult['errorCode'];
+    errorMessage: string;
+}
+export declare type GetDataResult = GetDataSuccess | GetDataFailure;
+/**
+ * Defines an interface that represents a successful "get data" result.
+ */
+export interface GetDataSuccess {
+    success: true;
+    /**
+     * The data that was stored.
+     */
+    data: any;
+    /**
+     * The name of the record.
+     */
+    recordName: string;
+    /**
+     * The ID of the user that owns the record.
+     */
+    publisherId: string;
+    /**
+     * The ID of the user that sent the data.
+     */
+    subjectId: string;
+}
+export interface GetDataFailure {
+    success: false;
+    errorCode: ServerError | GetDataStoreResult['errorCode'];
+    errorMessage: string;
+}
+//# sourceMappingURL=DataRecordsController.d.ts.map

package/DataRecordsController.js

@@ -0,0 +1,87 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Defines a class that is able to manage data (key/value) records.
+ */
+export class DataRecordsController {
+    /**
+     * Creates a DataRecordsController.
+     * @param manager The records manager that should be used to validate record keys.
+     * @param store The store that should be used to save data.
+     */
+    constructor(manager, store) {
+        this._manager = manager;
+        this._store = store;
+    }
+    /**
+     * Records the given data in the given record and address.
+     * Uses the given record key to access the record and the given subject ID to store which user the data came from.
+     * @param recordKey The key that should be used to access the record.
+     * @param address The address that the record should be stored at inside the record.
+     * @param data The data that should be saved.
+     * @param subjectId The ID of the user that the data came from.
+     * @returns
+     */
+    recordData(recordKey, address, data, subjectId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield this._manager.validatePublicRecordKey(recordKey);
+                if (result.success === false) {
+                    return {
+                        success: false,
+                        errorCode: result.errorCode,
+                        errorMessage: result.errorMessage,
+                    };
+                }
+                const recordName = result.recordName;
+                const result2 = yield this._store.setData(recordName, address, data, result.ownerId, subjectId);
+                if (result2.success === false) {
+                    return {
+                        success: false,
+                        errorCode: result2.errorCode,
+                        errorMessage: result2.errorMessage,
+                    };
+                }
+                return {
+                    success: true,
+                    recordName: recordName,
+                    address: address,
+                };
+            }
+            catch (err) {
+                return {
+                    success: false,
+                    errorCode: 'server_error',
+                    errorMessage: err.toString(),
+                };
+            }
+        });
+    }
+    getData(recordName, address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this._store.getData(recordName, address);
+            if (result.success === false) {
+                return {
+                    success: false,
+                    errorCode: result.errorCode,
+                    errorMessage: result.errorMessage,
+                };
+            }
+            return {
+                success: true,
+                data: result.data,
+                publisherId: result.publisherId,
+                subjectId: result.subjectId,
+                recordName,
+            };
+        });
+    }
+}
+//# sourceMappingURL=DataRecordsController.js.map

package/DataRecordsController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataRecordsController.js","sourceRoot":"","sources":["DataRecordsController.ts"],"names":[],"mappings":";;;;;;;;;AAWA;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAI9B;;;;OAIG;IACH,YAAY,OAA0B,EAAE,KAAuB;QAC3D,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACG,UAAU,CACZ,SAAiB,EACjB,OAAe,EACf,IAAY,EACZ,SAAiB;;YAEjB,IAAI;gBACA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,uBAAuB,CACtD,SAAS,CACZ,CAAC;gBACF,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC1B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,MAAM,CAAC,SAAS;wBAC3B,YAAY,EAAE,MAAM,CAAC,YAAY;qBACpC,CAAC;iBACL;gBAED,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;gBACrC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CACrC,UAAU,EACV,OAAO,EACP,IAAI,EACJ,MAAM,CAAC,OAAO,EACd,SAAS,CACZ,CAAC;gBAEF,IAAI,OAAO,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC3B,OAAO;wBACH,OAAO,EAAE,KAAK;wBACd,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,YAAY,EAAE,OAAO,CAAC,YAAY;qBACrC,CAAC;iBACL;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,UAAU,EAAE,UAAU;oBACtB,OAAO,EAAE,OAAO;iBACnB,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,GAAG,CAAC,QAAQ,EAAE;iBAC/B,CAAC;aACL;QACL,CAAC;KAAA;IAEK,OAAO,CAAC,UAAkB,EAAE,OAAe;;YAC7C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;YAC9D,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;gBAC1B,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,YAAY,EAAE,MAAM,CAAC,YAAY;iBACpC,CAAC;aACL;YAED,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,UAAU;aACb,CAAC;QACN,CAAC;KAAA;CACJ"}

package/DataRecordsStore.d.ts

@@ -0,0 +1,41 @@
+import { ServerError } from './Errors';
+/**
+ * Defines an interface for objects that can store data records.
+ */
+export interface DataRecordsStore {
+    /**
+     * Sets the given data in the given record and address.
+     * @param recordName The name of the record that the data should be set in.
+     * @param address The address that the data should be set for.
+     * @param data The data that should be saved.
+     * @param publisherId The ID of the user that owns the record this data is being published to.
+     * @param subjectId The ID of the user that was logged in when the data was published.
+     */
+    setData(recordName: string, address: string, data: any, publisherId: string, subjectId: string): Promise<SetDataResult>;
+    /**
+     * Gets the data stored in the given record and address.
+     * @param recordName The name of hte record that the data is in.
+     * @param address The address that the data is stored at.
+     */
+    getData(recordName: string, address: string): Promise<GetDataStoreResult>;
+}
+/**
+ * Defines an interface that represents the result of a "set data" operation.
+ */
+export interface SetDataResult {
+    success: boolean;
+    errorCode?: 'data_too_large' | ServerError;
+    errorMessage?: string;
+}
+/**
+ * Defines an interface that represents the result of a "get data" operation.
+ */
+export interface GetDataStoreResult {
+    success: boolean;
+    data?: any;
+    publisherId?: string;
+    subjectId?: string;
+    errorCode?: 'data_not_found' | ServerError;
+    errorMessage?: string;
+}
+//# sourceMappingURL=DataRecordsStore.d.ts.map

package/DataRecordsStore.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DataRecordsStore.js.map

package/DataRecordsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataRecordsStore.js","sourceRoot":"","sources":["DataRecordsStore.ts"],"names":[],"mappings":""}

package/Errors.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Defines an error that occurs when an unspecified error occurs while creating a public record key.
+ */
+export declare type ServerError = 'server_error';
+/**
+ * Defines an error that occurs when the user is not logged in but they are required to be in order to perform an action.
+ */
+export declare type NotLoggedInError = 'not_logged_in';
+//# sourceMappingURL=Errors.d.ts.map

package/Errors.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Errors.js.map

package/Errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.js","sourceRoot":"","sources":["Errors.ts"],"names":[],"mappings":""}

package/FileRecordsController.d.ts

@@ -0,0 +1,75 @@
+import { FileRecordsStore, AddFileFailure, MarkFileRecordAsUploadedFailure } from './FileRecordsStore';
+import { NotLoggedInError, ServerError } from './Errors';
+import { RecordsController, ValidatePublicRecordKeyFailure } from './RecordsController';
+/**
+ * Defines a class that can manage file records.
+ */
+export declare class FileRecordsController {
+    private _controller;
+    private _store;
+    constructor(controller: RecordsController, store: FileRecordsStore);
+    recordFile(recordKey: string, userId: string, request: RecordFileRequest): Promise<RecordFileResult>;
+    markFileAsUploaded(recordName: string, fileName: string): Promise<FileUploadedResult>;
+}
+/**
+ * Defines an interface that is used for requests to record a file.
+ */
+export interface RecordFileRequest {
+    /**
+     * The hex encoded SHA256 hash of the file that will be uploaded.
+     */
+    fileSha256Hex: string;
+    /**
+     * The number of bytes in the file.
+     */
+    fileByteLength: number;
+    /**
+     * The MIME type of the file.
+     */
+    fileMimeType: string;
+    /**
+     * The description of the file.
+     */
+    fileDescription: string;
+}
+export declare type RecordFileResult = RecordFileSuccess | RecordFileFailure;
+export interface RecordFileSuccess {
+    success: true;
+    /**
+     * The URL that the file should be uploaded to.
+     */
+    uploadUrl: string;
+    /**
+     * The HTTP Method that should be used for the upload.
+     */
+    uploadMethod: string;
+    /**
+     * The HTTP headers that should be included in the upload request.
+     */
+    uploadHeaders: {
+        [name: string]: string;
+    };
+    /**
+     * The name of the file that was recorded.
+     */
+    fileName: string;
+}
+export interface RecordFileFailure {
+    success: false;
+    errorCode: ServerError | NotLoggedInError | ValidatePublicRecordKeyFailure['errorCode'] | AddFileFailure['errorCode'] | 'invalid_file_data';
+    errorMessage: string;
+    /**
+     * The URL that the file is available at if it has already been uploaded.
+     */
+    existingFileUrl?: string;
+}
+export declare type FileUploadedResult = FileUploadedSuccess | FileUploadedFailure;
+export interface FileUploadedSuccess {
+    success: true;
+}
+export interface FileUploadedFailure {
+    success: false;
+    errorCode: ServerError | MarkFileRecordAsUploadedFailure['errorCode'];
+    errorMessage: string;
+}
+//# sourceMappingURL=FileRecordsController.d.ts.map

package/FileRecordsController.js

@@ -0,0 +1,114 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { getExtension } from 'mime';
+/**
+ * Defines a class that can manage file records.
+ */
+export class FileRecordsController {
+    constructor(controller, store) {
+        this._controller = controller;
+        this._store = store;
+    }
+    recordFile(recordKey, userId, request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const keyResult = yield this._controller.validatePublicRecordKey(recordKey);
+                if (keyResult.success === false) {
+                    return keyResult;
+                }
+                const publisherId = keyResult.ownerId;
+                const recordName = keyResult.recordName;
+                const subjectId = userId;
+                const extension = getExtension(request.fileMimeType);
+                const fileName = extension
+                    ? `${request.fileSha256Hex}.${extension}`
+                    : request.fileSha256Hex;
+                const presignResult = yield this._store.presignFileUpload({
+                    recordName,
+                    fileName: fileName,
+                    fileSha256Hex: request.fileSha256Hex,
+                    fileMimeType: request.fileMimeType,
+                    fileByteLength: request.fileByteLength,
+                });
+                if (presignResult.success === false) {
+                    return presignResult;
+                }
+                const addFileResult = yield this._store.addFileRecord(recordName, fileName, publisherId, subjectId, request.fileByteLength, request.fileDescription);
+                if (addFileResult.success === false) {
+                    if (addFileResult.errorCode === 'file_already_exists') {
+                        const fileResult = yield this._store.getFileRecord(recordName, fileName);
+                        if (fileResult.success === false) {
+                            console.error('[FileRecordsController] Error getting file record even though it should exist:', fileResult);
+                            return {
+                                success: false,
+                                errorCode: 'server_error',
+                                errorMessage: fileResult.errorMessage,
+                            };
+                        }
+                        if (!fileResult.uploaded) {
+                            return {
+                                success: true,
+                                fileName,
+                                uploadUrl: presignResult.uploadUrl,
+                                uploadHeaders: presignResult.uploadHeaders,
+                                uploadMethod: presignResult.uploadMethod,
+                            };
+                        }
+                        else {
+                            return {
+                                success: false,
+                                errorCode: 'file_already_exists',
+                                errorMessage: 'The file has already been uploaded to ' +
+                                    fileResult.url,
+                                existingFileUrl: fileResult.url,
+                            };
+                        }
+                    }
+                    return addFileResult;
+                }
+                return {
+                    success: true,
+                    fileName,
+                    uploadUrl: presignResult.uploadUrl,
+                    uploadHeaders: presignResult.uploadHeaders,
+                    uploadMethod: presignResult.uploadMethod,
+                };
+            }
+            catch (err) {
+                return {
+                    success: false,
+                    errorCode: 'server_error',
+                    errorMessage: err.toString(),
+                };
+            }
+        });
+    }
+    markFileAsUploaded(recordName, fileName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const result = yield this._store.setFileRecordAsUploaded(recordName, fileName);
+                if (result.success === false) {
+                    return result;
+                }
+                return {
+                    success: true,
+                };
+            }
+            catch (err) {
+                return {
+                    success: false,
+                    errorCode: 'server_error',
+                    errorMessage: err.toString(),
+                };
+            }
+        });
+    }
+}
+//# sourceMappingURL=FileRecordsController.js.map

package/FileRecordsController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileRecordsController.js","sourceRoot":"","sources":["FileRecordsController.ts"],"names":[],"mappings":";;;;;;;;;AAUA,OAAO,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAEpC;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAI9B,YAAY,UAA6B,EAAE,KAAuB;QAC9D,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;IACxB,CAAC;IAEK,UAAU,CACZ,SAAiB,EACjB,MAAc,EACd,OAA0B;;YAE1B,IAAI;gBACA,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,uBAAuB,CAC5D,SAAS,CACZ,CAAC;gBAEF,IAAI,SAAS,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC7B,OAAO,SAAS,CAAC;iBACpB;gBAED,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC;gBACtC,MAAM,UAAU,GAAG,SAAS,CAAC,UAAU,CAAC;gBACxC,MAAM,SAAS,GAAG,MAAM,CAAC;gBAEzB,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;gBACrD,MAAM,QAAQ,GAAG,SAAS;oBACtB,CAAC,CAAC,GAAG,OAAO,CAAC,aAAa,IAAI,SAAS,EAAE;oBACzC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;gBAE5B,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC;oBACtD,UAAU;oBACV,QAAQ,EAAE,QAAQ;oBAClB,aAAa,EAAE,OAAO,CAAC,aAAa;oBACpC,YAAY,EAAE,OAAO,CAAC,YAAY;oBAClC,cAAc,EAAE,OAAO,CAAC,cAAc;iBACzC,CAAC,CAAC;gBAEH,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE;oBACjC,OAAO,aAAa,CAAC;iBACxB;gBAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CACjD,UAAU,EACV,QAAQ,EACR,WAAW,EACX,SAAS,EACT,OAAO,CAAC,cAAc,EACtB,OAAO,CAAC,eAAe,CAC1B,CAAC;gBAEF,IAAI,aAAa,CAAC,OAAO,KAAK,KAAK,EAAE;oBACjC,IAAI,aAAa,CAAC,SAAS,KAAK,qBAAqB,EAAE;wBACnD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,aAAa,CAC9C,UAAU,EACV,QAAQ,CACX,CAAC;wBACF,IAAI,UAAU,CAAC,OAAO,KAAK,KAAK,EAAE;4BAC9B,OAAO,CAAC,KAAK,CACT,gFAAgF,EAChF,UAAU,CACb,CAAC;4BACF,OAAO;gCACH,OAAO,EAAE,KAAK;gCACd,SAAS,EAAE,cAAc;gCACzB,YAAY,EAAE,UAAU,CAAC,YAAY;6BACxC,CAAC;yBACL;wBAED,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE;4BACtB,OAAO;gCACH,OAAO,EAAE,IAAI;gCACb,QAAQ;gCACR,SAAS,EAAE,aAAa,CAAC,SAAS;gCAClC,aAAa,EAAE,aAAa,CAAC,aAAa;gCAC1C,YAAY,EAAE,aAAa,CAAC,YAAY;6BAC3C,CAAC;yBACL;6BAAM;4BACH,OAAO;gCACH,OAAO,EAAE,KAAK;gCACd,SAAS,EAAE,qBAAqB;gCAChC,YAAY,EACR,wCAAwC;oCACxC,UAAU,CAAC,GAAG;gCAClB,eAAe,EAAE,UAAU,CAAC,GAAG;6BAClC,CAAC;yBACL;qBACJ;oBAED,OAAO,aAAa,CAAC;iBACxB;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;oBACb,QAAQ;oBACR,SAAS,EAAE,aAAa,CAAC,SAAS;oBAClC,aAAa,EAAE,aAAa,CAAC,aAAa;oBAC1C,YAAY,EAAE,aAAa,CAAC,YAAY;iBAC3C,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,GAAG,CAAC,QAAQ,EAAE;iBAC/B,CAAC;aACL;QACL,CAAC;KAAA;IAEK,kBAAkB,CACpB,UAAkB,EAClB,QAAgB;;YAEhB,IAAI;gBACA,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,uBAAuB,CACpD,UAAU,EACV,QAAQ,CACX,CAAC;gBAEF,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE;oBAC1B,OAAO,MAAM,CAAC;iBACjB;gBAED,OAAO;oBACH,OAAO,EAAE,IAAI;iBAChB,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,cAAc;oBACzB,YAAY,EAAE,GAAG,CAAC,QAAQ,EAAE;iBAC/B,CAAC;aACL;QACL,CAAC;KAAA;CACJ"}

package/FileRecordsStore.d.ts

@@ -0,0 +1,139 @@
+import { ServerError } from './Errors';
+/**
+ * Defines an interface that provides a way to store file records.
+ */
+export interface FileRecordsStore {
+    /**
+     * Presigns a request to record a file.
+     * Returns the URL that should be used to upload the file and the headers that should be included in the upload request.
+     * @param request The request to create a signed request for.
+     */
+    presignFileUpload(request: PresignFileUploadRequest): Promise<PresignFileUploadResult>;
+    /**
+     * Gets the file record for the file with the given name.
+     * @param recordName The name of the record that the file is stored in.
+     * @param fileName The name of the file.
+     */
+    getFileRecord(recordName: string, fileName: string): Promise<GetFileRecordResult>;
+    /**
+     * Attempts to add a record for a file to the store.
+     * @param recordName The name of the record that the file was recorded in.
+     * @param fileName The name of the file that should be recorded.
+     * @param publisherId The ID of the publisher that published the record.
+     * @param subjectId The ID of the subject that was logged in when the record was published.
+     * @param sizeInBytes The size of the file in bytes.
+     * @param description The description of the file.
+     */
+    addFileRecord(recordName: string, fileName: string, publisherId: string, subjectId: string, sizeInBytes: number, description: string): Promise<AddFileResult>;
+    /**
+     * Marks the given file record as having been uploaded.
+     * @param recordName The reocrd that the file was uploaded to.
+     * @param fileName The name of the file that was uploaded.
+     */
+    setFileRecordAsUploaded(recordName: string, fileName: string): Promise<MarkFileRecordAsUploadedResult>;
+}
+export declare type GetFileRecordResult = GetFileRecordSuccess | GetFileRecordFailure;
+export interface GetFileRecordSuccess {
+    success: true;
+    /**
+     * The name of the file.
+     */
+    fileName: string;
+    /**
+     * The description of the file.
+     */
+    description: string;
+    /**
+     * The name of the record that the file was recorded in.
+     */
+    recordName: string;
+    /**
+     * The URL that the file can be downloaded from.
+     */
+    url: string;
+    /**
+     * The ID of the publisher that published the record.
+     */
+    publisherId: string;
+    /**
+     * The ID of the subject that was logged in when the record was published.
+     */
+    subjectId: string;
+    /**
+     * The size of the record in bytes.
+     */
+    sizeInBytes: number;
+    /**
+     * Whether the record was uploaded to the server.
+     */
+    uploaded: boolean;
+}
+export declare type MarkFileRecordAsUploadedResult = MarkFileRecordAsUploadedSuccess | MarkFileRecordAsUploadedFailure;
+export interface MarkFileRecordAsUploadedSuccess {
+    success: true;
+}
+export interface MarkFileRecordAsUploadedFailure {
+    success: false;
+    errorCode: ServerError | 'file_not_found';
+    errorMessage: string;
+}
+export interface GetFileRecordFailure {
+    success: false;
+    errorCode: ServerError | 'file_not_found';
+    errorMessage: string;
+}
+export interface PresignFileUploadRequest {
+    /**
+     * The name of the record that the file will be stored in.
+     */
+    recordName: string;
+    /**
+     * The name of the file.
+     */
+    fileName: string;
+    /**
+     * The Hex encoded SHA-256 hash of the file that will be uploaded.
+     */
+    fileSha256Hex: string;
+    /**
+     * The MIME type of the file that will be uploaded.
+     */
+    fileMimeType: string;
+    /**
+     * The number of bytes in the file.
+     */
+    fileByteLength: number;
+}
+export declare type PresignFileUploadResult = PresignFileUploadSuccess | PresignFileUploadFailure;
+export interface PresignFileUploadSuccess {
+    success: true;
+    /**
+     * The URL that the upload should be sent to.
+     */
+    uploadUrl: string;
+    /**
+     * The HTTP method that should be used for the upload.
+     */
+    uploadMethod: string;
+    /**
+     * The HTTP headers that should be included in the upload.
+     */
+    uploadHeaders: {
+        [name: string]: string;
+    };
+}
+export interface PresignFileUploadFailure {
+    success: false;
+    errorCode: ServerError;
+    errorMessage: string;
+}
+export declare type AddFileResult = AddFileSuccess | AddFileFailure;
+export interface AddFileSuccess {
+    success: true;
+}
+export interface AddFileFailure {
+    success: false;
+    errorCode: ServerError | 'file_already_exists';
+    errorMessage: string;
+}
+//# sourceMappingURL=FileRecordsStore.d.ts.map

package/FileRecordsStore.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=FileRecordsStore.js.map

package/FileRecordsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileRecordsStore.js","sourceRoot":"","sources":["FileRecordsStore.ts"],"names":[],"mappings":""}

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Casual Simulation, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/MemoryDataRecordsStore.d.ts

@@ -0,0 +1,8 @@
+import { DataRecordsStore, GetDataStoreResult, SetDataResult } from './DataRecordsStore';
+export declare class MemoryDataRecordsStore implements DataRecordsStore {
+    private _buckets;
+    setData(recordName: string, address: string, data: any, publisherId: string, subjectId: string): Promise<SetDataResult>;
+    getData(recordName: string, address: string): Promise<GetDataStoreResult>;
+    private _getRecord;
+}
+//# sourceMappingURL=MemoryDataRecordsStore.d.ts.map

package/MemoryDataRecordsStore.js

@@ -0,0 +1,55 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+export class MemoryDataRecordsStore {
+    constructor() {
+        this._buckets = new Map();
+    }
+    setData(recordName, address, data, publisherId, subjectId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let record = this._getRecord(recordName);
+            record.set(address, {
+                data: data,
+                publisherId: publisherId,
+                subjectId: subjectId,
+            });
+            return {
+                success: true,
+            };
+        });
+    }
+    getData(recordName, address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let record = this._getRecord(recordName);
+            let data = record.get(address);
+            if (!data) {
+                return {
+                    success: false,
+                    errorCode: 'data_not_found',
+                    errorMessage: 'The data was not found.',
+                };
+            }
+            return {
+                success: true,
+                data: data.data,
+                publisherId: data.publisherId,
+                subjectId: data.subjectId,
+            };
+        });
+    }
+    _getRecord(recordName) {
+        let record = this._buckets.get(recordName);
+        if (!record) {
+            record = new Map();
+            this._buckets.set(recordName, record);
+        }
+        return record;
+    }
+}
+//# sourceMappingURL=MemoryDataRecordsStore.js.map

package/MemoryDataRecordsStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryDataRecordsStore.js","sourceRoot":"","sources":["MemoryDataRecordsStore.ts"],"names":[],"mappings":";;;;;;;;;AAMA,MAAM,OAAO,sBAAsB;IAAnC;QACY,aAAQ,GAAyC,IAAI,GAAG,EAAE,CAAC;IAkDvE,CAAC;IAhDS,OAAO,CACT,UAAkB,EAClB,OAAe,EACf,IAAS,EACT,WAAmB,EACnB,SAAiB;;YAEjB,IAAI,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACzC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE;gBAChB,IAAI,EAAE,IAAI;gBACV,WAAW,EAAE,WAAW;gBACxB,SAAS,EAAE,SAAS;aACvB,CAAC,CAAC;YACH,OAAO;gBACH,OAAO,EAAE,IAAI;aAChB,CAAC;QACN,CAAC;KAAA;IAEK,OAAO,CACT,UAAkB,EAClB,OAAe;;YAEf,IAAI,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;YACzC,IAAI,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YAC/B,IAAI,CAAC,IAAI,EAAE;gBACP,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,SAAS,EAAE,gBAAgB;oBAC3B,YAAY,EAAE,yBAAyB;iBAC1C,CAAC;aACL;YAED,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;aAC5B,CAAC;QACN,CAAC;KAAA;IAEO,UAAU,CAAC,UAAkB;QACjC,IAAI,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,EAAE;YACT,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;YACnB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;SACzC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ"}