Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2dcae9060f | ||
|
|
f4525cc62a | ||
|
|
d4aa70ddbf | ||
|
|
4c2aca3495 | ||
|
|
36c9ef0e95 | ||
|
|
7511b64523 | ||
|
|
7b4b4ebeeb | ||
|
|
c7ba025d39 | ||
|
|
b5e9b25319 | ||
|
|
82a254d22c | ||
|
|
0d7fd34297 | ||
|
|
1beb3d490d | ||
|
|
1fb5e8eb37 | ||
|
|
78dd29ba78 | ||
|
|
ba7b61082d | ||
|
|
1a9231809e | ||
|
|
df5c975869 | ||
|
|
2728dac873 | ||
|
|
88f55b9d06 | ||
|
|
301675052f | ||
|
|
45c434271d | ||
|
|
f523c798c3 | ||
|
|
41fd618884 | ||
|
|
f368242cb0 | ||
|
|
636e4e5b4a | ||
|
|
49710eb62d | ||
|
|
25c12f2b18 | ||
|
|
3ba8858260 | ||
|
|
81014001ac | ||
|
|
691d6f277e | ||
|
|
e7453a9305 | ||
|
|
005b616adb | ||
|
|
0ae1781d28 | ||
|
|
fb94840016 | ||
|
|
6864c044dc | ||
|
|
b30ba3e76b | ||
|
|
a4583f2db0 | ||
|
|
a161670b86 | ||
|
|
e6cf5a8d25 | ||
|
|
7ebc26fc7f | ||
|
|
c9dd933cec | ||
|
|
716eba621f | ||
|
|
982d507ae3 | ||
|
|
27a12951e3 | ||
|
|
4c8e4ee1b2 | ||
|
|
a15fdc401e | ||
|
|
7019e39318 | ||
|
|
9ca57193b4 | ||
|
|
175eb9853a | ||
|
|
e859d3354e | ||
|
|
adc6424211 | ||
|
|
74442096ba | ||
|
|
9f84a580fb | ||
|
|
2f5d3dfc38 | ||
|
|
9b18a45d35 | ||
|
|
6a30de37ca | ||
|
|
31075a165f | ||
|
|
53b7ee0cb2 | ||
|
|
ebe6972dd7 | ||
|
|
2acea64589 | ||
|
|
ffa3ff9c10 | ||
|
|
0ac3ff4511 | ||
|
|
3429a7a2a6 | ||
|
|
56fb2c2a3a | ||
|
|
77b4bb310e | ||
|
|
47ba03ec63 | ||
|
|
e331e1bb21 | ||
|
|
40f285f295 | ||
|
|
2d29346cbf | ||
|
|
f70ea2fe71 | ||
|
|
29aaa72c60 | ||
|
|
12c7d30894 | ||
|
|
38cb1e207b | ||
|
|
4c879c614b | ||
|
|
8e012f760a | ||
|
|
8c09befd74 | ||
|
|
6af49cf1fd | ||
|
|
4ea604f9fb | ||
|
|
9d97bf7ea1 | ||
|
|
eb015d712b | ||
|
|
1d04f4a42c | ||
|
|
11ee49a57a | ||
|
|
609731ff99 | ||
|
|
d6cb32ed25 | ||
|
|
3668a7426f | ||
|
|
cc82dcaafe | ||
|
|
ea03bdecc5 | ||
|
|
51071b463b | ||
|
|
ac0bd10212 | ||
|
|
1b73e355b7 | ||
|
|
b661580c60 | ||
|
|
dc4e07a692 | ||
|
|
f2313b31f1 | ||
|
|
f8810ee7e9 | ||
|
|
8ab4af8397 | ||
|
|
2382a559a5 | ||
|
|
5d889d824c | ||
|
|
bed21122ce | ||
|
|
ea8cf71101 | ||
|
|
f1a26e132e | ||
|
|
1db6984de3 | ||
|
|
636ff237dd | ||
|
|
02963ab6d5 | ||
|
|
d40f61292a | ||
|
|
7d94cb2ae4 | ||
|
|
bb80476767 | ||
|
|
1635bc9c45 | ||
|
|
f031b4eb89 | ||
|
|
93d4ab65ac | ||
|
|
ce921a032a |
@@ -0,0 +1,606 @@
|
|||||||
|
---
|
||||||
|
name: handsontable
|
||||||
|
description: >
|
||||||
|
Use this skill whenever the user asks about Handsontable — a JavaScript data grid component with
|
||||||
|
spreadsheet-like UX. Triggers include: mentions of "handsontable", "HotTable", "data grid",
|
||||||
|
"@handsontable/react-wrapper", spreadsheet component in React/Angular/Vue, HyperFormula formulas
|
||||||
|
inside a grid, cell types (dropdown, checkbox, date, numeric) in a grid context, or questions
|
||||||
|
about Handsontable theming, plugins, hooks, configuration options, or column/row features. Also
|
||||||
|
trigger when the user wants to add an editable spreadsheet-like table to a web app, or asks about
|
||||||
|
copy/paste, sorting, filtering, frozen rows/columns, merged cells, or context menus in a grid.
|
||||||
|
This skill covers Handsontable used with any framework (React, Angular, Vue 3, vanilla JS) and
|
||||||
|
HyperFormula as the Formulas plugin engine inside Handsontable. Do NOT use this skill for
|
||||||
|
headless/standalone HyperFormula usage without Handsontable — that is covered by the separate
|
||||||
|
"hyperformula" skill.
|
||||||
|
---
|
||||||
|
|
||||||
|
# Handsontable
|
||||||
|
|
||||||
|
Handsontable is a JavaScript **data grid component** (not a full spreadsheet application) that
|
||||||
|
brings spreadsheet-like UX to web apps: cell editing, copy/paste, sorting, filtering, formulas,
|
||||||
|
keyboard navigation, context menus, merged cells, frozen rows/columns, conditional formatting, data
|
||||||
|
validation, pagination, and 400+ built-in formulas via HyperFormula.
|
||||||
|
|
||||||
|
- **Latest version:** 17.1.0 (May 2026)
|
||||||
|
- **Frameworks:** Vanilla JS/TS, React (`@handsontable/react-wrapper`), Angular (`@handsontable/angular-wrapper`), Vue 3 (`@handsontable/vue3`)
|
||||||
|
- **React wrapper requires:** React 18+
|
||||||
|
- **License:** Dual — free for non-commercial use (`licenseKey: 'non-commercial-and-evaluation'`), paid for commercial. Per-developer annual license, offline validation (no server connection). Tiers: Hobby (free, non-commercial), Trial (free 45 days), Standard (from $999/yr), Priority (from $1,299/yr), Enterprise (custom). See [Pricing](https://handsontable.com/pricing).
|
||||||
|
|
||||||
|
Always check `references/docs-map.md` (in this skill folder) for the full organized link directory
|
||||||
|
when you need to point the user to specific documentation or need to look up more info.
|
||||||
|
|
||||||
|
### What this skill does NOT cover
|
||||||
|
|
||||||
|
- **Standalone HyperFormula** (headless formula engine without a grid UI) — use the "hyperformula" skill instead.
|
||||||
|
- **Other data grid libraries** (AG Grid, TanStack Table, etc.).
|
||||||
|
- **Full spreadsheet applications** — Handsontable is a component you embed, not a standalone app like Google Sheets.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## React Quick Start (Recommended)
|
||||||
|
|
||||||
|
### Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install handsontable @handsontable/react-wrapper
|
||||||
|
```
|
||||||
|
|
||||||
|
### Minimal working example
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
import { HotTable } from '@handsontable/react-wrapper';
|
||||||
|
import { registerAllModules } from 'handsontable/registry';
|
||||||
|
import 'handsontable/styles/handsontable.min.css';
|
||||||
|
import 'handsontable/styles/ht-theme-main.min.css';
|
||||||
|
|
||||||
|
registerAllModules();
|
||||||
|
|
||||||
|
const MyGrid = () => (
|
||||||
|
<HotTable
|
||||||
|
themeName="ht-theme-main"
|
||||||
|
data={[
|
||||||
|
['', 'Tesla', 'Volvo', 'Toyota', 'Ford'],
|
||||||
|
['2019', 10, 11, 12, 13],
|
||||||
|
['2020', 20, 11, 14, 13],
|
||||||
|
['2021', 30, 15, 12, 13],
|
||||||
|
]}
|
||||||
|
colHeaders={true}
|
||||||
|
rowHeaders={true}
|
||||||
|
height="auto"
|
||||||
|
autoWrapRow={true}
|
||||||
|
autoWrapCol={true}
|
||||||
|
licenseKey="non-commercial-and-evaluation"
|
||||||
|
/>
|
||||||
|
);
|
||||||
|
|
||||||
|
export default MyGrid;
|
||||||
|
```
|
||||||
|
|
||||||
|
Key points:
|
||||||
|
- `registerAllModules()` registers every built-in plugin. To reduce bundle size, import only what
|
||||||
|
you need — see [Modules guide](https://handsontable.com/docs/react-data-grid/modules/).
|
||||||
|
- `height` is required (or the grid won't render). Use `"auto"`, a pixel number, or a CSS string.
|
||||||
|
- All Handsontable configuration options are passed as props on `<HotTable>`.
|
||||||
|
- Full installation guide: https://handsontable.com/docs/react-data-grid/installation/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Vanilla JS Quick Start
|
||||||
|
|
||||||
|
### Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install handsontable
|
||||||
|
```
|
||||||
|
|
||||||
|
### CDN (jsDelivr)
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/handsontable/dist/handsontable.full.min.js"></script>
|
||||||
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable/styles/handsontable.min.css" />
|
||||||
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable/styles/ht-theme-main.min.css" />
|
||||||
|
```
|
||||||
|
|
||||||
|
To pin a specific version, add `@17.1` after `handsontable` in the URL (e.g.,
|
||||||
|
`handsontable@17.1/dist/handsontable.full.min.js`).
|
||||||
|
|
||||||
|
### Minimal working example
|
||||||
|
|
||||||
|
```js
|
||||||
|
import Handsontable from 'handsontable';
|
||||||
|
import 'handsontable/styles/handsontable.min.css';
|
||||||
|
import 'handsontable/styles/ht-theme-main.min.css';
|
||||||
|
|
||||||
|
const container = document.getElementById('grid');
|
||||||
|
|
||||||
|
new Handsontable(container, {
|
||||||
|
data: [
|
||||||
|
['', 'Tesla', 'Volvo', 'Toyota', 'Ford'],
|
||||||
|
['2019', 10, 11, 12, 13],
|
||||||
|
['2020', 20, 11, 14, 13],
|
||||||
|
['2021', 30, 15, 12, 13],
|
||||||
|
],
|
||||||
|
colHeaders: true,
|
||||||
|
rowHeaders: true,
|
||||||
|
height: 'auto',
|
||||||
|
themeName: 'ht-theme-main',
|
||||||
|
autoWrapRow: true,
|
||||||
|
autoWrapCol: true,
|
||||||
|
licenseKey: 'non-commercial-and-evaluation',
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Full JS docs: https://handsontable.com/docs/javascript-data-grid/installation/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Other Frameworks
|
||||||
|
|
||||||
|
### Angular (v17–19)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install handsontable @handsontable/angular-wrapper
|
||||||
|
```
|
||||||
|
|
||||||
|
The Angular wrapper was modernized in Handsontable v17.1 to align with Angular 17–19, simplifying setup and reducing dependencies. Earlier Angular versions are no longer the target — upgrade Angular first if you're below v17.
|
||||||
|
|
||||||
|
Docs: https://handsontable.com/docs/angular-data-grid/installation/
|
||||||
|
|
||||||
|
### Vue 3
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install handsontable @handsontable/vue3
|
||||||
|
```
|
||||||
|
|
||||||
|
Docs: https://handsontable.com/docs/react-data-grid/vue3-installation/
|
||||||
|
|
||||||
|
All framework wrappers share the same version number as the core library and expose the same
|
||||||
|
configuration options. The React examples in this skill translate directly — just use the
|
||||||
|
framework's component syntax. Note: Vue 2 (`@handsontable/vue`) is deprecated — use Vue 3.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Theming: Light / Dark / Auto
|
||||||
|
|
||||||
|
Handsontable v15+ includes a built-in theme system. Three themes ship out of the box: **main**
|
||||||
|
(default, spreadsheet-like), **horizon** (clean, analytics-focused), **classic** (legacy
|
||||||
|
replacement).
|
||||||
|
|
||||||
|
### CSS file approach (simplest)
|
||||||
|
|
||||||
|
Import the base stylesheet plus a theme:
|
||||||
|
|
||||||
|
```js
|
||||||
|
import 'handsontable/styles/handsontable.min.css';
|
||||||
|
import 'handsontable/styles/ht-theme-main.min.css';
|
||||||
|
```
|
||||||
|
|
||||||
|
Then set the theme on the grid:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
<HotTable themeName="ht-theme-main" /* ... */ />
|
||||||
|
```
|
||||||
|
|
||||||
|
**Dark mode:**
|
||||||
|
- System preference (auto): `themeName="ht-theme-main-dark-auto"`
|
||||||
|
- Forced dark: `themeName="ht-theme-main-dark"`
|
||||||
|
|
||||||
|
Replace `main` with `horizon` or `classic` for other themes.
|
||||||
|
|
||||||
|
### Theme API approach (runtime switching)
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { mainTheme, registerTheme } from 'handsontable/themes';
|
||||||
|
|
||||||
|
const theme = registerTheme(mainTheme)
|
||||||
|
.setColorScheme('auto') // 'light' | 'dark' | 'auto'
|
||||||
|
.setDensityType('comfortable'); // 'compact' | 'default' | 'comfortable'
|
||||||
|
```
|
||||||
|
|
||||||
|
Then pass it as a prop:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
<HotTable theme={theme} /* ... */ />
|
||||||
|
```
|
||||||
|
|
||||||
|
### CDN theme files
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!-- Theme CSS (includes light and dark mode support) -->
|
||||||
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/handsontable/styles/ht-theme-main.min.css" />
|
||||||
|
```
|
||||||
|
|
||||||
|
In v17, dark mode is controlled via `themeName` or the Theme API — there are no separate `-dark` or
|
||||||
|
`-dark-auto` CSS files. Load the base theme CSS above and set the mode at runtime.
|
||||||
|
|
||||||
|
For CSS variable customization, the Theme Builder, Figma design system, and 200+ design tokens, see:
|
||||||
|
- [Themes guide](https://handsontable.com/docs/react-data-grid/themes/)
|
||||||
|
- [Theme customization](https://handsontable.com/docs/react-data-grid/theme-customization/)
|
||||||
|
- [Theme Builder tool](https://handsontable.com/theme-builder)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Configuration Patterns
|
||||||
|
|
||||||
|
All options below are passed as props on `<HotTable>` (React) or in the config object (vanilla JS).
|
||||||
|
For the full options reference: https://handsontable.com/docs/react-data-grid/api/options/
|
||||||
|
|
||||||
|
### Data binding
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
// Array of arrays
|
||||||
|
data={[['A1', 'B1'], ['A2', 'B2']]}
|
||||||
|
|
||||||
|
// Array of objects
|
||||||
|
data={[{ id: 1, name: 'Alice' }, { id: 2, name: 'Bob' }]}
|
||||||
|
columns={[{ data: 'id' }, { data: 'name' }]}
|
||||||
|
```
|
||||||
|
|
||||||
|
Docs: https://handsontable.com/docs/react-data-grid/binding-to-data/
|
||||||
|
|
||||||
|
### Column & row headers
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
colHeaders={['ID', 'Name', 'Price']} // custom labels, or {true} for A, B, C...
|
||||||
|
rowHeaders={true} // 1, 2, 3... or pass an array
|
||||||
|
```
|
||||||
|
|
||||||
|
### Column types (cell types)
|
||||||
|
|
||||||
|
Set via the `columns` array or `cells` function. Built-in types:
|
||||||
|
|
||||||
|
- `text` (default), `numeric`, `date`, `time`, `checkbox`, `select`, `dropdown`,
|
||||||
|
`autocomplete`, `password`, `handsontable` (nested grid), `multiselect` (v17+)
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
columns={[
|
||||||
|
{ data: 'name', type: 'text' },
|
||||||
|
{ data: 'price', type: 'numeric', numericFormat: { pattern: '$0,0.00' } },
|
||||||
|
{ data: 'active', type: 'checkbox' },
|
||||||
|
{ data: 'category', type: 'dropdown', source: ['A', 'B', 'C'] },
|
||||||
|
]}
|
||||||
|
```
|
||||||
|
|
||||||
|
Full cell types reference: https://handsontable.com/docs/react-data-grid/cell-type/
|
||||||
|
|
||||||
|
### Sorting & filtering
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
columnSorting={true} // single-column sort
|
||||||
|
// or
|
||||||
|
multiColumnSorting={true} // multi-column sort
|
||||||
|
|
||||||
|
filters={true} // enable column filters
|
||||||
|
dropdownMenu={true} // column header menu with filter UI
|
||||||
|
```
|
||||||
|
|
||||||
|
### Frozen rows/columns
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
fixedRowsTop={1}
|
||||||
|
fixedRowsBottom={1}
|
||||||
|
fixedColumnsStart={2}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Other common options
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
readOnly={true} // entire grid read-only (or per-cell/column)
|
||||||
|
contextMenu={true} // right-click menu
|
||||||
|
mergeCells={[{ row: 0, col: 0, rowspan: 2, colspan: 2 }]}
|
||||||
|
manualColumnResize={true}
|
||||||
|
manualRowResize={true}
|
||||||
|
stretchH="all" // stretch columns to fill width: 'none' | 'last' | 'all'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Per-column config with HotColumn (React)
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
import { HotTable, HotColumn } from '@handsontable/react-wrapper';
|
||||||
|
|
||||||
|
<HotTable data={data} licenseKey="non-commercial-and-evaluation">
|
||||||
|
<HotColumn title="Name" data="name" />
|
||||||
|
<HotColumn title="Active" data="active" type="checkbox" />
|
||||||
|
</HotTable>
|
||||||
|
```
|
||||||
|
|
||||||
|
Docs: https://handsontable.com/docs/react-data-grid/hot-column/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## HyperFormula Integration (Formulas Plugin)
|
||||||
|
|
||||||
|
HyperFormula powers Handsontable's Formulas plugin, providing 400+ spreadsheet functions (SUM,
|
||||||
|
AVERAGE, IF, VLOOKUP, etc.). This section covers using HyperFormula **inside** Handsontable only.
|
||||||
|
|
||||||
|
### Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install hyperformula
|
||||||
|
```
|
||||||
|
|
||||||
|
> **Note:** Starting in Handsontable v18, HyperFormula will no longer be bundled. Install it
|
||||||
|
> separately and pass it to the Formulas plugin.
|
||||||
|
|
||||||
|
### CDN
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/hyperformula/dist/hyperformula.full.min.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Simple setup (auto-created instance)
|
||||||
|
|
||||||
|
Pass the `HyperFormula` class directly — Handsontable creates an instance automatically:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
import { HyperFormula } from 'hyperformula';
|
||||||
|
|
||||||
|
<HotTable
|
||||||
|
data={[
|
||||||
|
['10', '20', '=SUM(A1:B1)'],
|
||||||
|
['30', '40', '=SUM(A2:B2)'],
|
||||||
|
]}
|
||||||
|
formulas={{ engine: HyperFormula }}
|
||||||
|
colHeaders={true}
|
||||||
|
licenseKey="non-commercial-and-evaluation"
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
### External instance (for multi-sheet or shared engine)
|
||||||
|
|
||||||
|
Create a HyperFormula instance with the `'internal-use-in-handsontable'` license key:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
import { HyperFormula } from 'hyperformula';
|
||||||
|
|
||||||
|
const hfInstance = HyperFormula.buildEmpty({
|
||||||
|
licenseKey: 'internal-use-in-handsontable',
|
||||||
|
});
|
||||||
|
|
||||||
|
// Sheet 1
|
||||||
|
<HotTable
|
||||||
|
data={data1}
|
||||||
|
formulas={{ engine: hfInstance, sheetName: 'Sheet1' }}
|
||||||
|
licenseKey="non-commercial-and-evaluation"
|
||||||
|
/>
|
||||||
|
|
||||||
|
// Sheet 2 — shares the same engine, enabling cross-sheet references
|
||||||
|
<HotTable
|
||||||
|
data={data2}
|
||||||
|
formulas={{ engine: hfInstance, sheetName: 'Sheet2' }}
|
||||||
|
licenseKey="non-commercial-and-evaluation"
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
Cross-sheet formula example: `=SUM(Sheet1!A:A)`
|
||||||
|
|
||||||
|
### Named expressions
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
formulas={{
|
||||||
|
engine: HyperFormula,
|
||||||
|
namedExpressions: [
|
||||||
|
{ name: 'TAX_RATE', expression: 0.21 },
|
||||||
|
],
|
||||||
|
}}
|
||||||
|
```
|
||||||
|
|
||||||
|
Use in cells: `=A1 * TAX_RATE`
|
||||||
|
|
||||||
|
### Listening for formula changes
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
<HotTable
|
||||||
|
formulas={{ engine: HyperFormula }}
|
||||||
|
afterFormulasValuesUpdate={(changes) => {
|
||||||
|
changes.forEach((c) => console.log(c.address, c.newValue));
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Known limitations
|
||||||
|
|
||||||
|
- Formulas don't work with nested object data.
|
||||||
|
- Moving rows/columns with formulas requires the ManualRowMove / ManualColumnMove plugins (not IndexMapper).
|
||||||
|
- `getSourceData()` operates on physical indexes; formulas use visual indexes.
|
||||||
|
|
||||||
|
Full guide: https://handsontable.com/docs/react-data-grid/formula-calculation/
|
||||||
|
HyperFormula functions list: https://hyperformula.handsontable.com/docs/guide/built-in-functions.html
|
||||||
|
HyperFormula version compatibility table: https://handsontable.com/docs/react-data-grid/formula-calculation/#hyperformula-version-support
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Server-side data with DataProvider (v17.1+)
|
||||||
|
|
||||||
|
The **DataProvider plugin** (new in v17.1) wires the grid up to a remote data source so rows are fetched, sorted, and mutated server-side instead of held in memory. Use it for datasets too large to load up front, or when the source of truth lives in a backend.
|
||||||
|
|
||||||
|
The `dataProvider` option is an object with five required keys: a row-id resolver, a paginated `fetchRows` callback, and three mutation callbacks. For a read-only grid, stub the mutation callbacks with `async () => {}` — they must still be present.
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
<HotTable
|
||||||
|
colHeaders={['ID', 'Name', 'Email']}
|
||||||
|
pagination={{ pageSize: 25 }}
|
||||||
|
columnSorting={true}
|
||||||
|
emptyDataState={true}
|
||||||
|
height={360}
|
||||||
|
licenseKey="non-commercial-and-evaluation"
|
||||||
|
dataProvider={{
|
||||||
|
// Required: how to extract a stable id from each row
|
||||||
|
rowId: 'id',
|
||||||
|
|
||||||
|
// Required: paginated fetch. `sort` is null when no column is sorted.
|
||||||
|
// Second arg carries an AbortSignal — pass it to fetch() so the plugin
|
||||||
|
// can cancel superseded requests when the user pages/sorts quickly.
|
||||||
|
async fetchRows({ page, pageSize, sort }, { signal }) {
|
||||||
|
const params = new URLSearchParams({ page, pageSize });
|
||||||
|
if (sort) {
|
||||||
|
// sort = { prop: string, order: 'asc' | 'desc' }
|
||||||
|
params.set('sortBy', sort.prop);
|
||||||
|
params.set('order', sort.order);
|
||||||
|
}
|
||||||
|
const res = await fetch(`/api/users?${params}`, { signal });
|
||||||
|
const { rows, totalRows } = await res.json();
|
||||||
|
return { rows, totalRows };
|
||||||
|
},
|
||||||
|
|
||||||
|
// Required. Stub with async () => {} if your grid is read-only.
|
||||||
|
// The plugin auto-refetches the current page after each callback resolves.
|
||||||
|
// See the plugin API ref for the exact payload shapes.
|
||||||
|
onRowsCreate: async () => {},
|
||||||
|
onRowsUpdate: async () => {},
|
||||||
|
onRowsRemove: async () => {},
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Loading and error UI
|
||||||
|
|
||||||
|
The plugin fires three hooks you can wire up as `<HotTable>` props for loading indicators and error surfaces:
|
||||||
|
|
||||||
|
- `beforeDataProviderFetch(params)` — fires before each fetch. `params.skipLoading` is set when the plugin wants to suppress your loading indicator (e.g., during a quick refetch).
|
||||||
|
- `afterDataProviderFetch(result)` — fires after a successful fetch.
|
||||||
|
- `afterDataProviderFetchError(error)` — fires when `fetchRows` throws or returns a rejected promise.
|
||||||
|
|
||||||
|
### Companion options
|
||||||
|
|
||||||
|
The plugin is built to pair with `pagination` (paginates server-side), `columnSorting` (single-column server-side sort), and `emptyDataState` (loading + empty state UI). Enable all three when you use DataProvider.
|
||||||
|
|
||||||
|
### Authoritative references
|
||||||
|
|
||||||
|
- Guide: https://handsontable.com/docs/react-data-grid/server-side-data-fetching/
|
||||||
|
- Recipe (REST API): https://handsontable.com/docs/react-data-grid/recipes/data-management/load-data-rest-api/
|
||||||
|
- Plugin API: https://handsontable.com/docs/react-data-grid/api/data-provider/
|
||||||
|
|
||||||
|
## Notifications (v17.1+)
|
||||||
|
|
||||||
|
The **Notification plugin** (new in v17.1) shows non-blocking toast notifications anchored to the grid — useful for confirming saves, surfacing validation errors, or signaling background sync state. Enable with `notifications: true` and trigger via `hot.getPlugin('notifications').showMessage(...)`. See the plugin guide for placement, severity levels, and auto-dismiss timing: https://handsontable.com/docs/react-data-grid/notification/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Events & Hooks
|
||||||
|
|
||||||
|
Handsontable hooks are passed as props on `<HotTable>`:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
<HotTable
|
||||||
|
afterChange={(changes, source) => {
|
||||||
|
if (source !== 'loadData') {
|
||||||
|
console.log('Cell changed:', changes);
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
beforeChange={(changes, source) => {
|
||||||
|
// Return false to cancel the edit
|
||||||
|
}}
|
||||||
|
afterSelection={(row, col, row2, col2) => {
|
||||||
|
console.log('Selected:', row, col, 'to', row2, col2);
|
||||||
|
}}
|
||||||
|
/>
|
||||||
|
```
|
||||||
|
|
||||||
|
There are 100+ hooks available. Full reference: https://handsontable.com/docs/react-data-grid/api/hooks/
|
||||||
|
|
||||||
|
Guide: https://handsontable.com/docs/react-data-grid/events-and-hooks/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Accessing the Instance (Ref)
|
||||||
|
|
||||||
|
Use a ref to call Handsontable's core methods:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
import { useRef } from 'react';
|
||||||
|
|
||||||
|
const MyGrid = () => {
|
||||||
|
const hotRef = useRef(null);
|
||||||
|
|
||||||
|
const handleClick = () => {
|
||||||
|
const hot = hotRef.current?.hotInstance;
|
||||||
|
if (hot) {
|
||||||
|
console.log(hot.getData()); // get all data
|
||||||
|
hot.selectCell(0, 0); // select a cell
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
return (
|
||||||
|
<>
|
||||||
|
<HotTable ref={hotRef} /* ...options */ />
|
||||||
|
<button onClick={handleClick}>Get Data</button>
|
||||||
|
</>
|
||||||
|
);
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
Core API reference: https://handsontable.com/docs/react-data-grid/api/core/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Performance & Large Datasets
|
||||||
|
|
||||||
|
Handsontable virtualizes rendering automatically — only visible rows and columns are in the DOM, so
|
||||||
|
grids with 10k–100k+ rows perform well out of the box. For bulk programmatic updates, wrap mutations
|
||||||
|
in `batch()` to defer re-rendering until all changes are applied:
|
||||||
|
|
||||||
|
```jsx
|
||||||
|
hotRef.current.hotInstance.batch(() => {
|
||||||
|
// set many cells, add rows, etc.
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
For further tuning (disabling auto-size, reducing plugin overhead), see:
|
||||||
|
- [Performance guide](https://handsontable.com/docs/react-data-grid/performance/)
|
||||||
|
- [Batch operations](https://handsontable.com/docs/react-data-grid/batch-operations/)
|
||||||
|
- [Bundle size optimization](https://handsontable.com/docs/react-data-grid/bundle-size/)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recipes (v17+)
|
||||||
|
|
||||||
|
Handsontable v17 introduced a Recipes section in the docs — ready-made patterns for common use cases
|
||||||
|
(data validation workflows, dynamic column generation, etc.). Check the recipes index before building
|
||||||
|
something from scratch: https://handsontable.com/docs/react-data-grid/recipes/
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Common Pitfalls
|
||||||
|
|
||||||
|
- **Forgetting `height`**: The grid won't render without a `height` prop. Use `"auto"`, a pixel value, or a CSS string.
|
||||||
|
- **Not filtering `loadData` in `afterChange`**: The `afterChange` hook fires on initial data load with `source === 'loadData'`. Always check the source to avoid infinite loops when syncing changes back to state.
|
||||||
|
- **Using the old wrapper packages**: v17 removed `@handsontable/react` and `@handsontable/angular`. Use `@handsontable/react-wrapper` and `@handsontable/angular-wrapper`.
|
||||||
|
- **Using legacy CSS imports**: `handsontable.full.min.css` was removed in v17. Use `handsontable/styles/handsontable.min.css` plus a theme file.
|
||||||
|
- **Formulas with nested object data**: HyperFormula formulas don't work when `data` is an array of nested objects — use flat objects or arrays of arrays.
|
||||||
|
- **ExportFile `columnHeaders` renamed**: In v17.1 the ExportFile plugin's `columnHeaders` option was renamed to `colHeaders` to match the table-level option. Update any `exportAsString` / `exportAsBlob` / `downloadFile` calls that pass `columnHeaders: ...`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Version Awareness
|
||||||
|
|
||||||
|
Handsontable docs are versioned. The latest docs live at `/docs/react-data-grid/` (which redirects
|
||||||
|
to the current version). To link to a specific version, use `/docs/17.0/react-data-grid/`.
|
||||||
|
|
||||||
|
When helping a user, check which version they are on — breaking changes between major versions are
|
||||||
|
common. Point them to the relevant migration guide if they're upgrading.
|
||||||
|
|
||||||
|
For the full organized directory of documentation links, read `references/docs-map.md` in this
|
||||||
|
skill's folder.
|
||||||
|
|
||||||
|
### v17.1 changes (latest, May 2026)
|
||||||
|
|
||||||
|
- **New plugins:** DataProvider (server-side row loading via `dataProvider` option), Notification (toast notifications).
|
||||||
|
- **NestedHeaders rowspan:** column headers can now span multiple header rows.
|
||||||
|
- **ExportFile:** XLSX export added; the `columnHeaders` option was renamed to `colHeaders` (see Common Pitfalls).
|
||||||
|
- **Angular wrapper:** modernized for Angular 17–19; simpler setup, fewer deps.
|
||||||
|
- **Touch:** long-press now opens the context menu on touch devices.
|
||||||
|
- **TypeScript:** `dateFormat` option now accepts `Intl.DateTimeFormatOptions`.
|
||||||
|
- No removals or deprecations in v17.1.
|
||||||
|
|
||||||
|
### v17.0 Breaking Changes
|
||||||
|
|
||||||
|
- Removed legacy wrapper packages (`@handsontable/react`, `@handsontable/angular`). Use
|
||||||
|
`@handsontable/react-wrapper` and `@handsontable/angular-wrapper`.
|
||||||
|
- Removed legacy CSS (`handsontable.full.min.css`). Use `handsontable/styles/` imports.
|
||||||
|
- Removed core-js from dependencies.
|
||||||
|
- Removed the PersistentState plugin.
|
||||||
|
- Deprecated bundled HyperFormula (will require separate install in v18).
|
||||||
|
- Deprecated numbro.js, Pikaday, moment.js, DOMPurify — use native alternatives.
|
||||||
|
|
||||||
|
Migration guide: https://handsontable.com/docs/react-data-grid/migration-from-16.2-to-17.0/
|
||||||
@@ -0,0 +1,231 @@
|
|||||||
|
# Handsontable Documentation Map
|
||||||
|
|
||||||
|
> Last verified: May 2026 · Aligned with Handsontable 17.1.0
|
||||||
|
|
||||||
|
Organized link directory for all Handsontable and HyperFormula (in-grid) documentation. Use these
|
||||||
|
to point users to the right page. Links default to the React docs; replace `react-data-grid` with
|
||||||
|
`javascript-data-grid`, `angular-data-grid`, or prefix with `vue3-` for other frameworks.
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
- Installation: https://handsontable.com/docs/react-data-grid/installation/
|
||||||
|
- Demo: https://handsontable.com/docs/react-data-grid/demo/
|
||||||
|
- Binding to data: https://handsontable.com/docs/react-data-grid/binding-to-data/
|
||||||
|
- Server-side data fetching (DataProvider, v17.1+): https://handsontable.com/docs/react-data-grid/server-side-data-fetching/
|
||||||
|
- Saving data: https://handsontable.com/docs/react-data-grid/saving-data/
|
||||||
|
- Configuration options guide: https://handsontable.com/docs/react-data-grid/configuration-options/
|
||||||
|
- Grid size: https://handsontable.com/docs/react-data-grid/grid-size/
|
||||||
|
- Instance methods: https://handsontable.com/docs/react-data-grid/instance-methods/
|
||||||
|
- Events and hooks: https://handsontable.com/docs/react-data-grid/events-and-hooks/
|
||||||
|
- License key: https://handsontable.com/docs/react-data-grid/license-key/
|
||||||
|
- Redux integration: https://handsontable.com/docs/react-data-grid/redux/
|
||||||
|
|
||||||
|
## Styling & Themes
|
||||||
|
- Themes guide: https://handsontable.com/docs/react-data-grid/themes/
|
||||||
|
- Design system (Figma): https://handsontable.com/docs/react-data-grid/handsontable-design-system/
|
||||||
|
- Theme customization (CSS vars, tokens): https://handsontable.com/docs/react-data-grid/theme-customization/
|
||||||
|
- Legacy style (pre-v15): https://handsontable.com/docs/react-data-grid/legacy-style/
|
||||||
|
- Theme Builder tool: https://handsontable.com/theme-builder
|
||||||
|
- Figma Theme Generator: https://github.com/handsontable/handsontable-figma
|
||||||
|
|
||||||
|
## Columns
|
||||||
|
- HotColumn component (React): https://handsontable.com/docs/react-data-grid/hot-column/
|
||||||
|
- Column headers: https://handsontable.com/docs/react-data-grid/column-header/
|
||||||
|
- Column groups (nested headers): https://handsontable.com/docs/react-data-grid/column-groups/
|
||||||
|
- Column hiding: https://handsontable.com/docs/react-data-grid/column-hiding/
|
||||||
|
- Column moving: https://handsontable.com/docs/react-data-grid/column-moving/
|
||||||
|
- Column freezing: https://handsontable.com/docs/react-data-grid/column-freezing/
|
||||||
|
- Column widths: https://handsontable.com/docs/react-data-grid/column-width/
|
||||||
|
- Column summary: https://handsontable.com/docs/react-data-grid/column-summary/
|
||||||
|
- Column virtualization: https://handsontable.com/docs/react-data-grid/column-virtualization/
|
||||||
|
- Column menu (dropdown): https://handsontable.com/docs/react-data-grid/column-menu/
|
||||||
|
- Column filter: https://handsontable.com/docs/react-data-grid/column-filter/
|
||||||
|
|
||||||
|
## Rows
|
||||||
|
- Row headers: https://handsontable.com/docs/react-data-grid/row-header/
|
||||||
|
- Row parent-child (nested rows): https://handsontable.com/docs/react-data-grid/row-parent-child/
|
||||||
|
- Row hiding: https://handsontable.com/docs/react-data-grid/row-hiding/
|
||||||
|
- Row moving: https://handsontable.com/docs/react-data-grid/row-moving/
|
||||||
|
- Row freezing: https://handsontable.com/docs/react-data-grid/row-freezing/
|
||||||
|
- Row heights: https://handsontable.com/docs/react-data-grid/row-height/
|
||||||
|
- Row virtualization: https://handsontable.com/docs/react-data-grid/row-virtualization/
|
||||||
|
- Rows sorting: https://handsontable.com/docs/react-data-grid/rows-sorting/
|
||||||
|
- Rows pagination: https://handsontable.com/docs/react-data-grid/rows-pagination/
|
||||||
|
- Row trimming: https://handsontable.com/docs/react-data-grid/row-trimming/
|
||||||
|
- Row pre-populating: https://handsontable.com/docs/react-data-grid/row-prepopulating/
|
||||||
|
|
||||||
|
## Cell Features
|
||||||
|
- Clipboard (copy/paste): https://handsontable.com/docs/react-data-grid/basic-clipboard/
|
||||||
|
- Selection: https://handsontable.com/docs/react-data-grid/selection/
|
||||||
|
- Merge cells: https://handsontable.com/docs/react-data-grid/merge-cells/
|
||||||
|
- Conditional formatting: https://handsontable.com/docs/react-data-grid/conditional-formatting/
|
||||||
|
- Text alignment: https://handsontable.com/docs/react-data-grid/text-alignment/
|
||||||
|
- Disabled cells: https://handsontable.com/docs/react-data-grid/disabled-cells/
|
||||||
|
- Comments: https://handsontable.com/docs/react-data-grid/comments/
|
||||||
|
- Autofill values: https://handsontable.com/docs/react-data-grid/autofill-values/
|
||||||
|
- Formatting cells: https://handsontable.com/docs/react-data-grid/formatting-cells/
|
||||||
|
|
||||||
|
## Cell Functions
|
||||||
|
- Cell functions overview: https://handsontable.com/docs/react-data-grid/cell-function/
|
||||||
|
- Cell renderer: https://handsontable.com/docs/react-data-grid/cell-renderer/
|
||||||
|
- Cell editor: https://handsontable.com/docs/react-data-grid/cell-editor/
|
||||||
|
- Cell validator: https://handsontable.com/docs/react-data-grid/cell-validator/
|
||||||
|
- Custom cells (v17+): https://handsontable.com/docs/react-data-grid/custom-cells/
|
||||||
|
|
||||||
|
## Cell Types
|
||||||
|
- Cell type overview: https://handsontable.com/docs/react-data-grid/cell-type/
|
||||||
|
- Numeric: https://handsontable.com/docs/react-data-grid/numeric-cell-type/
|
||||||
|
- Date: https://handsontable.com/docs/react-data-grid/date-cell-type/
|
||||||
|
- Time: https://handsontable.com/docs/react-data-grid/time-cell-type/
|
||||||
|
- Checkbox: https://handsontable.com/docs/react-data-grid/checkbox-cell-type/
|
||||||
|
- Select: https://handsontable.com/docs/react-data-grid/select-cell-type/
|
||||||
|
- Dropdown: https://handsontable.com/docs/react-data-grid/dropdown-cell-type/
|
||||||
|
- Autocomplete: https://handsontable.com/docs/react-data-grid/autocomplete-cell-type/
|
||||||
|
- MultiSelect (v17+): https://handsontable.com/docs/react-data-grid/multiselect-cell-type/
|
||||||
|
- Password: https://handsontable.com/docs/react-data-grid/password-cell-type/
|
||||||
|
- Handsontable (nested grid): https://handsontable.com/docs/react-data-grid/handsontable-cell-type/
|
||||||
|
|
||||||
|
## Formulas (HyperFormula in Handsontable)
|
||||||
|
- Formula calculation guide: https://handsontable.com/docs/react-data-grid/formula-calculation/
|
||||||
|
- Formulas plugin API: https://handsontable.com/docs/react-data-grid/api/formulas/
|
||||||
|
- HyperFormula built-in functions list: https://hyperformula.handsontable.com/docs/guide/built-in-functions.html
|
||||||
|
- HyperFormula configuration options: https://hyperformula.handsontable.com/docs/guide/configuration-options.html
|
||||||
|
- HyperFormula custom functions: https://hyperformula.handsontable.com/docs/guide/custom-functions.html
|
||||||
|
- HyperFormula named expressions: https://hyperformula.handsontable.com/docs/guide/cell-references.html#relative-references
|
||||||
|
- HyperFormula license key: https://hyperformula.handsontable.com/docs/guide/license-key.html
|
||||||
|
|
||||||
|
## Navigation
|
||||||
|
- Keyboard shortcuts: https://handsontable.com/docs/react-data-grid/keyboard-shortcuts/
|
||||||
|
- Custom shortcuts: https://handsontable.com/docs/react-data-grid/custom-shortcuts/
|
||||||
|
- Focus scopes: https://handsontable.com/docs/react-data-grid/focus-scopes/
|
||||||
|
- Searching values: https://handsontable.com/docs/react-data-grid/searching-values/
|
||||||
|
|
||||||
|
## Accessibility
|
||||||
|
- Accessibility guide: https://handsontable.com/docs/react-data-grid/accessibility/
|
||||||
|
|
||||||
|
## Menus & Accessories
|
||||||
|
- Context menu: https://handsontable.com/docs/react-data-grid/context-menu/
|
||||||
|
- Undo and redo: https://handsontable.com/docs/react-data-grid/undo-redo/
|
||||||
|
- Icon pack: https://handsontable.com/docs/react-data-grid/icon-pack/
|
||||||
|
- Export to CSV: https://handsontable.com/docs/react-data-grid/export-to-csv/
|
||||||
|
- Export to Excel/XLSX (v17.1+): https://handsontable.com/docs/react-data-grid/export-to-excel/
|
||||||
|
- Notification (v17.1+): https://handsontable.com/docs/react-data-grid/notification/
|
||||||
|
- Empty data state: https://handsontable.com/docs/react-data-grid/empty-data-state/
|
||||||
|
|
||||||
|
## Dialog & Loading
|
||||||
|
- Dialog: https://handsontable.com/docs/react-data-grid/dialog/
|
||||||
|
- Loading indicator: https://handsontable.com/docs/react-data-grid/loading/
|
||||||
|
|
||||||
|
## Internationalization
|
||||||
|
- Language: https://handsontable.com/docs/react-data-grid/language/
|
||||||
|
- Locale: https://handsontable.com/docs/react-data-grid/locale/
|
||||||
|
- Layout direction (RTL/LTR): https://handsontable.com/docs/react-data-grid/layout-direction/
|
||||||
|
- IME support: https://handsontable.com/docs/react-data-grid/ime-support/
|
||||||
|
|
||||||
|
## Tools & Building
|
||||||
|
- Modules (tree-shaking): https://handsontable.com/docs/react-data-grid/modules/
|
||||||
|
- Custom plugins: https://handsontable.com/docs/react-data-grid/custom-plugins/
|
||||||
|
- Custom builds: https://handsontable.com/docs/react-data-grid/custom-builds/
|
||||||
|
- Testing: https://handsontable.com/docs/react-data-grid/testing/
|
||||||
|
|
||||||
|
## Optimization
|
||||||
|
- Batch operations: https://handsontable.com/docs/react-data-grid/batch-operations/
|
||||||
|
- Performance: https://handsontable.com/docs/react-data-grid/performance/
|
||||||
|
- Bundle size: https://handsontable.com/docs/react-data-grid/bundle-size/
|
||||||
|
|
||||||
|
## Security
|
||||||
|
- Security guide: https://handsontable.com/docs/react-data-grid/security/
|
||||||
|
|
||||||
|
## API Reference
|
||||||
|
- API overview: https://handsontable.com/docs/react-data-grid/api/
|
||||||
|
- Core (instance methods): https://handsontable.com/docs/react-data-grid/api/core/
|
||||||
|
- Hooks (all events): https://handsontable.com/docs/react-data-grid/api/hooks/
|
||||||
|
- Configuration options (all props): https://handsontable.com/docs/react-data-grid/api/options/
|
||||||
|
- Plugins index: https://handsontable.com/docs/react-data-grid/api/plugins/
|
||||||
|
|
||||||
|
### Individual Plugin APIs
|
||||||
|
- AutoColumnSize: https://handsontable.com/docs/react-data-grid/api/auto-column-size/
|
||||||
|
- AutoRowSize: https://handsontable.com/docs/react-data-grid/api/auto-row-size/
|
||||||
|
- Autofill: https://handsontable.com/docs/react-data-grid/api/autofill/
|
||||||
|
- BindRowsWithHeaders: https://handsontable.com/docs/react-data-grid/api/bind-rows-with-headers/
|
||||||
|
- CollapsibleColumns: https://handsontable.com/docs/react-data-grid/api/collapsible-columns/
|
||||||
|
- ColumnSorting: https://handsontable.com/docs/react-data-grid/api/column-sorting/
|
||||||
|
- ColumnSummary: https://handsontable.com/docs/react-data-grid/api/column-summary/
|
||||||
|
- Comments: https://handsontable.com/docs/react-data-grid/api/comments/
|
||||||
|
- ContextMenu: https://handsontable.com/docs/react-data-grid/api/context-menu/
|
||||||
|
- CopyPaste: https://handsontable.com/docs/react-data-grid/api/copy-paste/
|
||||||
|
- CustomBorders: https://handsontable.com/docs/react-data-grid/api/custom-borders/
|
||||||
|
- DataProvider (v17.1+): https://handsontable.com/docs/react-data-grid/api/data-provider/
|
||||||
|
- Dialog: https://handsontable.com/docs/react-data-grid/api/dialog/
|
||||||
|
- DragToScroll: https://handsontable.com/docs/react-data-grid/api/drag-to-scroll/
|
||||||
|
- DropdownMenu: https://handsontable.com/docs/react-data-grid/api/dropdown-menu/
|
||||||
|
- EmptyDataState: https://handsontable.com/docs/react-data-grid/api/empty-data-state/
|
||||||
|
- ExportFile: https://handsontable.com/docs/react-data-grid/api/export-file/
|
||||||
|
- Filters: https://handsontable.com/docs/react-data-grid/api/filters/
|
||||||
|
- Formulas: https://handsontable.com/docs/react-data-grid/api/formulas/
|
||||||
|
- HiddenColumns: https://handsontable.com/docs/react-data-grid/api/hidden-columns/
|
||||||
|
- HiddenRows: https://handsontable.com/docs/react-data-grid/api/hidden-rows/
|
||||||
|
- Loading: https://handsontable.com/docs/react-data-grid/api/loading/
|
||||||
|
- ManualColumnFreeze: https://handsontable.com/docs/react-data-grid/api/manual-column-freeze/
|
||||||
|
- ManualColumnMove: https://handsontable.com/docs/react-data-grid/api/manual-column-move/
|
||||||
|
- ManualColumnResize: https://handsontable.com/docs/react-data-grid/api/manual-column-resize/
|
||||||
|
- ManualRowMove: https://handsontable.com/docs/react-data-grid/api/manual-row-move/
|
||||||
|
- ManualRowResize: https://handsontable.com/docs/react-data-grid/api/manual-row-resize/
|
||||||
|
- MergeCells: https://handsontable.com/docs/react-data-grid/api/merge-cells/
|
||||||
|
- MultiColumnSorting: https://handsontable.com/docs/react-data-grid/api/multi-column-sorting/
|
||||||
|
- NestedHeaders: https://handsontable.com/docs/react-data-grid/api/nested-headers/
|
||||||
|
- NestedRows: https://handsontable.com/docs/react-data-grid/api/nested-rows/
|
||||||
|
- Notification (v17.1+): https://handsontable.com/docs/react-data-grid/api/notification/
|
||||||
|
- Pagination: https://handsontable.com/docs/react-data-grid/api/pagination/
|
||||||
|
- Search: https://handsontable.com/docs/react-data-grid/api/search/
|
||||||
|
- StretchColumns: https://handsontable.com/docs/react-data-grid/api/stretch-columns/
|
||||||
|
- TrimRows: https://handsontable.com/docs/react-data-grid/api/trim-rows/
|
||||||
|
- UndoRedo: https://handsontable.com/docs/react-data-grid/api/undo-redo/
|
||||||
|
|
||||||
|
## Recipes (new in v17)
|
||||||
|
- Recipes index: https://handsontable.com/docs/react-data-grid/recipes/
|
||||||
|
- Load data from a REST API (DataProvider, v17.1+): https://handsontable.com/docs/react-data-grid/recipes/data-management/load-data-rest-api/
|
||||||
|
|
||||||
|
## Upgrade & Migration
|
||||||
|
- Changelog: https://handsontable.com/docs/react-data-grid/changelog/
|
||||||
|
- Versioning policy: https://handsontable.com/docs/react-data-grid/versioning-policy/
|
||||||
|
- Deprecation policy: https://handsontable.com/docs/react-data-grid/deprecation-policy/
|
||||||
|
- Long Term Support (LTS): https://handsontable.com/docs/react-data-grid/long-term-support/
|
||||||
|
- 16.2 → 17.0 migration: https://handsontable.com/docs/react-data-grid/migration-from-16.2-to-17.0/
|
||||||
|
- 16.0 → 16.1 migration: https://handsontable.com/docs/react-data-grid/migration-from-16.0-to-16.1/
|
||||||
|
- 15.3 → 16.0 migration: https://handsontable.com/docs/react-data-grid/migration-from-15.3-to-16.0/
|
||||||
|
- 14.6 → 15.0 migration: https://handsontable.com/docs/react-data-grid/migration-from-14.6-to-15.0/
|
||||||
|
|
||||||
|
## Other Framework Installation
|
||||||
|
- JavaScript: https://handsontable.com/docs/javascript-data-grid/installation/
|
||||||
|
- Angular: https://handsontable.com/docs/angular-data-grid/installation/
|
||||||
|
- Vue 3: https://handsontable.com/docs/react-data-grid/vue3-installation/
|
||||||
|
|
||||||
|
## SSR Examples (CodeSandbox)
|
||||||
|
- Next.js: https://codesandbox.io/p/sandbox/kwnjph?file=https://handsontable.com/codesandbox-vm?example-dir=next.js&handsontable-version=17.1preview=true
|
||||||
|
- Astro: https://codesandbox.io/p/sandbox/gnqcwn?file=https://handsontable.com/codesandbox-vm?example-dir=astro&handsontable-version=17.1preview=true
|
||||||
|
- Remix: https://codesandbox.io/p/sandbox/njcjlq?file=https://handsontable.com/codesandbox-vm?example-dir=remix&handsontable-version=17.1preview=true
|
||||||
|
- Nuxt: https://codesandbox.io/p/sandbox/r7qsjc?file=https://handsontable.com/codesandbox-vm?example-dir=nuxt&handsontable-version=17.1preview=true
|
||||||
|
|
||||||
|
## CDN Links (jsDelivr) — latest
|
||||||
|
- JS (full bundle): https://cdn.jsdelivr.net/npm/handsontable/dist/handsontable.full.min.js
|
||||||
|
- Base CSS: https://cdn.jsdelivr.net/npm/handsontable/styles/handsontable.min.css
|
||||||
|
- Theme Main: https://cdn.jsdelivr.net/npm/handsontable/styles/ht-theme-main.min.css
|
||||||
|
- Theme Horizon: https://cdn.jsdelivr.net/npm/handsontable/styles/ht-theme-horizon.min.css
|
||||||
|
- Theme Classic: https://cdn.jsdelivr.net/npm/handsontable/styles/ht-theme-classic.min.css
|
||||||
|
- React wrapper: https://cdn.jsdelivr.net/npm/@handsontable/react-wrapper/dist/react-handsontable.min.js
|
||||||
|
- HyperFormula: https://cdn.jsdelivr.net/npm/hyperformula/dist/hyperformula.full.min.js
|
||||||
|
|
||||||
|
Pin versions by adding `@17.1` after the package name (e.g., `handsontable@17.1`).
|
||||||
|
|
||||||
|
## Package Registries
|
||||||
|
- npm: https://www.npmjs.com/package/handsontable
|
||||||
|
- NuGet: https://www.nuget.org/packages/handsontable
|
||||||
|
|
||||||
|
## Community & Support
|
||||||
|
- Developer Forum: https://forum.handsontable.com/
|
||||||
|
- GitHub Issues: https://github.com/handsontable/handsontable/issues
|
||||||
|
- Stack Overflow: https://stackoverflow.com/tags/handsontable
|
||||||
|
- Commercial support: support@handsontable.com
|
||||||
|
- Contact form: https://handsontable.com/contact
|
||||||
|
- Blog / Release Notes: https://handsontable.com/blog/categories/release-notes
|
||||||
|
- Download page: https://handsontable.com/download
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
# @handsontable/hyperformula-skill
|
||||||
|
|
||||||
|
An agent skill for [**HyperFormula**](https://hyperformula.handsontable.com) — the headless, open-source TypeScript spreadsheet calculation engine. It gives any AI coding agent deep, task-oriented knowledge of HyperFormula so the agent can help you integrate, configure, and debug the engine faster.
|
||||||
|
|
||||||
|
This package is the npm distribution of the `hyperformula` skill maintained in [`handsontable/handsontable-skills`](https://github.com/handsontable/handsontable-skills). The package version tracks the HyperFormula product version the skill targets (e.g. `3.3.0` targets HyperFormula 3.3.0).
|
||||||
|
|
||||||
|
## What's in the package
|
||||||
|
|
||||||
|
A self-contained skill — plain markdown, no runtime dependencies:
|
||||||
|
|
||||||
|
```
|
||||||
|
SKILL.md ← entry point: concepts, routing, and a docs map (YAML frontmatter + body)
|
||||||
|
references/ ← task-oriented deep-dives the agent reads on demand
|
||||||
|
```
|
||||||
|
|
||||||
|
`SKILL.md` follows the [Agent Skills](https://claude.com/blog/skills) layout (a YAML frontmatter block with `name`/`description`, followed by markdown instructions). Any agent that can load a skill — or simply read a folder of markdown instructions — can use it.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @handsontable/hyperformula-skill
|
||||||
|
```
|
||||||
|
|
||||||
|
The installed package lives at `node_modules/@handsontable/hyperformula-skill`. Resolve that path programmatically with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
node -p "require.resolve('@handsontable/hyperformula-skill/SKILL.md')"
|
||||||
|
```
|
||||||
|
|
||||||
|
Then make the skill available to your agent using whichever of the following matches it:
|
||||||
|
|
||||||
|
### Claude Code
|
||||||
|
|
||||||
|
Copy the package into a skills directory. User scope (available in every project):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cp -r node_modules/@handsontable/hyperformula-skill ~/.claude/skills/hyperformula
|
||||||
|
```
|
||||||
|
|
||||||
|
Or project scope, from your project root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cp -r node_modules/@handsontable/hyperformula-skill .claude/skills/hyperformula
|
||||||
|
```
|
||||||
|
|
||||||
|
### Claude API
|
||||||
|
|
||||||
|
Upload the package contents (`SKILL.md` + `references/`) to the [Skills API](https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview).
|
||||||
|
|
||||||
|
### OpenAI Codex
|
||||||
|
|
||||||
|
Codex discovers [skills](https://developers.openai.com/codex/skills) as folders containing a `SKILL.md`, under `~/.agents/skills` (available in every repo) or `.agents/skills` in a repo (checked in for your team). Copy the package into one of those locations:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# User scope — available in every repo
|
||||||
|
cp -r node_modules/@handsontable/hyperformula-skill ~/.agents/skills/hyperformula
|
||||||
|
|
||||||
|
# Repo scope — from your project root
|
||||||
|
cp -r node_modules/@handsontable/hyperformula-skill .agents/skills/hyperformula
|
||||||
|
```
|
||||||
|
|
||||||
|
Codex also follows symlinked skill folders, so you can instead link the installed package and let `npm install` keep it current:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ln -s "$PWD/node_modules/@handsontable/hyperformula-skill" ~/.agents/skills/hyperformula
|
||||||
|
```
|
||||||
|
|
||||||
|
### Any other agent
|
||||||
|
|
||||||
|
Most coding agents support a skills, rules, or knowledge directory. Copy (or symlink) the package folder into it, for example:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Replace <agent-skills-dir> with your agent's skills/knowledge directory
|
||||||
|
cp -r node_modules/@handsontable/hyperformula-skill <agent-skills-dir>/hyperformula
|
||||||
|
```
|
||||||
|
|
||||||
|
If your agent reads a single instruction file rather than a folder, point it at `SKILL.md`; it links the files under `references/` so the agent can pull them in as needed. For RAG / vector-store setups, ingest `SKILL.md` together with every file under `references/` (the repository also publishes a pre-flattened `hyperformula-rag.md` for this case).
|
||||||
|
|
||||||
|
## Other distribution formats
|
||||||
|
|
||||||
|
The same skill source is also shipped as a drag-and-drop `.zip` (Cowork / Claude.ai web), a flattened `-rag.md` doc (RAG / vector stores), and a Claude Code plugin marketplace entry. See the [repository README](https://github.com/handsontable/handsontable-skills#readme) for details.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
MIT — see the [repository](https://github.com/handsontable/handsontable-skills/blob/main/LICENSE.txt). HyperFormula itself is separately licensed (GPLv3 or commercial); see the [licensing guide](https://hyperformula.handsontable.com/docs/guide/licensing.html).
|
||||||
@@ -0,0 +1,134 @@
|
|||||||
|
---
|
||||||
|
name: hyperformula
|
||||||
|
description: >
|
||||||
|
Use this skill when the user works with HyperFormula (HF) — a headless,
|
||||||
|
open-source TypeScript spreadsheet calculation engine. Use it when the user:
|
||||||
|
mentions HyperFormula or HF; wants to integrate Excel-like formulas into a
|
||||||
|
JS/TS app; evaluate formulas programmatically in a browser or Node.js;
|
||||||
|
simulate spreadsheet or Excel calculation behavior server-side; run
|
||||||
|
calculations over data parsed from XLSX files (e.g. via SheetJS) in code;
|
||||||
|
build a pricing engine, financial model, or what-if analysis in code; define
|
||||||
|
custom spreadsheet functions or named expressions outside of a UI context. Do
|
||||||
|
NOT use this skill for: general Excel questions unrelated to HF; general
|
||||||
|
Google Sheets questions; generic spreadsheet formula-syntax questions outside
|
||||||
|
an HF context; formulas used inside Handsontable (use the "handsontable"
|
||||||
|
skill instead).
|
||||||
|
---
|
||||||
|
|
||||||
|
# HyperFormula
|
||||||
|
|
||||||
|
HyperFormula is a **headless, open-source TypeScript spreadsheet calculation engine** for embedding spreadsheet logic in any JavaScript/TypeScript application (browser or Node.js). ~420 built-in functions, dependency graph, undo/redo, i18n (17 languages). Dual-licensed: GPLv3 or commercial.
|
||||||
|
|
||||||
|
- Docs: https://hyperformula.handsontable.com/
|
||||||
|
- npm: https://www.npmjs.com/package/hyperformula
|
||||||
|
- GitHub: https://github.com/handsontable/hyperformula
|
||||||
|
|
||||||
|
## Where to go next
|
||||||
|
|
||||||
|
Task-oriented references in `references/` (open the one that matches what the user is doing):
|
||||||
|
|
||||||
|
- [`getting-started.md`](references/getting-started.md) — how to install, create an instance (`buildFromArray` / `buildFromSheets` / `buildEmpty`), and work with cell addresses. Open this for onboarding questions and first-run errors.
|
||||||
|
- [`api-quickref.md`](references/api-quickref.md) — runnable examples for CRUD, rows/columns, sheets, exporting data, batching, named expressions, events, undo/redo, clipboard. Open this when implementing or debugging HF API calls.
|
||||||
|
- [`custom-functions.md`](references/custom-functions.md) — extending HyperFormula via `FunctionPlugin`: minimal plugin, argument types, volatile functions, range arguments, returning arrays, error handling, aliases, localized names. Open this when adding or debugging custom spreadsheet functions.
|
||||||
|
- [`configuration.md`](references/configuration.md) — `ConfigParams` options, Excel-compatibility preset, Google-Sheets preset, and config-related pitfalls (separator collisions, Node ICU, `precisionRounding` change in v3). Open this when tuning behavior or diagnosing locale issues.
|
||||||
|
- [`vue3.md`](references/vue3.md) — Vue 3 integration: `markRaw` requirement, Composition API, Pinia/Vuex stores, `destroy()` on unmount. Open this when embedding HF in a Vue 3 app.
|
||||||
|
- [`error-handling.md`](references/error-handling.md) — inspecting `CellError`, `ErrorType` enum, `getCellValueDetailedType`, common error causes (`#NAME?`, `#CYCLE!`, `#REF!`, …). Open this when a cell returns an error or you need to branch on result type.
|
||||||
|
- [`general-pitfalls.md`](references/general-pitfalls.md) — cross-cutting gotchas: `destroy()` lifecycle, forcing literal strings, Excel-parity caveats, hard limits. Open this when results look wrong or memory grows unboundedly.
|
||||||
|
|
||||||
|
Below this section is the **Documentation map** — the canonical directory of links to the official HyperFormula docs. Use it when pointing the user to authoritative material.
|
||||||
|
|
||||||
|
## Documentation map
|
||||||
|
|
||||||
|
All links resolve to `hyperformula.handsontable.com` unless noted.
|
||||||
|
|
||||||
|
### Introduction
|
||||||
|
- Welcome / Homepage: https://hyperformula.handsontable.com/
|
||||||
|
- Demo: https://hyperformula.handsontable.com/docs/guide/demo.html
|
||||||
|
|
||||||
|
### Overview
|
||||||
|
- Quality (test coverage, CI): https://hyperformula.handsontable.com/docs/guide/quality.html
|
||||||
|
- Supported browsers: https://hyperformula.handsontable.com/docs/guide/supported-browsers.html
|
||||||
|
- Dependencies: https://hyperformula.handsontable.com/docs/guide/dependencies.html
|
||||||
|
- Licensing (GPLv3 vs commercial): https://hyperformula.handsontable.com/docs/guide/licensing.html
|
||||||
|
- Support: https://hyperformula.handsontable.com/docs/guide/support.html
|
||||||
|
|
||||||
|
### Getting Started
|
||||||
|
- Client-side installation: https://hyperformula.handsontable.com/docs/guide/client-side-installation.html
|
||||||
|
- Server-side installation (Node.js): https://hyperformula.handsontable.com/docs/guide/server-side-installation.html
|
||||||
|
- Basic usage: https://hyperformula.handsontable.com/docs/guide/basic-usage.html
|
||||||
|
- Advanced usage: https://hyperformula.handsontable.com/docs/guide/advanced-usage.html
|
||||||
|
- Configuration options guide: https://hyperformula.handsontable.com/docs/guide/configuration-options.html
|
||||||
|
- License key setup: https://hyperformula.handsontable.com/docs/guide/license-key.html
|
||||||
|
|
||||||
|
### Framework Integration
|
||||||
|
- React: https://hyperformula.handsontable.com/docs/guide/integration-with-react.html
|
||||||
|
- Vue: https://hyperformula.handsontable.com/docs/guide/integration-with-vue.html
|
||||||
|
- Angular: https://hyperformula.handsontable.com/docs/guide/integration-with-angular.html
|
||||||
|
- Svelte: https://hyperformula.handsontable.com/docs/guide/integration-with-svelte.html
|
||||||
|
|
||||||
|
### Data Operations
|
||||||
|
- Basic operations (CRUD): https://hyperformula.handsontable.com/docs/guide/basic-operations.html
|
||||||
|
- Batch operations: https://hyperformula.handsontable.com/docs/guide/batch-operations.html
|
||||||
|
- Clipboard operations: https://hyperformula.handsontable.com/docs/guide/clipboard-operations.html
|
||||||
|
- Undo-redo: https://hyperformula.handsontable.com/docs/guide/undo-redo.html
|
||||||
|
- Sorting data: https://hyperformula.handsontable.com/docs/guide/sorting-data.html
|
||||||
|
|
||||||
|
### Formulas
|
||||||
|
- Specifications and limits: https://hyperformula.handsontable.com/docs/guide/specifications-and-limits.html
|
||||||
|
- Cell references (relative, absolute, mixed, cross-sheet): https://hyperformula.handsontable.com/docs/guide/cell-references.html
|
||||||
|
- Types of values: https://hyperformula.handsontable.com/docs/guide/types-of-values.html
|
||||||
|
- Types of errors: https://hyperformula.handsontable.com/docs/guide/types-of-errors.html
|
||||||
|
- Types of operators: https://hyperformula.handsontable.com/docs/guide/types-of-operators.html
|
||||||
|
- Order of precedence: https://hyperformula.handsontable.com/docs/guide/order-of-precendece.html
|
||||||
|
- Built-in functions (full list, ~400): https://hyperformula.handsontable.com/docs/guide/built-in-functions.html
|
||||||
|
- Volatile functions: https://hyperformula.handsontable.com/docs/guide/volatile-functions.html
|
||||||
|
- Named expressions: https://hyperformula.handsontable.com/docs/guide/named-expressions.html
|
||||||
|
- Array formulas / ARRAYFORMULA: https://hyperformula.handsontable.com/docs/guide/arrays.html
|
||||||
|
|
||||||
|
### Internationalization
|
||||||
|
- i18n features (17 languages): https://hyperformula.handsontable.com/docs/guide/i18n-features.html
|
||||||
|
- Localizing function names: https://hyperformula.handsontable.com/docs/guide/localizing-functions.html
|
||||||
|
- Date and time handling: https://hyperformula.handsontable.com/docs/guide/date-and-time-handling.html
|
||||||
|
|
||||||
|
### Compatibility
|
||||||
|
- Microsoft Excel compatibility: https://hyperformula.handsontable.com/docs/guide/compatibility-with-microsoft-excel.html
|
||||||
|
- Google Sheets compatibility: https://hyperformula.handsontable.com/docs/guide/compatibility-with-google-sheets.html
|
||||||
|
- Runtime differences (Excel & Sheets): https://hyperformula.handsontable.com/docs/guide/list-of-differences.html
|
||||||
|
|
||||||
|
### Advanced Topics
|
||||||
|
- Key concepts (AST, dependency graph, evaluation): https://hyperformula.handsontable.com/docs/guide/key-concepts.html
|
||||||
|
- Dependency graph: https://hyperformula.handsontable.com/docs/guide/dependency-graph.html
|
||||||
|
- Building & testing from source: https://hyperformula.handsontable.com/docs/guide/building.html
|
||||||
|
- Custom functions (FunctionPlugin): https://hyperformula.handsontable.com/docs/guide/custom-functions.html
|
||||||
|
- Performance: https://hyperformula.handsontable.com/docs/guide/performance.html
|
||||||
|
- Known limitations: https://hyperformula.handsontable.com/docs/guide/known-limitations.html
|
||||||
|
- File import: https://hyperformula.handsontable.com/docs/guide/file-import.html
|
||||||
|
|
||||||
|
### Upgrade & Migration
|
||||||
|
- Release notes / Changelog: https://hyperformula.handsontable.com/docs/guide/release-notes.html
|
||||||
|
- 0.6 → 1.0 migration: https://hyperformula.handsontable.com/docs/guide/migration-from-0.6-to-1.0.html
|
||||||
|
- 1.x → 2.0 migration: https://hyperformula.handsontable.com/docs/guide/migration-from-1.x-to-2.0.html
|
||||||
|
- 2.x → 3.0 migration: https://hyperformula.handsontable.com/docs/guide/migration-from-2.x-to-3.0.html
|
||||||
|
|
||||||
|
### API Reference
|
||||||
|
- API overview: https://hyperformula.handsontable.com/docs/api/
|
||||||
|
- HyperFormula class (all methods): https://hyperformula.handsontable.com/docs/api/classes/hyperformula.html
|
||||||
|
- ConfigParams interface (all options): https://hyperformula.handsontable.com/docs/api/interfaces/configparams.html
|
||||||
|
- Listeners interface (all events): https://hyperformula.handsontable.com/docs/api/interfaces/listeners.html
|
||||||
|
|
||||||
|
### npm
|
||||||
|
- npm page: https://www.npmjs.com/package/hyperformula
|
||||||
|
|
||||||
|
### Community & Support
|
||||||
|
- GitHub repo: https://github.com/handsontable/hyperformula
|
||||||
|
- GitHub Issues: https://github.com/handsontable/hyperformula/issues
|
||||||
|
- GitHub Discussions: https://github.com/handsontable/hyperformula/discussions
|
||||||
|
- Developer Forum: https://forum.handsontable.com/
|
||||||
|
- Commercial support: support@handsontable.com
|
||||||
|
- Sales (commercial license): sales@handsontable.com
|
||||||
|
- Contact form: https://handsontable.com/contact
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
> **Last updated: 2026-05-20 · Aligned with HyperFormula 3.3.0.**
|
||||||
|
> If the user is on a newer release, confirm API shape against the latest docs (see the **Release notes** link above) before relying on this file.
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
{
|
||||||
|
"name": "@handsontable/hyperformula-skill",
|
||||||
|
"version": "3.3.0",
|
||||||
|
"description": "Agent skill for HyperFormula — the headless, open-source TypeScript spreadsheet calculation engine. Teaches AI coding agents how to integrate, configure, and debug HyperFormula.",
|
||||||
|
"license": "MIT",
|
||||||
|
"author": "Handsontable <hello@handsontable.com> (https://handsontable.com)",
|
||||||
|
"homepage": "https://github.com/handsontable/handsontable-skills#readme",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/handsontable/handsontable-skills.git",
|
||||||
|
"directory": "skills/hyperformula"
|
||||||
|
},
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/handsontable/handsontable-skills/issues"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"agent-skill",
|
||||||
|
"claude-skill",
|
||||||
|
"claude",
|
||||||
|
"anthropic",
|
||||||
|
"ai",
|
||||||
|
"hyperformula",
|
||||||
|
"spreadsheet",
|
||||||
|
"formula-engine",
|
||||||
|
"handsontable"
|
||||||
|
],
|
||||||
|
"files": [
|
||||||
|
"SKILL.md",
|
||||||
|
"references/"
|
||||||
|
],
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,147 @@
|
|||||||
|
# API Quick Reference
|
||||||
|
|
||||||
|
Runnable examples for the most-used HyperFormula APIs. Authoritative docs:
|
||||||
|
- Basic operations: https://hyperformula.handsontable.com/docs/guide/basic-operations.html
|
||||||
|
- Batch operations: https://hyperformula.handsontable.com/docs/guide/batch-operations.html
|
||||||
|
- Named expressions: https://hyperformula.handsontable.com/docs/guide/named-expressions.html
|
||||||
|
- Clipboard operations: https://hyperformula.handsontable.com/docs/guide/clipboard-operations.html
|
||||||
|
- Undo-redo: https://hyperformula.handsontable.com/docs/guide/undo-redo.html
|
||||||
|
- Sorting data: https://hyperformula.handsontable.com/docs/guide/sorting-data.html
|
||||||
|
- HyperFormula class (all methods): https://hyperformula.handsontable.com/docs/api/classes/hyperformula.html
|
||||||
|
- Listeners (all events): https://hyperformula.handsontable.com/docs/api/interfaces/listeners.html
|
||||||
|
|
||||||
|
## CRUD
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// Write: string, number, or formula
|
||||||
|
hf.setCellContents({ sheet: 0, col: 0, row: 0 }, 'Hello');
|
||||||
|
hf.setCellContents({ sheet: 0, col: 1, row: 0 }, '=A1 & " World"');
|
||||||
|
|
||||||
|
// Read
|
||||||
|
hf.getCellValue({ sheet: 0, col: 1, row: 0 }); // computed result
|
||||||
|
hf.getCellFormula({ sheet: 0, col: 1, row: 0 }); // '=A1 & " World"'
|
||||||
|
hf.getCellType({ sheet: 0, col: 0, row: 0 }); // CellType.FORMULA | VALUE | EMPTY
|
||||||
|
```
|
||||||
|
|
||||||
|
## Rows and columns
|
||||||
|
|
||||||
|
Second arg is `[startIndex, count]`, not a list of indexes.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.addRows(sheetId, [rowIndex, numberOfRows]);
|
||||||
|
hf.removeRows(sheetId, [rowIndex, numberOfRows]);
|
||||||
|
hf.addColumns(sheetId, [colIndex, numberOfColumns]);
|
||||||
|
hf.removeColumns(sheetId, [colIndex, numberOfColumns]);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Sheets
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.addSheet('NewSheet');
|
||||||
|
hf.removeSheet(sheetId);
|
||||||
|
hf.renameSheet(sheetId, 'BetterName');
|
||||||
|
hf.countSheets();
|
||||||
|
hf.getSheetName(sheetId);
|
||||||
|
hf.getSheetId('SheetName');
|
||||||
|
hf.getSheetDimensions(sheetId); // → { width, height }
|
||||||
|
```
|
||||||
|
|
||||||
|
## Export data
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.getSheetValues(sheetId); // computed values as 2D array
|
||||||
|
hf.getSheetSerialized(sheetId); // formulas/raw values as 2D array
|
||||||
|
hf.getAllSheetsValues(); // { SheetName: values[][] }
|
||||||
|
hf.getAllSheetsSerialized(); // { SheetName: formulas[][] }
|
||||||
|
```
|
||||||
|
|
||||||
|
## Batch operations
|
||||||
|
|
||||||
|
Every `setCellContents` call triggers a full dependency-graph recalculation. Always batch when writing more than one cell.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// Preferred: batch() — returns ExportedChange[]
|
||||||
|
const changes = hf.batch(() => {
|
||||||
|
hf.setCellContents({ sheet: 0, col: 0, row: 0 }, '100');
|
||||||
|
hf.setCellContents({ sheet: 0, col: 0, row: 1 }, '200');
|
||||||
|
hf.addRows(0, [2, 1]);
|
||||||
|
});
|
||||||
|
// `changes` contains all cells that were recalculated.
|
||||||
|
|
||||||
|
// For bulk imports (value writes only):
|
||||||
|
hf.suspendEvaluation();
|
||||||
|
// ... hundreds of setCellContents calls ...
|
||||||
|
hf.resumeEvaluation(); // single recalc
|
||||||
|
|
||||||
|
// PITFALL: structural ops (addRows/moveRows/...) during suspendEvaluation
|
||||||
|
// have degraded performance. Use batch() when mixing structural + value writes.
|
||||||
|
```
|
||||||
|
|
||||||
|
## Sorting
|
||||||
|
|
||||||
|
`setRowOrder` takes a **permutation array**, not a comparator. Compute the new index sequence externally, then pass it in.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// Sort rows by the value in column 0
|
||||||
|
const rowCount = hf.getSheetDimensions(0).height;
|
||||||
|
const indexes = Array.from({ length: rowCount }, (_, i) => i);
|
||||||
|
indexes.sort((a, b) => {
|
||||||
|
const va = hf.getCellValue({ sheet: 0, col: 0, row: a }) as number;
|
||||||
|
const vb = hf.getCellValue({ sheet: 0, col: 0, row: b }) as number;
|
||||||
|
return va - vb;
|
||||||
|
});
|
||||||
|
hf.setRowOrder(0, indexes); // e.g. [2, 0, 1, 3]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Named expressions
|
||||||
|
|
||||||
|
Reusable names for values or formulas. Can be global or scoped to a sheet (local shadows global).
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.addNamedExpression('TAX_RATE', '0.21');
|
||||||
|
hf.addNamedExpression('TOTAL_REVENUE', '=SUM(Revenue!A:A)');
|
||||||
|
|
||||||
|
hf.setCellContents({ sheet: 0, col: 0, row: 0 }, '=1000 * TAX_RATE');
|
||||||
|
|
||||||
|
hf.listNamedExpressions(); // all registered names
|
||||||
|
```
|
||||||
|
|
||||||
|
## Custom functions
|
||||||
|
|
||||||
|
See [custom-functions.md](custom-functions.md) — `FunctionPlugin`, argument types, volatile functions, range arguments, returning arrays, error handling, aliases, localized names.
|
||||||
|
|
||||||
|
## Events
|
||||||
|
|
||||||
|
Subscribe via `.on()` on the instance. Full list: https://hyperformula.handsontable.com/docs/api/interfaces/listeners.html
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.on('valuesUpdated', (changes) => {
|
||||||
|
changes.forEach((c) => console.log(c.address, c.newValue));
|
||||||
|
});
|
||||||
|
|
||||||
|
hf.on('sheetAdded', (addedSheetName) => { /* ... */ });
|
||||||
|
hf.on('sheetRemoved', (removedSheetName, removedSheetData) => { /* ... */ });
|
||||||
|
hf.on('sheetRenamed', (oldName, newName) => { /* ... */ });
|
||||||
|
```
|
||||||
|
|
||||||
|
## Undo / redo
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.undo();
|
||||||
|
hf.redo();
|
||||||
|
hf.isThereSomethingToUndo();
|
||||||
|
hf.isThereSomethingToRedo();
|
||||||
|
hf.clearUndoStack();
|
||||||
|
```
|
||||||
|
|
||||||
|
Configure depth via `undoLimit` in `ConfigParams` (see [configuration.md](configuration.md)).
|
||||||
|
|
||||||
|
## Clipboard
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.copy({ start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 1 } });
|
||||||
|
hf.cut ({ start: { sheet: 0, col: 0, row: 0 }, end: { sheet: 0, col: 1, row: 1 } });
|
||||||
|
hf.paste({ sheet: 0, col: 5, row: 5 });
|
||||||
|
hf.isClipboardEmpty();
|
||||||
|
hf.clearClipboard();
|
||||||
|
```
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
# Configuration
|
||||||
|
|
||||||
|
`ConfigParams` + compatibility presets + config-specific pitfalls. Authoritative docs:
|
||||||
|
- Configuration options guide: https://hyperformula.handsontable.com/docs/guide/configuration-options.html
|
||||||
|
- ConfigParams (all options): https://hyperformula.handsontable.com/docs/api/interfaces/configparams.html
|
||||||
|
- Excel compatibility: https://hyperformula.handsontable.com/docs/guide/compatibility-with-microsoft-excel.html
|
||||||
|
- Google Sheets compatibility: https://hyperformula.handsontable.com/docs/guide/compatibility-with-google-sheets.html
|
||||||
|
|
||||||
|
## ConfigParams highlights
|
||||||
|
|
||||||
|
Pass as the second argument to any factory method.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const hf = HyperFormula.buildEmpty({
|
||||||
|
licenseKey: 'gpl-v3', // required — 'gpl-v3' for open source
|
||||||
|
precisionRounding: 10, // decimal rounding precision (default 10; was 14 before v3)
|
||||||
|
functionArgSeparator: ',', // separator between function arguments
|
||||||
|
dateFormats: ['DD/MM/YYYY', 'DD-MM-YYYY'],
|
||||||
|
nullDate: { year: 1900, month: 1, day: 1 },
|
||||||
|
leapYear1900: false, // Excel bug compat: treat 1900 as leap year
|
||||||
|
maxRows: 40000, // max rows per sheet (default 40000)
|
||||||
|
maxColumns: 18278, // max columns per sheet (default 18278 = 'ZZZ')
|
||||||
|
undoLimit: 20, // undo history depth
|
||||||
|
maxPendingLazyTransformations: 1000, // v3.3+ — cap accumulated lazy transformations before cleanup
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Excel compatibility preset
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const hf = HyperFormula.buildEmpty({
|
||||||
|
licenseKey: 'gpl-v3',
|
||||||
|
useArrayArithmetic: true,
|
||||||
|
useWildcards: true,
|
||||||
|
evaluateNullToZero: true,
|
||||||
|
leapYear1900: true, // Excel's intentional 1900 leap-year bug
|
||||||
|
ignoreWhiteSpace: 'any',
|
||||||
|
caseSensitive: false,
|
||||||
|
accentSensitive: true,
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Google Sheets compatibility preset
|
||||||
|
|
||||||
|
Defaults already match Google Sheets behavior (`leapYear1900: false`, `useArrayArithmetic: false`).
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const hf = HyperFormula.buildEmpty({ licenseKey: 'gpl-v3' });
|
||||||
|
```
|
||||||
|
|
||||||
|
## Config-specific pitfalls
|
||||||
|
|
||||||
|
### Vue 3
|
||||||
|
|
||||||
|
Vue 3 requires wrapping the instance with `markRaw` — see [vue3.md](vue3.md) for the full integration guide (React / Angular / Svelte need no special handling).
|
||||||
|
|
||||||
|
### `functionArgSeparator` vs `thousandSeparator` collision
|
||||||
|
|
||||||
|
These two options **cannot share a character**. European locales that use `,` as thousand separator must change the argument separator:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const hf = HyperFormula.buildEmpty({
|
||||||
|
licenseKey: 'gpl-v3',
|
||||||
|
thousandSeparator: ',',
|
||||||
|
decimalSeparator: '.',
|
||||||
|
functionArgSeparator: ';', // must differ from thousandSeparator
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
### Node.js must have full ICU
|
||||||
|
|
||||||
|
String comparisons (used in `MATCH`, `VLOOKUP`, sorting) can silently produce wrong results on Node.js < 13 or builds without full ICU. Verify at startup:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// Must report 'full' (or a detailed ICU version), not 'small'.
|
||||||
|
console.log(process.versions.icu);
|
||||||
|
```
|
||||||
|
|
||||||
|
### Tuning `maxPendingLazyTransformations` (v3.3+)
|
||||||
|
|
||||||
|
HyperFormula defers some structural transformations (row/column insertions, moves) and applies them lazily. In long-lived instances with heavy mutation throughput — bulk imports, frequent undo/redo, scripted batch edits — the pending queue can grow before cleanup. v3.3 fixed the unbounded-growth leak; this option lets you cap the queue explicitly. Lower values trade memory for more frequent flush work; the default is suitable for typical UI workloads.
|
||||||
|
|
||||||
|
### `precisionRounding` default changed in v3
|
||||||
|
|
||||||
|
Before v3 the default was `14`. It is now `10`. Calculations relying on the old precision need an explicit override:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const hf = HyperFormula.buildEmpty({
|
||||||
|
licenseKey: 'gpl-v3',
|
||||||
|
precisionRounding: 14, // pre-v3 behavior
|
||||||
|
});
|
||||||
|
```
|
||||||
@@ -0,0 +1,174 @@
|
|||||||
|
# Custom Functions
|
||||||
|
|
||||||
|
Extend HyperFormula with your own functions via `FunctionPlugin`. Authoritative doc:
|
||||||
|
- Custom functions guide: https://hyperformula.handsontable.com/docs/guide/custom-functions.html
|
||||||
|
|
||||||
|
## Minimal plugin
|
||||||
|
|
||||||
|
Register **before** creating any instance — functions registered after `buildFromArray` / `buildFromSheets` / `buildEmpty` won't be available.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { HyperFormula, FunctionPlugin, FunctionArgumentType } from 'hyperformula';
|
||||||
|
|
||||||
|
class MyPlugin extends FunctionPlugin {
|
||||||
|
greet(ast, state) {
|
||||||
|
return this.runFunction(
|
||||||
|
ast.args,
|
||||||
|
state,
|
||||||
|
this.metadata('GREET'),
|
||||||
|
(name) => `Hello, ${name}!`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
MyPlugin.implementedFunctions = {
|
||||||
|
GREET: {
|
||||||
|
method: 'greet',
|
||||||
|
parameters: [{ argumentType: FunctionArgumentType.STRING }],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
const translations = { enGB: { GREET: 'GREET' }, enUS: { GREET: 'GREET' } };
|
||||||
|
|
||||||
|
// PITFALL: registration MUST happen before any instance is built.
|
||||||
|
HyperFormula.registerFunctionPlugin(MyPlugin, translations);
|
||||||
|
|
||||||
|
const hf = HyperFormula.buildFromArray(
|
||||||
|
[['World', '=GREET(A1)']],
|
||||||
|
{ licenseKey: 'gpl-v3' }
|
||||||
|
);
|
||||||
|
console.log(hf.getCellValue({ sheet: 0, col: 1, row: 0 })); // "Hello, World!"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Volatile functions
|
||||||
|
|
||||||
|
Mark a function as volatile so it recalculates on every change (like `RAND` or `NOW`). Volatile functions are expensive in large sheets — use sparingly.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
MyPlugin.implementedFunctions = {
|
||||||
|
RAND_ID: {
|
||||||
|
method: 'randId',
|
||||||
|
parameters: [],
|
||||||
|
isVolatile: true,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Argument types
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { FunctionArgumentType } from 'hyperformula';
|
||||||
|
|
||||||
|
// FunctionArgumentType.NUMBER
|
||||||
|
// FunctionArgumentType.STRING
|
||||||
|
// FunctionArgumentType.BOOLEAN
|
||||||
|
// FunctionArgumentType.NOERROR
|
||||||
|
// FunctionArgumentType.SCALAR
|
||||||
|
// FunctionArgumentType.RANGE // accepts a cell range
|
||||||
|
// FunctionArgumentType.ANY
|
||||||
|
```
|
||||||
|
|
||||||
|
Use `optionalArg: true`, `defaultValue`, and `minValue` / `maxValue` to validate arguments declaratively:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
MyPlugin.implementedFunctions = {
|
||||||
|
CLAMP: {
|
||||||
|
method: 'clamp',
|
||||||
|
parameters: [
|
||||||
|
{ argumentType: FunctionArgumentType.NUMBER },
|
||||||
|
{ argumentType: FunctionArgumentType.NUMBER, optionalArg: true, defaultValue: 0 },
|
||||||
|
{ argumentType: FunctionArgumentType.NUMBER, optionalArg: true, defaultValue: 100 },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Range arguments
|
||||||
|
|
||||||
|
Use `RANGE` argument type when the function takes a cell area. The callback receives the range as a 2D array.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
class SumPositivesPlugin extends FunctionPlugin {
|
||||||
|
sumPositives(ast, state) {
|
||||||
|
return this.runFunction(
|
||||||
|
ast.args,
|
||||||
|
state,
|
||||||
|
this.metadata('SUM_POSITIVES'),
|
||||||
|
(range) => {
|
||||||
|
let total = 0;
|
||||||
|
for (const row of range.data) {
|
||||||
|
for (const v of row) if (typeof v === 'number' && v > 0) total += v;
|
||||||
|
}
|
||||||
|
return total;
|
||||||
|
}
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
SumPositivesPlugin.implementedFunctions = {
|
||||||
|
SUM_POSITIVES: {
|
||||||
|
method: 'sumPositives',
|
||||||
|
parameters: [{ argumentType: FunctionArgumentType.RANGE }],
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## Returning arrays
|
||||||
|
|
||||||
|
Custom functions can return 2D arrays. **PITFALL:** result arrays don't auto-resize when upstream dependencies change — the footprint is fixed at first evaluation.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
class SplitPlugin extends FunctionPlugin {
|
||||||
|
splitToRow(ast, state) {
|
||||||
|
return this.runFunction(
|
||||||
|
ast.args,
|
||||||
|
state,
|
||||||
|
this.metadata('SPLIT_ROW'),
|
||||||
|
(text, sep) => [text.split(sep)] // 2D array: one row, N cols
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Error handling
|
||||||
|
|
||||||
|
Return a `CellError` to signal a formula error:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { CellError, ErrorType } from 'hyperformula';
|
||||||
|
|
||||||
|
class DividePlugin extends FunctionPlugin {
|
||||||
|
safeDivide(ast, state) {
|
||||||
|
return this.runFunction(
|
||||||
|
ast.args,
|
||||||
|
state,
|
||||||
|
this.metadata('SAFE_DIVIDE'),
|
||||||
|
(a, b) => (b === 0 ? new CellError(ErrorType.DIV_BY_ZERO) : a / b)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Aliases and localized names
|
||||||
|
|
||||||
|
Expose one method under multiple function names, or localize:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
MyPlugin.aliases = {
|
||||||
|
HELLO: 'GREET', // calling =HELLO(x) runs the greet() method
|
||||||
|
};
|
||||||
|
|
||||||
|
const translations = {
|
||||||
|
enGB: { GREET: 'GREET' },
|
||||||
|
plPL: { GREET: 'POWITAJ' }, // =POWITAJ("Świat") in Polish
|
||||||
|
};
|
||||||
|
HyperFormula.registerFunctionPlugin(MyPlugin, translations);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Unregister / introspect
|
||||||
|
|
||||||
|
```ts
|
||||||
|
HyperFormula.unregisterFunctionPlugin(MyPlugin);
|
||||||
|
HyperFormula.unregisterFunction('GREET');
|
||||||
|
HyperFormula.getRegisteredFunctionNames('enGB');
|
||||||
|
```
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
# Error Handling
|
||||||
|
|
||||||
|
Inspect cell values that may be errors, tell error types apart, and check value shape. Authoritative docs:
|
||||||
|
- Types of errors: https://hyperformula.handsontable.com/docs/guide/types-of-errors.html
|
||||||
|
- Types of values: https://hyperformula.handsontable.com/docs/guide/types-of-values.html
|
||||||
|
|
||||||
|
## Always check `CellError` before using a result
|
||||||
|
|
||||||
|
Cell values can be errors (`#DIV/0!`, `#VALUE!`, `#REF!`, etc.). Always test before using a result.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { CellError, ErrorType } from 'hyperformula';
|
||||||
|
|
||||||
|
const value = hf.getCellValue({ sheet: 0, col: 0, row: 0 });
|
||||||
|
|
||||||
|
if (value instanceof CellError) {
|
||||||
|
// ErrorType enum: DIV_BY_ZERO, VALUE, REF, NAME, NUM, NA, CYCLE, ERROR
|
||||||
|
switch (value.type) {
|
||||||
|
case ErrorType.CYCLE:
|
||||||
|
console.log('Circular reference');
|
||||||
|
break;
|
||||||
|
case ErrorType.NAME:
|
||||||
|
// Usually: function not registered (check plugin registration or i18n language)
|
||||||
|
console.log('Unknown name:', value.message);
|
||||||
|
break;
|
||||||
|
default:
|
||||||
|
console.log('Error:', value.type, value.message);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
console.log('Value:', value);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## `#CYCLE!` is HyperFormula-specific
|
||||||
|
|
||||||
|
Standard spreadsheet apps report cycles differently. HyperFormula's `IF` also reports cycles for all branches, even unreachable ones — this can produce `#CYCLE!` in formulas that Excel or Sheets would evaluate.
|
||||||
|
|
||||||
|
## Inspect value shape without catching errors
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { CellValueDetailedType } from 'hyperformula';
|
||||||
|
|
||||||
|
hf.getCellValueDetailedType({ sheet: 0, col: 0, row: 0 });
|
||||||
|
// → CellValueDetailedType.NUMBER | STRING | BOOLEAN | ERROR | EMPTY | ...
|
||||||
|
```
|
||||||
|
|
||||||
|
Use the detailed type when you need to distinguish e.g. number vs empty without touching the value.
|
||||||
|
|
||||||
|
## Returning errors from custom functions
|
||||||
|
|
||||||
|
Custom `FunctionPlugin` methods can return a `CellError` to surface a formula error. See [custom-functions.md](custom-functions.md) for the full pattern.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { CellError, ErrorType } from 'hyperformula';
|
||||||
|
|
||||||
|
return new CellError(ErrorType.DIV_BY_ZERO);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common causes
|
||||||
|
|
||||||
|
| Error | Common cause |
|
||||||
|
|---|---|
|
||||||
|
| `#NAME?` | Function not registered (check `registerFunctionPlugin` order or `language` config) |
|
||||||
|
| `#CYCLE!` | Circular reference — or an `IF` branch that *could* produce one |
|
||||||
|
| `#REF!` | Deleted row/column broke a formula reference |
|
||||||
|
| `#VALUE!` | Type mismatch — e.g. passing a string where a number is expected |
|
||||||
|
| `#DIV/0!` | Division by zero, including empty cells coerced to 0 |
|
||||||
|
| `#NUM!` | Out-of-range numeric result (e.g. `SQRT(-1)`) |
|
||||||
|
| `#N/A` | Lookup miss (`MATCH`, `VLOOKUP`) or propagated from an upstream `#N/A` |
|
||||||
@@ -0,0 +1,48 @@
|
|||||||
|
# General Pitfalls
|
||||||
|
|
||||||
|
Cross-cutting gotchas that aren't tied to a specific API or config option. Authoritative docs:
|
||||||
|
- Known limitations: https://hyperformula.handsontable.com/docs/guide/known-limitations.html
|
||||||
|
- Built-in functions (full list): https://hyperformula.handsontable.com/docs/guide/built-in-functions.html
|
||||||
|
- Runtime differences vs Excel/Sheets: https://hyperformula.handsontable.com/docs/guide/list-of-differences.html
|
||||||
|
|
||||||
|
## Error handling
|
||||||
|
|
||||||
|
See [error-handling.md](error-handling.md) — checking `CellError`, `ErrorType` enum, `getCellValueDetailedType`, common error causes.
|
||||||
|
|
||||||
|
## Always call `destroy()` in long-running apps
|
||||||
|
|
||||||
|
HyperFormula maintains internal data structures (dependency graph, address mapping) that are **not** garbage-collected until `destroy()` is called. Leaking instances in servers or SPAs accumulates memory.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.destroy();
|
||||||
|
// After destroy() the instance is unusable — create a new one if needed.
|
||||||
|
```
|
||||||
|
|
||||||
|
v3.3 fixed two longstanding leak sources inside live instances — pending lazy transformations and undo/redo history were not being trimmed. If you maintain very long-lived instances with heavy mutation throughput, also see `maxPendingLazyTransformations` in [configuration.md](configuration.md) to bound the lazy-transformation queue. `destroy()` is still mandatory at teardown.
|
||||||
|
|
||||||
|
## Force a string that looks like a formula
|
||||||
|
|
||||||
|
Prefix with `'` (apostrophe) to store the literal text instead of evaluating.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
// Stored as the literal string "=SUM(1,2)", not a formula:
|
||||||
|
hf.setCellContents({ sheet: 0, col: 0, row: 0 }, "'=SUM(1,2)");
|
||||||
|
```
|
||||||
|
|
||||||
|
## Don't assume Excel parity
|
||||||
|
|
||||||
|
~68% of Excel functions are covered. Runtime differences exist even for implemented functions. Before relying on behavior, check:
|
||||||
|
|
||||||
|
- Full built-in list: https://hyperformula.handsontable.com/docs/guide/built-in-functions.html
|
||||||
|
- Runtime differences: https://hyperformula.handsontable.com/docs/guide/list-of-differences.html
|
||||||
|
|
||||||
|
## `licenseKey` is always required
|
||||||
|
|
||||||
|
Every factory method (`buildFromArray`, `buildFromSheets`, `buildEmpty`) requires `licenseKey`. Use `'gpl-v3'` for open-source use or your commercial key.
|
||||||
|
|
||||||
|
## Known hard limits
|
||||||
|
|
||||||
|
- **Single workbook per instance** — no multi-workbook support.
|
||||||
|
- No 3D references, dynamic arrays, async functions, structured references ("Tables"), or relative named expressions.
|
||||||
|
- `IF` reports cycles for all branches, even unreachable ones.
|
||||||
|
- Custom function result arrays don't auto-resize when dependencies change.
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
# Getting Started
|
||||||
|
|
||||||
|
Install, create an instance, read/write cells. Authoritative docs:
|
||||||
|
- Client-side install: https://hyperformula.handsontable.com/docs/guide/client-side-installation.html
|
||||||
|
- Server-side install: https://hyperformula.handsontable.com/docs/guide/server-side-installation.html
|
||||||
|
- Basic usage: https://hyperformula.handsontable.com/docs/guide/basic-usage.html
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
### npm
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install hyperformula
|
||||||
|
```
|
||||||
|
|
||||||
|
### CDN (jsDelivr, pinned version)
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script src="https://cdn.jsdelivr.net/npm/hyperformula@3.2.0/dist/hyperformula.full.min.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
|
### Node.js
|
||||||
|
|
||||||
|
Same npm install. Requires Node.js 13+ with full ICU for locale-aware string comparison.
|
||||||
|
|
||||||
|
## Create an instance
|
||||||
|
|
||||||
|
Every factory method requires `licenseKey`. Use `'gpl-v3'` for open-source use or your commercial key.
|
||||||
|
|
||||||
|
### `buildFromArray` — single sheet from a 2D array
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { HyperFormula } from 'hyperformula';
|
||||||
|
|
||||||
|
const hf = HyperFormula.buildFromArray(
|
||||||
|
[
|
||||||
|
['10', '20', '=SUM(A1:B1)'],
|
||||||
|
['30', '40', '=SUM(A2:B2)'],
|
||||||
|
],
|
||||||
|
{ licenseKey: 'gpl-v3' }
|
||||||
|
);
|
||||||
|
|
||||||
|
console.log(hf.getCellValue({ sheet: 0, col: 2, row: 0 })); // 30
|
||||||
|
```
|
||||||
|
|
||||||
|
### `buildFromSheets` — multi-sheet workbook
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const hf = HyperFormula.buildFromSheets(
|
||||||
|
{
|
||||||
|
Revenue: [['100', '200', '=SUM(A1:B1)']],
|
||||||
|
Expenses: [['50', '=Revenue!C1 - A1']],
|
||||||
|
},
|
||||||
|
{ licenseKey: 'gpl-v3' }
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
Cross-sheet references use `SheetName!CellRef` syntax.
|
||||||
|
|
||||||
|
### `buildEmpty` — start empty, add sheets later
|
||||||
|
|
||||||
|
```ts
|
||||||
|
const hf = HyperFormula.buildEmpty({ licenseKey: 'gpl-v3' });
|
||||||
|
const sheetName = hf.addSheet('Data');
|
||||||
|
const sheetId = hf.getSheetId(sheetName);
|
||||||
|
|
||||||
|
hf.setCellContents({ sheet: sheetId, col: 0, row: 0 }, [
|
||||||
|
['10', '20', '=SUM(A1:B1)'],
|
||||||
|
]);
|
||||||
|
```
|
||||||
|
|
||||||
|
## Cell addresses
|
||||||
|
|
||||||
|
All addresses use zero-indexed `{ sheet, col, row }`. Convert to/from A1 notation with built-in helpers:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
hf.simpleCellAddressFromString('B3', 0);
|
||||||
|
// → { sheet: 0, col: 1, row: 2 }
|
||||||
|
|
||||||
|
hf.simpleCellAddressToString({ sheet: 0, col: 1, row: 2 }, 0);
|
||||||
|
// → 'B3'
|
||||||
|
```
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
# Vue 3
|
||||||
|
|
||||||
|
HyperFormula + Vue 3 integration. Authoritative doc:
|
||||||
|
- Vue integration guide: https://hyperformula.handsontable.com/docs/guide/integration-with-vue.html
|
||||||
|
|
||||||
|
## Always wrap the instance with `markRaw`
|
||||||
|
|
||||||
|
Vue 3's Composition API wraps objects in a reactive Proxy that intercepts property access and **corrupts HyperFormula's internal state**, causing silent data corruption or crashes. React, Angular, and Svelte need no special handling.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { markRaw } from 'vue';
|
||||||
|
import { HyperFormula } from 'hyperformula';
|
||||||
|
|
||||||
|
const hf = markRaw(
|
||||||
|
HyperFormula.buildEmpty({ licenseKey: 'gpl-v3' })
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
Use the same wrapper no matter where the instance is held — `ref`, `reactive`, component state, a store (Pinia/Vuex), or a composable. If the raw HyperFormula instance ever reaches Vue's reactivity system, it must be marked.
|
||||||
|
|
||||||
|
## Composition API example
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { onBeforeUnmount, ref } from 'vue';
|
||||||
|
import { markRaw } from 'vue';
|
||||||
|
import { HyperFormula } from 'hyperformula';
|
||||||
|
|
||||||
|
export function useHyperFormula() {
|
||||||
|
const hf = markRaw(
|
||||||
|
HyperFormula.buildEmpty({ licenseKey: 'gpl-v3' })
|
||||||
|
);
|
||||||
|
|
||||||
|
// Free internal data structures when the component unmounts.
|
||||||
|
onBeforeUnmount(() => hf.destroy());
|
||||||
|
|
||||||
|
const result = ref<unknown>(null);
|
||||||
|
|
||||||
|
function evaluate(formula: string) {
|
||||||
|
hf.setCellContents({ sheet: 0, col: 0, row: 0 }, formula);
|
||||||
|
result.value = hf.getCellValue({ sheet: 0, col: 0, row: 0 });
|
||||||
|
}
|
||||||
|
|
||||||
|
return { evaluate, result };
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Pinia / Vuex store
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { defineStore } from 'pinia';
|
||||||
|
import { markRaw } from 'vue';
|
||||||
|
import { HyperFormula } from 'hyperformula';
|
||||||
|
|
||||||
|
export const useCalcStore = defineStore('calc', {
|
||||||
|
state: () => ({
|
||||||
|
hf: markRaw(
|
||||||
|
HyperFormula.buildEmpty({ licenseKey: 'gpl-v3' })
|
||||||
|
),
|
||||||
|
}),
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Cleanup
|
||||||
|
|
||||||
|
HyperFormula's internal graph is **not** garbage-collected until `destroy()` is called. In SPAs this accumulates memory over time.
|
||||||
|
|
||||||
|
```ts
|
||||||
|
import { onBeforeUnmount } from 'vue';
|
||||||
|
|
||||||
|
onBeforeUnmount(() => hf.destroy());
|
||||||
|
// After destroy() the instance is unusable — create a new one if needed.
|
||||||
|
```
|
||||||
@@ -69,6 +69,9 @@ jobs:
|
|||||||
needs: Build-and-ng-test
|
needs: Build-and-ng-test
|
||||||
env:
|
env:
|
||||||
CHROME_BIN: /usr/bin/google-chrome
|
CHROME_BIN: /usr/bin/google-chrome
|
||||||
|
# Pin OS locale
|
||||||
|
LANG: en_GB.UTF-8
|
||||||
|
LC_ALL: en_GB.UTF-8
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -86,7 +89,10 @@ jobs:
|
|||||||
apt-get update
|
apt-get update
|
||||||
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
|
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
|
||||||
apt install -y ./google-chrome*.deb
|
apt install -y ./google-chrome*.deb
|
||||||
apt-get -y install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libnss3 libxss1 libasound2t64 libxtst6 xauth xvfb jq zip
|
apt-get -y install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libnss3 libxss1 libasound2t64 libxtst6 xauth xvfb jq zip locales
|
||||||
|
# Generate the en_GB.UTF-8 locale referenced by LANG/LC_ALL
|
||||||
|
locale-gen en_GB.UTF-8
|
||||||
|
update-locale LANG=en_GB.UTF-8 LC_ALL=en_GB.UTF-8
|
||||||
|
|
||||||
- name: Write cypress credentials
|
- name: Write cypress credentials
|
||||||
run: echo "$CYPRESS_CREDS" > ./client/cypress.env.json
|
run: echo "$CYPRESS_CREDS" > ./client/cypress.env.json
|
||||||
@@ -123,6 +129,7 @@ jobs:
|
|||||||
# sasjs request services/admin/makedata -t server-ci -d ./deploy/makeData4GL.json -c ./deploy/requestConfig.json -o ./output.json
|
# sasjs request services/admin/makedata -t server-ci -d ./deploy/makeData4GL.json -c ./deploy/requestConfig.json -o ./output.json
|
||||||
|
|
||||||
- name: Prepare and run frontend and cypress
|
- name: Prepare and run frontend and cypress
|
||||||
|
timeout-minutes: 35
|
||||||
run: |
|
run: |
|
||||||
cd ./client
|
cd ./client
|
||||||
mv ./cypress.env.example.json ./cypress.env.json
|
mv ./cypress.env.example.json ./cypress.env.json
|
||||||
@@ -137,7 +144,9 @@ jobs:
|
|||||||
replace-in-files --regex='"hosturl".*' --replacement='hosturl:"http://localhost:4200",' ./cypress.config.ts
|
replace-in-files --regex='"hosturl".*' --replacement='hosturl:"http://localhost:4200",' ./cypress.config.ts
|
||||||
cat ./cypress.config.ts
|
cat ./cypress.config.ts
|
||||||
# Start frontend and run cypress
|
# Start frontend and run cypress
|
||||||
npx ng serve --host 0.0.0.0 --port 4200 & npx wait-on http://localhost:4200 && npx cypress run --browser chrome --spec "cypress/e2e/csv-limited.cy.ts,cypress/e2e/liveness.cy.ts,cypress/e2e/editor.cy.ts,cypress/e2e/excel-multi-load.cy.ts,cypress/e2e/excel.cy.ts,cypress/e2e/csv.cy.ts,cypress/e2e/filtering.cy.ts,cypress/e2e/licensing.cy.ts"
|
# timeout 1800: SIGTERM after 30 min so Cypress can flush video/screenshots
|
||||||
|
# before the outer timeout-minutes hard-kills the step (avoids silent multi-hour hangs)
|
||||||
|
npx ng serve --host 0.0.0.0 --port 4200 & npx wait-on http://localhost:4200 && timeout 1800 npx cypress run --browser chrome --spec "cypress/e2e/csv-limited.cy.ts,cypress/e2e/liveness.cy.ts,cypress/e2e/editor.cy.ts,cypress/e2e/excel-multi-load.cy.ts,cypress/e2e/excel.cy.ts,cypress/e2e/csv.cy.ts,cypress/e2e/filtering.cy.ts,cypress/e2e/licensing.cy.ts,cypress/e2e/viewer-labels.cy.ts"
|
||||||
|
|
||||||
- name: Zip Cypress videos
|
- name: Zip Cypress videos
|
||||||
if: always()
|
if: always()
|
||||||
|
|||||||
@@ -47,9 +47,9 @@ jobs:
|
|||||||
- name: Check audit
|
- name: Check audit
|
||||||
# Audit should fail and stop the CI if critical vulnerability found
|
# Audit should fail and stop the CI if critical vulnerability found
|
||||||
run: |
|
run: |
|
||||||
npm audit --omit=dev
|
npm audit --audit-level=critical --omit=dev
|
||||||
cd ./sas
|
cd ./sas
|
||||||
npm audit --omit=dev
|
npm audit --audit-level=critical --omit=dev
|
||||||
cd ../client
|
cd ../client
|
||||||
npm audit --audit-level=critical --omit=dev
|
npm audit --audit-level=critical --omit=dev
|
||||||
|
|
||||||
@@ -69,6 +69,9 @@ jobs:
|
|||||||
needs: Build-production-and-ng-test
|
needs: Build-production-and-ng-test
|
||||||
env:
|
env:
|
||||||
CHROME_BIN: /usr/bin/google-chrome
|
CHROME_BIN: /usr/bin/google-chrome
|
||||||
|
# Pin OS locale
|
||||||
|
LANG: en_GB.UTF-8
|
||||||
|
LC_ALL: en_GB.UTF-8
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -86,7 +89,10 @@ jobs:
|
|||||||
apt-get update
|
apt-get update
|
||||||
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
|
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
|
||||||
apt install -y ./google-chrome*.deb
|
apt install -y ./google-chrome*.deb
|
||||||
apt-get -y install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libnss3 libxss1 libasound2t64 libxtst6 xauth xvfb jq zip
|
apt-get -y install libgtk2.0-0 libgtk-3-0 libgbm-dev libnotify-dev libnss3 libxss1 libasound2t64 libxtst6 xauth xvfb jq zip locales
|
||||||
|
# Generate the en_GB.UTF-8 locale referenced by LANG/LC_ALL
|
||||||
|
locale-gen en_GB.UTF-8
|
||||||
|
update-locale LANG=en_GB.UTF-8 LC_ALL=en_GB.UTF-8
|
||||||
|
|
||||||
- name: Write cypress credentials
|
- name: Write cypress credentials
|
||||||
run: echo "$CYPRESS_CREDS" > ./client/cypress.env.json
|
run: echo "$CYPRESS_CREDS" > ./client/cypress.env.json
|
||||||
@@ -137,7 +143,7 @@ jobs:
|
|||||||
replace-in-files --regex='"hosturl".*' --replacement='hosturl:"http://localhost:4200",' ./cypress.config.ts
|
replace-in-files --regex='"hosturl".*' --replacement='hosturl:"http://localhost:4200",' ./cypress.config.ts
|
||||||
cat ./cypress.config.ts
|
cat ./cypress.config.ts
|
||||||
# Start frontend and run cypress
|
# Start frontend and run cypress
|
||||||
npx ng serve --host 0.0.0.0 --port 4200 & npx wait-on http://localhost:4200 && npx cypress run --browser chrome --spec "cypress/e2e/csv-limited.cy.ts,cypress/e2e/liveness.cy.ts,cypress/e2e/editor.cy.ts,cypress/e2e/excel-multi-load.cy.ts,cypress/e2e/excel.cy.ts,cypress/e2e/csv.cy.ts,cypress/e2e/filtering.cy.ts,cypress/e2e/licensing.cy.ts"
|
npx ng serve --host 0.0.0.0 --port 4200 & npx wait-on http://localhost:4200 && npx cypress run --browser chrome --spec "cypress/e2e/csv-limited.cy.ts,cypress/e2e/liveness.cy.ts,cypress/e2e/editor.cy.ts,cypress/e2e/excel-multi-load.cy.ts,cypress/e2e/excel.cy.ts,cypress/e2e/csv.cy.ts,cypress/e2e/filtering.cy.ts,cypress/e2e/licensing.cy.ts,cypress/e2e/viewer-labels.cy.ts"
|
||||||
|
|
||||||
- name: Zip Cypress videos
|
- name: Zip Cypress videos
|
||||||
if: always()
|
if: always()
|
||||||
@@ -155,6 +161,16 @@ jobs:
|
|||||||
release:
|
release:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: [Build-production-and-ng-test, Build-and-test-development]
|
needs: [Build-production-and-ng-test, Build-and-test-development]
|
||||||
|
# The semantic-release step below uses the per-job token injected by Gitea
|
||||||
|
# Actions (secrets.GITEA_TOKEN). That token is scoped to THIS repository
|
||||||
|
# and its permissions are derived from this block.
|
||||||
|
# contents: write -> push CHANGELOG.md / package.json commit + tag, and
|
||||||
|
# create the Release via the Gitea API.
|
||||||
|
# The TSDOC_TOKEN and CODE_DATACONTROLLER_IO secrets continue to be used
|
||||||
|
# because they target *different* servers (webdoc.datacontroller.io and
|
||||||
|
# code.datacontroller.io), not the Gitea API.
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
@@ -187,12 +203,41 @@ jobs:
|
|||||||
npm run build
|
npm run build
|
||||||
|
|
||||||
- name: Create Empty Release (assets are posted later)
|
- name: Create Empty Release (assets are posted later)
|
||||||
|
env:
|
||||||
|
# Use the ephemeral per-job token injected by Gitea Actions instead
|
||||||
|
# of a manually-managed PAT. This token always reports push=true on
|
||||||
|
# its own repo via the Gitea API, which is what the
|
||||||
|
# @saithodev/semantic-release-gitea verifyConditions step checks.
|
||||||
|
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||||
|
GITEA_URL: ${{ gitea.server_url }}
|
||||||
run: |
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
npm i
|
npm i
|
||||||
npm i -g semantic-release
|
npm i -g semantic-release
|
||||||
# We do a semantic-release DRY RUN to make the job fail if there are no changes to release
|
|
||||||
GITEA_TOKEN=${{ secrets.RELEASE_TOKEN }} GITEA_URL=https://git.datacontroller.io semantic-release --dry-run | grep -q "There are no relevant changes, so no new version is released." && exit 1
|
# We do a semantic-release DRY RUN to make the job fail if there are
|
||||||
GITEA_TOKEN=${{ secrets.RELEASE_TOKEN }} GITEA_URL=https://git.datacontroller.io semantic-release
|
# no changes to release. The previous implementation piped --dry-run
|
||||||
|
# into `grep`, which swallowed semantic-release's non-zero exit codes
|
||||||
|
# (e.g. auth/verifyConditions failures) — the real error then only
|
||||||
|
# surfaced from the second invocation. Capture output and inspect it
|
||||||
|
# so authentication failures fail the step cleanly with context.
|
||||||
|
echo "::group::semantic-release --dry-run"
|
||||||
|
DRY_EXIT=0
|
||||||
|
DRY_OUTPUT=$(semantic-release --dry-run 2>&1) || DRY_EXIT=$?
|
||||||
|
echo "$DRY_OUTPUT"
|
||||||
|
echo "::endgroup::"
|
||||||
|
|
||||||
|
if [ "$DRY_EXIT" -ne 0 ]; then
|
||||||
|
echo "::error::semantic-release dry-run failed (exit $DRY_EXIT). See log above; common cause is the Gitea token lacking push permission on this repo (verifyConditions of @saithodev/semantic-release-gitea)."
|
||||||
|
exit "$DRY_EXIT"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if echo "$DRY_OUTPUT" | grep -q "There are no relevant changes, so no new version is released."; then
|
||||||
|
echo "::error::No releasable changes since last tag - aborting release job."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
semantic-release
|
||||||
|
|
||||||
- name: Frontend Build
|
- name: Frontend Build
|
||||||
description: Must be created AFTER the release as the version (git tag) is used in the interface
|
description: Must be created AFTER the release as the version (git tag) is used in the interface
|
||||||
@@ -266,17 +311,40 @@ jobs:
|
|||||||
surfer put --token ${{ secrets.CODE_DATACONTROLLER_IO }} --server code.datacontroller.io sasjsbuild/sasdocs/* /
|
surfer put --token ${{ secrets.CODE_DATACONTROLLER_IO }} --server code.datacontroller.io sasjsbuild/sasdocs/* /
|
||||||
|
|
||||||
- name: Upload assets to release
|
- name: Upload assets to release
|
||||||
|
env:
|
||||||
|
# Use the same ephemeral per-job Gitea Actions token that the
|
||||||
|
# "Create Empty Release" step uses for semantic-release. It is scoped
|
||||||
|
# to this repo and is granted write access via the workflow's
|
||||||
|
# `permissions:` block at the top of the file (see contents: write).
|
||||||
|
GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
RELEASE_ID=`curl -k 'https://git.datacontroller.io/api/v1/repos/dc/dc/releases/latest?access_token=${{ secrets.RELEASE_TOKEN }}' | jq -r '.id'`
|
set -euo pipefail
|
||||||
RELEASE_BODY=`curl -k 'https://git.datacontroller.io/api/v1/repos/dc/dc/releases/latest?access_token=${{ secrets.RELEASE_TOKEN }}' | jq -r '.body'`
|
# Send the token via Authorization header rather than ?access_token=
|
||||||
# Update body
|
# (the query-string form is deprecated and leaks into access logs).
|
||||||
curl --data '{"draft": false,"body":"'"$RELEASE_BODY\n\nFor installation instructions, please visit https://docs.datacontroller.io/"'"}' -X PATCH --header 'Content-Type: application/json' -k https://git.datacontroller.io/api/v1/repos/dc/dc/releases/$RELEASE_ID?access_token=${{ secrets.RELEASE_TOKEN }}
|
AUTH_HEADER="Authorization: token ${GITEA_TOKEN}"
|
||||||
|
BASE="${{ gitea.server_url }}/api/v1/repos/${{ gitea.repository }}"
|
||||||
|
|
||||||
|
RELEASE_JSON=$(curl -k --fail-with-body -sS -H "$AUTH_HEADER" "$BASE/releases/latest")
|
||||||
|
RELEASE_ID=$(echo "$RELEASE_JSON" | jq -r '.id')
|
||||||
|
RELEASE_BODY=$(echo "$RELEASE_JSON" | jq -r '.body')
|
||||||
|
|
||||||
|
# Update body (also confirms the token has contents:write on this repo)
|
||||||
|
curl -k --fail-with-body -sS -X PATCH \
|
||||||
|
-H "$AUTH_HEADER" \
|
||||||
|
-H 'Content-Type: application/json' \
|
||||||
|
--data "$(jq -n --arg body "$RELEASE_BODY"$'\n\nFor installation instructions, please visit https://docs.datacontroller.io/' \
|
||||||
|
'{draft:false, body:$body}')" \
|
||||||
|
"$BASE/releases/$RELEASE_ID"
|
||||||
|
|
||||||
# Upload assets
|
# Upload assets
|
||||||
URL="https://git.datacontroller.io/api/v1/repos/dc/dc/releases/$RELEASE_ID/assets?access_token=${{ secrets.RELEASE_TOKEN }}"
|
URL="$BASE/releases/$RELEASE_ID/assets"
|
||||||
curl -k $URL -F attachment=@frontend.zip
|
for f in frontend.zip \
|
||||||
curl -k $URL -F attachment=@sas/demostream_sas9.sas
|
sas/demostream_sas9.sas \
|
||||||
curl -k $URL -F attachment=@sas/viya.sas
|
sas/viya.sas \
|
||||||
curl -k $URL -F attachment=@sas/sasjs_server.json.zip
|
sas/sasjs_server.json.zip \
|
||||||
curl -k $URL -F attachment=@sas/sas9.sas
|
sas/sas9.sas \
|
||||||
curl -k $URL -F attachment=@sas/viya_noweb.sas
|
sas/viya_noweb.sas \
|
||||||
curl -k $URL -F attachment=@sas/viya_noweb.json
|
sas/viya_noweb.json; do
|
||||||
|
echo "Uploading $f ..."
|
||||||
|
curl -k --fail-with-body -sS -H "$AUTH_HEADER" "$URL" -F "attachment=@$f"
|
||||||
|
done
|
||||||
|
|||||||
Vendored
+1
@@ -1,5 +1,6 @@
|
|||||||
{
|
{
|
||||||
"cSpell.words": [
|
"cSpell.words": [
|
||||||
|
"Handsontable",
|
||||||
"Licence",
|
"Licence",
|
||||||
"SYSERRORTEXT",
|
"SYSERRORTEXT",
|
||||||
"SYSWARNINGTEXT",
|
"SYSWARNINGTEXT",
|
||||||
|
|||||||
+122
@@ -1,3 +1,125 @@
|
|||||||
|
## [7.10.1](https://git.datacontroller.io/dc/dc/compare/v7.10.0...v7.10.1) (2026-07-15)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **editor:** order validation rules by COLHEADERS, not cols[].VARNUM ([4c2aca3](https://git.datacontroller.io/dc/dc/commit/4c2aca34951d6d5c5cf2df69d5bf4256a9290d53))
|
||||||
|
|
||||||
|
# [7.10.0](https://git.datacontroller.io/dc/dc/compare/v7.9.1...v7.10.0) (2026-07-13)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* adapt column validation to vertical-array COLTYPE ([#253](https://git.datacontroller.io/dc/dc/issues/253)) ([3016750](https://git.datacontroller.io/dc/dc/commit/301675052fb5cbcb11f54c370ad7eda1d60461fd))
|
||||||
|
* backend updates to bring back labels under [#240](https://git.datacontroller.io/dc/dc/issues/240) ([fb94840](https://git.datacontroller.io/dc/dc/commit/fb94840016f067fa3523a3539dd0616d8970eed0))
|
||||||
|
* **editor:** normalise unpadded time strings on spreadsheet import ([7b4b4eb](https://git.datacontroller.io/dc/dc/commit/7b4b4ebeeb0e34ec5fcd5c485741d7bbddb43b7e))
|
||||||
|
* **hot:** row rendering on resize, resolve blank whitespace ([c7ba025](https://git.datacontroller.io/dc/dc/commit/c7ba025d39aa9681ad51f239503e884fb26613e2))
|
||||||
|
* including datadictionary descs in labels, [#240](https://git.datacontroller.io/dc/dc/issues/240) ([e7453a9](https://git.datacontroller.io/dc/dc/commit/e7453a9305263faf4d4f288d50977121353040c7))
|
||||||
|
* pass variable formats to front-end in a vertical array instead of horizontal list ([691d6f2](https://git.datacontroller.io/dc/dc/commit/691d6f277ea87051f539681b34da2f39cade8fc3))
|
||||||
|
* remove coltype from sasparams table, add it to cols table. ([8101400](https://git.datacontroller.io/dc/dc/commit/81014001ac4da6b8d262c72c65e0c657f186ec84))
|
||||||
|
* trim leading/trailing whitespace from Excel header cells on upload ([2728dac](https://git.datacontroller.io/dc/dc/commit/2728dac873ab8c9fc44413f873e4730515ca0e21))
|
||||||
|
* **va:** date filters refactor, support more dates ([df5c975](https://git.datacontroller.io/dc/dc/commit/df5c9758697d7481e67d20ed7ff81e9ce4e92ec0))
|
||||||
|
* **va:** enable readOnly and hold filtering while editing ([82a254d](https://git.datacontroller.io/dc/dc/commit/82a254d22cb7aaf75aae7b332f0b07fc8bda3e44))
|
||||||
|
* **va:** enable Upload button in va mode ([1beb3d4](https://git.datacontroller.io/dc/dc/commit/1beb3d490d0e7b8d5fa7985f121495ed62740cfe))
|
||||||
|
* **va:** guard deferred contextMenu toggle against destroyed instance ([b5e9b25](https://git.datacontroller.io/dc/dc/commit/b5e9b2531924bec1a23c67d3ad0ca3f512a75655))
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* adding DC_MAXOBS_WEBVIEW config item, closes [#258](https://git.datacontroller.io/dc/dc/issues/258) ([ba7b610](https://git.datacontroller.io/dc/dc/commit/ba7b61082d39767f9539a84de6742a1704573e81))
|
||||||
|
* viewer/editor column label display toggle (?labels=true) ([25c12f2](https://git.datacontroller.io/dc/dc/commit/25c12f2b18adda09e6edc93eba263bd5ea0f7409))
|
||||||
|
|
||||||
|
|
||||||
|
### Reverts
|
||||||
|
|
||||||
|
* enable upload button in va mode ([0d7fd34](https://git.datacontroller.io/dc/dc/commit/0d7fd342970744489a2e6c6fb08f239fe853cb81))
|
||||||
|
|
||||||
|
## [7.9.1](https://git.datacontroller.io/dc/dc/compare/v7.9.0...v7.9.1) (2026-06-30)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* workflow file upload using action PAT ([a161670](https://git.datacontroller.io/dc/dc/commit/a161670b8656614f61d42ee673064ba8f010b71c))
|
||||||
|
|
||||||
|
# [7.9.0](https://git.datacontroller.io/dc/dc/compare/v7.8.2...v7.9.0) (2026-06-29)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* allow large retained key values. Closes [#248](https://git.datacontroller.io/dc/dc/issues/248). ([6a30de3](https://git.datacontroller.io/dc/dc/commit/6a30de37cad21b7b94bf550ce7afbc804e6f0f90))
|
||||||
|
* build issues ([#245](https://git.datacontroller.io/dc/dc/issues/245)) ([77b4bb3](https://git.datacontroller.io/dc/dc/commit/77b4bb310e62adb450805488fc69a132435d0eb7))
|
||||||
|
* **ci:** bump Lighthouse to 13.4.0 ([47ba03e](https://git.datacontroller.io/dc/dc/commit/47ba03ec637113d8867372d64484927de9b645ff))
|
||||||
|
* **dc-validator:** display date/time/datetime cells as raw ISO, locale-independent ([9ca5719](https://git.datacontroller.io/dc/dc/commit/9ca57193b4aafa1e7bf216301cdf197cea6ec4c9))
|
||||||
|
* **editor:** await dynamic validation on paste; defer spinner ([ea03bde](https://git.datacontroller.io/dc/dc/commit/ea03bdecc5aaf917052add2c7e6fdc192b9974ce))
|
||||||
|
* **editor:** cancelEdit will reset cell's valid state ([51071b4](https://git.datacontroller.io/dc/dc/commit/51071b463bb311c6db48c301daa8cc7dfd92144a))
|
||||||
|
* **editor:** preserve commas in dropdown source values ([6af49cf](https://git.datacontroller.io/dc/dc/commit/6af49cf1fd8aa27cbf99f9514cca537339cdbf7e))
|
||||||
|
* **editor:** retry initSetup when the Handsontable instance isn't ready ([53b7ee0](https://git.datacontroller.io/dc/dc/commit/53b7ee0cb23329fa4f9d6211ffe6b102053fade9))
|
||||||
|
* **handsontable:** add exceljs ([38cb1e2](https://git.datacontroller.io/dc/dc/commit/38cb1e207b58822d71ef803e770a93bc7265bc1c))
|
||||||
|
* **handsontable:** horizontal scrollbar in dropdown ([ac0bd10](https://git.datacontroller.io/dc/dc/commit/ac0bd102127ced6b6a908a7244f35002f22cb669))
|
||||||
|
* **handsontable:** restore dark mode for v17 ([9d97bf7](https://git.datacontroller.io/dc/dc/commit/9d97bf7ea13199ab9dab10c5fc47e07b4751fb9a))
|
||||||
|
* **handsontable:** update licenseChecker exclude buffers - exceljs dep ([12c7d30](https://git.datacontroller.io/dc/dc/commit/12c7d30894b5c3709b683189da6e52255ad0a3e7))
|
||||||
|
* incrementing rk val ([7444209](https://git.datacontroller.io/dc/dc/commit/74442096bac1481a4992e5c97dac47c8d277cc3f))
|
||||||
|
* **licensing:** add protocol info ([3668a74](https://git.datacontroller.io/dc/dc/commit/3668a7426fec078ad7939b5bc815d7ad920c0d62)), closes [#178](https://git.datacontroller.io/dc/dc/issues/178)
|
||||||
|
* migrate handsontables to v17 ([1b73e35](https://git.datacontroller.io/dc/dc/commit/1b73e355b78a0039aa48f7a137095eb5470c08e2))
|
||||||
|
* **mocks:** return dynamic cell values as OBJ to match new contract ([a15fdc4](https://git.datacontroller.io/dc/dc/commit/a15fdc401e6cdcf934a5d599f8b7c4d197e9d2d4))
|
||||||
|
* removing display_value in SAS code ([9b18a45](https://git.datacontroller.io/dc/dc/commit/9b18a45d354ad617e590d62758ef761b01b3095a))
|
||||||
|
* rule_type ([adc6424](https://git.datacontroller.io/dc/dc/commit/adc6424211a83fb03b267bf8fa6b6d9fa72f185b))
|
||||||
|
* sending dynamic_values and dynamic_extended_values back as OBJ instead of ARR ([e859d33](https://git.datacontroller.io/dc/dc/commit/e859d3354e82f0faad53a0b8aa14ed66974cbffa))
|
||||||
|
* upcasing RAW_VALUE, bumping core, fixing tests ([982d507](https://git.datacontroller.io/dc/dc/commit/982d507ae3ad2ccc08e65678956199cd54b696f2))
|
||||||
|
* validate pasted values ([b661580](https://git.datacontroller.io/dc/dc/commit/b661580c604c2923b930911a1881aec7b06ecf23))
|
||||||
|
* viewLibs now fires only once, libPromise shared between the calls ([dc4e07a](https://git.datacontroller.io/dc/dc/commit/dc4e07a692a5e839986abb69b17e51024c4cdc03))
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* **edit-record:** use native date/time/datetime pickers ([2d29346](https://git.datacontroller.io/dc/dc/commit/2d29346cbf09ad057743e6f5ebea12f3257f246e))
|
||||||
|
* **editor:** add READONLY, HIDDEN, ROUND and NUMBER_FORMAT validation rules ([4ea604f](https://git.datacontroller.io/dc/dc/commit/4ea604f9fbdd429108fe063b306ea376e756c107))
|
||||||
|
* **editor:** migrate date/time/datetime to HOT 17 Intl cell types ([f70ea2f](https://git.datacontroller.io/dc/dc/commit/f70ea2fe712ff9a42bf47387f9f0aaa6d1a1f511))
|
||||||
|
* **editor:** paste-validation overlay with cancel and confirm ([609731f](https://git.datacontroller.io/dc/dc/commit/609731ff99185a162614df13bde7afb1a2c3bbca))
|
||||||
|
* **editor:** SAS VA data-driven content embed mode (?embed=va) ([ffa3ff9](https://git.datacontroller.io/dc/dc/commit/ffa3ff9c103d6d80677f4f67e7d53418f201f491))
|
||||||
|
* **editor:** VA embed filter modes with pending UX ([ebe6972](https://git.datacontroller.io/dc/dc/commit/ebe6972dd7d38c5742ed7eb446e0448d98b2c8a7))
|
||||||
|
* **editor:** validate autofilled cells; fix paste validation lag ([11ee49a](https://git.datacontroller.io/dc/dc/commit/11ee49a57a0bc7ccd59e91d5fe37bb5db1bf7d69))
|
||||||
|
* **handsontable:** enable export plugin, add export menu items ([29aaa72](https://git.datacontroller.io/dc/dc/commit/29aaa72c6047bb309d325887ab602a9369a1ad74))
|
||||||
|
* migration script for adding new validation rules under [#241](https://git.datacontroller.io/dc/dc/issues/241) ([9f84a58](https://git.datacontroller.io/dc/dc/commit/9f84a580fb762da8c1c796a35eb4f531df1caf13))
|
||||||
|
* new validation rules in mpe_selectbox. [#241](https://git.datacontroller.io/dc/dc/issues/241) ([2f5d3df](https://git.datacontroller.io/dc/dc/commit/2f5d3dfc387f02353601aaa844aaeabde3e9f3e5))
|
||||||
|
|
||||||
|
|
||||||
|
### Reverts
|
||||||
|
|
||||||
|
* eager-load feature modules instead of lazy-loading ([3429a7a](https://git.datacontroller.io/dc/dc/commit/3429a7a2a6ecfa6115394e1c842061cc68bf2be3))
|
||||||
|
* **editor:** DISPLAY_VALUE change ([eb015d7](https://git.datacontroller.io/dc/dc/commit/eb015d712b01687f36ac92e38ab576a7c114b1ba))
|
||||||
|
|
||||||
|
## [7.8.2](https://git.datacontroller.io/dc/dc/compare/v7.8.1...v7.8.2) (2026-05-20)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* bumping ws package ([2382a55](https://git.datacontroller.io/dc/dc/commit/2382a559a5ac32b0f815776a90207650d5809ba6))
|
||||||
|
* enabling version restore for non admin users ([5d889d8](https://git.datacontroller.io/dc/dc/commit/5d889d824cc2f8e4ea089cbb578453125dc4ba6c))
|
||||||
|
|
||||||
|
## [7.8.1](https://git.datacontroller.io/dc/dc/compare/v7.8.0...v7.8.1) (2026-05-15)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **sasjs:** enable runAsTask ([f1a26e1](https://git.datacontroller.io/dc/dc/commit/f1a26e132eba7fa2ac64754940b52ea46c6619b3))
|
||||||
|
|
||||||
|
# [7.8.0](https://git.datacontroller.io/dc/dc/compare/v7.7.3...v7.8.0) (2026-05-15)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* enabling DSN=*ALL* in MPE_SECURITY ([7d94cb2](https://git.datacontroller.io/dc/dc/commit/7d94cb2ae4a3f6c1fa1011ae0fced7083a2f2793))
|
||||||
|
* providing default values for RULE_ACTIVE on MPE_VALIDATIONS ([f031b4e](https://git.datacontroller.io/dc/dc/commit/f031b4eb8925397e60dcc739a721cfbbb6da8dff))
|
||||||
|
* switch away from api usage for CASLIB metadata ([ce921a0](https://git.datacontroller.io/dc/dc/commit/ce921a032a8970b8078a463a41da884e1fa71bc3))
|
||||||
|
* use correct debug param for runAsTask ([bb80476](https://git.datacontroller.io/dc/dc/commit/bb8047676749814d3b86eea666726dbe4bf5f270))
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* add runAsTask config attribute parser ([1635bc9](https://git.datacontroller.io/dc/dc/commit/1635bc9c451bc221f386241007f594096f114b4f))
|
||||||
|
* enabling *ALL* option by default in MPE_SECURITY (DSN col) ([93d4ab6](https://git.datacontroller.io/dc/dc/commit/93d4ab65acce7b5b35e448146f9893964ad2cca3))
|
||||||
|
|
||||||
## [7.7.3](https://git.datacontroller.io/dc/dc/compare/v7.7.2...v7.7.3) (2026-05-12)
|
## [7.7.3](https://git.datacontroller.io/dc/dc/compare/v7.7.2...v7.7.3) (2026-05-12)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -51,7 +51,7 @@ This project includes automated Lighthouse performance and accessibility checks
|
|||||||
The Lighthouse CI workflow:
|
The Lighthouse CI workflow:
|
||||||
1. Sets up the development environment with SASjs server and mocked services
|
1. Sets up the development environment with SASjs server and mocked services
|
||||||
2. Builds and serves the Angular frontend
|
2. Builds and serves the Angular frontend
|
||||||
3. Runs Lighthouse CI against key application pages
|
3. Installs Chrome and runs `lhci autorun` (Lighthouse CI) against key pages
|
||||||
4. Uploads results as artifacts for review
|
4. Uploads results as artifacts for review
|
||||||
|
|
||||||
To run Lighthouse checks locally:
|
To run Lighthouse checks locally:
|
||||||
@@ -61,4 +61,4 @@ npm install
|
|||||||
npm run lighthouse
|
npm run lighthouse
|
||||||
```
|
```
|
||||||
|
|
||||||
Configuration is in `client/lighthouserc.js`.
|
Configuration is in `client/lighthouserc.js` (URL list, `desktop` preset, Chrome flags, assertions).
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
# Auto-generated at build time (node ./src/version.ts) — gitignored, never linted.
|
||||||
|
# Formerly skipped via root .gitignore when prettier ran from the repo root;
|
||||||
|
# now that lint runs from client/, prettier reads this CWD-local ignore instead.
|
||||||
|
src/environments/version.ts
|
||||||
+9
-1
@@ -25,6 +25,7 @@
|
|||||||
"options": {
|
"options": {
|
||||||
"allowedCommonJsDependencies": [
|
"allowedCommonJsDependencies": [
|
||||||
"handsontable",
|
"handsontable",
|
||||||
|
"exceljs",
|
||||||
"core-js",
|
"core-js",
|
||||||
"pikaday",
|
"pikaday",
|
||||||
"querystring",
|
"querystring",
|
||||||
@@ -67,7 +68,14 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"styles": ["src/styles.scss"],
|
"styles": ["src/styles.scss"],
|
||||||
"scripts": ["node_modules/marked/marked.min.js"],
|
"scripts": [
|
||||||
|
"node_modules/marked/marked.min.js",
|
||||||
|
{
|
||||||
|
"input": "src/assets/va-early.js",
|
||||||
|
"bundleName": "va-early",
|
||||||
|
"inject": true
|
||||||
|
}
|
||||||
|
],
|
||||||
"webWorkerTsConfig": "tsconfig.worker.json",
|
"webWorkerTsConfig": "tsconfig.worker.json",
|
||||||
"main": "src/main.ts"
|
"main": "src/main.ts"
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -34,7 +34,14 @@ export default defineConfig({
|
|||||||
e2e: {
|
e2e: {
|
||||||
video: true,
|
video: true,
|
||||||
setupNodeEvents(on, config) {
|
setupNodeEvents(on, config) {
|
||||||
// implement node event listeners here
|
// Pin the browser locale so locale-formatted cells (intl-date/time/datetime)
|
||||||
|
// render deterministically regardless of the runner's system locale.
|
||||||
|
on('before:browser:launch', (browser, launchOptions) => {
|
||||||
|
if (browser.family === 'chromium' && browser.name !== 'electron') {
|
||||||
|
launchOptions.args.push('--lang=en-GB')
|
||||||
|
}
|
||||||
|
return launchOptions
|
||||||
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -0,0 +1,132 @@
|
|||||||
|
// Marks this file as an ES module (rather than a global script) so its
|
||||||
|
// top-level consts don't collide, under the TS type-checker, with the same
|
||||||
|
// names declared in other spec files — see viewer-labels.cy.ts for the same
|
||||||
|
// pattern.
|
||||||
|
export {}
|
||||||
|
|
||||||
|
const username = Cypress.env('username')
|
||||||
|
const password = Cypress.env('password')
|
||||||
|
const hostUrl = Cypress.env('hosturl')
|
||||||
|
const appLocation = Cypress.env('appLocation')
|
||||||
|
const longerCommandTimeout = Cypress.env('longerCommandTimeout')
|
||||||
|
const serverType = Cypress.env('serverType')
|
||||||
|
const libraryToOpenIncludes = Cypress.env(`libraryToOpenIncludes_${serverType}`)
|
||||||
|
|
||||||
|
// Regression coverage for issue #253's vertical-array COLTYPE fix — see
|
||||||
|
// getdata.sas now sends one COLTYPE JSON-object string per cols[] row (via
|
||||||
|
// a LEFT JOIN keyed off the real dataset's columns), instead of one
|
||||||
|
// comma-joined sasparams.COLTYPE string covering every column. Two things
|
||||||
|
// are specifically at risk from that change and aren't covered elsewhere:
|
||||||
|
// 1. `_____DELETE__THIS__RECORD_____` (the delete checkbox column) is a
|
||||||
|
// client-side-only concept — %mp_getcols never has a row for it, so
|
||||||
|
// it can no longer travel via cols[].COLTYPE at all. Its Yes/No
|
||||||
|
// dropdown rule is now hardcoded client-side (deleteRecordColumnRule.ts)
|
||||||
|
// — test 1 proves that hardcode actually renders end to end.
|
||||||
|
// 2. Ordinary columns (e.g. SOME_DROPDOWN) still get their rule via the
|
||||||
|
// new per-row cols[].COLTYPE path — test 2 proves the migration didn't
|
||||||
|
// silently drop real columns' rules either.
|
||||||
|
// Column positions below come from COLHEADERS in
|
||||||
|
// sas/mocks/sasjs/services/editors/getdata.js:
|
||||||
|
// "_____DELETE__THIS__RECORD_____,PRIMARY_KEY_FIELD,SOME_CHAR,SOME_DROPDOWN,..."
|
||||||
|
// — childNodes[0] on a body <tr> is the row-header <th>, so childNodes[N+1]
|
||||||
|
// is the Nth (0-indexed) column in that list.
|
||||||
|
context('coltype vertical-array regression tests: ', function () {
|
||||||
|
this.beforeAll(() => {
|
||||||
|
cy.visit(`${hostUrl}/SASLogon/logout`)
|
||||||
|
cy.loginAndUpdateValidKey(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
this.beforeEach(() => {
|
||||||
|
cy.visit(hostUrl + appLocation)
|
||||||
|
visitPage('home')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('1 | delete-record column renders its hardcoded Yes/No dropdown', () => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
|
||||||
|
clickOnEdit()
|
||||||
|
|
||||||
|
cy.get('.ht_master tbody tr', { timeout: longerCommandTimeout }).then(
|
||||||
|
(rows: any) => {
|
||||||
|
// childNodes[1] = _____DELETE__THIS__RECORD_____ (1st column)
|
||||||
|
cy.get(rows[1].childNodes[1])
|
||||||
|
.click({ force: true })
|
||||||
|
.then(($td) => {
|
||||||
|
cy.get('.htAutocompleteArrow', { withinSubject: $td })
|
||||||
|
.should('exist')
|
||||||
|
.click({ force: true })
|
||||||
|
|
||||||
|
cy.get('.autocompleteEditor .htCore tbody td').should(
|
||||||
|
($choices) => {
|
||||||
|
const texts = [...$choices].map((el) => el.innerText.trim())
|
||||||
|
expect(texts).to.deep.equal(['No', 'Yes'])
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('2 | an ordinary dropdown column (SOME_DROPDOWN) still gets its rule from cols[].COLTYPE', () => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
|
||||||
|
clickOnEdit()
|
||||||
|
|
||||||
|
cy.get('.ht_master tbody tr', { timeout: longerCommandTimeout }).then(
|
||||||
|
(rows: any) => {
|
||||||
|
// childNodes[4] = SOME_DROPDOWN (4th column, 0-indexed as 3). This
|
||||||
|
// only holds if DcValidator emits rules in VARNUM order — see the
|
||||||
|
// "orders rules by VARNUM" regression test in dc-validator.spec.ts.
|
||||||
|
cy.get(rows[1].childNodes[4])
|
||||||
|
.click({ force: true })
|
||||||
|
.then(($td) => {
|
||||||
|
cy.get('.htAutocompleteArrow', { withinSubject: $td }).should(
|
||||||
|
'exist'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const clickOnEdit = (callback?: any) => {
|
||||||
|
cy.get('.btnCtrl button.btn-primary', { timeout: longerCommandTimeout })
|
||||||
|
.click()
|
||||||
|
.then(() => {
|
||||||
|
if (callback) callback()
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const openTableFromTree = (libNameIncludes: string, tablename: string) => {
|
||||||
|
cy.get('.app-loading', { timeout: longerCommandTimeout })
|
||||||
|
.should('not.exist')
|
||||||
|
.then(() => {
|
||||||
|
cy.get('.nav-tree clr-tree > clr-tree-node', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).then((treeNodes: any) => {
|
||||||
|
let viyaLib
|
||||||
|
|
||||||
|
for (let node of treeNodes) {
|
||||||
|
if (node.innerText.toLowerCase().includes(libNameIncludes)) {
|
||||||
|
viyaLib = node
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cy.get(viyaLib).within(() => {
|
||||||
|
cy.get('.clr-tree-node-content-container > button').click()
|
||||||
|
|
||||||
|
cy.get('.clr-treenode-link').then((innerNodes: any) => {
|
||||||
|
for (let innerNode of innerNodes) {
|
||||||
|
if (innerNode.innerText.toLowerCase().includes(tablename)) {
|
||||||
|
innerNode.click()
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const visitPage = (url: string) => {
|
||||||
|
cy.visit(`${hostUrl}${appLocation}/#/${url}`)
|
||||||
|
}
|
||||||
@@ -0,0 +1,130 @@
|
|||||||
|
const hostUrl = Cypress.env('hosturl')
|
||||||
|
const appLocation = Cypress.env('appLocation')
|
||||||
|
const longerCommandTimeout = Cypress.env('longerCommandTimeout')
|
||||||
|
const serverType = Cypress.env('serverType')
|
||||||
|
const libraryToOpenIncludes = Cypress.env(`libraryToOpenIncludes_${serverType}`)
|
||||||
|
|
||||||
|
// SAS Visual Analytics data-driven content embed mode (`?embed=va`):
|
||||||
|
// - chrome is hidden (same as embed=true),
|
||||||
|
// - the editor opens in edit mode immediately (not read-only),
|
||||||
|
// - the only action button is a single Submit below the grid (stubbed in v1),
|
||||||
|
// - the top button bar and Add Record are hidden.
|
||||||
|
//
|
||||||
|
// The detailed PK+label data-merge logic is covered by the VaMessagingService
|
||||||
|
// unit spec; here we only assert the deterministic UI layout and that pushing a
|
||||||
|
// VA postMessage does not break the page.
|
||||||
|
context('embed=va (VA data-driven content) tests: ', function () {
|
||||||
|
this.beforeAll(() => {
|
||||||
|
cy.visit(`${hostUrl}/SASLogon/logout`)
|
||||||
|
cy.loginAndUpdateValidKey()
|
||||||
|
})
|
||||||
|
|
||||||
|
this.beforeEach(() => {
|
||||||
|
cy.visit(hostUrl + appLocation)
|
||||||
|
visitPage('home')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('1 | opens the editor in VA mode: chrome hidden, editable, single bottom Submit', () => {
|
||||||
|
openEditorInVaMode('mpe_x_test', () => {
|
||||||
|
// Chrome hidden (same as embed=true)
|
||||||
|
cy.get('header.app-header').should('not.exist')
|
||||||
|
|
||||||
|
// Grid present and in edit mode (read-only Filter/Edit/Upload bar absent)
|
||||||
|
cy.get('#hotTable', { timeout: longerCommandTimeout }).should('exist')
|
||||||
|
cy.get('.btnCtrl button').contains('Edit').should('not.exist')
|
||||||
|
cy.get('.btnCtrl button').contains('Filter').should('not.exist')
|
||||||
|
|
||||||
|
// Top edit-mode buttons hidden in VA mode
|
||||||
|
cy.get('.btnCtrl button.btn-outline-danger').should('not.exist') // Cancel
|
||||||
|
cy.get('.btnCtrl').contains('Add Row').should('not.exist')
|
||||||
|
|
||||||
|
// Bottom Add Record hidden
|
||||||
|
cy.contains('button', 'Add Record').should('not.exist')
|
||||||
|
|
||||||
|
// Exactly one Submit button, below the grid, disabled in v1
|
||||||
|
cy.get('button').filter(':contains("Submit")').should('have.length', 1)
|
||||||
|
cy.get('button').contains('Submit').should('be.disabled')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('2 | accepts a VA postMessage and stays in VA mode', () => {
|
||||||
|
// A VA message drives column visibility + filtering; an empty/unmatched
|
||||||
|
// message reloads the editor (unfiltered) while preserving ?embed=va.
|
||||||
|
openEditorInVaMode('mpe_x_test', () => {
|
||||||
|
cy.window().then((win) => {
|
||||||
|
win.postMessage(
|
||||||
|
{
|
||||||
|
version: '1',
|
||||||
|
resultName: 'dd1',
|
||||||
|
rowCount: 0,
|
||||||
|
availableRowCount: 0,
|
||||||
|
data: [],
|
||||||
|
columns: [],
|
||||||
|
parameters: []
|
||||||
|
},
|
||||||
|
'*'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
// Editor still loads in VA mode after the message (chrome hidden, grid up)
|
||||||
|
cy.get('#hotTable', { timeout: longerCommandTimeout }).should('exist')
|
||||||
|
cy.get('header.app-header').should('not.exist')
|
||||||
|
cy.get('button').contains('Submit').should('exist')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
// Opens a table from the tree (which routes to #/editor/LIB.TABLE), then
|
||||||
|
// re-visits the same route with ?embed=va so the app parses VA embed mode.
|
||||||
|
const openEditorInVaMode = (tablename: string, callback?: any) => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, tablename)
|
||||||
|
|
||||||
|
cy.get('#hotTable', { timeout: longerCommandTimeout })
|
||||||
|
.should('exist')
|
||||||
|
.then(() => {
|
||||||
|
cy.url().then((url) => {
|
||||||
|
const separator = url.includes('?') ? '&' : '?'
|
||||||
|
cy.visit(`${url}${separator}embed=va`)
|
||||||
|
cy.get('.app-loading', { timeout: longerCommandTimeout }).should(
|
||||||
|
'not.exist'
|
||||||
|
)
|
||||||
|
if (callback) callback()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const openTableFromTree = (libNameIncludes: string, tablename: string) => {
|
||||||
|
cy.get('.app-loading', { timeout: longerCommandTimeout })
|
||||||
|
.should('not.exist')
|
||||||
|
.then(() => {
|
||||||
|
cy.get('.nav-tree clr-tree > clr-tree-node', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).then((treeNodes: any) => {
|
||||||
|
let viyaLib
|
||||||
|
|
||||||
|
for (let node of treeNodes) {
|
||||||
|
if (node.innerText.toLowerCase().includes(libNameIncludes)) {
|
||||||
|
viyaLib = node
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cy.get(viyaLib).within(() => {
|
||||||
|
cy.get('.clr-tree-node-content-container > button').click()
|
||||||
|
|
||||||
|
cy.get('.clr-treenode-link').then((innerNodes: any) => {
|
||||||
|
for (let innerNode of innerNodes) {
|
||||||
|
if (innerNode.innerText.toLowerCase().includes(tablename)) {
|
||||||
|
innerNode.click()
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const visitPage = (url: string) => {
|
||||||
|
cy.visit(`${hostUrl}${appLocation}/#/${url}`)
|
||||||
|
}
|
||||||
@@ -386,6 +386,19 @@ context('excel tests: ', function () {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('24 | Uploads Excel with leading whitespace in header row (should still succeed)', (done) => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
|
||||||
|
|
||||||
|
// Every header except the first has a leading space, matching a
|
||||||
|
// real-world defect from copy-pasting between spreadsheets/systems.
|
||||||
|
// Header matching must tolerate
|
||||||
|
// this rather than reporting the columns missing and aborting.
|
||||||
|
attachExcelFile('leading_whitespace_header_excel.xlsx', () => {
|
||||||
|
submitExcel()
|
||||||
|
rejectExcel(done)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
// Large files break Cypress
|
// Large files break Cypress
|
||||||
|
|
||||||
// it ('? | Uploads Excel with size of 5MB', (done) => {
|
// it ('? | Uploads Excel with size of 5MB', (done) => {
|
||||||
@@ -539,7 +552,9 @@ const checkResultOfFormulaUpload = (callback?: any) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const checkResultOfXLSUpload = (callback?: any) => {
|
const checkResultOfXLSUpload = (callback?: any) => {
|
||||||
cy.viewport(1280, 720)
|
// Config-default width — wide enough that the date/datetime/time columns are
|
||||||
|
// not virtualized away (the old 1280 width hid the trailing time columns).
|
||||||
|
cy.viewport(1600, 900)
|
||||||
cy.get('#hotTable', { timeout: 30000 })
|
cy.get('#hotTable', { timeout: 30000 })
|
||||||
.find('div.ht_master.handsontable')
|
.find('div.ht_master.handsontable')
|
||||||
.find('div.wtHolder')
|
.find('div.wtHolder')
|
||||||
@@ -557,14 +572,15 @@ const checkResultOfXLSUpload = (callback?: any) => {
|
|||||||
expect(cell.innerText).to.equal('▼\nOption 1')
|
expect(cell.innerText).to.equal('▼\nOption 1')
|
||||||
cell = data[0].children[0].children[5]
|
cell = data[0].children[0].children[5]
|
||||||
expect(cell.innerText).to.equal('42')
|
expect(cell.innerText).to.equal('42')
|
||||||
|
// Cells render the raw stored ISO string verbatim (locale-independent;
|
||||||
|
// see registerIntlCellTypes). date -> YYYY-MM-DD, datetime ->
|
||||||
|
// YYYY-MM-DD HH:mm:ss, time -> HH:mm:ss.
|
||||||
cell = data[0].children[0].children[6]
|
cell = data[0].children[0].children[6]
|
||||||
expect(cell.innerText).to.equal('▼\n1960-02-12')
|
expect(cell.innerText).to.equal('1960-02-12')
|
||||||
// When CI detached browser screen is smaller, below cells are not visible so test fails
|
cell = data[0].children[0].children[7]
|
||||||
// Commenting it out now until we figure out workaround
|
expect(cell.innerText).to.equal('1960-01-01 00:00:42')
|
||||||
// cell = data[0].children[0].children[7]
|
cell = data[0].children[0].children[8]
|
||||||
// expect(cell.innerText).to.equal('▼\n1960-01-01 00:00:42')
|
expect(cell.innerText).to.equal('00:00:42')
|
||||||
// cell = data[0].children[0].children[8]
|
|
||||||
// expect(cell.innerText).to.equal('00:00:42')
|
|
||||||
|
|
||||||
if (callback) callback()
|
if (callback) callback()
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -0,0 +1,243 @@
|
|||||||
|
// Marks this file as an ES module (rather than a global script) so its
|
||||||
|
// top-level consts don't collide, under the TS type-checker, with the same
|
||||||
|
// names declared in other spec files — see e.g. download.cy.ts, which gets
|
||||||
|
// this for free via a real import.
|
||||||
|
export {}
|
||||||
|
|
||||||
|
const username = Cypress.env('username')
|
||||||
|
const password = Cypress.env('password')
|
||||||
|
const hostUrl = Cypress.env('hosturl')
|
||||||
|
const appLocation = Cypress.env('appLocation')
|
||||||
|
const longerCommandTimeout = Cypress.env('longerCommandTimeout')
|
||||||
|
const serverType = Cypress.env('serverType')
|
||||||
|
const libraryToOpenIncludes = Cypress.env(`libraryToOpenIncludes_${serverType}`)
|
||||||
|
|
||||||
|
// Viewer column-label display toggle (`?labels=true`): clients surfacing DC in
|
||||||
|
// SAS Visual Analytics want column LABELs shown instead of NAMEs. Default
|
||||||
|
// behavior (no param) must stay unchanged; the right-click context menu's
|
||||||
|
// "Show labels"/"Show names" item is the in-app affordance, and it drives the
|
||||||
|
// same URL param so state is shareable/refreshable. See mock data in
|
||||||
|
// sas/mocks/sasjs/services/public/viewdata.js: MPE_X_TEST's SOME_CHAR/SOME_DATE
|
||||||
|
// have LABELs that differ from NAME, and SOME_NUM has a blank LABEL (fallback
|
||||||
|
// to NAME) — this spec exercises exactly that fixture.
|
||||||
|
context('viewer column labels toggle tests: ', function () {
|
||||||
|
this.beforeAll(() => {
|
||||||
|
cy.visit(`${hostUrl}/SASLogon/logout`)
|
||||||
|
// forceLicenceKey=true: without it, loginAndUpdateValidKey() only
|
||||||
|
// generates key data and logs back out if no valid license already
|
||||||
|
// exists — it doesn't actually apply one (see commands.ts). Several
|
||||||
|
// specs call it with no argument and rely on an *earlier* spec in the
|
||||||
|
// same CI run having already forced a valid license onto the shared
|
||||||
|
// server first (csv.cy.ts, excel.cy.ts, etc.). This spec shouldn't
|
||||||
|
// depend on run order, so force it explicitly.
|
||||||
|
cy.loginAndUpdateValidKey(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
this.beforeEach(() => {
|
||||||
|
// No re-login here: beforeAll's loginAndUpdateValidKey() already
|
||||||
|
// authenticated the session, and it persists across tests in this file
|
||||||
|
// (see filtering.cy.ts/csv.cy.ts for the same pattern). Re-typing into
|
||||||
|
// the login form would fail — it's hidden once already logged in.
|
||||||
|
cy.visit(hostUrl + appLocation)
|
||||||
|
|
||||||
|
// Visit 'home' first, matching filtering.cy.ts/csv.cy.ts/download.cy.ts —
|
||||||
|
// going straight to 'view/data' skips whatever startup-data fetch 'home'
|
||||||
|
// triggers, which passed locally (fast round-trips) but left the
|
||||||
|
// nav-tree empty in CI's slower environment.
|
||||||
|
visitPage('home')
|
||||||
|
visitPage('view/data')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('1 | default (no param): headers show NAMEs', () => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
|
||||||
|
|
||||||
|
cy.get('#hotTable .ht_clone_top .htCore thead tr', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).should(($headerRow) => {
|
||||||
|
expect($headerRow[0].innerHTML).to.include('SOME_CHAR')
|
||||||
|
expect($headerRow[0].innerHTML).to.not.include('Some Character Column')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('2 | ?labels=true: headers show LABELs, blank LABEL falls back to NAME', () => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
|
||||||
|
appendUrlParam('labels=true')
|
||||||
|
|
||||||
|
cy.get('#hotTable .ht_clone_top .htCore thead tr', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).should(($headerRow) => {
|
||||||
|
const html = $headerRow[0].innerHTML
|
||||||
|
expect(html).to.include('Some Character Column')
|
||||||
|
expect(html).to.include('Some Date')
|
||||||
|
// SOME_NUM has a blank LABEL in the mock -> falls back to NAME
|
||||||
|
expect(html).to.include('SOME_NUM')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('3 | context menu "Show labels"/"Show names" toggles headers and the URL', () => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
|
||||||
|
|
||||||
|
toggleColumnLabelsFromContextMenu('Show labels')
|
||||||
|
|
||||||
|
cy.url().should('include', 'labels=true')
|
||||||
|
cy.get('#hotTable .ht_clone_top .htCore thead tr', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).should(($headerRow) => {
|
||||||
|
expect($headerRow[0].innerHTML).to.include('Some Character Column')
|
||||||
|
})
|
||||||
|
|
||||||
|
toggleColumnLabelsFromContextMenu('Show names')
|
||||||
|
|
||||||
|
cy.url().should('not.include', 'labels=true')
|
||||||
|
cy.get('#hotTable .ht_clone_top .htCore thead tr', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).should(($headerRow) => {
|
||||||
|
expect($headerRow[0].innerHTML).to.include('SOME_CHAR')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('4 | ?embed=va&labels=true: labels shown with embed chrome hidden', () => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
|
||||||
|
appendUrlParam('embed=va&labels=true')
|
||||||
|
|
||||||
|
cy.get('header.app-header').should('not.exist')
|
||||||
|
cy.get('#hotTable .ht_clone_top .htCore thead tr', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).should(($headerRow) => {
|
||||||
|
expect($headerRow[0].innerHTML).to.include('Some Character Column')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('5 | info dropdown: first line is NAME (in both toggle states)', () => {
|
||||||
|
openTableFromTree(libraryToOpenIncludes, 'mpe_x_test')
|
||||||
|
|
||||||
|
// No assertion on the item's label text here: `info` has a custom
|
||||||
|
// `renderer`, so Handsontable never renders its `name` ("test info") as
|
||||||
|
// text at all — the renderer's own output (checked below) is the only
|
||||||
|
// real content.
|
||||||
|
openColumnDropdown('SOME_CHAR')
|
||||||
|
cy.get('.htDropdownMenu').should(($menu) => {
|
||||||
|
expect($menu.text()).to.match(/NAME: SOME_CHAR/)
|
||||||
|
})
|
||||||
|
cy.get('body').click(0, 0) // close menu
|
||||||
|
|
||||||
|
appendUrlParam('labels=true')
|
||||||
|
|
||||||
|
openColumnDropdown('Some Character Column')
|
||||||
|
cy.get('.htDropdownMenu').should(($menu) => {
|
||||||
|
// NAME is always shown first, even while headers display as LABEL
|
||||||
|
expect($menu.text()).to.match(/NAME: SOME_CHAR/)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
const visitPage = (url: string) => {
|
||||||
|
cy.visit(`${hostUrl}${appLocation}/#/${url}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Re-visits the current route with extra hash-query params appended, then
|
||||||
|
// forces a real reload. Under hash routing (`useHash: true`), changing only
|
||||||
|
// the URL's hash fragment is a same-document navigation — Angular Router
|
||||||
|
// still reacts to it (which is enough for `useLabels`, read reactively from
|
||||||
|
// `route.queryParams`), but `embed` is parsed once from `window.location.hash`
|
||||||
|
// at app bootstrap (app.component.ts), so `?embed=va` only takes effect after
|
||||||
|
// an actual reload.
|
||||||
|
const appendUrlParam = (param: string) => {
|
||||||
|
cy.url().then((url) => {
|
||||||
|
const separator = url.includes('?') ? '&' : '?'
|
||||||
|
cy.visit(`${url}${separator}${param}`)
|
||||||
|
cy.reload()
|
||||||
|
cy.get('.app-loading', { timeout: longerCommandTimeout }).should(
|
||||||
|
'not.exist'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
const openColumnDropdown = (headerText: string) => {
|
||||||
|
// Handsontable renders the sticky/frozen header via a separate clone pane
|
||||||
|
// (.ht_clone_top) for scroll behavior; the header row inside the main
|
||||||
|
// .ht_master pane is kept visibility:hidden (replaced visually by the
|
||||||
|
// clone). .ht_clone_top is the real, interactive one — confirmed via
|
||||||
|
// `document.querySelector('#hotTable .ht_clone_top thead').innerText` in
|
||||||
|
// a live browser session.
|
||||||
|
cy.get('#hotTable .ht_clone_top .htCore thead button.changeType', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
})
|
||||||
|
.parents('th')
|
||||||
|
.filter((_, th) => Cypress.$(th).text().includes(headerText))
|
||||||
|
.last()
|
||||||
|
.as('targetHeader')
|
||||||
|
|
||||||
|
// Click the header text first to select the column — the `info` item's
|
||||||
|
// renderer reads hot.getSelected() to decide which column to describe,
|
||||||
|
// so without an active selection it always shows "No info found".
|
||||||
|
cy.get('@targetHeader').click()
|
||||||
|
cy.get('@targetHeader').find('button.changeType').click({ force: true })
|
||||||
|
}
|
||||||
|
|
||||||
|
const toggleColumnLabelsFromContextMenu = (
|
||||||
|
menuItemText: 'Show labels' | 'Show names'
|
||||||
|
) => {
|
||||||
|
cy.get('#hotTable .ht_master.handsontable .htCore tbody tr td', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
})
|
||||||
|
.first()
|
||||||
|
// force: true — the first body row can sit under an overlay clone's
|
||||||
|
// header/sort-icon layer, which fails Cypress's actionability check
|
||||||
|
// even though the cell is the real rightclick target underneath.
|
||||||
|
.rightclick({ force: true })
|
||||||
|
|
||||||
|
cy.get('.htContextMenu').contains(menuItemText).click()
|
||||||
|
|
||||||
|
cy.get('.app-loading', { timeout: longerCommandTimeout }).should('not.exist')
|
||||||
|
}
|
||||||
|
|
||||||
|
const openTableFromTree = (libNameIncludes: string, tablename: string) => {
|
||||||
|
cy.get('.app-loading', { timeout: longerCommandTimeout })
|
||||||
|
.should('not.exist')
|
||||||
|
.then(() => {
|
||||||
|
cy.get('.nav-tree clr-tree > clr-tree-node', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).then((treeNodes: any) => {
|
||||||
|
let viyaLib
|
||||||
|
|
||||||
|
for (let node of treeNodes) {
|
||||||
|
if (node.innerText.toLowerCase().includes(libNameIncludes)) {
|
||||||
|
viyaLib = node
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cy.get(viyaLib).within(() => {
|
||||||
|
// Small settle wait: right after a fresh visit/reload, the tree
|
||||||
|
// component can still be re-rendering, causing this node to be
|
||||||
|
// found then swapped out mid-click ("disappeared from the page").
|
||||||
|
cy.wait(300)
|
||||||
|
|
||||||
|
cy.get(
|
||||||
|
'.clr-tree-node-content-container .clr-treenode-content p'
|
||||||
|
).click()
|
||||||
|
|
||||||
|
cy.get('.clr-treenode-link').then((innerNodes: any) => {
|
||||||
|
for (let innerNode of innerNodes) {
|
||||||
|
if (innerNode.innerText.toLowerCase().includes(tablename)) {
|
||||||
|
innerNode.click()
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
// Selecting the table triggers async SPA routing + a viewdata fetch;
|
||||||
|
// wait for the grid to actually render before any subsequent action
|
||||||
|
// (reading the URL, right-clicking, opening a header dropdown) — without
|
||||||
|
// this, callers can act while still on the intermediate library-only
|
||||||
|
// route or a not-yet-rendered grid. Waiting specifically for a header's
|
||||||
|
// dropdown button (not just the <tr> shell) confirms Handsontable has
|
||||||
|
// finished populating header cell contents, not just their DOM rows.
|
||||||
|
cy.get('#hotTable .ht_clone_top .htCore thead button.changeType', {
|
||||||
|
timeout: longerCommandTimeout
|
||||||
|
}).should('exist')
|
||||||
|
}
|
||||||
Binary file not shown.
@@ -23,21 +23,33 @@
|
|||||||
//
|
//
|
||||||
// -- This will overwrite an existing command --
|
// -- This will overwrite an existing command --
|
||||||
// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
|
// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
|
||||||
import 'cypress-file-upload';
|
import 'cypress-file-upload'
|
||||||
|
|
||||||
import { arrayBufferToBase64 } from './../util/helper-functions'
|
import { arrayBufferToBase64 } from './../util/helper-functions'
|
||||||
import * as moment from 'moment'
|
import moment from 'moment'
|
||||||
|
|
||||||
const username = Cypress.env('username');
|
// These custom commands were added via Cypress.Commands.add() below but never
|
||||||
const password = Cypress.env('password');
|
// had a type augmentation, so every spec calling cy.loginAndUpdateValidKey()/
|
||||||
const hostUrl = Cypress.env('hosturl');
|
// cy.isLoggedIn() had an unresolved-property error.
|
||||||
const appLocation = Cypress.env('appLocation');
|
declare global {
|
||||||
|
namespace Cypress {
|
||||||
|
interface Chainable {
|
||||||
|
isLoggedIn(callback: (exist: boolean) => void): Chainable<void>
|
||||||
|
loginAndUpdateValidKey(forceLicenceKey?: boolean): Chainable<void>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const username = Cypress.env('username')
|
||||||
|
const password = Cypress.env('password')
|
||||||
|
const hostUrl = Cypress.env('hosturl')
|
||||||
|
const appLocation = Cypress.env('appLocation')
|
||||||
const longerCommandTimeout = Cypress.env('longerCommandTimeout')
|
const longerCommandTimeout = Cypress.env('longerCommandTimeout')
|
||||||
const site_id_SASJS = Cypress.env('site_id_SASJS')
|
const site_id_SASJS = Cypress.env('site_id_SASJS')
|
||||||
|
|
||||||
Cypress.Commands.add('isLoggedIn', (callback: (exist: boolean) => void) => {
|
Cypress.Commands.add('isLoggedIn', (callback: (exist: boolean) => void) => {
|
||||||
cy.get('body').then($body => {
|
cy.get('body').then(($body) => {
|
||||||
if ($body.find(".nav-tree").length > 0) {
|
if ($body.find('.nav-tree').length > 0) {
|
||||||
if (callback) callback(true)
|
if (callback) callback(true)
|
||||||
} else {
|
} else {
|
||||||
if (callback) callback(false)
|
if (callback) callback(false)
|
||||||
@@ -45,76 +57,92 @@ Cypress.Commands.add('isLoggedIn', (callback: (exist: boolean) => void) => {
|
|||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
Cypress.Commands.add('loginAndUpdateValidKey', (forceLicenceKey: boolean = false) => {
|
Cypress.Commands.add(
|
||||||
cy.visit(hostUrl + appLocation);
|
'loginAndUpdateValidKey',
|
||||||
|
(forceLicenceKey: boolean = false) => {
|
||||||
|
cy.visit(hostUrl + appLocation)
|
||||||
|
|
||||||
cy.wait(2000)
|
cy.wait(2000)
|
||||||
|
|
||||||
cy.get('body').then($body =>{
|
cy.get('body').then(($body) => {
|
||||||
const usernameInput = $body.find("input.username")[0]
|
const usernameInput = $body.find('input.username')[0]
|
||||||
|
|
||||||
if (usernameInput && !Cypress.dom.isHidden(usernameInput)) {
|
if (usernameInput && !Cypress.dom.isHidden(usernameInput)) {
|
||||||
cy.get('input.username').type(username);
|
cy.get('input.username').type(username)
|
||||||
cy.get('input.password').type(password);
|
cy.get('input.password').type(password)
|
||||||
|
|
||||||
cy.get('.login-group button').click()
|
cy.get('.login-group button').click()
|
||||||
}
|
}
|
||||||
|
|
||||||
cy.get('.app-loading', {timeout: longerCommandTimeout}).should('not.exist').then(() => {
|
cy.get('.app-loading', { timeout: longerCommandTimeout })
|
||||||
cy.wait(2000)
|
.should('not.exist')
|
||||||
|
.then(() => {
|
||||||
|
cy.wait(2000)
|
||||||
|
|
||||||
if ($body.find(".nav-tree").length > 0) {
|
if ($body.find('.nav-tree').length > 0) {
|
||||||
/**
|
/**
|
||||||
* If licence key is already working, then skip rest of the function
|
* If licence key is already working, then skip rest of the function
|
||||||
*/
|
*/
|
||||||
return logout(() => {
|
return logout(() => {
|
||||||
return
|
return
|
||||||
})
|
})
|
||||||
} else{
|
} else {
|
||||||
const keyData = {
|
const keyData = {
|
||||||
valid_until: moment().add(20, 'day').format('YYYY-MM-DD'),
|
valid_until: moment().add(20, 'day').format('YYYY-MM-DD'),
|
||||||
number_of_users: 10,
|
number_of_users: 10,
|
||||||
hot_license_key: '',
|
hot_license_key: '',
|
||||||
site_id: '',
|
site_id: '',
|
||||||
demo: false
|
demo: false
|
||||||
}
|
|
||||||
|
|
||||||
return generateKeys(keyData.valid_until, keyData.number_of_users, keyData.hot_license_key, keyData.demo, (keysGen: any) => {
|
|
||||||
return acceptTermsIfPresented((result: boolean) => {
|
|
||||||
if (result) {
|
|
||||||
cy.wait(20000)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!forceLicenceKey) {
|
return generateKeys(
|
||||||
return logout(() => {
|
keyData.valid_until,
|
||||||
return
|
keyData.number_of_users,
|
||||||
})
|
keyData.hot_license_key,
|
||||||
} else {
|
keyData.demo,
|
||||||
return updateLicenseKeyQuick(keysGen, () => {
|
(keysGen: any) => {
|
||||||
cy.wait(25000)
|
|
||||||
return acceptTermsIfPresented((result: boolean) => {
|
return acceptTermsIfPresented((result: boolean) => {
|
||||||
if (result) {
|
if (result) {
|
||||||
cy.wait(20000)
|
cy.wait(20000)
|
||||||
}
|
}
|
||||||
return logout(() => {
|
|
||||||
return
|
if (!forceLicenceKey) {
|
||||||
})
|
return logout(() => {
|
||||||
|
return
|
||||||
|
})
|
||||||
|
} else {
|
||||||
|
return updateLicenseKeyQuick(keysGen, () => {
|
||||||
|
cy.wait(25000)
|
||||||
|
return acceptTermsIfPresented((result: boolean) => {
|
||||||
|
if (result) {
|
||||||
|
cy.wait(20000)
|
||||||
|
}
|
||||||
|
return logout(() => {
|
||||||
|
return
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
})
|
})
|
||||||
})
|
}
|
||||||
}
|
)
|
||||||
})
|
}
|
||||||
})
|
})
|
||||||
}
|
|
||||||
})
|
})
|
||||||
});
|
}
|
||||||
});
|
)
|
||||||
|
|
||||||
const logout = (callback?: any) => {
|
const logout = (callback?: any) => {
|
||||||
cy.get('.header-actions .dropdown-toggle').click().then(() => {
|
cy.get('.header-actions .dropdown-toggle')
|
||||||
cy.get('.header-actions .dropdown-menu > .separator').next().click().then(() => {
|
.click()
|
||||||
if (callback) callback()
|
.then(() => {
|
||||||
|
cy.get('.header-actions .dropdown-menu > .separator')
|
||||||
|
.next()
|
||||||
|
.click()
|
||||||
|
.then(() => {
|
||||||
|
if (callback) callback()
|
||||||
|
})
|
||||||
})
|
})
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const updateLicenseKeyQuick = (keys: any, callback: any) => {
|
const updateLicenseKeyQuick = (keys: any, callback: any) => {
|
||||||
@@ -132,11 +160,15 @@ const updateLicenseKeyQuick = (keys: any, callback: any) => {
|
|||||||
const acceptTermsIfPresented = (callback?: any) => {
|
const acceptTermsIfPresented = (callback?: any) => {
|
||||||
cy.url().then((url: string) => {
|
cy.url().then((url: string) => {
|
||||||
if (url.includes('licensing/register')) {
|
if (url.includes('licensing/register')) {
|
||||||
cy.get('.card-block').scrollTo('bottom').then(() => {
|
cy.get('.card-block')
|
||||||
cy.get('#checkbox1').click().then(() => {
|
.scrollTo('bottom')
|
||||||
if (callback) callback(true)
|
.then(() => {
|
||||||
|
cy.get('#checkbox1')
|
||||||
|
.click()
|
||||||
|
.then(() => {
|
||||||
|
if (callback) callback(true)
|
||||||
|
})
|
||||||
})
|
})
|
||||||
})
|
|
||||||
} else {
|
} else {
|
||||||
if (callback) callback(false)
|
if (callback) callback(false)
|
||||||
}
|
}
|
||||||
@@ -151,23 +183,36 @@ const isLicensingPage = (callback: any) => {
|
|||||||
|
|
||||||
const inputLicenseKeyPage = (licenseKey: string, activationKey: string) => {
|
const inputLicenseKeyPage = (licenseKey: string, activationKey: string) => {
|
||||||
cy.get('button').contains('Paste licence').click()
|
cy.get('button').contains('Paste licence').click()
|
||||||
cy.get('.license-key-form textarea', {timeout: longerCommandTimeout}).invoke('val', licenseKey).trigger('input').should('not.be.undefined')
|
cy.get('.license-key-form textarea', { timeout: longerCommandTimeout })
|
||||||
cy.get('.activation-key-form textarea', {timeout: longerCommandTimeout}).invoke('val', activationKey).trigger('input').should('not.be.undefined')
|
.invoke('val', licenseKey)
|
||||||
|
.trigger('input')
|
||||||
|
.should('not.be.undefined')
|
||||||
|
cy.get('.activation-key-form textarea', { timeout: longerCommandTimeout })
|
||||||
|
.invoke('val', activationKey)
|
||||||
|
.trigger('input')
|
||||||
|
.should('not.be.undefined')
|
||||||
cy.get('button.apply-keys').click()
|
cy.get('button.apply-keys').click()
|
||||||
}
|
}
|
||||||
|
|
||||||
const visitPage = (url: string) => {
|
const visitPage = (url: string) => {
|
||||||
cy.visit(`${hostUrl}${appLocation}/#/${url}`);
|
cy.visit(`${hostUrl}${appLocation}/#/${url}`)
|
||||||
}
|
}
|
||||||
const generateKeys = async (valid_until: string, users_allowed: number, hot_license_key: string, demo: boolean, resultCallback?: any) => {
|
const generateKeys = async (
|
||||||
let keyPair = await window.crypto.subtle.generateKey({
|
valid_until: string,
|
||||||
name: "RSA-OAEP",
|
users_allowed: number,
|
||||||
modulusLength: 2024,
|
hot_license_key: string,
|
||||||
publicExponent: new Uint8Array([1, 0, 1]),
|
demo: boolean,
|
||||||
hash: "SHA-256"
|
resultCallback?: any
|
||||||
|
) => {
|
||||||
|
let keyPair = await window.crypto.subtle.generateKey(
|
||||||
|
{
|
||||||
|
name: 'RSA-OAEP',
|
||||||
|
modulusLength: 2024,
|
||||||
|
publicExponent: new Uint8Array([1, 0, 1]),
|
||||||
|
hash: 'SHA-256'
|
||||||
},
|
},
|
||||||
true,
|
true,
|
||||||
["encrypt", "decrypt"]
|
['encrypt', 'decrypt']
|
||||||
)
|
)
|
||||||
|
|
||||||
let licenseData = {
|
let licenseData = {
|
||||||
@@ -184,30 +229,39 @@ const generateKeys = async (valid_until: string, users_allowed: number, hot_lice
|
|||||||
|
|
||||||
console.log(encoded)
|
console.log(encoded)
|
||||||
|
|
||||||
let cipher = await window.crypto.subtle.encrypt(
|
let cipher = await window.crypto.subtle
|
||||||
{
|
.encrypt(
|
||||||
name: "RSA-OAEP"
|
{
|
||||||
},
|
name: 'RSA-OAEP'
|
||||||
keyPair.publicKey,
|
},
|
||||||
encoded
|
keyPair.publicKey,
|
||||||
).then((value) => {
|
encoded
|
||||||
return value
|
)
|
||||||
}, (err) => {
|
.then(
|
||||||
console.log('Encrpyt error', err)
|
(value) => {
|
||||||
})
|
return value
|
||||||
|
},
|
||||||
|
(err) => {
|
||||||
|
console.log('Encrpyt error', err)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
if (!cipher) {
|
if (!cipher) {
|
||||||
alert('Encryptin keys failed')
|
alert('Encryptin keys failed')
|
||||||
throw new Error('Encryptin keys failed')
|
throw new Error('Encryptin keys failed')
|
||||||
}
|
}
|
||||||
|
|
||||||
let privateKeyBytes = await window.crypto.subtle.exportKey('pkcs8', keyPair.privateKey)
|
let privateKeyBytes = await window.crypto.subtle.exportKey(
|
||||||
|
'pkcs8',
|
||||||
|
keyPair.privateKey
|
||||||
|
)
|
||||||
|
|
||||||
let activationKey = await arrayBufferToBase64(privateKeyBytes)
|
let activationKey = await arrayBufferToBase64(privateKeyBytes)
|
||||||
let licenseKey = await arrayBufferToBase64(cipher)
|
let licenseKey = await arrayBufferToBase64(cipher)
|
||||||
|
|
||||||
if (resultCallback) resultCallback({
|
if (resultCallback)
|
||||||
activationKey,
|
resultCallback({
|
||||||
licenseKey
|
activationKey,
|
||||||
})
|
licenseKey
|
||||||
}
|
})
|
||||||
|
}
|
||||||
|
|||||||
@@ -20,4 +20,16 @@ import './commands'
|
|||||||
// require('./commands')
|
// require('./commands')
|
||||||
|
|
||||||
import 'cypress-plugin-tab'
|
import 'cypress-plugin-tab'
|
||||||
import "cypress-real-events"
|
import 'cypress-real-events'
|
||||||
|
|
||||||
|
// Pin the locale
|
||||||
|
Cypress.on('window:before:load', (win) => {
|
||||||
|
Object.defineProperty(win.navigator, 'language', {
|
||||||
|
value: 'en-GB',
|
||||||
|
configurable: true
|
||||||
|
})
|
||||||
|
Object.defineProperty(win.navigator, 'languages', {
|
||||||
|
value: ['en-GB'],
|
||||||
|
configurable: true
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ const check = (cwd) => {
|
|||||||
onlyAllow:
|
onlyAllow:
|
||||||
'AFLv2.1;Apache 2.0;Apache-2.0;Apache*;Artistic-2.0;0BSD;BSD*;BSD-2-Clause;BSD-3-Clause;CC0-1.0;CC-BY-3.0;CC-BY-4.0;ISC;MIT;MPL-2.0;ODC-By-1.0;Python-2.0;Unlicense;',
|
'AFLv2.1;Apache 2.0;Apache-2.0;Apache*;Artistic-2.0;0BSD;BSD*;BSD-2-Clause;BSD-3-Clause;CC0-1.0;CC-BY-3.0;CC-BY-4.0;ISC;MIT;MPL-2.0;ODC-By-1.0;Python-2.0;Unlicense;',
|
||||||
excludePackages:
|
excludePackages:
|
||||||
'@cds/city@1.1.0;@handsontable/angular-wrapper@16.0.1;handsontable@^16.0.1;handsontable@16.2.0;hyperformula@2.7.1;hyperformula@3.0.0;hyperformula@3.1.0;hyperformula@3.2.0;jackspeak@3.4.3;path-scurry@1.11.1;package-json-from-dist@1.0.1'
|
'@cds/city@1.1.0;@handsontable/angular-wrapper@16.0.1;@handsontable/angular-wrapper@17.1.0;@handsontable/angular-wrapper@18.0.0;handsontable@^16.0.1;handsontable@16.2.0;handsontable@17.1.0;handsontable@18.0.0;hyperformula@2.7.1;hyperformula@3.0.0;hyperformula@3.1.0;hyperformula@3.2.0;hyperformula@3.3.0;jackspeak@3.4.3;path-scurry@1.11.1;package-json-from-dist@1.0.1;buffers@0.1.1'
|
||||||
},
|
},
|
||||||
(error, json) => {
|
(error, json) => {
|
||||||
if (error) {
|
if (error) {
|
||||||
|
|||||||
Generated
+1982
-799
File diff suppressed because it is too large
Load Diff
+14
-6
@@ -17,13 +17,17 @@
|
|||||||
"deploy_viya": "rsync -avhe ssh ./dist/* --delete ${npm_config_account}@sas.4gl.io:/var/www/html/${npm_config_account}/dc/dev",
|
"deploy_viya": "rsync -avhe ssh ./dist/* --delete ${npm_config_account}@sas.4gl.io:/var/www/html/${npm_config_account}/dc/dev",
|
||||||
"deploy_sasjs": "rsync -avhe ssh ./dist/* --delete root@${npm_config_account}.4gl.io:/var/www/html/dc/dev",
|
"deploy_sasjs": "rsync -avhe ssh ./dist/* --delete root@${npm_config_account}.4gl.io:/var/www/html/dc/dev",
|
||||||
"viyabuild": "cd build; ./viyabuild.sh",
|
"viyabuild": "cd build; ./viyabuild.sh",
|
||||||
"lint": "cd .. && npm run lint",
|
"lint": "npm run lint:fix",
|
||||||
|
"lint:fix": "npx prettier --write \"{src,test}/**/*.{ts,tsx,js,jsx,html,css,sass,less,yml,md,graphql}\" \"cypress/e2e/*.cy.ts\"",
|
||||||
|
"lint:fix:silent": "npx prettier --log-level silent --write \"{src,test}/**/*.{ts,tsx,js,jsx,html,css,sass,less,yml,md,graphql}\" \"cypress/e2e/*.cy.ts\"",
|
||||||
|
"lint:check": "npx prettier --check \"{src,test}/**/*.{ts,tsx,js,jsx,html,css,sass,less,yml,md,graphql}\" \"cypress/e2e/*.cy.ts\"",
|
||||||
|
"lint:check:silent": "npx prettier --log-level silent --check \"{src,test}/**/*.{ts,tsx,js,jsx,html,css,sass,less,yml,md,graphql}\" \"cypress/e2e/*.cy.ts\"",
|
||||||
"test": "npx ng test",
|
"test": "npx ng test",
|
||||||
"test:headless": "npx ng test --no-watch --no-progress --browsers ChromeHeadlessCI",
|
"test:headless": "npx ng test --no-watch --no-progress --browsers ChromeHeadlessCI",
|
||||||
"watch": "ng test watch=true",
|
"watch": "ng test watch=true",
|
||||||
"pree2e": "webdriver-manager update",
|
"pree2e": "webdriver-manager update",
|
||||||
"e2e": "protractor protractor.config.js",
|
"e2e": "protractor protractor.config.js",
|
||||||
"postinstall": "node ./src/version.ts && npm run add-githook && node ./scripts/strip-clr-base64-fonts.mjs",
|
"postinstall": "node ./src/version.ts && npm run add-githook && node ./scripts/strip-clr-base64-fonts.mjs && node ./scripts/gen-hot-icons.mjs",
|
||||||
"add-githook": "[ -d ../.git ] && git config core.hooksPath ./.git-hooks || true",
|
"add-githook": "[ -d ../.git ] && git config core.hooksPath ./.git-hooks || true",
|
||||||
"cypress": "cypress open",
|
"cypress": "cypress open",
|
||||||
"cy:run": "cypress run",
|
"cy:run": "cypress run",
|
||||||
@@ -50,8 +54,8 @@
|
|||||||
"@clr/angular": "file:libraries/clr-angular-17.9.0.tgz",
|
"@clr/angular": "file:libraries/clr-angular-17.9.0.tgz",
|
||||||
"@clr/icons": "^13.0.2",
|
"@clr/icons": "^13.0.2",
|
||||||
"@clr/ui": "file:libraries/clr-ui-17.9.0.tgz",
|
"@clr/ui": "file:libraries/clr-ui-17.9.0.tgz",
|
||||||
"@handsontable/angular-wrapper": "16.0.1",
|
"@handsontable/angular-wrapper": "^18.0.0",
|
||||||
"@sasjs/adapter": "^4.16.7",
|
"@sasjs/adapter": "^4.17.0",
|
||||||
"@sasjs/utils": "^3.5.3",
|
"@sasjs/utils": "^3.5.3",
|
||||||
"@sheet/crypto": "file:libraries/sheet-crypto.tgz",
|
"@sheet/crypto": "file:libraries/sheet-crypto.tgz",
|
||||||
"@types/d3-graphviz": "^2.6.7",
|
"@types/d3-graphviz": "^2.6.7",
|
||||||
@@ -61,8 +65,9 @@
|
|||||||
"crypto-browserify": "^3.12.1",
|
"crypto-browserify": "^3.12.1",
|
||||||
"crypto-js": "^4.2.0",
|
"crypto-js": "^4.2.0",
|
||||||
"d3-graphviz": "^5.0.2",
|
"d3-graphviz": "^5.0.2",
|
||||||
|
"exceljs": "^4.4.0",
|
||||||
"fs-extra": "^7.0.1",
|
"fs-extra": "^7.0.1",
|
||||||
"handsontable": "^16.0.1",
|
"handsontable": "^18.0.0",
|
||||||
"https-browserify": "1.0.0",
|
"https-browserify": "1.0.0",
|
||||||
"hyperformula": "^2.5.0",
|
"hyperformula": "^2.5.0",
|
||||||
"iconv-lite": "^0.5.0",
|
"iconv-lite": "^0.5.0",
|
||||||
@@ -125,6 +130,7 @@
|
|||||||
"lodash-es": "^4.17.21",
|
"lodash-es": "^4.17.21",
|
||||||
"mochawesome": "^7.1.3",
|
"mochawesome": "^7.1.3",
|
||||||
"mutationobserver-shim": "^0.3.3",
|
"mutationobserver-shim": "^0.3.3",
|
||||||
|
"prettier": "3.8.4",
|
||||||
"replace-in-file": "^6.3.5",
|
"replace-in-file": "^6.3.5",
|
||||||
"rimraf": "3.0.2",
|
"rimraf": "3.0.2",
|
||||||
"ts-loader": "^9.2.8",
|
"ts-loader": "^9.2.8",
|
||||||
@@ -134,6 +140,8 @@
|
|||||||
"watch": "^1.0.2"
|
"watch": "^1.0.2"
|
||||||
},
|
},
|
||||||
"overrides": {
|
"overrides": {
|
||||||
"ajv": "8.18.0"
|
"ajv": "8.18.0",
|
||||||
|
"uuid": "11.1.1",
|
||||||
|
"lighthouse": "13.4.0"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,69 @@
|
|||||||
|
import { readFileSync, writeFileSync, mkdirSync, rmSync, existsSync } from 'fs'
|
||||||
|
import { resolve, join } from 'path'
|
||||||
|
import { createRequire } from 'module'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Generate static SVG assets + an SCSS partial that re-applies HOT v17 classic
|
||||||
|
* theme icons via real URLs (not data: URIs).
|
||||||
|
*
|
||||||
|
* Why: deployed app runs under CSP `img-src 'self'`. HOT v17's classic theme
|
||||||
|
* embeds icons as `data:image/svg+xml,...` in `-webkit-mask-image` rules, which
|
||||||
|
* the CSP blocks. We switch to `ht-theme-classic-no-icons.min.css` and re-add
|
||||||
|
* the icon rules pointing at same-origin SVG files emitted from this script.
|
||||||
|
*
|
||||||
|
* Inputs (HOT's own modules, so semantic names + selector list track upstream):
|
||||||
|
* handsontable/themes/theme/classic → { classicTheme: { icons } }
|
||||||
|
* handsontable/themes/static/variables/helpers/iconsMap → iconsMap(icons, themePrefix)
|
||||||
|
*
|
||||||
|
* Outputs:
|
||||||
|
* client/src/assets/hot-icons/<kebab-name>.svg
|
||||||
|
* client/src/_hot-icons.scss
|
||||||
|
*
|
||||||
|
* Idempotent: clears the output dir and rewrites both outputs each run.
|
||||||
|
* Skips silently if handsontable isn't installed yet (pre-install runs).
|
||||||
|
*/
|
||||||
|
const require = createRequire(import.meta.url)
|
||||||
|
|
||||||
|
const ASSETS_DIR = resolve('src/assets/hot-icons')
|
||||||
|
const SCSS_OUT = resolve('src/_hot-icons.scss')
|
||||||
|
const ASSET_URL_PREFIX = './assets/hot-icons/'
|
||||||
|
|
||||||
|
const themePath = resolve('node_modules/handsontable/themes/theme/classic.js')
|
||||||
|
const mapPath = resolve('node_modules/handsontable/themes/static/variables/helpers/iconsMap.js')
|
||||||
|
|
||||||
|
if (!existsSync(themePath) || !existsSync(mapPath)) {
|
||||||
|
console.log('skip: handsontable theme modules not found (likely pre-install run)')
|
||||||
|
process.exit(0)
|
||||||
|
}
|
||||||
|
|
||||||
|
const { classicTheme } = require(themePath)
|
||||||
|
const { iconsMap } = require(mapPath)
|
||||||
|
|
||||||
|
const icons = classicTheme.icons
|
||||||
|
const cssTemplate = iconsMap(icons, 'ht-theme-classic')
|
||||||
|
|
||||||
|
const kebab = (s) => s.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase()
|
||||||
|
|
||||||
|
rmSync(ASSETS_DIR, { recursive: true, force: true })
|
||||||
|
mkdirSync(ASSETS_DIR, { recursive: true })
|
||||||
|
|
||||||
|
const writeMap = {}
|
||||||
|
for (const [name, dataUri] of Object.entries(icons)) {
|
||||||
|
if (typeof dataUri !== 'string' || !dataUri.startsWith('data:image/svg+xml')) continue
|
||||||
|
const decoded = decodeURIComponent(dataUri.replace(/^data:image\/svg\+xml(;charset=utf-8)?,/, ''))
|
||||||
|
const fname = kebab(name) + '.svg'
|
||||||
|
writeFileSync(join(ASSETS_DIR, fname), decoded)
|
||||||
|
writeMap[dataUri] = ASSET_URL_PREFIX + fname
|
||||||
|
}
|
||||||
|
|
||||||
|
let scss = cssTemplate
|
||||||
|
for (const [uri, url] of Object.entries(writeMap)) {
|
||||||
|
scss = scss.split(`url("${uri}")`).join(`url("${url}")`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const header = '/* Auto-generated by scripts/gen-hot-icons.mjs — do not edit by hand.\n' +
|
||||||
|
' Regenerated on postinstall; rerun manually via `node scripts/gen-hot-icons.mjs`. */\n\n'
|
||||||
|
|
||||||
|
writeFileSync(SCSS_OUT, header + scss + '\n')
|
||||||
|
|
||||||
|
console.log(`hot-icons: wrote ${Object.keys(writeMap).length} SVGs + ${SCSS_OUT}`)
|
||||||
@@ -0,0 +1,238 @@
|
|||||||
|
/* Auto-generated by scripts/gen-hot-icons.mjs — do not edit by hand.
|
||||||
|
Regenerated on postinstall; rerun manually via `node scripts/gen-hot-icons.mjs`. */
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .htDropdownMenu table tbody tr td.htSubmenu .htItemWrapper::after,
|
||||||
|
[class*=ht-theme-classic] .htContextMenu table tbody tr td.htSubmenu .htItemWrapper::after,
|
||||||
|
[class*=ht-theme-classic] .htFiltersConditionsMenu table tbody tr td.htSubmenu .htItemWrapper::after,
|
||||||
|
[class*=ht-theme-classic] .pika-single .pika-next {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-right.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .pika-single .pika-prev {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-left.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-page-size-section__select-wrapper::after {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-down.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .changeType::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/select-arrow.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .htUISelectCaption::after,
|
||||||
|
.htAutocompleteArrow::after {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/select-arrow.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .columnSorting.sortAction.ascending::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-narrow-up.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .columnSorting.sortAction.descending::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-narrow-down.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-page-navigation-section .ht-page-first::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-left-with-bar.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] [dir="rtl"] .ht-page-navigation-section .ht-page-first::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-right-with-bar.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-page-navigation-section .ht-page-prev::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-left.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] [dir="rtl"] .ht-page-navigation-section .ht-page-prev::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-right.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-page-navigation-section .ht-page-next::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-right.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] [dir="rtl"] .ht-page-navigation-section .ht-page-next::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-left.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-page-navigation-section .ht-page-last::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-right-with-bar.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] [dir="rtl"] .ht-page-navigation-section .ht-page-last::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/arrow-left-with-bar.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .htDropdownMenu table tbody tr td .htItemWrapper span.selected::after,
|
||||||
|
[class*=ht-theme-classic] .htContextMenu table tbody tr td .htItemWrapper span.selected::after,
|
||||||
|
[class*=ht-theme-classic] .htFiltersConditionsMenu table tbody tr td .htItemWrapper span.selected::after {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/check.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .htCheckboxRendererInput {
|
||||||
|
appearance: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .htCheckboxRendererInput::after {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/checkbox.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] th.beforeHiddenColumn::after {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/caret-hidden-left.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] th.afterHiddenColumn::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/caret-hidden-right.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] th.beforeHiddenRow::after {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/caret-hidden-up.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] th.afterHiddenRow::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/caret-hidden-down.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .collapsibleIndicator::before,
|
||||||
|
[class*=ht-theme-classic] .ht_nestingButton::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/collapse-off.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .collapsibleIndicator.collapsed::before,
|
||||||
|
[class*=ht-theme-classic] .ht_nestingButton.ht_nestingExpand::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/collapse-on.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .htUIRadio > input[type="radio"]::after {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/radio.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-multi-select-chip-remove::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/chip-close.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-notification__close::before {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/chip-close.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-multi-select-editor-search-icon {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/search.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
|
|
||||||
|
[class*=ht-theme-classic] .ht-multi-select-editor-item-selected input::after {
|
||||||
|
width: var(--ht-icon-size);
|
||||||
|
height: var(--ht-icon-size);
|
||||||
|
-webkit-mask-size: contain;
|
||||||
|
-webkit-mask-image: url("./assets/hot-icons/checkbox.svg");
|
||||||
|
background-color: currentColor;
|
||||||
|
}
|
||||||
@@ -55,7 +55,12 @@ export interface HandsontableStaticConfig {
|
|||||||
* Cached viyaApi collections, search and selected endpoint
|
* Cached viyaApi collections, search and selected endpoint
|
||||||
*/
|
*/
|
||||||
export const globals: {
|
export const globals: {
|
||||||
embed: boolean
|
embed: boolean | 'va'
|
||||||
|
/**
|
||||||
|
* VA embed filter behavior: 'live' = auto-apply, 'confirm' = manual Apply.
|
||||||
|
* Defaults to 'live'; toggled by the Auto-apply checkbox in the editor.
|
||||||
|
*/
|
||||||
|
vaApplyMode: 'live' | 'confirm'
|
||||||
rootParam: string
|
rootParam: string
|
||||||
dcLib: string
|
dcLib: string
|
||||||
xlmaps: XLMapListItem[]
|
xlmaps: XLMapListItem[]
|
||||||
@@ -71,6 +76,7 @@ export const globals: {
|
|||||||
[key: string]: any
|
[key: string]: any
|
||||||
} = {
|
} = {
|
||||||
embed: false,
|
embed: false,
|
||||||
|
vaApplyMode: 'live',
|
||||||
rootParam: <string>'',
|
rootParam: <string>'',
|
||||||
dcLib: '',
|
dcLib: '',
|
||||||
xlmaps: [],
|
xlmaps: [],
|
||||||
|
|||||||
@@ -127,9 +127,10 @@
|
|||||||
"
|
"
|
||||||
(click)="toggleSidebar()"
|
(click)="toggleSidebar()"
|
||||||
type="button"
|
type="button"
|
||||||
|
aria-label="Toggle sidebar"
|
||||||
class="cursor-pointer select-none ml-10 d-flex clr-justify-content-center clr-align-items-center"
|
class="cursor-pointer select-none ml-10 d-flex clr-justify-content-center clr-align-items-center"
|
||||||
>
|
>
|
||||||
<clr-icon size="24" shape="tree-view"></clr-icon>
|
<clr-icon size="24" shape="tree-view" aria-hidden="true"></clr-icon>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="logo d-flex clr-align-items-center">
|
<div class="logo d-flex clr-align-items-center">
|
||||||
@@ -255,6 +256,26 @@
|
|||||||
|
|
||||||
<!-- <app-terms *ngIf="showRegistration"></app-terms> -->
|
<!-- <app-terms *ngIf="showRegistration"></app-terms> -->
|
||||||
|
|
||||||
|
<!-- VA embed, back to Editor button -->
|
||||||
|
<div
|
||||||
|
*ngIf="embed === 'va' && vaEditorLibds && !isMainRoute('/editor')"
|
||||||
|
class="va-back-bar"
|
||||||
|
>
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
class="btn btn-sm btn-primary"
|
||||||
|
(click)="backToEditor()"
|
||||||
|
>
|
||||||
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
|
shape="caret"
|
||||||
|
dir="left"
|
||||||
|
size="16"
|
||||||
|
></clr-icon>
|
||||||
|
Back to Edit table
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
<router-outlet *ngIf="startupDataLoaded"></router-outlet>
|
<router-outlet *ngIf="startupDataLoaded"></router-outlet>
|
||||||
|
|
||||||
<app-login></app-login>
|
<app-login></app-login>
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
.va-back-bar {
|
||||||
|
position: sticky;
|
||||||
|
top: 0;
|
||||||
|
z-index: 1000;
|
||||||
|
display: flex;
|
||||||
|
justify-content: flex-start;
|
||||||
|
padding: 0.35rem 0.6rem;
|
||||||
|
background: #fafafa;
|
||||||
|
border-bottom: 1px solid rgba(0, 0, 0, 0.08);
|
||||||
|
}
|
||||||
|
|||||||
@@ -11,6 +11,7 @@ import { Location } from '@angular/common'
|
|||||||
import '@clr/icons'
|
import '@clr/icons'
|
||||||
import '@clr/icons/shapes/all-shapes'
|
import '@clr/icons/shapes/all-shapes'
|
||||||
import { globals } from './_globals'
|
import { globals } from './_globals'
|
||||||
|
import { parseEmbedParam } from './shared/utils/parse-embed-param'
|
||||||
import moment from 'moment'
|
import moment from 'moment'
|
||||||
import { EventService } from './services/event.service'
|
import { EventService } from './services/event.service'
|
||||||
import { AppService } from './services/app.service'
|
import { AppService } from './services/app.service'
|
||||||
@@ -145,13 +146,10 @@ export class AppComponent {
|
|||||||
})
|
})
|
||||||
|
|
||||||
const hashQuery = window.location.hash.split('?')[1]
|
const hashQuery = window.location.hash.split('?')[1]
|
||||||
if (hashQuery) {
|
if (hashQuery && new URLSearchParams(hashQuery).get('embed') !== null) {
|
||||||
const embedParam = new URLSearchParams(hashQuery).get('embed')
|
const embed = parseEmbedParam(hashQuery)
|
||||||
if (embedParam !== null) {
|
globals.embed = embed
|
||||||
const isEmbed = embedParam !== 'false'
|
this.embed = embed
|
||||||
globals.embed = isEmbed
|
|
||||||
this.embed = isEmbed
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
this.subscribeToShowAbortModal()
|
this.subscribeToShowAbortModal()
|
||||||
@@ -209,6 +207,7 @@ export class AppComponent {
|
|||||||
dcPath: getAppAttribute('dcPath') || '',
|
dcPath: getAppAttribute('dcPath') || '',
|
||||||
debug: getAppAttribute('debug') === 'true' || false,
|
debug: getAppAttribute('debug') === 'true' || false,
|
||||||
useComputeApi: this.parseComputeApi(getAppAttribute('useComputeApi')),
|
useComputeApi: this.parseComputeApi(getAppAttribute('useComputeApi')),
|
||||||
|
runAsTask: getAppAttribute('runAsTask') === 'true' || false,
|
||||||
contextName: getAppAttribute('contextName') || '',
|
contextName: getAppAttribute('contextName') || '',
|
||||||
hotLicenceKey: getAppAttribute('hotLicenceKey') || ''
|
hotLicenceKey: getAppAttribute('hotLicenceKey') || ''
|
||||||
}
|
}
|
||||||
@@ -353,4 +352,23 @@ export class AppComponent {
|
|||||||
public openLicencingPage() {
|
public openLicencingPage() {
|
||||||
this.router.navigateByUrl('/licensing/update')
|
this.router.navigateByUrl('/licensing/update')
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** "lib.table" of the last-opened editor table (for the VA embed back button). */
|
||||||
|
get vaEditorLibds(): string {
|
||||||
|
const e = globals.editor
|
||||||
|
return e?.library && e?.table ? `${e.library}.${e.table}` : ''
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* VA embed only: returns to the editor for the last-opened table. Lets users
|
||||||
|
* who land on the stage/approve/review pages get back without knowing DC's
|
||||||
|
* page paths. `globals.embed` (set at app init) keeps the editor in VA mode.
|
||||||
|
*/
|
||||||
|
public backToEditor(): void {
|
||||||
|
if (this.vaEditorLibds) {
|
||||||
|
this.router.navigate(['/editor/' + this.vaEditorLibds], {
|
||||||
|
queryParams: { embed: 'va' }
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Vendored
-1
@@ -1,5 +1,4 @@
|
|||||||
declare module 'save-svg-as-png'
|
declare module 'save-svg-as-png'
|
||||||
declare module 'numbro/dist/languages.min'
|
|
||||||
declare interface Navigator {
|
declare interface Navigator {
|
||||||
msSaveBlob: (blob: any, defaultName?: string) => boolean
|
msSaveBlob: (blob: any, defaultName?: string) => boolean
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
<div class="content-area position-relative">
|
<main class="content-area position-relative">
|
||||||
<div class="clr-row">
|
<div class="clr-row">
|
||||||
<!-- T&C section -->
|
<!-- T&C section -->
|
||||||
<div *ngIf="step === 0" id="TCS" class="card">
|
<div *ngIf="step === 0" id="TCS" class="card">
|
||||||
@@ -97,4 +97,4 @@
|
|||||||
</div>
|
</div>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
</div>
|
</main>
|
||||||
|
|||||||
@@ -373,7 +373,7 @@ export class AutomaticComponent implements OnInit {
|
|||||||
let contextname = `&_contextname=${params.contextName}`
|
let contextname = `&_contextname=${params.contextName}`
|
||||||
let admin = `&admin=${params.admin}`
|
let admin = `&admin=${params.admin}`
|
||||||
let dcPath = `&dcpath=${params.dcPath}`
|
let dcPath = `&dcpath=${params.dcPath}`
|
||||||
let debug = `&_debug=131`
|
let debug = this.sasService.getDebugUrlParam()
|
||||||
|
|
||||||
let programUrl =
|
let programUrl =
|
||||||
serverUrl +
|
serverUrl +
|
||||||
|
|||||||
@@ -251,7 +251,7 @@ export class ManualComponent implements OnInit {
|
|||||||
this.selectedAdminGroup +
|
this.selectedAdminGroup +
|
||||||
'&DCPATH=' +
|
'&DCPATH=' +
|
||||||
this.dcPath +
|
this.dcPath +
|
||||||
'&_debug=131'
|
this.sasService.getDebugUrlParam()
|
||||||
|
|
||||||
window.open(url, '_blank')
|
window.open(url, '_blank')
|
||||||
|
|
||||||
|
|||||||
@@ -177,45 +177,45 @@
|
|||||||
</div>
|
</div>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
|
|
||||||
<clr-textarea-container class="date-field" *ngSwitchCase="'time'">
|
<div class="date-field" *ngSwitchCase="'intl-time'">
|
||||||
<textarea
|
<input
|
||||||
clrTextarea
|
type="time"
|
||||||
(paste)="recordInputPaste($event)"
|
step="1"
|
||||||
(input)="recordInputChange($event, col.key)"
|
class="date-input"
|
||||||
|
[attr.aria-label]="col.key"
|
||||||
[class.invalid-data]="
|
[class.invalid-data]="
|
||||||
currentRecordInvalidCols.includes(col.key)
|
currentRecordInvalidCols.includes(col.key)
|
||||||
"
|
"
|
||||||
[rows]="col.value.length > 80 ? 6 : 1"
|
[value]="currentRecord[col.key]"
|
||||||
[(ngModel)]="currentRecord[col.key]"
|
(change)="recordTimeChange($event, col.key)"
|
||||||
[class.not-char]="
|
/>
|
||||||
currentRecordValidator?.getRule(col.key)?.type
|
</div>
|
||||||
"
|
|
||||||
></textarea>
|
|
||||||
<clr-control-helper>HH:mm:ss</clr-control-helper>
|
|
||||||
</clr-textarea-container>
|
|
||||||
|
|
||||||
<div class="date-field" *ngSwitchCase="'date'">
|
<div class="date-field" *ngSwitchCase="'intl-datetime'">
|
||||||
<textarea
|
<input
|
||||||
clrTextarea
|
type="datetime-local"
|
||||||
(paste)="recordInputPaste($event)"
|
step="1"
|
||||||
(input)="recordInputChange($event, col.key)"
|
class="date-input"
|
||||||
|
[attr.aria-label]="col.key"
|
||||||
[class.invalid-data]="
|
[class.invalid-data]="
|
||||||
currentRecordInvalidCols.includes(col.key)
|
currentRecordInvalidCols.includes(col.key)
|
||||||
"
|
"
|
||||||
rows="1"
|
[value]="toNativeDatetime(currentRecord[col.key])"
|
||||||
cols="auto"
|
(change)="recordDatetimeChange($event, col.key)"
|
||||||
class="not-char"
|
/>
|
||||||
[(ngModel)]="currentRecord[col.key]"
|
</div>
|
||||||
></textarea>
|
|
||||||
<clr-date-container class="date-picker">
|
<div class="date-field" *ngSwitchCase="'intl-date'">
|
||||||
<input
|
<input
|
||||||
type="date"
|
type="date"
|
||||||
name="date"
|
class="date-input"
|
||||||
class="d-none"
|
[attr.aria-label]="col.key"
|
||||||
(clrDateChange)="recordDateChange($event, col.key)"
|
[class.invalid-data]="
|
||||||
clrDate
|
currentRecordInvalidCols.includes(col.key)
|
||||||
/>
|
"
|
||||||
</clr-date-container>
|
[value]="currentRecord[col.key]"
|
||||||
|
(change)="recordDateChange($event, col.key)"
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
<div *ngSwitchCase="'autocomplete'">
|
<div *ngSwitchCase="'autocomplete'">
|
||||||
<ng-container
|
<ng-container
|
||||||
@@ -255,6 +255,7 @@
|
|||||||
type="button"
|
type="button"
|
||||||
class="btn btn-outline focusable"
|
class="btn btn-outline focusable"
|
||||||
tabindex="0"
|
tabindex="0"
|
||||||
|
aria-label="Previous record"
|
||||||
(click)="onPreviousRecordClick()"
|
(click)="onPreviousRecordClick()"
|
||||||
[disabled]="currentRecordInvalidCols.length > 0"
|
[disabled]="currentRecordInvalidCols.length > 0"
|
||||||
>
|
>
|
||||||
@@ -267,6 +268,7 @@
|
|||||||
type="button"
|
type="button"
|
||||||
class="btn btn-outline focusable"
|
class="btn btn-outline focusable"
|
||||||
tabindex="0"
|
tabindex="0"
|
||||||
|
aria-label="Next record"
|
||||||
(click)="onNextRecordClick()"
|
(click)="onNextRecordClick()"
|
||||||
[disabled]="currentRecordInvalidCols.length > 0"
|
[disabled]="currentRecordInvalidCols.length > 0"
|
||||||
>
|
>
|
||||||
|
|||||||
@@ -2,12 +2,12 @@ import { KeyValue } from '@angular/common'
|
|||||||
import {
|
import {
|
||||||
Component,
|
Component,
|
||||||
EventEmitter,
|
EventEmitter,
|
||||||
|
HostListener,
|
||||||
Input,
|
Input,
|
||||||
OnInit,
|
OnInit,
|
||||||
Output,
|
Output,
|
||||||
ViewEncapsulation
|
ViewEncapsulation
|
||||||
} from '@angular/core'
|
} from '@angular/core'
|
||||||
import moment from 'moment'
|
|
||||||
import { ValidateFilterSASResponse } from 'src/app/models/sas/validate-filter.model'
|
import { ValidateFilterSASResponse } from 'src/app/models/sas/validate-filter.model'
|
||||||
import { QueryClause } from 'src/app/models/TableData'
|
import { QueryClause } from 'src/app/models/TableData'
|
||||||
import { HelperService } from 'src/app/services/helper.service'
|
import { HelperService } from 'src/app/services/helper.service'
|
||||||
@@ -91,17 +91,69 @@ export class EditRecordComponent implements OnInit {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fired when date field in the record change
|
* Fired when the native date picker (intl-date) changes. A native
|
||||||
* Function will parse date and format to string
|
* `<input type="date">` value is always ISO `YYYY-MM-DD`, so it is stored
|
||||||
* @param date picker value
|
* as-is. Mirrors recordTimeChange / recordDatetimeChange.
|
||||||
|
* @param event native <input type="date"> change event
|
||||||
* @param colKey column name (key)
|
* @param colKey column name (key)
|
||||||
*/
|
*/
|
||||||
recordDateChange(date: Date, colKey: string) {
|
recordDateChange(event: Event, colKey: string) {
|
||||||
let cellValidation = this.currentRecordValidator?.getRule(colKey)
|
const value = (event.target as HTMLInputElement).value // YYYY-MM-DD
|
||||||
let format = cellValidation ? cellValidation.dateFormat : ''
|
if (!value || !this.currentRecord) return
|
||||||
|
this.currentRecord[colKey] = value
|
||||||
|
this.revalidateRecordCol(colKey, value)
|
||||||
|
}
|
||||||
|
|
||||||
if (this.currentRecord)
|
/**
|
||||||
this.currentRecord[colKey] = moment(date).format(format)
|
* Stored `YYYY-MM-DD HH:mm:ss` → native `<input type="datetime-local">` value
|
||||||
|
* `YYYY-MM-DDTHH:mm:ss`, so the picker opens at the current value.
|
||||||
|
*/
|
||||||
|
toNativeDatetime(value: any): string {
|
||||||
|
if (typeof value !== 'string') return ''
|
||||||
|
return value.includes(' ') ? value.replace(' ', 'T') : value
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Re-runs validation for a column after a native picker change (the picker
|
||||||
|
* handlers set the value programmatically, which does not fire the textarea's
|
||||||
|
* input handler). Mirrors recordInputChange's validate + state update.
|
||||||
|
*/
|
||||||
|
private revalidateRecordCol(colName: string, value: any) {
|
||||||
|
const colRules = this.currentRecordValidator?.getRule(colName)
|
||||||
|
this.validateRecordCol(colRules, value).then((valid: boolean) =>
|
||||||
|
this.updateValidationState(colName, valid)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the native time picker (intl-time) changes. Stores 24h
|
||||||
|
* `HH:mm:ss`, padding the seconds the browser may omit. Mirrors the
|
||||||
|
* IntlDatetimeEditor conversion used by the HOT grid.
|
||||||
|
* @param event native <input type="time"> change event
|
||||||
|
* @param colKey column name (key)
|
||||||
|
*/
|
||||||
|
recordTimeChange(event: Event, colKey: string) {
|
||||||
|
const value = (event.target as HTMLInputElement).value // HH:mm[:ss]
|
||||||
|
if (!value || !this.currentRecord) return
|
||||||
|
const stored = value.length === 5 ? `${value}:00` : value
|
||||||
|
this.currentRecord[colKey] = stored
|
||||||
|
this.revalidateRecordCol(colKey, stored)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fired when the native datetime picker (intl-datetime) changes. Converts the
|
||||||
|
* native `YYYY-MM-DDTHH:mm[:ss]` into SAS' stored `YYYY-MM-DD HH:mm:ss`,
|
||||||
|
* padding seconds. Mirrors the IntlDatetimeEditor conversion used by the grid.
|
||||||
|
* @param event native <input type="datetime-local"> change event
|
||||||
|
* @param colKey column name (key)
|
||||||
|
*/
|
||||||
|
recordDatetimeChange(event: Event, colKey: string) {
|
||||||
|
const value = (event.target as HTMLInputElement).value // YYYY-MM-DDTHH:mm[:ss]
|
||||||
|
if (!value || !this.currentRecord) return
|
||||||
|
const [date, time] = value.split('T')
|
||||||
|
const stored = `${date} ${time.length === 5 ? `${time}:00` : time}`
|
||||||
|
this.currentRecord[colKey] = stored
|
||||||
|
this.revalidateRecordCol(colKey, stored)
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -120,6 +172,16 @@ export class EditRecordComponent implements OnInit {
|
|||||||
this.onRecordEditClose.emit()
|
this.onRecordEditClose.emit()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Close the modal on Escape (cancel, like the Close button). A native picker
|
||||||
|
* swallows the first Escape to dismiss itself, so the modal only closes once
|
||||||
|
* focus is back on the form.
|
||||||
|
*/
|
||||||
|
@HostListener('document:keydown.escape')
|
||||||
|
onEscapeKey() {
|
||||||
|
this.closeRecordEdit()
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Emitting output event when dropdown (autocomplete) input in any col change
|
* Emitting output event when dropdown (autocomplete) input in any col change
|
||||||
* @param colName column name (key)
|
* @param colName column name (key)
|
||||||
@@ -233,8 +295,9 @@ export class EditRecordComponent implements OnInit {
|
|||||||
if (obj.data === key) {
|
if (obj.data === key) {
|
||||||
if (
|
if (
|
||||||
obj.type === 'numeric' ||
|
obj.type === 'numeric' ||
|
||||||
obj.type === 'date' ||
|
obj.type === 'intl-date' ||
|
||||||
obj.type === 'time'
|
obj.type === 'intl-time' ||
|
||||||
|
obj.type === 'intl-datetime'
|
||||||
) {
|
) {
|
||||||
type = 'N'
|
type = 'N'
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
<div class="content-area d-flex clr-flex-column">
|
<main class="content-area d-flex clr-flex-column">
|
||||||
<clr-modal
|
<clr-modal
|
||||||
appFileDrop
|
appFileDrop
|
||||||
(fileOver)="fileOverBase($event)"
|
(fileOver)="fileOverBase($event)"
|
||||||
@@ -172,14 +172,23 @@
|
|||||||
class="btn icon-collapse btn-sm btn-icon btn-dimmed"
|
class="btn icon-collapse btn-sm btn-icon btn-dimmed"
|
||||||
[routerLink]="['/home']"
|
[routerLink]="['/home']"
|
||||||
>
|
>
|
||||||
<clr-icon shape="caret" dir="left" size="20"></clr-icon>
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
|
shape="caret"
|
||||||
|
dir="left"
|
||||||
|
size="20"
|
||||||
|
></clr-icon>
|
||||||
<span class="text">Back to table selection</span>
|
<span class="text">Back to table selection</span>
|
||||||
</span>
|
</span>
|
||||||
<span
|
<span
|
||||||
(click)="viewboxManager()"
|
(click)="viewboxManager()"
|
||||||
class="btn icon-collapse btn-sm btn-icon btn-dimmed viewbox-open"
|
class="btn icon-collapse btn-sm btn-icon btn-dimmed viewbox-open"
|
||||||
>
|
>
|
||||||
<clr-icon shape="view-cards" size="20"></clr-icon>
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
|
shape="view-cards"
|
||||||
|
size="20"
|
||||||
|
></clr-icon>
|
||||||
<span class="text">Viewboxes</span>
|
<span class="text">Viewboxes</span>
|
||||||
</span>
|
</span>
|
||||||
</div>
|
</div>
|
||||||
@@ -207,6 +216,7 @@
|
|||||||
|
|
||||||
<clr-icon
|
<clr-icon
|
||||||
*ngIf="libdsParsed.tableName.includes('-FC')"
|
*ngIf="libdsParsed.tableName.includes('-FC')"
|
||||||
|
aria-hidden="true"
|
||||||
shape="bolt"
|
shape="bolt"
|
||||||
class="color-yellow"
|
class="color-yellow"
|
||||||
></clr-icon>
|
></clr-icon>
|
||||||
@@ -247,11 +257,12 @@
|
|||||||
>
|
>
|
||||||
<ng-container *ngIf="hotTable.readOnly && !uploadPreview">
|
<ng-container *ngIf="hotTable.readOnly && !uploadPreview">
|
||||||
<button
|
<button
|
||||||
|
*ngIf="!isVaEmbed"
|
||||||
type="button"
|
type="button"
|
||||||
class="btnView btn icon-collapse btn-sm btn-icon btn-block btn-dimmed"
|
class="btnView btn icon-collapse btn-sm btn-icon btn-block btn-dimmed"
|
||||||
(click)="openQb()"
|
(click)="openQb()"
|
||||||
>
|
>
|
||||||
<clr-icon shape="filter"></clr-icon>
|
<clr-icon aria-hidden="true" shape="filter"></clr-icon>
|
||||||
<span class="text">Filter</span>
|
<span class="text">Filter</span>
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
@@ -260,7 +271,7 @@
|
|||||||
class="btn icon-collapse btn-sm btn-primary btn-block"
|
class="btn icon-collapse btn-sm btn-primary btn-block"
|
||||||
(click)="editTable()"
|
(click)="editTable()"
|
||||||
>
|
>
|
||||||
<clr-icon shape="note"></clr-icon>
|
<clr-icon aria-hidden="true" shape="note"></clr-icon>
|
||||||
<span class="text">Edit</span>
|
<span class="text">Edit</span>
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
@@ -270,7 +281,7 @@
|
|||||||
type="button"
|
type="button"
|
||||||
class="btn icon-collapse btn-sm btn-success btn-block mr-0"
|
class="btn icon-collapse btn-sm btn-success btn-block mr-0"
|
||||||
>
|
>
|
||||||
<clr-icon shape="upload"></clr-icon>
|
<clr-icon aria-hidden="true" shape="upload"></clr-icon>
|
||||||
<span class="text">Upload</span>
|
<span class="text">Upload</span>
|
||||||
</button>
|
</button>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
@@ -281,7 +292,7 @@
|
|||||||
class="btn btn-sm btn-icon btn-outline-danger"
|
class="btn btn-sm btn-icon btn-outline-danger"
|
||||||
(click)="cancelEdit()"
|
(click)="cancelEdit()"
|
||||||
>
|
>
|
||||||
<clr-icon shape="times"></clr-icon>
|
<clr-icon aria-hidden="true" shape="times"></clr-icon>
|
||||||
<span>Cancel</span>
|
<span>Cancel</span>
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
@@ -294,7 +305,8 @@
|
|||||||
[class.dc-locked-control]="restrictions.restrictAddRow"
|
[class.dc-locked-control]="restrictions.restrictAddRow"
|
||||||
(click)="!restrictions.restrictAddRow ? addRow() : ''"
|
(click)="!restrictions.restrictAddRow ? addRow() : ''"
|
||||||
>
|
>
|
||||||
<clr-icon shape="plus" size="16"></clr-icon>Add Row
|
<clr-icon aria-hidden="true" shape="plus" size="16"></clr-icon
|
||||||
|
>Add Row
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
<clr-tooltip-content
|
<clr-tooltip-content
|
||||||
@@ -319,7 +331,8 @@
|
|||||||
class="btn btn-sm btn-primary"
|
class="btn btn-sm btn-primary"
|
||||||
(click)="checkSave()"
|
(click)="checkSave()"
|
||||||
>
|
>
|
||||||
<clr-icon shape="check" size="20"></clr-icon>Submit
|
<clr-icon aria-hidden="true" shape="check" size="20"></clr-icon
|
||||||
|
>Submit
|
||||||
</button>
|
</button>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
|
|
||||||
@@ -329,7 +342,7 @@
|
|||||||
class="btn btn-sm btn-icon btn-outline-danger btn-upload-preview"
|
class="btn btn-sm btn-icon btn-outline-danger btn-upload-preview"
|
||||||
(click)="discardSourceFile = true"
|
(click)="discardSourceFile = true"
|
||||||
>
|
>
|
||||||
<clr-icon shape="times"></clr-icon>
|
<clr-icon aria-hidden="true" shape="times"></clr-icon>
|
||||||
<span>Discard file</span>
|
<span>Discard file</span>
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
@@ -339,7 +352,7 @@
|
|||||||
class="btn btn-sm btn-primary btn-upload-preview"
|
class="btn btn-sm btn-primary btn-upload-preview"
|
||||||
(click)="manualFileEditModal = true"
|
(click)="manualFileEditModal = true"
|
||||||
>
|
>
|
||||||
<clr-icon shape="note"></clr-icon>
|
<clr-icon aria-hidden="true" shape="note"></clr-icon>
|
||||||
<span>Edit</span>
|
<span>Edit</span>
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
@@ -349,7 +362,7 @@
|
|||||||
(click)="submitExcel()"
|
(click)="submitExcel()"
|
||||||
[clrLoading]="uploadLoading"
|
[clrLoading]="uploadLoading"
|
||||||
>
|
>
|
||||||
<clr-icon shape="check" size="20"></clr-icon>
|
<clr-icon aria-hidden="true" shape="check" size="20"></clr-icon>
|
||||||
Submit
|
Submit
|
||||||
</button>
|
</button>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
@@ -382,7 +395,11 @@
|
|||||||
|
|
||||||
<ng-container *ngIf="getdataError">
|
<ng-container *ngIf="getdataError">
|
||||||
<span>
|
<span>
|
||||||
<clr-icon shape="error-standard" class="error-icon"></clr-icon>
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
|
shape="error-standard"
|
||||||
|
class="error-icon"
|
||||||
|
></clr-icon>
|
||||||
</span>
|
</span>
|
||||||
|
|
||||||
<div class="mt-10">
|
<div class="mt-10">
|
||||||
@@ -419,7 +436,9 @@
|
|||||||
|
|
||||||
<div>
|
<div>
|
||||||
<clr-tooltip
|
<clr-tooltip
|
||||||
*ngIf="tableTrue && !restrictions.removeAddRecordButton"
|
*ngIf="
|
||||||
|
tableTrue && !restrictions.removeAddRecordButton && !isVaEmbed
|
||||||
|
"
|
||||||
>
|
>
|
||||||
<button
|
<button
|
||||||
clrTooltipTrigger
|
clrTooltipTrigger
|
||||||
@@ -430,7 +449,7 @@
|
|||||||
!restrictions.restrictAddRow ? addRecordButtonClick() : ''
|
!restrictions.restrictAddRow ? addRecordButtonClick() : ''
|
||||||
"
|
"
|
||||||
>
|
>
|
||||||
<clr-icon shape="plus" size="16"></clr-icon>
|
<clr-icon aria-hidden="true" shape="plus" size="16"></clr-icon>
|
||||||
Add Record
|
Add Record
|
||||||
</button>
|
</button>
|
||||||
|
|
||||||
@@ -450,6 +469,64 @@
|
|||||||
>
|
>
|
||||||
</clr-tooltip-content>
|
</clr-tooltip-content>
|
||||||
</clr-tooltip>
|
</clr-tooltip>
|
||||||
|
|
||||||
|
<!-- VA data-driven content mode: filter controls only. Edit/Submit
|
||||||
|
use the normal top toolbar (same as embed=true). VA opens
|
||||||
|
read-only and filters live with the report; filtering
|
||||||
|
repopulates the grid, so it is held while editing (change shown
|
||||||
|
pending) and resumes on return to read-only. -->
|
||||||
|
<ng-container *ngIf="isVaEmbed">
|
||||||
|
<div class="va-filter-controls w-100 mt-2-i">
|
||||||
|
<!-- Read-only: auto-apply toggle + manual Apply (confirm mode).
|
||||||
|
Hidden while editing (filtering is held). -->
|
||||||
|
<ng-container *ngIf="hotTable.readOnly">
|
||||||
|
<label class="va-toggle">
|
||||||
|
<input
|
||||||
|
type="checkbox"
|
||||||
|
[checked]="vaAutoApply"
|
||||||
|
(change)="toggleVaAutoApply()"
|
||||||
|
/>
|
||||||
|
Auto-apply VA filters
|
||||||
|
</label>
|
||||||
|
|
||||||
|
<button
|
||||||
|
*ngIf="!vaAutoApply"
|
||||||
|
[disabled]="
|
||||||
|
vaFilterStatus !== 'pending' &&
|
||||||
|
vaFilterStatus !== 'loading'
|
||||||
|
"
|
||||||
|
type="button"
|
||||||
|
class="btn btn-sm btn-primary"
|
||||||
|
(click)="applyPendingVaFilter()"
|
||||||
|
>
|
||||||
|
Apply filter
|
||||||
|
</button>
|
||||||
|
</ng-container>
|
||||||
|
|
||||||
|
<!-- Edit mode: filtering is held so edits aren't wiped. -->
|
||||||
|
<span *ngIf="!hotTable.readOnly" class="va-disabled-text">
|
||||||
|
VA filtering paused while editing
|
||||||
|
</span>
|
||||||
|
|
||||||
|
<!-- Persistent live region (shown in both modes) so a filter
|
||||||
|
change that arrives while editing is announced as pending. -->
|
||||||
|
<span class="va-filter-status" role="status" aria-live="polite">
|
||||||
|
<span
|
||||||
|
*ngIf="vaFilterStatus === 'pending'"
|
||||||
|
class="va-pending-text"
|
||||||
|
>
|
||||||
|
Filter change pending
|
||||||
|
</span>
|
||||||
|
<span
|
||||||
|
*ngIf="vaFilterStatus === 'loading'"
|
||||||
|
class="va-loading-text"
|
||||||
|
>
|
||||||
|
Loading filter…
|
||||||
|
</span>
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
</ng-container>
|
||||||
|
|
||||||
<p
|
<p
|
||||||
*ngIf="
|
*ngIf="
|
||||||
licenceState.value.editor_rows_allowed !== Infinity &&
|
licenceState.value.editor_rows_allowed !== Infinity &&
|
||||||
@@ -686,7 +763,7 @@
|
|||||||
</div> -->
|
</div> -->
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</main>
|
||||||
|
|
||||||
<div class="modal z-index-highest" *ngIf="nullVariables">
|
<div class="modal z-index-highest" *ngIf="nullVariables">
|
||||||
<div class="modal-dialog" role="dialog" aria-hidden="true">
|
<div class="modal-dialog" role="dialog" aria-hidden="true">
|
||||||
@@ -873,3 +950,17 @@
|
|||||||
</app-dataset-info>
|
</app-dataset-info>
|
||||||
|
|
||||||
<app-viewboxes [(viewboxModal)]="viewboxes"></app-viewboxes>
|
<app-viewboxes [(viewboxModal)]="viewboxes"></app-viewboxes>
|
||||||
|
|
||||||
|
<app-confirm-modal
|
||||||
|
[open]="confirmModal.open"
|
||||||
|
[title]="confirmModal.title"
|
||||||
|
[message]="confirmModal.message"
|
||||||
|
(result)="onConfirmModalResult($event)"
|
||||||
|
></app-confirm-modal>
|
||||||
|
|
||||||
|
<app-bulk-validation-modal
|
||||||
|
[open]="bulkValidation.active"
|
||||||
|
[done]="bulkValidation.done"
|
||||||
|
[total]="bulkValidation.total"
|
||||||
|
(cancel)="cancelBulkValidation({ revert: true })"
|
||||||
|
></app-bulk-validation-modal>
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
.va-filter-controls {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.5rem;
|
||||||
|
flex-wrap: wrap;
|
||||||
|
|
||||||
|
.va-toggle {
|
||||||
|
display: inline-flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 0.35rem;
|
||||||
|
margin: 0;
|
||||||
|
cursor: pointer;
|
||||||
|
}
|
||||||
|
|
||||||
|
.va-pending-text {
|
||||||
|
font-style: italic;
|
||||||
|
color: #8a5200;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
.va-loading-text {
|
||||||
|
font-style: italic;
|
||||||
|
color: #0072a3;
|
||||||
|
}
|
||||||
|
|
||||||
|
.va-disabled-text {
|
||||||
|
font-style: italic;
|
||||||
|
opacity: 0.7;
|
||||||
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,13 +1,22 @@
|
|||||||
/**
|
/**
|
||||||
* Model for the dynamic cell validation in the editor
|
* Model for a row of `dynamic_values` returned by the getdynamiccolvals
|
||||||
* (sending whole row to the backend service and recieving data for the cell dropdown)
|
* service (the dropdown source for the edited cell itself).
|
||||||
|
*/
|
||||||
|
export interface DynamicCellValidation {
|
||||||
|
DISPLAY_INDEX: number
|
||||||
|
RAW_VALUE: string | number
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Model for a row of `dynamic_extended_values` returned by the
|
||||||
|
* getdynamiccolvals service (dropdown values for _other_ cells in the _same_
|
||||||
|
* row, mapped via DISPLAY_INDEX).
|
||||||
*/
|
*/
|
||||||
export interface DynamicExtendedCellValidation {
|
export interface DynamicExtendedCellValidation {
|
||||||
DISPLAY_INDEX: number
|
DISPLAY_INDEX: number
|
||||||
DISPLAY_TYPE: string
|
DISPLAY_TYPE: string
|
||||||
DISPLAY_VALUE: string
|
|
||||||
EXTRA_COL_NAME: string
|
EXTRA_COL_NAME: string
|
||||||
RAW_VALUE_CHAR: string
|
RAW_VALUE_CHAR: string
|
||||||
RAW_VALUE_NUM: number
|
RAW_VALUE_NUM: number
|
||||||
FORCE_FLAG: number
|
FORCED_VALUE: number
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,6 +18,22 @@ export const dateToTime = (date: Date) => {
|
|||||||
return timeStr
|
return timeStr
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Normalises a 24-hour time STRING to zero-padded `HH:mm:ss`.
|
||||||
|
*
|
||||||
|
* The `intl-time` cell type (validator + native `<input type=time>` editor) is
|
||||||
|
* strict and rejects `H:mm[:ss]`, so such a value paints red and the editor
|
||||||
|
* opens empty. Pad the hour and default the seconds so the value validates.
|
||||||
|
*
|
||||||
|
* Non time-like input is returned unchanged.
|
||||||
|
*/
|
||||||
|
export const padTimeString = (value: string): string => {
|
||||||
|
const match = value.match(/^(\d{1,2}):(\d{2})(?::(\d{2}))?$/)
|
||||||
|
if (!match) return value
|
||||||
|
const [, hours, minutes, seconds] = match
|
||||||
|
return `${hours.padStart(2, '0')}:${minutes}:${seconds ?? '00'}`
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Converts date object to the YYYY-MM-DD
|
* Converts date object to the YYYY-MM-DD
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -0,0 +1,88 @@
|
|||||||
|
import Handsontable from 'handsontable'
|
||||||
|
import { makeNumberFormatRenderer } from './renderers.utils'
|
||||||
|
|
||||||
|
describe('makeNumberFormatRenderer', () => {
|
||||||
|
it('renders a numeric cell as EUR currency without changing the value', () => {
|
||||||
|
const container = document.createElement('div')
|
||||||
|
document.body.appendChild(container)
|
||||||
|
|
||||||
|
const hot = new Handsontable(container, {
|
||||||
|
data: [{ amt: 1025 }],
|
||||||
|
columns: [
|
||||||
|
{
|
||||||
|
data: 'amt',
|
||||||
|
type: 'numeric',
|
||||||
|
renderer: makeNumberFormatRenderer(
|
||||||
|
'{"style":"currency","currency":"EUR"}'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
],
|
||||||
|
licenseKey: 'non-commercial-and-evaluation'
|
||||||
|
})
|
||||||
|
hot.render()
|
||||||
|
|
||||||
|
const td = hot.getCell(0, 0)
|
||||||
|
// Display is formatted as currency...
|
||||||
|
expect(td?.textContent).toContain('€')
|
||||||
|
expect(td?.textContent).toContain('1,025')
|
||||||
|
// ...but the stored value is untouched
|
||||||
|
expect(hot.getDataAtCell(0, 0)).toEqual(1025)
|
||||||
|
|
||||||
|
hot.destroy()
|
||||||
|
container.remove()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('is overridden by numbro numericFormat (why DcValidator clears it for NUMBER_FORMAT cols)', () => {
|
||||||
|
// Regression note: on a `type: 'numeric'` column, a `numericFormat` makes
|
||||||
|
// HOT re-render via numbro and drop our currency symbol. DcValidator clears
|
||||||
|
// numericFormat on NUMBER_FORMAT columns so the Intl renderer wins.
|
||||||
|
const container = document.createElement('div')
|
||||||
|
document.body.appendChild(container)
|
||||||
|
|
||||||
|
const hot = new Handsontable(container, {
|
||||||
|
data: [{ amt: 1025 }],
|
||||||
|
columns: [
|
||||||
|
{
|
||||||
|
data: 'amt',
|
||||||
|
type: 'numeric',
|
||||||
|
numericFormat: { pattern: '0,0', culture: 'en-US' },
|
||||||
|
renderer: makeNumberFormatRenderer(
|
||||||
|
'{"style":"currency","currency":"EUR"}'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
],
|
||||||
|
licenseKey: 'non-commercial-and-evaluation'
|
||||||
|
})
|
||||||
|
hot.render()
|
||||||
|
|
||||||
|
const td = hot.getCell(0, 0)
|
||||||
|
expect(td?.textContent).not.toContain('€')
|
||||||
|
|
||||||
|
hot.destroy()
|
||||||
|
container.remove()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('falls back to a plain number when options JSON is invalid', () => {
|
||||||
|
const container = document.createElement('div')
|
||||||
|
document.body.appendChild(container)
|
||||||
|
|
||||||
|
const hot = new Handsontable(container, {
|
||||||
|
data: [{ amt: 1025 }],
|
||||||
|
columns: [
|
||||||
|
{
|
||||||
|
data: 'amt',
|
||||||
|
type: 'numeric',
|
||||||
|
renderer: makeNumberFormatRenderer('not json')
|
||||||
|
}
|
||||||
|
],
|
||||||
|
licenseKey: 'non-commercial-and-evaluation'
|
||||||
|
})
|
||||||
|
hot.render()
|
||||||
|
|
||||||
|
const td = hot.getCell(0, 0)
|
||||||
|
expect(td?.textContent).not.toContain('€')
|
||||||
|
|
||||||
|
hot.destroy()
|
||||||
|
container.remove()
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -1,3 +1,57 @@
|
|||||||
|
import Handsontable from 'handsontable'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a display-only HOT renderer that formats numeric cell values using
|
||||||
|
* Intl.NumberFormat. The stored/submitted value is never changed — only the
|
||||||
|
* rendered text. `ruleValue` is a JSON string of Intl.NumberFormat options
|
||||||
|
* (e.g. '{"style":"currency","currency":"EUR","minimumFractionDigits":2}').
|
||||||
|
*
|
||||||
|
* Falls back to the plain text renderer when the JSON is invalid, the options
|
||||||
|
* are rejected by Intl.NumberFormat, or the value is not a finite number.
|
||||||
|
*/
|
||||||
|
export const makeNumberFormatRenderer = (ruleValue?: string) => {
|
||||||
|
let formatter: Intl.NumberFormat | null = null
|
||||||
|
|
||||||
|
try {
|
||||||
|
const options = ruleValue ? JSON.parse(ruleValue) : {}
|
||||||
|
formatter = new Intl.NumberFormat(window.navigator.language, options)
|
||||||
|
} catch (e) {
|
||||||
|
console.warn(
|
||||||
|
`NUMBER_FORMAT - invalid Intl.NumberFormat options: ${ruleValue}`
|
||||||
|
)
|
||||||
|
formatter = null
|
||||||
|
}
|
||||||
|
|
||||||
|
const baseRenderer = Handsontable.renderers.getRenderer('text')
|
||||||
|
|
||||||
|
return (
|
||||||
|
instance: any,
|
||||||
|
td: any,
|
||||||
|
row: number,
|
||||||
|
col: number,
|
||||||
|
prop: string | number,
|
||||||
|
value: any,
|
||||||
|
cellProperties: any
|
||||||
|
) => {
|
||||||
|
// Render via the base text renderer first to preserve cell styling/classes
|
||||||
|
// (readOnly, alignment, etc.), then override the displayed text.
|
||||||
|
baseRenderer(instance, td, row, col, prop, value, cellProperties)
|
||||||
|
|
||||||
|
const num = Number(value)
|
||||||
|
if (
|
||||||
|
formatter &&
|
||||||
|
value !== null &&
|
||||||
|
value !== undefined &&
|
||||||
|
value !== '' &&
|
||||||
|
!isNaN(num)
|
||||||
|
) {
|
||||||
|
td.textContent = formatter.format(num)
|
||||||
|
}
|
||||||
|
|
||||||
|
return td
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Custom renderer for HOT cell
|
* Custom renderer for HOT cell
|
||||||
* Used to show error icon
|
* Used to show error icon
|
||||||
|
|||||||
@@ -16,11 +16,13 @@
|
|||||||
<clr-icon
|
<clr-icon
|
||||||
*ngIf="searchLibTreeInput.value.length < 1"
|
*ngIf="searchLibTreeInput.value.length < 1"
|
||||||
shape="search"
|
shape="search"
|
||||||
|
aria-hidden="true"
|
||||||
></clr-icon>
|
></clr-icon>
|
||||||
<clr-icon
|
<clr-icon
|
||||||
*ngIf="searchLibTreeInput.value.length > 0"
|
*ngIf="searchLibTreeInput.value.length > 0"
|
||||||
(click)="librariesSearch = ''; libraryOnFilter()"
|
(click)="librariesSearch = ''; libraryOnFilter()"
|
||||||
shape="times"
|
shape="times"
|
||||||
|
aria-label="Clear libraries search"
|
||||||
></clr-icon>
|
></clr-icon>
|
||||||
</div>
|
</div>
|
||||||
</clr-tree-node>
|
</clr-tree-node>
|
||||||
@@ -40,7 +42,7 @@
|
|||||||
"
|
"
|
||||||
class="m-0 cursor-pointer"
|
class="m-0 cursor-pointer"
|
||||||
>
|
>
|
||||||
<clr-icon shape="rack-server"></clr-icon>
|
<clr-icon shape="rack-server" aria-hidden="true"></clr-icon>
|
||||||
{{ library.LIBRARYREF }}
|
{{ library.LIBRARYREF }}
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
@@ -60,6 +62,7 @@
|
|||||||
<clr-icon
|
<clr-icon
|
||||||
*ngIf="searchTreeInput.value.length < 1"
|
*ngIf="searchTreeInput.value.length < 1"
|
||||||
shape="search"
|
shape="search"
|
||||||
|
aria-hidden="true"
|
||||||
></clr-icon>
|
></clr-icon>
|
||||||
<clr-icon
|
<clr-icon
|
||||||
*ngIf="searchTreeInput.value.length > 0"
|
*ngIf="searchTreeInput.value.length > 0"
|
||||||
@@ -69,6 +72,7 @@
|
|||||||
treeOnFilter(library, 'tables')
|
treeOnFilter(library, 'tables')
|
||||||
"
|
"
|
||||||
shape="times"
|
shape="times"
|
||||||
|
aria-label="Clear tables search"
|
||||||
></clr-icon>
|
></clr-icon>
|
||||||
</div>
|
</div>
|
||||||
</clr-tree-node>
|
</clr-tree-node>
|
||||||
@@ -90,8 +94,16 @@
|
|||||||
[class.active]="libTabActive(library.LIBRARYREF, libTable)"
|
[class.active]="libTabActive(library.LIBRARYREF, libTable)"
|
||||||
>
|
>
|
||||||
<ng-container [ngSwitch]="libTable.includes('-FC')">
|
<ng-container [ngSwitch]="libTable.includes('-FC')">
|
||||||
<clr-icon *ngSwitchCase="true" shape="bolt"></clr-icon>
|
<clr-icon
|
||||||
<clr-icon *ngSwitchCase="false" shape="table"></clr-icon>
|
*ngSwitchCase="true"
|
||||||
|
shape="bolt"
|
||||||
|
aria-hidden="true"
|
||||||
|
></clr-icon>
|
||||||
|
<clr-icon
|
||||||
|
*ngSwitchCase="false"
|
||||||
|
shape="table"
|
||||||
|
aria-hidden="true"
|
||||||
|
></clr-icon>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
{{ libTable.replace('-FC', '') }}
|
{{ libTable.replace('-FC', '') }}
|
||||||
</button>
|
</button>
|
||||||
@@ -114,7 +126,7 @@
|
|||||||
</clr-tree>
|
</clr-tree>
|
||||||
</app-sidebar>
|
</app-sidebar>
|
||||||
|
|
||||||
<div class="content-area">
|
<main class="content-area">
|
||||||
<div class="card-block">
|
<div class="card-block">
|
||||||
<div *ngIf="loading" class="spinner-wrapper-fullpage">
|
<div *ngIf="loading" class="spinner-wrapper-fullpage">
|
||||||
<div class="loadingSpinner">
|
<div class="loadingSpinner">
|
||||||
@@ -144,4 +156,4 @@
|
|||||||
</p>
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</main>
|
||||||
|
|||||||
@@ -34,6 +34,8 @@
|
|||||||
</p>
|
</p>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
|
|
||||||
|
<p><strong>Protocol:</strong> {{ protocol }}</p>
|
||||||
|
|
||||||
<p>
|
<p>
|
||||||
<strong>SYSSITE:</strong>
|
<strong>SYSSITE:</strong>
|
||||||
<span
|
<span
|
||||||
|
|||||||
@@ -35,6 +35,10 @@ export class LicensingComponent implements OnInit {
|
|||||||
public activationKeyValue: string = ''
|
public activationKeyValue: string = ''
|
||||||
|
|
||||||
public applyingKeys: boolean = false
|
public applyingKeys: boolean = false
|
||||||
|
public protocol: string =
|
||||||
|
location.protocol === 'https:'
|
||||||
|
? 'HTTPS - secure connection'
|
||||||
|
: 'HTTP - insecure connection'
|
||||||
|
|
||||||
public syssite = this.appService.syssite
|
public syssite = this.appService.syssite
|
||||||
public currentLicenceKey = this.licenceService.licenceKey
|
public currentLicenceKey = this.licenceService.licenceKey
|
||||||
|
|||||||
@@ -1,9 +1,15 @@
|
|||||||
|
import {
|
||||||
|
DynamicCellValidation,
|
||||||
|
DynamicExtendedCellValidation
|
||||||
|
} from '../editor/models/dynamicExtendedCellValidation'
|
||||||
|
|
||||||
export interface CellValidationSource {
|
export interface CellValidationSource {
|
||||||
col: number
|
col: number
|
||||||
row: number
|
row: number
|
||||||
strict: boolean
|
strict: boolean
|
||||||
values: any[]
|
values: DynamicCellValidation[]
|
||||||
extended_values?: string[]
|
extended_values?: DynamicExtendedCellValidation[]
|
||||||
hash: string
|
hash: string
|
||||||
count: number
|
count: number
|
||||||
|
pending?: Promise<void>
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -37,7 +37,6 @@ export interface MaxVarLength {
|
|||||||
|
|
||||||
export interface SASParam {
|
export interface SASParam {
|
||||||
COLHEADERS: string
|
COLHEADERS: string
|
||||||
COLTYPE: string
|
|
||||||
DTTMVARS: string
|
DTTMVARS: string
|
||||||
DTVARS: string
|
DTVARS: string
|
||||||
CLS_FLAG: number
|
CLS_FLAG: number
|
||||||
|
|||||||
@@ -127,6 +127,7 @@
|
|||||||
class="no-table-selected pointer-events-none"
|
class="no-table-selected pointer-events-none"
|
||||||
>
|
>
|
||||||
<clr-icon
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
shape="upload-cloud"
|
shape="upload-cloud"
|
||||||
size="40"
|
size="40"
|
||||||
class="is-info icon-dc-fill"
|
class="is-info icon-dc-fill"
|
||||||
@@ -197,6 +198,7 @@
|
|||||||
>
|
>
|
||||||
<ng-container *ngIf="fileLoadingState !== FileLoadingState.parsed">
|
<ng-container *ngIf="fileLoadingState !== FileLoadingState.parsed">
|
||||||
<clr-icon
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
shape="process-on-vm"
|
shape="process-on-vm"
|
||||||
size="40"
|
size="40"
|
||||||
class="is-info icon-dc-fill"
|
class="is-info icon-dc-fill"
|
||||||
@@ -209,6 +211,7 @@
|
|||||||
|
|
||||||
<ng-container *ngIf="fileLoadingState === FileLoadingState.parsed">
|
<ng-container *ngIf="fileLoadingState === FileLoadingState.parsed">
|
||||||
<clr-icon
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
shape="warning-standard"
|
shape="warning-standard"
|
||||||
size="40"
|
size="40"
|
||||||
class="is-info icon-dc-fill"
|
class="is-info icon-dc-fill"
|
||||||
@@ -372,6 +375,7 @@
|
|||||||
class="no-table-selected pointer-events-none"
|
class="no-table-selected pointer-events-none"
|
||||||
>
|
>
|
||||||
<clr-icon
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
shape="warning-standard"
|
shape="warning-standard"
|
||||||
size="40"
|
size="40"
|
||||||
class="is-info icon-dc-fill"
|
class="is-info icon-dc-fill"
|
||||||
|
|||||||
@@ -22,10 +22,9 @@ import { ExcelRule } from '../models/TableData'
|
|||||||
import { HotTableInterface } from '../models/HotTable.interface'
|
import { HotTableInterface } from '../models/HotTable.interface'
|
||||||
import { Col } from '../shared/dc-validator/models/col.model'
|
import { Col } from '../shared/dc-validator/models/col.model'
|
||||||
import { SpreadsheetService } from '../services/spreadsheet.service'
|
import { SpreadsheetService } from '../services/spreadsheet.service'
|
||||||
import Handsontable from 'handsontable'
|
import Handsontable, { CellChange, ChangeSource } from 'handsontable'
|
||||||
import { HotTableComponent } from '@handsontable/angular-wrapper'
|
import { HotTableComponent } from '@handsontable/angular-wrapper'
|
||||||
import { EditorsStageDataSASResponse } from '../models/sas/editors-stagedata.model'
|
import { EditorsStageDataSASResponse } from '../models/sas/editors-stagedata.model'
|
||||||
import { CellChange, ChangeSource } from 'handsontable/common'
|
|
||||||
import { baseAfterGetColHeader } from '../shared/utils/hot.utils'
|
import { baseAfterGetColHeader } from '../shared/utils/hot.utils'
|
||||||
import { ColumnSettings } from 'handsontable/settings'
|
import { ColumnSettings } from 'handsontable/settings'
|
||||||
import { UploadFile } from '@sasjs/adapter'
|
import { UploadFile } from '@sasjs/adapter'
|
||||||
@@ -160,14 +159,16 @@ export class MultiDatasetComponent implements OnInit, AfterViewInit {
|
|||||||
filters: true,
|
filters: true,
|
||||||
stretchH: 'all',
|
stretchH: 'all',
|
||||||
afterGetColHeader: baseAfterGetColHeader,
|
afterGetColHeader: baseAfterGetColHeader,
|
||||||
modifyColWidth: this.maxWidthCheker
|
modifyColWidth: this.maxWidthCheker,
|
||||||
|
theme: 'ht-theme-classic'
|
||||||
}
|
}
|
||||||
|
|
||||||
// Exclude data from settings for HOT v16 - it will be loaded manually
|
// Exclude data from settings for HOT v16 - it will be loaded manually
|
||||||
const { data, ...settingsWithoutData } = this.hotUserDatasets
|
const { data, ...settingsWithoutData } = this.hotUserDatasets
|
||||||
this.hotUserDatasetsSettings = {
|
this.hotUserDatasetsSettings = {
|
||||||
...settingsWithoutData,
|
...settingsWithoutData,
|
||||||
licenseKey: this.hotTableLicenseKey
|
licenseKey: this.hotTableLicenseKey,
|
||||||
|
theme: 'ht-theme-classic'
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -500,7 +501,9 @@ export class MultiDatasetComponent implements OnInit, AfterViewInit {
|
|||||||
if (changes) {
|
if (changes) {
|
||||||
for (let change of changes) {
|
for (let change of changes) {
|
||||||
if (change && change[3]) {
|
if (change && change[3]) {
|
||||||
change[3] = change[3].toUpperCase()
|
// CellValue is `unknown` in HOT 18 (was a concrete union before);
|
||||||
|
// this column is always a dataset name string.
|
||||||
|
change[3] = (change[3] as string).toUpperCase()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -550,7 +553,9 @@ export class MultiDatasetComponent implements OnInit, AfterViewInit {
|
|||||||
dynamicCellValidations() {
|
dynamicCellValidations() {
|
||||||
if (!this.hotInstanceUserDataset) return
|
if (!this.hotInstanceUserDataset) return
|
||||||
|
|
||||||
const hotData = this.hotInstanceUserDataset.getData()
|
// getData() returns unknown[][] in HOT 18 (was CellValue[][]); this grid's
|
||||||
|
// data is always library/table name strings.
|
||||||
|
const hotData = this.hotInstanceUserDataset.getData() as string[][]
|
||||||
|
|
||||||
hotData.forEach((row, rowIndex) => {
|
hotData.forEach((row, rowIndex) => {
|
||||||
const library = row[0]
|
const library = row[0]
|
||||||
@@ -571,10 +576,12 @@ export class MultiDatasetComponent implements OnInit, AfterViewInit {
|
|||||||
|
|
||||||
if (dataAtRow && dataAtRow[0] && dataAtRow[1]) {
|
if (dataAtRow && dataAtRow[0] && dataAtRow[1]) {
|
||||||
if (!this.matchedDatasets.includes(dataset)) {
|
if (!this.matchedDatasets.includes(dataset)) {
|
||||||
|
// getCellMetaAtRow() returns Record<string, unknown>[] in HOT 18, so
|
||||||
|
// `.col` needs casting back to number for setCellMeta() (same below).
|
||||||
cellMetaAtRow.forEach((cellMeta) => {
|
cellMetaAtRow.forEach((cellMeta) => {
|
||||||
this.hotInstanceUserDataset.setCellMeta(
|
this.hotInstanceUserDataset.setCellMeta(
|
||||||
row,
|
row,
|
||||||
cellMeta.col,
|
cellMeta.col as number,
|
||||||
'className',
|
'className',
|
||||||
'not-matched'
|
'not-matched'
|
||||||
)
|
)
|
||||||
@@ -583,7 +590,7 @@ export class MultiDatasetComponent implements OnInit, AfterViewInit {
|
|||||||
cellMetaAtRow.forEach((cellMeta) => {
|
cellMetaAtRow.forEach((cellMeta) => {
|
||||||
this.hotInstanceUserDataset.setCellMeta(
|
this.hotInstanceUserDataset.setCellMeta(
|
||||||
row,
|
row,
|
||||||
cellMeta.col,
|
cellMeta.col as number,
|
||||||
'className',
|
'className',
|
||||||
''
|
''
|
||||||
)
|
)
|
||||||
@@ -593,7 +600,7 @@ export class MultiDatasetComponent implements OnInit, AfterViewInit {
|
|||||||
cellMetaAtRow.forEach((cellMeta) => {
|
cellMetaAtRow.forEach((cellMeta) => {
|
||||||
this.hotInstanceUserDataset.setCellMeta(
|
this.hotInstanceUserDataset.setCellMeta(
|
||||||
row,
|
row,
|
||||||
cellMeta.col,
|
cellMeta.col as number,
|
||||||
'className',
|
'className',
|
||||||
''
|
''
|
||||||
)
|
)
|
||||||
@@ -989,7 +996,8 @@ export class MultiDatasetComponent implements OnInit, AfterViewInit {
|
|||||||
private getDatasetsFromHot(): string[] {
|
private getDatasetsFromHot(): string[] {
|
||||||
if (!this.hotInstanceUserDataset) return []
|
if (!this.hotInstanceUserDataset) return []
|
||||||
|
|
||||||
const hotData = this.hotInstanceUserDataset.getData()
|
// getData() returns unknown[][] in HOT 18; see dynamicCellValidations() above.
|
||||||
|
const hotData = this.hotInstanceUserDataset.getData() as string[][]
|
||||||
|
|
||||||
return hotData
|
return hotData
|
||||||
.filter((row) => row[0]?.length && row[1]?.length)
|
.filter((row) => row[0]?.length && row[1]?.length)
|
||||||
|
|||||||
@@ -0,0 +1,48 @@
|
|||||||
|
import { HelperService } from './helper.service'
|
||||||
|
|
||||||
|
describe('HelperService - convertArrayValues', () => {
|
||||||
|
let service: HelperService
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
// convertArrayValues does not touch any injected dependency
|
||||||
|
service = new HelperService(null as any)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns an empty array for empty input', () => {
|
||||||
|
expect(service.convertArrayValues([], 'string')).toEqual([])
|
||||||
|
expect(service.convertArrayValues([], 'number')).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('coerces values to numbers for the numeric path', () => {
|
||||||
|
expect(service.convertArrayValues(['1', '2', '3'], 'number')).toEqual([
|
||||||
|
1, 2, 3
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('coerces values to strings for the string path', () => {
|
||||||
|
expect(service.convertArrayValues([1, 2, 3], 'string')).toEqual([
|
||||||
|
'1',
|
||||||
|
'2',
|
||||||
|
'3'
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
// Regression: a RAW_VALUE / dropdown source value that itself contains a
|
||||||
|
// comma must stay a single item. Previously `array.toString().split(',')`
|
||||||
|
// joined the array and re-split on every comma, shattering one value into
|
||||||
|
// several. Same bug that hit display_value lists.
|
||||||
|
it('keeps a single value containing commas intact (string path)', () => {
|
||||||
|
expect(service.convertArrayValues(['Smith, John'], 'string')).toEqual([
|
||||||
|
'Smith, John'
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not split multiple comma-containing values into individual items', () => {
|
||||||
|
const source = ['Smith, John', 'Doe, Jane', 'Plain']
|
||||||
|
|
||||||
|
const result = service.convertArrayValues(source, 'string')
|
||||||
|
|
||||||
|
expect(result).toEqual(['Smith, John', 'Doe, Jane', 'Plain'])
|
||||||
|
expect(result.length).toBe(3)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -280,7 +280,7 @@ export class HelperService {
|
|||||||
return array.map((value) => value * 1)
|
return array.map((value) => value * 1)
|
||||||
}
|
}
|
||||||
case 'string': {
|
case 'string': {
|
||||||
return array.toString().split(',')
|
return array.map((value) => `${value}`)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -170,15 +170,15 @@ export class LicenceService {
|
|||||||
errString
|
errString
|
||||||
)}&force=true`
|
)}&force=true`
|
||||||
this.licenceProblem.next(url)
|
this.licenceProblem.next(url)
|
||||||
this.router.navigateByUrl(url)
|
|
||||||
|
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
return this.applicationActivation(
|
this.applicationActivation(
|
||||||
this.freeTierLicenceData,
|
this.freeTierLicenceData,
|
||||||
variables,
|
variables,
|
||||||
startup_site_id,
|
startup_site_id,
|
||||||
true
|
true
|
||||||
)
|
)
|
||||||
|
this.router.navigateByUrl(url)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -155,13 +155,23 @@ export class SasStoreService {
|
|||||||
.adapterResponse
|
.adapterResponse
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private libsPromise: Promise<any> | null = null
|
||||||
|
|
||||||
/**
|
/**
|
||||||
*
|
*
|
||||||
* @returns All libraries
|
* @returns All libraries
|
||||||
*/
|
*/
|
||||||
public async viewLibs() {
|
public viewLibs() {
|
||||||
return (await this.sasService.request('public/viewlibs', null))
|
if (!this.libsPromise) {
|
||||||
.adapterResponse
|
this.libsPromise = this.sasService
|
||||||
|
.request('public/viewlibs', null)
|
||||||
|
.then((res: any) => res.adapterResponse)
|
||||||
|
.catch((err: any) => {
|
||||||
|
this.libsPromise = null
|
||||||
|
throw err
|
||||||
|
})
|
||||||
|
}
|
||||||
|
return this.libsPromise
|
||||||
}
|
}
|
||||||
|
|
||||||
public async refreshLibInfo(libref: string) {
|
public async refreshLibInfo(libref: string) {
|
||||||
|
|||||||
@@ -641,6 +641,23 @@ export class SasService {
|
|||||||
this.sasjsAdapter.setDebugState(state)
|
this.sasjsAdapter.setDebugState(state)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the `&_debug=...` URL segment honoring the live adapter
|
||||||
|
* config. Empty string when debug is off. `128` on the Viya WEB JES path
|
||||||
|
* with `runAsTask` enabled, `131` otherwise.
|
||||||
|
*/
|
||||||
|
public getDebugUrlParam(): string {
|
||||||
|
const config = this.sasjsAdapter.getSasjsConfig()
|
||||||
|
if (!config.debug) return ''
|
||||||
|
const value =
|
||||||
|
config.serverType === ServerType.SasViya &&
|
||||||
|
config.useComputeApi === null &&
|
||||||
|
config.runAsTask === true
|
||||||
|
? 128
|
||||||
|
: 131
|
||||||
|
return `&_debug=${value}`
|
||||||
|
}
|
||||||
|
|
||||||
public getSasjsInstance() {
|
public getSasjsInstance() {
|
||||||
return this.sasjsAdapter
|
return this.sasjsAdapter
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,274 @@
|
|||||||
|
import { VaFilterService } from './va-filter.service'
|
||||||
|
import { VaMessage } from './va-messaging.service'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Minimal stand-in for HelperService.convertJsDateToSasDate using the real
|
||||||
|
* epoch math, so date/datetime assertions use the actual SAS internal values
|
||||||
|
* without pulling in HelperService's dependency graph (SasService etc.).
|
||||||
|
*/
|
||||||
|
class HelperServiceStub {
|
||||||
|
convertJsDateToSasDate(jsDate: Date, unit = 'days'): number {
|
||||||
|
const ms = Date.UTC(
|
||||||
|
jsDate.getFullYear(),
|
||||||
|
jsDate.getMonth(),
|
||||||
|
jsDate.getDate(),
|
||||||
|
jsDate.getHours(),
|
||||||
|
jsDate.getMinutes(),
|
||||||
|
jsDate.getSeconds()
|
||||||
|
)
|
||||||
|
const sasMs = ms + 315619200000
|
||||||
|
return unit === 'days'
|
||||||
|
? Math.floor(Math.abs(sasMs / 86400000))
|
||||||
|
: sasMs / 1000
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function msg(parameters: any[]): VaMessage {
|
||||||
|
return {
|
||||||
|
resultName: 'r',
|
||||||
|
rowCount: 0,
|
||||||
|
data: [],
|
||||||
|
columns: [],
|
||||||
|
parameters
|
||||||
|
} as VaMessage
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('VaFilterService', () => {
|
||||||
|
let service: VaFilterService
|
||||||
|
|
||||||
|
// DC column metadata used by the metadata path. cellValidation[0] is the
|
||||||
|
// delete column and must be skipped by buildLabelToVarMap.
|
||||||
|
const cellValidation = [
|
||||||
|
{ data: 'DEL' },
|
||||||
|
{ data: 'SOME_CHAR' },
|
||||||
|
{ data: 'SOME_NUM' },
|
||||||
|
{ data: 'SOME_TIME' },
|
||||||
|
{ data: 'SOME_DATE' },
|
||||||
|
{ data: 'SOME_DATETIME' }
|
||||||
|
]
|
||||||
|
const columnHeader = [
|
||||||
|
'Delete?',
|
||||||
|
'SOME_CHAR',
|
||||||
|
'SOME_NUM',
|
||||||
|
'SOME_TIME',
|
||||||
|
'SOME_DATE',
|
||||||
|
'SOME_DATETIME'
|
||||||
|
]
|
||||||
|
const cols = [
|
||||||
|
{ NAME: 'SOME_CHAR', DDTYPE: 'CHARACTER' },
|
||||||
|
{ NAME: 'SOME_NUM', DDTYPE: 'NUMERIC' },
|
||||||
|
{ NAME: 'SOME_TIME', DDTYPE: 'TIME' },
|
||||||
|
{ NAME: 'SOME_DATE', DDTYPE: 'DATE' },
|
||||||
|
{ NAME: 'SOME_DATETIME', DDTYPE: 'DATETIME' }
|
||||||
|
]
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
service = new VaFilterService(new HelperServiceStub() as any)
|
||||||
|
})
|
||||||
|
|
||||||
|
const labelToVar = () =>
|
||||||
|
service.buildLabelToVarMap(cellValidation, columnHeader)
|
||||||
|
|
||||||
|
describe('buildLabelToVarMap', () => {
|
||||||
|
it('maps header and var name (case-insensitive), skipping the delete column', () => {
|
||||||
|
const map = labelToVar()
|
||||||
|
expect(map.get('some_char')).toBe('SOME_CHAR')
|
||||||
|
expect(map.get('some_num')).toBe('SOME_NUM')
|
||||||
|
expect(map.get('del')).toBeUndefined()
|
||||||
|
expect(map.get('delete?')).toBeUndefined()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('buildClauses (metadata path)', () => {
|
||||||
|
const build = (parameters: any[]) =>
|
||||||
|
service.buildClauses(msg(parameters), labelToVar(), cols)
|
||||||
|
|
||||||
|
it('builds a char equality clause, single-quote escaped', () => {
|
||||||
|
expect(build([{ label: 'SOME_CHAR', value: "O'Brien" }])).toEqual([
|
||||||
|
{
|
||||||
|
GROUP_LOGIC: 'AND',
|
||||||
|
SUBGROUP_LOGIC: 'AND',
|
||||||
|
SUBGROUP_ID: 0,
|
||||||
|
VARIABLE_NM: 'SOME_CHAR',
|
||||||
|
OPERATOR_NM: '=',
|
||||||
|
RAW_VALUE: "'O''Brien'"
|
||||||
|
}
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('builds an IN clause for multiple values', () => {
|
||||||
|
const [clause] = build([{ label: 'SOME_CHAR', value: ['A', 'B'] }])
|
||||||
|
expect(clause.OPERATOR_NM).toBe('IN')
|
||||||
|
expect(clause.RAW_VALUE).toBe("('A','B')")
|
||||||
|
})
|
||||||
|
|
||||||
|
it('passes numeric values raw and drops non-numeric (injection guard)', () => {
|
||||||
|
expect(build([{ label: 'SOME_NUM', value: '10' }])[0].RAW_VALUE).toBe(
|
||||||
|
'10'
|
||||||
|
)
|
||||||
|
expect(build([{ label: 'SOME_NUM', value: 'abc' }])).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('converts temporal values to SAS internal numbers', () => {
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_TIME', value: '0:00:02' }])[0].RAW_VALUE
|
||||||
|
).toBe('2')
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATE', value: '01JUL1960' }])[0].RAW_VALUE
|
||||||
|
).toBe('182')
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATETIME', value: '01JAN1960:00:06:05' }])[0]
|
||||||
|
.RAW_VALUE
|
||||||
|
).toBe('365')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('passes an already-internal (bare number) temporal value through raw', () => {
|
||||||
|
// VA sends the raw SAS internal value when the data item has no format.
|
||||||
|
expect(build([{ label: 'SOME_DATE', value: '182' }])[0].RAW_VALUE).toBe(
|
||||||
|
'182'
|
||||||
|
)
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATETIME', value: '365' }])[0].RAW_VALUE
|
||||||
|
).toBe('365')
|
||||||
|
expect(build([{ label: 'SOME_TIME', value: '2' }])[0].RAW_VALUE).toBe('2')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('parses ISO date shapes identically to DATE9 (VA sends no format)', () => {
|
||||||
|
const date9 = build([{ label: 'SOME_DATE', value: '01AUG1962' }])[0]
|
||||||
|
.RAW_VALUE
|
||||||
|
// The production symptom: YYMMDDS "2025/03/31" style must parse, not drop.
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATE', value: '1962-08-01' }])[0].RAW_VALUE
|
||||||
|
).toBe(date9)
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATE', value: '1962/08/01' }])[0].RAW_VALUE
|
||||||
|
).toBe(date9)
|
||||||
|
// A real production-format value must yield a clause (not be dropped).
|
||||||
|
expect(build([{ label: 'SOME_DATE', value: '2025/03/31' }])).toHaveSize(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('resolves ambiguous slash dates day-first (never US), disambiguating by value', () => {
|
||||||
|
const iso = build([{ label: 'SOME_DATE', value: '2025-03-31' }])[0]
|
||||||
|
.RAW_VALUE
|
||||||
|
// 31 can only be a day -> both orders resolve to 2025-03-31.
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATE', value: '31/03/2025' }])[0].RAW_VALUE
|
||||||
|
).toBe(iso) // day-first
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATE', value: '03/31/2025' }])[0].RAW_VALUE
|
||||||
|
).toBe(iso) // value forces month-first
|
||||||
|
// Genuinely ambiguous (both <= 12): default DAY-first => 4th March, NOT 3rd April.
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATE', value: '04/03/2025' }])[0].RAW_VALUE
|
||||||
|
).toBe(build([{ label: 'SOME_DATE', value: '2025-03-04' }])[0].RAW_VALUE)
|
||||||
|
// Impossible date is dropped, not rolled over.
|
||||||
|
expect(build([{ label: 'SOME_DATE', value: '31/02/2025' }])).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('uses the column FMTNAME to resolve ambiguous dates (MMDDYY reads US month-first)', () => {
|
||||||
|
const iso = (v: string) =>
|
||||||
|
service.buildClauses(
|
||||||
|
msg([{ label: 'D', value: v }]),
|
||||||
|
new Map([['d', 'D']]),
|
||||||
|
[{ NAME: 'D', DDTYPE: 'DATE' }]
|
||||||
|
)[0]?.RAW_VALUE
|
||||||
|
const withFmt = (fmt: string, v: string) =>
|
||||||
|
service.buildClauses(
|
||||||
|
msg([{ label: 'D', value: v }]),
|
||||||
|
new Map([['d', 'D']]),
|
||||||
|
[{ NAME: 'D', DDTYPE: 'DATE', FMTNAME: fmt }]
|
||||||
|
)[0]?.RAW_VALUE
|
||||||
|
// 04/03/2025, both <= 12 (ambiguous): FMTNAME decides.
|
||||||
|
expect(withFmt('MMDDYY', '04/03/2025')).toBe(iso('2025-04-03')) // 3 April
|
||||||
|
expect(withFmt('DDMMYY', '04/03/2025')).toBe(iso('2025-03-04')) // 4 March
|
||||||
|
// Value still overrides a wrong FMTNAME: 31 can only be the day.
|
||||||
|
expect(withFmt('MMDDYY', '31/03/2025')).toBe(iso('2025-03-31'))
|
||||||
|
// Falls back to the full FORMAT (e.g. MMDDYY10.) when FMTNAME is blank.
|
||||||
|
const withFormat = service.buildClauses(
|
||||||
|
msg([{ label: 'D', value: '04/03/2025' }]),
|
||||||
|
new Map([['d', 'D']]),
|
||||||
|
[{ NAME: 'D', DDTYPE: 'DATE', FMTNAME: '', FORMAT: 'MMDDYY10.' }]
|
||||||
|
)[0]?.RAW_VALUE
|
||||||
|
expect(withFormat).toBe(iso('2025-04-03')) // 3 April, from FORMAT
|
||||||
|
})
|
||||||
|
|
||||||
|
it('parses ISO datetime shapes identically to SAS DATETIME', () => {
|
||||||
|
const sas = build([
|
||||||
|
{ label: 'SOME_DATETIME', value: '01JAN1960:00:06:05' }
|
||||||
|
])[0].RAW_VALUE
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATETIME', value: '1960-01-01T00:06:05' }])[0]
|
||||||
|
.RAW_VALUE
|
||||||
|
).toBe(sas)
|
||||||
|
expect(
|
||||||
|
build([{ label: 'SOME_DATETIME', value: '1960-01-01 00:06:05' }])[0]
|
||||||
|
.RAW_VALUE
|
||||||
|
).toBe(sas)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('matches the column by label case-insensitively', () => {
|
||||||
|
expect(build([{ label: 'some_char', value: 'x' }])[0].VARIABLE_NM).toBe(
|
||||||
|
'SOME_CHAR'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('skips params that are empty or do not map to a column', () => {
|
||||||
|
expect(build([{ label: 'SOME_CHAR', value: '' }])).toEqual([])
|
||||||
|
expect(build([{ label: 'NOT_A_COLUMN', value: 'x' }])).toEqual([])
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('buildInitialClauses (no metadata, infer kind from value)', () => {
|
||||||
|
it('uses the VA label as the column and infers kinds by value shape', () => {
|
||||||
|
const clauses = service.buildInitialClauses(
|
||||||
|
msg([
|
||||||
|
{ name: 'pr1', label: 'SOME_CHAR', dataType: 'string', value: 'x' },
|
||||||
|
{ name: 'pr2', label: 'SOME_NUM', dataType: 'number', value: '10' },
|
||||||
|
{ name: 'pr3', label: 'SOME_TIME', value: '0:00:02' },
|
||||||
|
{ name: 'pr4', label: 'SOME_DATE', value: '01JUL1960' },
|
||||||
|
{ name: 'pr5', label: 'SOME_DATETIME', value: '01JAN1960:00:06:05' }
|
||||||
|
])
|
||||||
|
)
|
||||||
|
expect(clauses.map((c) => [c.VARIABLE_NM, c.RAW_VALUE])).toEqual([
|
||||||
|
['SOME_CHAR', "'x'"],
|
||||||
|
['SOME_NUM', '10'],
|
||||||
|
['SOME_TIME', '2'],
|
||||||
|
['SOME_DATE', '182'],
|
||||||
|
['SOME_DATETIME', '365']
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('infers ISO date/datetime shapes by value shape', () => {
|
||||||
|
const clauses = service.buildInitialClauses(
|
||||||
|
msg([
|
||||||
|
{ name: 'pr1', label: 'SOME_DATE', value: '1960-07-01' },
|
||||||
|
{ name: 'pr2', label: 'SOME_DATE2', value: '1960/07/01' },
|
||||||
|
{ name: 'pr3', label: 'SOME_DTTM', value: '1960-01-01T00:06:05' }
|
||||||
|
])
|
||||||
|
)
|
||||||
|
expect(clauses.map((c) => [c.VARIABLE_NM, c.RAW_VALUE])).toEqual([
|
||||||
|
['SOME_DATE', '182'],
|
||||||
|
['SOME_DATE2', '182'],
|
||||||
|
['SOME_DTTM', '365']
|
||||||
|
])
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('signature', () => {
|
||||||
|
it('is case-insensitive on the column name (no reconcile reload)', () => {
|
||||||
|
const a = [
|
||||||
|
{ VARIABLE_NM: 'some_char', OPERATOR_NM: '=', RAW_VALUE: "'x'" }
|
||||||
|
] as any
|
||||||
|
const b = [
|
||||||
|
{ VARIABLE_NM: 'SOME_CHAR', OPERATOR_NM: '=', RAW_VALUE: "'x'" }
|
||||||
|
] as any
|
||||||
|
expect(service.signature(a)).toBe(service.signature(b))
|
||||||
|
})
|
||||||
|
|
||||||
|
it('changes when a value changes', () => {
|
||||||
|
const a = [{ VARIABLE_NM: 'SOME_CHAR', RAW_VALUE: "'x'" }] as any
|
||||||
|
const b = [{ VARIABLE_NM: 'SOME_CHAR', RAW_VALUE: "'y'" }] as any
|
||||||
|
expect(service.signature(a)).not.toBe(service.signature(b))
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,421 @@
|
|||||||
|
import { Injectable } from '@angular/core'
|
||||||
|
import { HelperService } from './helper.service'
|
||||||
|
import { VaMessage } from './va-messaging.service'
|
||||||
|
import { QueryClause } from '../models/TableData'
|
||||||
|
|
||||||
|
/** SAS data-type kind used to format a VA filter value into a DC RAW_VALUE. */
|
||||||
|
type VaColumnKind = 'char' | 'numeric' | 'time' | 'date' | 'datetime'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translates SAS Visual Analytics data-driven content `parameters` into DC
|
||||||
|
* filter clauses. Independent of editor/HOT state — the editor passes the
|
||||||
|
* loaded column metadata in — so it is unit-testable on its own. Temporal
|
||||||
|
* values are converted to SAS internal numbers (matching DC's native filters)
|
||||||
|
* via the shared HelperService.
|
||||||
|
*/
|
||||||
|
@Injectable({ providedIn: 'root' })
|
||||||
|
export class VaFilterService {
|
||||||
|
private static readonly SAS_MONTHS = [
|
||||||
|
'JAN',
|
||||||
|
'FEB',
|
||||||
|
'MAR',
|
||||||
|
'APR',
|
||||||
|
'MAY',
|
||||||
|
'JUN',
|
||||||
|
'JUL',
|
||||||
|
'AUG',
|
||||||
|
'SEP',
|
||||||
|
'OCT',
|
||||||
|
'NOV',
|
||||||
|
'DEC'
|
||||||
|
]
|
||||||
|
|
||||||
|
constructor(private helperService: HelperService) {}
|
||||||
|
|
||||||
|
/** label/name (lower-cased) -> DC variable (prop) name, skipping the delete col. */
|
||||||
|
buildLabelToVarMap(
|
||||||
|
cellValidation: any[],
|
||||||
|
columnHeader: string[]
|
||||||
|
): Map<string, string> {
|
||||||
|
const map = new Map<string, string>()
|
||||||
|
for (let i = 1; i < cellValidation.length; i++) {
|
||||||
|
const varName = cellValidation[i]?.data
|
||||||
|
if (!varName) continue
|
||||||
|
map.set(
|
||||||
|
(columnHeader[i] ?? varName).toString().trim().toLowerCase(),
|
||||||
|
varName
|
||||||
|
)
|
||||||
|
map.set(varName.toString().trim().toLowerCase(), varName)
|
||||||
|
}
|
||||||
|
return map
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Translates VA `parameters` into DC filter clauses. Each parameter is matched
|
||||||
|
* to a DC column by label; a single value becomes `col = value`, multiple
|
||||||
|
* values become `col IN (...)`. Values are formatted for the column's SAS kind.
|
||||||
|
*/
|
||||||
|
buildClauses(
|
||||||
|
msg: VaMessage,
|
||||||
|
labelToVar: Map<string, string>,
|
||||||
|
cols: any[]
|
||||||
|
): QueryClause[] {
|
||||||
|
const clauses: QueryClause[] = []
|
||||||
|
for (const param of msg.parameters || []) {
|
||||||
|
if (!param || param.value === undefined || param.value === null) continue
|
||||||
|
const key = (param.label ?? param.name ?? '')
|
||||||
|
.toString()
|
||||||
|
.trim()
|
||||||
|
.toLowerCase()
|
||||||
|
// A VA param whose label isn't a DC column (beyond case, which is handled)
|
||||||
|
// simply doesn't map — skip it.
|
||||||
|
const varName = labelToVar.get(key)
|
||||||
|
if (!varName) continue
|
||||||
|
|
||||||
|
const col = this.findCol(varName, cols)
|
||||||
|
const kind = this.columnKind(col)
|
||||||
|
const order = this.dateOrderFromFmt(col?.FMTNAME || col?.FORMAT)
|
||||||
|
const rawValues = Array.isArray(param.value) ? param.value : [param.value]
|
||||||
|
// Format/validate every value for the column's SAS type. Numeric columns
|
||||||
|
// must receive a finite number (untrusted postMessage input is
|
||||||
|
// interpolated into a SAS WHERE clause, so a non-numeric value here would
|
||||||
|
// be an injection vector); temporal -> SAS internal number; char ->
|
||||||
|
// escaped. Invalid values are dropped.
|
||||||
|
const formatted = rawValues
|
||||||
|
.filter((v) => v !== undefined && v !== null && v !== '')
|
||||||
|
.map((v) => this.formatValueByKind(v, kind, order))
|
||||||
|
.filter((v): v is string => v !== null)
|
||||||
|
if (formatted.length === 0) continue
|
||||||
|
clauses.push(this.clause(varName, formatted))
|
||||||
|
}
|
||||||
|
return clauses
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pre-getdata variant used on the deferred initial load, when DC column
|
||||||
|
* metadata isn't available. Uses the VA `label` as the column name and infers
|
||||||
|
* the SAS kind from the value shape, so the clause matches what the metadata
|
||||||
|
* build later produces (no reconcile reload).
|
||||||
|
*/
|
||||||
|
buildInitialClauses(msg: VaMessage): QueryClause[] {
|
||||||
|
const clauses: QueryClause[] = []
|
||||||
|
for (const param of msg.parameters || []) {
|
||||||
|
if (!param || param.value === undefined || param.value === null) continue
|
||||||
|
// The DC column name is the VA `label`; `name` is VA's internal id (pr###).
|
||||||
|
const varName = (param.label ?? param.name ?? '').toString().trim()
|
||||||
|
if (!varName) continue
|
||||||
|
|
||||||
|
const rawValues = Array.isArray(param.value) ? param.value : [param.value]
|
||||||
|
const nonEmpty = rawValues.filter(
|
||||||
|
(v) => v !== undefined && v !== null && v !== ''
|
||||||
|
)
|
||||||
|
if (nonEmpty.length === 0) continue
|
||||||
|
|
||||||
|
const formatted = nonEmpty
|
||||||
|
.map((v) =>
|
||||||
|
this.formatValueByKind(
|
||||||
|
v,
|
||||||
|
this.inferKindFromValue(String(v).trim(), param.dataType)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
.filter((v): v is string => v !== null)
|
||||||
|
if (formatted.length === 0) continue
|
||||||
|
clauses.push(this.clause(varName, formatted))
|
||||||
|
}
|
||||||
|
return clauses
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stable signature of filter clauses for cross-reload dedup. VARIABLE_NM is
|
||||||
|
* upper-cased because the metadata-less deferred build uses VA's label case
|
||||||
|
* while the metadata build uses DC's stored column case — SAS WHERE clauses
|
||||||
|
* are case-insensitive, so those are the same filter and must not trigger a
|
||||||
|
* reconcile reload. A genuine value difference still changes the signature.
|
||||||
|
*/
|
||||||
|
signature(clauses: QueryClause[]): string {
|
||||||
|
return JSON.stringify(
|
||||||
|
clauses.map((c) => ({
|
||||||
|
...c,
|
||||||
|
VARIABLE_NM: (c.VARIABLE_NM ?? '').toString().toUpperCase()
|
||||||
|
}))
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
private clause(varName: string, formatted: string[]): QueryClause {
|
||||||
|
return {
|
||||||
|
GROUP_LOGIC: 'AND',
|
||||||
|
SUBGROUP_LOGIC: 'AND',
|
||||||
|
SUBGROUP_ID: 0,
|
||||||
|
VARIABLE_NM: varName,
|
||||||
|
OPERATOR_NM: formatted.length === 1 ? '=' : 'IN',
|
||||||
|
RAW_VALUE:
|
||||||
|
formatted.length === 1 ? formatted[0] : `(${formatted.join(',')})`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The loaded column spec whose NAME matches varName (case-insensitive). */
|
||||||
|
private findCol(varName: string, cols: any[]): any {
|
||||||
|
return (cols || []).find(
|
||||||
|
(x: any) =>
|
||||||
|
(x?.NAME ?? '').toString().toUpperCase() === varName.toUpperCase()
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SAS data-type kind of a column spec. DDTYPE carries
|
||||||
|
* TIME/DATE/DATETIME/NUMERIC/CHARACTER; checked DATETIME-before-DATE (substring).
|
||||||
|
*/
|
||||||
|
private columnKind(col: any): VaColumnKind {
|
||||||
|
const ddtype = (col?.DDTYPE ?? '').toString().toUpperCase()
|
||||||
|
if (ddtype.includes('DATETIME')) return 'datetime'
|
||||||
|
if (ddtype.includes('DATE')) return 'date'
|
||||||
|
if (ddtype.includes('TIME')) return 'time'
|
||||||
|
if (ddtype.includes('NUMERIC') || (col?.TYPE ?? '') === 'num') {
|
||||||
|
return 'numeric'
|
||||||
|
}
|
||||||
|
return 'char'
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Day/month/year order declared by a column's SAS format, used to resolve
|
||||||
|
* ambiguous numeric dates. Accepts either the base FMTNAME (e.g. `DDMMYY`) or
|
||||||
|
* the full FORMAT (e.g. `DDMMYY10.`) — the leading name is the same and is all
|
||||||
|
* that matters for order (width is irrelevant). This is the SOURCE column's
|
||||||
|
* format; the VA report can in principle display a different one, so
|
||||||
|
* value-based disambiguation (a group > 12 is the day) still takes precedence —
|
||||||
|
* this only decides the genuinely-ambiguous case. `undefined` when the format
|
||||||
|
* is absent, month-name (DATE*), or locale-dependent (NLDATE).
|
||||||
|
*/
|
||||||
|
private dateOrderFromFmt(fmtname: any): 'YMD' | 'DMY' | 'MDY' | undefined {
|
||||||
|
const f = (fmtname ?? '').toString().toUpperCase()
|
||||||
|
if (/^MMDDYY/.test(f)) return 'MDY'
|
||||||
|
if (/^(DDMMYY|EURDF)/.test(f)) return 'DMY'
|
||||||
|
if (/^(YYMMDD|E8601DA|B8601DA)/.test(f)) return 'YMD'
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Infers a column's SAS kind from a VA value string (deferred load, no
|
||||||
|
* metadata). VA's temporal strings are distinctive — DATE9 `ddMMMyyyy` and ISO
|
||||||
|
* `yyyy-MM-dd`/`yyyy/MM/dd`, optionally with a `[ T:]HH:MM[:SS]` time part, and
|
||||||
|
* `H:MM:SS` — so they're detected by shape; otherwise fall back to the VA
|
||||||
|
* `dataType`.
|
||||||
|
*/
|
||||||
|
private inferKindFromValue(value: string, dataType?: string): VaColumnKind {
|
||||||
|
const monName = String.raw`\d{1,2}[A-Za-z]{3}\d{2,4}`
|
||||||
|
const ymd = String.raw`\d{4}[-/.]\d{1,2}[-/.]\d{1,2}` // 4-digit year first
|
||||||
|
const dmy = String.raw`\d{1,2}[-/.]\d{1,2}[-/.]\d{4}` // 4-digit year last
|
||||||
|
const date = `${monName}|${ymd}|${dmy}`
|
||||||
|
if (new RegExp(`^(?:${date})[ T:]\\d{1,2}:\\d{2}(:\\d{2})?$`).test(value)) {
|
||||||
|
return 'datetime'
|
||||||
|
}
|
||||||
|
if (new RegExp(`^(?:${date})$`).test(value)) return 'date'
|
||||||
|
if (/^\d{1,2}:\d{2}(:\d{2})?(\.\d+)?$/.test(value)) return 'time'
|
||||||
|
if (dataType === 'number') return 'numeric'
|
||||||
|
return 'char'
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Formats one VA filter value into a DC RAW_VALUE for the column kind, or null
|
||||||
|
* when invalid (dropped). Matches DC's native filters, which send the NUMERIC
|
||||||
|
* INTERNAL value (not SAS literals — those error out in the backend):
|
||||||
|
* - numeric -> finite number, raw (else null — injection guard)
|
||||||
|
* - time -> seconds since midnight (VA: "0:00:02" -> 2)
|
||||||
|
* - date -> days since 1960-01-01 (VA: "01JUL1960" -> 182)
|
||||||
|
* - datetime -> seconds since 1960-01-01 (VA: "01JAN1960:00:06:05" -> 365)
|
||||||
|
* - char -> single-quote escaped
|
||||||
|
* Temporal strings are regex-parsed (digits/letters/colons only), so a value
|
||||||
|
* either yields a finite number or is dropped — also the injection guard.
|
||||||
|
* Date/datetime reuse HelperService.convertJsDateToSasDate so the value is
|
||||||
|
* byte-identical to what DC's own pickers produce.
|
||||||
|
*
|
||||||
|
* A temporal value that is already a bare number is the SAS internal value
|
||||||
|
* itself (VA sends it unformatted when the data item carries no format / is
|
||||||
|
* used as a measure), so it is passed through raw. This is unambiguous because
|
||||||
|
* the only date formats in use (DATE9, ISO) always contain a letter or a
|
||||||
|
* separator — a plain integer is never a formatted date.
|
||||||
|
*/
|
||||||
|
private formatValueByKind(
|
||||||
|
value: any,
|
||||||
|
kind: VaColumnKind,
|
||||||
|
order?: 'YMD' | 'DMY' | 'MDY'
|
||||||
|
): string | null {
|
||||||
|
const s = String(value).trim()
|
||||||
|
if (s === '') return null
|
||||||
|
switch (kind) {
|
||||||
|
case 'numeric': {
|
||||||
|
const num = Number(s)
|
||||||
|
return Number.isFinite(num) ? `${num}` : null
|
||||||
|
}
|
||||||
|
case 'time': {
|
||||||
|
if (this.isBareNumber(s)) return `${Number(s)}`
|
||||||
|
const secs = this.timeToSeconds(s)
|
||||||
|
return secs === null ? null : `${secs}`
|
||||||
|
}
|
||||||
|
case 'date': {
|
||||||
|
if (this.isBareNumber(s)) return `${Number(s)}`
|
||||||
|
const d = this.parseDate(s, order)
|
||||||
|
return d
|
||||||
|
? `${this.helperService.convertJsDateToSasDate(d, 'days')}`
|
||||||
|
: null
|
||||||
|
}
|
||||||
|
case 'datetime': {
|
||||||
|
if (this.isBareNumber(s)) return `${Number(s)}`
|
||||||
|
const d = this.parseDatetime(s, order)
|
||||||
|
return d
|
||||||
|
? `${this.helperService.convertJsDateToSasDate(d, 'seconds')}`
|
||||||
|
: null
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return `'${s.replace(/'/g, "''")}'`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** "H:MM[:SS][.f]" -> seconds since midnight, or null if not a valid time. */
|
||||||
|
private timeToSeconds(value: string): number | null {
|
||||||
|
if (!/^\d{1,2}:\d{2}(:\d{2})?(\.\d+)?$/.test(value)) return null
|
||||||
|
const p = value.split('.')[0].split(':')
|
||||||
|
const h = Number(p[0])
|
||||||
|
const m = Number(p[1])
|
||||||
|
const sec = p.length === 3 ? Number(p[2]) : 0
|
||||||
|
if (![h, m, sec].every(Number.isFinite)) return null
|
||||||
|
return h * 3600 + m * 60 + sec
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* VA date string -> local JS Date, or null. VA sends no format metadata, so the
|
||||||
|
* shape is sniffed. Accepted forms (separator may be `-`, `/`, or `.`):
|
||||||
|
* - DATE9 "ddMMM[yy]yy" (e.g. 01AUG1962)
|
||||||
|
* - ISO/YMD "yyyy-MM-dd" (4-digit year first, e.g. 2025-03-31)
|
||||||
|
* - year-last "dd/mm/yyyy" or "mm/dd/yyyy" (4-digit year last)
|
||||||
|
*
|
||||||
|
* Day/month order for the year-last form is resolved in priority order:
|
||||||
|
* 1. by value — a group > 12 must be the day (ground truth);
|
||||||
|
* 2. by `order` — the column's declared FMTNAME order (DMY/MDY/YMD);
|
||||||
|
* 3. default DAY-FIRST — never US month-first — matching SAS's DDMMYY
|
||||||
|
* default and non-US convention.
|
||||||
|
* `new Date(y, m-1, d)` is local, matching HelperService.convertJsDateToSasDate
|
||||||
|
* so the value is byte-identical to DC's own pickers. The constructed date is
|
||||||
|
* round-trip validated to reject impossible values (e.g. 31/02) rather than
|
||||||
|
* silently roll over.
|
||||||
|
*/
|
||||||
|
private parseDate(value: string, order?: 'YMD' | 'DMY' | 'MDY'): Date | null {
|
||||||
|
return this.parseMonthNameDate(value) ?? this.parseNumericDate(value, order)
|
||||||
|
}
|
||||||
|
|
||||||
|
/** DATE9 "ddMMM[yy]yy" (e.g. 01AUG1962, 01AUG62) -> local Date, or null. */
|
||||||
|
private parseMonthNameDate(value: string): Date | null {
|
||||||
|
const m = /^(\d{1,2})([A-Za-z]{3})(\d{2}|\d{4})$/.exec(value)
|
||||||
|
if (!m) return null
|
||||||
|
const [, day, monthAbbr, year] = m
|
||||||
|
const monthIndex = VaFilterService.SAS_MONTHS.indexOf(
|
||||||
|
monthAbbr.toUpperCase()
|
||||||
|
)
|
||||||
|
if (monthIndex < 0) return null
|
||||||
|
return this.buildDate(this.fullYear(year), monthIndex + 1, Number(day))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Numeric date with `-`, `/`, or `.` separators -> local Date, or null:
|
||||||
|
* - year-first "yyyy-MM-dd" -> YMD directly;
|
||||||
|
* - year-last "dd/mm/yyyy" or "mm/dd/yyyy" -> day/month resolved by
|
||||||
|
* resolveDayMonth (value, then column order, then day-first default).
|
||||||
|
* A 4-digit year (leading or trailing) is required to anchor the parse;
|
||||||
|
* an all-2-digit value (e.g. "03/04/05") is too ambiguous and is dropped.
|
||||||
|
*/
|
||||||
|
private parseNumericDate(
|
||||||
|
value: string,
|
||||||
|
order?: 'YMD' | 'DMY' | 'MDY'
|
||||||
|
): Date | null {
|
||||||
|
const m = /^(\d{1,4})[-/.](\d{1,2})[-/.](\d{1,4})$/.exec(value)
|
||||||
|
if (!m) return null
|
||||||
|
const [, first, middle, last] = m
|
||||||
|
const yearIsFirst = first.length === 4
|
||||||
|
const yearIsLast = last.length === 4
|
||||||
|
|
||||||
|
if (yearIsFirst) {
|
||||||
|
return this.buildDate(Number(first), Number(middle), Number(last))
|
||||||
|
}
|
||||||
|
if (!yearIsLast) return null
|
||||||
|
|
||||||
|
const { day, month } = this.resolveDayMonth(
|
||||||
|
Number(first),
|
||||||
|
Number(middle),
|
||||||
|
order
|
||||||
|
)
|
||||||
|
return this.buildDate(Number(last), month, day)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resolves the day/month of a year-last date whose two leading groups (`a`,
|
||||||
|
* `b`) are in unknown order, in priority:
|
||||||
|
* 1. by value — a group > 12 must be the day (ground truth);
|
||||||
|
* 2. by `order` — only MDY flips to month-first; DMY/YMD keep day-first;
|
||||||
|
* 3. default — DAY-first (`a` is the day), never US month-first.
|
||||||
|
*/
|
||||||
|
private resolveDayMonth(
|
||||||
|
a: number,
|
||||||
|
b: number,
|
||||||
|
order?: 'YMD' | 'DMY' | 'MDY'
|
||||||
|
): { day: number; month: number } {
|
||||||
|
if (a > 12 && b <= 12) return { day: a, month: b }
|
||||||
|
if (b > 12 && a <= 12) return { day: b, month: a }
|
||||||
|
if (order === 'MDY') return { day: b, month: a }
|
||||||
|
return { day: a, month: b }
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Local Date from 1-based month, round-trip validated (null if impossible). */
|
||||||
|
private buildDate(
|
||||||
|
year: number,
|
||||||
|
month: number,
|
||||||
|
day: number,
|
||||||
|
hours = 0,
|
||||||
|
minutes = 0,
|
||||||
|
seconds = 0
|
||||||
|
): Date | null {
|
||||||
|
if (month < 1 || month > 12 || day < 1 || day > 31) return null
|
||||||
|
const d = new Date(year, month - 1, day, hours, minutes, seconds, 0)
|
||||||
|
// Reject rollovers (e.g. 31 Feb -> 3 Mar) so a bad value is dropped, not
|
||||||
|
// silently converted to the wrong SAS date.
|
||||||
|
if (
|
||||||
|
d.getFullYear() !== year ||
|
||||||
|
d.getMonth() !== month - 1 ||
|
||||||
|
d.getDate() !== day
|
||||||
|
) {
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
return d
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* VA datetime string -> local JS Date, or null. The date part is any shape
|
||||||
|
* accepted by parseDate; the time part is "HH:MM[:SS]". They are joined by the
|
||||||
|
* SAS ":" separator (e.g. 01JAN1960:05:13:03), an ISO "T", or a space
|
||||||
|
* (e.g. 2025-03-31T05:13:03, 2025-03-31 05:13:03).
|
||||||
|
*/
|
||||||
|
private parseDatetime(
|
||||||
|
value: string,
|
||||||
|
order?: 'YMD' | 'DMY' | 'MDY'
|
||||||
|
): Date | null {
|
||||||
|
const m = /^(.+?)[ T:](\d{1,2}:\d{2}(?::\d{2})?)$/.exec(value)
|
||||||
|
if (!m) return null
|
||||||
|
const date = this.parseDate(m[1], order)
|
||||||
|
if (!date) return null
|
||||||
|
const t = m[2].split(':')
|
||||||
|
date.setHours(Number(t[0]), Number(t[1]), Number(t[2] || 0), 0)
|
||||||
|
return date
|
||||||
|
}
|
||||||
|
|
||||||
|
/** True when the value is a bare (already-internal) SAS number: optional sign,
|
||||||
|
* digits, optional fraction. No letters/separators — so never a formatted date. */
|
||||||
|
private isBareNumber(value: string): boolean {
|
||||||
|
return /^-?\d+(\.\d+)?$/.test(value) && Number.isFinite(Number(value))
|
||||||
|
}
|
||||||
|
|
||||||
|
/** 2-digit SAS year -> 4-digit (SAS default cutoff: 00-19 -> 20xx, else 19xx). */
|
||||||
|
private fullYear(year: string): number {
|
||||||
|
if (year.length === 4) return Number(year)
|
||||||
|
const y = Number(year)
|
||||||
|
return y <= 19 ? 2000 + y : 1900 + y
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
import { VaMessagingService, VaMessage } from './va-messaging.service'
|
||||||
|
|
||||||
|
// Sample message taken from the official SAS DDC docs (brush column included).
|
||||||
|
const SAMPLE = {
|
||||||
|
version: '1',
|
||||||
|
resultName: 'dd40',
|
||||||
|
rowCount: 3,
|
||||||
|
availableRowCount: 3,
|
||||||
|
data: [
|
||||||
|
['Finch', 95000.0, 0.4285],
|
||||||
|
['Jones', 26000.0, 0.0],
|
||||||
|
['Smith', 108000.0, 0.5]
|
||||||
|
],
|
||||||
|
columns: [
|
||||||
|
{ name: 'bi184', label: 'dealer', type: 'string' },
|
||||||
|
{
|
||||||
|
name: 'bi258',
|
||||||
|
label: 'sales',
|
||||||
|
type: 'number',
|
||||||
|
usage: 'quantitative',
|
||||||
|
aggregation: 'sum'
|
||||||
|
},
|
||||||
|
{ name: 'ri1', type: 'number', usage: 'brush' }
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('VaMessagingService', () => {
|
||||||
|
let service: VaMessagingService
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
service = new VaMessagingService()
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('parseMessage', () => {
|
||||||
|
it('parses a valid DDC message and defaults parameters to []', () => {
|
||||||
|
const msg = service.parseMessage({ data: SAMPLE } as MessageEvent)
|
||||||
|
expect(msg).not.toBeNull()
|
||||||
|
expect(msg!.resultName).toBe('dd40')
|
||||||
|
expect(msg!.rowCount).toBe(3)
|
||||||
|
expect(msg!.parameters).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns null for unrelated / malformed messages', () => {
|
||||||
|
expect(service.parseMessage({ data: null } as MessageEvent)).toBeNull()
|
||||||
|
expect(
|
||||||
|
service.parseMessage({ data: 'hello' } as unknown as MessageEvent)
|
||||||
|
).toBeNull()
|
||||||
|
expect(
|
||||||
|
service.parseMessage({ data: { columns: [] } } as MessageEvent)
|
||||||
|
).toBeNull()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('dataColumns', () => {
|
||||||
|
it('excludes brush columns and keeps original indices', () => {
|
||||||
|
const msg = service.parseMessage({ data: SAMPLE } as MessageEvent)!
|
||||||
|
const cols = service.dataColumns(msg)
|
||||||
|
expect(cols.map((c) => c.column.name)).toEqual(['bi184', 'bi258'])
|
||||||
|
expect(cols.map((c) => c.index)).toEqual([0, 1])
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('onData', () => {
|
||||||
|
const sameOrigin = window.location.origin
|
||||||
|
|
||||||
|
it('invokes the callback for valid messages and unsubscribes cleanly', () => {
|
||||||
|
const received: VaMessage[] = []
|
||||||
|
const off = service.onData((m) => received.push(m))
|
||||||
|
|
||||||
|
window.dispatchEvent(
|
||||||
|
new MessageEvent('message', { data: SAMPLE, origin: sameOrigin })
|
||||||
|
)
|
||||||
|
expect(received.length).toBe(1)
|
||||||
|
expect(received[0].resultName).toBe('dd40')
|
||||||
|
|
||||||
|
// unrelated traffic is ignored
|
||||||
|
window.dispatchEvent(
|
||||||
|
new MessageEvent('message', { data: { foo: 1 }, origin: sameOrigin })
|
||||||
|
)
|
||||||
|
expect(received.length).toBe(1)
|
||||||
|
|
||||||
|
off()
|
||||||
|
window.dispatchEvent(
|
||||||
|
new MessageEvent('message', { data: SAMPLE, origin: sameOrigin })
|
||||||
|
)
|
||||||
|
expect(received.length).toBe(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('rejects messages from an untrusted origin', () => {
|
||||||
|
const received: VaMessage[] = []
|
||||||
|
service.onData((m) => received.push(m))
|
||||||
|
|
||||||
|
window.dispatchEvent(
|
||||||
|
new MessageEvent('message', {
|
||||||
|
data: SAMPLE,
|
||||||
|
origin: 'https://evil.example.com'
|
||||||
|
})
|
||||||
|
)
|
||||||
|
expect(received.length).toBe(0)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,218 @@
|
|||||||
|
import { Injectable } from '@angular/core'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SAS Visual Analytics data-driven content (DDC) postMessage interface.
|
||||||
|
*
|
||||||
|
* Contract (from the official SAS docs and the sample repo
|
||||||
|
* https://github.com/sassoftware/sas-visualanalytics-thirdpartyvisualizations):
|
||||||
|
* VA shares data with the data-driven content object via window.postMessage().
|
||||||
|
* The content registers a `message` listener; `event.data` is a JSON object.
|
||||||
|
* To act as the source of an action (selection / brushing) or to show an
|
||||||
|
* instructional message, the content posts a message back to `window.parent`,
|
||||||
|
* echoing the `resultName`.
|
||||||
|
*/
|
||||||
|
|
||||||
|
export interface VaColumn {
|
||||||
|
/** Internal VA column id, e.g. "bi184". */
|
||||||
|
name: string
|
||||||
|
/** Human label, e.g. "dealer". May be absent (e.g. on brush columns). */
|
||||||
|
label?: string
|
||||||
|
type: string
|
||||||
|
/** "categorical" | "quantitative" | "brush" | ... */
|
||||||
|
usage?: string
|
||||||
|
aggregation?: string
|
||||||
|
format?: any
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface VaParameter {
|
||||||
|
/** VA internal id, e.g. "pr273". NOT the DC column. */
|
||||||
|
name: string
|
||||||
|
/** Human label — equals the DC column name in our setup, e.g. "some_dropdown". */
|
||||||
|
label?: string
|
||||||
|
/** "number" | "string" — VA's value type (used to decide numeric vs char). */
|
||||||
|
dataType?: string
|
||||||
|
type?: string
|
||||||
|
format?: any
|
||||||
|
value: any
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface VaMessage {
|
||||||
|
version?: string
|
||||||
|
/** Required to echo back on any message to VA. */
|
||||||
|
resultName: string
|
||||||
|
rowCount: number
|
||||||
|
availableRowCount?: number
|
||||||
|
/** Row-major 2-D array; cell order matches `columns`. Measures are unformatted. */
|
||||||
|
data: any[][]
|
||||||
|
columns: VaColumn[]
|
||||||
|
/** Only the parameters used by the query are returned. */
|
||||||
|
parameters: VaParameter[]
|
||||||
|
}
|
||||||
|
|
||||||
|
@Injectable({ providedIn: 'root' })
|
||||||
|
export class VaMessagingService {
|
||||||
|
/** Result name from the most recent message, needed for the back-channel. */
|
||||||
|
private resultName: string | null = null
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Origin of the last trusted inbound message — used as the explicit
|
||||||
|
* targetOrigin for the back-channel so payloads are never broadcast to an
|
||||||
|
* unintended parent.
|
||||||
|
*/
|
||||||
|
private parentOrigin: string | null = null
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validates that a message comes from a trusted source: our hosting frame
|
||||||
|
* (the normal SAS VA data-driven content case) or the same origin (local dev /
|
||||||
|
* tests). Untrusted messages — e.g. from an unrelated window or a malicious
|
||||||
|
* iframe — are rejected.
|
||||||
|
*/
|
||||||
|
private isTrustedSource(event: MessageEvent): boolean {
|
||||||
|
if (window.parent !== window && event.source === window.parent) return true
|
||||||
|
return !!event.origin && event.origin === window.location.origin
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cross-reload state. Applying a VA filter navigates to
|
||||||
|
* /editor/<table>/<FILTER_RK>, which recreates the editor component, so the
|
||||||
|
* desired filter + column visibility are held on this root singleton and
|
||||||
|
* re-applied after the reload.
|
||||||
|
*/
|
||||||
|
filterSignature: string | null = null
|
||||||
|
/** DC variable names that should be visible (the rest are hidden). */
|
||||||
|
visibleColumns: string[] | null = null
|
||||||
|
|
||||||
|
/** True once the pre-bootstrap early buffer has been drained (drain-once). */
|
||||||
|
private earlyDrained = false
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers a window `message` listener and invokes `callback` for every
|
||||||
|
* valid DDC message. The latest message itself is read via `latestMessage()`
|
||||||
|
* from the always-on `window.__vaLastMessage` buffer, not stored here.
|
||||||
|
* Returns an unsubscribe function that removes the listener.
|
||||||
|
*/
|
||||||
|
onData(callback: (msg: VaMessage) => void): () => void {
|
||||||
|
const handler = (event: MessageEvent) => {
|
||||||
|
if (!this.isTrustedSource(event)) return
|
||||||
|
const parsed = this.parseMessage(event)
|
||||||
|
if (parsed) {
|
||||||
|
this.resultName = parsed.resultName
|
||||||
|
if (event.origin) this.parentOrigin = event.origin
|
||||||
|
callback(parsed)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
window.addEventListener('message', handler, false)
|
||||||
|
// Replay any DDC message captured by the early listener before
|
||||||
|
// the app (and this listener) existed. VA pushes its message once on iframe
|
||||||
|
// load — which happens before Angular bootstraps — so without this the very
|
||||||
|
// first message is lost entirely and the editor loads unfiltered.
|
||||||
|
this.replayEarlyMessages(callback)
|
||||||
|
return () => window.removeEventListener('message', handler, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The true latest DDC message, from the always-on `window.__vaLastMessage`
|
||||||
|
* buffer (set in va-early.js). That listener is registered at page parse and
|
||||||
|
* never removed, so it has NO gaps — including the window during an editor
|
||||||
|
* reload when the app's own listener is briefly absent. So a message that
|
||||||
|
* arrives mid-reload (e.g. a rapid filter change) is still here.
|
||||||
|
*/
|
||||||
|
latestMessage(): VaMessage | null {
|
||||||
|
const captured = (window as unknown as { __vaLastMessage?: any })
|
||||||
|
.__vaLastMessage
|
||||||
|
return captured ? this.parseData(captured.data) : null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Replays the latest VA message captured by the early `window.__vaLastMessage`
|
||||||
|
* listener (set up in va-early.js), closing the pre-bootstrap race. Only runs
|
||||||
|
* when actually framed (DDC context).
|
||||||
|
*/
|
||||||
|
private replayEarlyMessages(callback: (msg: VaMessage) => void): void {
|
||||||
|
if (window.parent === window) return
|
||||||
|
// Drain only once per page lifetime. This service is a root singleton, so
|
||||||
|
// the flag persists across editor reloads — without it every reload would
|
||||||
|
// re-replay the captured message and fight the live filter (loop).
|
||||||
|
if (this.earlyDrained) return
|
||||||
|
this.earlyDrained = true
|
||||||
|
const captured = (window as unknown as { __vaLastMessage?: any })
|
||||||
|
.__vaLastMessage
|
||||||
|
const parsed = this.parseData(captured && captured.data)
|
||||||
|
if (!parsed) return
|
||||||
|
this.resultName = parsed.resultName
|
||||||
|
if (captured.origin) this.parentOrigin = captured.origin
|
||||||
|
callback(parsed)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a raw window MessageEvent into a VaMessage, or null when it is not a
|
||||||
|
* recognisable DDC message (e.g. unrelated postMessage traffic).
|
||||||
|
*/
|
||||||
|
parseMessage(event: MessageEvent): VaMessage | null {
|
||||||
|
return this.parseData(event && event.data)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a raw message payload (from a MessageEvent or the early buffer) into
|
||||||
|
* a VaMessage, or null when it is not a recognisable DDC message.
|
||||||
|
*/
|
||||||
|
private parseData(data: any): VaMessage | null {
|
||||||
|
if (!data || typeof data !== 'object') return null
|
||||||
|
if (typeof data.resultName !== 'string') return null
|
||||||
|
if (!Array.isArray(data.columns) || !Array.isArray(data.data)) return null
|
||||||
|
|
||||||
|
return {
|
||||||
|
version: data.version,
|
||||||
|
resultName: data.resultName,
|
||||||
|
rowCount: data.rowCount,
|
||||||
|
availableRowCount: data.availableRowCount,
|
||||||
|
data: data.data,
|
||||||
|
columns: data.columns,
|
||||||
|
parameters: Array.isArray(data.parameters) ? data.parameters : []
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Columns that carry grid data — excludes `usage: "brush"` columns, which
|
||||||
|
* encode linked-selection state rather than data.
|
||||||
|
*/
|
||||||
|
dataColumns(msg: VaMessage): { column: VaColumn; index: number }[] {
|
||||||
|
return msg.columns
|
||||||
|
.map((column, index) => ({ column, index }))
|
||||||
|
.filter(({ column }) => column.usage !== 'brush')
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Back-channel (DDC → VA) — selection / source-of-action. Designed per the
|
||||||
|
* SAS contract; not wired into the UI in v1.
|
||||||
|
*/
|
||||||
|
sendSelection(rows: number[]): void {
|
||||||
|
if (this.resultName === null) return
|
||||||
|
this.sendMessage({
|
||||||
|
resultName: this.resultName,
|
||||||
|
selections: rows.map((row) => ({ row }))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Back-channel (DDC → VA) — custom instructional message, shown in the report
|
||||||
|
* designer when the assigned data does not meet the visual's requirements.
|
||||||
|
*/
|
||||||
|
sendInstructionalMessage(message: string): void {
|
||||||
|
if (this.resultName === null) return
|
||||||
|
this.sendMessage({ resultName: this.resultName, message })
|
||||||
|
}
|
||||||
|
|
||||||
|
private sendMessage(message: any): void {
|
||||||
|
// Prefer the validated origin captured from the inbound VA message; only
|
||||||
|
// fall back to the referrer/own location when we have not yet received one.
|
||||||
|
const target =
|
||||||
|
this.parentOrigin ||
|
||||||
|
(window.location !== window.parent.location
|
||||||
|
? document.referrer
|
||||||
|
: document.location.href)
|
||||||
|
if (!target) return
|
||||||
|
window.parent.postMessage(message, target)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
<clr-modal
|
||||||
|
[clrModalOpen]="open"
|
||||||
|
[clrModalClosable]="false"
|
||||||
|
[clrModalStaticBackdrop]="true"
|
||||||
|
[clrModalSize]="'sm'"
|
||||||
|
>
|
||||||
|
<h3 class="modal-title">Validating cells</h3>
|
||||||
|
<div class="modal-body bulk-validation-body">
|
||||||
|
<div class="bulk-validation-row">
|
||||||
|
<clr-spinner clrSmall></clr-spinner>
|
||||||
|
<span class="bulk-validation-text">
|
||||||
|
Validating {{ done }} / {{ total }}…
|
||||||
|
</span>
|
||||||
|
</div>
|
||||||
|
<clr-progress-bar
|
||||||
|
class="bulk-validation-progress"
|
||||||
|
[clrValue]="done"
|
||||||
|
[clrMax]="total"
|
||||||
|
></clr-progress-bar>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
<button type="button" class="btn btn-outline" (click)="onCancel()">
|
||||||
|
Cancel
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</clr-modal>
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
.bulk-validation-body {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 10px;
|
||||||
|
|
||||||
|
.bulk-validation-row {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.bulk-validation-text {
|
||||||
|
flex: 1 1 auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.bulk-validation-progress {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
import { Component, EventEmitter, Input, Output } from '@angular/core'
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
selector: 'app-bulk-validation-modal',
|
||||||
|
templateUrl: './bulk-validation-modal.component.html',
|
||||||
|
styleUrls: ['./bulk-validation-modal.component.scss'],
|
||||||
|
standalone: false
|
||||||
|
})
|
||||||
|
export class BulkValidationModalComponent {
|
||||||
|
@Input() open = false
|
||||||
|
@Input() done = 0
|
||||||
|
@Input() total = 0
|
||||||
|
|
||||||
|
@Output() cancel = new EventEmitter<void>()
|
||||||
|
|
||||||
|
onCancel() {
|
||||||
|
this.cancel.emit()
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
<clr-modal
|
||||||
|
[clrModalOpen]="open"
|
||||||
|
(clrModalOpenChange)="onClrModalOpenChange($event)"
|
||||||
|
[clrModalSize]="'md'"
|
||||||
|
>
|
||||||
|
<h3 class="modal-title">{{ title }}</h3>
|
||||||
|
<div class="modal-body">
|
||||||
|
<div>{{ message }}</div>
|
||||||
|
</div>
|
||||||
|
<div class="modal-footer">
|
||||||
|
<button type="button" class="btn btn-outline" (click)="onCancel()">
|
||||||
|
{{ cancelText }}
|
||||||
|
</button>
|
||||||
|
<button type="button" class="btn btn-primary" (click)="onConfirm()">
|
||||||
|
{{ confirmText }}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</clr-modal>
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
import { Component, EventEmitter, Input, Output } from '@angular/core'
|
||||||
|
|
||||||
|
@Component({
|
||||||
|
selector: 'app-confirm-modal',
|
||||||
|
templateUrl: './confirm-modal.component.html',
|
||||||
|
standalone: false
|
||||||
|
})
|
||||||
|
export class ConfirmModalComponent {
|
||||||
|
@Input() open = false
|
||||||
|
@Input() title = 'Confirm'
|
||||||
|
@Input() message = ''
|
||||||
|
@Input() confirmText = 'Yes'
|
||||||
|
@Input() cancelText = 'No'
|
||||||
|
|
||||||
|
@Output() result = new EventEmitter<boolean>()
|
||||||
|
|
||||||
|
onConfirm() {
|
||||||
|
this.result.emit(true)
|
||||||
|
}
|
||||||
|
|
||||||
|
onCancel() {
|
||||||
|
this.result.emit(false)
|
||||||
|
}
|
||||||
|
|
||||||
|
onClrModalOpenChange(value: boolean) {
|
||||||
|
// Close triggered by X / outside / Esc — treat as cancel. Only emit
|
||||||
|
// when modal was actually open (avoid double-emit when parent closes
|
||||||
|
// us via [open]=false in response to the Yes/No button).
|
||||||
|
if (!value && this.open) this.result.emit(false)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,99 @@
|
|||||||
|
import Handsontable from 'handsontable'
|
||||||
|
import { datetimeValidator } from '../validations/hot-custom-validators'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cell types for the date/time/datetime columns after the HOT 17 migration.
|
||||||
|
*
|
||||||
|
* All three DISPLAY the raw stored ISO string verbatim — `YYYY-MM-DD`,
|
||||||
|
* `HH:mm:ss`, `YYYY-MM-DD HH:mm:ss` — via an identity `valueFormatter`, so the
|
||||||
|
* cell text is stable and locale-independent. The native picker editors still
|
||||||
|
* follow the OS regional format while open; only the painted cell is ISO.
|
||||||
|
* The stored/submitted value is unchanged.
|
||||||
|
*
|
||||||
|
* `intl-date` and `intl-time` are HOT built-ins; we re-register them by spreading
|
||||||
|
* the built-in definition (keeping its native picker editor + ISO validator) and
|
||||||
|
* swapping only the `valueFormatter` for the identity one. `intl-datetime` has no
|
||||||
|
* built-in — it pairs a native `datetime-local` picker with the identity
|
||||||
|
* formatter. valueFormatter is applied render-only (tableView), so copy/paste and
|
||||||
|
* the stored value are untouched.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/** Identity formatter — display the stored ISO string as-is (no localization). */
|
||||||
|
const isoPassthrough = (value: any): any => value
|
||||||
|
|
||||||
|
const SPACE_ISO = /^(\d{4}-\d{2}-\d{2}) (\d{2}:\d{2}(?::\d{2})?)$/
|
||||||
|
|
||||||
|
const BaseTextEditor = Handsontable.editors.getEditor('text') as any
|
||||||
|
const baseTextRenderer = Handsontable.renderers.getRenderer('text')
|
||||||
|
|
||||||
|
class IntlDatetimeEditor extends BaseTextEditor {
|
||||||
|
createElements() {
|
||||||
|
super.createElements('input')
|
||||||
|
this.TEXTAREA.setAttribute('type', 'datetime-local')
|
||||||
|
this.TEXTAREA.setAttribute('step', '1') // allow seconds
|
||||||
|
}
|
||||||
|
|
||||||
|
// Stored `YYYY-MM-DD HH:mm:ss` → native input `YYYY-MM-DDTHH:mm:ss`.
|
||||||
|
setValue(value: any) {
|
||||||
|
const match = typeof value === 'string' ? value.match(SPACE_ISO) : null
|
||||||
|
super.setValue(match ? `${match[1]}T${match[2]}` : value)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Native input `YYYY-MM-DDTHH:mm[:ss]` → stored `YYYY-MM-DD HH:mm:ss`.
|
||||||
|
getValue() {
|
||||||
|
const raw: string = super.getValue()
|
||||||
|
if (typeof raw !== 'string' || raw.indexOf('T') === -1) return raw
|
||||||
|
const [date, time] = raw.split('T')
|
||||||
|
const withSeconds = time.length === 5 ? `${time}:00` : time // pad HH:mm
|
||||||
|
return `${date} ${withSeconds}`
|
||||||
|
}
|
||||||
|
|
||||||
|
open() {
|
||||||
|
super.open()
|
||||||
|
try {
|
||||||
|
this.TEXTAREA.showPicker()
|
||||||
|
} catch {
|
||||||
|
/* showPicker requires a user gesture; ignore when called programmatically */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The base text editor's focus() calls select() + setSelectionRange to place
|
||||||
|
// the caret, but a native `datetime-local` input does not support text
|
||||||
|
// selection and throws `InvalidStateError`. Just focus the input.
|
||||||
|
focus() {
|
||||||
|
this.TEXTAREA.focus()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Re-registers a built-in HOT cell type (`intl-date` / `intl-time`) with only its
|
||||||
|
* `valueFormatter` swapped for the ISO passthrough — the native picker editor and
|
||||||
|
* ISO validator are reused from the built-in definition. Idempotent: a second
|
||||||
|
* call reads back our already-overridden type, which still carries the original
|
||||||
|
* editor/validator.
|
||||||
|
*/
|
||||||
|
const overrideWithPassthrough = (type: string) => {
|
||||||
|
const builtin = Handsontable.cellTypes.getCellType(type) as any
|
||||||
|
Handsontable.cellTypes.registerCellType(type, {
|
||||||
|
...builtin,
|
||||||
|
valueFormatter: isoPassthrough
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Registers the Intl date/time/datetime cell types. Idempotent — safe to call
|
||||||
|
* per DcValidator construction. All three display the stored ISO value verbatim.
|
||||||
|
*/
|
||||||
|
export const registerIntlCellTypes = () => {
|
||||||
|
overrideWithPassthrough('intl-date')
|
||||||
|
overrideWithPassthrough('intl-time')
|
||||||
|
|
||||||
|
Handsontable.cellTypes.registerCellType('intl-datetime', {
|
||||||
|
// IntlDatetimeEditor extends the (loosely-typed) text editor returned by
|
||||||
|
// getEditor('text'); cast to satisfy registerCellType's editor signature.
|
||||||
|
editor: IntlDatetimeEditor as any,
|
||||||
|
renderer: baseTextRenderer,
|
||||||
|
validator: datetimeValidator,
|
||||||
|
valueFormatter: isoPassthrough
|
||||||
|
} as any)
|
||||||
|
}
|
||||||
@@ -3,8 +3,8 @@ import Handsontable from 'handsontable'
|
|||||||
import { CellProperties } from 'handsontable/settings'
|
import { CellProperties } from 'handsontable/settings'
|
||||||
import {
|
import {
|
||||||
autocompleteValidator,
|
autocompleteValidator,
|
||||||
dateValidator,
|
intlDateValidator,
|
||||||
timeValidator
|
intlTimeValidator
|
||||||
} from 'handsontable/validators'
|
} from 'handsontable/validators'
|
||||||
import { $DataFormats } from 'src/app/models/sas/editors-getdata.model'
|
import { $DataFormats } from 'src/app/models/sas/editors-getdata.model'
|
||||||
import { DQData, SASParam } from '../../models/TableData'
|
import { DQData, SASParam } from '../../models/TableData'
|
||||||
@@ -17,11 +17,18 @@ import { DQRule, DQRuleTypes } from './models/dq-rules.model'
|
|||||||
import { getDqDataCols } from './utils/getDqDataCols'
|
import { getDqDataCols } from './utils/getDqDataCols'
|
||||||
import { getNotNullDefault } from './utils/getNotNullDefault'
|
import { getNotNullDefault } from './utils/getNotNullDefault'
|
||||||
import { mergeColsRules } from './utils/mergeColsRules'
|
import { mergeColsRules } from './utils/mergeColsRules'
|
||||||
import { parseColType } from './utils/parseColType'
|
import { parseColTypeRow } from './utils/parseColTypeRow'
|
||||||
|
import { DELETE_RECORD_COLUMN_RULE } from './utils/deleteRecordColumnRule'
|
||||||
import { dqValidate } from './validations/dq-validation'
|
import { dqValidate } from './validations/dq-validation'
|
||||||
import { specialMissingNumericValidator } from './validations/hot-custom-validators'
|
import {
|
||||||
|
datetimeValidator,
|
||||||
|
specialMissingNumericValidator
|
||||||
|
} from './validations/hot-custom-validators'
|
||||||
import { applyNumericFormats } from './utils/applyNumericFormats'
|
import { applyNumericFormats } from './utils/applyNumericFormats'
|
||||||
|
import { mapIntlCellTypes } from './utils/mapIntlCellTypes'
|
||||||
import { CustomAutocompleteEditor } from './editors/numericAutocomplete'
|
import { CustomAutocompleteEditor } from './editors/numericAutocomplete'
|
||||||
|
import { registerIntlCellTypes } from './cellTypes/intlCellTypes'
|
||||||
|
import { makeNumberFormatRenderer } from '../../editor/utils/renderers.utils'
|
||||||
|
|
||||||
export class DcValidator {
|
export class DcValidator {
|
||||||
private rules: DcValidation[] = []
|
private rules: DcValidation[] = []
|
||||||
@@ -44,9 +51,36 @@ export class DcValidator {
|
|||||||
|
|
||||||
this.sasparams = sasparams
|
this.sasparams = sasparams
|
||||||
this.hotInstance = hotInstance
|
this.hotInstance = hotInstance
|
||||||
this.rules = parseColType(sasparams.COLTYPE)
|
// Each cols[i].COLTYPE is a single JSON-object string (one per column, as
|
||||||
|
// of the vertical-array getdata.sas fix — issue #253), not the old
|
||||||
|
// comma-joined sasparams.COLTYPE list. DELETE_RECORD_COLUMN_RULE is
|
||||||
|
// injected separately — see its own doc comment for why.
|
||||||
|
//
|
||||||
|
// COLHEADERS is the authoritative grid order and the only safe key to
|
||||||
|
// build against: it is the variable list of the *output* dataset, where
|
||||||
|
// getdata.sas hoists the delete column and the PK to the front ("order
|
||||||
|
// delete var and pk fields at start of table"), whereas cols[].VARNUM
|
||||||
|
// describes the *source* table and cols[] itself can arrive sorted by
|
||||||
|
// NAME. Those orders diverge whenever the PK isn't already the source's
|
||||||
|
// first column, so rules are keyed by name and emitted in COLHEADERS
|
||||||
|
// order — never paired positionally against cols[] or VARNUM.
|
||||||
|
//
|
||||||
|
// A column with no parseable COLTYPE falls back to a plain text rule
|
||||||
|
// rather than being dropped: getRules() is consumed positionally against
|
||||||
|
// COLHEADERS, so a missing entry would shift every later column.
|
||||||
|
const ruleByName = new Map<string, DcValidation>([
|
||||||
|
[DELETE_RECORD_COLUMN_RULE.data, { ...DELETE_RECORD_COLUMN_RULE }]
|
||||||
|
])
|
||||||
|
for (const col of cols) {
|
||||||
|
const rule = parseColTypeRow(col.COLTYPE)
|
||||||
|
if (rule) ruleByName.set(col.NAME, rule)
|
||||||
|
}
|
||||||
|
this.rules = sasparams.COLHEADERS.split(',').map(
|
||||||
|
(name) => ruleByName.get(name) ?? { data: name }
|
||||||
|
)
|
||||||
this.rules = mergeColsRules(cols, this.rules, $dataFormats)
|
this.rules = mergeColsRules(cols, this.rules, $dataFormats)
|
||||||
this.rules = applyNumericFormats(this.rules)
|
this.rules = applyNumericFormats(this.rules)
|
||||||
|
this.rules = mapIntlCellTypes(this.rules)
|
||||||
this.dqrules = dqRules
|
this.dqrules = dqRules
|
||||||
this.dqdata = dqData
|
this.dqdata = dqData
|
||||||
this.primaryKeys = sasparams.PK.split(' ')
|
this.primaryKeys = sasparams.PK.split(' ')
|
||||||
@@ -60,6 +94,7 @@ export class DcValidator {
|
|||||||
'autocomplete.custom',
|
'autocomplete.custom',
|
||||||
CustomAutocompleteEditor
|
CustomAutocompleteEditor
|
||||||
)
|
)
|
||||||
|
registerIntlCellTypes()
|
||||||
}
|
}
|
||||||
|
|
||||||
getRules(): DcValidation[] {
|
getRules(): DcValidation[] {
|
||||||
@@ -147,6 +182,25 @@ export class DcValidator {
|
|||||||
return getNotNullDefault(col, this.dqrules, colRule?.type)
|
return getNotNullDefault(col, this.dqrules, colRule?.type)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the num_digits for a ROUND rule on the given column, used to
|
||||||
|
* round edited/pasted values Excel-style. Returns undefined if no ROUND
|
||||||
|
* rule exists or its RULE_VALUE is not an integer.
|
||||||
|
*
|
||||||
|
* @param col column name
|
||||||
|
*/
|
||||||
|
getRoundDigits(col: string): number | undefined {
|
||||||
|
const roundRule = this.dqrules.find(
|
||||||
|
(rule: DQRule) => rule.BASE_COL === col && rule.RULE_TYPE === 'ROUND'
|
||||||
|
)
|
||||||
|
|
||||||
|
if (!roundRule) return undefined
|
||||||
|
|
||||||
|
const digits = parseInt(roundRule.RULE_VALUE, 10)
|
||||||
|
|
||||||
|
return isNaN(digits) ? undefined : digits
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves dropdown source for given dc validation rule
|
* Retrieves dropdown source for given dc validation rule
|
||||||
* The values comes from MPE_SELECTBOX table
|
* The values comes from MPE_SELECTBOX table
|
||||||
@@ -238,7 +292,6 @@ export class DcValidator {
|
|||||||
const cellProperties: CellProperties = {
|
const cellProperties: CellProperties = {
|
||||||
...columnRules,
|
...columnRules,
|
||||||
validator: undefined,
|
validator: undefined,
|
||||||
correctFormat: false,
|
|
||||||
row: 0,
|
row: 0,
|
||||||
col: 0,
|
col: 0,
|
||||||
instance: new Handsontable(document.createElement('div'), {}),
|
instance: new Handsontable(document.createElement('div'), {}),
|
||||||
@@ -317,11 +370,31 @@ export class DcValidator {
|
|||||||
if (this.hasDqRules(ruleColName, ['NOTNULL'])) {
|
if (this.hasDqRules(ruleColName, ['NOTNULL'])) {
|
||||||
this.rules[i].allowEmpty = false
|
this.rules[i].allowEmpty = false
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// Correct format comes as STRING from SAS. That could be also fixed on SAS side.
|
// READONLY: render column read-only (default value handled via getColumnDefault on add row)
|
||||||
if ((this.rules[i].correctFormat as any) === 'true') {
|
if (this.hasDqRules(ruleColName, ['READONLY'])) {
|
||||||
this.rules[i].correctFormat = true
|
this.rules[i].readOnly = true
|
||||||
|
}
|
||||||
|
|
||||||
|
// HIDDEN: hide column in HOT but keep its data (still submitted via hot.getData())
|
||||||
|
if (this.hasDqRules(ruleColName, ['HIDDEN'])) {
|
||||||
|
this.hiddenColumns.push(i)
|
||||||
|
}
|
||||||
|
|
||||||
|
// NUMBER_FORMAT: display-only Intl.NumberFormat renderer.
|
||||||
|
// Set last so it overrides a dropdown's 'autocomplete' renderer (last-wins).
|
||||||
|
if (this.hasDqRules(ruleColName, ['NUMBER_FORMAT'])) {
|
||||||
|
const fmtRule = this.getDqDetails(ruleColName).find(
|
||||||
|
(rule: DQRule) => rule.RULE_TYPE === 'NUMBER_FORMAT'
|
||||||
|
)
|
||||||
|
this.rules[i].renderer = makeNumberFormatRenderer(fmtRule?.RULE_VALUE)
|
||||||
|
// Clear numericFormat (set by applyNumericFormats on every numeric
|
||||||
|
// column). On a numeric cell HOT's built-in numeric renderer would
|
||||||
|
// re-format via numericFormat, overriding our custom NUMBER_FORMAT
|
||||||
|
// Intl renderer and dropping the currency symbol. The numeric
|
||||||
|
// editor/validator stay intact via `type`.
|
||||||
|
this.rules[i].numericFormat = undefined
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
const self = this
|
const self = this
|
||||||
@@ -463,10 +536,12 @@ export class DcValidator {
|
|||||||
return autocompleteValidator
|
return autocompleteValidator
|
||||||
case 'numeric':
|
case 'numeric':
|
||||||
return specialMissingNumericValidator
|
return specialMissingNumericValidator
|
||||||
case 'date':
|
case 'intl-date':
|
||||||
return dateValidator
|
return intlDateValidator
|
||||||
case 'time':
|
case 'intl-time':
|
||||||
return timeValidator
|
return intlTimeValidator
|
||||||
|
case 'intl-datetime':
|
||||||
|
return datetimeValidator
|
||||||
default:
|
default:
|
||||||
return (value: any, callback: any) => (callback ? callback(true) : null)
|
return (value: any, callback: any) => (callback ? callback(true) : null)
|
||||||
}
|
}
|
||||||
@@ -492,8 +567,11 @@ export class DcValidator {
|
|||||||
|
|
||||||
if (rule.clsRule === 'EDIT') {
|
if (rule.clsRule === 'EDIT') {
|
||||||
rule.readOnly = false
|
rule.readOnly = false
|
||||||
|
// Guard the -1: splice(-1, 1) drops the LAST hidden column rather than
|
||||||
|
// no-op'ing, so an EDIT column that was never hidden would un-hide an
|
||||||
|
// unrelated one (e.g. a column hidden by a HIDDEN DQ rule).
|
||||||
const hiddenIndex = this.hiddenColumns.indexOf(index)
|
const hiddenIndex = this.hiddenColumns.indexOf(index)
|
||||||
this.hiddenColumns.splice(hiddenIndex, 1)
|
if (hiddenIndex !== -1) this.hiddenColumns.splice(hiddenIndex, 1)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
import Handsontable from 'handsontable'
|
import Handsontable from 'handsontable'
|
||||||
import Core from 'handsontable/core'
|
|
||||||
|
|
||||||
export class CustomAutocompleteEditor
|
export class CustomAutocompleteEditor
|
||||||
extends Handsontable.editors.AutocompleteEditor
|
extends Handsontable.editors.AutocompleteEditor
|
||||||
{
|
{
|
||||||
constructor(instance: Core) {
|
constructor(instance: Handsontable.Core) {
|
||||||
super(instance)
|
super(instance)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -13,8 +12,9 @@ export class CustomAutocompleteEditor
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Listbox open
|
// Listbox open
|
||||||
open(event?: Event | undefined): void {
|
// HOT 18's AutocompleteEditor.open() takes no arguments (was `event?: Event`).
|
||||||
super.open(event)
|
open(): void {
|
||||||
|
super.open()
|
||||||
|
|
||||||
if (this.isCellNumeric()) {
|
if (this.isCellNumeric()) {
|
||||||
this.htContainer.classList.add('numericListbox')
|
this.htContainer.classList.add('numericListbox')
|
||||||
|
|||||||
@@ -9,4 +9,8 @@ export interface Col {
|
|||||||
MEMLABEL: string
|
MEMLABEL: string
|
||||||
DESC: string
|
DESC: string
|
||||||
LONGDESC: string
|
LONGDESC: string
|
||||||
|
// Handsontable column-formatting spec (JSON-object string), one per column
|
||||||
|
// — see parseColTypeRow.ts. Optional: getdata.sas LEFT JOINs this in, so
|
||||||
|
// an unmatched row can leave it unset.
|
||||||
|
COLTYPE?: string
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,3 +14,7 @@ export type DQRuleTypes =
|
|||||||
| 'CASE'
|
| 'CASE'
|
||||||
| 'MINVAL'
|
| 'MINVAL'
|
||||||
| 'MAXVAL'
|
| 'MAXVAL'
|
||||||
|
| 'READONLY'
|
||||||
|
| 'HIDDEN'
|
||||||
|
| 'ROUND'
|
||||||
|
| 'NUMBER_FORMAT'
|
||||||
|
|||||||
@@ -23,21 +23,33 @@ describe('DC Validator', () => {
|
|||||||
// Check if COLS merged with FORMATS
|
// Check if COLS merged with FORMATS
|
||||||
expect(cols[0].TYPE).toEqual('char')
|
expect(cols[0].TYPE).toEqual('char')
|
||||||
|
|
||||||
// Get all
|
// Get all — one rule per cols[] entry, plus the injected
|
||||||
|
// DELETE_RECORD_COLUMN_RULE (never present in cols[], see its own
|
||||||
|
// doc comment)
|
||||||
const validationRules = dcValidator.getRules()
|
const validationRules = dcValidator.getRules()
|
||||||
expect(validationRules).toHaveSize(
|
expect(validationRules).toHaveSize(example_cols.length + 1)
|
||||||
JSON.parse(`[${example_COLTYPE}]`).length
|
|
||||||
)
|
|
||||||
|
|
||||||
// Get col with notnull validation
|
// Get col with notnull validation
|
||||||
const someNumRule = dcValidator.getRule('SOME_NUM')
|
const someNumRule = dcValidator.getRule('SOME_NUM')
|
||||||
// Check allowEmpty - it is notnull rule so allowEmpty should be false
|
// Check allowEmpty - it is notnull rule so allowEmpty should be false
|
||||||
expect(someNumRule?.allowEmpty).toBeFalse()
|
expect(someNumRule?.allowEmpty).toBeFalse()
|
||||||
|
|
||||||
// Get col with notnull validation
|
// SAS sends semantic date/time/datetime column types; the frontend maps them
|
||||||
|
// to the HOT 17 Intl cell-type names (see mapIntlCellTypes). The cell display
|
||||||
|
// is the raw stored ISO string (no locale/format meta) — see
|
||||||
|
// registerIntlCellTypes. The deprecated correctFormat + moment format strings
|
||||||
|
// are no longer sent in the payload.
|
||||||
const someDateRule = dcValidator.getRule('SOME_DATE')
|
const someDateRule = dcValidator.getRule('SOME_DATE')
|
||||||
// Check correctFormat - it comes from SAS - should be true
|
expect(someDateRule?.correctFormat).toBeUndefined()
|
||||||
expect(someDateRule?.correctFormat).toBeTrue()
|
expect(someDateRule?.type).toBe('intl-date')
|
||||||
|
|
||||||
|
const someDatetimeRule = dcValidator.getRule('SOME_DATETIME')
|
||||||
|
expect(someDatetimeRule?.type).toBe('intl-datetime')
|
||||||
|
expect(someDatetimeRule?.correctFormat).toBeUndefined()
|
||||||
|
|
||||||
|
const someTimeRule = dcValidator.getRule('SOME_TIME')
|
||||||
|
expect(someTimeRule?.type).toBe('intl-time')
|
||||||
|
expect(someTimeRule?.correctFormat).toBeUndefined()
|
||||||
|
|
||||||
// Get col with dropdown, check if merging sas data is correct
|
// Get col with dropdown, check if merging sas data is correct
|
||||||
const someDropdownRule = dcValidator.getRule('SOME_DROPDOWN')
|
const someDropdownRule = dcValidator.getRule('SOME_DROPDOWN')
|
||||||
@@ -54,6 +66,15 @@ describe('DC Validator', () => {
|
|||||||
const someDropdownHardRule = dcValidator.getRule('SOME_DROPDOWN_HARD')
|
const someDropdownHardRule = dcValidator.getRule('SOME_DROPDOWN_HARD')
|
||||||
// Check strict - it is hardselect so strict should be true
|
// Check strict - it is hardselect so strict should be true
|
||||||
expect(someDropdownHardRule?.strict).toBeTrue()
|
expect(someDropdownHardRule?.strict).toBeTrue()
|
||||||
|
|
||||||
|
// _____DELETE__THIS__RECORD_____ never has a cols[] entry (%mp_getcols
|
||||||
|
// doesn't know about it — see DELETE_RECORD_COLUMN_RULE), but its rule
|
||||||
|
// must still exist with its fixed dropdown shape, independent of cols
|
||||||
|
const deleteRecordRule = dcValidator.getRule(
|
||||||
|
'_____DELETE__THIS__RECORD_____'
|
||||||
|
)
|
||||||
|
expect(deleteRecordRule?.type).toEqual('dropdown')
|
||||||
|
expect(deleteRecordRule?.source).toEqual(['No', 'Yes'])
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should create an instance of validator and execute its functions', () => {
|
it('should create an instance of validator and execute its functions', () => {
|
||||||
@@ -235,8 +256,182 @@ describe('DC Validator', () => {
|
|||||||
}
|
}
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should apply READONLY, HIDDEN, NUMBER_FORMAT and ROUND rules', () => {
|
||||||
|
const dcValidator: DcValidator = new DcValidator(
|
||||||
|
example_sasparams,
|
||||||
|
example_dataformats,
|
||||||
|
example_cols,
|
||||||
|
example_dqRules,
|
||||||
|
example_dqData
|
||||||
|
)
|
||||||
|
|
||||||
|
// READONLY -> column rendered read-only
|
||||||
|
expect(dcValidator.getRule('SOME_BESTNUM')?.readOnly).toBeTrue()
|
||||||
|
|
||||||
|
// NUMBER_FORMAT -> a function renderer is assigned and numbro numericFormat
|
||||||
|
// is cleared so it can't override the Intl currency/percent rendering
|
||||||
|
expect(typeof dcValidator.getRule('SOME_BESTNUM')?.renderer).toEqual(
|
||||||
|
'function'
|
||||||
|
)
|
||||||
|
expect(dcValidator.getRule('SOME_BESTNUM')?.numericFormat).toBeUndefined()
|
||||||
|
|
||||||
|
// HIDDEN -> column index added to hidden columns
|
||||||
|
const rules = dcValidator.getRules()
|
||||||
|
const hiddenIndex = rules.findIndex(
|
||||||
|
(rule) => rule.data === 'PRIMARY_KEY_FIELD'
|
||||||
|
)
|
||||||
|
expect(dcValidator.getHiddenColumns()).toContain(hiddenIndex)
|
||||||
|
|
||||||
|
// ROUND -> num_digits returned for the column, undefined otherwise
|
||||||
|
expect(dcValidator.getRoundDigits('SOME_SHORTNUM')).toEqual(2)
|
||||||
|
expect(dcValidator.getRoundDigits('SOME_NUM')).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('5 | orders rules by COLHEADERS when cols[] arrives in a different order', () => {
|
||||||
|
// %mp_getcols/cols1 can serialize cols[] alphabetically by NAME rather
|
||||||
|
// than in COLHEADERS order (confirmed against a real getdata.sas
|
||||||
|
// response). getRules() is consumed positionally against headerColumns,
|
||||||
|
// so rule order must follow COLHEADERS regardless of cols[]'s own order.
|
||||||
|
const alphabeticalCols = [...example_cols].sort((a, b) =>
|
||||||
|
a.NAME.localeCompare(b.NAME)
|
||||||
|
)
|
||||||
|
|
||||||
|
const dcValidator: DcValidator = new DcValidator(
|
||||||
|
example_sasparams,
|
||||||
|
example_dataformats,
|
||||||
|
alphabeticalCols,
|
||||||
|
example_dqRules,
|
||||||
|
example_dqData
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(dcValidator.getRules().map((rule) => rule.data)).toEqual(
|
||||||
|
example_sasparams.COLHEADERS.split(',')
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it("6 | keeps rules aligned with COLHEADERS when the PK is not the source table's first column", () => {
|
||||||
|
// Regression test for the real-world misalignment: getdata.sas hoists the
|
||||||
|
// delete column and PK to the front of the *output* dataset ("order
|
||||||
|
// delete var and pk fields at start of table"), so COLHEADERS order and
|
||||||
|
// cols[].VARNUM order (which describes the *source* table) diverge
|
||||||
|
// whenever the PK isn't already the source's first column. Worst case (as
|
||||||
|
// seen in the wild): the PK is the source's LAST column, so pairing rules
|
||||||
|
// to headers by VARNUM shifts every single column by one.
|
||||||
|
const cols: Col[] = [
|
||||||
|
// deliberately alphabetical, as the backend serializes it
|
||||||
|
makeCol('PRIMARY_KEY_FIELD', 6), // the PK — last in the source table
|
||||||
|
makeCol('SOME_CHAR', 1),
|
||||||
|
makeCol('SOME_DATE', 2),
|
||||||
|
makeCol('SOME_DROPDOWN', 3),
|
||||||
|
makeCol('SOME_NUM', 4),
|
||||||
|
makeCol('SOME_TIME', 5)
|
||||||
|
]
|
||||||
|
const sasparams: SASParam = {
|
||||||
|
...example_sasparams,
|
||||||
|
// PK hoisted to the front by getdata.sas, ahead of VARNUM 1..5
|
||||||
|
COLHEADERS:
|
||||||
|
'_____DELETE__THIS__RECORD_____,PRIMARY_KEY_FIELD,SOME_CHAR,' +
|
||||||
|
'SOME_DATE,SOME_DROPDOWN,SOME_NUM,SOME_TIME',
|
||||||
|
PK: 'PRIMARY_KEY_FIELD'
|
||||||
|
} as SASParam
|
||||||
|
|
||||||
|
const dcValidator: DcValidator = new DcValidator(
|
||||||
|
sasparams,
|
||||||
|
{ vars: {} } as $DataFormats,
|
||||||
|
cols,
|
||||||
|
[],
|
||||||
|
[]
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(dcValidator.getRules().map((rule) => rule.data)).toEqual(
|
||||||
|
sasparams.COLHEADERS.split(',')
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('7 | falls back to a text rule rather than dropping a column with an unparseable COLTYPE', () => {
|
||||||
|
// A dropped rule would shorten getRules() and shift every later column
|
||||||
|
// against headerColumns. getdata.sas LEFT JOINs COLTYPE in, so an
|
||||||
|
// unmatched row can legitimately leave it unset.
|
||||||
|
const cols: Col[] = [
|
||||||
|
makeCol('PRIMARY_KEY_FIELD', 1),
|
||||||
|
{ ...makeCol('SOME_CHAR', 2), COLTYPE: undefined },
|
||||||
|
{ ...makeCol('SOME_NUM', 3), COLTYPE: 'not valid json' }
|
||||||
|
]
|
||||||
|
const sasparams: SASParam = {
|
||||||
|
...example_sasparams,
|
||||||
|
COLHEADERS:
|
||||||
|
'_____DELETE__THIS__RECORD_____,PRIMARY_KEY_FIELD,SOME_CHAR,SOME_NUM',
|
||||||
|
PK: 'PRIMARY_KEY_FIELD'
|
||||||
|
} as SASParam
|
||||||
|
|
||||||
|
const dcValidator: DcValidator = new DcValidator(
|
||||||
|
sasparams,
|
||||||
|
{ vars: {} } as $DataFormats,
|
||||||
|
cols,
|
||||||
|
[],
|
||||||
|
[]
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(dcValidator.getRules().map((rule) => rule.data)).toEqual(
|
||||||
|
sasparams.COLHEADERS.split(',')
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('8 | does not un-hide an unrelated column when a CLS EDIT column was never hidden', () => {
|
||||||
|
// hiddenColumns.indexOf() returns -1 for a column that isn't hidden, and
|
||||||
|
// splice(-1, 1) drops the LAST element instead of no-op'ing — so an EDIT
|
||||||
|
// column used to silently un-hide a column hidden by a HIDDEN DQ rule.
|
||||||
|
//
|
||||||
|
// The EDIT column must not be the PK: setColumnLevelSecurity forces PK
|
||||||
|
// columns to clsRule 'READ' before the EDIT branch is reached, which would
|
||||||
|
// skip the splice entirely and leave this test passing against the bug.
|
||||||
|
const cols: Col[] = [
|
||||||
|
{ ...makeCol('PK_COL', 1), CLS_RULE: 'READ' },
|
||||||
|
{ ...makeCol('SECRET_COL', 2), CLS_RULE: 'READ' },
|
||||||
|
{ ...makeCol('OPEN_COL', 3), CLS_RULE: 'EDIT' }
|
||||||
|
]
|
||||||
|
const sasparams: SASParam = {
|
||||||
|
...example_sasparams,
|
||||||
|
CLS_FLAG: 1,
|
||||||
|
COLHEADERS: '_____DELETE__THIS__RECORD_____,PK_COL,SECRET_COL,OPEN_COL',
|
||||||
|
PK: 'PK_COL'
|
||||||
|
} as SASParam
|
||||||
|
const dqRules: DQRule[] = [
|
||||||
|
{ BASE_COL: 'SECRET_COL', RULE_TYPE: 'HIDDEN', RULE_VALUE: '', X: 0 }
|
||||||
|
]
|
||||||
|
|
||||||
|
const dcValidator: DcValidator = new DcValidator(
|
||||||
|
sasparams,
|
||||||
|
{ vars: {} } as $DataFormats,
|
||||||
|
cols,
|
||||||
|
dqRules,
|
||||||
|
[]
|
||||||
|
)
|
||||||
|
|
||||||
|
// SECRET_COL is rules[2]; CLS_FLAG also hides the delete column (index 0).
|
||||||
|
// OPEN_COL (rules[3]) is EDIT and was never hidden, so the splice guard is
|
||||||
|
// what keeps SECRET_COL hidden here.
|
||||||
|
expect(dcValidator.getHiddenColumns()).toContain(2)
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
/** Minimal cols[] entry — only the fields rule ordering depends on. */
|
||||||
|
const makeCol = (name: string, varnum: number): Col =>
|
||||||
|
({
|
||||||
|
NAME: name,
|
||||||
|
VARNUM: varnum,
|
||||||
|
LABEL: name,
|
||||||
|
FMTNAME: '',
|
||||||
|
DDTYPE: 'CHARACTER',
|
||||||
|
TYPE: '',
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
MEMLABEL: '',
|
||||||
|
DESC: '',
|
||||||
|
LONGDESC: '',
|
||||||
|
COLTYPE: `{"data":"${name}"}`
|
||||||
|
}) as Col
|
||||||
|
|
||||||
const example_dqData = [
|
const example_dqData = [
|
||||||
{
|
{
|
||||||
BASE_COL: 'SOME_DROPDOWN',
|
BASE_COL: 'SOME_DROPDOWN',
|
||||||
@@ -313,9 +508,40 @@ const example_dqRules: any = [
|
|||||||
RULE_TYPE: 'CASE',
|
RULE_TYPE: 'CASE',
|
||||||
RULE_VALUE: 'LOWCASE',
|
RULE_VALUE: 'LOWCASE',
|
||||||
X: 0
|
X: 0
|
||||||
|
},
|
||||||
|
{
|
||||||
|
BASE_COL: 'SOME_BESTNUM',
|
||||||
|
RULE_TYPE: 'READONLY',
|
||||||
|
RULE_VALUE: '7',
|
||||||
|
X: 0
|
||||||
|
},
|
||||||
|
{
|
||||||
|
BASE_COL: 'SOME_BESTNUM',
|
||||||
|
RULE_TYPE: 'NUMBER_FORMAT',
|
||||||
|
RULE_VALUE: '{"minimumFractionDigits":2}',
|
||||||
|
X: 0
|
||||||
|
},
|
||||||
|
{
|
||||||
|
BASE_COL: 'PRIMARY_KEY_FIELD',
|
||||||
|
RULE_TYPE: 'HIDDEN',
|
||||||
|
RULE_VALUE: '99',
|
||||||
|
X: 0
|
||||||
|
},
|
||||||
|
{
|
||||||
|
BASE_COL: 'SOME_SHORTNUM',
|
||||||
|
RULE_TYPE: 'ROUND',
|
||||||
|
RULE_VALUE: '2',
|
||||||
|
X: 0
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
||||||
|
// One row per column, each carrying its own COLTYPE JSON-object string — the
|
||||||
|
// vertical-array shape from issue #253's getdata.sas fix. Order: SOME_DROPDOWN
|
||||||
|
// then SOME_NUM first (the `cols[0].TYPE` assertion above is positional),
|
||||||
|
// remaining columns in the same order the old concatenated
|
||||||
|
// sasparams.COLTYPE used to list them. _____DELETE__THIS__RECORD_____ is
|
||||||
|
// deliberately absent — DcValidator injects its rule directly (see
|
||||||
|
// DELETE_RECORD_COLUMN_RULE), since %mp_getcols never has a row for it.
|
||||||
const example_cols = [
|
const example_cols = [
|
||||||
{
|
{
|
||||||
CLS_RULE: 'READ',
|
CLS_RULE: 'READ',
|
||||||
@@ -327,7 +553,8 @@ const example_cols = [
|
|||||||
LONGDESC: '',
|
LONGDESC: '',
|
||||||
MEMLABEL: '',
|
MEMLABEL: '',
|
||||||
NAME: 'SOME_DROPDOWN',
|
NAME: 'SOME_DROPDOWN',
|
||||||
VARNUM: 3
|
VARNUM: 3,
|
||||||
|
COLTYPE: '{"data":"SOME_DROPDOWN"}'
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
CLS_RULE: 'READ',
|
CLS_RULE: 'READ',
|
||||||
@@ -339,83 +566,157 @@ const example_cols = [
|
|||||||
LONGDESC: '',
|
LONGDESC: '',
|
||||||
MEMLABEL: '',
|
MEMLABEL: '',
|
||||||
NAME: 'SOME_NUM',
|
NAME: 'SOME_NUM',
|
||||||
VARNUM: 4
|
VARNUM: 4,
|
||||||
|
COLTYPE: '{"data":"SOME_NUM","type":"numeric","format":"0"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'NUMERIC',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'PRIMARY_KEY_FIELD',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'PRIMARY_KEY_FIELD',
|
||||||
|
VARNUM: 1,
|
||||||
|
COLTYPE: '{"data":"PRIMARY_KEY_FIELD","type":"numeric","format":"0"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'CHARACTER',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_CHAR',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_CHAR',
|
||||||
|
VARNUM: 2,
|
||||||
|
COLTYPE: '{"data":"SOME_CHAR"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'CHARACTER',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_CHAR_LOW',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_CHAR_LOW',
|
||||||
|
VARNUM: 5,
|
||||||
|
COLTYPE: '{"data":"SOME_CHAR_LOW"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'CHARACTER',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_CHAR_ANY',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_CHAR_ANY',
|
||||||
|
VARNUM: 6,
|
||||||
|
COLTYPE: '{"data":"SOME_CHAR_ANY"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'CHARACTER',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_DROPDOWN_HARD',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_DROPDOWN_HARD',
|
||||||
|
VARNUM: 7,
|
||||||
|
COLTYPE: '{"data":"SOME_DROPDOWN_HARD"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'DATE',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_DATE',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_DATE',
|
||||||
|
VARNUM: 8,
|
||||||
|
COLTYPE: '{"data":"SOME_DATE","type":"date"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'DATETIME',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_DATETIME',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_DATETIME',
|
||||||
|
VARNUM: 9,
|
||||||
|
COLTYPE: '{"data":"SOME_DATETIME","type":"datetime"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'TIME',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_TIME',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_TIME',
|
||||||
|
VARNUM: 10,
|
||||||
|
COLTYPE: '{"data":"SOME_TIME","type":"time"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'NUMERIC',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_SHORTNUM',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_SHORTNUM',
|
||||||
|
VARNUM: 11,
|
||||||
|
COLTYPE: '{"data":"SOME_SHORTNUM","type":"numeric","format":"0"}'
|
||||||
|
},
|
||||||
|
{
|
||||||
|
CLS_RULE: 'READ',
|
||||||
|
DDTYPE: 'NUMERIC',
|
||||||
|
DESC: '',
|
||||||
|
TYPE: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
LABEL: 'SOME_BESTNUM',
|
||||||
|
LONGDESC: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
NAME: 'SOME_BESTNUM',
|
||||||
|
VARNUM: 12,
|
||||||
|
COLTYPE: '{"data":"SOME_BESTNUM","type":"numeric","format":"0"}'
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
||||||
const example_COLTYPE = `
|
// COLHEADERS mirrors a real getdata.sas response: the *output* dataset's
|
||||||
{
|
// variable list, i.e. the delete column and PK hoisted to the front, then the
|
||||||
"data":"_____DELETE__THIS__RECORD_____",
|
// remaining source columns in VARNUM order. It drives rule order, so it must
|
||||||
"type":"dropdown",
|
// list every example_cols entry.
|
||||||
"source":[
|
|
||||||
"No",
|
|
||||||
"Yes"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"PRIMARY_KEY_FIELD",
|
|
||||||
"type":"numeric",
|
|
||||||
"format":"0"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_CHAR"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_CHAR_LOW"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_CHAR_ANY"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_DROPDOWN"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_DROPDOWN_HARD"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_NUM",
|
|
||||||
"type":"numeric",
|
|
||||||
"format":"0"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_DATE",
|
|
||||||
"type":"date",
|
|
||||||
"dateFormat":"YYYY-MM-DD",
|
|
||||||
"correctFormat":"true"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_DATETIME",
|
|
||||||
"type":"date",
|
|
||||||
"dateFormat":"YYYY-MM-DD HH:mm:ss.SSS",
|
|
||||||
"correctFormat":"true"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_TIME",
|
|
||||||
"type":"time",
|
|
||||||
"timeFormat":"HH:mm:ss.SSS",
|
|
||||||
"correctFormat":"true"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_SHORTNUM",
|
|
||||||
"type":"numeric",
|
|
||||||
"format":"0"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"data":"SOME_BESTNUM",
|
|
||||||
"type":"numeric",
|
|
||||||
"format":"0"
|
|
||||||
}`
|
|
||||||
|
|
||||||
const example_sasparams = {
|
const example_sasparams = {
|
||||||
CLS_FLAG: 0,
|
CLS_FLAG: 0,
|
||||||
COLHEADERS: 'head1 head2',
|
COLHEADERS:
|
||||||
COLTYPE: example_COLTYPE,
|
'_____DELETE__THIS__RECORD_____,PRIMARY_KEY_FIELD,SOME_CHAR,SOME_DROPDOWN,' +
|
||||||
|
'SOME_NUM,SOME_CHAR_LOW,SOME_CHAR_ANY,SOME_DROPDOWN_HARD,SOME_DATE,' +
|
||||||
|
'SOME_DATETIME,SOME_TIME,SOME_SHORTNUM,SOME_BESTNUM',
|
||||||
DTTMVARS: 'dttm vars',
|
DTTMVARS: 'dttm vars',
|
||||||
DTVARS: 'dt vars',
|
DTVARS: 'dt vars',
|
||||||
FILTER_TEXT: 'filter text',
|
FILTER_TEXT: 'filter text',
|
||||||
LOADTYPE: 'load type',
|
LOADTYPE: 'load type',
|
||||||
PK: 'primary key',
|
PK: 'PRIMARY_KEY_FIELD',
|
||||||
PKCNT: 0,
|
PKCNT: 1,
|
||||||
RK_FLAG: 0,
|
RK_FLAG: 0,
|
||||||
TMVARS: 'string'
|
TMVARS: 'string'
|
||||||
}
|
}
|
||||||
@@ -446,6 +747,24 @@ const example_dataformats = {
|
|||||||
length: '128',
|
length: '128',
|
||||||
type: 'char'
|
type: 'char'
|
||||||
},
|
},
|
||||||
|
SOME_CHAR_LOW: {
|
||||||
|
format: '$128.',
|
||||||
|
label: 'SOME_CHAR_LOW',
|
||||||
|
length: '128',
|
||||||
|
type: 'char'
|
||||||
|
},
|
||||||
|
SOME_CHAR_ANY: {
|
||||||
|
format: '$128.',
|
||||||
|
label: 'SOME_CHAR_ANY',
|
||||||
|
length: '128',
|
||||||
|
type: 'char'
|
||||||
|
},
|
||||||
|
SOME_DROPDOWN_HARD: {
|
||||||
|
format: '$128.',
|
||||||
|
label: 'SOME_DROPDOWN_HARD',
|
||||||
|
length: '128',
|
||||||
|
type: 'char'
|
||||||
|
},
|
||||||
SOME_NUM: {
|
SOME_NUM: {
|
||||||
format: 'best.',
|
format: 'best.',
|
||||||
label: 'SOME_NUM',
|
label: 'SOME_NUM',
|
||||||
|
|||||||
@@ -0,0 +1,39 @@
|
|||||||
|
import { excelRound } from '../utils/excelRound'
|
||||||
|
|
||||||
|
describe('DC Validator - excelRound', () => {
|
||||||
|
it('should round to the given number of decimal places', () => {
|
||||||
|
expect(excelRound(1.23456, 2)).toEqual(1.23)
|
||||||
|
expect(excelRound(1.236, 2)).toEqual(1.24)
|
||||||
|
expect(excelRound(2.5, 0)).toEqual(3)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should round half away from zero for negative values', () => {
|
||||||
|
expect(excelRound(-0.5, 0)).toEqual(-1)
|
||||||
|
expect(excelRound(-2.5, 0)).toEqual(-3)
|
||||||
|
expect(excelRound(-1.23456, 2)).toEqual(-1.23)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should support negative digits (round to tens/hundreds)', () => {
|
||||||
|
expect(excelRound(25, -1)).toEqual(30)
|
||||||
|
expect(excelRound(24, -1)).toEqual(20)
|
||||||
|
expect(excelRound(150, -2)).toEqual(200)
|
||||||
|
})
|
||||||
|
|
||||||
|
// Examples from Microsoft's ROUND documentation:
|
||||||
|
// https://support.microsoft.com/en-us/office/round-function-c018c5d8-40fb-4053-90b1-b3e7f61a213c
|
||||||
|
it('should match the Microsoft ROUND examples', () => {
|
||||||
|
expect(excelRound(2.15, 1)).toEqual(2.2)
|
||||||
|
expect(excelRound(2.149, 1)).toEqual(2.1)
|
||||||
|
expect(excelRound(-1.475, 2)).toEqual(-1.48)
|
||||||
|
expect(excelRound(21.5, -1)).toEqual(20)
|
||||||
|
expect(excelRound(626.3, -3)).toEqual(1000)
|
||||||
|
expect(excelRound(1.98, -1)).toEqual(0)
|
||||||
|
expect(excelRound(-50.55, -2)).toEqual(-100)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return the original value when not finite', () => {
|
||||||
|
expect(excelRound(NaN, 2)).toBeNaN()
|
||||||
|
expect(excelRound(Infinity, 2)).toEqual(Infinity)
|
||||||
|
expect(excelRound(5, NaN)).toEqual(5)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
import { DQRule } from '../models/dq-rules.model'
|
||||||
|
import { getColumnDefault } from '../utils/getColumnDefault'
|
||||||
|
|
||||||
|
describe('DC Validator - getColumnDefault', () => {
|
||||||
|
const dqRules: DQRule[] = [
|
||||||
|
{ BASE_COL: 'NOTNULL_COL', RULE_TYPE: 'NOTNULL', RULE_VALUE: 'nn', X: 1 },
|
||||||
|
{ BASE_COL: 'READONLY_COL', RULE_TYPE: 'READONLY', RULE_VALUE: 'ro', X: 1 },
|
||||||
|
{ BASE_COL: 'HIDDEN_COL', RULE_TYPE: 'HIDDEN', RULE_VALUE: 'hd', X: 1 },
|
||||||
|
{ BASE_COL: 'NUM_COL', RULE_TYPE: 'READONLY', RULE_VALUE: '42', X: 1 },
|
||||||
|
{ BASE_COL: 'EMPTY_COL', RULE_TYPE: 'HIDDEN', RULE_VALUE: ' ', X: 1 },
|
||||||
|
{ BASE_COL: 'OTHER_COL', RULE_TYPE: 'HARDSELECT', RULE_VALUE: 'x', X: 1 }
|
||||||
|
]
|
||||||
|
|
||||||
|
it('should return defaults for NOTNULL, READONLY and HIDDEN rules', () => {
|
||||||
|
expect(getColumnDefault('NOTNULL_COL', dqRules, 'text')).toEqual('nn')
|
||||||
|
expect(getColumnDefault('READONLY_COL', dqRules, 'text')).toEqual('ro')
|
||||||
|
expect(getColumnDefault('HIDDEN_COL', dqRules, 'text')).toEqual('hd')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should coerce to number for numeric columns', () => {
|
||||||
|
expect(getColumnDefault('NUM_COL', dqRules, 'numeric')).toEqual(42)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return string for numeric columns when value is non-numeric', () => {
|
||||||
|
expect(getColumnDefault('READONLY_COL', dqRules, 'numeric')).toEqual('ro')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should ignore empty RULE_VALUE', () => {
|
||||||
|
expect(getColumnDefault('EMPTY_COL', dqRules, 'text')).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return undefined for rules that do not provide defaults', () => {
|
||||||
|
expect(getColumnDefault('OTHER_COL', dqRules, 'text')).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should return undefined for non-existent columns and empty rules', () => {
|
||||||
|
expect(getColumnDefault('MISSING', dqRules, 'text')).toBeUndefined()
|
||||||
|
expect(getColumnDefault('NOTNULL_COL', [], 'text')).toBeUndefined()
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -1,23 +0,0 @@
|
|||||||
import { HotColumnSettings } from '../models/dc-validation.model'
|
|
||||||
import { parseColType } from '../utils/parseColType'
|
|
||||||
|
|
||||||
describe('DC Validator - parse col type', () => {
|
|
||||||
it('should return array of parsed json', () => {
|
|
||||||
const colTypeString =
|
|
||||||
'{"data":"test","test2":"test2"}, {"data":"test3","test4":"test4"}'
|
|
||||||
const expected: HotColumnSettings[] = [
|
|
||||||
{ data: 'test', test2: 'test2' },
|
|
||||||
{ data: 'test3', test4: 'test4' }
|
|
||||||
]
|
|
||||||
|
|
||||||
expect(parseColType(colTypeString)).toEqual(expected)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should return empty array for invalid json', () => {
|
|
||||||
const colTypeString =
|
|
||||||
'{"test":"test""test:"test2"}, {"test3":"test3","test4":"test4"}'
|
|
||||||
const expected: HotColumnSettings[] = []
|
|
||||||
|
|
||||||
expect(parseColType(colTypeString)).toEqual(expected)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
import { HotColumnSettings } from '../models/dc-validation.model'
|
||||||
|
import { parseColTypeRow } from '../utils/parseColTypeRow'
|
||||||
|
|
||||||
|
describe('DC Validator - parse col type row', () => {
|
||||||
|
it('parses a single JSON object', () => {
|
||||||
|
const expected: HotColumnSettings = { data: 'test', type: 'numeric' }
|
||||||
|
|
||||||
|
expect(parseColTypeRow('{"data":"test","type":"numeric"}')).toEqual(
|
||||||
|
expected
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns undefined for undefined input (LEFT JOIN can leave it unset)', () => {
|
||||||
|
expect(parseColTypeRow(undefined)).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns undefined for an empty string', () => {
|
||||||
|
expect(parseColTypeRow('')).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns undefined for malformed JSON, without throwing', () => {
|
||||||
|
expect(parseColTypeRow('{not valid')).toBeUndefined()
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -1,25 +1,22 @@
|
|||||||
import { DcValidation } from '../models/dc-validation.model'
|
import { DcValidation } from '../models/dc-validation.model'
|
||||||
import * as languages from 'numbro/dist/languages.min'
|
|
||||||
/**
|
/**
|
||||||
* Applying the numeric formats based on the browser locale/language
|
* Applying the numeric formats based on the browser locale/language
|
||||||
* So that correct decimal separators are applied.
|
* So that correct decimal separators are applied.
|
||||||
* For example european format (thousand dot, decimal comma): 1.000,00
|
* For example european format (thousand dot, decimal comma): 1.000,00
|
||||||
*
|
*
|
||||||
|
* Uses Intl.NumberFormat options (HOT 17+) instead of the deprecated numbro
|
||||||
|
* `pattern`/`culture`. `maximumFractionDigits: 20` preserves all natural
|
||||||
|
* decimals (Intl's default of 3 would round); `locale` replaces `culture`.
|
||||||
|
*
|
||||||
* @param rules Cell Validation rules to be updated
|
* @param rules Cell Validation rules to be updated
|
||||||
* Those rules are passed in the `columns` property Of handsontable settings.
|
* Those rules are passed in the `columns` property Of handsontable settings.
|
||||||
*/
|
*/
|
||||||
export const applyNumericFormats = (rules: DcValidation[]): DcValidation[] => {
|
export const applyNumericFormats = (rules: DcValidation[]): DcValidation[] => {
|
||||||
const lang = languages[window.navigator.language]
|
|
||||||
|
|
||||||
if (!lang) return rules
|
|
||||||
|
|
||||||
for (let rule of rules) {
|
for (let rule of rules) {
|
||||||
if (rule.type === 'numeric')
|
if (rule.type === 'numeric') {
|
||||||
rule.numericFormat = {
|
rule.numericFormat = { useGrouping: true, maximumFractionDigits: 20 }
|
||||||
pattern: '0,0',
|
rule.locale = window.navigator.language
|
||||||
culture: window.navigator.language // use this for EUR (German),
|
}
|
||||||
// more cultures available on http://numbrojs.com/languages.html
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return rules
|
return rules
|
||||||
|
|||||||
@@ -0,0 +1,16 @@
|
|||||||
|
import { DcValidation } from '../models/dc-validation.model'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* `_____DELETE__THIS__RECORD_____` is a client-side UI concept (the delete
|
||||||
|
* checkbox column) that getdata.sas synthesizes into vars3/vars4 for display
|
||||||
|
* purposes only — it's never a real column of the underlying dataset, so
|
||||||
|
* `%mp_getcols` (which builds `cols1`, the left side of the join into
|
||||||
|
* `cols`) never has a row for it, and its rule can no longer travel via
|
||||||
|
* `cols[].COLTYPE` (see issue #253's vertical-array fix). The rule is fixed
|
||||||
|
* and data-independent, so it's injected directly here instead.
|
||||||
|
*/
|
||||||
|
export const DELETE_RECORD_COLUMN_RULE: DcValidation = {
|
||||||
|
data: '_____DELETE__THIS__RECORD_____',
|
||||||
|
type: 'dropdown',
|
||||||
|
source: ['No', 'Yes']
|
||||||
|
}
|
||||||
@@ -0,0 +1,16 @@
|
|||||||
|
/**
|
||||||
|
* Rounds a number like Excel's ROUND(number, num_digits):
|
||||||
|
* - rounds half away from zero (so ROUND(-0.5) === -1, ROUND(2.5) === 3)
|
||||||
|
* - supports negative `digits` (e.g. -1 rounds to the nearest ten)
|
||||||
|
*
|
||||||
|
* @param value number to round
|
||||||
|
* @param digits number of decimal places (may be negative)
|
||||||
|
* @returns the rounded number, or the original value if it is not finite
|
||||||
|
*/
|
||||||
|
export function excelRound(value: number, digits: number): number {
|
||||||
|
if (!isFinite(value) || !isFinite(digits)) return value
|
||||||
|
|
||||||
|
const factor = Math.pow(10, digits)
|
||||||
|
|
||||||
|
return (Math.sign(value) * Math.round(Math.abs(value) * factor)) / factor
|
||||||
|
}
|
||||||
@@ -0,0 +1,44 @@
|
|||||||
|
import { DQRule, DQRuleTypes } from '../models/dq-rules.model'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Rule types whose RULE_VALUE supplies the default value inserted into a cell
|
||||||
|
* when a new row is added. Checked in priority order.
|
||||||
|
*/
|
||||||
|
const DEFAULT_VALUE_RULE_TYPES: DQRuleTypes[] = [
|
||||||
|
'NOTNULL',
|
||||||
|
'READONLY',
|
||||||
|
'HIDDEN'
|
||||||
|
]
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the default value for a column from DQ rules, used to pre-fill cells
|
||||||
|
* when a new row is added. Looks for the first non-empty RULE_VALUE among
|
||||||
|
* NOTNULL, READONLY and HIDDEN rules. Converts to number for numeric columns.
|
||||||
|
*
|
||||||
|
* @param colName column name to look up
|
||||||
|
* @param dqRules array of DQ rules
|
||||||
|
* @param colType column type (e.g., 'numeric', 'text')
|
||||||
|
* @returns default value (string or number) if a default-providing rule exists
|
||||||
|
* with a non-empty value, otherwise undefined
|
||||||
|
*/
|
||||||
|
export function getColumnDefault(
|
||||||
|
colName: string,
|
||||||
|
dqRules: DQRule[],
|
||||||
|
colType?: string
|
||||||
|
): string | number | undefined {
|
||||||
|
const rule = dqRules.find(
|
||||||
|
(rule: DQRule) =>
|
||||||
|
rule.BASE_COL === colName &&
|
||||||
|
DEFAULT_VALUE_RULE_TYPES.includes(rule.RULE_TYPE) &&
|
||||||
|
rule.RULE_VALUE != null &&
|
||||||
|
rule.RULE_VALUE.trim().length > 0
|
||||||
|
)
|
||||||
|
|
||||||
|
if (!rule) return undefined
|
||||||
|
|
||||||
|
if (colType === 'numeric' && !isNaN(Number(rule.RULE_VALUE))) {
|
||||||
|
return Number(rule.RULE_VALUE)
|
||||||
|
}
|
||||||
|
|
||||||
|
return rule.RULE_VALUE
|
||||||
|
}
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
import { DcValidation } from '../models/dc-validation.model'
|
import { DcValidation } from '../models/dc-validation.model'
|
||||||
import { DQRule } from '../models/dq-rules.model'
|
import { DQRule } from '../models/dq-rules.model'
|
||||||
import { getNotNullDefault } from './getNotNullDefault'
|
import { getColumnDefault } from './getColumnDefault'
|
||||||
|
|
||||||
const schemaTypeMap: { [key: string]: any } = {
|
const schemaTypeMap: { [key: string]: any } = {
|
||||||
numeric: '',
|
numeric: '',
|
||||||
@@ -9,16 +9,16 @@ const schemaTypeMap: { [key: string]: any } = {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Schema defines the default values for given types. For example when new row is added.
|
* Schema defines the default values for given types. For example when new row is added.
|
||||||
* Priority: NOTNULL RULE_VALUE > autocomplete first option > type default
|
* Priority: NOTNULL/READONLY/HIDDEN RULE_VALUE > autocomplete first option > type default
|
||||||
*/
|
*/
|
||||||
export function getHotDataSchema(
|
export function getHotDataSchema(
|
||||||
type: string | undefined,
|
type: string | undefined,
|
||||||
cellValidation?: DcValidation,
|
cellValidation?: DcValidation,
|
||||||
dqRules?: DQRule[]
|
dqRules?: DQRule[]
|
||||||
): any {
|
): any {
|
||||||
// Check for NOTNULL default first
|
// Check for a rule-supplied default (NOTNULL/READONLY/HIDDEN) first
|
||||||
if (dqRules && cellValidation?.data) {
|
if (dqRules && cellValidation?.data) {
|
||||||
const defaultValue = getNotNullDefault(cellValidation.data, dqRules, type)
|
const defaultValue = getColumnDefault(cellValidation.data, dqRules, type)
|
||||||
if (defaultValue !== undefined) {
|
if (defaultValue !== undefined) {
|
||||||
return defaultValue
|
return defaultValue
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,33 @@
|
|||||||
|
import { DcValidation } from '../models/dc-validation.model'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Maps SAS' semantic date/time/datetime column types to the HOT 17 Intl cell
|
||||||
|
* type names. SAS sends a HOT-agnostic flag (`date`/`time`/`datetime`); the
|
||||||
|
* frontend owns the HOT-specific cell-type names:
|
||||||
|
*
|
||||||
|
* - `date` → `intl-date` (native date picker)
|
||||||
|
* - `time` → `intl-time` (native time picker)
|
||||||
|
* - `datetime` → `intl-datetime` (native datetime-local picker)
|
||||||
|
*
|
||||||
|
* The cell display is the raw stored ISO string (locale-independent) — see
|
||||||
|
* registerIntlCellTypes, where these types' `valueFormatter` is the identity
|
||||||
|
* passthrough. No locale/format meta is attached; it is unused for display, and
|
||||||
|
* the validators are ISO-based and locale-agnostic. Runs in the DcValidator
|
||||||
|
* constructor, before the rules reach Handsontable.
|
||||||
|
*
|
||||||
|
* @param rules Cell validation rules passed to Handsontable's `columns`.
|
||||||
|
*/
|
||||||
|
const INTL_TYPE_MAP: Record<string, string> = {
|
||||||
|
date: 'intl-date',
|
||||||
|
time: 'intl-time',
|
||||||
|
datetime: 'intl-datetime'
|
||||||
|
}
|
||||||
|
|
||||||
|
export const mapIntlCellTypes = (rules: DcValidation[]): DcValidation[] => {
|
||||||
|
for (const rule of rules) {
|
||||||
|
const mapped = rule.type ? INTL_TYPE_MAP[rule.type as string] : undefined
|
||||||
|
if (mapped) rule.type = mapped
|
||||||
|
}
|
||||||
|
|
||||||
|
return rules
|
||||||
|
}
|
||||||
@@ -27,7 +27,7 @@ export const mergeColsRules = (
|
|||||||
: colFormats.type
|
: colFormats.type
|
||||||
|
|
||||||
if (rule && col.DESC) rule.desc = col.DESC
|
if (rule && col.DESC) rule.desc = col.DESC
|
||||||
if (rule && colFormats.length) rule.length = parseInt(colFormats.length)
|
if (rule && colFormats?.length) rule.length = parseInt(colFormats.length)
|
||||||
if (rule && col.CLS_RULE) rule.clsRule = col.CLS_RULE
|
if (rule && col.CLS_RULE) rule.clsRule = col.CLS_RULE
|
||||||
if (rule && colFormats?.type) rule.sasType = colFormats.type
|
if (rule && colFormats?.type) rule.sasType = colFormats.type
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,16 +0,0 @@
|
|||||||
import { HotColumnSettings } from '../models/dc-validation.model'
|
|
||||||
|
|
||||||
/**
|
|
||||||
* From sas we get a string instead of array of objects, in that string `[]` are missing so
|
|
||||||
* before parsing JSON we need to add them.
|
|
||||||
*
|
|
||||||
* @param coltype string (objects) that comes from sas
|
|
||||||
* @returns JSON Handsontable.ColumnSettings[]
|
|
||||||
*/
|
|
||||||
export const parseColType = (coltype: string): HotColumnSettings[] => {
|
|
||||||
try {
|
|
||||||
return JSON.parse(`[${coltype}]`)
|
|
||||||
} catch (err: any) {
|
|
||||||
return []
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
import { HotColumnSettings } from '../models/dc-validation.model'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Parses a single column's `COLTYPE` JSON-object string (one per `cols` row,
|
||||||
|
* as of the vertical-array getdata.sas fix — see issue #253). Unlike the
|
||||||
|
* previous comma-joined `sasparams.COLTYPE` format, each row is independent:
|
||||||
|
* a malformed or missing value here only drops that one column's rule,
|
||||||
|
* rather than every column's.
|
||||||
|
*
|
||||||
|
* @param coltype a single column's COLTYPE JSON string, or undefined (the
|
||||||
|
* LEFT JOIN in getdata.sas can leave it unset for unmatched rows)
|
||||||
|
*/
|
||||||
|
export const parseColTypeRow = (
|
||||||
|
coltype: string | undefined
|
||||||
|
): HotColumnSettings | undefined => {
|
||||||
|
if (!coltype) return undefined
|
||||||
|
|
||||||
|
try {
|
||||||
|
return JSON.parse(coltype)
|
||||||
|
} catch (err: any) {
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -22,3 +22,26 @@ export function specialMissingNumericValidator(
|
|||||||
if (callback) callback(valid)
|
if (callback) callback(valid)
|
||||||
return valid
|
return valid
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const DATETIME_REGEX = /^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Validator for the custom `intl-datetime` cell type. Expects SAS' ISO datetime
|
||||||
|
* form `YYYY-MM-DD HH:mm:ss`. Mirrors HOT's intl validators by honouring
|
||||||
|
* `this.allowEmpty` for blank values. Bound by HOT to the cell properties, so
|
||||||
|
* `this` carries `allowEmpty`.
|
||||||
|
*/
|
||||||
|
export function datetimeValidator(
|
||||||
|
this: { allowEmpty?: boolean } | void,
|
||||||
|
value: any,
|
||||||
|
callback: (valid: boolean) => void
|
||||||
|
) {
|
||||||
|
const allowEmpty = (this as { allowEmpty?: boolean })?.allowEmpty ?? true
|
||||||
|
|
||||||
|
if (value === undefined || value === null || value === '') {
|
||||||
|
callback(allowEmpty)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
callback(typeof value === 'string' && DATETIME_REGEX.test(value))
|
||||||
|
}
|
||||||
|
|||||||
@@ -0,0 +1,173 @@
|
|||||||
|
import Handsontable from 'handsontable'
|
||||||
|
import { MenuItemConfig } from 'handsontable/plugins/contextMenu'
|
||||||
|
|
||||||
|
export type HotExportFormat = 'csv' | 'xlsx'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cell types whose values must be exported as raw stored strings rather than
|
||||||
|
* converted to native Excel date/time cells. SAS raw data is the canonical
|
||||||
|
* representation, so dates/times are exported exactly as the grid stores them.
|
||||||
|
* `numeric` is intentionally NOT listed — it stays a native Excel number.
|
||||||
|
*/
|
||||||
|
const RAW_EXPORT_TYPES = new Set([
|
||||||
|
'date',
|
||||||
|
'time',
|
||||||
|
'datetime',
|
||||||
|
'intl-date',
|
||||||
|
'intl-time',
|
||||||
|
'intl-datetime'
|
||||||
|
])
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Client-side export of a Handsontable grid's current view via the built-in
|
||||||
|
* `exportFile` plugin. Exports the current selection if one exists, otherwise
|
||||||
|
* the whole grid. This is a "what you see" convenience export and is distinct
|
||||||
|
* from any server-side (SAS) download.
|
||||||
|
*
|
||||||
|
* @param hot Live Handsontable instance.
|
||||||
|
* @param format `'csv'` or `'xlsx'`.
|
||||||
|
* @param filename File name (without extension).
|
||||||
|
* @param skipLeadingCols Number of leading UI/housekeeping columns to exclude
|
||||||
|
* (e.g. the editor's `Delete?` column at index 0).
|
||||||
|
*/
|
||||||
|
export async function exportGrid(
|
||||||
|
hot: Handsontable,
|
||||||
|
format: HotExportFormat,
|
||||||
|
filename: string,
|
||||||
|
skipLeadingCols = 0
|
||||||
|
): Promise<void> {
|
||||||
|
const plugin = hot.getPlugin('exportFile')
|
||||||
|
|
||||||
|
const opts: Record<string, any> = {
|
||||||
|
filename: filename || 'export',
|
||||||
|
colHeaders: true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Selection-aware, contiguous range (visual indexes). Hidden columns are
|
||||||
|
// excluded automatically (exportHiddenColumns defaults to false).
|
||||||
|
const sel = hot.getSelectedRangeLast()
|
||||||
|
const lastRow = hot.countRows() - 1
|
||||||
|
const lastCol = hot.countCols() - 1
|
||||||
|
|
||||||
|
// Mirror HOT's own export item: only honor a selection that spans more than
|
||||||
|
// one cell. A right-click places a single-cell cursor, and the corner click
|
||||||
|
// is select-all (negative coords) — both mean "export the whole table".
|
||||||
|
// sel.from/to.row/col are typed nullable (CellCoords allows an unset state),
|
||||||
|
// but a range returned by getSelectedRangeLast() always has real coordinates.
|
||||||
|
const isCornerSelectAll = !!sel && sel.from.row! < 0 && sel.from.col! < 0
|
||||||
|
if (sel && !sel.isSingleCell() && !isCornerSelectAll) {
|
||||||
|
const top = Math.max(0, Math.min(sel.from.row!, sel.to.row!))
|
||||||
|
const left = Math.max(0, Math.min(sel.from.col!, sel.to.col!))
|
||||||
|
const bottom = Math.max(sel.from.row!, sel.to.row!)
|
||||||
|
const right = Math.max(sel.from.col!, sel.to.col!)
|
||||||
|
opts['range'] = [top, Math.max(left, skipLeadingCols), bottom, right]
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!opts['range'] && skipLeadingCols > 0) {
|
||||||
|
opts['range'] = [0, skipLeadingCols, lastRow, lastCol]
|
||||||
|
}
|
||||||
|
|
||||||
|
if (format === 'csv') {
|
||||||
|
// CSV reads raw stored values (getDataAtCell) — no type conversion needed.
|
||||||
|
plugin.downloadFile('csv', opts)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// xlsx: temporarily override cell meta during the export's single
|
||||||
|
// getCellMeta() pass, then restore (HOT returns cached meta objects).
|
||||||
|
// - date/time/datetime types -> 'text' so values export raw, not as native
|
||||||
|
// Excel dates.
|
||||||
|
// - drop color/highlight: clear classNames and readOnly so the exporter
|
||||||
|
// doesn't bake in theme/validation/read-only fills. Cell classes carry no
|
||||||
|
// meaning in the exported file.
|
||||||
|
const restore: Array<{
|
||||||
|
meta: any
|
||||||
|
type: any
|
||||||
|
className: any
|
||||||
|
readOnly: any
|
||||||
|
}> = []
|
||||||
|
const seen = new Set<any>()
|
||||||
|
const hook = (_row: number, _col: number, cp: any): void => {
|
||||||
|
if (seen.has(cp)) return
|
||||||
|
seen.add(cp)
|
||||||
|
|
||||||
|
const needsTypeFix = RAW_EXPORT_TYPES.has(cp.type)
|
||||||
|
const needsClassFix =
|
||||||
|
typeof cp.className === 'string' && cp.className !== ''
|
||||||
|
const needsReadOnlyFix = cp.readOnly === true
|
||||||
|
|
||||||
|
if (!needsTypeFix && !needsClassFix && !needsReadOnlyFix) return
|
||||||
|
|
||||||
|
restore.push({
|
||||||
|
meta: cp,
|
||||||
|
type: cp.type,
|
||||||
|
className: cp.className,
|
||||||
|
readOnly: cp.readOnly
|
||||||
|
})
|
||||||
|
|
||||||
|
if (needsTypeFix) cp.type = 'text'
|
||||||
|
if (needsClassFix) cp.className = ''
|
||||||
|
if (needsReadOnlyFix) cp.readOnly = false
|
||||||
|
}
|
||||||
|
|
||||||
|
hot.addHook('afterGetCellMeta', hook)
|
||||||
|
try {
|
||||||
|
const mod: any = await import('exceljs')
|
||||||
|
const ExcelJS = mod.default ?? mod
|
||||||
|
await plugin.downloadFileAsync('xlsx', { ...opts, engine: ExcelJS })
|
||||||
|
} finally {
|
||||||
|
hot.removeHook('afterGetCellMeta', hook)
|
||||||
|
restore.forEach(({ meta, type, className, readOnly }) => {
|
||||||
|
meta.type = type
|
||||||
|
meta.className = className
|
||||||
|
meta.readOnly = readOnly
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds a reusable `export_file` context-menu item (CSV / Excel submenu) that
|
||||||
|
* exports the given grid via {@link exportGrid}. Add it to any HOT context-menu
|
||||||
|
* `items` map under the `export_file` key.
|
||||||
|
*
|
||||||
|
* @param getFilename Returns the export file name at click time.
|
||||||
|
* @param skipLeadingCols Leading UI columns to exclude (see {@link exportGrid}).
|
||||||
|
*/
|
||||||
|
export function buildExportMenuItem(
|
||||||
|
getFilename: () => string,
|
||||||
|
skipLeadingCols = 0
|
||||||
|
): MenuItemConfig {
|
||||||
|
// HOT invokes context-menu callbacks with `this` bound to the clicked grid
|
||||||
|
// instance, so the item works uniformly even for components that host
|
||||||
|
// multiple grids (e.g. viewboxes).
|
||||||
|
const makeCb = (format: HotExportFormat) =>
|
||||||
|
function (this: Handsontable): void {
|
||||||
|
void exportGrid(this, format, getFilename(), skipLeadingCols)
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
name: 'Export',
|
||||||
|
// The exportFile plugin registers a predefined item under the same
|
||||||
|
// `export_file` key whose `hidden()` returns true unless an `exportFile`
|
||||||
|
// setting exists. HOT shallow-merges our config over it, so we must
|
||||||
|
// explicitly override `hidden` to keep the item visible.
|
||||||
|
hidden: false,
|
||||||
|
submenu: {
|
||||||
|
// Submenu keys use the documented "parent_key:sub_key" form. The array
|
||||||
|
// form is what HOT's own exportFile plugin uses at runtime; cast to
|
||||||
|
// satisfy the (stricter) MenuConfig typing.
|
||||||
|
items: [
|
||||||
|
{
|
||||||
|
key: 'export_file:csv',
|
||||||
|
name: 'CSV',
|
||||||
|
callback: makeCb('csv')
|
||||||
|
},
|
||||||
|
{
|
||||||
|
key: 'export_file:xlsx',
|
||||||
|
name: 'Excel (.xlsx)',
|
||||||
|
callback: makeCb('xlsx')
|
||||||
|
}
|
||||||
|
] as any
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -15,6 +15,8 @@ import { DirectivesModule } from '../directives/directives.module'
|
|||||||
import { DatasetInfoComponent } from './dataset-info/dataset-info.component'
|
import { DatasetInfoComponent } from './dataset-info/dataset-info.component'
|
||||||
import { ContactLinkComponent } from './contact-link/contact-link.component'
|
import { ContactLinkComponent } from './contact-link/contact-link.component'
|
||||||
import { ExcelPasswordModalComponent } from './excel-password-modal/excel-password-modal.component'
|
import { ExcelPasswordModalComponent } from './excel-password-modal/excel-password-modal.component'
|
||||||
|
import { ConfirmModalComponent } from './confirm-modal/confirm-modal.component'
|
||||||
|
import { BulkValidationModalComponent } from './bulk-validation-modal/bulk-validation-modal.component'
|
||||||
|
|
||||||
@NgModule({
|
@NgModule({
|
||||||
imports: [
|
imports: [
|
||||||
@@ -32,7 +34,9 @@ import { ExcelPasswordModalComponent } from './excel-password-modal/excel-passwo
|
|||||||
TermsComponent,
|
TermsComponent,
|
||||||
DatasetInfoComponent,
|
DatasetInfoComponent,
|
||||||
ContactLinkComponent,
|
ContactLinkComponent,
|
||||||
ExcelPasswordModalComponent
|
ExcelPasswordModalComponent,
|
||||||
|
ConfirmModalComponent,
|
||||||
|
BulkValidationModalComponent
|
||||||
],
|
],
|
||||||
exports: [
|
exports: [
|
||||||
LoadingIndicatorComponent,
|
LoadingIndicatorComponent,
|
||||||
@@ -42,7 +46,9 @@ import { ExcelPasswordModalComponent } from './excel-password-modal/excel-passwo
|
|||||||
TermsComponent,
|
TermsComponent,
|
||||||
DatasetInfoComponent,
|
DatasetInfoComponent,
|
||||||
ContactLinkComponent,
|
ContactLinkComponent,
|
||||||
ExcelPasswordModalComponent
|
ExcelPasswordModalComponent,
|
||||||
|
ConfirmModalComponent,
|
||||||
|
BulkValidationModalComponent
|
||||||
],
|
],
|
||||||
providers: [UserService, AlertsService]
|
providers: [UserService, AlertsService]
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -13,7 +13,7 @@
|
|||||||
<clr-dropdown>
|
<clr-dropdown>
|
||||||
<button class="dropdown-toggle btn btn-primary" clrDropdownTrigger>
|
<button class="dropdown-toggle btn btn-primary" clrDropdownTrigger>
|
||||||
{{ getSubPage() }}
|
{{ getSubPage() }}
|
||||||
<clr-icon shape="caret down"></clr-icon>
|
<clr-icon aria-hidden="true" shape="caret down"></clr-icon>
|
||||||
</button>
|
</button>
|
||||||
<clr-dropdown-menu *clrIfOpen>
|
<clr-dropdown-menu *clrIfOpen>
|
||||||
<a
|
<a
|
||||||
@@ -76,7 +76,9 @@
|
|||||||
class="user-nav-btn"
|
class="user-nav-btn"
|
||||||
clrTabLink
|
clrTabLink
|
||||||
>
|
>
|
||||||
<p class="zero-margin"><clr-icon shape="user"></clr-icon> Users</p>
|
<p class="zero-margin">
|
||||||
|
<clr-icon aria-hidden="true" shape="user"></clr-icon> Users
|
||||||
|
</p>
|
||||||
</button>
|
</button>
|
||||||
<clr-tab-content> </clr-tab-content>
|
<clr-tab-content> </clr-tab-content>
|
||||||
</clr-tab>
|
</clr-tab>
|
||||||
@@ -87,7 +89,9 @@
|
|||||||
class="user-nav-btn"
|
class="user-nav-btn"
|
||||||
clrTabLink
|
clrTabLink
|
||||||
>
|
>
|
||||||
<p class="zero-margin"><clr-icon shape="users"></clr-icon> Groups</p>
|
<p class="zero-margin">
|
||||||
|
<clr-icon aria-hidden="true" shape="users"></clr-icon> Groups
|
||||||
|
</p>
|
||||||
</button>
|
</button>
|
||||||
<clr-tab-content *clrIfActive="isMainRoute('/view/usernav/groups')">
|
<clr-tab-content *clrIfActive="isMainRoute('/view/usernav/groups')">
|
||||||
</clr-tab-content>
|
</clr-tab-content>
|
||||||
@@ -100,7 +104,7 @@
|
|||||||
clrTabLink
|
clrTabLink
|
||||||
>
|
>
|
||||||
<p class="zero-margin">
|
<p class="zero-margin">
|
||||||
<clr-icon shape="blocks-group"></clr-icon> Roles
|
<clr-icon aria-hidden="true" shape="blocks-group"></clr-icon> Roles
|
||||||
</p>
|
</p>
|
||||||
</button>
|
</button>
|
||||||
<clr-tab-content *clrIfActive="isMainRoute('/view/usernav/roles')">
|
<clr-tab-content *clrIfActive="isMainRoute('/view/usernav/roles')">
|
||||||
@@ -115,7 +119,7 @@
|
|||||||
<clr-dropdown>
|
<clr-dropdown>
|
||||||
<button class="dropdown-toggle btn btn-primary" clrDropdownTrigger>
|
<button class="dropdown-toggle btn btn-primary" clrDropdownTrigger>
|
||||||
{{ getSubPage() }}
|
{{ getSubPage() }}
|
||||||
<clr-icon shape="caret down"></clr-icon>
|
<clr-icon aria-hidden="true" shape="caret down"></clr-icon>
|
||||||
</button>
|
</button>
|
||||||
<clr-dropdown-menu *clrIfOpen>
|
<clr-dropdown-menu *clrIfOpen>
|
||||||
<a
|
<a
|
||||||
|
|||||||
@@ -0,0 +1,151 @@
|
|||||||
|
import { BehaviorSubject } from 'rxjs'
|
||||||
|
import * as XLSX from '@sheet/crypto'
|
||||||
|
import { SpreadsheetUtil } from './spreadsheet-util'
|
||||||
|
import { LicenceState } from 'src/app/models/LicenceState'
|
||||||
|
import { ParseParams } from 'src/app/models/ParseParams.interface'
|
||||||
|
import { SearchDataExcelResult } from 'src/app/models/SearchDataExcelResult.interface'
|
||||||
|
|
||||||
|
describe('SpreadsheetUtil - header matching', () => {
|
||||||
|
// licenceState is unused by searchDataInExcel, so an empty stub is fine.
|
||||||
|
const buildSpreadsheetUtil = () =>
|
||||||
|
new SpreadsheetUtil({
|
||||||
|
licenceState: new BehaviorSubject<LicenceState>({} as LicenceState)
|
||||||
|
})
|
||||||
|
|
||||||
|
const buildWorkbook = (headerRow: string[], dataRow: any[]) => {
|
||||||
|
const ws = XLSX.utils.aoa_to_sheet([headerRow, dataRow])
|
||||||
|
const wb = XLSX.utils.book_new()
|
||||||
|
|
||||||
|
XLSX.utils.book_append_sheet(wb, ws, 'Sheet1')
|
||||||
|
|
||||||
|
return wb
|
||||||
|
}
|
||||||
|
|
||||||
|
// searchDataInExcel only reads headerArray/headerPks off ParseParams; the
|
||||||
|
// other required fields (dcValidator, etc.) are irrelevant here, so a
|
||||||
|
// minimal cast object stands in for a full ParseParams.
|
||||||
|
const buildParseParams = (): ParseParams =>
|
||||||
|
({
|
||||||
|
headerArray: ['PRIMARY_KEY_FIELD', 'SOME_CHAR', 'SOME_NUM'],
|
||||||
|
headerPks: ['PRIMARY_KEY_FIELD']
|
||||||
|
}) as any as ParseParams
|
||||||
|
|
||||||
|
// searchDataInExcel is private; there's no existing precedent in this
|
||||||
|
// codebase for testing private methods, so this casts through `any` to
|
||||||
|
// reach it directly rather than exercising it via the public
|
||||||
|
// parseSpreadsheetFile (which would need a real File/FileReader).
|
||||||
|
const searchDataInExcel = (
|
||||||
|
spreadsheetUtil: SpreadsheetUtil,
|
||||||
|
wb: XLSX.WorkBook,
|
||||||
|
parseParams: ParseParams
|
||||||
|
): SearchDataExcelResult =>
|
||||||
|
(spreadsheetUtil as any).searchDataInExcel(wb, parseParams)
|
||||||
|
|
||||||
|
it('matches headers with leading whitespace against the expected clean header names', () => {
|
||||||
|
const wb = buildWorkbook(
|
||||||
|
['PRIMARY_KEY_FIELD', ' SOME_CHAR', ' SOME_NUM'],
|
||||||
|
[1, 'a value', 42]
|
||||||
|
)
|
||||||
|
|
||||||
|
const result = searchDataInExcel(
|
||||||
|
buildSpreadsheetUtil(),
|
||||||
|
wb,
|
||||||
|
buildParseParams()
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(result.missing).toBeUndefined()
|
||||||
|
expect(result.found).toBeDefined()
|
||||||
|
expect(result.found?.headers).toContain('some_char')
|
||||||
|
expect(result.found?.headers).toContain('some_num')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('still reports a genuinely different header as missing (no over-broadening)', () => {
|
||||||
|
const wb = buildWorkbook(
|
||||||
|
['PRIMARY_KEY_FIELD', ' SOME_CHARX', ' SOME_NUM'],
|
||||||
|
[1, 'a value', 42]
|
||||||
|
)
|
||||||
|
|
||||||
|
const result = searchDataInExcel(
|
||||||
|
buildSpreadsheetUtil(),
|
||||||
|
wb,
|
||||||
|
buildParseParams()
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(result.found).toBeUndefined()
|
||||||
|
expect(result.missing).toBeDefined()
|
||||||
|
expect(result.missing?.[0].missingHeaders).toContain('SOME_CHAR')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('SpreadsheetUtil - updateDateTimeCols time normalization', () => {
|
||||||
|
const buildSpreadsheetUtil = () =>
|
||||||
|
new SpreadsheetUtil({
|
||||||
|
licenceState: new BehaviorSubject<LicenceState>({} as LicenceState)
|
||||||
|
})
|
||||||
|
|
||||||
|
// updateDateTimeCols is private; cast through `any` (same precedent as above).
|
||||||
|
const updateDateTimeCols = (
|
||||||
|
spreadsheetUtil: SpreadsheetUtil,
|
||||||
|
headers: string[],
|
||||||
|
data: any[],
|
||||||
|
parseParams: ParseParams
|
||||||
|
): any[] =>
|
||||||
|
(spreadsheetUtil as any).updateDateTimeCols(headers, data, parseParams)
|
||||||
|
|
||||||
|
const timeParseParams = (): ParseParams =>
|
||||||
|
({
|
||||||
|
dateHeaders: [],
|
||||||
|
dateTimeHeaders: [],
|
||||||
|
timeHeaders: ['SOME_TIME']
|
||||||
|
}) as any as ParseParams
|
||||||
|
|
||||||
|
it('pads unpadded-hour time strings to canonical HH:mm:ss and leaves canonical values alone', () => {
|
||||||
|
// The core bug: SAS TIME8. / Excel render a single-digit hour (`0:00:42`),
|
||||||
|
// arriving as a plain string (not an Excel serial). Already-canonical values
|
||||||
|
// must pass through untouched.
|
||||||
|
const data = [[{ v: '0:00:42' }], [{ v: '9:05:03' }], [{ v: '23:00:00' }]]
|
||||||
|
|
||||||
|
const result = updateDateTimeCols(
|
||||||
|
buildSpreadsheetUtil(),
|
||||||
|
['SOME_TIME'],
|
||||||
|
data,
|
||||||
|
timeParseParams()
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(result.map((row) => row[0].v)).toEqual([
|
||||||
|
'00:00:42',
|
||||||
|
'09:05:03',
|
||||||
|
'23:00:00'
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('reads a 2-part value as HOURS-first and defaults seconds (HHMM/TIME5.): 0:42 -> 00:42:00', () => {
|
||||||
|
// TIME5.-7. and HHMM. columns render `HH:mm`. Such values are never `mm:ss`
|
||||||
|
// — DC only classifies TIME/HHMM formats as time columns — so the hour is
|
||||||
|
// padded and minutes kept, with seconds defaulted to :00.
|
||||||
|
const data = [[{ v: '0:42' }], [{ v: '12:25' }]]
|
||||||
|
|
||||||
|
const result = updateDateTimeCols(
|
||||||
|
buildSpreadsheetUtil(),
|
||||||
|
['SOME_TIME'],
|
||||||
|
data,
|
||||||
|
timeParseParams()
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(result.map((row) => row[0].v)).toEqual(['00:42:00', '12:25:00'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('reconstructs an Excel serial time to zero-padded HH:mm:ss', () => {
|
||||||
|
// 0.0004861111 of a day = 42 seconds past midnight.
|
||||||
|
const data = [[{ v: 0.0004861111 }]]
|
||||||
|
|
||||||
|
const result = updateDateTimeCols(
|
||||||
|
buildSpreadsheetUtil(),
|
||||||
|
['SOME_TIME'],
|
||||||
|
data,
|
||||||
|
timeParseParams()
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(result[0][0].v).toBe('00:00:42')
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -2,7 +2,8 @@ import { isSpecialMissing } from '@sasjs/utils/input/validators'
|
|||||||
import {
|
import {
|
||||||
dateFormat,
|
dateFormat,
|
||||||
dateToUtcTime,
|
dateToUtcTime,
|
||||||
dateToTime
|
dateToTime,
|
||||||
|
padTimeString
|
||||||
} from 'src/app/editor/utils/date.utils'
|
} from 'src/app/editor/utils/date.utils'
|
||||||
import {
|
import {
|
||||||
getMissingHeaders,
|
getMissingHeaders,
|
||||||
@@ -608,7 +609,11 @@ export class SpreadsheetUtil {
|
|||||||
|
|
||||||
// If the cell does not have `v` property we ignore it, those are metadata properties
|
// If the cell does not have `v` property we ignore it, those are metadata properties
|
||||||
if (cellValue && typeof cellValue === 'string') {
|
if (cellValue && typeof cellValue === 'string') {
|
||||||
const potentialHeader = cellValue.toLowerCase()
|
// .trim(): header cells can pick up incidental leading/trailing
|
||||||
|
// whitespace from copy-pasting between spreadsheets/systems — treat
|
||||||
|
// that the same as the existing case-insensitive matching below,
|
||||||
|
// not as a genuinely different (missing) column.
|
||||||
|
const potentialHeader = cellValue.trim().toLowerCase()
|
||||||
const headerIndex = csvArrayHeadersLower.indexOf(potentialHeader)
|
const headerIndex = csvArrayHeadersLower.indexOf(potentialHeader)
|
||||||
|
|
||||||
if (headerIndex > -1) {
|
if (headerIndex > -1) {
|
||||||
@@ -816,6 +821,7 @@ export class SpreadsheetUtil {
|
|||||||
data.forEach((row: any[]) => {
|
data.forEach((row: any[]) => {
|
||||||
dateCols.forEach((element) => {
|
dateCols.forEach((element) => {
|
||||||
const obj = row[element]
|
const obj = row[element]
|
||||||
|
if (!obj || obj.v == null) return
|
||||||
if (isStringNumber(obj.v)) {
|
if (isStringNumber(obj.v)) {
|
||||||
const date = excelDateToJSDate(Number(obj.v))
|
const date = excelDateToJSDate(Number(obj.v))
|
||||||
|
|
||||||
@@ -847,14 +853,18 @@ export class SpreadsheetUtil {
|
|||||||
data.forEach((row: any[]) => {
|
data.forEach((row: any[]) => {
|
||||||
timeCols.forEach((element) => {
|
timeCols.forEach((element) => {
|
||||||
const obj = row[element]
|
const obj = row[element]
|
||||||
|
if (!obj || obj.v == null) return
|
||||||
if (
|
if (
|
||||||
isStringNumber(obj.v) ||
|
isStringNumber(obj.v) ||
|
||||||
isStringDecimal(obj.v) ||
|
isStringDecimal(obj.v) ||
|
||||||
obj.v.includes('E-')
|
(typeof obj.v === 'string' && obj.v.includes('E-'))
|
||||||
) {
|
) {
|
||||||
const date = excelDateToJSDate(Number(obj.v))
|
const date = excelDateToJSDate(Number(obj.v))
|
||||||
|
|
||||||
obj.v = dateToUtcTime(date)
|
obj.v = dateToUtcTime(date)
|
||||||
|
} else if (typeof obj.v === 'string') {
|
||||||
|
// `0:00:42`— pad the hour for `intl-time` cell type
|
||||||
|
obj.v = padTimeString(obj.v)
|
||||||
}
|
}
|
||||||
row[element] = obj
|
row[element] = obj
|
||||||
})
|
})
|
||||||
@@ -870,6 +880,7 @@ export class SpreadsheetUtil {
|
|||||||
data.forEach((row: any[]) => {
|
data.forEach((row: any[]) => {
|
||||||
dateTimeCols.forEach((element) => {
|
dateTimeCols.forEach((element) => {
|
||||||
const obj = row[element]
|
const obj = row[element]
|
||||||
|
if (!obj || obj.v == null) return
|
||||||
if (isStringNumber(obj.v) || isStringDecimal(obj.v)) {
|
if (isStringNumber(obj.v) || isStringDecimal(obj.v)) {
|
||||||
const date = excelDateToJSDate(Number(obj.v))
|
const date = excelDateToJSDate(Number(obj.v))
|
||||||
obj.v = dateFormat(date) + ' ' + dateToUtcTime(date)
|
obj.v = dateFormat(date) + ' ' + dateToUtcTime(date)
|
||||||
@@ -903,6 +914,7 @@ export class SpreadsheetUtil {
|
|||||||
data.forEach((row: any[]) => {
|
data.forEach((row: any[]) => {
|
||||||
xlRuleCols.forEach((element: any) => {
|
xlRuleCols.forEach((element: any) => {
|
||||||
const obj = row[element.index]
|
const obj = row[element.index]
|
||||||
|
if (!obj) return
|
||||||
if (element.XL_RULE === 'FORMULA') {
|
if (element.XL_RULE === 'FORMULA') {
|
||||||
if ('f' in obj) {
|
if ('f' in obj) {
|
||||||
if (obj['t'] === 'n') {
|
if (obj['t'] === 'n') {
|
||||||
@@ -912,7 +924,7 @@ export class SpreadsheetUtil {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
row[element] = obj
|
row[element.index] = obj
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -43,7 +43,11 @@
|
|||||||
[class.hidden]="debugLogs.length === 0"
|
[class.hidden]="debugLogs.length === 0"
|
||||||
>{{ debugLogs.length }}</span
|
>{{ debugLogs.length }}</span
|
||||||
>
|
>
|
||||||
<clr-icon *ngIf="!isViya" shape="caret down"></clr-icon>
|
<clr-icon
|
||||||
|
*ngIf="!isViya"
|
||||||
|
aria-hidden="true"
|
||||||
|
shape="caret down"
|
||||||
|
></clr-icon>
|
||||||
</button>
|
</button>
|
||||||
<clr-dropdown-menu clrPosition="bottom-right" *clrIfOpen>
|
<clr-dropdown-menu clrPosition="bottom-right" *clrIfOpen>
|
||||||
<div #dropdownItemDebug class="debug-switch-item" clrDropdownItem>
|
<div #dropdownItemDebug class="debug-switch-item" clrDropdownItem>
|
||||||
@@ -83,7 +87,11 @@
|
|||||||
</a>
|
</a>
|
||||||
<a href="..." (click)="logout($event)" clrDropdownItem>
|
<a href="..." (click)="logout($event)" clrDropdownItem>
|
||||||
<span>Log Out</span>
|
<span>Log Out</span>
|
||||||
<clr-icon class="clr-logout" shape="logout"></clr-icon>
|
<clr-icon
|
||||||
|
aria-hidden="true"
|
||||||
|
class="clr-logout"
|
||||||
|
shape="logout"
|
||||||
|
></clr-icon>
|
||||||
</a>
|
</a>
|
||||||
<div class="copyRight">
|
<div class="copyRight">
|
||||||
<span>v{{ commitVer }}</span>
|
<span>v{{ commitVer }}</span>
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
import { buildColInfoHtml } from './col-info-html'
|
||||||
|
import { DataFormat } from '../../models/sas/common/DateFormat'
|
||||||
|
|
||||||
|
describe('buildColInfoHtml', () => {
|
||||||
|
it('returns "No info found" when colInfo is undefined', () => {
|
||||||
|
expect(buildColInfoHtml('SOME_CHAR', undefined)).toBe('No info found')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('renders NAME first, then LABEL/TYPE/LENGTH/FORMAT', () => {
|
||||||
|
const colInfo: DataFormat = {
|
||||||
|
label: 'Some Character Column',
|
||||||
|
type: 'char',
|
||||||
|
length: '1024',
|
||||||
|
format: '$1024.'
|
||||||
|
}
|
||||||
|
|
||||||
|
expect(buildColInfoHtml('SOME_CHAR', colInfo)).toBe(
|
||||||
|
'NAME: SOME_CHAR<br>LABEL: Some Character Column<br>TYPE: char<br>LENGTH: 1024<br>FORMAT: $1024.'
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
import { DataFormat } from '../../models/sas/common/DateFormat'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds the HTML shown in a column-header "info" dropdown item (viewer and
|
||||||
|
* editor). NAME is listed first so it's visible regardless of whether
|
||||||
|
* headers are currently displayed as NAME or LABEL.
|
||||||
|
*/
|
||||||
|
export function buildColInfoHtml(
|
||||||
|
colName: string,
|
||||||
|
colInfo?: DataFormat
|
||||||
|
): string {
|
||||||
|
if (!colInfo) return 'No info found'
|
||||||
|
|
||||||
|
return `NAME: ${colName}<br>LABEL: ${colInfo.label}<br>TYPE: ${colInfo.type}<br>LENGTH: ${colInfo.length}<br>FORMAT: ${colInfo.format}`
|
||||||
|
}
|
||||||
@@ -0,0 +1,59 @@
|
|||||||
|
import { getDisplayColHeaders } from './display-col-headers'
|
||||||
|
import { Col } from '../dc-validator/models/col.model'
|
||||||
|
|
||||||
|
const makeCol = (overrides: Partial<Col>): Col => ({
|
||||||
|
NAME: '',
|
||||||
|
VARNUM: 0,
|
||||||
|
LABEL: '',
|
||||||
|
FMTNAME: '',
|
||||||
|
DDTYPE: '',
|
||||||
|
TYPE: '',
|
||||||
|
CLS_RULE: '',
|
||||||
|
MEMLABEL: '',
|
||||||
|
DESC: '',
|
||||||
|
LONGDESC: '',
|
||||||
|
...overrides
|
||||||
|
})
|
||||||
|
|
||||||
|
describe('getDisplayColHeaders', () => {
|
||||||
|
const colNames = ['SOME_CHAR', 'SOME_NUM', 'SOME_DATE']
|
||||||
|
const cols: Col[] = [
|
||||||
|
makeCol({ NAME: 'SOME_CHAR', LABEL: 'Some Character Column' }),
|
||||||
|
makeCol({ NAME: 'SOME_NUM', LABEL: '' }),
|
||||||
|
makeCol({ NAME: 'SOME_DATE', LABEL: 'Some Date' })
|
||||||
|
]
|
||||||
|
|
||||||
|
it('returns colNames unchanged when useLabels is false', () => {
|
||||||
|
expect(getDisplayColHeaders(colNames, cols, false)).toEqual(colNames)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns matching LABELs when useLabels is true', () => {
|
||||||
|
expect(getDisplayColHeaders(colNames, cols, true)).toEqual([
|
||||||
|
'Some Character Column',
|
||||||
|
'SOME_NUM',
|
||||||
|
'Some Date'
|
||||||
|
])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('falls back to NAME when LABEL is blank', () => {
|
||||||
|
const result = getDisplayColHeaders(['SOME_NUM'], cols, true)
|
||||||
|
expect(result).toEqual(['SOME_NUM'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('falls back to NAME when the column is missing from cols', () => {
|
||||||
|
const result = getDisplayColHeaders(
|
||||||
|
['SOME_CHAR', 'UNKNOWN_COL'],
|
||||||
|
cols,
|
||||||
|
true
|
||||||
|
)
|
||||||
|
expect(result).toEqual(['Some Character Column', 'UNKNOWN_COL'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('preserves colNames order, not cols order', () => {
|
||||||
|
const reordered = ['SOME_DATE', 'SOME_CHAR']
|
||||||
|
expect(getDisplayColHeaders(reordered, cols, true)).toEqual([
|
||||||
|
'Some Date',
|
||||||
|
'Some Character Column'
|
||||||
|
])
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,20 @@
|
|||||||
|
import { Col } from '../dc-validator/models/col.model'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Maps grid column names to their display headers.
|
||||||
|
*
|
||||||
|
* When `useLabels` is true, each name is swapped for its `LABEL` from `cols`
|
||||||
|
* (falling back to the NAME itself when a column has no LABEL, or isn't
|
||||||
|
* present in `cols` at all). Order always follows `colNames` (grid order).
|
||||||
|
*/
|
||||||
|
export function getDisplayColHeaders(
|
||||||
|
colNames: string[],
|
||||||
|
cols: Col[],
|
||||||
|
useLabels: boolean
|
||||||
|
): string[] {
|
||||||
|
if (!useLabels) return colNames
|
||||||
|
|
||||||
|
const labelsByName = new Map(cols.map((col) => [col.NAME, col.LABEL]))
|
||||||
|
|
||||||
|
return colNames.map((name) => labelsByName.get(name) || name)
|
||||||
|
}
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user