npm - ngx-print - Versions diffs - 20.1.0-beta.4 → 20.1.0-beta.5 - Mend

ngx-print 20.1.0-beta.4 → 20.1.0-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (32) hide show

package/fesm2022/ngx-print.mjs +533 -0
package/fesm2022/ngx-print.mjs.map +1 -0
package/index.d.ts +241 -0
package/index.d.ts.map +1 -0
package/package.json +43 -68
package/.editorconfig +0 -13
package/.eslintrc.json +0 -50
package/.github/ISSUE_TEMPLATE/bug_report.md +0 -31
package/.github/ISSUE_TEMPLATE/feature_request.md +0 -20
package/.github/dependabot.yml +0 -17
package/.github/workflows/PullRequest.yml +0 -32
package/.github/workflows/stale.yml +0 -26
package/.prettierignore +0 -42
package/.prettierrc.json +0 -14
package/CHANGELOG.md +0 -17
package/_config.yml +0 -1
package/angular.json +0 -64
package/karma.conf.js +0 -43
package/ng-package.json +0 -7
package/src/lib/ngx-print.base.ts +0 -320
package/src/lib/ngx-print.directive.spec.ts +0 -139
package/src/lib/ngx-print.directive.ts +0 -113
package/src/lib/ngx-print.module.ts +0 -8
package/src/lib/ngx-print.service.spec.ts +0 -201
package/src/lib/ngx-print.service.ts +0 -51
package/src/lib/print-helper.ts +0 -24
package/src/lib/print-options.ts +0 -16
package/src/public_api.ts +0 -18
package/tsconfig.json +0 -35
package/tsconfig.lib.json +0 -14
package/tsconfig.spec.json +0 -17
package/tslint.json +0 -17

package/index.d.ts ADDED Viewed

