@futdevpro/fsm-dynamo 1.20.9 → 1.20.12

package/src/_models/control-models/http/http-error-response.control-model.spec.ts

@@ -1,116 +0,0 @@
-import { DyFM_HttpErrorResponse, DyFM_httpErrorResponse_name } from './http-error-response.control-model';
-import { DyFM_Error } from '../error.control-model';
-import { DyFM_HttpResponseBase } from './http-response.model-base';
-
-describe('| DyFM_HttpErrorResponse', (): void => {
-  it('| should create an instance with valid data', (): void => {
-    const error = new Error('Test error');
-    const response = new DyFM_HttpErrorResponse({
-      status: 500,
-      statusText: 'Internal Server Error',
-      url: 'https://example.com/api/error',
-      message: 'Error message',
-      error: error
-    });
-
-    expect(response.status).toBe(500);
-    expect(response.statusText).toBe('Internal Server Error');
-    expect(response.url).toBe('https://example.com/api/error');
-    expect(response.message).toBe('Error message');
-    expect(response.error).toBe(error);
-    expect(response.ok).toBe(false);
-    expect(response.name).toBe(DyFM_httpErrorResponse_name);
-  });
-
-  it('| should always have ok set to false', (): void => {
-    const response = new DyFM_HttpErrorResponse({
-      status: 200,
-      statusText: 'OK',
-      message: 'Error message'
-    });
-
-    expect(response.ok).toBe(false);
-  });
-
-  it('| should have correct name property', (): void => {
-    const response = new DyFM_HttpErrorResponse({
-      message: 'Error message'
-    });
-
-    expect(response.name).toBe(DyFM_httpErrorResponse_name);
-  });
-
-  it('| should extend DyFM_HttpResponseBase', (): void => {
-    const response = new DyFM_HttpErrorResponse({
-      message: 'Error message'
-    });
-
-    expect(response).toBeInstanceOf(DyFM_HttpResponseBase);
-  });
-
-  it('| should implement Error interface', (): void => {
-    const response = new DyFM_HttpErrorResponse({
-      message: 'Error message'
-    });
-
-    expect(response.name).toBeDefined();
-    expect(response.message).toBeDefined();
-  });
-
-  it('| should handle DyFM_Error as error', (): void => {
-    const dyfmError = new DyFM_Error({ message: 'DyFM Error' });
-    const response = new DyFM_HttpErrorResponse({
-      message: 'Error message',
-      error: dyfmError
-    });
-
-    expect(response.error).toBe(dyfmError);
-  });
-
-  it('| should handle standard Error as error', (): void => {
-    const standardError = new Error('Standard Error');
-    const response = new DyFM_HttpErrorResponse({
-      message: 'Error message',
-      error: standardError
-    });
-
-    expect(response.error).toBe(standardError);
-  });
-
-  describe('| isHttpErrorResponse', (): void => {
-    it('| should return true for HttpErrorResponse instance', (): void => {
-      const response = new DyFM_HttpErrorResponse({
-        message: 'Error message'
-      });
-
-      expect(DyFM_HttpErrorResponse.isHttpErrorResponse(response)).toBe(true);
-    });
-
-    it('| should return false for standard Error', (): void => {
-      const error = new Error('Standard error');
-
-      expect(DyFM_HttpErrorResponse.isHttpErrorResponse(error)).toBe(false);
-    });
-
-    it('| should return false for DyFM_Error', (): void => {
-      const error = new DyFM_Error({ message: 'DyFM Error' });
-
-      expect(DyFM_HttpErrorResponse.isHttpErrorResponse(error)).toBe(false);
-    });
-
-    it('| should return false for null', (): void => {
-      expect(DyFM_HttpErrorResponse.isHttpErrorResponse(null as any)).toBe(false);
-    });
-
-    it('| should return false for undefined', (): void => {
-      expect(DyFM_HttpErrorResponse.isHttpErrorResponse(undefined as any)).toBe(false);
-    });
-
-    it('| should return false for object without name property', (): void => {
-      const obj = { message: 'test' };
-
-      expect(DyFM_HttpErrorResponse.isHttpErrorResponse(obj as any)).toBe(false);
-    });
-  });
-});
-

package/src/_models/control-models/http/http-error-response.control-model.ts

