ngx-promise-buttons 1.0.0 → 1.0.1

package/.editorconfig

@@ -0,0 +1,13 @@
+# Editor configuration, see http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

package/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [meysamsahragard] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.travis.yml

@@ -0,0 +1,21 @@
+language: node_js
+node_js:
+  - "12"
+
+cache:
+  yarn: true
+
+
+script:
+  - yarn
+  - yarn test-coverage
+
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    # required by node-gyp to build some packages
+    packages:
+      - g++-4.8
+
+after_success: 'npm run coveralls'

package/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# How to contribute to this repository
+Create a fork of this repository and check it out. 
+
+To make everything work you need to symlink the src directory to the app folder once. You can do this manually or by running `npm run link-mod`. 
+
+Once this is done you can run `npm start` to start the development server.
+
+If you implement a new feature it is always a good idea to also add an example of it to the demo application.
+
+## Commit guidelines
+In general this repo tries to adhere to the [angular commit guidelines](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit).
+
+## Dev tasks
+There are several scripts defined in the package.json
+
+`npm start`: Starts the development server.
+
+`npm run` **test-watch**: Runs the unit tests via karma.
+
+`npm run` **test**: Runs the unit tests once.
+
+`npm run` **test-coverage**: Runs the unit tests with a coverage report.
+
+`npm run` **build**: Creates a compiled version of your library inside the dist folder.
+
+`npm run` **demo.deploy**: 
+Builds the demo app to demo/dist, copies the readme to it and publishes everything to github pages.
+ 
+`npm run` **release.changelog**:
+Creates a changelog based on the [angular commit conventions](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md).  
+ 
+`npm run` **link-mod**: Creates a symlink to the module inside the demo/src folder. This is required for compiling the app with aot.
+ 
+`npm run` **lint**: Lints all demo and library files
+ 
+`npm run` **e2e**: Runs the end2end tests.

package/README.md

@@ -27,17 +27,13 @@ Install it via npm:
 npm install ngx-promise-buttons -S
 ```
 
-And add it as a dependency to your main module
+Add it to your app using bootstrapApplication:
 ```typescript
