@squiz/optimization-utils 4.5.0 → 4.6.1

package/dist/data-structures/Result.d.ts

@@ -1,5 +1,5 @@
 export type ResultType = 'success' | 'failure';
-export declare class Result<TData, TError = Error> {
+export declare class Result<TData, TError = never> {
     readonly type: ResultType;
     readonly data?: TData;
     readonly error?: TError;
@@ -14,7 +14,10 @@ export declare class Result<TData, TError = Error> {
         error: TError;
         type: 'failure';
     };
-    isErrorInstanceOf(...errorTypes: Array<new (...args: Array<any>) => any>): boolean;
+    isErrorInstanceOf<ThisType extends Result<unknown, unknown>, T extends Array<new (...args: Array<any>) => any>>(this: ThisType, ...errorTypes: T): this is Omit<Result<TData>, 'error'> & {
+        error: T[number];
+        type: 'failure';
+    };
     throw(): never | void;
     unwrap(): TData;
     match<TResult, TErrorResult>(handlers: {

package/dist/data-structures/Result.js

@@ -22,9 +22,7 @@ class Result {
     isFailure() {
         return this.type === 'failure';
     }
-    isErrorInstanceOf(
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    ...errorTypes) {
+    isErrorInstanceOf(...errorTypes) {
         return errorTypes.some((errorType) => this.error instanceof errorType);
     }
     throw() {

package/dist/data-structures/Result.js.map

@@ -1 +1 @@
-{"version":3,"file":"Result.js","sourceRoot":"","sources":["../../src/data-structures/Result.ts"],"names":[],"mappings":";;;AAEA,MAAa,MAAM;IACD,IAAI,CAAa;IACjB,IAAI,CAAS;IACb,KAAK,CAAU;IAE/B,YAAoB,IAAgB,EAAE,IAAY,EAAE,KAAc;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,OAAO,CAAI,IAAQ;QACxB,OAAO,IAAI,MAAM,CAAW,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM,CAAC,OAAO,CAAS,KAAa;QAClC,OAAO,IAAI,MAAM,CAAgB,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED,SAAS;QAGP,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACjC,CAAC;IAED,SAAS;QAMP,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACjC,CAAC;IAED,iBAAiB;IACf,8DAA8D;IAC9D,GAAG,UAAmD;QAEtD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,YAAY,SAAS,CAAC,CAAC;IACzE,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,KAAK,CAAC;QACnB,CAAC;IACH,CAAC;IAED,MAAM;QACJ,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,KAAK,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,IAAK,CAAC;QACpB,CAAC;IACH,CAAC;IAED,KAAK,CAAwB,QAG5B;QACC,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAK,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAM,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;CACF;AAjED,wBAiEC"}
+{"version":3,"file":"Result.js","sourceRoot":"","sources":["../../src/data-structures/Result.ts"],"names":[],"mappings":";;;AAEA,MAAa,MAAM;IACD,IAAI,CAAa;IACjB,IAAI,CAAS;IACb,KAAK,CAAU;IAE/B,YAAoB,IAAgB,EAAE,IAAY,EAAE,KAAc;QAChE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,OAAO,CAAI,IAAQ;QACxB,OAAO,IAAI,MAAM,CAAW,SAAS,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1D,CAAC;IAED,MAAM,CAAC,OAAO,CAAS,KAAa;QAClC,OAAO,IAAI,MAAM,CAAgB,SAAS,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC;IAChE,CAAC;IAED,SAAS;QAGP,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACjC,CAAC;IAED,SAAS;QAMP,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACjC,CAAC;IAED,iBAAiB,CAMf,GAAG,UAAa;QAKhB,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,YAAY,SAAS,CAAC,CAAC;IACzE,CAAC;IAED,KAAK;QACH,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,KAAK,CAAC;QACnB,CAAC;IACH,CAAC;IAED,MAAM;QACJ,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,MAAM,IAAI,CAAC,KAAK,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,IAAK,CAAC;QACpB,CAAC;IACH,CAAC;IAED,KAAK,CAAwB,QAG5B;QACC,IAAI,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACrB,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAK,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;aAAM,CAAC;YACN,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,KAAM,EAAE,IAAI,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;CACF;AAxED,wBAwEC"}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './types/class-utilities-types';
 export * from './retries/Retries';
 export * from './object/getProperty';
+export * from './metadata/CopyReflection';
 export * from './measurement/performance';
 export * from './data-structures/Result';
 export * from './change-tracker/ChangeTracker';

package/dist/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/class-utilities-types"), exports);
 __exportStar(require("./retries/Retries"), exports);
 __exportStar(require("./object/getProperty"), exports);
+__exportStar(require("./metadata/CopyReflection"), exports);
 __exportStar(require("./measurement/performance"), exports);
 __exportStar(require("./data-structures/Result"), exports);
 __exportStar(require("./change-tracker/ChangeTracker"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,oDAAkC;AAClC,uDAAqC;AACrC,4DAA0C;AAC1C,2DAAyC;AACzC,iEAA+C;AAC/C,mDAAiC;AACjC,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gEAA8C;AAC9C,oDAAkC;AAClC,uDAAqC;AACrC,4DAA0C;AAC1C,4DAA0C;AAC1C,2DAAyC;AACzC,iEAA+C;AAC/C,mDAAiC;AACjC,iDAA+B"}

package/dist/metadata/CopyReflection.d.ts

@@ -0,0 +1,5 @@
+import 'reflect-metadata';
+export declare class CopyReflection {
+    static copyMetadata(source: object, target: object): void;
+    static copyPropertyMetadata(source: object, target: object, propertyKey: string | symbol): void;
+}

package/dist/metadata/CopyReflection.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CopyReflection = void 0;
+require("reflect-metadata");
+class CopyReflection {
+    static copyMetadata(source, target) {
+        const metadataKeys = Reflect.getMetadataKeys(source);
+        metadataKeys.forEach((key) => {
+            const metadata = Reflect.getMetadata(key, source);
+            Reflect.defineMetadata(key, metadata, target);
+        });
+    }
+    static copyPropertyMetadata(source, target, propertyKey) {
+        const metadataKeys = Reflect.getMetadataKeys(source, propertyKey);
+        metadataKeys.forEach((key) => {
+            const metadata = Reflect.getMetadata(key, source, propertyKey);
+            Reflect.defineMetadata(key, metadata, target, propertyKey);
+        });
+    }
+}
+exports.CopyReflection = CopyReflection;
+//# sourceMappingURL=CopyReflection.js.map

package/dist/metadata/CopyReflection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CopyReflection.js","sourceRoot":"","sources":["../../src/metadata/CopyReflection.ts"],"names":[],"mappings":";;;AAAA,4BAA0B;AAE1B,MAAa,cAAc;IAClB,MAAM,CAAC,YAAY,CAAC,MAAc,EAAE,MAAc;QACvD,MAAM,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAErD,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC3B,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YAElD,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,oBAAoB,CAChC,MAAc,EACd,MAAc,EACd,WAA4B;QAE5B,MAAM,YAAY,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QAElE,YAAY,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAC3B,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;YAE/D,OAAO,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAxBD,wCAwBC"}

package/dist/retries/Retries.d.ts

@@ -2,4 +2,4 @@ export declare function Retry({ delay, retries, retryableErrors, }: {
     retries: number;
     delay: number;
     retryableErrors: Array<new (...args: Array<any>) => Error>;
-}): (_target: unknown, _propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+}): MethodDecorator;

package/dist/retries/Retries.js

@@ -2,30 +2,54 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Retry = Retry;
 const promises_1 = require("timers/promises");
+const inversify_1 = require("inversify");
+const optimization_logger_1 = require("@squiz/optimization-logger");
+const CopyReflection_1 = require("../metadata/CopyReflection");
 function Retry({ delay, retries, retryableErrors, }) {
-    return (_target, _propertyKey, descriptor) => {
+    return (target, propertyKey, descriptor) => {
+        const injection = (0, inversify_1.inject)(optimization_logger_1.Logger);
+        const loggerSymbol = Symbol('logger');
+        injection(target, loggerSymbol);
         const originalMethod = descriptor.value;
         descriptor.value = async function (...args) {
+            const logger = this[loggerSymbol] ||
+                (0, optimization_logger_1.createLogger)();
             let attempt = 0;
             while (attempt <= retries) {
                 try {
                     return await originalMethod.apply(this, args);
                 }
                 catch (error) {
+                    logger.debug({
+                        message: `Attempt ${attempt} of ${retries}`,
+                    });
                     attempt++;
                     if (!retryableErrors.some((errType) => error instanceof errType)) {
+                        logger.error({
+                            message: `Non-retryable error encountered`,
+                            error,
+                        });
                         throw error;
                     }
                     const isMaxRetriesReached = attempt > retries;
                     if (isMaxRetriesReached) {
+                        logger.error({
+                            message: `Max retries (${retries}) reached`,
+                            error,
+                        });
                         throw error;
                     }
                     const _delay = delay * Math.pow(2, attempt - 1);
+                    logger.debug({
+                        message: `Retrying in ${_delay}ms`,
+                        attempt,
+                        delay: _delay,
+                    });
                     await (0, promises_1.setTimeout)(_delay);
                 }
             }
         };
-        return descriptor;
+        CopyReflection_1.CopyReflection.copyPropertyMetadata(originalMethod, descriptor.value, propertyKey);
     };
 }
 //# sourceMappingURL=Retries.js.map

package/dist/retries/Retries.js.map

@@ -1 +1 @@
-{"version":3,"file":"Retries.js","sourceRoot":"","sources":["../../src/retries/Retries.ts"],"names":[],"mappings":";;AAEA,sBA+CC;AAjDD,8CAA6C;AAE7C,SAAgB,KAAK,CAAC,EACpB,KAAK,EACL,OAAO,EACP,eAAe,GAMhB;IACC,OAAO,CACL,OAAgB,EAChB,YAAoB,EACpB,UAA8B,EACV,EAAE;QACtB,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAoB;YAEvB,IAAI,OAAO,GAAG,CAAC,CAAC;YAEhB,OAAO,OAAO,IAAI,OAAO,EAAE,CAAC;gBAC1B,IAAI,CAAC;oBACH,OAAO,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAChD,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,OAAO,EAAE,CAAC;oBAEV,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,YAAY,OAAO,CAAC,EAAE,CAAC;wBACjE,MAAM,KAAK,CAAC;oBACd,CAAC;oBAED,MAAM,mBAAmB,GAAG,OAAO,GAAG,OAAO,CAAC;oBAE9C,IAAI,mBAAmB,EAAE,CAAC;wBACxB,MAAM,KAAK,CAAC;oBACd,CAAC;oBAED,MAAM,MAAM,GAAG,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;oBAEhD,MAAM,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC;AACJ,CAAC"}
+{"version":3,"file":"Retries.js","sourceRoot":"","sources":["../../src/retries/Retries.ts"],"names":[],"mappings":";;AAKA,sBAyEC;AA9ED,8CAA6C;AAC7C,yCAAmC;AACnC,oEAAkE;AAClE,+DAA4D;AAE5D,SAAgB,KAAK,CAAC,EACpB,KAAK,EACL,OAAO,EACP,eAAe,GAMhB;IACC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,UAA8B,EAAQ,EAAE;QACnE,MAAM,SAAS,GAAG,IAAA,kBAAM,EAAC,4BAAM,CAAC,CAAC;QACjC,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEtC,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAEhC,MAAM,cAAc,GAAG,UAAU,CAAC,KAAK,CAAC;QAExC,UAAU,CAAC,KAAK,GAAG,KAAK,WACtB,GAAG,IAAoB;YAEvB,MAAM,MAAM,GACT,IAA+C,CAAC,YAAY,CAAC;gBAC9D,IAAA,kCAAY,GAAE,CAAC;YAEjB,IAAI,OAAO,GAAG,CAAC,CAAC;YAEhB,OAAO,OAAO,IAAI,OAAO,EAAE,CAAC;gBAC1B,IAAI,CAAC;oBACH,OAAO,MAAM,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAChD,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,KAAK,CAAC;wBACX,OAAO,EAAE,WAAW,OAAO,OAAO,OAAO,EAAE;qBAC5C,CAAC,CAAC;oBACH,OAAO,EAAE,CAAC;oBAEV,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,KAAK,YAAY,OAAO,CAAC,EAAE,CAAC;wBACjE,MAAM,CAAC,KAAK,CAAC;4BACX,OAAO,EAAE,iCAAiC;4BAC1C,KAAK;yBACN,CAAC,CAAC;wBACH,MAAM,KAAK,CAAC;oBACd,CAAC;oBAED,MAAM,mBAAmB,GAAG,OAAO,GAAG,OAAO,CAAC;oBAE9C,IAAI,mBAAmB,EAAE,CAAC;wBACxB,MAAM,CAAC,KAAK,CAAC;4BACX,OAAO,EAAE,gBAAgB,OAAO,WAAW;4BAC3C,KAAK;yBACN,CAAC,CAAC;wBACH,MAAM,KAAK,CAAC;oBACd,CAAC;oBAED,MAAM,MAAM,GAAG,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,CAAC;oBAEhD,MAAM,CAAC,KAAK,CAAC;wBACX,OAAO,EAAE,eAAe,MAAM,IAAI;wBAClC,OAAO;wBACP,KAAK,EAAE,MAAM;qBACd,CAAC,CAAC;oBAEH,MAAM,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC;QACH,CAAC,CAAC;QAEF,+BAAc,CAAC,oBAAoB,CACjC,cAAc,EACd,UAAU,CAAC,KAAK,EAChB,WAAW,CACZ,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squiz/optimization-utils",
-  "version": "4.5.0",
+  "version": "4.6.1",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",