@slickgrid-universal/pdf-export 0.0.1 → 9.13.0

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2020-present, Ghislain B. 
+https://github.com/ghiscoding/slickgrid-universal
+
+and the original author of SlickGrid 
+Michael Leibman, michael{dot}leibman{at}gmail{dot}com
+http://github.com/mleibman/slickgrid
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,45 +1,69 @@
-# @slickgrid-universal/pdf-export
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
+[![lerna--lite](https://img.shields.io/badge/maintained%20with-lerna--lite-e137ff)](https://github.com/ghiscoding/lerna-lite)
+[![npm](https://img.shields.io/npm/v/@slickgrid-universal/pdf-export.svg)](https://www.npmjs.com/package/@slickgrid-universal/pdf-export)
+[![npm](https://img.shields.io/npm/dy/@slickgrid-universal/pdf-export)](https://www.npmjs.com/package/@slickgrid-universal/pdf-export)
+[![npm bundle size](https://img.shields.io/bundlephobia/minzip/@slickgrid-universal/pdf-export?color=success&label=gzip)](https://bundlephobia.com/result?p=@slickgrid-universal/pdf-export)
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+## PDF Export Service
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+#### `@slickgrid-universal/pdf-export`
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+Export your SlickGrid data to PDF format using [`jsPDF`](https://www.npmjs.com/package/jspdf) - a popular, well-supported PDF library for JavaScript.
 
-## Purpose
+### External Dependencies
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@slickgrid-universal/pdf-export`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+- [`jsPDF`](https://www.npmjs.com/package/jspdf) to build and export to PDF.
 
-## What is OIDC Trusted Publishing?
+## Installation
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+```bash
+npm install @slickgrid-universal/pdf-export
+```
 
-## Setup Instructions
+## Usage
 
-To properly configure OIDC trusted publishing for this package:
+```typescript
+import { PdfExportService } from '@slickgrid-universal/pdf-export';
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+// Register the service
+const pdfExportService = new PdfExportService();
 
-## DO NOT USE THIS PACKAGE
+// Initialize in grid options
+const gridOptions = {
+  enablePdfExport: true,
+  pdfExportOptions: {
+    filename: 'my-grid-export',
+    pageOrientation: 'landscape',
+    pageSize: 'a4',
+    documentTitle: 'My Grid Data'
+  },
+  externalResources: [pdfExportService]
+};
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+// Export to PDF
+await pdfExportService.exportToPdf({
+  filename: 'custom-export',
+  pageOrientation: 'portrait'
+});
+```
 
-## More Information
+## Options
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+See [PdfExportOption](../common/src/interfaces/pdfExportOption.interface.ts) for all available options.
 
----
+## Features
 
-**Maintained for OIDC setup purposes only**
+- Export grid data to PDF
+- Support for grouped data
+- Configurable page size and orientation (A4, Letter, Legal)
+- Portrait and landscape orientations
+- Custom font sizes
+- Support for formatters
+- HTML entity decoding
+- Data sanitization
+- Powered by `jsPDF` (widely used, extensible, and feature-rich)
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { PdfExportService } from './pdfExport.service.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/index.js

@@ -0,0 +1,2 @@
+export { PdfExportService } from './pdfExport.service.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC"}

package/dist/pdfExport.service.d.ts

@@ -0,0 +1,88 @@
+import type { PdfExportService as BasePdfExportService, Column, ContainerService, ExternalResource, GridOption, KeyTitlePair, Locale, PdfExportOption, PubSubService, SlickDataView, SlickGrid, TranslaterService } from '@slickgrid-universal/common';
+export interface GroupedHeaderSpan {
+    title: string;
+    span: number;
+}
+export declare class PdfExportService implements ExternalResource, BasePdfExportService {
+    protected _exportOptions: PdfExportOption;
+    protected _grid: SlickGrid;
+    protected _groupedColumnHeaders?: Array<GroupedHeaderSpan>;
+    protected _columnHeaders: Array<KeyTitlePair>;
+    protected _hasGroupedItems: boolean;
+    protected _locales: Locale;
+    protected _pubSubService: PubSubService | null;
+    protected _translaterService: TranslaterService | undefined;
+    /** PdfExportService class name which is use to find service instance in the external registered services */
+    readonly className = "PdfExportService";
+    constructor();
+    protected get _datasetIdPropName(): string;
+    /** Getter of SlickGrid DataView object */
+    get _dataView(): SlickDataView;
+    /** Getter for the Grid Options pulled through the Grid Object */
+    protected get _gridOptions(): GridOption;
+    dispose(): void;
+    /**
+     * Initialize the Service
+     * @param grid
+     * @param containerService
+     */
+    init(grid: SlickGrid, containerService: ContainerService): void;
+    /**
+     * Export the Grid result to PDF format using jsPDF & jsPDF-AutoTable
+     * This is a WYSIWYG export to file output (What You See is What You Get)
+     *
+     * Example: exportToPdf({ filename: 'my-export', pageOrientation: 'landscape' })
+     */
+    exportToPdf(options?: PdfExportOption): Promise<boolean>;
+    /**
+     * Get all the grid row data and return that as a 2D array
+     */
+    protected getAllGridRowData(columns: Column[], columnExportOptionsCache?: Record<string, PdfExportOption>): any[][];
+    /**
+     * Download the PDF file to the user's computer
+     */
+    protected downloadPdf(pdfBytes: Uint8Array, filename: string): void;
+    /**
+     * Get all header titles and their keys, translate the title when required.
+     * @param {Array<object>} columns of the grid
+     */
+    protected getColumnHeaders(columns: Column[]): Array<KeyTitlePair>;
+    /**
+     * Get the data of a regular row (a row without grouping)
+     * @param {Array<Object>} columns - column definitions
+     * @param {Number} row - row index
+     * @param {Object} itemObj - item datacontext object
+     */
+    protected readRegularRowData(columns: Column[], row: number, itemObj: any, columnExportOptionsCache?: Record<string, PdfExportOption>): any[];
+    /**
+     * Get the grouped title(s) and its group title formatter
+     * For example if we grouped by salesRep, the returned result would be: 'Sales Rep: John Dow (2 items)'
+     * @param itemObj
+     */
+    protected readGroupedTitleRow(itemObj: any): any[];
+    /**
+     * Get the grouped totals (below the regular rows), these are set by Slick Aggregators.
+     * For example if we grouped by "salesRep" and we have a Sum Aggregator on "sales",
+     * then the returned output would be:: ["Sum 123$"]
+     * @param itemObj
+     */
+    protected readGroupedTotalRow(columns: Column[], itemObj: any): any[];
+    /**
+     * Get all Grouped Header Titles and their keys, translate the title when required.
+     * Returns array of { title, span } for each group, in order
+     * @param {Array<object>} columns of the grid
+     */
+    protected getColumnGroupedHeaderTitles(columns: Column[]): Array<{
+        title: string;
+        span: number;
+    }>;
+    /**
+     * Draw the pre-header row (grouped column headers) on the PDF document
+     */
+    private _drawPreHeaderRow;
+    /**
+     * Draw the header row on the PDF document
+     */
+    private _drawHeaderRow;
+}
+//# sourceMappingURL=pdfExport.service.d.ts.map

package/dist/pdfExport.service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdfExport.service.d.ts","sourceRoot":"","sources":["../src/pdfExport.service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,IAAI,oBAAoB,EACxC,MAAM,EACN,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,MAAM,EACN,eAAe,EACf,aAAa,EACb,aAAa,EACb,SAAS,EACT,iBAAiB,EAClB,MAAM,6BAA6B,CAAC;AAwBrC,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd;AAeD,qBAAa,gBAAiB,YAAW,gBAAgB,EAAE,oBAAoB;IAC7E,SAAS,CAAC,cAAc,EAAG,eAAe,CAAC;IAC3C,SAAS,CAAC,KAAK,EAAG,SAAS,CAAC;IAC5B,SAAS,CAAC,qBAAqB,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC3D,SAAS,CAAC,cAAc,EAAE,KAAK,CAAC,YAAY,CAAC,CAAM;IACnD,SAAS,CAAC,gBAAgB,UAAS;IACnC,SAAS,CAAC,QAAQ,EAAG,MAAM,CAAC;IAC5B,SAAS,CAAC,cAAc,EAAG,aAAa,GAAG,IAAI,CAAC;IAChD,SAAS,CAAC,kBAAkB,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5D,4GAA4G;IAC5G,QAAQ,CAAC,SAAS,sBAAsB;;IAIxC,SAAS,KAAK,kBAAkB,IAAI,MAAM,CAEzC;IAED,0CAA0C;IAC1C,IAAI,SAAS,IAAI,aAAa,CAE7B;IAED,iEAAiE;IACjE,SAAS,KAAK,YAAY,IAAI,UAAU,CAEvC;IAED,OAAO,IAAI,IAAI;IAIf;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,IAAI;IAe/D;;;;;OAKG;IACH,WAAW,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAgRxD;;OAEG;IACH,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,GAAG,EAAE,EAAE;IA4BnH;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IA0BnE;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC,YAAY,CAAC;IA+BlE;;;;;OAKG;IACH,SAAS,CAAC,kBAAkB,CAC1B,OAAO,EAAE,MAAM,EAAE,EACjB,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,GAAG,EACZ,wBAAwB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,GACzD,GAAG,EAAE;IAsER;;;;OAIG;IACH,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG,EAAE;IA4BlD;;;;;OAKG;IACH,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,GAAG,GAAG,GAAG,EAAE;IAiCrE;;;;OAIG;IACH,SAAS,CAAC,4BAA4B,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAgCjG;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAsCzB;;OAEG;IACH,OAAO,CAAC,cAAc;CAqBvB"}