@pluslabs/utils 0.4.1 → 0.4.2

package/dist/module/stamp/index.d.ts

@@ -1,9 +1,16 @@
-type context = {
+type TLogger = {
+    info: (message: string) => void;
+};
+type StampOptions = {
+    enableInProduction?: boolean;
+};
+declare const context: {
     id: string;
     idx: string;
     step: number;
     now: number;
     end: () => void;
+    logger?: TLogger;
 };
 /**
  * The idea is that you can create a stamp with an id, and then use that id to mark different steps in your code.
@@ -11,13 +18,42 @@ type context = {
  * @param id String to identify the stamp
  * @returns
  */
-export declare const createStamp: (id?: string) => {
-    stamp: (name: string) => context;
-    end: () => context;
+export declare const createStamp: (id?: string, logger?: TLogger, options?: StampOptions) => {
+    stamp: (name: string) => {
+        id: string;
+        idx: string;
+        step: number;
+        now: number;
+        end: () => void;
+        logger?: TLogger;
+    };
+    end: () => {
+        id: string;
+        idx: string;
+        step: number;
+        now: number;
+        end: () => void;
+        logger?: TLogger;
+    };
+};
+export declare function stamp(this: typeof context, name: string): {
+    id: string;
+    idx: string;
+    step: number;
+    now: number;
+    end: () => void;
+    logger?: TLogger;
 };
-export declare function stamp(this: context, name: string): context;
 export declare namespace stamp {
-    var end: (this: context) => context;
+    var end: typeof import("./index.js").end;
 }
+export declare function end(this: typeof context): {
+    id: string;
+    idx: string;
+    step: number;
+    now: number;
+    end: () => void;
+    logger?: TLogger;
+};
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/module/stamp/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stamp/index.ts"],"names":[],"mappings":"AAGA,KAAK,OAAO,GAAG;IACX,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,IAAI,CAAC;CACnB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,WAAO;;;CAiBlC,CAAC;AAEF,wBAAgB,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAahD;yBAbe,KAAK;oBAiBF,OAAO"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/stamp/index.ts"],"names":[],"mappings":"AAEA,KAAK,OAAO,GAAG;IACX,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACnC,CAAC;AAEF,KAAK,YAAY,GAAG;IAChB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC,CAAC;AAEF,QAAA,MAAM,OAAO,EAAE;IACX,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,IAAI,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CAQpB,CAAC;AAMF;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,WAAO,EAAE,SAAS,OAAO,EAAE,UAAU,YAAY;;YAzBrE,MAAM;aACL,MAAM;cACL,MAAM;aACP,MAAM;aACN,MAAM,IAAI;iBACN,OAAO;;;YALZ,MAAM;aACL,MAAM;cACL,MAAM;aACP,MAAM;aACN,MAAM,IAAI;iBACN,OAAO;;CAsCnB,CAAC;AAEF,wBAAgB,KAAK,CAAC,IAAI,EAAE,OAAO,OAAO,EAAE,IAAI,EAAE,MAAM;QA7ChD,MAAM;SACL,MAAM;UACL,MAAM;SACP,MAAM;SACN,MAAM,IAAI;aACN,OAAO;EA2DnB;yBAnBe,KAAK;;;AAuBrB,wBAAgB,GAAG,CAAC,IAAI,EAAE,OAAO,OAAO;QApEhC,MAAM;SACL,MAAM;UACL,MAAM;SACP,MAAM;SACN,MAAM,IAAI;aACN,OAAO;EAuEnB"}

package/dist/module/stamp/index.js

@@ -1,18 +1,29 @@
-// Copy/pasta from https://github.com/pluslabs/magic-professional/blob/main/packages/stamp/index.ts
-// since yarn cant do subdirectories from a monorepo
+const isProd = process.env.NODE_ENV === 'production';
+const context = {
+    id: '',
+    idx: '',
+    step: 0,
+    now: 0,
+    end: () => { },
+    logger: undefined
+};
+const noopLogger = {
+    info: () => { }
+};
 /**
  * The idea is that you can create a stamp with an id, and then use that id to mark different steps in your code.
  * `createStamp` should be called at the beginning of the execution context and then createStamp
  * @param id String to identify the stamp
  * @returns
  */