@@ -0,0 +1,241 @@
+import * as i0 from '@angular/core';
+import * as rxjs from 'rxjs';
+import { Subject } from 'rxjs';
+declare class PrintOptions {
+    printSectionId: string;
+    printTitle: string;
+    useExistingCss: boolean;
+    bodyClass: string;
+    openNewTab: boolean;
+    previewOnly: boolean;
+    closeWindow: boolean;
+    printDelay: number;
+    constructor(options?: Partial<PrintOptions>);
+}
+declare class PrintBase {
+    private nonce;
+    private _printStyle;
+    private _styleSheetFile;
+    protected printComplete: Subject<void>;
+    /**
+     * Sets the print styles based on the provided values.
+     *
+     * @param {Object} values - Key-value pairs representing print styles.
+     * @protected
+     */
+    protected setPrintStyle(values: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    }): void;
+    /**
+     *
+     *
+     * @returns the string that create the stylesheet which will be injected
+     * later within <style></style> tag.
+     *
+     * -join/replace to transform an array objects to css-styled string
+     */
+    returnStyleValues(): string;
+    /**
+     * @returns string which contains the link tags containing the css which will
+     * be injected later within <head></head> tag.
+     *
+     */
+    private returnStyleSheetLinkTags;
+    /**
+     * Sets the style sheet file based on the provided CSS list.
+     *
+     * @param {string} cssList - CSS file or list of CSS files.
+     * @protected
+     */
+    protected setStyleSheetFile(cssList: string): void;
+    /**
+     * Updates the default values for input elements.
+     *
+     * @param {HTMLCollectionOf<HTMLInputElement>} elements - Collection of input elements.
+     * @private
+     */
+    private updateInputDefaults;
+    /**
+     * Updates the default values for select elements.
+     *
+     * @param {HTMLCollectionOf<HTMLSelectElement>} elements - Collection of select elements.
+     * @private
+     */
+    private updateSelectDefaults;
+    /**
+     * Updates the default values for textarea elements.
+     *
+     * @param {HTMLCollectionOf<HTMLTextAreaElement>} elements - Collection of textarea elements.
+     * @private
+     */
+    private updateTextAreaDefaults;
+    /**
+     * Converts a canvas element to an image and returns its HTML string.
+     *
+     * @param {HTMLCanvasElement} element - The canvas element to convert.
+     * @returns {string} - HTML string of the image.
+     * @private
+     */
+    private canvasToImageHtml;
+    /**
+     * Includes canvas contents in the print section via img tags.
+     *
+     * @param {HTMLCollectionOf<HTMLCanvasElement>} elements - Collection of canvas elements.
+     * @private
+     */
+    private updateCanvasToImage;
+    /**
+     * Retrieves the HTML content of a specified printing section.
+     *
+     * @param {string} printSectionId - Id of the printing section.
+     * @returns {string | null} - HTML content of the printing section, or null if not found.
+     * @private
+     */
+    private getHtmlContents;
+    /**
+     * Retrieves the HTML content of elements with the specified tag.
+     *
+     * @param {keyof HTMLElementTagNameMap} tag - HTML tag name.
+     * @returns {string} - Concatenated outerHTML of elements with the specified tag.
+     * @private
+     */
+    private getElementTag;
+    protected notifyPrintComplete(): void;
+    /**
+     * Prints the specified content using the provided print options.
+     *
+     * @param {PrintOptions} printOptions - Options for printing.
+     * @public
+     */
+    protected print(printOptions: PrintOptions): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PrintBase, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PrintBase>;
+}
+declare class NgxPrintDirective extends PrintBase {
+    private printOptions;
+    /**
+     * Prevents the print dialog from opening on the window
+     *
+     * @memberof NgxPrintDirective
+     */
+    set previewOnly(value: boolean);
+    /**
+     *
+     *
+     * @memberof NgxPrintDirective
+     */
+    set printSectionId(value: string);
+    /**
+     *
+     *
+     * @memberof NgxPrintDirective
+     */
+    set printTitle(value: string);
+    /**
+     *
+     *
+     * @memberof NgxPrintDirective
+     */
+    set useExistingCss(value: boolean);
+    /**
+     * A delay in milliseconds to force the print dialog to wait before opened. Default: 0
+     *
+     * @memberof NgxPrintDirective
+     */
+    set printDelay(value: number);
+    /**
+     * Whether to close the window after print() returns.
+     *
+     */
+    set closeWindow(value: boolean);
+    /**
+     * Class attribute to apply to the body element.
+     *
+     */
+    set bodyClass(value: string);
+    /**
+     * Whether to open a new window or default to new window.
+     *
+     */
+    set openNewTab(value: boolean);
+    /**
+     *
+     *
+     * @memberof NgxPrintDirective
+     */
+    set printStyle(values: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    });
+    /**
+     * @memberof NgxPrintDirective
+     * @param cssList
+     */
+    set styleSheetFile(cssList: string);
+    /**
+     *
+     *
+     * @memberof NgxPrintDirective
+     */
+    print(): void;
+    readonly printCompleted: i0.OutputEmitterRef<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxPrintDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<NgxPrintDirective, "[ngxPrint]", never, { "previewOnly": { "alias": "previewOnly"; "required": false; }; "printSectionId": { "alias": "printSectionId"; "required": false; }; "printTitle": { "alias": "printTitle"; "required": false; }; "useExistingCss": { "alias": "useExistingCss"; "required": false; }; "printDelay": { "alias": "printDelay"; "required": false; }; "closeWindow": { "alias": "closeWindow"; "required": false; }; "bodyClass": { "alias": "bodyClass"; "required": false; }; "openNewTab": { "alias": "openNewTab"; "required": false; }; "printStyle": { "alias": "printStyle"; "required": false; }; "styleSheetFile": { "alias": "styleSheetFile"; "required": false; }; }, { "printCompleted": "printCompleted"; }, never, never, true, never>;
+}
+declare class NgxPrintModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxPrintModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxPrintModule, never, [typeof NgxPrintDirective], [typeof NgxPrintDirective]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgxPrintModule>;
+}
+/**
+ * Service for handling printing functionality in Angular applications.
+ * Extends the base printing class (PrintBase).
+ *
+ * @export
+ * @class NgxPrintService
+ * @extends {PrintBase}
+ */
+declare class NgxPrintService extends PrintBase {
+    printComplete$: rxjs.Observable<void>;
+    /**
+     * Initiates the printing process using the provided print options.
+     *
+     * @param {PrintOptions} printOptions - Options for configuring the printing process.
+     * @memberof NgxPrintService
+     * @returns {void}
+     */
+    print(printOptions: PrintOptions): void;
+    /**
+     * Sets the print style for the printing process.
+     *
+     * @param {{ [key: string]: { [key: string]: string } }} values - A dictionary representing the print styles.
+     * @memberof NgxPrintService
+     * @setter
+     */
+    set printStyle(values: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    });
+    /**
+     * Sets the stylesheet file for the printing process.
+     *
+     * @param {string} cssList - A string representing the path to the stylesheet file.
+     * @memberof NgxPrintService
+     * @setter
+     */
+    set styleSheetFile(cssList: string);
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxPrintService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgxPrintService>;
+}
+export { NgxPrintDirective, NgxPrintModule, NgxPrintService, PrintOptions };
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"index.d.ts","sources":["../../src/lib/print-options.ts","../../src/lib/ngx-print.base.ts","../../src/lib/ngx-print.directive.ts","../../src/lib/ngx-print.module.ts","../../src/lib/ngx-print.service.ts"],"sourcesContent":[null,null,null,null,null],"names":["_angular_core"],"mappings":";;;;AAAA,cAAA,YAAA;;;;;;;;;AAUc,0BAAA,OAAA,CAAA,YAAA;AAKb;;ACXD,cAAA,SAAA;;;;;AAWE;;;;;AAKG;AACH;;AAAmD;;AAAyB;AAS5E;;;;;;;AAOG;;AAMH;;;;AAIG;AACH;AAIA;;;;;AAKG;AACH;AAiBA;;;;;AAKG;AACH;AAQA;;;;;AAKG;AACH;AAUA;;;;;AAKG;AACH;AAOA;;;;;;AAMG;AACH;AAKA;;;;;AAKG;AACH;AAQA;;;;;;AAMG;AACH;AAiBA;;;;;;AAMG;AACH;AAUA;AAIA;;;;;AAKG;AACH,kCAAA,YAAA;;;AA4HD;;AC3TD,cAAA,iBAAA,SAAA,SAAA;;AAME;;;;AAIG;AACH;AAIA;;;;AAIG;AACH;AAIA;;;;AAIG;AACH;AAIA;;;;AAIG;AACH;AAIA;;;;AAIG;AACH;AAIA;;;AAGG;AACH;AAIA;;;AAGG;AACH;AAIA;;;AAGG;AACH;AAIA;;;;AAIG;;;AAEuC;;;AAI1C;;;AAGG;AACH;AAKA;;;;AAIG;AAEI;6BAOgBA,EAAA,CAAA,gBAAA;;;AACxB;;AC7GD,cAAA,cAAA;;;;AAI8B;;ACH9B;;;;;;;AAOG;AACH,cAAA,eAAA,SAAA,SAAA;AAIE,oBAAc,IAAA,CAAA,UAAA;AACd;;;;;;AAMG;AACI,wBAAA,YAAA;AAKP;;;;;;AAMG;;;AACuC;;;AAI1C;;;;;;AAMG;AACH;;;AAGD;;;;"}

