@ssv/ngx.command 3.0.0-dev.1 → 3.0.0-dev.1-dev.11

package/src/command.ts

@@ -1,170 +1,170 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Observable, combineLatest, Subscription, Subject, BehaviorSubject, of, EMPTY } from "rxjs";
-import { tap, map, filter, switchMap, catchError, finalize, take } from "rxjs/operators";
-import { ICommand } from "./command.model";
-
-/**
- * Command object used to encapsulate information which is needed to perform an action.
- */
-export class Command implements ICommand {
-
-	/** Determines whether the command is currently executing, as a snapshot value. */
-	get isExecuting(): boolean {
-		return this._isExecuting;
-	}
-
-	/** Determines whether the command can execute or not, as a snapshot value. */
-	get canExecute(): boolean {
-		return this._canExecute;
-	}
-
-	/** Determines whether the command is currently executing, as an observable. */
-	get isExecuting$(): Observable<boolean> {
-		return this._isExecuting$.asObservable();
-	}
-
-	/** Determines whether to auto destroy when having 0 subscribers. */
-	autoDestroy = true;
-
-	/** Determines whether the command can execute or not, as an observable. */
-	readonly canExecute$: Observable<boolean>;
-
-	private _isExecuting$ = new BehaviorSubject<boolean>(false);
-	private _isExecuting = false;
-	private _canExecute = true;
-	private executionPipe$ = new Subject<unknown[] | undefined>();
-	private isExecuting$$ = Subscription.EMPTY;
-	private canExecute$$ = Subscription.EMPTY;
-	private executionPipe$$ = Subscription.EMPTY;
-	private subscribersCount = 0;
-
-	/**
-	 * Creates an instance of Command.
-	 *
-	 * @param execute Execute function to invoke - use `isAsync: true` when `Observable<any>`.
-	 * @param canExecute Observable which determines whether it can execute or not.
-	 * @param isAsync Indicates that the execute function is async e.g. Observable.
-	 */
-	constructor(
-		execute: (...args: unknown[]) => unknown,
-		canExecute$?: Observable<boolean>,
-		isAsync?: boolean,
-	) {
-		if (canExecute$) {
-			this.canExecute$ = combineLatest([
-				this._isExecuting$,
-				canExecute$
-			]).pipe(
-				map(([isExecuting, canExecuteResult]) => {
-					// console.log("[command::combineLatest$] update!", { isExecuting, canExecuteResult });
-					this._isExecuting = isExecuting;
-					this._canExecute = !isExecuting && !!canExecuteResult;
-					return this._canExecute;
-				}),
-			);
-			this.canExecute$$ = this.canExecute$.subscribe();
-		} else {
-			this.canExecute$ = this._isExecuting$.pipe(
-				map(x => {
-					const canExecute = !x;
-					this._canExecute = canExecute;
-					return canExecute;
-				})
-			);
-			this.isExecuting$$ = this._isExecuting$
-				.pipe(tap(x => this._isExecuting = x))
-				.subscribe();
-		}
-		this.executionPipe$$ = this.buildExecutionPipe(execute, isAsync).subscribe();
-	}
-
-	/** Execute function to invoke. */
-	execute(...args: unknown[]): void {
-		// console.warn("[command::execute]", args);
-		this.executionPipe$.next(args);
-	}
-
-	/** Disposes all resources held by subscriptions. */
-	destroy(): void {
-		// console.warn("[command::destroy]");
-		this.executionPipe$$.unsubscribe();
-		this.canExecute$$.unsubscribe();
-		this.isExecuting$$.unsubscribe();
-	}
-
-	subscribe(): void {
-		this.subscribersCount++;
-	}
-
-	unsubscribe(): void {
-		this.subscribersCount--;
-		// console.log("[command::unsubscribe]", { autoDestroy: this.autoDestroy, subscribersCount: this.subscribersCount });
-		if (this.autoDestroy && this.subscribersCount <= 0) {
-			this.destroy();
-		}
-	}
-
-	private buildExecutionPipe(execute: (...args: unknown[]) => any, isAsync?: boolean): Observable<unknown> {
-		let pipe$ = this.executionPipe$.pipe(
-			// tap(x => console.warn(">>>> executionPipe", this._canExecute)),
-			filter(() => this._canExecute),
-			tap(() => {
-				// console.log("[command::executionPipe$] do#1 - set execute", { args: x });
-				this._isExecuting$.next(true);
-			})
-		);
-
-		const execFn = isAsync
-			? switchMap<unknown[] | undefined, any[]>(args => {
-				if (args) {
-					return execute(...args);
-				}
-				return execute();
-			})
-			: tap((args: unknown[] | undefined) => {
-				if (args) {
-					execute(...args);
-					return;
-				}
-				execute();
-			});
-
-		pipe$ = pipe$.pipe(
-			switchMap(args => of(args).pipe(
-				execFn,
-				finalize(() => {
-					// console.log("[command::executionPipe$]  finalize inner#1 - set idle");
-					this._isExecuting$.next(false);
-				}),
-				take(1),
-				catchError(error => {
-					console.error("Unhandled execute error", error);
-					return EMPTY;
-				}),
-			)),
-			tap(
-				() => {
-					// console.log("[command::executionPipe$] tap#2 - set idle");
-					this._isExecuting$.next(false);
-				},
-			)
-		);
-		return pipe$;
-	}
-
-}
-
-/**
- * Async Command object used to encapsulate information which is needed to perform an action,
- * which takes an execute function as Observable/Promise.
- */
-export class CommandAsync extends Command {
-
-	constructor(
-		execute: (...args: any[]) => Observable<unknown> | Promise<unknown>,
-		canExecute$?: Observable<boolean>,
-	) {
-		super(execute, canExecute$, true);
-	}
-
-}
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Observable, combineLatest, Subscription, Subject, BehaviorSubject, of, EMPTY } from "rxjs";
+import { tap, map, filter, switchMap, catchError, finalize, take } from "rxjs/operators";
+import { ICommand } from "./command.model";
+
+/**
+ * Command object used to encapsulate information which is needed to perform an action.
+ */
+export class Command implements ICommand {
+
+	/** Determines whether the command is currently executing, as a snapshot value. */
+	get isExecuting(): boolean {
+		return this._isExecuting;
+	}
+
+	/** Determines whether the command can execute or not, as a snapshot value. */
+	get canExecute(): boolean {
+		return this._canExecute;
+	}
+
+	/** Determines whether the command is currently executing, as an observable. */
+	get isExecuting$(): Observable<boolean> {
+		return this._isExecuting$.asObservable();
+	}
+
+	/** Determines whether to auto destroy when having 0 subscribers. */
+	autoDestroy = true;
+
+	/** Determines whether the command can execute or not, as an observable. */
+	readonly canExecute$: Observable<boolean>;
+
+	private _isExecuting$ = new BehaviorSubject<boolean>(false);
+	private _isExecuting = false;
+	private _canExecute = true;
+	private executionPipe$ = new Subject<unknown[] | undefined>();
+	private isExecuting$$ = Subscription.EMPTY;
+	private canExecute$$ = Subscription.EMPTY;
+	private executionPipe$$ = Subscription.EMPTY;
+	private subscribersCount = 0;
+
+	/**
+	 * Creates an instance of Command.
+	 *
+	 * @param execute Execute function to invoke - use `isAsync: true` when `Observable<any>`.
+	 * @param canExecute Observable which determines whether it can execute or not.
+	 * @param isAsync Indicates that the execute function is async e.g. Observable.
+	 */
+	constructor(
+		execute: (...args: unknown[]) => unknown,
+		canExecute$?: Observable<boolean>,
+		isAsync?: boolean,
+	) {
+		if (canExecute$) {
+			this.canExecute$ = combineLatest([
+				this._isExecuting$,
+				canExecute$
+			]).pipe(
+				map(([isExecuting, canExecuteResult]) => {
+					// console.log("[command::combineLatest$] update!", { isExecuting, canExecuteResult });
+					this._isExecuting = isExecuting;
+					this._canExecute = !isExecuting && !!canExecuteResult;
+					return this._canExecute;
+				}),
+			);
+			this.canExecute$$ = this.canExecute$.subscribe();
+		} else {
+			this.canExecute$ = this._isExecuting$.pipe(
+				map(x => {
+					const canExecute = !x;
+					this._canExecute = canExecute;
+					return canExecute;
+				})
+			);
+			this.isExecuting$$ = this._isExecuting$
+				.pipe(tap(x => this._isExecuting = x))
+				.subscribe();
+		}
+		this.executionPipe$$ = this.buildExecutionPipe(execute, isAsync).subscribe();
+	}
+
+	/** Execute function to invoke. */
+	execute(...args: unknown[]): void {
+		// console.warn("[command::execute]", args);
+		this.executionPipe$.next(args);
+	}
+
+	/** Disposes all resources held by subscriptions. */
+	destroy(): void {
+		// console.warn("[command::destroy]");
+		this.executionPipe$$.unsubscribe();
+		this.canExecute$$.unsubscribe();
+		this.isExecuting$$.unsubscribe();
+	}
+
+	subscribe(): void {
+		this.subscribersCount++;
+	}
+
+	unsubscribe(): void {
+		this.subscribersCount--;
+		// console.log("[command::unsubscribe]", { autoDestroy: this.autoDestroy, subscribersCount: this.subscribersCount });
+		if (this.autoDestroy && this.subscribersCount <= 0) {
+			this.destroy();
+		}
+	}
+
+	private buildExecutionPipe(execute: (...args: unknown[]) => any, isAsync?: boolean): Observable<unknown> {
+		let pipe$ = this.executionPipe$.pipe(
+			// tap(x => console.warn(">>>> executionPipe", this._canExecute)),
+			filter(() => this._canExecute),
+			tap(() => {
+				// console.log("[command::executionPipe$] do#1 - set execute", { args: x });
+				this._isExecuting$.next(true);
+			})
+		);
+
+		const execFn = isAsync
+			? switchMap<unknown[] | undefined, any[]>(args => {
+				if (args) {
+					return execute(...args);
+				}
+				return execute();
+			})
+			: tap((args: unknown[] | undefined) => {
+				if (args) {
+					execute(...args);
+					return;
+				}
+				execute();
+			});
+
+		pipe$ = pipe$.pipe(
+			switchMap(args => of(args).pipe(
+				execFn,
+				finalize(() => {
+					// console.log("[command::executionPipe$]  finalize inner#1 - set idle");
+					this._isExecuting$.next(false);
+				}),
+				take(1),
+				catchError(error => {
+					console.error("Unhandled execute error", error);
+					return EMPTY;
+				}),
+			)),
+			tap(
+				() => {
+					// console.log("[command::executionPipe$] tap#2 - set idle");
+					this._isExecuting$.next(false);
+				},
+			)
+		);
+		return pipe$;
+	}
+
+}
+
+/**
+ * Async Command object used to encapsulate information which is needed to perform an action,
+ * which takes an execute function as Observable/Promise.
+ */
+export class CommandAsync extends Command {
+
+	constructor(
+		execute: (...args: any[]) => Observable<unknown> | Promise<unknown>,
+		canExecute$?: Observable<boolean>,
+	) {
+		super(execute, canExecute$, true);
+	}
+
+}

