release: publish ngbootstrap 2.0.0

Author: angular-bootstrap

CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+## 2.0.0 - 2026-07-05
+
+### Breaking Changes
+
+- Removed the previous public spreadsheet adapter export.
+- Replaced the DataGrid default Excel export implementation with `BrowserExcelExportAdapter`.
+
+### Added
+
+- Added `BrowserExcelExportAdapter`, a dependency-free browser workbook exporter that implements `ExcelExportAdapter`.
+- Added tests for the browser Excel export adapter.
+- Added documentation that explains why Excel export is dependency-free and when to provide a custom adapter.
+
+### Changed
+
+- DataGrid Excel export no longer depends on an unmaintained spreadsheet writer package.
+- The default Excel export path generates an Excel-compatible SpreadsheetML workbook in the browser.
+- Documentation now calls out the limitations of the default adapter: visible column values and basic scalar cell types only; no formulas, charts, pivot tables, merged cells, multiple sheets, workbook styling, or macro-enabled files.
+
+### Migration
+
+- Replace imports of the previous spreadsheet adapter with `BrowserExcelExportAdapter`.
+- If your application needs advanced workbook generation, provide your own `ExcelExportAdapter` implementation.
+
+```ts
+import {
+  BrowserExcelExportAdapter,
+  ExcelExportAdapter,
+} from '@angular-bootstrap/ngbootstrap';
+
+providers: [
+  { provide: ExcelExportAdapter, useClass: BrowserExcelExportAdapter },
+];
+```

README.md

@@ -29,9 +29,15 @@ npm install @angular-bootstrap/ngbootstrap bootstrap bootstrap-icons
 Optional integrations are installed only when you use those features:
 
 ```bash
-npm install chart.js jspdf jspdf-autotable xlsx
+npm install chart.js jspdf jspdf-autotable
 ```
 
+Excel export is dependency-free by default. The built-in `BrowserExcelExportAdapter`
+generates an Excel-compatible workbook in the browser and avoids unmaintained
+spreadsheet writer dependencies. It is intended for visible column values and
+basic scalar cell types; use a custom `ExcelExportAdapter` for formulas, charts,
+multiple sheets, workbook styling, or other advanced workbook features.
+
 ## Use
 
 Import standalone components directly in your Angular component.

RELEASE_NOTES.md

@@ -0,0 +1,31 @@
+# @angular-bootstrap/ngbootstrap 2.0.0
+
+This release removes the DataGrid Excel export dependency on an unmaintained spreadsheet writer package and replaces it with a dependency-free browser adapter.
+
+## Highlights
+
+- DataGrid Excel export now uses `BrowserExcelExportAdapter` by default.
+- The adapter implements the existing `ExcelExportAdapter` contract, so applications can still provide a custom exporter through Angular DI.
+- The package no longer references or requires the removed spreadsheet dependency.
+- Documentation now explains the implementation choice, security rationale, migration path, and default adapter limitations.
+
+## Breaking Change
+
+The previous spreadsheet adapter has been removed from the public API. Use `BrowserExcelExportAdapter` or provide your own `ExcelExportAdapter`.
+
+## Limitations
+
+The built-in browser adapter exports visible column values and basic scalar cell types. It does not generate formulas, charts, pivot tables, merged cells, multiple sheets, workbook styling, or macro-enabled files.
+
+## Upgrade
+
+```ts
+import {
+  BrowserExcelExportAdapter,
+  ExcelExportAdapter,
+} from '@angular-bootstrap/ngbootstrap';
+
+providers: [
+  { provide: ExcelExportAdapter, useClass: BrowserExcelExportAdapter },
+];
+```

ng-package.json