package/package.json CHANGED Viewed

@@ -1,68 +1,43 @@
-{
-  "name": "ngx-print",
-  "version": "20.1.0-beta.4",
-  "description": "Plug n' Play Angular (2++) directive to print your stuff",
-  "author": "https://github.com/selemxmn/ngx-print/graphs/contributors",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/selemxmn/ngx-print.git"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/selemxmn/ngx-print/issues"
-  },
-  "homepage": "https://github.com/selemxmn/ngx-print#readme",
-  "keywords": [
-    "print",
-    "angular",
-    "library",
-    "ng-print",
-    "ngx-print",
-    "directive",
-    "dependency",
-    "angular-print"
-  ],
-  "scripts": {
-    "ng": "ng",
-    "build": "ng build",
-    "test": "ng test --no-watch --code-coverage --no-progress --browsers=ChromeHeadlessCI",
-    "lint": "ng lint"
-  },
-  "devDependencies": {
-    "@angular-devkit/build-angular": "^20.1.0",
-    "@angular-eslint/builder": "20.2.0",
-    "@angular-eslint/eslint-plugin": "20.2.0",
-    "@angular-eslint/eslint-plugin-template": "20.2.0",
-    "@angular-eslint/schematics": "20.2.0",
-    "@angular-eslint/template-parser": "20.2.0",
-    "@angular/build": "^20.1.0",
-    "@angular/cli": "^20.1.0",
-    "@angular/common": "^20.1.0",
-    "@angular/compiler": "^20.1.0",
-    "@angular/compiler-cli": "^20.1.0",
-    "@angular/core": "^20.1.0",
-    "@angular/platform-browser": "20.2.1",
-    "@angular/platform-browser-dynamic": "20.2.1",
-    "@types/jasmine": "~5.1.4",
-    "@typescript-eslint/eslint-plugin": "^8.33.1",
-    "@typescript-eslint/parser": "^8.33.1",
-    "@typescript-eslint/types": "^8.36.0",
-    "@typescript-eslint/utils": "^8.33.1",
-    "eslint": "^9.28.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.4.1",
-    "jasmine-core": "~5.9.0",
-    "karma": "~6.4.0",
-    "karma-chrome-launcher": "~3.2.0",
-    "karma-coverage": "~2.2.0",
-    "karma-jasmine": "~5.1.0",
-    "karma-jasmine-html-reporter": "~2.1.0",
-    "ng-packagr": "^20.1.0",
-    "prettier": "^3.3.3",
-    "prettier-eslint": "^16.3.0",
-    "typescript": "~5.9.2"
-  },
-  "peerDependencies": {
-    "rxjs": "^7.4.0"
-  }
-}
+{
+  "name": "ngx-print",
+  "version": "20.1.0-beta.5",
+  "description": "Plug n' Play Angular (2++) directive to print your stuff",
+  "author": "https://github.com/selemxmn/ngx-print/graphs/contributors",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/selemxmn/ngx-print.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/selemxmn/ngx-print/issues"
+  },
+  "homepage": "https://github.com/selemxmn/ngx-print#readme",
+  "keywords": [
+    "print",
+    "angular",
+    "library",
+    "ng-print",
+    "ngx-print",
+    "directive",
+    "dependency",
+    "angular-print"
+  ],
+  "peerDependencies": {
+    "rxjs": "^7.4.0"
+  },
+  "module": "fesm2022/ngx-print.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./fesm2022/ngx-print.mjs"
+    }
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "tslib": "^2.3.0"
+  }
+}