package/src/command.util.ts

@@ -1,50 +1,50 @@
-import { AbstractControl, AbstractControlDirective, FormControlStatus } from "@angular/forms";
-import { Observable, of } from "rxjs";
-import { map, distinctUntilChanged, startWith, delay } from "rxjs/operators";
-
-import { CommandCreator, ICommand } from "./command.model";
-import { Command } from "./command";
-
-/** Determines whether the arg object is of type `Command`. */
-export function isCommand(arg: unknown): arg is ICommand {
-	return arg instanceof Command;
-}
-
-/** Determines whether the arg object is of type `CommandCreator`. */
-export function isCommandCreator(arg: unknown): arg is CommandCreator {
-	if (arg instanceof Command) {
-		return false;
-	} else if (isAssumedType<CommandCreator>(arg) && arg.execute && arg.host) {
-		return true;
-	}
-	return false;
-}
-
-export interface CanExecuteFormOptions {
-	/** Determines whether to check for validity. (defaults: true) */
-	validity?: boolean;
-
-	/** Determines whether to check whether UI has been touched. (defaults: true) */
-	dirty?: boolean;
-}
-
-/** Get form is valid as an observable. */
-export function canExecuteFromNgForm(
-	form: AbstractControl | AbstractControlDirective,
-	options?: CanExecuteFormOptions
-): Observable<boolean> {
-	const opts: CanExecuteFormOptions = { validity: true, dirty: true, ...options };
-
-	return form.statusChanges
-		? (form.statusChanges as Observable<FormControlStatus>).pipe( // todo: remove cast when working correctly
-			delay(0),
-			startWith(form.valid),
-			map(() => !!(!opts.validity || form.valid) && !!(!opts.dirty || form.dirty)),
-			distinctUntilChanged(),
-		)
-		: of(true);
-}
-
-function isAssumedType<T = Record<string, unknown>>(x: unknown): x is Partial<T> {
-	return x !== null && typeof x === "object";
-}
+import { AbstractControl, AbstractControlDirective, FormControlStatus } from "@angular/forms";
+import { Observable, of } from "rxjs";
+import { map, distinctUntilChanged, startWith, delay } from "rxjs/operators";
+
+import { CommandCreator, ICommand } from "./command.model";
+import { Command } from "./command";
+
+/** Determines whether the arg object is of type `Command`. */
+export function isCommand(arg: unknown): arg is ICommand {
+	return arg instanceof Command;
+}
+
+/** Determines whether the arg object is of type `CommandCreator`. */
+export function isCommandCreator(arg: unknown): arg is CommandCreator {
+	if (arg instanceof Command) {
+		return false;
+	} else if (isAssumedType<CommandCreator>(arg) && arg.execute && arg.host) {
+		return true;
+	}
+	return false;
+}
+
+export interface CanExecuteFormOptions {
+	/** Determines whether to check for validity. (defaults: true) */
+	validity?: boolean;
+
+	/** Determines whether to check whether UI has been touched. (defaults: true) */
+	dirty?: boolean;
+}
+
+/** Get form is valid as an observable. */
+export function canExecuteFromNgForm(
+	form: AbstractControl | AbstractControlDirective,
+	options?: CanExecuteFormOptions
+): Observable<boolean> {
+	const opts: CanExecuteFormOptions = { validity: true, dirty: true, ...options };
+
+	return form.statusChanges
+		? (form.statusChanges as Observable<FormControlStatus>).pipe( // todo: remove cast when working correctly
+			delay(0),
+			startWith(form.valid),
+			map(() => !!(!opts.validity || form.valid) && !!(!opts.dirty || form.dirty)),
+			distinctUntilChanged(),
+		)
+		: of(true);
+}
+
+function isAssumedType<T = Record<string, unknown>>(x: unknown): x is Partial<T> {
+	return x !== null && typeof x === "object";
+}