@@ -1,52 +0,0 @@
-import { DyFM_AnyError, DyFM_Error } from '../error.control-model';
-import { DyFM_HttpResponseBase } from './http-response.model-base';
-
-export const DyFM_httpErrorResponse_name = 'HttpErrorResponse';
-
-/**
- * A class that represents an HTTP error response.
- *
- * @example
- * ```ts
- * const errorResponse: DyFM_HttpErrorResponse = new DyFM_HttpErrorResponse({
- *   status: 500,
- *   statusText: 'Internal Server Error',
- *   url: 'https://example.com/api/error',
- *   error: new Error('Internal Server Error'),
- * });
- * ```
- */
-export class DyFM_HttpErrorResponse extends DyFM_HttpResponseBase implements Error {
-  readonly name = DyFM_httpErrorResponse_name;
-  readonly message: string;
-  readonly error?: DyFM_Error | Error;
-  /**
-   * Errors are never okay, even when the status code is in the 2xx success range.
-   */
-  override readonly ok = false;
-  constructor(
-    set: Partial<DyFM_HttpErrorResponse>
-  ) {
-    super(set);
-
-    if (set) {
-      Object.assign(this, set);
-    }
-  }
-
-  /**
-   * Checks if the error is an HTTP error response.
-   * @param error - The error to check.
-   * @returns True if the error is an HTTP error response, false otherwise.
-   * 
-   * @example
-   * ```ts
-   * const error: DyFM_AnyError = new Error('Internal Server Error');
-   * const isHttpErrorResponse: boolean = DyFM_HttpErrorResponse.isHttpErrorResponse(error);
-   * console.log(isHttpErrorResponse); // true
-   * ```
-   */
-  static isHttpErrorResponse(error: DyFM_AnyError): error is DyFM_HttpErrorResponse {
-    return (error as DyFM_HttpErrorResponse)?.name === DyFM_httpErrorResponse_name;
-  }
-}

package/src/_models/control-models/http/http-headers.control-model.spec.ts

@@ -1,25 +0,0 @@
-import { DyFM_HttpHeaders } from './http-headers.control-model';
-
-describe('| DyFM_HttpHeaders', (): void => {
-  it('| should create an instance without parameters', (): void => {
-    const headers = new DyFM_HttpHeaders();
-
-    expect(headers).toBeTruthy();
-  });
-
-  it('| should create an instance with headers object', (): void => {
-    const headers = new DyFM_HttpHeaders({
-      'Content-Type': 'application/json',
-      'Authorization': 'Bearer 1234567890',
-    });
-
-    expect(headers).toBeTruthy();
-  });
-
-  it('| should create an instance with string headers', (): void => {
-    const headers = new DyFM_HttpHeaders('Content-Type: application/json');
-
-    expect(headers).toBeTruthy();
-  });
-});
-

package/src/_models/control-models/http/http-headers.control-model.ts