-import {NgxPromiseButtonModule} from 'ngx-promise-buttons';
-
-@NgModule({
-  imports: [
-    NgxPromiseButtonModule.forRoot(),
+bootstrapApplication(AppComponent, {
+  providers: [
+    provideNgxPromiseButtons({ handleCurrentBtnOnly: true }),
   ],
-})
-export class MainAppModule {
-}
+});
 ```
 Using the buttons is easy. Just pass a promise to the directive:
 ```html
@@ -68,28 +64,14 @@ There are selectors you can use to style. There is the `.is-loading` class on th
 
 
 ## Configuration
-Configuration is done via the forRoot method of the promise button module:
+You can pass a config object to provideNgxPromiseButtons:
 ```typescript
-import {NgxPromiseButtonModule} from 'ngx-promise-buttons';
-
-@NgModule({
-  imports: [
-    NgxPromiseButtonModule
-      .forRoot({
-        // your custom config goes here
-        spinnerTpl: '<span class="btn-spinner"></span>',
-        // disable buttons when promise is pending
-        disableBtn: true,
-        // the class used to indicate a pending promise
-        btnLoadingClass: 'is-loading',
-        // only disable and show is-loading class for clicked button, 
-        // even when they share the same promise
-        handleCurrentBtnOnly: false,
-      }),
-  ],
-})
-export class MainAppModule {
-}
+provideNgxPromiseButtons({
+  spinnerTpl: '<span class="btn-spinner"></span>',
+  disableBtn: true,
+  btnLoadingClass: 'is-loading',
+  handleCurrentBtnOnly: false,
+});
 ```
 
 ## Using observables

package/angular.json

@@ -0,0 +1,180 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "ngx-promise-buttons-demo": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "style": "scss"
+        }
+      },
+      "root": "projects/ngx-promise-buttons-demo",
+      "sourceRoot": "projects/ngx-promise-buttons-demo/src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:application",
+          "options": {
+            "outputPath": {
+              "base": "../../dist/demo"
+            },
+            "index": "projects/ngx-promise-buttons-demo/src/index.html",
+            "polyfills": [
+              "projects/ngx-promise-buttons-demo/src/polyfills.ts"
+            ],
+            "tsConfig": "projects/ngx-promise-buttons-demo/tsconfig.app.json",
+            "assets": [
+              "projects/ngx-promise-buttons-demo/src/favicon.ico",
+              "projects/ngx-promise-buttons-demo/src/assets"
+            ],
+            "styles": [
+              "projects/ngx-promise-buttons-demo/src/styles.scss"
+            ],
+            "scripts": [],
+            "extractLicenses": false,
+            "sourceMap": true,
+            "optimization": false,
+            "namedChunks": true,
+            "browser": "projects/ngx-promise-buttons-demo/src/main.ts"
+          },
+          "configurations": {
+            "production": {
+              "fileReplacements": [
+                {
+                  "replace": "projects/ngx-promise-buttons-demo/src/environments/environment.ts",
+                  "with": "projects/ngx-promise-buttons-demo/src/environments/environment.prod.ts"
+                }
+              ],
+              "optimization": true,
+              "outputHashing": "all",
+              "sourceMap": false,
+              "namedChunks": false,
+              "extractLicenses": true,
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "2mb",
+                  "maximumError": "5mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "6kb"
+                }
+              ]
+            }
+          },
+          "defaultConfiguration": ""
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "buildTarget": "ngx-promise-buttons-demo:build"
+          },
+          "configurations": {
+            "production": {
+              "buildTarget": "ngx-promise-buttons-demo:build:production"
+            }
+          }
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "buildTarget": "ngx-promise-buttons-demo:build"
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "projects/ngx-promise-buttons-demo/tsconfig.app.json",
+              "projects/ngx-promise-buttons-demo/e2e/tsconfig.json"
+            ],
+            "exclude": [
+              "**/node_modules/**"
+            ]
+          }
+        },
+        "e2e": {
+          "builder": "@angular-devkit/build-angular:protractor",
+          "options": {
+            "protractorConfig": "projects/ngx-promise-buttons-demo/e2e/protractor.conf.js",
+            "devServerTarget": "ngx-promise-buttons-demo:serve"
+          },
+          "configurations": {
+            "production": {
+              "devServerTarget": "ngx-promise-buttons-demo:serve:production"
+            }
+          }
+        }
+      }
+    },
+    "ngx-promise-buttons": {
+      "projectType": "library",
+      "root": "projects/ngx-promise-buttons",
+      "sourceRoot": "projects/ngx-promise-buttons/src",
+      "prefix": "lib",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:ng-packagr",
+          "options": {
+            "tsConfig": "projects/ngx-promise-buttons/tsconfig.lib.json",
+            "project": "projects/ngx-promise-buttons/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/ngx-promise-buttons/tsconfig.lib.prod.json"
+            }
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "projects/ngx-promise-buttons/src/test.ts",
+            "tsConfig": "projects/ngx-promise-buttons/tsconfig.spec.json",
+            "karmaConfig": "projects/ngx-promise-buttons/karma.conf.js"
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "projects/ngx-promise-buttons/tsconfig.lib.json",
+              "projects/ngx-promise-buttons/tsconfig.spec.json"
+            ],
+            "exclude": [
+              "**/node_modules/**"
+            ]
+          }
+        }
+      }
+    }
+  },
+  "schematics": {
+    "@schematics/angular:component": {
+      "type": "component"
+    },
+    "@schematics/angular:directive": {
+      "type": "directive"
+    },
+    "@schematics/angular:service": {
+      "type": "service"
+    },
+    "@schematics/angular:guard": {
+      "typeSeparator": "."
+    },
+    "@schematics/angular:interceptor": {
+      "typeSeparator": "."
+    },
+    "@schematics/angular:module": {
+      "typeSeparator": "."
+    },
+    "@schematics/angular:pipe": {
+      "typeSeparator": "."
+    },
+    "@schematics/angular:resolver": {
+      "typeSeparator": "."
+    }
+  }
+}

