spec-3nweb-server 1.5.0 → 1.6.0

package/build/3nstorage/owner.js

@@ -37,7 +37,7 @@ const get_current_obj_1 = require("./routes/owner/get-current-obj");
 const get_archived_obj_ver_1 = require("./routes/owner/get-archived-obj-ver");
 const delete_obj_1 = require("./routes/owner/delete-obj");
 const archive_obj_version_1 = require("./routes/owner/archive-obj-version");
-const list_obj_archive_1 = require("./routes/owner/list-obj-archive");
+const get_obj_status_1 = require("./routes/owner/get-obj-status");
 const api = require("../lib-common/service-api/3nstorage/owner");
 function makeApp(domain, sessions, users, midAuthorizer) {
     const app = new app_1.AppWithWSs();
@@ -48,8 +48,7 @@ function makeApp(domain, sessions, users, midAuthorizer) {
 exports.makeApp = makeApp;
 function setWSPart(app, sessions, users) {
     const sockets = new app_1.UserSockets(sessions.ensureAuthorizedSessionForSocketStart());
-    const storageEvents = new server_events_1.ServerEvents(undefined, [api.objChanged.EVENT_NAME,
-        api.objRemoved.EVENT_NAME], sockets.socketGetter);
+    const storageEvents = new server_events_1.ServerEvents(undefined, api.events.all, sockets.socketGetter);
     // give events ipc to both ends
     sockets.addSocketIPC(storageEvents);
     users.setStorageEventsSink(storageEvents.eventsSink);
@@ -89,14 +88,16 @@ function setHttpPart(app, domain, sessions, users, midAuthorizer) {
     app.http.route('/' + api.archivedObjVersion.EXPRESS_URL_END)
         .get((0, get_archived_obj_ver_1.getArchivedObjVersion)(false, users.getArchivedObjVersion));
     // Archive root's current version
-    app.http.route('/' + api.archiveRoot.URL_END)
-        .get((0, list_obj_archive_1.listObjArchive)(true, users.listObjArchive))
+    app.http.route('/' + api.archiveRoot.EXPRESS_URL_END)
         .post((0, body_parsers_1.emptyBody)(), (0, archive_obj_version_1.archiveCurrentObjVersion)(true, users.archiveObjVersion))
         .delete((0, delete_obj_1.deleteArchivedObjVer)(true, users.deleteArchivedObjVersion));
     // Archive non-root object's current version
     app.http.route('/' + api.archiveObj.EXPRESS_URL_END)
-        .get((0, list_obj_archive_1.listObjArchive)(false, users.listObjArchive))
         .post((0, body_parsers_1.emptyBody)(), (0, archive_obj_version_1.archiveCurrentObjVersion)(false, users.archiveObjVersion))
         .delete((0, delete_obj_1.deleteArchivedObjVer)(false, users.deleteArchivedObjVersion));
+    // Getting root object status
+    app.http.get('/' + api.rootStatus.EXPRESS_URL_END, (0, get_obj_status_1.getObjStatus)(true, users.getObjStatus));
+    // Getting object status
+    app.http.get('/' + api.objStatus.EXPRESS_URL_END, (0, get_obj_status_1.getObjStatus)(false, users.getObjStatus));
 }
 Object.freeze(exports);

package/build/3nstorage/resources/store.d.ts

@@ -2,11 +2,10 @@
 import { Readable } from 'stream';
 import { PutObjFirstQueryOpts, PutObjSecondQueryOpts } from '../../lib-common/service-api/3nstorage/owner';
 import { UserFiles, ObjReader } from '../../lib-server/resources/user-files';
-import { DiffInfo, objChanged, objRemoved } from '../../lib-common/service-api/3nstorage/owner';
+import { DiffInfo, events, ObjStatus } from '../../lib-common/service-api/3nstorage/owner';
 export { DiffInfo } from '../../lib-common/service-api/3nstorage/owner';
 export { ObjPipe, ObjReader } from '../../lib-server/resources/user-files';
-export declare type MsgEvents = objChanged.Event | objRemoved.Event;
-export declare type StorageEventsSink = (userId: string, channel: string, event: MsgEvents) => void;
+export declare type StorageEventsSink = (userId: string, channel: events.EventNameType, event: events.AllTypes) => void;
 export declare const SC: {
     USER_UNKNOWN: string;
     OBJ_EXIST: string;
@@ -112,7 +111,7 @@ export declare class Store extends UserFiles {
      */
     private rmObjFiles;
     archiveCurrentObjVersion(objId: string, version: number): Promise<void>;
-    listObjArchive(objId: string): Promise<number[]>;
+    getObjStatus(objId: string): Promise<ObjStatus>;
     static getSpaceQuota(store: Store): Promise<number>;
     static getKeyDerivParams(store: Store): Promise<any>;
     static setKeyDerivParams(store: Store, params: any, setDefault: boolean): Promise<boolean>;

package/build/3nstorage/resources/store.js

@@ -172,10 +172,7 @@ class Store extends user_files_1.UserFiles {
                     throw exports.SC.OBJ_FILE_INCOMPLETE;
                 }
                 await this.transactions.complete(objId, trans, file);
-                this.storageEventsSink(this.userId, owner_1.objChanged.EVENT_NAME, {
-                    objId,
-                    newVer: opts.ver
-                });
+                this.storageEventsSink(this.userId, owner_1.events.objChanged.EVENT_NAME, { objId, newVer: opts.ver });
             }
             else {
                 return trans.transactionId;
@@ -214,10 +211,7 @@ class Store extends user_files_1.UserFiles {
                     throw exports.SC.OBJ_FILE_INCOMPLETE;
                 }
                 await this.transactions.complete(objId, trans, file);
-                this.storageEventsSink(this.userId, owner_1.objChanged.EVENT_NAME, {
-                    objId,
-                    newVer: trans.version
-                });
+                this.storageEventsSink(this.userId, owner_1.events.objChanged.EVENT_NAME, { objId, newVer: trans.version });
             }
             else {
                 return opts.trans;
@@ -342,9 +336,7 @@ class Store extends user_files_1.UserFiles {
                 await this.rmObjFiles(objId, version);
             }
         }
-        this.storageEventsSink(this.userId, owner_1.objRemoved.EVENT_NAME, {
-            objId,
-        });
+        this.storageEventsSink(this.userId, owner_1.events.objRemoved.EVENT_NAME, { objId });
     }
     async deleteArchivedObjVer(objId, version) {
         const status = await this.statuses.get(objId);
@@ -368,9 +360,7 @@ class Store extends user_files_1.UserFiles {
         else if (status.currentVersion !== version) {
             await this.statuses.deleteWithObj(objId);
         }
-        // this.storageEventsSink(this.userId, objRemoved.EVENT_NAME, {
-        // 	objId,
-        // });
+        this.storageEventsSink(this.userId, owner_1.events.objArchivedVersionRemoved.EVENT_NAME, { objId, archivedVer: version });
     }
     /**
      * @param objId is a string object id for non-root objects, and null for
@@ -421,11 +411,14 @@ class Store extends user_files_1.UserFiles {
             status.archivedVersions = [status.currentVersion];
         }
         await this.statuses.set(objId, status);
+        this.storageEventsSink(this.userId, owner_1.events.objVersionArchived.EVENT_NAME, { objId, archivedVer: version });
     }
-    async listObjArchive(objId) {
+    async getObjStatus(objId) {
         const status = await this.statuses.get(objId);
-        const arch = status.archivedVersions;
-        return (Array.isArray(arch) ? arch : []);
+        return {
+            current: status.currentVersion,
+            archived: status.archivedVersions
+        };
     }
     static getSpaceQuota(store) {
         return store.getSpaceQuota();

package/build/3nstorage/resources/users.d.ts

@@ -6,7 +6,7 @@
  */
 import { Readable as ReadableStream } from 'stream';
 import { ObjReader, StorageEventsSink } from './store';
-import { PutObjFirstQueryOpts, PutObjSecondQueryOpts, DiffInfo } from '../../lib-common/service-api/3nstorage/owner';
+import { PutObjFirstQueryOpts, PutObjSecondQueryOpts, DiffInfo, ObjStatus } from '../../lib-common/service-api/3nstorage/owner';
 export { SC, ObjReader, MismatchedObjVerException } from './store';
 export declare type UserExists = (userId: string) => Promise<boolean>;
 export declare type GetCurrentObj = (userId: string, objId: string | null, header: boolean, segsOffset: number, segsLimit: number | undefined) => Promise<{
@@ -17,7 +17,7 @@ export declare type SaveNewObjVersion = (userId: string, objId: string | null, f
 export declare type GetArchivedObjVersion = (userId: string, objId: string | null, version: number, header: boolean, segsOffset: number, segsLimit: number | undefined) => Promise<ObjReader>;
 export declare type CancelTransaction = (userId: string, objId: string, transactionId?: string) => Promise<void>;
 export declare type ArchiveObjCurrentVersion = (userId: string, objId: string, version: number) => Promise<void>;
-export declare type ListObjArchive = (userId: string, objId: string) => Promise<number[]>;
+export declare type GetObjStatus = (userId: string, objId: string) => Promise<ObjStatus>;
 export declare type DeleteCurrentObjVersion = (userId: string, objId: string, version?: number) => Promise<void>;
 export declare type DeleteArchivedObjVersion = (userId: string, objId: string | null, version: number) => Promise<void>;
 declare type GetParam<T> = (userId: string) => Promise<T>;
@@ -39,7 +39,7 @@ export interface Factory {
     saveNewObjVersion: SaveNewObjVersion;
     saveNewRootVersion: SaveNewObjVersion;
     getCurrentRootObj: GetCurrentObj;
-    listObjArchive: ListObjArchive;
+    getObjStatus: GetObjStatus;
     archiveObjVersion: ArchiveObjCurrentVersion;
     getArchivedRootVersion: GetArchivedObjVersion;
     getArchivedObjVersion: GetArchivedObjVersion;

package/build/3nstorage/resources/users.js

@@ -130,9 +130,9 @@ function makeFactory(rootFolder, writeBufferSize, readBufferSize) {
             const store = await getStore(userId);
             await store.archiveCurrentObjVersion(objId, version);
         },
-        listObjArchive: async (userId, objId) => {
+        getObjStatus: async (userId, objId) => {
             const store = await getStore(userId);
-            return store.listObjArchive(objId);
+            return store.getObjStatus(objId);
         },
         deleteArchivedObjVersion: async (userId, objId, version) => {
             const store = await getStore(userId);

package/build/3nstorage/routes/owner/delete-obj.js

@@ -19,7 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteArchivedObjVer = exports.deleteCurrentObjVer = void 0;
 const users_1 = require("../../resources/users");
 const owner_1 = require("../../../lib-common/service-api/3nstorage/owner");
-const assert_1 = require("../../../tests/libs-for-tests/assert");
+const assert_1 = require("../../../lib-common/assert");
 function deleteObj(root, delCurrent, deleteObjFunc) {
     if ('function' !== typeof deleteObjFunc) {
         throw new TypeError("Given argument 'deleteObjFunc' must be function, but is not.");

package/build/3nstorage/routes/owner/get-obj-status.d.ts

@@ -0,0 +1,3 @@
+import { RequestHandler } from 'express';
+import { GetObjStatus } from '../../resources/users';
+export declare function getObjStatus(root: boolean, getObjStatusFunc: GetObjStatus): RequestHandler;

package/build/3nstorage/routes/owner/{list-obj-archive.js → get-obj-status.js}

@@ -16,26 +16,26 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.listObjArchive = void 0;
+exports.getObjStatus = void 0;
 const users_1 = require("../../resources/users");
 const owner_1 = require("../../../lib-common/service-api/3nstorage/owner");
-function listObjArchive(root, listObjArchiveFunc) {
-    if ('function' !== typeof listObjArchiveFunc) {
-        throw new TypeError("Given argument 'listObjArchiveFunc' must be function, but is not.");
+function getObjStatus(root, getObjStatusFunc) {
+    if ('function' !== typeof getObjStatusFunc) {
+        throw new TypeError("Given argument 'getObjStatusFunc' must be function, but is not.");
     }
     return async (req, res, next) => {
         const userId = req.session.params.userId;
         const objId = (root ? null : req.params.objId);
         try {
-            const lst = await listObjArchiveFunc(userId, objId);
-            res.status(owner_1.archiveObj.SC.okGet).json(lst);
+            const lst = await getObjStatusFunc(userId, objId);
+            res.status(owner_1.objStatus.SC.ok).json(lst);
         }
         catch (err) {
             if ("string" !== typeof err) {
                 next(err);
             }
             else if (err === users_1.SC.OBJ_UNKNOWN) {
-                res.status(owner_1.archiveObj.SC.unknownObj).send(root ?
+                res.status(owner_1.objStatus.SC.unknownObj).send(root ?
                     `Root object is set.` : `Object ${objId} is unknown.`);
             }
             else if (err === users_1.SC.USER_UNKNOWN) {
@@ -48,6 +48,6 @@ function listObjArchive(root, listObjArchiveFunc) {
         }
     };
 }
-exports.listObjArchive = listObjArchive;
+exports.getObjStatus = getObjStatus;
 ;
 Object.freeze(exports);

package/build/lib-common/service-api/3nstorage/owner.d.ts

@@ -109,6 +109,7 @@ export interface PutObjSecondQueryOpts {
 export declare namespace currentObj {
     const EXPRESS_URL_END = "obj/:objId/current";
     function getReqUrlEnd(objId: string, opts?: GetObjQueryOpts): string;
+    function delReqUrlEnd(objId: string, ver?: number): string;
     function firstPutReqUrlEnd(objId: string, opts: PutObjFirstQueryOpts): string;
     function secondPutReqUrlEnd(objId: string, opts: PutObjSecondQueryOpts): string;
     interface ReplyToPut {
@@ -214,13 +215,33 @@ export declare namespace cancelRootTransaction {
         missing: number;
     };
 }
+export interface ObjStatus {
+    current?: number;
+    archived?: number[];
+}
+export declare namespace objStatus {
+    const EXPRESS_URL_END = "obj/:objId/status";
+    function getReqUrlEnd(objId: string): string;
+    type Reply = ObjStatus;
+    const SC: {
+        ok: number;
+        unknownObj: number;
+    };
+}
+export declare namespace rootStatus {
+    const EXPRESS_URL_END = "root/status";
+    function getReqUrlEnd(): string;
+    type Reply = ObjStatus;
+    const SC: {
+        ok: number;
+        unknownObj: number;
+    };
+}
 export declare namespace archiveObj {
     const EXPRESS_URL_END = "obj/:objId/archive";
-    function getReqUrlEnd(objId: string): string;
     function postAndDelReqUrlEnd(objId: string, version: number): string;
     type VersionsList = number[];
     const SC: {
-        okGet: number;
         okPost: number;
         okDelete: number;
         unknownObj: number;
@@ -228,12 +249,10 @@ export declare namespace archiveObj {
     };
 }
 export declare namespace archiveRoot {
-    const URL_END = "root/archive";
-    function getReqUrlEnd(): string;
+    const EXPRESS_URL_END = "root/archive";
     function postAndDelReqUrlEnd(version: number): string;
     type VersionsList = archiveObj.VersionsList;
     const SC: {
-        okGet: number;
         okPost: number;
         okDelete: number;
         unknownObj: number;
@@ -249,23 +268,59 @@ export declare namespace wsEventChannel {
         ok: number;
     };
 }
-export declare namespace objChanged {
-    const EVENT_NAME = "obj-changed";
-    interface Event {
-        /**
-         * This indentifies a non-root object by its string id, while null value
-         * identifies root object.
-         */
-        objId: string | null;
-        newVer: number;
+export declare namespace events {
+    namespace objChanged {
+        const EVENT_NAME = "obj-changed";
+        interface Event {
+            /**
+             * This indentifies a non-root object by its string id, while null
+             * value identifies root object.
+             */
+            objId: string | null;
+            /**
+             * New current version on the server.
+             */
+            newVer: number;
+        }
     }
-}
-export declare namespace objRemoved {
-    const EVENT_NAME = "obj-removed";
-    interface Event {
-        /**
-         * This indentifies a removed non-root object by its string id.
-         */
-        objId: string;
+    namespace objRemoved {
+        const EVENT_NAME = "obj-removed";
+        interface Event {
+            /**
+             * This indentifies a removed non-root object by its string id.
+             */
+            objId: string;
+        }
+    }
+    namespace objVersionArchived {
+        const EVENT_NAME = "obj-ver-archived";
+        interface Event {
+            /**
+             * This indentifies a non-root object by its string id, while null
+             * value identifies root object.
+             */
+            objId: string | null;
+            /**
+             * Version that was set archived on the server.
+             */
+            archivedVer: number;
+        }
+    }
+    namespace objArchivedVersionRemoved {
+        const EVENT_NAME = "obj-ver-removed";
+        interface Event {
+            /**
+             * This indentifies a non-root object by its string id, while null
+             * value identifies root object.
+             */
+            objId: string | null;
+            /**
+             * Archived version that was removed on the server.
+             */
+            archivedVer: number;
+        }
     }
+    const all: string[];
+    type EventNameType = (typeof objChanged.EVENT_NAME) | (typeof objRemoved.EVENT_NAME) | (typeof objVersionArchived.EVENT_NAME) | (typeof objArchivedVersionRemoved.EVENT_NAME);
+    type AllTypes = objChanged.Event | objRemoved.Event | objVersionArchived.Event | objArchivedVersionRemoved.Event;
 }

package/build/lib-common/service-api/3nstorage/owner.js

@@ -16,7 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.objRemoved = exports.objChanged = exports.wsEventChannel = exports.archiveRoot = exports.archiveObj = exports.cancelRootTransaction = exports.cancelTransaction = exports.addDiffSectionTo = exports.sanitizedDiff = exports.archivedRootVersion = exports.archivedObjVersion = exports.currentRootObj = exports.currentObj = exports.keyDerivParams = exports.PARAM_SC = exports.sessionParams = exports.closeSession = exports.midLogin = exports.BIN_TYPE = exports.HTTP_HEADER = exports.ERR_SC = void 0;
+exports.events = exports.wsEventChannel = exports.archiveRoot = exports.archiveObj = exports.rootStatus = exports.objStatus = exports.cancelRootTransaction = exports.cancelTransaction = exports.addDiffSectionTo = exports.sanitizedDiff = exports.archivedRootVersion = exports.archivedObjVersion = exports.currentRootObj = exports.currentObj = exports.keyDerivParams = exports.PARAM_SC = exports.sessionParams = exports.closeSession = exports.midLogin = exports.BIN_TYPE = exports.HTTP_HEADER = exports.ERR_SC = void 0;
 /**
  * This defines interfaces for 3nstorage owner's requests.
  */
@@ -79,6 +79,10 @@ var currentObj;
         return `obj/${objId}/current${opts ? `?${(0, querystring_1.stringify)(opts)}` : ''}`;
     }
     currentObj.getReqUrlEnd = getReqUrlEnd;
+    function delReqUrlEnd(objId, ver) {
+        return `obj/${objId}/current${ver ? `?${(0, querystring_1.stringify)({ ver })}` : ''}`;
+    }
+    currentObj.delReqUrlEnd = delReqUrlEnd;
     function firstPutReqUrlEnd(objId, opts) {
         return `obj/${objId}/current?${(0, querystring_1.stringify)(opts)}`;
     }
@@ -220,19 +224,37 @@ var cancelRootTransaction;
     cancelRootTransaction.SC = cancelTransaction.SC;
 })(cancelRootTransaction = exports.cancelRootTransaction || (exports.cancelRootTransaction = {}));
 Object.freeze(cancelRootTransaction);
+var objStatus;
+(function (objStatus) {
+    objStatus.EXPRESS_URL_END = 'obj/:objId/status';
+    function getReqUrlEnd(objId) {
+        return `obj/${objId}/status`;
+    }
+    objStatus.getReqUrlEnd = getReqUrlEnd;
+    objStatus.SC = {
+        ok: 200,
+        unknownObj: 474,
+    };
+})(objStatus = exports.objStatus || (exports.objStatus = {}));
+Object.freeze(objStatus);
+var rootStatus;
+(function (rootStatus) {
+    rootStatus.EXPRESS_URL_END = 'root/status';
+    function getReqUrlEnd() {
+        return 'root/status';
+    }
+    rootStatus.getReqUrlEnd = getReqUrlEnd;
+    rootStatus.SC = objStatus.SC;
+})(rootStatus = exports.rootStatus || (exports.rootStatus = {}));
+Object.freeze(rootStatus);
 var archiveObj;
 (function (archiveObj) {
     archiveObj.EXPRESS_URL_END = 'obj/:objId/archive';
-    function getReqUrlEnd(objId) {
-        return `obj/${objId}/archive`;
-    }
-    archiveObj.getReqUrlEnd = getReqUrlEnd;
     function postAndDelReqUrlEnd(objId, version) {
         return `obj/${objId}/archive?ver=${version}`;
     }
     archiveObj.postAndDelReqUrlEnd = postAndDelReqUrlEnd;
     archiveObj.SC = {
-        okGet: 200,
         okPost: 200,
         okDelete: 200,
         unknownObj: 474,
@@ -242,11 +264,7 @@ var archiveObj;
 Object.freeze(archiveObj);
 var archiveRoot;
 (function (archiveRoot) {
-    archiveRoot.URL_END = 'root/archive';
-    function getReqUrlEnd() {
-        return `root/archive`;
-    }
-    archiveRoot.getReqUrlEnd = getReqUrlEnd;
+    archiveRoot.EXPRESS_URL_END = 'root/archive';
     function postAndDelReqUrlEnd(version) {
         return `root/archive?ver=${version}`;
     }
@@ -263,14 +281,34 @@ var wsEventChannel;
     Object.freeze(wsEventChannel.SC);
 })(wsEventChannel = exports.wsEventChannel || (exports.wsEventChannel = {}));
 Object.freeze(wsEventChannel);
-var objChanged;
-(function (objChanged) {
-    objChanged.EVENT_NAME = 'obj-changed';
-})(objChanged = exports.objChanged || (exports.objChanged = {}));
-Object.freeze(objChanged);
-var objRemoved;
-(function (objRemoved) {
-    objRemoved.EVENT_NAME = 'obj-removed';
-})(objRemoved = exports.objRemoved || (exports.objRemoved = {}));
-Object.freeze(objChanged);
+var events;
+(function (events) {
+    let objChanged;
+    (function (objChanged) {
+        objChanged.EVENT_NAME = 'obj-changed';
+    })(objChanged = events.objChanged || (events.objChanged = {}));
+    Object.freeze(objChanged);
+    let objRemoved;
+    (function (objRemoved) {
+        objRemoved.EVENT_NAME = 'obj-removed';
+    })(objRemoved = events.objRemoved || (events.objRemoved = {}));
+    Object.freeze(objRemoved);
+    let objVersionArchived;
+    (function (objVersionArchived) {
+        objVersionArchived.EVENT_NAME = 'obj-ver-archived';
+    })(objVersionArchived = events.objVersionArchived || (events.objVersionArchived = {}));
+    Object.freeze(objVersionArchived);
+    let objArchivedVersionRemoved;
+    (function (objArchivedVersionRemoved) {
+        objArchivedVersionRemoved.EVENT_NAME = 'obj-ver-removed';
+    })(objArchivedVersionRemoved = events.objArchivedVersionRemoved || (events.objArchivedVersionRemoved = {}));
+    Object.freeze(objArchivedVersionRemoved);
+    events.all = [
+        objChanged.EVENT_NAME,
+        objRemoved.EVENT_NAME,
+        objVersionArchived.EVENT_NAME,
+        objArchivedVersionRemoved.EVENT_NAME,
+    ];
+})(events = exports.events || (exports.events = {}));
+Object.freeze(events);
 Object.freeze(exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spec-3nweb-server",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "3NWeb spec server.",
   "main": "build/lib.js",
   "types": "build/lib.d.ts",

package/build/3nstorage/routes/owner/list-obj-archive.d.ts

@@ -1,3 +0,0 @@
-import { RequestHandler } from 'express';
-import { ListObjArchive } from '../../resources/users';
-export declare function listObjArchive(root: boolean, listObjArchiveFunc: ListObjArchive): RequestHandler;