package/src/index.ts

@@ -1,8 +1,8 @@
-export * from "./command";
-export * from "./command.directive";
-export * from "./command-ref.directive";
-export * from "./command.util";
-export { CommandCreator, ICommand } from "./command.model";
-export * from "./command.options";
-export * from "./module";
-export * from "./version";
+export * from "./command";
+export * from "./command.directive";
+export * from "./command-ref.directive";
+export * from "./command.util";
+export { CommandCreator, ICommand } from "./command.model";
+export * from "./command.options";
+export * from "./module";
+export * from "./version";

package/src/module.ts

@@ -1,17 +1,17 @@
-import { NgModule } from "@angular/core";
-
-import { CommandDirective } from "./command.directive";
-import { CommandRefDirective } from "./command-ref.directive";
-
-const EXPORTED_IMPORTS = [
-	CommandDirective,
-	CommandRefDirective
-];
-
-@NgModule({
-	imports: [EXPORTED_IMPORTS],
-	exports: [EXPORTED_IMPORTS]
-})
-export class SsvCommandModule {
-
-}
+import { NgModule } from "@angular/core";
+
+import { CommandDirective } from "./command.directive";
+import { CommandRefDirective } from "./command-ref.directive";
+
+const EXPORTED_IMPORTS = [
+	CommandDirective,
+	CommandRefDirective
+];
+
+@NgModule({
+	imports: [EXPORTED_IMPORTS],
+	exports: [EXPORTED_IMPORTS]
+})
+export class SsvCommandModule {
+
+}