package/e2e/protractor.conf.js

@@ -0,0 +1,32 @@
+// @ts-check
+// Protractor configuration file, see link for more information
+// https://github.com/angular/protractor/blob/master/lib/config.ts
+
+const { SpecReporter } = require('jasmine-spec-reporter');
+
+/**
+ * @type { import("protractor").Config }
+ */
+exports.config = {
+  allScriptsTimeout: 11000,
+  specs: [
+    './src/**/*.e2e-spec.ts'
+  ],
+  capabilities: {
+    'browserName': 'chrome'
+  },
+  directConnect: true,
+  baseUrl: 'http://localhost:4200/',
+  framework: 'jasmine',
+  jasmineNodeOpts: {
+    showColors: true,
+    defaultTimeoutInterval: 30000,
+    print: function() {}
+  },
+  onPrepare() {
+    require('ts-node').register({
+      project: require('path').join(__dirname, './tsconfig.json')
+    });
+    jasmine.getEnv().addReporter(new SpecReporter({ spec: { displayStacktrace: true } }));
+  }
+};

package/e2e/src/app.e2e-spec.ts

@@ -0,0 +1,23 @@
+import { AppPage } from './app.po';
+import { browser, logging } from 'protractor';
+
+describe('workspace-project App', () => {
+  let page: AppPage;
+
+  beforeEach(() => {
+    page = new AppPage();
+  });
+
+  it('should display welcome message', () => {
+    page.navigateTo();
+    expect(page.getTitleText()).toEqual('Welcome to angular-material-css-vars!');
+  });
+
+  afterEach(async () => {
+    // Assert that there are no errors emitted from the browser
+    const logs = await browser.manage().logs().get(logging.Type.BROWSER);
+    expect(logs).not.toContain(jasmine.objectContaining({
+      level: logging.Level.SEVERE,
+    } as logging.Entry));
+  });
+});

package/e2e/src/app.po.ts

@@ -0,0 +1,11 @@
+import { browser, by, element } from 'protractor';
+
+export class AppPage {
+  navigateTo() {
+    return browser.get(browser.baseUrl) as Promise<any>;
+  }
+
+  getTitleText() {
+    return element(by.css('app-root h1')).getText() as Promise<string>;
+  }
+}

package/e2e/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../out-tsc/e2e",
+    "module": "commonjs",
+    "target": "es2018",
+    "types": [
+      "jasmine",
+      "jasminewd2",
+      "node"
+    ]
+  }
+}

package/package.json

