@ssv/ngx.command 0.0.0-PLACEHOLDER

package/README.md

@@ -0,0 +1,243 @@
+[projectUri]: https://github.com/sketch7/ngx.command
+[changeLog]: ./CHANGELOG.md
+[releaseWorkflowWiki]: ./docs/RELEASE-WORKFLOW.md
+
+[npm]: https://www.npmjs.com
+[commandpatternwiki]: https://en.wikipedia.org/wiki/Command_pattern
+
+# @ssv/ngx.command
+[![CI](https://github.com/sketch7/ngx.command/actions/workflows/ci.yml/badge.svg)](https://github.com/sketch7/ngx.command/actions/workflows/ci.yml)
+[![npm version](https://badge.fury.io/js/%40ssv%2Fngx.command.svg)](https://badge.fury.io/js/%40ssv%2Fngx.command)
+
+[Command pattern][commandpatternwiki] implementation for angular. Command's are used to encapsulate information which is needed to perform an action.
+
+Primary usage is to disable a button when an action is executing, or not in a valid state (e.g. busy, invalid), and also to show an activity progress while executing.
+
+**Quick links**
+
+[Change logs][changeLog] | [Project Repository][projectUri]
+
+## Installation
+
+Get library via [npm]
+
+```bash
+npm install @ssv/ngx.command
+```
+
+Choose the version corresponding to your Angular version:
+
+ | Angular | library |
+ | ------- | ------- |
+ | 10+     | 2.x+    |
+ | 4 to 9  | 1.x+    |
+
+
+# Usage
+
+## Register module
+
+```ts
+import { SsvCommandModule } from "@ssv/ngx.command";
+
+@NgModule({
+  imports: [
+    SsvCommandModule
+  ]
+}
+export class AppModule {
+}
+```
+
+## Command
+In order to start working with Command, you need to create a new instance of it.
+
+```ts
+import { CommandDirective, Command, CommandAsync, ICommand } from "@ssv/ngx.command";
+
+isValid$ = new BehaviorSubject(false);
+
+// use `CommandAsync` when execute function returns an observable/promise OR else 3rd argument must be true.
+saveCmd = new Command(() => this.save()), this.isValid$);
+
+// using CommandAsync
+saveCmd = new CommandAsync(() => Observable.timer(2000), this.isValid$);
+
+// using ICommand interface
+saveCmd: ICommand = new CommandAsync(() => Observable.timer(2000), this.isValid$);
+```
+
+## Command Attribute (Directive)
+Handles the command `canExecute$`, `isExecuting` and `execute` functions of the `Command`, in order to
+enable/disable, add/remove a cssClass while executing in order alter styling during execution (if desired)
+and execute when its enabled and clicked.
+
+Generally used on a `<button>` as below.
+
+### Usage
+
+```html
+<!-- simple usage -->
+<button [ssvCommand]="saveCmd">Save</button>
+
+<!-- using isExecuting + showing spinner -->
+<button [ssvCommand]="saveCmd">
+  <i *ngIf="saveCmd.isExecuting" class="ai-circled ai-indicator ai-dark-spin small"></i>
+  Save
+</button>
+```
+
+#### Usage with params
+This is useful for collections (loops) or using multiple actions with different args.
+*NOTE: This will share the `isExecuting` when used with multiple controls.*
+
+```html
+<!-- with single param -->
+<button [ssvCommand]="saveCmd" [ssvCommandParams]="{id: 1}">Save</button>
+<!-- 
+  NOTE: if you have only 1 argument as an array, it should be enclosed within an array e.g. [['apple', 'banana']], 
+  else it will spread and you will arg1: "apple", arg2: "banana"
+-->
+
+ <!-- with multi params -->
+<button [ssvCommand]="saveCmd" [ssvCommandParams]="[{id: 1}, 'hello', hero]">Save</button>
+```
+
+#### Usage with command creator
+This is useful for collections (loops) or using multiple actions with different args, whilst not sharing `isExecuting`.
+
+```html
+<button [ssvCommand]="{host: this, execute: removeHero$, canExecute: isValid$, params: [hero, 1337, 'xx']}">Remove</button>
+```
+
+##### canExecute with params
+```html
+<button [ssvCommand]="{host: this, execute: removeHero$, canExecute: canRemoveHero$, params: [hero, 1337, 'xx']}">Remove</button>
+```
+
+```ts
+canRemoveHero$(hero: Hero, id: number, param2): Observable<boolean> {
+  return of(id).pipe(
+    map(x => x === "invulnerable")
+  );
+}
+```
+
+## Usage without Attribute
+It can also be used as below without the command attribute.
+
+```html
+<button
+    [disabled]="!saveCmd.canExecute"
+    (click)="saveCmd.execute()">
+    Save
+</button>
+```
+
+## CommandRef Attribute (directive)
+Command creator ref, directive which allows creating Command in the template and associate it to a command (in order to share executions).
+
+```html
+<div *ngFor="let hero of heroes">
+  <div #actionCmd="ssvCommandRef" [ssvCommandRef]="{host: this, execute: removeHero$, canExecute: isValid$}" class="button-group">
+    <button [ssvCommand]="actionCmd.command" [ssvCommandParams]="hero">
+      Remove
+    </button>
+    <button [ssvCommand]="actionCmd.command" [ssvCommandParams]="hero">
+      Remove
+    </button>
+  </div>
+</div>
+```
+
+## Utils
+
+### canExecuteFromNgForm
+In order to use with `NgForm` easily, you can use the following utility method.
+This will make canExecute respond to `form.valid` and for `form.dirty` - also can optionally disable validity or dirty.
+
+```ts
+import { CommandAsync, canExecuteFromNgForm } from "@ssv/ngx.command";
+
+loginCmd = new CommandAsync(this.login.bind(this), canExecuteFromNgForm(this.form));
+
+// options - disable dirty check
+loginCmd = new CommandAsync(this.login.bind(this), canExecuteFromNgForm(this.form, {
+  dirty: false
+}));
+
+```
+
+
+## Configure
+In order to configure globally, you can do so as following:
+
+```ts
+import { SsvCommandModule } from "@ssv/ngx.command";
+
+    imports: [
+        SsvCommandModule.forRoot({ executingCssClass: "is-busy" })
+    ],
+```
+
+
+## Getting Started
+
+### Setup Machine for Development
+Install/setup the following:
+
+- NodeJS v18.16.0+
+- Visual Studio Code or similar code editor
+- TypeScript 5.0+
+- Git + SourceTree, SmartGit or similar (optional)
+- Ensure to install **global NPM modules** using the following:
+
+
+```bash
+npm install -g git gulp devtool
+```
+
+
+### Project Setup
+The following process need to be executed in order to get started.
+
+```bash
+npm install
+```
+
+
+### Building the code
+
+```bash
+npm run build
+```
+
+### Running the tests
+
+```bash
+npm test
+```
+
+#### Watch
+Handles compiling of changes.
+
+```bash
+npm start
+```
+
+
+#### Running Continuous Tests
+Spawns test runner and keep watching for changes.
+
+```bash
+npm run tdd
+```
+
+
+### Preparation for Release
+
+- Update changelogs
+- bump version
+
+
+Check out the [release workflow guide][releaseWorkflowWiki] in order to guide you creating a release and publishing it.

package/eslint.config.js

@@ -0,0 +1,43 @@
+const nx = require('@nx/eslint-plugin');
+const baseConfig = require('../../eslint.config.js');
+
+module.exports = [
+	...baseConfig,
+	{
+		files: ['**/*.json'],
+		rules: {
+			'@nx/dependency-checks': ['error', { ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs}'] }],
+		},
+		languageOptions: { parser: require('jsonc-eslint-parser') },
+	},
+	...nx.configs['flat/angular'],
+	...nx.configs['flat/angular-template'],
+	{
+		files: ['**/*.ts'],
+		rules: {
+			'@angular-eslint/directive-selector': [
+				'error',
+				{
+					type: 'attribute',
+					prefix: 'ssv',
+					style: 'camelCase',
+				},
+			],
+			'@angular-eslint/component-selector': [
+				'error',
+				{
+					type: 'element',
+					prefix: 'ssv',
+					style: 'kebab-case',
+				},
+			],
+			'@angular-eslint/directive-selector': 'off',
+			'@angular-eslint/no-input-rename': 'off',
+		},
+	},
+	{
+		files: ['**/*.html'],
+		// Override or add rules here
+		rules: {},
+	},
+];

package/jest.config.ts

@@ -0,0 +1,21 @@
+export default {
+  displayName: '@ssv/ngx.command',
+  preset: '../../jest.preset.js',
+  setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
+  coverageDirectory: '../../coverage/libs/ngx.command',
+  transform: {
+    '^.+\\.(ts|mjs|js|html)$': [
+      'jest-preset-angular',
+      {
+        tsconfig: '<rootDir>/tsconfig.spec.json',
+        stringifyContentPathRegex: '\\.(html|svg)$',
+      },
+    ],
+  },
+  transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
+  snapshotSerializers: [
+    'jest-preset-angular/build/serializers/no-ng-attributes',
+    'jest-preset-angular/build/serializers/ng-snapshot',
+    'jest-preset-angular/build/serializers/html-comment',
+  ],
+};

package/ng-package.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../dist/libs/ngx.command",
+  "lib": {
+    "entryFile": "src/index.ts"
+  }
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@ssv/ngx.command",
+  "version": "0.0.0-PLACEHOLDER",
+  "versionSuffix": "",
+  "description": "Command pattern implementation for angular. Command used to encapsulate information which is needed to perform an action.",
+  "keywords": [
+    "sketch7",
+    "ngx",
+    "angular17",
+    "angular",
+    "ssv",
+    "command",
+    "pattern",
+    "ui"
+  ],
+  "author": "Stephen Lautier <stephen.lautier@outlook.com>",
+  "license": "MIT",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sketch7/ngx.command.git"
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "@angular/core": ">=17.0.0",
+    "@angular/forms": ">=17.0.0",
+    "rxjs": ">=6.0.0"
+  },
+  "sideEffects": false
+}

package/project.json

@@ -0,0 +1,36 @@
+{
+  "name": "@ssv/ngx.command",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/ngx.command/src",
+  "prefix": "ssv",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/angular:package",
+      "outputs": ["{workspaceRoot}/dist/{projectRoot}"],
+      "options": {
+        "project": "libs/ngx.command/ng-package.json"
+      },
+      "configurations": {
+        "production": {
+          "tsConfig": "libs/ngx.command/tsconfig.lib.prod.json"
+        },
+        "development": {
+          "tsConfig": "libs/ngx.command/tsconfig.lib.json"
+        }
+      },
+      "defaultConfiguration": "production"
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/ngx.command/jest.config.ts"
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    }
+  }
+}

package/src/command-ref.directive.ts

@@ -0,0 +1,57 @@
+import { Observable } from "rxjs";
+import { Directive, OnInit, OnDestroy, Input } from "@angular/core";
+
+import { ICommand, CommandCreator } from "./command.model";
+import { isCommandCreator } from "./command.util";
+import { Command } from "./command";
+
+const NAME_CAMEL = "ssvCommandRef";
+
+/**
+ * Command creator ref, directive which allows creating Command in the template
+ * and associate it to a command (in order to share executions).
+ * @example
+ * ### Most common usage
+ * ```html
+ * <div #actionCmd="ssvCommandRef" [ssvCommandRef]="{host: this, execute: removeHero$, canExecute: isValid$}">
+ *    <button [ssvCommand]="actionCmd.command" [ssvCommandParams]="hero">
+ *      Remove
+ *    </button>
+ *    <button [ssvCommand]="actionCmd.command" [ssvCommandParams]="hero">
+ *       Remove
+ *    </button>
+ * </div>
+ * ```
+ *
+ */
+@Directive({
+	selector: `[${NAME_CAMEL}]`,
+	exportAs: NAME_CAMEL,
+	standalone: true,
+})
+export class CommandRefDirective implements OnInit, OnDestroy {
+
+	@Input(NAME_CAMEL) commandCreator: CommandCreator | undefined;
+
+	get command(): ICommand { return this._command; }
+	private _command!: ICommand;
+
+	ngOnInit(): void {
+		if (isCommandCreator(this.commandCreator)) {
+			const isAsync = this.commandCreator.isAsync || this.commandCreator.isAsync === undefined;
+
+			const execFn = this.commandCreator.execute.bind(this.commandCreator.host);
+			this._command = new Command(execFn, this.commandCreator.canExecute as Observable<boolean> | undefined, isAsync);
+		} else {
+			throw new Error(`${NAME_CAMEL}: [${NAME_CAMEL}] is not defined properly!`);
+		}
+	}
+
+	ngOnDestroy(): void {
+		// console.log("[commandRef::destroy]");
+		if (this._command) {
+			this._command.destroy();
+		}
+	}
+
+}

package/src/command.directive.ts

@@ -0,0 +1,191 @@
+import {
+	Directive,
+	OnInit,
+	OnDestroy,
+	Input,
+	HostListener,
+	ElementRef,
+	Renderer2,
+	ChangeDetectorRef,
+	inject,
+} from "@angular/core";
+import { Subject } from "rxjs";
+import { tap, delay, takeUntil } from "rxjs/operators";
+
+import { CommandOptions, COMMAND_OPTIONS } from "./command.options";
+import { Command } from "./command";
+import { isCommand, isCommandCreator } from "./command.util";
+import { CommandCreator, ICommand } from "./command.model";
+
+/**
+ * Controls the state of a component in sync with `Command`.
+ *
+ * @example
+ * ### Most common usage
+ * ```html
+ * <button [ssvCommand]="saveCmd">Save</button>
+ * ```
+ *
+ *
+ * ### Usage with options
+ * ```html
+ * <button [ssvCommand]="saveCmd" [ssvCommandOptions]="{executingCssClass: 'in-progress'}">Save</button>
+ * ```
+ *
+ *
+ * ### Usage with params
+ * This is useful for collections (loops) or using multiple actions with different args.
+ * *NOTE: This will share the `isExecuting` when used with multiple controls.*
+ *
+ * #### With single param
+ *
+ * ```html
+ * <button [ssvCommand]="saveCmd" [ssvCommandParams]="{id: 1}">Save</button>
+ * ```
+ * *NOTE: if you have only 1 argument as an array, it should be enclosed within an array e.g. `[['apple', 'banana']]`,
+ * else it will spread and you will `arg1: "apple", arg2: "banana"`*
+ *
+ * #### With multi params
+ * ```html
+ * <button [ssvCommand]="saveCmd" [ssvCommandParams]="[{id: 1}, 'hello', hero]">Save</button>
+ * ```
+ *
+ * ### Usage with Command Creator
+ * This is useful for collections (loops) or using multiple actions with different args, whilst not sharing `isExecuting`.
+ *
+ *
+ * ```html
+ * <button [ssvCommand]="{host: this, execute: removeHero$, canExecute: isValid$, params: [hero, 1337, 'xx']}">Save</button>
+ * ```
+ *
+ */
+
+const NAME_CAMEL = "ssvCommand";
+
+// let nextUniqueId = 0;
+
+@Directive({
+	selector: `[${NAME_CAMEL}]`,
+	exportAs: NAME_CAMEL,
+	standalone: true,
+})
+export class CommandDirective implements OnInit, OnDestroy {
+
+	// readonly id = `${NAME_CAMEL}-${nextUniqueId++}`;
+	private readonly globalOptions = inject(COMMAND_OPTIONS);
+	private readonly renderer = inject(Renderer2);
+	private readonly element = inject(ElementRef);
+	private readonly cdr = inject(ChangeDetectorRef);
+
+	@Input(NAME_CAMEL) commandOrCreator: ICommand | CommandCreator | undefined;
+
+	@Input(`${NAME_CAMEL}Options`)
+	get commandOptions(): CommandOptions { return this._commandOptions; }
+	set commandOptions(value: Partial<CommandOptions>) {
+		if (value === this._commandOptions) {
+			return;
+		}
+		this._commandOptions = {
+			...this.globalOptions,
+			...value,
+		};
+	}
+
+	@Input(`${NAME_CAMEL}Params`) commandParams: unknown | unknown[];
+
+	get command(): ICommand { return this._command; }
+
+	private _command!: ICommand;
+	private _commandOptions: CommandOptions = this.globalOptions;
+	private _destroy$ = new Subject<void>();
+
+	ngOnInit(): void {
+		// console.log("[ssvCommand::init]", this.config);
+		if (!this.commandOrCreator) {
+			throw new Error(`${NAME_CAMEL}: [${NAME_CAMEL}] should be defined!`);
+		} else if (isCommand(this.commandOrCreator)) {
+			this._command = this.commandOrCreator;
+		} else if (isCommandCreator(this.commandOrCreator)) {
+			const isAsync = this.commandOrCreator.isAsync || this.commandOrCreator.isAsync === undefined;
+
+			// todo: find something like this for ivy (or angular10+)
+			// const hostComponent = (this.viewContainer as any)._view.component;
+
+			const execFn = this.commandOrCreator.execute.bind(this.commandOrCreator.host);
+			this.commandParams = this.commandParams || this.commandOrCreator.params;
+
+			const canExec = this.commandOrCreator.canExecute instanceof Function
+				? this.commandOrCreator.canExecute.bind(this.commandOrCreator.host, this.commandParams)()
+				: this.commandOrCreator.canExecute;
+
+			// console.log("[ssvCommand::init] command creator", {
+			// 	firstParam: this.commandParams ? this.commandParams[0] : null,
+			// 	params: this.commandParams
+			// });
+			this._command = new Command(execFn, canExec, isAsync);
+		} else {
+			throw new Error(`${NAME_CAMEL}: [${NAME_CAMEL}] is not defined properly!`);
+		}
+
+		this._command.subscribe();
+		this._command.canExecute$.pipe(
+			this.commandOptions.hasDisabledDelay
+				? delay(1)
+				: tap(() => { /* stub */ }),
+			tap(x => {
+				this.trySetDisabled(!x);
+				// console.log("[ssvCommand::canExecute$]", { canExecute: x });
+				this.cdr.markForCheck();
+			}),
+			takeUntil(this._destroy$),
+		).subscribe();
+
+		if (this._command.isExecuting$) {
+			this._command.isExecuting$.pipe(
+				tap(x => {
+					// console.log("[ssvCommand::isExecuting$]", x, this.commandOptions);
+					if (x) {
+						this.renderer.addClass(
+							this.element.nativeElement,
+							this.commandOptions.executingCssClass
+						);
+					} else {
+						this.renderer.removeClass(
+							this.element.nativeElement,
+							this.commandOptions.executingCssClass
+						);
+					}
+				}),
+				takeUntil(this._destroy$),
+			).subscribe();
+		}
+	}
+
+	@HostListener("click")
+	onClick(): void {
+		// console.log("[ssvCommand::onClick]", this.commandParams);
+		if (Array.isArray(this.commandParams)) {
+			this._command.execute(...this.commandParams);
+		} else {
+			this._command.execute(this.commandParams);
+		}
+	}
+
+	ngOnDestroy(): void {
+		// console.log("[ssvCommand::destroy]");
+		this._destroy$.next();
+		this._destroy$.complete();
+		if (this._command) {
+			this._command.unsubscribe();
+		}
+	}
+
+	private trySetDisabled(disabled: boolean) {
+		if (this.commandOptions.handleDisabled) {
+			// console.warn(">>>> disabled", { id: this.id, disabled });
+			this.renderer.setProperty(this.element.nativeElement, "disabled", disabled);
+		}
+	}
+
+}
+