package/src/test-setup.ts

@@ -1,8 +1,8 @@
-// @ts-expect-error https://thymikee.github.io/jest-preset-angular/docs/getting-started/test-environment
-globalThis.ngJest = {
-  testEnvironmentOptions: {
-    errorOnUnknownElements: true,
-    errorOnUnknownProperties: true,
-  },
-};
-import 'jest-preset-angular/setup-jest';
+// @ts-expect-error https://thymikee.github.io/jest-preset-angular/docs/getting-started/test-environment
+globalThis.ngJest = {
+  testEnvironmentOptions: {
+    errorOnUnknownElements: true,
+    errorOnUnknownProperties: true,
+  },
+};
+import 'jest-preset-angular/setup-jest';

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = "0.0.0-PLACEHOLDER";
+export const VERSION = "3.0.0-dev.1-dev.11";

package/tsconfig.json

@@ -1,28 +1,28 @@
-{
-  "compilerOptions": {
-    "target": "es2022",
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitOverride": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true
-  },
-  "files": [],
-  "include": [],
-  "references": [
-    {
-      "path": "./tsconfig.lib.json"
-    },
-    {
-      "path": "./tsconfig.spec.json"
-    }
-  ],
-  "extends": "../../tsconfig.base.json",
-  "angularCompilerOptions": {
-    "enableI18nLegacyMessageIdFormat": false,
-    "strictInjectionParameters": true,
-    "strictInputAccessModifiers": true,
-    "strictTemplates": true
-  }
-}
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "extends": "../../tsconfig.base.json",
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  }
+}