@@ -1,38 +1,87 @@
-{
-  "name": "ngx-promise-buttons",
-  "version": "1.0.0",
-  "description": "Chilled loading buttons for angular",
-  "author": "meysamsahragard <contact@super-productivity.com> (http://super-productivity.com)",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/meysamsahragard/ngx-promise-buttons.git"
-  },
-  "keywords": [
-    "angular",
-    "javascript",
-    "typescript",
-    "button",
-    "promise",
-    "spinner"
-  ],
-  "dependencies": {
-    "tslib": "^2.0.0"
-  },
-  "peerDependencies": {
-    "@angular/common": ">=9.0.4",
-    "@angular/core": ">=9.0.4"
-  },
-  "module": "fesm2022/ngx-promise-buttons.mjs",
-  "typings": "types/ngx-promise-buttons.d.ts",
-  "exports": {
-    "./package.json": {
-      "default": "./package.json"
-    },
-    ".": {
-      "types": "./types/ngx-promise-buttons.d.ts",
-      "default": "./fesm2022/ngx-promise-buttons.mjs"
-    }
-  },
-  "sideEffects": false
-}
+{
+  "name": "ngx-promise-buttons",
+  "version": "1.0.1",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/meysamsahragard/ngx-promise-buttons.git"
+  },
+  "scripts": {
+    "ng": "ng",
+    "start": "ng serve",
+    "build": "ng build",
+    "test": "ng test --browsers ChromeHeadless --watch=false",
+    "lint": "ng lint",
+    "e2e": "ng e2e",
+    "demo": "run-s demo.build demo.copy-readme demo.gh-pages",
+    "demo.build": "ng build --aot --configuration production --base-href='./'",
+    "demo.copy-readme": "node scripts/copy-readme-to-demo.js",
+    "demo.gh-pages": "gh-pages -d dist/demo",
+    "lib": "run-s lib.build copy",
+    "lib.build": "ng build --configuration production ngx-promise-buttons",
+    "copy": "run-s copy.licence copy.readme",
+    "copy.licence": "copyfiles ./LICENSE ./dist/ngx-promise-buttons",
+    "copy.readme": "copyfiles ./README.md ./dist/ngx-promise-buttons",
+    "pub": "run-s lib && cd ./dist/ngx-promise-buttons/ && npm publish && cd .. && cd ..",
+    "patch": "npm version patch && cd ./projects/ngx-promise-buttons && npm version patch && cd .. && cd .. && git add . && git commit -am\"chore: update lib version\"",
+    "patch-release_": "run-s lib demo patch pub",
+    "patch-release": "npm run patch-release_",
+    "major": "npm version major && cd ./projects/ngx-promise-buttons && npm version major && cd .. && cd .. && git add . && git commit -am\"chore: update lib version\"",
+    "major-release_": "run-s lib demo major pub",
+    "major-release": "npm run major-release_",
+    "test-coverage": "ng test --browsers ChromeHeadless --code-coverage --watch=false",
+    "coveralls": "YOURPACKAGE_COVERAGE=1 cat ./coverage/lcov.info | ./node_modules/.bin/coveralls"
+  },
+  "devDependencies": {
+    "@angular-devkit/build-angular": "^21.0.4",
+    "@angular/cli": "^21.0.4",
+    "@angular/common": "^21.0.6",
+    "@angular/compiler": "^21.0.6",
+    "@angular/compiler-cli": "^21.0.6",
+    "@angular/core": "^21.0.6",
+    "@angular/forms": "^21.0.6",
+    "@angular/platform-browser": "^21.0.6",
+    "@angular/platform-browser-dynamic": "^21.0.6",
+    "@angular/router": "^21.0.6",
+    "@types/bluebird": "^3.5.29",
+    "@types/core-js": "^2.5.2",
+    "@types/jasmine": "~3.6.0",
+    "@types/jquery": "^3.3.32",
+    "@types/node": "^13.7.0",
+    "angular2-template-loader": "^0.6.2",
+    "bluebird": "^3.7.2",
+    "bootstrap": "^4.4.1",
+    "bootstrap-material-design": "^4.1.2",
+    "codelyzer": "^6.0.0",
+    "conventional-changelog-cli": "^2.0.31",
+    "conventional-github-releaser": "^3.1.3",
+    "copyfiles": "^2.2.0",
+    "core-js": "^3.6.4",
+    "coveralls": "^3.0.9",
+    "gh-pages": "^2.2.0",
+    "intl": "^1.2.5",
+    "jasmine-core": "~3.10",
+    "jasmine-spec-reporter": "~5.0.0",
+    "jquery": "^3.5.0",
+    "karma": "~6.3.16",
+    "karma-chrome-launcher": "~3.1.0",
+    "karma-cli": "~2.0.0",
+    "karma-coverage-istanbul-reporter": "~3.0.2",
+    "karma-jasmine": "~4.0.0",
+    "karma-jasmine-html-reporter": "^1.5.0",
+    "karma-phantomjs-launcher": "^1.0.4",
+    "marked": "^2.0.0",
+    "ng-packagr": "^21.0.1",
+    "npm-run-all": "^4.1.5",
+    "protractor": "~7.0.0",
+    "reflect-metadata": "^0.1.13",
+    "rxjs": "^6.5.4",
+    "ts-node": "~8.6.2",
+    "tslib": "^2.0.0",
+    "tslint": "~6.1.0",
+    "typescript": "~5.9.3",
+    "wallaby-webpack": "3.9.15",
+    "web-animations-js": "^2.3.2",
+    "zone.js": "~0.15.1"
+  }
+}