@@ -1,125 +0,0 @@
-
-
-/**
- * Represents the header configuration options for an HTTP request.
- * Instances are immutable. Modifying methods return a cloned
- * instance with the change. The original object is never changed.
- *
- * @publicApi
- * 
- * @example
- * ```ts
- * const headers: DyFM_HttpHeaders = new DyFM_HttpHeaders({
- *   'Content-Type': 'application/json',
- *   'Authorization': 'Bearer 1234567890',
- * });
- * ```
- */
-export class DyFM_HttpHeaders {
-  /**
-   * Internal map of lowercase header names to values.
-   */
-  private headers: { [name: string]: string | number | (string | number)[] } = {};
-  /**
-   * Internal map of lowercased header names to the normalized
-   * form of the name (the form seen first).
-   */
-  private normalizedNames;
-  /**
-   * Complete the lazy initialization of this object (needed before reading).
-   */
-  private lazyInit;
-  /**
-   * Queued updates to be materialized the next initialization.
-   */
-  private lazyUpdate;
-  /**  Constructs a new HTTP header object with the given values.*/
-  constructor(
-    setHeaders?: string | { [name: string]: string | number | (string | number)[] } | Headers
-  ) {
-    if (setHeaders) {
-      this.headers = setHeaders as { [name: string]: string | number | (string | number)[] };
-    }
-  }
-  ///**
-  // * Checks for existence of a given header.
-  // *
-  // * @param name The header name to check for existence.
-  // *
-  // * @returns True if the header exists, false otherwise.
-  // */
-  //has(name: string): boolean {
-  //  return Boolean(this.headers[name]);
-  //}
-  ///**
-  // * Retrieves the first value of a given header.
-  // *
-  // * @param name The header name.
-  // *
-  // * @returns The value string if the header exists, null otherwise
-  // */
-  //get(name: string): string | number | (string | number)[] {
-  //  return this.headers[name];
-  //}
-  ///**
-  // * Retrieves the names of the headers.
-  // *
-  // * @returns A list of header names.
-  // */
-  //keys(): string[] {
-  //  return Object.keys(this.headers);
-  //}
-  ///**
-  // * Retrieves a list of values for a given header.
-  // *
-  // * @param name The header name from which to retrieve values.
-  // *
-  // * @returns A string of values if the header exists, null otherwise.
-  // */
-  //getAll(name: string): string[] | number[] | (string | number)[] | null {
-  //  return this.headers[name] as string[] | number[] | (string | number)[] | null;
-  //}
-  ///**
-  // * Appends a new value to the existing set of values for a header
-  // * and returns them in a clone of the original instance.
-  // *
-  // * @param name The header name for which to append the values.
-  // * @param value The value to append.
-  // *
-  // * @returns A clone of the HTTP headers object with the value appended to the given header.
-  // */
-  //append(name: string, value: string | string[]): DyFM_HttpHeaders {
-  //  return new DyFM_HttpHeaders(this.headers);
-  //}
-  ///**
-  // * Sets or modifies a value for a given header in a clone of the original instance.
-  // * If the header already exists, its value is replaced with the given value
-  // * in the returned object.
-  // *
-  // * @param name The header name.
-  // * @param value The value or values to set or override for the given header.
-  // *
-  // * @returns A clone of the HTTP headers object with the newly set header value.
-  // */
-  //set(name: string, value: string | string[]): DyFM_HttpHeaders {
-  //  return new DyFM_HttpHeaders(this.headers);
-  //}
-  ///**
-  // * Deletes values for a given header in a clone of the original instance.
-  // *
-  // * @param name The header name.
-  // * @param value The value or values to delete for the given header.
-  // *
-  // * @returns A clone of the HTTP headers object with the given value deleted.
-  // */
-  //delete(name: string, value?: string | string[]): DyFM_HttpHeaders {
-  //  return new DyFM_HttpHeaders(this.headers);
-  //}
-
-  /* private maybeSetNormalizedName;
-  private init;
-  private copyFrom;
-  private clone;
-  private applyUpdate;
-  private setHeaderEntries; */
-}

package/src/_models/control-models/http/http-response.model-base.spec.ts

@@ -1,46 +0,0 @@
-import { DyFM_HttpResponseBase } from './http-response.model-base';
-import { DyFM_HttpEventType } from '../../../_enums/http/http-event-type.enum';
-
-class TestHttpResponse extends DyFM_HttpResponseBase {
-  constructor(set?: Partial<DyFM_HttpResponseBase>) {
-    super(set);
-  }
-}
-
-describe('| DyFM_HttpResponseBase', (): void => {
-  it('| should create an instance with default values', (): void => {
-    const response = new TestHttpResponse({ url: null });
-
-    expect(response.status).toBe(200);
-    expect(response.statusText).toBe('OK');
-    expect(response.headers).toBeTruthy();
-    expect(response.url).toBeNull();
-  });
-
-  it('| should create an instance with custom values', (): void => {
-    const response = new TestHttpResponse({
-      status: 404,
-      statusText: 'Not Found',
-      url: 'https://example.com/api/test',
-      ok: false,
-      type: DyFM_HttpEventType.response,
-    });
-
-    expect(response.status).toBe(404);
-    expect(response.statusText).toBe('Not Found');
-    expect(response.url).toBe('https://example.com/api/test');
-    expect(response.ok).toBe(false);
-    expect(response.type).toBe(DyFM_HttpEventType.response);
-  });
-
-  it('| should create an instance with partial values', (): void => {
-    const response = new TestHttpResponse({
-      status: 500,
-    });
-
-    expect(response.status).toBe(500);
-    expect(response.statusText).toBe('OK');
-    expect(response.headers).toBeTruthy();
-  });
-});
-

package/src/_models/control-models/http/http-response.model-base.ts

