@ampsec/platform-client 35.0.0 → 36.0.0

package/build/src/index.d.ts

@@ -1,4 +1,5 @@
 export * from './dto';
 export * from './etag';
+export * from './logging';
 export * from './services';
 export * from './FilterCriteria';

package/build/src/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./dto"), exports);
 __exportStar(require("./etag"), exports);
+__exportStar(require("./logging"), exports);
 __exportStar(require("./services"), exports);
 __exportStar(require("./FilterCriteria"), exports);
 //# sourceMappingURL=index.js.map

package/build/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,yCAAuB;AACvB,6CAA2B;AAC3B,mDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,yCAAuB;AACvB,4CAA0B;AAC1B,6CAA2B;AAC3B,mDAAiC"}

package/build/src/logging.d.ts

@@ -0,0 +1,8 @@
+export interface AmpLogger {
+    info(_message: unknown, _meta?: unknown): void;
+    debug(_message: unknown, _meta?: unknown): void;
+    warn(_message: unknown, _meta?: unknown): void;
+    error(_message: unknown, _meta?: unknown): void;
+}
+export declare const defaultLogger: AmpLogger;
+export declare const noopLogger: AmpLogger;

package/build/src/logging.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.noopLogger = exports.defaultLogger = void 0;
+exports.defaultLogger = console;
+exports.noopLogger = {
+    info: () => { },
+    debug: () => { },
+    warn: () => { },
+    error: () => { },
+};
+//# sourceMappingURL=logging.js.map

package/build/src/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../../src/logging.ts"],"names":[],"mappings":";;;AAOa,QAAA,aAAa,GAAc,OAAO,CAAC;AACnC,QAAA,UAAU,GAAc;IACnC,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;IACf,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC;IACd,KAAK,EAAE,GAAG,EAAE,GAAE,CAAC;CAChB,CAAC"}

package/build/src/services/rest/RestClient.d.ts

@@ -4,13 +4,14 @@ import { RestResponse } from './RestResponse';
 import { RestClientRetryStrategy } from './retry.rest';
 import { HeadersMap } from './utils';
 import { RestClientRateLimitStrategy } from './rateLimit.rest';