package/.editorconfig DELETED Viewed

@@ -1,13 +0,0 @@
-# Editor configuration, see https://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/.eslintrc.json DELETED Viewed

@@ -1,50 +0,0 @@
-{
-  "root": true,
-  "ignorePatterns": ["projects/**/*"],
-  "overrides": [
-    {
-      "files": ["*.ts"],
-      "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended",
-        "plugin:@angular-eslint/recommended",
-        "plugin:@angular-eslint/template/process-inline-templates",
-        "plugin:prettier/recommended"
-      ],
-      "rules": {
-        "@typescript-eslint/no-unused-vars": "off",
-        "@typescript-eslint/no-explicit-any": "off",
-        "@typescript-eslint/no-unused-expressions": "off",
-        "@angular-eslint/directive-selector": [
-          "off",
-          {
-            "type": "attribute",
-            "prefix": "app",
-            "style": "camelCase"
-          }
-        ],
-        "@angular-eslint/component-selector": [
-          "error",
-          {
-            "type": "element",
-            "prefix": "app",
-            "style": "kebab-case"
-          }
-        ]
-      }
-    },
-    {
-      "files": ["*.html"],
-      "excludedFiles": ["*inline-template-*.component.html"],
-      "extends": ["plugin:@angular-eslint/template/recommended", "plugin:prettier/recommended"],
-      "rules": {
-        "prettier/prettier": [
-          "error",
-          {
-            "parser": "angular"
-          }
-        ]
-      }
-    }
-  ]
-}

package/.github/ISSUE_TEMPLATE/bug_report.md DELETED Viewed