package/projects/ngx-promise-buttons/karma.conf.js

@@ -0,0 +1,32 @@
+// Karma configuration file, see link for more information
+// https://karma-runner.github.io/1.0/config/configuration-file.html
+
+module.exports = function (config) {
+  config.set({
+    basePath: '',
+    frameworks: ['jasmine', '@angular-devkit/build-angular'],
+    plugins: [
+      require('karma-jasmine'),
+      require('karma-chrome-launcher'),
+      require('karma-jasmine-html-reporter'),
+      require('karma-coverage-istanbul-reporter'),
+      require('@angular-devkit/build-angular/plugins/karma')
+    ],
+    client: {
+      clearContext: false // leave Jasmine Spec Runner output visible in browser
+    },
+    coverageIstanbulReporter: {
+      dir: require('path').join(__dirname, '../../coverage/ngx-promise-buttons'),
+      reports: ['html', 'lcovonly', 'text-summary'],
+      fixWebpackSourcePaths: true
+    },
+    reporters: ['progress', 'kjhtml'],
+    port: 9876,
+    colors: true,
+    logLevel: config.LOG_INFO,
+    autoWatch: true,
+    browsers: ['Chrome'],
+    singleRun: false,
+    restartOnFileChange: true
+  });
+};

package/projects/ngx-promise-buttons/ng-package.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
+  "dest": "../../dist/ngx-promise-buttons",
+  "lib": {
+    "entryFile": "src/index.ts"
+  },
+  "assets": [
+    "./**/*.scss"
+  ]
+}

package/projects/ngx-promise-buttons/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "ngx-promise-buttons",
+  "version": "1.0.1",
+  "description": "Chilled loading buttons for angular",
+  "author": "meysamsahragard <contact@super-productivity.com> (http://super-productivity.com)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/meysamsahragard/ngx-promise-buttons.git"
+  },
+  "keywords": [
+    "angular",
+    "javascript",
+    "typescript",
+    "button",
+    "promise",
+    "spinner"
+  ],
+  "dependencies": {
+    "tslib": "^2.0.0"
+  },
+  "peerDependencies": {
+    "@angular/common": ">=9.0.4",
+    "@angular/core": ">=9.0.4"
+  }
+}

package/projects/ngx-promise-buttons/src/default-promise-btn-config.ts

@@ -0,0 +1,10 @@
+import {PromiseBtnConfig} from './promise-btn-config';
+
+export const DEFAULT_CFG: PromiseBtnConfig = {
+  spinnerTpl: '<span class="btn-spinner"></span>',
+  disableBtn: true,
+  btnLoadingClass: 'is-loading',
+  handleCurrentBtnOnly: false,
+  minDuration: null,
+};
+

package/projects/ngx-promise-buttons/src/index.ts

@@ -0,0 +1,2 @@
+export {PromiseBtnDirective} from './promise-btn.directive';
+export * from'./provider';

package/projects/ngx-promise-buttons/src/promise-btn-config.ts

@@ -0,0 +1,7 @@
+export interface PromiseBtnConfig {
+  spinnerTpl?: string;
+  disableBtn?: boolean;
+  btnLoadingClass?: boolean | string;
+  handleCurrentBtnOnly?: boolean;
+  minDuration?: number | null;
+}