+import { AmpLogger } from '../../logging';
 export type AmpRestClientOptions = {
     baseUrl: string;
     token: string;
     timeout?: number;
     retryStrategy?: RestClientRetryStrategy;
     rateLimitStrategy?: RestClientRateLimitStrategy;
-    verbose?: boolean;
+    logger?: AmpLogger;
     client?: AxiosStatic;
 };
 export type RestClientOptions = {
@@ -19,7 +20,7 @@ export type RestClientOptions = {
     timeout?: number;
     retryStrategy?: RestClientRetryStrategy;
     rateLimitStrategy?: RestClientRateLimitStrategy;
-    verbose?: boolean;
+    logger?: AmpLogger;
     client?: AxiosStatic;
 };
 /**
@@ -39,7 +40,7 @@ export declare class DefaultRestClient {
     protected readonly ampAxios: Axios;
     protected readonly retryStrategy: RestClientRetryStrategy;
     protected readonly rateLimitStrategy: RestClientRateLimitStrategy;
-    protected readonly verbose: boolean;
+    protected readonly logger: AmpLogger;
     constructor(options?: RestClientOptions);
     call(request: RestRequest): Promise<RestResponse>;
 }

package/build/src/services/rest/RestClient.js

@@ -33,6 +33,7 @@ const axios_1 = __importStar(require("axios"));
 const retry_rest_1 = require("./retry.rest");
 const utils_1 = require("./utils");
 const rateLimit_rest_1 = require("./rateLimit.rest");
+const logging_1 = require("../../logging");
 /**
  * DefaultRestClient is a default implementation of RestClient.
  * It defaults to useing axios to make REST calls and adds reasonble defaults
@@ -56,7 +57,7 @@ class DefaultRestClient {
             var _a;
             this.ampAxios.defaults.headers.common[key] = (_a = options.headers) === null || _a === void 0 ? void 0 : _a[key];
         });
-        this.verbose = (_c = options.verbose) !== null && _c !== void 0 ? _c : false;
+        this.logger = (_c = options.logger) !== null && _c !== void 0 ? _c : logging_1.noopLogger;
         this.ampAxios.defaults.headers.common['Accepts'] = 'application/json';
         this.ampAxios.defaults.headers.post['Content-Type'] = 'application/json';
         this.ampAxios.defaults.headers.put['Content-Type'] = 'application/json';
@@ -68,8 +69,7 @@ class DefaultRestClient {
         const req = lodash_1.default.merge(request);
         try {
             await this.rateLimitStrategy.reserve(req);
-            if (this.verbose)
-                console.log('Request', req);
+            this.logger.debug({ req }); // noop logger by default
             const res = await this.ampAxios.request(req);
             return {
                 status: res.status,
@@ -94,14 +94,13 @@ class DefaultRestClient {
 }
 exports.DefaultRestClient = DefaultRestClient;
 const getAmpRestClient = (options) => {
-    var _a;
     const ampClient = new DefaultRestClient({
         baseUrl: options.baseUrl,
         headers: {
             Authorization: `Bearer ${options.token}`,
         },
         rateLimitStrategy: new rateLimit_rest_1.StaticRestClientRateLimitStrategy(50),
-        verbose: (_a = options.verbose) !== null && _a !== void 0 ? _a : false,
+        logger: options.logger,
         client: options.client,
     });
     return ampClient;

package/build/src/services/rest/RestClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"RestClient.js","sourceRoot":"","sources":["../../../../src/services/rest/RestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAuB;AACvB,4CAAoB;AACpB,+CAA4D;AAG5D,6CAA4E;AAC5E,mCAAmD;AACnD,qDAAiI;AA6BjI;;;;;;GAMG;AACH,MAAa,iBAAiB;IAK5B,YAAY,UAA6B,EAAE;;QACzC,oBAAoB;QACpB,MAAM,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,eAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,gBAAgB,EAAE,MAAM,CAAC,EAAE;gBACzB,OAAO,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC,CAAC;YACvD,CAAC;SACF,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;;YAC/C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAA,OAAO,CAAC,OAAO,0CAAG,GAAG,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,KAAK,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC;QACtE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACzE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACxE,IAAI,CAAC,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,kCAAqB,CAAC;QACpE,IAAI,CAAC,iBAAiB,GAAG,MAAA,OAAO,CAAC,iBAAiB,mCAAI,gDAA+B,CAAC;IACxF,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,OAAoB;;QAC7B,MAAM,GAAG,GAAG,gBAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI;YACF,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,IAAI,CAAC,OAAO;gBAAE,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;YAC9C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC7C,OAAO;gBACL,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,OAAO,EAAE,IAAA,sBAAc,EAAC,GAAG,CAAC;gBAC5B,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,IAAI;aACZ,CAAC;SACH;QAAC,OAAO,GAAY,EAAE;YACrB,IAAI,GAAG,YAAY,kBAAU,EAAE;gBAC7B,MAAM,UAAU,GAAG,GAAiB,CAAC;gBACrC,OAAO;oBACL,MAAM,EAAE,MAAA,MAAA,UAAU,CAAC,QAAQ,0CAAE,MAAM,mCAAI,GAAG;oBAC1C,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,sBAAc,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;oBACvE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,GAAG;iBACX,CAAC;aACH;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;CACF;AAlDD,8CAkDC;AAEM,MAAM,gBAAgB,GAAG,CAAC,OAA6B,EAAc,EAAE;;IAC5E,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC;QACtC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,KAAK,EAAE;SACzC;QACD,iBAAiB,EAAE,IAAI,kDAAiC,CAAC,EAAE,CAAC;QAC5D,OAAO,EAAE,MAAA,OAAO,CAAC,OAAO,mCAAI,KAAK;QACjC,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAXW,QAAA,gBAAgB,oBAW3B"}
+{"version":3,"file":"RestClient.js","sourceRoot":"","sources":["../../../../src/services/rest/RestClient.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAuB;AACvB,4CAAoB;AACpB,+CAA4D;AAG5D,6CAA4E;AAC5E,mCAAmD;AACnD,qDAAiI;AACjI,2CAAoD;AA6BpD;;;;;;GAMG;AACH,MAAa,iBAAiB;IAM5B,YAAY,UAA6B,EAAE;;QACzC,oBAAoB;QACpB,MAAM,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,eAAK,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC;YAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,gBAAgB,EAAE,MAAM,CAAC,EAAE;gBACzB,OAAO,YAAE,CAAC,SAAS,CAAC,MAAM,EAAE,EAAC,WAAW,EAAE,QAAQ,EAAC,CAAC,CAAC;YACvD,CAAC;SACF,CAAC,CAAC;QACH,MAAM,CAAC,IAAI,CAAC,MAAA,OAAO,CAAC,OAAO,mCAAI,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;;YAC/C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,MAAA,OAAO,CAAC,OAAO,0CAAG,GAAG,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,oBAAU,CAAC;QAC3C,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,kBAAkB,CAAC;QACtE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACzE,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;QACxE,IAAI,CAAC,aAAa,GAAG,MAAA,OAAO,CAAC,aAAa,mCAAI,kCAAqB,CAAC;QACpE,IAAI,CAAC,iBAAiB,GAAG,MAAA,OAAO,CAAC,iBAAiB,mCAAI,gDAA+B,CAAC;IACxF,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,OAAoB;;QAC7B,MAAM,GAAG,GAAG,gBAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI;YACF,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAC,GAAG,EAAC,CAAC,CAAC,CAAC,yBAAyB;YACnD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC7C,OAAO;gBACL,MAAM,EAAE,GAAG,CAAC,MAAM;gBAClB,OAAO,EAAE,IAAA,sBAAc,EAAC,GAAG,CAAC;gBAC5B,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,KAAK,EAAE,IAAI;aACZ,CAAC;SACH;QAAC,OAAO,GAAY,EAAE;YACrB,IAAI,GAAG,YAAY,kBAAU,EAAE;gBAC7B,MAAM,UAAU,GAAG,GAAiB,CAAC;gBACrC,OAAO;oBACL,MAAM,EAAE,MAAA,MAAA,UAAU,CAAC,QAAQ,0CAAE,MAAM,mCAAI,GAAG;oBAC1C,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAA,sBAAc,EAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;oBACvE,IAAI,EAAE,IAAI;oBACV,KAAK,EAAE,GAAG;iBACX,CAAC;aACH;YACD,MAAM,GAAG,CAAC;SACX;IACH,CAAC;CACF;AAnDD,8CAmDC;AAEM,MAAM,gBAAgB,GAAG,CAAC,OAA6B,EAAc,EAAE;IAC5E,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC;QACtC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,OAAO,EAAE;YACP,aAAa,EAAE,UAAU,OAAO,CAAC,KAAK,EAAE;SACzC;QACD,iBAAiB,EAAE,IAAI,kDAAiC,CAAC,EAAE,CAAC;QAC5D,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAXW,QAAA,gBAAgB,oBAW3B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ampsec/platform-client",
-  "version": "35.0.0",
+  "version": "36.0.0",
   "description": "",
   "main": "build/src/index.js",
   "runkitExampleFilename": "example/main.js",

package/src/index.ts

@@ -1,4 +1,5 @@
 export * from './dto';
 export * from './etag';
+export * from './logging';
 export * from './services';
 export * from './FilterCriteria';

package/src/logging.ts

@@ -0,0 +1,14 @@
+export interface AmpLogger {
+  info(_message: unknown, _meta?: unknown): void;
+  debug(_message: unknown, _meta?: unknown): void;
+  warn(_message: unknown, _meta?: unknown): void;
+  error(_message: unknown, _meta?: unknown): void;
+}
+
+export const defaultLogger: AmpLogger = console;
+export const noopLogger: AmpLogger = {
+  info: () => {},
+  debug: () => {},
+  warn: () => {},
+  error: () => {},
+};

package/src/services/rest/RestClient.ts

@@ -6,6 +6,7 @@ import {RestResponse} from './RestResponse';
 import {RestClientRetryStrategy, noopRestRetryStrategy} from './retry.rest';
 import {HeadersMap, convertHeaders} from './utils';
 import {RestClientRateLimitStrategy, StaticRestClientRateLimitStrategy, noopRestClientRateLimitStrategy} from './rateLimit.rest';
+import {AmpLogger, noopLogger} from '../../logging';
 
 export type AmpRestClientOptions = {
   baseUrl: string;
@@ -13,7 +14,7 @@ export type AmpRestClientOptions = {
   timeout?: number;
   retryStrategy?: RestClientRetryStrategy;
   rateLimitStrategy?: RestClientRateLimitStrategy;
-  verbose?: boolean;
+  logger?: AmpLogger;
   client?: AxiosStatic;
 };
 
@@ -23,7 +24,7 @@ export type RestClientOptions = {
   timeout?: number;
   retryStrategy?: RestClientRetryStrategy;
   rateLimitStrategy?: RestClientRateLimitStrategy;
-  verbose?: boolean;
+  logger?: AmpLogger;
   client?: AxiosStatic;
 };
 
@@ -45,7 +46,8 @@ export class DefaultRestClient {
   protected readonly ampAxios: Axios;
   protected readonly retryStrategy: RestClientRetryStrategy;
   protected readonly rateLimitStrategy: RestClientRateLimitStrategy;
-  protected readonly verbose: boolean;
+  protected readonly logger: AmpLogger;
+
   constructor(options: RestClientOptions = {}) {
     // TODO: rest client
     const client = options.client ?? axios;
@@ -59,7 +61,7 @@ export class DefaultRestClient {
     Object.keys(options.headers ?? {}).forEach(key => {
       this.ampAxios.defaults.headers.common[key] = options.headers?.[key];
     });
-    this.verbose = options.verbose ?? false;
+    this.logger = options.logger ?? noopLogger;
     this.ampAxios.defaults.headers.common['Accepts'] = 'application/json';
     this.ampAxios.defaults.headers.post['Content-Type'] = 'application/json';
     this.ampAxios.defaults.headers.put['Content-Type'] = 'application/json';
@@ -70,7 +72,7 @@ export class DefaultRestClient {
     const req = _.merge(request);
     try {
       await this.rateLimitStrategy.reserve(req);
-      if (this.verbose) console.log('Request', req);
+      this.logger.debug({req}); // noop logger by default
       const res = await this.ampAxios.request(req);
       return {
         status: res.status,
@@ -100,7 +102,7 @@ export const getAmpRestClient = (options: AmpRestClientOptions): RestClient => {
       Authorization: `Bearer ${options.token}`,
     },
     rateLimitStrategy: new StaticRestClientRateLimitStrategy(50),
-    verbose: options.verbose ?? false,
+    logger: options.logger,
     client: options.client,
   });
   return ampClient;