@@ -1,58 +0,0 @@
-import { DyFM_HttpEventType } from '../../../_enums/http/http-event-type.enum';
-import { DyFM_HttpHeaders } from './http-headers.control-model';
-
-/**
- * Base class for both `HttpResponse` and `HttpHeaderResponse`.
- *
- * @publicApi
- * 
- * @example
- * ```ts
- * const response: DyFM_HttpResponseBase = new DyFM_HttpResponseBase({
- *   status: 200,
- *   statusText: 'OK',
- *   url: 'https://example.com/api/response',
- * });
- * ```
- */
-export abstract class DyFM_HttpResponseBase {
-  /**
-   * All response headers.
-   */
-  readonly headers: DyFM_HttpHeaders = new DyFM_HttpHeaders();
-  /**
-   * Response status code.
-   */
-  readonly status: number = 200;
-  /**
-   * Textual description of response status code, defaults to OK.
-   *
-   * Do not depend on this.
-   */
-  readonly statusText: string = 'OK';
-  /**
-   * URL of the resource retrieved, or null if not available.
-   */
-  readonly url: string | null;
-  /**
-   * Whether the status code falls in the 2xx range.
-   */
-  readonly ok: boolean;
-  /**
-   * Type of the response, narrowed to either the full response or the header.
-   */
-  readonly type: DyFM_HttpEventType.response | DyFM_HttpEventType.responseHeader;
-  /**
-   * Super-constructor for all responses.
-   *
-   * The single parameter accepted is an initialization hash. Any properties
-   * of the response passed there will override the default values.
-   */
-  constructor(
-    set: Partial<DyFM_HttpResponseBase>
-  ) {
-    if (set) {
-      Object.assign(this, set);
-    }
-  }
-}

package/src/_models/control-models/poll.control-model.spec.ts

@@ -1,63 +0,0 @@
-
-import { DyFM_Error } from './error.control-model';
-import { DyFM_Poll } from './poll.control-model';
-
-describe('| DyFM_Poll', () => {
-  let pollInstance: DyFM_Poll<number>;
-  let pollDo: jasmine.Spy<(...args: any[]) => Promise<number>>;
-  let pollWhile: jasmine.Spy<(res: number) => boolean>;
-  let pollEnd: jasmine.Spy<(res: number) => void>;
-
-  beforeEach(() => {
-    pollDo = jasmine.createSpy('pollDo').and.returnValue(Promise.resolve(1));
-    pollWhile = jasmine.createSpy('pollWhile').and.returnValue(true);
-    pollEnd = jasmine.createSpy('pollEnd');
-
-    pollInstance = new DyFM_Poll<number>({
-      pollDo,
-      pollWhile,
-      pollEnd,
-      pollDelay: 0,
-      pollPeriod: 1000,
-      stopOnFail: true,
-    });
-  });
-
-  xit('should initialize with the correct properties', () => {
-    expect(pollInstance.running).toBeTrue();
-    expect(pollDo).toHaveBeenCalled();
-  });
-
-  it('| should stop polling when stop is called', () => {
-    pollInstance.stop();
-    expect(pollInstance.running).toBeFalse();
-  });
-
-  xit('should call pollEnd and stop polling when pollWhile returns false', async () => {
-    pollWhile.and.returnValue(false);
-    await pollDo.calls.mostRecent().returnValue;
-    expect(pollEnd).toHaveBeenCalledWith(1);
-    expect(pollInstance.running).toBeFalse();
-  });
-
-  xit('should throw DyFM_Error when pollDo fails and stopOnFail is true', async () => {
-    pollDo.and.returnValue(Promise.reject('error'));
-    try {
-      await pollDo.calls.mostRecent().returnValue;
-    } catch (error) {
-      expect(error).toEqual(jasmine.any(DyFM_Error));
-    }
-    expect(pollInstance.running).toBeFalse();
-  });
-
-  xit('should restart polling with new arguments', () => {
-    const newArgs = [2];
-    pollInstance.restartPoll(newArgs);
-    expect(pollDo).toHaveBeenCalledWith(...newArgs);
-  });
-
-  xit('should restart polling with initial arguments if no new arguments are provided', () => {
-    pollInstance.restartPoll();
-    expect(pollDo).toHaveBeenCalledWith(...pollInstance['args']);
-  });
-});

package/src/_models/control-models/poll.control-model.ts

