spec-3nweb-server 1.8.5 → 1.8.7

package/.gitlab-ci-linux.yml

@@ -0,0 +1,50 @@
+
+#########
+# Linux #
+#########
+
+build for linux:
+  extends: build
+  rules: [ { when: on_success } ]
+  image: node-22
+
+
+test on linux:
+  extends: test
+  rules: [ { when: on_success } ]
+  needs:
+    - build for linux
+  image: node-22
+
+
+pack for linux:
+  extends: pack
+  rules: [ { when: on_success } ]
+  needs:
+    - build for linux
+    - test on linux
+  image: node-22
+
+
+pack mock for linux:
+  extends: pack mock
+  rules: [ { when: on_success } ]
+  needs:
+    - build for linux
+    - test on linux
+  image: node-22
+
+
+# pack deb:
+#   extends: pack
+#   rules: [ { when: on_success } ]
+#   needs:
+#     - build for linux
+#     - test on linux
+#   image: node-16
+#   script:
+#     - npm run pack-deb
+#   artifacts:
+#     paths:
+#       - 3nweb-*.deb
+#     expire_in: 3d

package/.gitlab-ci-mac.yml

@@ -0,0 +1,29 @@
+
+#########
+# MacOS #
+#########
+
+build for mac:
+  extends: build
+  rules: [ { when: on_success } ]
+  tags:
+    - mac-m1
+
+
+test on mac:
+  extends: test
+  rules: [ { when: on_success } ]
+  needs:
+    - build for mac
+  tags:
+    - mac-m1
+
+
+pack mock for mac:
+  extends: pack mock
+  rules: [ { when: on_success } ]
+  tags:
+    - mac-m1
+  needs:
+    - build for mac
+    - test on mac

package/.gitlab-ci-windows.yml

@@ -0,0 +1,29 @@
+
+###########
+# Windows #
+###########
+
+build for windows:
+  extends: build
+  rules: [ { when: on_success } ]
+  tags:
+    - windows
+
+
+test on windows:
+  extends: test
+  rules: [ { when: on_success } ]
+  needs:
+    - build for windows
+  tags:
+    - windows
+
+
+pack mock for windows:
+  extends: pack mock
+  rules: [ { when: on_success } ]
+  tags:
+    - windows
+  needs:
+    - build for windows
+    - test on windows

package/.gitlab-ci.yml

@@ -0,0 +1,63 @@
+stages:
+  - build
+  - test
+  - pack
+  - publish
+
+
+build:
+  rules: [ { when: never } ]
+  stage: build
+  script:
+    - npm ci
+    - npm run build
+  artifacts:
+    paths:
+      - node_modules/
+      - build/
+    expire_in: 1h
+
+
+test:
+  rules: [ { when: never } ]
+  stage: test
+  script:
+    - npm run test
+
+
+pack:
+  rules: [ { when: never } ]
+  stage: pack
+  script:
+    - npm run clear-for-packing
+  artifacts:
+    paths:
+      - build/
+      - node_modules/
+      - LICENSE
+      - package-lock.json
+      - package.json
+      - README.md
+    expire_in: 3d
+
+
+pack mock:
+  extends: pack
+  script:
+    - npm run clear-for-packing-mock
+
+
+publish to npm:
+  stage: publish
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "master"'
+      when: manual
+  image: node-22
+  script:
+    - bash publish-task.sh $NPM_PUBLISH_TOKEN
+
+
+include:
+  - .gitlab-ci-linux.yml
+  - .gitlab-ci-windows.yml
+  - .gitlab-ci-mac.yml

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

@@ -113,7 +113,7 @@ export declare class Store extends UserFiles<StorageParams> {
      * @return a promise, resolvable when version files are removed.
      */
     private rmObjFiles;
-    archiveCurrentObjVersion(objId: string, version: number): Promise<void>;
-    getObjStatus(objId: string): Promise<ObjStatus>;
+    archiveCurrentObjVersion(objId: string | null, version: number): Promise<void>;
+    getObjStatus(objId: string | null): Promise<ObjStatus>;
     setKeyDerivParams(params: any, setDefault: boolean): Promise<boolean>;
 }

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2017, 2019 - 2020, 2022, 2025 3NSoft Inc.
+ Copyright (C) 2015 - 2017, 2019 - 2020, 2022, 2025 - 2026 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software

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

@@ -15,9 +15,9 @@ export type GetCurrentObj = (userId: string, objId: string | null, header: boole
 }>;
 export type SaveNewObjVersion = (userId: string, objId: string | null, fstReq: PutObjFirstQueryOpts | undefined, diff: DiffInfo | undefined, sndReq: PutObjSecondQueryOpts | undefined, bytesLen: number, bytes: ReadableStream) => Promise<string | undefined>;
 export type GetArchivedObjVersion = (userId: string, objId: string | null, version: number, header: boolean, segsOffset: number, segsLimit: number | undefined) => Promise<ObjReader>;
