@futdevpro/nts-dynamo 1.15.15 → 1.15.16

package/src/_models/control-models/api-call-params.control-model.spec.ts

@@ -1,152 +1,152 @@
-
-import { DyFM_HttpCallType, DyFM_HttpResponseType, DyFM_Log } from '@futdevpro/fsm-dynamo';
-
-import { DyNTS_ApiCall_Params, DyNTS_HttpOptions } from './api-call-params.control-model';
-
-describe('| DyNTS_ApiCall_Params', () => {
-  it('| should create an instance with default values', () => {
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/endpoint',
-      baseUrl: 'https://example.com/api',
-    });
-
-    expect(params.name).toBe('testCall');
-    expect(params.type).toBe(DyFM_HttpCallType.get);
-    expect(params.endpoint).toBe('/test/endpoint');
-    expect(params.baseUrl).toBe('https://example.com/api');
-    expect(params.getFullResponse).toBe(false);
-    expect(params.httpOptions).toEqual({});
-  });
-
-  it('| should create an instance with provided values', () => {
-    const httpOptions = new DyNTS_HttpOptions({
-      responseType: DyFM_HttpResponseType.json,
-      headers: { 'Content-Type': 'application/json' },
-      observe: 'body',
-      reportProgress: true,
-      withCredentials: true,
-    });
-
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.post,
-      endpoint: '/test/endpoint',
-      baseUrl: 'https://example.com/api',
-      getFullResponse: true,
-      httpOptions: httpOptions,
-    });
-
-    expect(params.name).toBe('testCall');
-    expect(params.type).toBe(DyFM_HttpCallType.post);
-    expect(params.endpoint).toBe('/test/endpoint');
-    expect(params.baseUrl).toBe('https://example.com/api');
-    expect(params.getFullResponse).toBe(true);
-    expect(params.httpOptions).toEqual(httpOptions);
-  });
-
-  it('| should replace deprecated endpoint parameter braces', () => {
-    spyOn(DyFM_Log, 'warn');
-
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/{param}/endpoint',
-      baseUrl: 'https://example.com/api',
-    });
-
-    expect(DyFM_Log.warn).toHaveBeenCalledWith(
-      'WARNING: using {param} bracets in endpoint definitions will be deprecated... (/test/{param}/endpoint)' +
-      '\n  use :param instead ({pathparam} --> :pathparam)'
-    );
-    expect(params.endpoint).toBe('/test/:param/endpoint');
-  });
-
-  it('| should extract pathParamKeys from endpoint with colons', () => {
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/:userId/:itemId',
-      baseUrl: 'https://example.com/api',
-    });
-
-    expect(params.pathParamKeys).toEqual(['userId', 'itemId']);
-  });
-
-  it('| should handle endpoint without path parameters', () => {
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/endpoint',
-      baseUrl: 'https://example.com/api',
-    });
-
-    expect(params.pathParamKeys).toEqual([]);
-  });
-
-  it('| should use global baseUrl when baseUrl is not provided', () => {
-    spyOn(DyFM_Log, 'error');
-
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      endpoint: '/test/endpoint',
-    } as any);
-
-    expect(DyFM_Log.error).toHaveBeenCalled();
-    expect(params.baseUrl).toBeDefined();
-  });
-
-  it('| should handle missing endpoint', () => {
-    spyOn(DyFM_Log, 'warn');
-
-    const params = new DyNTS_ApiCall_Params({
-      name: 'testCall',
-      type: DyFM_HttpCallType.get,
-      baseUrl: 'https://example.com/api',
-    } as any);
-
-    expect(DyFM_Log.warn).toHaveBeenCalled();
-    expect(params.endpoint).toBe('');
-  });
-
-  it('| should throw error when endpoint is invalid', () => {
-    expect(() => {
-      new DyNTS_ApiCall_Params({
-        name: 'testCall',
-        type: DyFM_HttpCallType.get,
-        endpoint: { includes: false } as any,
-        baseUrl: 'https://example.com/api',
-      });
-    }).toThrowError(/DyNTS_ApiCall_Params Error: something went wrong with the endpoint, it is provided but not valid/);
-  });
-});
-
-describe('| DyNTS_HttpOptions', () => {
-  it('| should create an instance with default values', () => {
-    const options = new DyNTS_HttpOptions({});
-
-    expect(options.responseType).toBeUndefined();
-    expect(options.headers).toBeUndefined();
-    expect(options.observe).toBeUndefined();
-    expect(options.reportProgress).toBeUndefined();
-    expect(options.withCredentials).toBeUndefined();
-  });
-
-  it('| should create an instance with provided values', () => {
-    const options = new DyNTS_HttpOptions({
-      responseType: DyFM_HttpResponseType.json,
-      headers: { 'Content-Type': 'application/json' },
-      observe: 'body',
-      reportProgress: true,
-      withCredentials: true,
-    });
-
-    expect(options.responseType).toBe(DyFM_HttpResponseType.json);
-    expect(options.headers).toEqual({ 'Content-Type': 'application/json' });
-    expect(options.observe).toBe('body');
-    expect(options.reportProgress).toBe(true);
-    expect(options.withCredentials).toBe(true);
-  });
-});
+
+import { DyFM_HttpCallType, DyFM_HttpResponseType, DyFM_Log } from '@futdevpro/fsm-dynamo';
+
+import { DyNTS_ApiCall_Params, DyNTS_HttpOptions } from './api-call-params.control-model';
+
+describe('| DyNTS_ApiCall_Params', () => {
+  it('| should create an instance with default values', () => {
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/endpoint',
+      baseUrl: 'https://example.com/api',
+    });
+
+    expect(params.name).toBe('testCall');
+    expect(params.type).toBe(DyFM_HttpCallType.get);
+    expect(params.endpoint).toBe('/test/endpoint');
+    expect(params.baseUrl).toBe('https://example.com/api');
+    expect(params.getFullResponse).toBe(false);
+    expect(params.httpOptions).toEqual({});
+  });
+
+  it('| should create an instance with provided values', () => {
+    const httpOptions = new DyNTS_HttpOptions({
+      responseType: DyFM_HttpResponseType.json,
+      headers: { 'Content-Type': 'application/json' },
+      observe: 'body',
+      reportProgress: true,
+      withCredentials: true,
+    });
+
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.post,
+      endpoint: '/test/endpoint',
+      baseUrl: 'https://example.com/api',
+      getFullResponse: true,
+      httpOptions: httpOptions,
+    });
+
+    expect(params.name).toBe('testCall');
+    expect(params.type).toBe(DyFM_HttpCallType.post);
+    expect(params.endpoint).toBe('/test/endpoint');
+    expect(params.baseUrl).toBe('https://example.com/api');
+    expect(params.getFullResponse).toBe(true);
+    expect(params.httpOptions).toEqual(httpOptions);
+  });
+
+  it('| should replace deprecated endpoint parameter braces', () => {
+    spyOn(DyFM_Log, 'warn');
+
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/{param}/endpoint',
+      baseUrl: 'https://example.com/api',
+    });
+
+    expect(DyFM_Log.warn).toHaveBeenCalledWith(
+      'WARNING: using {param} bracets in endpoint definitions will be deprecated... (/test/{param}/endpoint)' +
+      '\n  use :param instead ({pathparam} --> :pathparam)'
+    );
+    expect(params.endpoint).toBe('/test/:param/endpoint');
+  });
+
+  it('| should extract pathParamKeys from endpoint with colons', () => {
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/:userId/:itemId',
+      baseUrl: 'https://example.com/api',
+    });
+
+    expect(params.pathParamKeys).toEqual(['userId', 'itemId']);
+  });
+
+  it('| should handle endpoint without path parameters', () => {
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/endpoint',
+      baseUrl: 'https://example.com/api',
+    });
+
+    expect(params.pathParamKeys).toEqual([]);
+  });
+
+  it('| should use global baseUrl when baseUrl is not provided', () => {
+    spyOn(DyFM_Log, 'error');
+
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      endpoint: '/test/endpoint',
+    } as any);
+
+    expect(DyFM_Log.error).toHaveBeenCalled();
+    expect(params.baseUrl).toBeDefined();
+  });
+
+  it('| should handle missing endpoint', () => {
+    spyOn(DyFM_Log, 'warn');
+
+    const params = new DyNTS_ApiCall_Params({
+      name: 'testCall',
+      type: DyFM_HttpCallType.get,
+      baseUrl: 'https://example.com/api',
+    } as any);
+
+    expect(DyFM_Log.warn).toHaveBeenCalled();
+    expect(params.endpoint).toBe('');
+  });
+
+  it('| should throw error when endpoint is invalid', () => {
+    expect(() => {
+      new DyNTS_ApiCall_Params({
+        name: 'testCall',
+        type: DyFM_HttpCallType.get,
+        endpoint: { includes: false } as any,
+        baseUrl: 'https://example.com/api',
+      });
+    }).toThrowError(/DyNTS_ApiCall_Params Error: something went wrong with the endpoint, it is provided but not valid/);
+  });
+});
+
+describe('| DyNTS_HttpOptions', () => {
+  it('| should create an instance with default values', () => {
+    const options = new DyNTS_HttpOptions({});
+
+    expect(options.responseType).toBeUndefined();
+    expect(options.headers).toBeUndefined();
+    expect(options.observe).toBeUndefined();
+    expect(options.reportProgress).toBeUndefined();
+    expect(options.withCredentials).toBeUndefined();
+  });
+
+  it('| should create an instance with provided values', () => {
+    const options = new DyNTS_HttpOptions({
+      responseType: DyFM_HttpResponseType.json,
+      headers: { 'Content-Type': 'application/json' },
+      observe: 'body',
+      reportProgress: true,
+      withCredentials: true,
+    });
+
+    expect(options.responseType).toBe(DyFM_HttpResponseType.json);
+    expect(options.headers).toEqual({ 'Content-Type': 'application/json' });
+    expect(options.observe).toBe('body');
+    expect(options.reportProgress).toBe(true);
+    expect(options.withCredentials).toBe(true);
+  });
+});

