@nocobase/plugin-action-import 2.1.0-alpha.23 → 2.1.0-alpha.25

package/dist/node_modules/xlsx/types/index.d.ts

@@ -14,9 +14,9 @@ export const SSF: any;
 // export { CFB };
 export const CFB: any;
 
-/** Set internal `fs` instance */
+/** ESM ONLY! Set internal `fs` instance */
 export function set_fs(fs: any): void;
-/** Set internal codepage tables */
+/** ESM ONLY! Set internal codepage tables */
 export function set_cptable(cptable: any): void;
 
 /** NODE ONLY! Attempts to read filename and parse */
@@ -139,37 +139,12 @@ export interface DateNFOption {
     dateNF?: NumberFormat;
 }
 
-export interface UTCOption {
-    /**
-     * For plaintext formats, interpret ambiguous datetimes in UTC
-     * If explicitly set to `false`, dates will be parsed in local time.
-     *
-     * The `true` option is consistent with spreadsheet application export.
-     *
-     * @default true
-     */
-    UTC?: boolean;
-}
-
-export interface DenseOption {
-    /** If true, generate dense-mode worksheets */
-    dense?: boolean;
-}
-
 /** Options for read and readFile */
-export interface ParsingOptions extends UTCOption, CommonOptions, DenseOption {
+export interface ParsingOptions extends CommonOptions {
     /** Input data encoding */
     type?: 'base64' | 'binary' | 'buffer' | 'file' | 'array' | 'string';
 
-    /**
-     * Default codepage for legacy files
-     *
-     * This requires encoding support to be loaded.  It is automatically loaded
-     * in `xlsx.full.min.js` and in CommonJS / Extendscript, but an extra step
-     * is required in React / Angular / Webpack ESM deployments.
-     *
-     * Check the relevant guide https://docs.sheetjs.com/docs/getting-started/
-     */
+    /** Default codepage */
     codepage?: number;
 
     /**
@@ -238,24 +213,24 @@ export interface ParsingOptions extends UTCOption, CommonOptions, DenseOption {
     /** If true, plaintext parsing will not parse values */
     raw?: boolean;
 
-    /** If true, ignore "dimensions" records and guess range using every cell */
-    nodim?: boolean;
-
     /** If true, preserve _xlfn. prefixes in formula function names */
     xlfn?: boolean;
 
-    /**
-     * For single-sheet formats (including CSV), override the worksheet name
-     * @default "Sheet1"
-     */
-    sheet?: string;
+    dense?: boolean;
 
     PRN?: boolean;
 }
 
+export interface SheetOption {
+  /**
+   * Name of Worksheet (for single-sheet formats)
+   * @default ''
+   */
+  sheet?: string;
+}
 
 /** Options for write and writeFile */
-export interface WritingOptions extends CommonOptions {
+export interface WritingOptions extends CommonOptions, SheetOption {
     /** Output data encoding */
     type?: 'base64' | 'binary' | 'buffer' | 'file' | 'array' | 'string';
 
@@ -277,9 +252,6 @@ export interface WritingOptions extends CommonOptions {
      */
     compression?: boolean;
 
-    /** Overwride theme XML when exporting to XLSX/XLSM/XLSB */
-    themeXLSX?: string;
-
     /**
      * Suppress "number stored as text" errors in generated files
      * @default true
@@ -289,34 +261,8 @@ export interface WritingOptions extends CommonOptions {
     /** Override workbook properties on save */
     Props?: Properties;
 
-    /**
-     * Desired codepage for legacy file formats
-     *
-     * This requires encoding support to be loaded.  It is automatically loaded
-     * in `xlsx.full.min.js` and in CommonJS / Extendscript, but an extra step
-     * is required in React / Angular / Webpack / ESM deployments.
-     *
-     * Check the relevant guide https://docs.sheetjs.com/docs/getting-started/
-     */
-    codepage?: number;
-
     /** Base64 encoding of NUMBERS base for exports */
     numbers?: string;
-
-    /**
-     * For single-sheet formats, export the specified worksheet.
-     *
-     * The property must be a string (sheet name) or number (`SheetNames` index).
-     *
-     * If this option is omitted, the first worksheet will be exported.
-     */
-    sheet?: string | number;
-
-    /** Field Separator ("delimiter") for CSV / Text output */
-    FS?: string;
-
-    /** Record Separator ("row separator") for CSV / Text output */
-    RS?: string;
 }
 
 /** Workbook Object */
@@ -339,9 +285,6 @@ export interface WorkBook {
     Workbook?: WBProps;
 
     vbaraw?: any;
-
-    /** Original file type (when parsed with `read` or `readFile`) */
-    bookType?: BookType;
 }
 
 export interface SheetProps {
@@ -571,52 +514,20 @@ export type SheetKeys = string | MarginInfo | SheetType;
 /** General object representing a Sheet (worksheet or chartsheet) */
 export interface Sheet {
     /**
-     * Sparse-mode store cells with keys corresponding to A1-style address
-     * Dense-mode  store cells in the '!data' key
+     * Indexing with a cell address string maps to a cell object
      * Special keys start with '!'
      */
-    [cell: string]: CellObject | CellObject[][] | SheetKeys | any;
-
-    /**
-     * Dense-mode worksheets store data in an array of arrays
-     *
-     * Cells are accessed with sheet['!data'][R][C] (where R and C are 0-indexed)
-     */
-    '!data'?: CellObject[][];
+    [cell: string]: CellObject | SheetKeys | any;
 
     /** Sheet type */
     '!type'?: SheetType;
 
-    /** Sheet Range (A1-style) */
+    /** Sheet Range */
     '!ref'?: string;
 
     /** Page Margins */
     '!margins'?: MarginInfo;
 }
-/** General object representing a dense Sheet (worksheet or chartsheet) */
-export interface DenseSheet extends Sheet {
-    /**
-     * Special keys start with '!'
-     * Dense-mode worksheets store data in the '!data' key
-     */
-    [cell: string]: CellObject[][] | SheetKeys | any;
-
-    /**
-     * Dense-mode worksheets store data in an array of arrays
-     *
-     * Cells are accessed with sheet['!data'][R][C] (where R and C are 0-indexed)
-     */
-    '!data': CellObject[][];
-}
-/** General object representing a sparse Sheet (worksheet or chartsheet) */
-export interface SparseSheet extends Sheet {
-    /**
-     * Sparse-mode store cells with keys corresponding to A1-style address
-     * Cells are accessed with sheet[addr]
-     */
-    '!data': never;
-}
-
 
 /** AutoFilter properties */
 export interface AutoFilterInfo {
@@ -649,15 +560,6 @@ export interface WorkSheet extends Sheet {
     /** AutoFilter info */
     '!autofilter'?: AutoFilterInfo;
 }
-/** Dense Worksheet Object */
-export interface DenseWorkSheet extends DenseSheet {
-    /**
-     * Dense-mode worksheets store data in an array of arrays
-     *
-     * Cells are accessed with sheet['!data'][R][C] (where R and C are 0-indexed)
-     */
-    '!data': CellObject[][];
-}
 
 /**
  * Worksheet Object with CellObject type
@@ -676,7 +578,7 @@ export type ExcelDataType = 'b' | 'n' | 'e' | 's' | 'd' | 'z';
  * Type of generated workbook
  * @default 'xlsx'
  */
-export type BookType = 'xlsx' | 'xlsm' | 'xlsb' | 'xls' | 'xla' | 'biff8' | 'biff5' | 'biff2' | 'xlml' | 'ods' | 'fods' | 'csv' | 'txt' | 'sylk' | 'slk' | 'html' | 'dif' | 'rtf' | 'prn' | 'eth' | 'dbf' | 'numbers';
+export type BookType = 'xlsx' | 'xlsm' | 'xlsb' | 'xls' | 'xla' | 'biff8' | 'biff5' | 'biff2' | 'xlml' | 'ods' | 'fods' | 'csv' | 'txt' | 'sylk' | 'slk' | 'html' | 'dif' | 'rtf' | 'prn' | 'eth' | 'dbf';
 
 /** Comment element */
 export interface Comment {
@@ -725,9 +627,6 @@ export interface CellObject {
     /** Range of enclosing array if formula is array formula (if applicable) */
     F?: string;
 
-    /** If true, cell is a dynamic array formula (for supported file formats) */
-    D?: boolean;
-
     /** Rich text encoding (if applicable) */
     r?: any;
 
@@ -826,27 +725,9 @@ export interface Sheet2JSONOpts extends DateNFOption {
 
     /** if true, return raw numbers; if false, return formatted numbers */
     rawNumbers?: boolean;
-
-    /**
-     * If true, return dates whose UTC interpretation is correct
-     * By default, return dates whose local interpretation is correct
-     *
-     * @default false
-     */
-    UTC?: boolean;
-}
-
-export interface UTCDateOption {
-    /**
-     * If true, dates are interpreted using the UTC methods
-     * By default, dates are interpreted in the local timezone
-     *
-     * @default false
-     */
-    UTC?: boolean;
 }
 
-export interface AOA2SheetOpts extends CommonOptions, UTCDateOption, DateNFOption, DenseOption {
+export interface AOA2SheetOpts extends CommonOptions, DateNFOption {
     /**
      * Create cell objects for stub cells
      * @default false
@@ -856,7 +737,7 @@ export interface AOA2SheetOpts extends CommonOptions, UTCDateOption, DateNFOptio
 
 export interface SheetAOAOpts extends AOA2SheetOpts, OriginOption {}
 
-export interface JSON2SheetOpts extends CommonOptions, UTCDateOption, DateNFOption, OriginOption, DenseOption {
+export interface JSON2SheetOpts extends CommonOptions, DateNFOption {
     /** Use specified column order */
     header?: string[];
 
@@ -864,7 +745,9 @@ export interface JSON2SheetOpts extends CommonOptions, UTCDateOption, DateNFOpti
     skipHeader?: boolean;
 }
 
-export interface Table2SheetOpts extends CommonOptions, DateNFOption, OriginOption {
+export interface SheetJSONOpts extends JSON2SheetOpts, OriginOption {}
+
+export interface Table2SheetOpts extends CommonOptions, DateNFOption, OriginOption, SheetOption {
     /** If true, plaintext parsing will not parse values */
     raw?: boolean;
 
@@ -876,28 +759,6 @@ export interface Table2SheetOpts extends CommonOptions, DateNFOption, OriginOpti
 
     /** If true, hidden rows and cells will not be parsed */
     display?: boolean;
-
-    /**
-     * Override the worksheet name
-     * @default "Sheet1"
-     */
-    sheet?: string;
-
-    /**
-     * If true, interpret date strings as if they are UTC.
-     * By default, date strings are interpreted in the local timezone.
-     *
-     * @default false
-     */
-    UTC?: boolean;
-}
-
-export interface Table2BookOpts extends Table2SheetOpts {
-    /**
-     * Override the worksheet name
-     * @default "Sheet1"
-     */
-     sheet?: string;
 }
 
 /** General utilities */
@@ -914,7 +775,7 @@ export interface XLSX$Utils {
 
     /** BROWSER ONLY! Converts a TABLE DOM element to a worksheet. */
     table_to_sheet(data: any,  opts?: Table2SheetOpts): WorkSheet;
-    table_to_book(data: any,  opts?: Table2BookOpts): WorkBook;
+    table_to_book(data: any,  opts?: Table2SheetOpts): WorkBook;
     sheet_add_dom(ws: WorkSheet, data: any, opts?: Table2SheetOpts): WorkSheet;
 
     /* --- Export Functions --- */
@@ -936,6 +797,15 @@ export interface XLSX$Utils {
     /** Generates a list of the formulae (with value fallbacks) */
     sheet_to_formulae(worksheet: WorkSheet): string[];
 
+    /** Generates DIF */
+    sheet_to_dif(worksheet: WorkSheet, options?: Sheet2HTMLOpts): string;
+
+    /** Generates SYLK (Symbolic Link) */
+    sheet_to_slk(worksheet: WorkSheet, options?: Sheet2HTMLOpts): string;
+
+    /** Generates ETH */
+    sheet_to_eth(worksheet: WorkSheet, options?: Sheet2HTMLOpts): string;
+
     /* --- Cell Address Utilities --- */
 
     /** Converts 0-indexed cell address to A1 form */
@@ -968,14 +838,11 @@ export interface XLSX$Utils {
 
     /* --- General Utilities --- */
 
-    /** Create a new workbook */
-    book_new(ws?: WorkSheet, wsname?: string): WorkBook;
-
-    /** Create a new worksheet */
-    sheet_new(opts?: DenseOption): WorkSheet;
+    /** Creates a new workbook */
+    book_new(): WorkBook;
 
-    /** Append a worksheet to a workbook, returns new worksheet name */
-    book_append_sheet(workbook: WorkBook, worksheet: WorkSheet, name?: string, roll?: boolean): string;
+    /** Append a worksheet to a workbook */
+    book_append_sheet(workbook: WorkBook, worksheet: WorkSheet, name?: string, roll?: boolean): void;
 
     /** Set sheet visibility (visible/hidden/very hidden) */
     book_set_sheet_visibility(workbook: WorkBook, sheet: number|string, visibility: number): void;
@@ -1000,8 +867,8 @@ export interface XLSX$Utils {
     sheet_add_aoa(ws: WorkSheet, data: any[][], opts?: SheetAOAOpts): WorkSheet;
 
     /** Add an array of JS objects to a worksheet */
-    sheet_add_json(ws: WorkSheet, data: any[], opts?: JSON2SheetOpts): WorkSheet;
-    sheet_add_json<T>(ws: WorkSheet, data: T[], opts?: JSON2SheetOpts): WorkSheet;
+    sheet_add_json(ws: WorkSheet, data: any[], opts?: SheetJSONOpts): WorkSheet;
+    sheet_add_json<T>(ws: WorkSheet, data: T[], opts?: SheetJSONOpts): WorkSheet;
 
 
     consts: XLSX$Consts;