-export type CancelTransaction = (userId: string, objId: string, transactionId?: string) => Promise<void>;
-export type ArchiveObjCurrentVersion = (userId: string, objId: string, version: number) => Promise<void>;
-export type GetObjStatus = (userId: string, objId: string) => Promise<ObjStatus>;
+export type CancelTransaction = (userId: string, objId: string | null, transactionId?: string) => Promise<void>;
+export type ArchiveObjCurrentVersion = (userId: string, objId: string | null, version: number) => Promise<void>;
+export type GetObjStatus = (userId: string, objId: string | null) => Promise<ObjStatus>;
 export type DeleteCurrentObjVersion = (userId: string, objId: string, version?: number) => Promise<void>;
 export type DeleteArchivedObjVersion = (userId: string, objId: string | null, version: number) => Promise<void>;
 export type GetSpaceQuota = (userId: string) => Promise<number>;

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2015 - 2017, 2020, 2025 3NSoft Inc.
+ Copyright (C) 2015 - 2017, 2020, 2025 - 2026 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software

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

@@ -0,0 +1,6 @@
+import { Response, Request } from 'express';
+export declare function getObjIdFromParams(rootObj: boolean, req: Request): {
+    objId: string | null;
+    objIdParseErr?: string;
+};
+export declare function replyWithErr(status: number, msg: string, res: Response, reqToDrainBytesFrom?: Request): void;

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