package/tsconfig.lib.json

@@ -1,17 +1,17 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "declaration": true,
-    "declarationMap": true,
-    "inlineSources": true,
-    "types": []
-  },
-  "exclude": [
-    "src/**/*.spec.ts",
-    "src/test-setup.ts",
-    "jest.config.ts",
-    "src/**/*.test.ts"
-  ],
-  "include": ["src/**/*.ts"]
-}
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "types": []
+  },
+  "exclude": [
+    "src/**/*.spec.ts",
+    "src/test-setup.ts",
+    "jest.config.ts",
+    "src/**/*.test.ts"
+  ],
+  "include": ["src/**/*.ts"]
+}

package/tsconfig.lib.prod.json

@@ -1,9 +1,9 @@
-{
-  "extends": "./tsconfig.lib.json",
-  "compilerOptions": {
-    "declarationMap": false
-  },
-  "angularCompilerOptions": {
-    "compilationMode": "partial"
-  }
-}
+{
+  "extends": "./tsconfig.lib.json",
+  "compilerOptions": {
+    "declarationMap": false
+  },
+  "angularCompilerOptions": {
+    "compilationMode": "partial"
+  }
+}

package/tsconfig.spec.json

@@ -1,16 +1,16 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "outDir": "../../dist/out-tsc",
-    "module": "commonjs",
-    "target": "es2016",
-    "types": ["jest", "node"]
-  },
-  "files": ["src/test-setup.ts"],
-  "include": [
-    "jest.config.ts",
-    "src/**/*.test.ts",
-    "src/**/*.spec.ts",
-    "src/**/*.d.ts"
-  ]
-}
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "target": "es2016",
+    "types": ["jest", "node"]
+  },
+  "files": ["src/test-setup.ts"],
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}