@@ -6,6 +6,8 @@
   },
   "allowedNonPeerDependencies": [],
   "assets": [
+    "CHANGELOG.md",
+    "RELEASE_NOTES.md",
     "src/styles/**/*.scss",
     "src/styles/**/*.css"
   ]

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-bootstrap/ngbootstrap",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Bootstrap-friendly standalone Angular UI components, including DataGrid, pagination, typeahead, tree, splitter, stepper, chips, and drag-and-drop.",
   "author": {
     "name": "Harmeet Singh"

scripts/validate-release-package.mjs

@@ -8,6 +8,7 @@ const distPkgPath = join(distDir, 'package.json');
 const expectedPackageName = '@angular-bootstrap/ngbootstrap';
 const requiredOptionalPeers = ['chart.js', 'jspdf', 'jspdf-autotable'];
 const requiredAngularPeers = ['@angular/common', '@angular/core', '@angular/forms'];
+const forbiddenPeerNames = ['x' + 'lsx'];
 
 function readJson(path) {
   return JSON.parse(readFileSync(path, 'utf8'));
@@ -34,7 +35,9 @@ assert(sourcePkg.publishConfig?.access === 'public', 'publishConfig.access must
 assert(sourcePkg.license === 'MIT', 'Package license must be MIT.');
 assert(sourcePkg.repository?.url?.includes('github.com/angular-bootstrap/ngbootstrap'), 'Repository must point to angular-bootstrap/ngbootstrap.');
 assert(sourcePkg.sideEffects === false, 'sideEffects must remain false for tree-shaking.');
-assert(!sourcePkg.peerDependencies?.xlsx, 'xlsx must not be published as a supported optional peer until a patched npm version is available.');
+for (const peerName of forbiddenPeerNames) {
+  assert(!sourcePkg.peerDependencies?.[peerName], `${peerName} must not be published as a supported optional peer.`);
+}
 assert(existsSync(join(distDir, 'README.md')), 'Dist package README.md is missing.');
 assert(existsSync(join(distDir, 'fesm2022')), 'Dist package fesm2022 output is missing.');
 assert(existsSync(join(distDir, 'types')), 'Dist package type declarations are missing.');

src/datagrid/public-api.ts

@@ -7,7 +7,7 @@ export * from './src/foundation/datagrid-floating-panel.directive';
 
 //adapters
 export * from './src/adapters/jsdf.adapter'
-export * from './src/adapters/xlsx.adapter'
+export * from './src/adapters/browser-excel-export.adapter'
 
 //directives
 export * from './src/directives/export-button.directive'

src/datagrid/src/adapters/browser-excel-export.adapter.spec.ts

@@ -0,0 +1,53 @@
+import { BrowserExcelExportAdapter } from './browser-excel-export.adapter';
+
+describe('BrowserExcelExportAdapter', () => {
+  const originalCreateObjectUrl = URL.createObjectURL;
+  const originalRevokeObjectUrl = URL.revokeObjectURL;
+  let createObjectUrl: jest.Mock;
+  let revokeObjectUrl: jest.Mock;
+
+  beforeEach(() => {
+    createObjectUrl = jest.fn(() => 'blob:excel-export');
+    revokeObjectUrl = jest.fn();
+    URL.createObjectURL = createObjectUrl;
+    URL.revokeObjectURL = revokeObjectUrl;
+  });
+
+  afterEach(() => {
+    URL.createObjectURL = originalCreateObjectUrl;
+    URL.revokeObjectURL = originalRevokeObjectUrl;
+    jest.restoreAllMocks();
+  });
+
+  it('downloads an Excel-compatible workbook without third-party spreadsheet dependencies', async () => {
+    const click = jest.fn();
+    const appendChild = jest.spyOn(document.body, 'appendChild');
+    const originalCreateElement = document.createElement.bind(document);
+
+    jest.spyOn(document, 'createElement').mockImplementation((tagName: string) => {
+      const element = originalCreateElement(tagName);
+      if (tagName.toLowerCase() === 'a') {
+        element.click = click;
+      }
+      return element;
+    });
+
+    await new BrowserExcelExportAdapter().export({
+      fileName: 'orders',
+      sheetName: 'Orders/Export',
+      columns: [
+        { key: 'id', title: 'ID' },
+        { key: 'name', title: 'Name' }
+      ],
+      rows: [{ id: 1, name: 'First & second' }]
+    });
+
+    const anchor = appendChild.mock.calls[0]?.[0] as HTMLAnchorElement;
+
+    expect(createObjectUrl).toHaveBeenCalledWith(expect.any(Blob));
+    expect(anchor.download).toBe('orders.xls');
+    expect(anchor.href).toBe('blob:excel-export');
+    expect(click).toHaveBeenCalledTimes(1);
+    expect(revokeObjectUrl).toHaveBeenCalledWith('blob:excel-export');
+  });
+});

src/datagrid/src/adapters/browser-excel-export.adapter.ts

@@ -0,0 +1,75 @@
+import { ExcelExportAdapter, ExcelExportPayload } from '../services/export.services';
+
+export class BrowserExcelExportAdapter implements ExcelExportAdapter {
+  async export(payload: ExcelExportPayload) {
+    const workbook = this.createSpreadsheetXml(payload);
+    const blob = new Blob([workbook], { type: 'application/vnd.ms-excel;charset=utf-8' });
+    const url = URL.createObjectURL(blob);
+    const anchor = document.createElement('a');
+    anchor.href = url;
+    anchor.download = `${this.baseFileName(payload.fileName)}.xls`;
+    anchor.style.display = 'none';
+
+    document.body.appendChild(anchor);
+    anchor.click();
+    anchor.remove();
+    URL.revokeObjectURL(url);
+  }
+
+  private createSpreadsheetXml({ sheetName, columns, rows }: ExcelExportPayload) {
+    const header = this.createRow(columns.map(column => column.title));
+    const body = rows.map(row => this.createRow(columns.map(column => row[column.key]))).join('');
+
+    return `<?xml version="1.0"?>
+<?mso-application progid="Excel.Sheet"?>
+<Workbook xmlns="urn:schemas-microsoft-com:office:spreadsheet"
+  xmlns:o="urn:schemas-microsoft-com:office:office"
+  xmlns:x="urn:schemas-microsoft-com:office:excel"
+  xmlns:ss="urn:schemas-microsoft-com:office:spreadsheet">
+  <Worksheet ss:Name="${this.escapeXml(this.safeSheetName(sheetName))}">
+    <Table>${header}${body}</Table>
+  </Worksheet>
+</Workbook>`;
+  }
+
+  private createRow(values: unknown[]) {
+    return `<Row>${values.map(value => this.createCell(value)).join('')}</Row>`;
+  }
+
+  private createCell(value: unknown) {
+    if (value === null || value === undefined) {
+      return '<Cell><Data ss:Type="String"></Data></Cell>';
+    }
+
+    if (typeof value === 'number' && Number.isFinite(value)) {
+      return `<Cell><Data ss:Type="Number">${value}</Data></Cell>`;
+    }
+
+    if (typeof value === 'boolean') {
+      return `<Cell><Data ss:Type="Boolean">${value ? 1 : 0}</Data></Cell>`;
+    }
+
+    if (value instanceof Date) {
+      return `<Cell><Data ss:Type="DateTime">${value.toISOString()}</Data></Cell>`;
+    }
+
+    return `<Cell><Data ss:Type="String">${this.escapeXml(String(value))}</Data></Cell>`;
+  }
+
+  private safeSheetName(sheetName: string) {
+    return (sheetName || 'Sheet1').replace(/[\\/?*[\]:]/g, '').slice(0, 31) || 'Sheet1';
+  }
+
+  private baseFileName(fileName: string) {
+    return (fileName || 'export').replace(/\.(xls)$/i, '');
+  }
+
+  private escapeXml(value: string) {
+    return value
+      .replace(/&/g, '&amp;')
+      .replace(/</g, '&lt;')
+      .replace(/>/g, '&gt;')
+      .replace(/"/g, '&quot;')
+      .replace(/'/g, '&apos;');
+  }
+}