@@ -1,151 +0,0 @@
-import { Subscription, timer } from 'rxjs';
-import { DyFM_Error } from './error.control-model';
-import { second } from '../../_collections/constants/times.const';
-import { DyFM_Async } from '../../_collections/utils/async.util';
-
-
-/**
- * DynamoFSM_Poll is a predefined class is
- * for polling a specific endpoint
- * waiting a specific result
- * 
- * @example
- * ```ts
- * const poll: DyFM_Poll<string> = new DyFM_Poll({
- *   name: 'My Poll',
- *   pollDo: async () => {
- *     return 'Poll result';
- *   },
- * });
- * ```
- */
-export class DyFM_Poll<T> {
-  name: string;
-
-  poll: Subscription;
-  running: boolean;
-
-  /**
-   * The function that will be called to poll the endpoint,
-   * it will be called every pollPeriod
-   */
-  readonly pollDo: (...args) => Promise<T>;
-  /**
-   * The function that will be called to check if the poll should continue,
-   * if this returns false, the poll will end
-   */
-  readonly pollWhile: (res: T) => boolean;
-  /**
-   * The function that will be called to end the poll
-   */
-  readonly pollEnd?: (res: T) => void;
-  /**
-   * The function that will be called to handle the error
-   */
-  readonly pollDoError?: (error: any) => void;
-  readonly args?: any[];
-  readonly pollDelay: number = 0;
-  readonly pollPeriod: number = 3 * second;
-  readonly stopOnFail: boolean = false;
-  readonly delayFirst: boolean = false;
-
-  constructor(
-    set: Partial<DyFM_Poll<T>> 
-  ) {
-    try {
-      Object.assign(this, set);
-
-      if (set.pollPeriod === 0) {
-        console.error(
-          'DYNAMO ERROR: creating polls with 0ms period is not supported! ' +
-          '(it will reset to 1000ms (1s))',
-        );
-        this.pollPeriod = 1 * second;
-      }
-
-      if (this.pollPeriod < 300) {
-        console.warn(
-          'DYNAMO WARNING: creating polls with less than 300ms period is not recommended!'
-        );
-      }
-
-      this.name = set.name ?? 'Unnamed DyFM_Poll';
-
-      this.stopOnFail = set.stopOnFail;
-      this.startPoll(this.args);
-    } catch (error) {
-      throw new DyFM_Error({
-        message: 'DyFM_Poll construcion failed.'
-      });
-    }
-  }
-
-  /**
-   * Starts the poll
-   * @param args - The arguments to pass to the pollDo function
-   */
-  private async startPoll(...args: any[]): Promise<void> {
-    try {
-      if (this.delayFirst) {
-        await DyFM_Async.wait(this.pollDelay);
-      }
-      this.poll = timer(this.pollDelay, this.pollPeriod).subscribe(async (): Promise<void> => {
-        await this.pollDo(...args).then((res: T): void => {
-          if (!this.pollWhile(res)) {
-            this.end(res);
-          }
-        }).catch((error): void => {
-          if (this.stopOnFail) {
-            this.stop();
-          }
-
-          if (this.pollDoError) {
-            this.pollDoError(error);
-          } else {
-            throw new DyFM_Error({
-              message: `DYNAMO ERROR: ` +
-                `\nDynamoPoll: "${this.name}" pollDo was UNSUCCESSFUL`,
-              error: error,
-            });
-          }
-        });
-      });
-      this.running = true;
-    } catch (error) {
-      throw new DyFM_Error({
-        message: 'DYNAMO ERROR: \nDynamoPoll: startPoll was UNSUCCESSFUL',
-        error: error,
-      });
-    }
-  }
-
-  /**
-   * Restarts the poll
-   * @param args - The arguments to pass to the pollDo function
-   */
-  restartPoll(args?: any[]): void {
-    try {
-      if (args) {
-        this.startPoll(args);
-      } else {
-        this.startPoll(this.args);
-      }
-    } catch (error) {
-      throw new DyFM_Error({
-        message: 'DYNAMO ERROR: \nDynamoPoll: restartPoll was UNSUCCESSFUL',
-        error: error,
-      });
-    }
-  }
-
-  stop(): void {
-    this.poll.unsubscribe();
-    this.running = false;
-  }
-
-  end(result: T): void {
-    this.poll.unsubscribe();
-    this.pollEnd?.(result);
-    this.running = false;
-  }
-}