@@ -0,0 +1,41 @@
+"use strict";
+/*
+ Copyright (C) 2026 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.replyWithErr = exports.getObjIdFromParams = void 0;
+const buffer_utils_1 = require("../../lib-common/buffer-utils");
+const body_parsers_1 = require("../../lib-server/middleware/body-parsers");
+function getObjIdFromParams(rootObj, req) {
+    if (rootObj) {
+        return { objId: null };
+    }
+    else {
+        const objId = req.params.objId;
+        return ((!!objId && buffer_utils_1.base64urlSafe.allCharsFromAlphabet(objId)) ?
+            { objId } :
+            { objId: undefined, objIdParseErr: "Bad object id" });
+    }
+}
+exports.getObjIdFromParams = getObjIdFromParams;
+function replyWithErr(status, msg, res, reqToDrainBytesFrom) {
+    if (reqToDrainBytesFrom) {
+        (0, body_parsers_1.attachByteDrainToRequest)(reqToDrainBytesFrom);
+    }
+    res.status(status).json({ error: msg });
+}
+exports.replyWithErr = replyWithErr;
+Object.freeze(exports);

package/build/3nstorage/routes/owner/archive-obj-version.js

@@ -19,18 +19,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.archiveCurrentObjVersion = void 0;
 const users_1 = require("../../resources/users");
 const owner_1 = require("../../../lib-common/service-api/3nstorage/owner");
+const utils_1 = require("../../resources/utils");
 const SC = owner_1.archiveObj.SC;
 function archiveCurrentObjVersion(root, archiveObjVerFunc) {
-    if ('function' !== typeof archiveObjVerFunc) {
-        throw new TypeError("Given argument 'archiveObjVerFunc' must be function, but is not.");
-    }
     return async (req, res, next) => {
         const userId = req.session.params.userId;
-        const objId = (root ? null : req.params.objId);
+        const { objId, objIdParseErr } = (0, utils_1.getObjIdFromParams)(root, req);
+        if (objIdParseErr) {
+            return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, objIdParseErr, res);
+        }
         const version = parseInt(req.query.ver);
         if (isNaN(version) || (version < 1)) {
-            res.status(owner_1.ERR_SC.malformed).send("Bad query parameters");
-            return;
+            return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, "Bad query parameters", res);
         }
         try {
             await archiveObjVerFunc(userId, objId, version);
@@ -51,12 +51,10 @@ function archiveCurrentObjVersion(root, archiveObjVerFunc) {
                 }
             }
             else if (err === users_1.SC.OBJ_UNKNOWN) {
-                res.status(SC.unknownObj).send(root ?
-                    `Root object is not set.` :
-                    `Object ${objId} is unknown.`);
+                (0, utils_1.replyWithErr)(SC.unknownObj, (root ? `Root object is not set.` : `Object ${objId} is unknown.`), res);
             }
             else if (err === users_1.SC.USER_UNKNOWN) {
-                res.status(owner_1.ERR_SC.server).send("Recipient disappeared from the system.");
+                (0, utils_1.replyWithErr)(owner_1.ERR_SC.server, "Recipient disappeared from the system.", res);
                 req.session.close();
             }
             else {

package/build/3nstorage/routes/owner/cancel-trans.js

@@ -19,13 +19,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cancelTransaction = void 0;
 const users_1 = require("../../resources/users");
 const owner_1 = require("../../../lib-common/service-api/3nstorage/owner");
+const utils_1 = require("../../resources/utils");
 function cancelTransaction(root, cancelTransFunc) {
-    if ('function' !== typeof cancelTransFunc) {
-        throw new TypeError("Given argument 'cancelTransFunc' must be function, but is not.");
-    }
     return async (req, res, next) => {
         const userId = req.session.params.userId;
-        const objId = (root ? null : req.params.objId);
+        const { objId, objIdParseErr } = (0, utils_1.getObjIdFromParams)(root, req);
+        if (objIdParseErr) {
+            return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, objIdParseErr, res);
+        }
         const transactionId = req.params.transactionId;
         try {
             await cancelTransFunc(userId, objId, ((transactionId === '-') ? undefined : transactionId));

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

@@ -20,16 +20,17 @@ 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("../../../lib-common/assert");
+const utils_1 = require("../../resources/utils");
 function deleteObj(root, delCurrent, deleteObjFunc) {
-    if ('function' !== typeof deleteObjFunc) {
-        throw new TypeError("Given argument 'deleteObjFunc' must be function, but is not.");
-    }
     if (delCurrent) {
         (0, assert_1.assert)(!root);
     }
     return async (req, res, next) => {
         const userId = req.session.params.userId;
-        const objId = (root ? null : req.params.objId);
+        const { objId, objIdParseErr } = (0, utils_1.getObjIdFromParams)(root, req);
+        if (objIdParseErr) {
+            return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, objIdParseErr, res);
+        }
         const ver = parseInt(req.query.ver);
         let version;
         if (isNaN(ver)) {
@@ -37,14 +38,12 @@ function deleteObj(root, delCurrent, deleteObjFunc) {
                 version = undefined;
             }
             else {
-                res.status(owner_1.ERR_SC.malformed).send("Bad query parameters");
-                return;
+                return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, "Bad query parameters", res);
             }
         }
         else {
             if (ver < 1) {
-                res.status(owner_1.ERR_SC.malformed).send("Bad query parameters");
-                return;
+                return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, "Bad query parameters", res);
             }
             version = ver;
         }

package/build/3nstorage/routes/owner/get-archived-obj-ver.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2017, 2020 3NSoft Inc.
+ Copyright (C) 2017, 2020, 2026 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -21,6 +21,7 @@ const users_1 = require("../../resources/users");
 const owner_1 = require("../../../lib-common/service-api/3nstorage/owner");
 const error_1 = require("../../../lib-common/exceptions/error");
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");
+const utils_1 = require("../../resources/utils");
 function extractQueryOptions(req) {
     // query fields are string or undefined, yet, type info helps the show
     const query = req.query;
@@ -46,16 +47,15 @@ function extractQueryOptions(req) {
     return { header, limit, ofs, ver };
 }
 function getArchivedObjVersion(root, getArchivedObjFunc) {
-    if ('function' !== typeof getArchivedObjFunc) {
-        throw new TypeError("Given argument 'getArchivedObjFunc' must be function, but is not.");
-    }
     return async (req, res, next) => {
         const userId = req.session.params.userId;
-        const objId = (root ? null : req.params.objId);
+        const { objId, objIdParseErr } = (0, utils_1.getObjIdFromParams)(root, req);
+        if (objIdParseErr) {
+            return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, objIdParseErr, res);
+        }
         const opts = extractQueryOptions(req);
         if (!opts) {
-            res.status(owner_1.ERR_SC.malformed).send("Bad query parameters");
-            return;
+            return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, "Bad query parameters", res);
         }
         try {
             const reader = await getArchivedObjFunc(userId, objId, opts.ver, opts.header, opts.ofs, opts.limit);
@@ -86,16 +86,14 @@ function getArchivedObjVersion(root, getArchivedObjFunc) {
                 next(err);
             }
             else if (err === users_1.SC.OBJ_UNKNOWN) {
-                res.status(owner_1.archivedObjVersion.SC.unknownObj).send(objId ?
-                    `Object ${objId}is unknown.` : `Root object is not set`);
+                (0, utils_1.replyWithErr)(owner_1.archivedObjVersion.SC.unknownObj, (objId ? `Object ${objId}is unknown.` : `Root object is not set`), res);
             }
             else if (err === users_1.SC.OBJ_VER_UNKNOWN) {
-                res.status(owner_1.archivedObjVersion.SC.unknownObjVer).send(objId ?
-                    `Object ${objId}, version ${opts.ver} is unknown.` :
-                    `Root object version ${opts.ver} is not known.`);
+                (0, utils_1.replyWithErr)(owner_1.archivedObjVersion.SC.unknownObjVer, (objId ?
+                    `Object ${objId}, version ${opts.ver} is unknown.` : `Root object version ${opts.ver} is not known.`), res);
             }
             else if (err === users_1.SC.USER_UNKNOWN) {
-                res.status(owner_1.ERR_SC.server).send(`Recipient disappeared from the system.`);
+                (0, utils_1.replyWithErr)(owner_1.ERR_SC.server, `Recipient disappeared from the system.`, res);
                 req.session.close();
             }
             else {

package/build/3nstorage/routes/owner/get-current-obj.js

@@ -21,6 +21,7 @@ const users_1 = require("../../resources/users");
 const owner_1 = require("../../../lib-common/service-api/3nstorage/owner");
 const error_1 = require("../../../lib-common/exceptions/error");
 const buffer_utils_1 = require("../../../lib-common/buffer-utils");
+const utils_1 = require("../../resources/utils");
 function extractQueryOptions(req) {
     // query fields are string or undefined, yet, type info helps the show
     const query = req.query;
@@ -51,12 +52,12 @@ function extractQueryOptions(req) {
     return { header, limit, ofs, ver };
 }
 function getCurrentObj(root, getCurrentObjFunc) {
-    if ('function' !== typeof getCurrentObjFunc) {
-        throw new TypeError("Given argument 'getCurrentObjFunc' must be function, but is not.");
-    }
     return async (req, res, next) => {
         const userId = req.session.params.userId;
-        const objId = (root ? null : req.params.objId);
+        const { objId, objIdParseErr } = (0, utils_1.getObjIdFromParams)(root, req);
+        if (objIdParseErr) {
+            return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, objIdParseErr, res);
+        }
         const opts = extractQueryOptions(req);
         if (!opts) {
             res.status(owner_1.ERR_SC.malformed).send("Bad query parameters");
@@ -102,10 +103,10 @@ function getCurrentObj(root, getCurrentObjFunc) {
             }
             else if ((err === users_1.SC.OBJ_UNKNOWN)
                 || (err === users_1.SC.OBJ_VER_UNKNOWN)) {
-                res.status(owner_1.currentObj.SC.unknownObj).send(objId ? `Object ${objId} is unknown.` : `Root object is not set.`);
+                (0, utils_1.replyWithErr)(owner_1.currentObj.SC.unknownObj, (objId ? `Object ${objId} is unknown.` : `Root object is not set.`), res);
             }
             else if (err === users_1.SC.USER_UNKNOWN) {
-                res.status(owner_1.ERR_SC.server).send(`Recipient disappeared from the system.`);
+                (0, utils_1.replyWithErr)(owner_1.ERR_SC.server, `Recipient disappeared from the system.`, res);
                 req.session.close();
             }
             else {

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2022 3NSoft Inc.
+ Copyright (C) 2022, 2026 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -19,13 +19,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getObjStatus = void 0;
 const users_1 = require("../../resources/users");
 const owner_1 = require("../../../lib-common/service-api/3nstorage/owner");
+const utils_1 = require("../../resources/utils");
 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);
+        const { objId, objIdParseErr } = (0, utils_1.getObjIdFromParams)(root, req);
+        if (objIdParseErr) {
+            return (0, utils_1.replyWithErr)(owner_1.ERR_SC.malformed, objIdParseErr, res);
+        }
         try {
             const lst = await getObjStatusFunc(userId, objId);
             res.status(owner_1.objStatus.SC.ok).json(lst);
@@ -35,11 +36,10 @@ function getObjStatus(root, getObjStatusFunc) {
                 next(err);
             }
             else if (err === users_1.SC.OBJ_UNKNOWN) {
-                res.status(owner_1.objStatus.SC.unknownObj).send(root ?
-                    `Root object is set.` : `Object ${objId} is unknown.`);
+                (0, utils_1.replyWithErr)(owner_1.objStatus.SC.unknownObj, (root ? `Root object is set.` : `Object ${objId} is unknown.`), res);
             }
             else if (err === users_1.SC.USER_UNKNOWN) {
-                res.status(owner_1.ERR_SC.server).send("Recipient disappeared from the system.");
+                (0, utils_1.replyWithErr)(owner_1.ERR_SC.server, "Recipient disappeared from the system.", res);
                 req.session.close();
             }
             else {