@futdevpro/nts-dynamo 1.5.53 → 1.5.55

package/lib/_services/dynamo-nts-data.service.d.ts

@@ -23,23 +23,23 @@ export declare class DynamoNTS_DataService<T extends Dynamo_Metadata> {
     dataDBService: DynamoNTS_DBService<T>;
     data: T;
     dataList: T[];
-    issuer?: string;
+    issuer: string;
     depKey?: string;
     depDBServiceKey?: string;
     private depDataDBService;
     dataParams: DynamoNTS_DataParams;
     defaultErrorUserMsg: string;
     defaultValidationErrorUserMsg: string;
-    constructor(data: T, dataParams: DynamoNTS_DataParams, issuer?: string);
+    constructor(data: T, dataParams: DynamoNTS_DataParams, issuer: string);
     /**
      * returns all data from database to service dataList
      */
-    getAll(): Promise<void>;
+    getAll(dontSetToService?: boolean): Promise<T[]>;
     /**
      * @description
      * returns data from database by id
      * also if dontSetToService is false or not setted,
-     * the data will be saved to the service
+     * the data will be saved to the service, even if its not found
      *
      * @remarks
      * If you need to get-save a data, if possible,
@@ -60,11 +60,124 @@ export declare class DynamoNTS_DataService<T extends Dynamo_Metadata> {
      * returns dataList from database by dependencyId to the service
      * @param dependencyId
      */
-    getDataListByDependencyId(dependencyId?: string): Promise<void>;
+    getDataListByDependencyId(dependencyId?: string, dontSetToService?: boolean): Promise<T[]>;
+    /**
+     *
+     * // findOne desc:
+     *
+     * Find the data first by any of its parameters,
+     * also if dontSetToService is false or not setted,
+     * the data will be saved to the service, even if non found
+     *
+     * @param filter if you can, use unique parameters for find!
+     *
+     * @example
+     * // by email:
+     * { email: email }
+     * //
+     * @example
+     * // or by id that is in list:
+     * { userIds: { $in: this.userId } }
+     * //
+     * @example
+     * // or by number or Date that is Greater Than AND Less Than:
+     * { points: { $gt: 2, $lt: 14 } }
+     * // further tools (syntax matches with $gt):
+     * $eq:  // Matches values that are EQual to a specified value.
+     * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+     * $lte: // Matches values that are Less Than or Equal to a specified value.
+     * $ne:  // Matches all values that are Not Equal to a specified value.
+     * $nin: // Matches None of the values specified IN an array.
+     * //
+     * @returns {T} data: T
+     */
+    findData(findBy: any, dontSetToService?: boolean): Promise<T>;
+    /**
+     *
+     * // find desc:
+     *
+     * Find the data first by any of its parameters,
+     * also if dontSetToService is false or not setted,
+     * the data will be saved to the service, even if non found
+     *
+     * @param filter if you can, use unique parameters for find!
+     *
+     * @example
+     * // by email:
+     * { email: email }
+     * //
+     * @example
+     * // or by id that is in list:
+     * { userIds: { $in: this.userId } }
+     * //
+     * @example
+     * // or by number or Date that is Greater Than AND Less Than:
+     * { points: { $gt: 2, $lt: 14 } }
+     * // further tools (syntax matches with $gt):
+     * $eq:  // Matches values that are EQual to a specified value.
+     * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+     * $lte: // Matches values that are Less Than or Equal to a specified value.
+     * $ne:  // Matches all values that are Not Equal to a specified value.
+     * $nin: // Matches None of the values specified IN an array.
+     * //
+     * @returns {T[]} dataList: T[]
+     */
+    findDatas(findBy: any, dontSetToService?: boolean): Promise<T[]>;
     /**
      * This function uses the dataDBService.updateOne function.
      * This uses updateBy if setted, or data._id if its setted or this.data[this.dependencyKey]
      * @param set
+     *
+     * // updateOne desc:
+     *
+     * Find the data first by any of its parameters, throws error if not found
+     * @param filter This uses the basic Mongoose updateOne.
+     * If you can, use unique parameters for find!
+     * @example
+     * // by email:
+     * { email: email }
+     * //
+     * @example
+     * // or by id that is in list:
+     * { userIds: { $in: this.userId } }
+     * //
+     * @example
+     * // or by number or Date that is Greater Than AND Less Than:
+     * { points: { $gt: 2, $lt: 14 } }
+     * // further tools (syntax matches with $gt):
+     * $eq:  // Matches values that are EQual to a specified value.
+     * $gte: // Matches values that are Greater Than OR Equal to a specified value.
+     * $lte: // Matches values that are Less Than or Equal to a specified value.
+     * $ne:  // Matches all values that are Not Equal to a specified value.
+     * $nin: // Matches None of the values specified IN an array.
+     * //
+     *
+     * @param update this uses the basic Mongoose updateOne
+     * @example
+     * // increase a specific value (here by 15):
+     * { $inc: { popularity: 15 } }
+     * //
+     * @example
+     * // or add element to a list:
+     * { $push: { reactions: this.newReaction }
+     * // or add multiple elements to a list
+     * { $push: { schedule: {$each: [ monday, tuesday, wednesday ] } } }
+     * //
+     * @example
+     * // or all at once
+     * {
+     *   $inc: { popularity: this.newVote.amount },
+     *   emailVerified: true,
+     *   $push: { reactions: this.newReaction }
+     * }
+     * // further tools (syntax matches with $inc):
+     * $currentDate: // Sets the value of a field to current date, either as a Date or a Timestamp.
+     * $min:         // Only updates the field if the specified value is less than the existing field value.
+     * $max:         // Only updates the field if the specified value is greater than the existing field value.
+     * $mul:         // Multiplies the value of the field by the specified amount.
+     * $rename:      // Renames a field.
+     * $unset:       // Removes the specified field from a document. (set: "" to value)
+     * //
      */
     updateData(set: {
         updateBy?: any;
@@ -74,6 +187,7 @@ export declare class DynamoNTS_DataService<T extends Dynamo_Metadata> {
      * modifies data if the data have ID and already exists in the DB,
      * creates new if the ID is not present or cant find in DB,
      * and if dependency data setted up, will check before creation,
+     *
      * @warning
      * but the proper way to update data, if you use update method instead,
      * this way, you can avoid data override errors

package/lib/_services/dynamo-nts-data.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dynamo-nts-data.service.d.ts","sourceRoot":"","sources":["../../src/_services/dynamo-nts-data.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAA8C,MAAM,uBAAuB,CAAC;AAE1H,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAG9D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,qBAAqB,CAAC,CAAC,SAAS,eAAe;IAC1D,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC;IACR,QAAQ,EAAE,CAAC,EAAE,CAAM;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,gBAAgB,CAA2B;IAGnD,UAAU,EAAE,oBAAoB,CAAC;IAEjC,mBAAmB,SAA8F;IACjH,6BAA6B,SAAoG;gBAG/H,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,oBAAoB,EAChC,MAAM,CAAC,EAAE,MAAM;IAUjB;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAe7B;;;;;;;;;;;;;;OAcG;IACG,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IA6BtE;;;OAGG;IACG,qBAAqB,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAuC1F;;;OAGG;IACG,yBAAyB,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmCrE;;;;OAIG;IACG,UAAU,CAAC,GAAG,EAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BrE;;;;;;;;;OASG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAmD/B;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBjC;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IA6CtC;;OAEG;IACH,OAAO,CAAC,6BAA6B;IAUrC;;;OAGG;IACH,0BAA0B,IAAI,mBAAmB,CAAC,GAAG,CAAC;CAkBvD"}
+{"version":3,"file":"dynamo-nts-data.service.d.ts","sourceRoot":"","sources":["../../src/_services/dynamo-nts-data.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,oBAAoB,EAA6D,MAAM,uBAAuB,CAAC;AAEzI,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAI9D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,qBAAqB,CAAC,CAAC,SAAS,eAAe;IAC1D,aAAa,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC;IACR,QAAQ,EAAE,CAAC,EAAE,CAAM;IACnB,MAAM,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,OAAO,CAAC,gBAAgB,CAA2B;IAEnD,UAAU,EAAE,oBAAoB,CAAC;IAEjC,mBAAmB,SAA8F;IACjH,6BAA6B,SAAoG;gBAG/H,IAAI,EAAE,CAAC,EACP,UAAU,EAAE,oBAAoB,EAChC,MAAM,EAAE,MAAM;IAShB;;OAEG;IACG,MAAM,CAAC,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IA2BtD;;;;;;;;;;;;;;OAcG;IACG,WAAW,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAyCtE;;;OAGG;IACG,qBAAqB,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IAmD1F;;;OAGG;IACG,yBAAyB,CAAC,YAAY,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAmDhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC;IA2BnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,SAAS,CAAC,MAAM,EAAE,GAAG,EAAE,gBAAgB,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IA2BtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuDG;IACG,UAAU,CAAC,GAAG,EAAE;QAAE,QAAQ,CAAC,EAAE,GAAG,CAAC;QAAC,MAAM,EAAE,GAAG,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCrE;;;;;;;;;;OAUG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAqE/B;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IA6BjC;;OAEG;IACG,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IA4DtC;;OAEG;IACH,OAAO,CAAC,6BAA6B;IAUrC;;;OAGG;IACH,0BAA0B,IAAI,mBAAmB,CAAC,GAAG,CAAC;CAkBvD"}