-export const createStamp = (id = '') => {
+export const createStamp = (id = '', logger, options) => {
     const ctx = {
         id,
         idx: (Date.now() * Math.random() * 1e6).toString(36),
         now: Date.now(),
         step: Date.now(),
-        end: () => { }
+        end: () => { },
+        logger: logger || (!(options === null || options === void 0 ? void 0 : options.enableInProduction) && !isProd ? undefined : noopLogger)
     };
     // Bind the end function to the context
     // so we can curry it
@@ -28,11 +39,18 @@ export function stamp(name) {
     }
     const diff = Date.now() - this.step;
     this.step = Date.now();
-    console.log(`[STAMP][${this.idx}][${this.id}] ${name} took ${diff}ms, total: ${Date.now() - this.now}ms`);
+    const delta = Date.now() - this.now;
+    const message = `[STAMP][${this.idx}][${this.id}] [step=${name}] [duration=${diff}ms] [total=${delta}ms]`;
+    if (this.logger) {
+        this.logger.info(message);
+    }
+    else {
+        console.log(message);
+    }
     return this;
 }
 stamp.end = end;
-function end() {
+export function end() {
     this.id = '';
     this.now = 0;
     this.step = 0;

package/dist/module/stamp/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stamp/index.ts"],"names":[],"mappings":"AAAA,mGAAmG;AACnG,oDAAoD;AAUpD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;IACnC,MAAM,GAAG,GAAG;QACR,EAAE;QACF,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpD,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE;QACf,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;QAChB,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;KACL,CAAC;IAEb,uCAAuC;IACvC,qBAAqB;IACrB,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAExB,OAAO;QACH,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QACtB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;KACrB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,UAAU,KAAK,CAAgB,IAAY;IAC7C,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;IACpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAEvB,OAAO,CAAC,GAAG,CACP,WAAW,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,SAAS,IAAI,cAAc,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAC/F,CAAC;IAEF,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;AAEhB,SAAS,GAAG;IACR,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;IACb,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IAEd,MAAM,GAAG,GAAG,IAAe,CAAC;IAE5B,OAAO,GAAG,CAAC;AACf,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/stamp/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC;AAUrD,MAAM,OAAO,GAOT;IACA,EAAE,EAAE,EAAE;IACN,GAAG,EAAE,EAAE;IACP,IAAI,EAAE,CAAC;IACP,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;IACb,MAAM,EAAE,SAAS;CACpB,CAAC;AAEF,MAAM,UAAU,GAAY;IACxB,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAAE,GAAG,EAAE,EAAE,MAAgB,EAAE,OAAsB,EAAE,EAAE;IAC7E,MAAM,GAAG,GAAG;QACR,EAAE;QACF,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpD,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE;QACf,IAAI,EAAE,IAAI,CAAC,GAAG,EAAE;QAChB,GAAG,EAAE,GAAG,EAAE,GAAE,CAAC;QACb,MAAM,EAAE,MAAM,IAAI,CAAC,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB,CAAA,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC;KACvF,CAAC;IAEF,uCAAuC;IACvC,qBAAqB;IACrB,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAExB,OAAO;QACH,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;QACtB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;KACrB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,UAAU,KAAK,CAAuB,IAAY;IACpD,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;IAEpC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC;IAEpC,MAAM,OAAO,GAAG,WAAW,IAAI,CAAC,GAAG,KAAK,IAAI,CAAC,EAAE,WAAW,IAAI,eAAe,IAAI,cAAc,KAAK,KAAK,CAAC;IAE1G,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QACd,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;SAAM,CAAC;QACJ,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC;AAEhB,MAAM,UAAU,GAAG;IACf,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC;IACb,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;IAEd,MAAM,GAAG,GAAG,IAAsB,CAAC;IAEnC,OAAO,GAAG,CAAC;AACf,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pluslabs/utils",
-    "version": "0.4.1",
+    "version": "0.4.2",
     "description": "A set of utilities used across projects",
     "keywords": [
         "javascript",

package/src/stamp/index.ts

@@ -1,12 +1,31 @@
-// Copy/pasta from https://github.com/pluslabs/magic-professional/blob/main/packages/stamp/index.ts
-// since yarn cant do subdirectories from a monorepo
+const isProd = process.env.NODE_ENV === 'production';
 
-type context = {
+type TLogger = {
+    info: (message: string) => void;
+};
+
+type StampOptions = {
+    enableInProduction?: boolean;
+};
+
+const context: {
     id: string;
     idx: string;
     step: number;
     now: number;
     end: () => void;
+    logger?: TLogger;
+} = {
+    id: '',
+    idx: '',
+    step: 0,
+    now: 0,
+    end: () => {},
+    logger: undefined
+};
+
+const noopLogger: TLogger = {
+    info: () => {}
 };
 
 /**
@@ -15,14 +34,15 @@ type context = {
  * @param id String to identify the stamp
  * @returns
  */
-export const createStamp = (id = '') => {
+export const createStamp = (id = '', logger?: TLogger, options?: StampOptions) => {
     const ctx = {
         id,
         idx: (Date.now() * Math.random() * 1e6).toString(36),
         now: Date.now(),
         step: Date.now(),
-        end: () => {}
-    } as context;
+        end: () => {},
+        logger: logger || (!options?.enableInProduction && !isProd ? undefined : noopLogger)
+    };
 
     // Bind the end function to the context
     // so we can curry it
@@ -34,29 +54,35 @@ export const createStamp = (id = '') => {
     };
 };
 
-export function stamp(this: context, name: string) {
+export function stamp(this: typeof context, name: string) {
     if (!this.id) {
         return this;
     }
 
     const diff = Date.now() - this.step;
+
     this.step = Date.now();
+    const delta = Date.now() - this.now;
 
-    console.log(
-        `[STAMP][${this.idx}][${this.id}] ${name} took ${diff}ms, total: ${Date.now() - this.now}ms`
-    );
+    const message = `[STAMP][${this.idx}][${this.id}] [step=${name}] [duration=${diff}ms] [total=${delta}ms]`;
+
+    if (this.logger) {
+        this.logger.info(message);
+    } else {
+        console.log(message);
+    }
 
     return this;
 }
 
 stamp.end = end;
 
-function end(this: context) {
+export function end(this: typeof context) {
     this.id = '';
     this.now = 0;
     this.step = 0;
 
-    const ctx = this as context;
+    const ctx = this as typeof context;
 
     return ctx;
 }