@@ -1,31 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
----
-**Describe the bug**
-A clear and concise description of what the bug is.
-**To Reproduce**
-Steps to reproduce the behavior.
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-**Ngx-Print Version**
-Include the current affected version.
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-**Additional context**
-Add any other context about the problem here.

package/.github/ISSUE_TEMPLATE/feature_request.md DELETED Viewed

@@ -1,20 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
----
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/dependabot.yml DELETED Viewed

@@ -1,17 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-      day: "monday"
-      time: "10:00"
-      timezone: "America/New_York"
-    open-pull-requests-limit: 5
-    groups:
-      npm-dependencies:
-        patterns:
-          - "*"
-    ignore:
-    - dependency-name: "*"
-      update-types: ["version-update:semver-major"]

package/.github/workflows/PullRequest.yml DELETED Viewed

@@ -1,32 +0,0 @@
-name: Pull Request Checker
-on:
-  pull_request:
-    branches:
-      - main
-concurrency:
-  group: ${{github.repository_id}}-${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-jobs:
-  build-npm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 24.0.0
-      - name: Install npm dependencies
-        run: npm ci
-        # Run linting
-      - name: Run lint
-        run: npm run lint
-      - name: Run tests
-        run: npm run test

package/.github/workflows/stale.yml DELETED Viewed

@@ -1,26 +0,0 @@
-name: Mark stale issues and pull requests
-on:
-  schedule:
-    - cron: '0 2 * * *'
-  workflow_dispatch:
-permissions:
-  issues: write
-  pull-requests: write
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v9
-        with:
-          repo-token: ${{ secrets.GITHUB_TOKEN }}
-          stale-issue-message: 'This issue has been automatically marked as stale due to inactivity. Please comment if you want to keep it open.'
-          stale-pr-message: 'This pull request has been automatically marked as stale due to inactivity.'
-          close-issue-message: 'Closing this issue due to prolonged inactivity.'
-          close-pr-message: 'Closing this pull request due to inactivity.'
-          days-before-stale: 30
-          days-before-close: 7
-          exempt-issue-labels: 'inspecting'

package/.prettierignore DELETED Viewed

@@ -1,42 +0,0 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-# Compiled output
-/dist
-/tmp
-/out-tsc
-/bazel-out
-# Node
-/node_modules
-npm-debug.log
-yarn-error.log
-# IDEs and editors
-.idea/
-.project
-.classpath
-.c9/
-*.launch
-.settings/
-*.sublime-workspace
-# Visual Studio Code
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-.history/*
-# Miscellaneous
-/.angular/cache
-.sass-cache/
-/connect.lock
-/coverage
-/libpeerconnection.log
-testem.log
-/typings
-# System files
-.DS_Store
-Thumbs.db

package/.prettierrc.json DELETED Viewed

@@ -1,14 +0,0 @@
-{
-  "tabWidth": 2,
-  "useTabs": false,
-  "singleQuote": true,
-  "semi": true,
-  "bracketSpacing": true,
-  "arrowParens": "avoid",
-  "trailingComma": "es5",
-  "bracketSameLine": true,
-  "printWidth": 150,
-  "endOfLine": "auto",
-  "htmlWhitespaceSensitivity": "ignore",
-  "quoteProps": "preserve"
-}

package/CHANGELOG.md DELETED Viewed

@@ -1,17 +0,0 @@
-# 1.5.0 (2023-11-29)
-*  Now supports Angular 17
-*  Added printService
-# 1.4.0 (2023-11-29)
-*  Now supports Angular 16
-# 1.3.0 (2022-12-20)
-### New features
-*  Supports previewOnly tag, allowing for the print preview to show without the print dialog
-### Dependency Updates
-* Angular Ivy support with Angular 15
-# 1.1.0 (2018-12-04)
-### New features
-*  Support styles (CSS) ([#5](https://github.com/selemxmn/ngx-print/issues/5)) ([71cefdf](https://github.com/selemxmn/ngx-print/commit/71cefdf))
-* Permit a dynamic title of printing window instead of the old static `Print tab` ([2098f3e](https://github.com/selemxmn/ngx-print/commit/2098f3e))

package/_config.yml DELETED Viewed

	@@ -1 +0,0 @@
1	- theme: jekyll-theme-cayman