proto.io 0.0.172 → 0.0.174

package/dist/internals/{index-BJP46VGq.js → index-S_gTMQBh.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var index = require('./index-CVutVPmd.js');
+var index = require('./index-DXuW8UiB.js');
 var _ = require('lodash');
 var Decimal = require('decimal.js');
 var utilsJs = require('@o2ter/utils-js');
@@ -47,9 +47,17 @@ const mergeOpts = (lhs, rhs) => {
         },
     };
 };
+/**
+ * Base class for query filters.
+ */
 class TQueryFilterBase {
     /** @internal */
     [_private.PVK] = { options: {} };
+    /**
+     * Applies a filter to the query.
+     * @param filter - The filter to apply.
+     * @returns The current instance for chaining.
+     */
     filter(filter) {
         if (_.isNil(this[_private.PVK].options.filter)) {
             this[_private.PVK].options.filter = filter;
@@ -62,70 +70,193 @@ class TQueryFilterBase {
         }
         return this;
     }
+    /**
+     * Applies an equality filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     equalTo(key, value) {
         return this.filter({ [key]: { $eq: value ?? null } });
     }
+    /**
+     * Applies a not equal filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     notEqualTo(key, value) {
         return this.filter({ [key]: { $ne: value ?? null } });
     }
+    /**
+     * Applies a less than filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     lessThan(key, value) {
         return this.filter({ [key]: { $lt: value ?? null } });
     }
+    /**
+     * Applies a greater than filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     greaterThan(key, value) {
         return this.filter({ [key]: { $gt: value ?? null } });
     }
+    /**
+     * Applies a less than or equal to filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     lessThanOrEqualTo(key, value) {
         return this.filter({ [key]: { $lte: value ?? null } });
     }
+    /**
+     * Applies a greater than or equal to filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     greaterThanOrEqualTo(key, value) {
         return this.filter({ [key]: { $gte: value ?? null } });
     }
+    /**
+     * Applies a pattern filter to the query.
+     * @param key - The key to filter.
+     * @param value - The pattern to filter.
+     * @returns The current instance for chaining.
+     */
     pattern(key, value) {
         return this.filter({ [key]: { $pattern: value ?? null } });
     }
+    /**
+     * Applies a starts with filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     startsWith(key, value) {
         return this.filter({ [key]: { $starts: value ?? null } });
     }
+    /**
+     * Applies an ends with filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     endsWith(key, value) {
         return this.filter({ [key]: { $ends: value ?? null } });
     }
+    /**
+     * Applies a size filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     size(key, value) {
         return this.filter({ [key]: { $size: value } });
     }
+    /**
+     * Applies an empty filter to the query.
+     * @param key - The key to filter.
+     * @returns The current instance for chaining.
+     */
     empty(key) {
         return this.filter({ [key]: { $empty: true } });
     }
+    /**
+     * Applies a not empty filter to the query.
+     * @param key - The key to filter.
+     * @returns The current instance for chaining.
+     */
     notEmpty(key) {
         return this.filter({ [key]: { $empty: false } });
     }
+    /**
+     * Filters the query to include only documents where the specified key contains any of the specified values.
+     * @param key - The key to check for values.
+     * @param value - The array of values to check for.
+     * @returns The current instance for chaining.
+     */
     containsIn(key, value) {
         return this.filter({ [key]: { $in: value } });
     }
+    /**
+     * Filters the query to exclude documents where the specified key contains any of the specified values.
+     * @param key - The key to check for values.
+     * @param value - The array of values to exclude.
+     * @returns The current instance for chaining.
+     */
     notContainsIn(key, value) {
         return this.filter({ [key]: { $nin: value } });
     }
+    /**
+     * Filters the query to include only documents where the specified key is a subset of the specified values.
+     * @param key - The key to check for subset.
+     * @param value - The array of values to check against.
+     * @returns The current instance for chaining.
+     */
     isSubset(key, value) {
         return this.filter({ [key]: { $subset: value } });
     }
+    /**
+     * Filters the query to include only documents where the specified key is a superset of the specified values.
+     * @param key - The key to check for superset.
+     * @param value - The array of values to check against.
+     * @returns The current instance for chaining.
+     */
     isSuperset(key, value) {
         return this.filter({ [key]: { $superset: value } });
     }
+    /**
+     * Filters the query to include only documents where the specified key is disjoint from the specified values.
+     * @param key - The key to check for disjoint.
+     * @param value - The array of values to check against.
+     * @returns The current instance for chaining.
+     */
     isDisjoint(key, value) {
         return this.filter({ [key]: { $not: { $intersect: value } } });
     }
+    /**
+     * Filters the query to include only documents where the specified key intersects with the specified values.
+     * @param key - The key to check for intersection.
+     * @param value - The array of values to check against.
+     * @returns The current instance for chaining.
+     */
     isIntersect(key, value) {
         return this.filter({ [key]: { $intersect: value } });
     }
+    /**
+     * Filters the query to include only documents where every element of the specified key matches the provided callback query.
+     * @param key - The key to check for every element.
+     * @param callback - The callback query to apply to each element.
+     * @returns The current instance for chaining.
+     */
     every(key, callback) {
         const query = new TQueryFilterBase();
         callback(query);
         return this.filter({ [key]: { $every: { $and: _.castArray(query[_private.PVK].options.filter) } } });
     }
+    /**
+     * Filters the query to include only documents where some elements of the specified key match the provided callback query.
+     * @param key - The key to check for some elements.
+     * @param callback - The callback query to apply to each element.
+     * @returns The current instance for chaining.
+     */
     some(key, callback) {
         const query = new TQueryFilterBase();
         callback(query);
         return this.filter({ [key]: { $some: { $and: _.castArray(query[_private.PVK].options.filter) } } });
     }
+    /**
+     * Filters the query to include only documents that match all of the provided callback queries.
+     * @param callbacks - The callback queries to apply.
+     * @returns The current instance for chaining.
+     */
     and(...callbacks) {
         return this.filter({
             $and: _.flatMap(_.flatten(callbacks), callback => {
@@ -135,6 +266,11 @@ class TQueryFilterBase {
             }),
         });
     }
+    /**
+     * Filters the query to include only documents that match any of the provided callback queries.
+     * @param callbacks - The callback queries to apply.
+     * @returns The current instance for chaining.
+     */
     or(...callbacks) {
         return this.filter({
             $or: _.map(_.flatten(callbacks), callback => {
@@ -146,6 +282,11 @@ class TQueryFilterBase {
             }),
         });
     }
+    /**
+     * Filters the query to include only documents that do not match any of the provided callback queries.
+     * @param callbacks - The callback queries to apply.
+     * @returns The current instance for chaining.
+     */
     nor(...callbacks) {
         return this.filter({
             $nor: _.map(_.flatten(callbacks), callback => {
@@ -161,22 +302,43 @@ class TQueryFilterBase {
 class TQueryBase extends TQueryFilterBase {
     /** @internal */
     [_private.PVK] = { options: {} };
+    /**
+     * Sorts the query results.
+     * @param sort - The sorting criteria.
+     * @returns The current instance for chaining.
+     */
     sort(sort) {
         this[_private.PVK].options.sort = sort;
         return this;
     }
+    /**
+     * Skips the specified number of results.
+     * @param skip - The number of results to skip.
+     * @returns The current instance for chaining.
+     */
     skip(skip) {
         if (!_.isSafeInteger(skip) || skip < 0)
             throw Error('Invalid skip number');
         this[_private.PVK].options.skip = skip;
         return this;
     }
+    /**
+     * Limits the number of results.
+     * @param limit - The maximum number of results to return.
+     * @returns The current instance for chaining.
+     */
     limit(limit) {
         if (!_.isSafeInteger(limit) || limit < 0)
             throw Error('Invalid limit number');
         this[_private.PVK].options.limit = limit;
         return this;
     }
+    /**
+     * Performs a nested query on a specific key.
+     * @param key - The key to match.
+     * @param callback - The callback function to execute.
+     * @returns The current instance for chaining.
+     */
     match(key, callback) {
         const query = new TQueryBase();
         callback(query);
@@ -219,27 +381,62 @@ class TQueryBase extends TQueryFilterBase {
 //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 //  THE SOFTWARE.
 //
+/**
+ * Abstract base class for queries.
+ */
 class TQuery extends TQueryBase {
     /** @internal */
     [_private.PVK] = { options: {} };
+    /**
+     * Adds fields to include in the query.
+     * @param includes - The fields to include.
+     * @returns The query instance.
+     */
     includes(...includes) {
         this[_private.PVK].options.includes = this[_private.PVK].options.includes ? [...this[_private.PVK].options.includes, ...includes] : includes;
         return this;
     }
+    /**
+     * Gets a record by its ID.
+     * @param id - The ID of the record.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the record or undefined.
+     */
     async get(id, options) {
         return _.first(await this.clone().equalTo('_id', id).limit(1).find(options));
     }
+    /**
+     * Gets the first record.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the first record or undefined.
+     */
     async first(options) {
         return _.first(await this.clone().limit(1).find(options));
     }
+    /**
+     * Gets a random record.
+     * @param opts - Options for the random selection.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the random record or undefined.
+     */
     async randomOne(opts, options) {
         return _.first(await this.clone().limit(1).random(opts, options));
     }
+    /**
+     * Checks if any records exist.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to a boolean indicating if any records exist.
+     */
     async exists(options) {
         const query = this.clone();
         this[_private.PVK].options.includes = [];
         return !_.isNil(await query.limit(1).find(options));
     }
+    /**
+     * Iterates over each batch of records.
+     * @param callback - The callback to execute for each batch.
+     * @param options - Extra options for the query.
+     */
     async eachBatch(callback, options) {
         const sorting = this[_private.PVK].options.sort ?? {};
         const batchSize = options?.batchSize ?? 100;
@@ -255,6 +452,7 @@ class TQuery extends TQueryBase {
         const keys = _.keys(sorting);
         let batch = [];
         while (true) {
+            options?.abortSignal?.throwIfAborted();
             const q = _.isEmpty(batch) ? query : query.clone()
                 .filter(keys.length > 1 ? {
                 $expr: {
@@ -272,6 +470,11 @@ class TQuery extends TQueryBase {
             await callback(batch);
         }
     }
+    /**
+     * Iterates over each record.
+     * @param callback - The callback to execute for each record.
+     * @param options - Extra options for the query.
+     */
     async each(callback, options) {
         await this.eachBatch(async (batch) => {
             for (const object of batch) {
@@ -364,22 +567,46 @@ class TUser extends index.TObject {
 //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 //  THE SOFTWARE.
 //
+/**
+ * Class representing a Role.
+ * @extends TObject
+ */
 class TRole extends index.TObject {
     constructor(attributes) {
         super('Role', attributes);
     }
+    /**
+     * Get the name of the role.
+     * @return {string | undefined} The name of the role.
+     */
     get name() {
         return this.get('name');
     }
+    /**
+     * Get the users associated with the role.
+     * @return {TUser[]} The users associated with the role.
+     */
     get users() {
         return this.get('users') ?? [];
     }
+    /**
+     * Set the users associated with the role.
+     * @param {TUser[]} value - The users to associate with the role.
+     */
     set users(value) {
         this.set('users', value);
     }
+    /**
+     * Get the roles associated with the role.
+     * @return {TRole[]} The roles associated with the role.
+     */
     get roles() {
         return this.get('roles') ?? [];
     }
+    /**
+     * Set the roles associated with the role.
+     * @param {TRole[]} value - The roles to associate with the role.
+     */
     set roles(value) {
         this.set('roles', value);
     }
@@ -409,19 +636,38 @@ class TRole extends index.TObject {
 //  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 //  THE SOFTWARE.
 //
+/**
+ * Class representing a file.
+ */
 class TFile extends index.TObject {
     constructor(attributes) {
         super('File', attributes);
     }
+    /**
+     * Gets the filename of the file.
+     * @returns The filename.
+     */
     get filename() {
         return this.get('filename');
     }
+    /**
+     * Gets the size of the file.
+     * @returns The size of the file.
+     */
     get size() {
         return this.get('size');
     }
+    /**
+     * Gets the type of the file.
+     * @returns The type of the file.
+     */
     get type() {
         return this.get('type');
     }
+    /**
+     * Gets the token of the file.
+     * @returns The token of the file.
+     */
     get token() {
         return this.get('token');
     }
@@ -655,6 +901,10 @@ const applyObjectMethods = (object, proto) => {
 //  THE SOFTWARE.
 //
 class ProtoType {
+    /**
+     * Checks if the server is online.
+     * @returns A promise that resolves to a boolean indicating if the server is online.
+     */
     async online() {
         try {
             const res = await axios({
@@ -668,14 +918,32 @@ class ProtoType {
             return false;
         }
     }
+    /**
+     * Rebinds an object to the proto instance.
+     * @param object - The object to rebind.
+     * @returns The rebinded object.
+     */
     rebind(object) {
         return applyObjectMethods(object, this);
     }
+    /**
+     * Creates a new object.
+     * @param className - The name of the class to create.
+     * @param objectId - The ID of the object to create.
+     * @returns The created object.
+     */
     Object(className, objectId) {
         const attrs = objectId ? { _id: objectId } : {};
         const obj = isObjKey(className, TObjectTypes) ? new TObjectTypes[className](attrs) : new index.TObject(className, attrs);
         return this.rebind(obj);
     }
+    /**
+     * Creates a new file object.
+     * @param filename - The name of the file.
+     * @param data - The file data.
+     * @param type - The type of the file.
+     * @returns The created file object.
+     */
     File(filename, data, type) {
         const file = this.Object('File');
         file.set('filename', filename);
@@ -930,6 +1198,15 @@ class _ProtoClientQuery extends TQuery {
             ...this._queryOptions,
         }, this._requestOpt(options));
     }
+    updateMany(update, options) {
+        return this._proto[_private.PVK].request(this._proto, {
+            operation: 'updateMany',
+            context: options?.context ?? {},
+            silent: options?.silent,
+            update,
+            ...this._queryOptions,
+        }, this._requestOpt(options));
+    }
     upsertOne(update, setOnInsert, options) {
         return this._proto[_private.PVK].request(this._proto, {
             operation: 'upsertOne',
@@ -940,6 +1217,16 @@ class _ProtoClientQuery extends TQuery {
             ...this._queryOptions,
         }, this._requestOpt(options));
     }
+    upsertMany(update, setOnInsert, options) {
+        return this._proto[_private.PVK].request(this._proto, {
+            operation: 'upsertMany',
+            context: options?.context ?? {},
+            silent: options?.silent,
+            update,
+            setOnInsert,
+            ...this._queryOptions,
+        }, this._requestOpt(options));
+    }
     deleteOne(options) {
         return this._proto[_private.PVK].request(this._proto, {
             operation: 'deleteOne',
@@ -1528,4 +1815,4 @@ exports.isQuery = isQuery;
 exports.isRole = isRole;
 exports.isUser = isUser;
 exports.serialize = serialize;
-//# sourceMappingURL=index-BJP46VGq.js.map
+//# sourceMappingURL=index-S_gTMQBh.js.map