package/src/_models/control-models/api-call-params.control-model.ts

@@ -1,142 +1,142 @@
-
-import { DyFM_Error, DyFM_getConstructionStackLocation, DyFM_HttpCallType, DyFM_HttpResponseType, DyFM_Log, } from '@futdevpro/fsm-dynamo';
-import { DyNTS_global_settings } from '../../_collections/global-settings.const';
-
-
-export interface DyNTS_AxiosSettings {
-  headers?: { [header: string]: string | string[] };
-  httpAgent?: any;
-  httpsAgent?: any;
-  timeout?: number;
-  maxRedirects?: number;
-  withCredentials?: boolean;
-  responseType?: DyFM_HttpResponseType;
-}
-
-/**
- * API call params,
- * such as
- * type (HttpCallType),
- * endpoint,
- * and other options as httpOptions
- */
-export class DyNTS_ApiCall_Params {
-  /**
-   * name the call to be able to identify it when debugging
-   */
-  name: string;
-  /**
-   * type of the call as; HttpCallType .get, .post, ...ect
-   */
-  type: DyFM_HttpCallType = DyFM_HttpCallType.get;
-  /**
-   * the endpoint of the API, without the baseUrl:
-   * '/user/get/:userId',
-   * where the parts starting with ':', will be used as pathParam
-   */
-  baseUrl: string;
-  /**
-   * baseUrl of the API;
-   * 'https://futdevpro.hu/api'
-   */
-  endpoint: string;
-
-  /**
-   * if this value is true, the call will return the full HTTP call response in raw
-   */
-  getFullResponse: boolean = false;
-  /**
-   * this setting will be passed to the axios http call
-   */
-  httpOptions: any | DyNTS_AxiosSettings = {};
-
-  pathParamKeys: string[] = [];
-  
-  readonly stack: string;
-
-  constructor(
-    /**
-     * set of options necessary for setting up an API call
-     */
-    set: Partial<DyNTS_ApiCall_Params>
-  ) {
-    this.stack = DyFM_getConstructionStackLocation();
-
-    if (!set.name) {
-      // ?TODO: nullable warning
-      DyFM_Log.warn(
-        'WARNING: DyNTS_ApiCall_Params: name is not provided, using stack location!',
-        '\n  stack:', this.stack
-      );
-      this.name = this.stack;
-    }
-
-    if (!set.baseUrl) {
-      // ?TODO: nullable warning
-      DyFM_Log.error(
-        'ERROR: DyNTS_ApiCall_Params: baseUrl is not provided, using global baseUrl!',
-        '\n  stack:', this.stack
-      );
-      this.baseUrl = DyNTS_global_settings.baseUrl;
-    }
-
-    if (!set.endpoint) {
-      // ?TODO: nullable warning
-      DyFM_Log.warn(
-        'WARNING: DyNTS_ApiCall_Params: endpoint is not provided',
-        '\n  stack:', this.stack
-      );
-      this.endpoint = '';
-    } else if (!set.endpoint.includes) {
-      throw new Error(
-        'DyNTS_ApiCall_Params Error: something went wrong with the endpoint, it is provided but not valid'
-      );
-    } else if (set.endpoint.includes('{')) {
-      DyFM_Log.warn(
-        `WARNING: using {param} bracets in endpoint definitions will be deprecated... (${set.endpoint})` +
-        '\n  use :param instead ({pathparam} --> :pathparam)'
-      );
-      set.endpoint = set.endpoint.replace(/{/g, ':').replace(/}/g, '');
-    } else {
-      this.pathParamKeys = set.endpoint.split('/')
-        .filter(part => part.startsWith(':'))
-        .map(part => part.slice(1));
-    }
-
-    Object.assign(this, set);
-  }
-}
-
-/**
- * basic axios HttpsOptions,
- * 
- * learn more on axios package....
- * TOD: link package documentations
- */
-export class DyNTS_HttpOptions {
-  responseType?: DyFM_HttpResponseType;
-  headers?: {
-    [header: string]: string | string[];
-  };
-  observe?: 'body';
-  reportProgress?: boolean;
-  withCredentials?: boolean;
-
-  constructor(
-    set: {
-      responseType?: DyFM_HttpResponseType,
-      headers?: {
-        [header: string]: string | string[];
-      },
-      observe?: 'body',
-      reportProgress?: boolean,
-      withCredentials?: boolean
-    }
-  ) {
-    this.responseType = set.responseType;
-    this.headers = set.headers;
-    this.observe = set.observe;
-    this.reportProgress = set.reportProgress;
-    this.withCredentials = set.withCredentials;
-  }
-}
+
+import { DyFM_Error, DyFM_getConstructionStackLocation, DyFM_HttpCallType, DyFM_HttpResponseType, DyFM_Log, } from '@futdevpro/fsm-dynamo';
+import { DyNTS_global_settings } from '../../_collections/global-settings.const';
+
+
+export interface DyNTS_AxiosSettings {
+  headers?: { [header: string]: string | string[] };
+  httpAgent?: any;
+  httpsAgent?: any;
+  timeout?: number;
+  maxRedirects?: number;
+  withCredentials?: boolean;
+  responseType?: DyFM_HttpResponseType;
+}
+
+/**
+ * API call params,
+ * such as
+ * type (HttpCallType),
+ * endpoint,
+ * and other options as httpOptions
+ */
+export class DyNTS_ApiCall_Params {
+  /**
+   * name the call to be able to identify it when debugging
+   */
+  name: string;
+  /**
+   * type of the call as; HttpCallType .get, .post, ...ect
+   */
+  type: DyFM_HttpCallType = DyFM_HttpCallType.get;
+  /**
+   * the endpoint of the API, without the baseUrl:
+   * '/user/get/:userId',
+   * where the parts starting with ':', will be used as pathParam
+   */
+  baseUrl: string;
+  /**
+   * baseUrl of the API;
+   * 'https://futdevpro.hu/api'
+   */
+  endpoint: string;
+
+  /**
+   * if this value is true, the call will return the full HTTP call response in raw
+   */
+  getFullResponse: boolean = false;
+  /**
+   * this setting will be passed to the axios http call
+   */
+  httpOptions: any | DyNTS_AxiosSettings = {};
+
+  pathParamKeys: string[] = [];
+  
+  readonly stack: string;
+
+  constructor(
+    /**
+     * set of options necessary for setting up an API call
+     */
+    set: Partial<DyNTS_ApiCall_Params>
+  ) {
+    this.stack = DyFM_getConstructionStackLocation();
+
+    if (!set.name) {
+      // ?TODO: nullable warning
+      DyFM_Log.warn(
+        'WARNING: DyNTS_ApiCall_Params: name is not provided, using stack location!',
+        '\n  stack:', this.stack
+      );
+      this.name = this.stack;
+    }
+
+    if (!set.baseUrl) {
+      // ?TODO: nullable warning
+      DyFM_Log.error(
+        'ERROR: DyNTS_ApiCall_Params: baseUrl is not provided, using global baseUrl!',
+        '\n  stack:', this.stack
+      );
+      this.baseUrl = DyNTS_global_settings.baseUrl;
+    }
+
+    if (!set.endpoint) {
+      // ?TODO: nullable warning
+      DyFM_Log.warn(
+        'WARNING: DyNTS_ApiCall_Params: endpoint is not provided',
+        '\n  stack:', this.stack
+      );
+      this.endpoint = '';
+    } else if (!set.endpoint.includes) {
+      throw new Error(
+        'DyNTS_ApiCall_Params Error: something went wrong with the endpoint, it is provided but not valid'
+      );
+    } else if (set.endpoint.includes('{')) {
+      DyFM_Log.warn(
+        `WARNING: using {param} bracets in endpoint definitions will be deprecated... (${set.endpoint})` +
+        '\n  use :param instead ({pathparam} --> :pathparam)'
+      );
+      set.endpoint = set.endpoint.replace(/{/g, ':').replace(/}/g, '');
+    } else {
+      this.pathParamKeys = set.endpoint.split('/')
+        .filter(part => part.startsWith(':'))
+        .map(part => part.slice(1));
+    }
+
+    Object.assign(this, set);
+  }
+}
+
+/**
+ * basic axios HttpsOptions,
+ * 
+ * learn more on axios package....
+ * TOD: link package documentations
+ */
+export class DyNTS_HttpOptions {
+  responseType?: DyFM_HttpResponseType;
+  headers?: {
+    [header: string]: string | string[];
+  };
+  observe?: 'body';
+  reportProgress?: boolean;
+  withCredentials?: boolean;
+
+  constructor(
+    set: {
+      responseType?: DyFM_HttpResponseType,
+      headers?: {
+        [header: string]: string | string[];
+      },
+      observe?: 'body',
+      reportProgress?: boolean,
+      withCredentials?: boolean
+    }
+  ) {
+    this.responseType = set.responseType;
+    this.headers = set.headers;
+    this.observe = set.observe;
+    this.reportProgress = set.reportProgress;
+    this.withCredentials = set.withCredentials;
+  }
+}