@sheetxl/sdk 0.7.27 → 0.7.28-beta.1

package/types/src/table/_TableColumn.d.ts

@@ -0,0 +1,51 @@
+import { ITransaction } from '../transaction';
+import { ICellRange } from '../cellRange';
+import { ISort } from '../sort';
+import { IFilter } from '../filter';
+import { ITable } from './ITable';
+import { ColumnPropertiesState } from './_TableUtils';
+export declare class TableColumn implements ITable.IColumn {
+    protected _table: ITable;
+    protected _id: number | string;
+    protected _getProps: (id: number | string) => ColumnPropertiesState;
+    protected _updateProps: (id: number | string, update: Partial<ITable.ColumnProperties> | null, options?: string | ITransaction.OperationOptions) => void;
+    protected _deleteSelf: (id: number | string, options?: ITransaction.OperationOptions) => void;
+    constructor(table: ITable, id: number | string, getProps: (id: number | string) => ColumnPropertiesState, updateProps: (id: number | string, update: Partial<ITable.ColumnProperties> | null, options?: string | ITransaction.OperationOptions) => void, deleteSelf: (id: number | string, options?: ITransaction.OperationOptions) => void);
+    /** {@inheritDoc ITable.IColumn.getTable} */
+    getTable(): ITable;
+    /** {@inheritDoc ITable.IColumn.getName} */
+    getName(): string;
+    /** {@inheritDoc ITable.IColumn.setName} */
+    setName(name: string): this;
+    /** {@inheritDoc ITable.IColumn.getId} */
+    getId(): string;
+    /** {@inheritDoc ITable.IColumn.getIndex} */
+    getIndex(): number;
+    /** {@inheritDoc ITable.IColumn.setTotalsRowLabel} */
+    setTotalsRowLabel(label: string): this;
+    /** {@inheritDoc ITable.IColumn.getTotalsRowLabel} */
+    getTotalsRowLabel(): string | null;
+    /** {@inheritDoc ITable.IColumn.setTotalsRowFormula} */
+    setTotalsRowFormula(formula: string | number | undefined): this;
+    /** {@inheritDoc ITable.IColumn.getTotalsRowFormula} */
+    getTotalsRowFormula(): string | number | null;
+    /** {@inheritDoc ITable.IColumn.getSort} */
+    getSort(): ISort | null;
+    /** {@inheritDoc ITable.IColumn.getFilter} */
+    getFilter(): IFilter | null;
+    /** {@inheritDoc ITable.IColumn.isHiddenButton} */
+    isHiddenButton(): boolean;
+    /** {@inheritDoc ITable.IColumn.setHiddenButton} */
+    setHiddenButton(hidden: boolean): this;
+    /** {@inheritDoc ITable.IColumn.getRange} */
+    getRange(): ICellRange;
+    /** {@inheritDoc ITable.IColumn.delete} */
+    delete(options?: ITransaction.OperationOptions): void;
+    /** {@inheritDoc ITable.IColumn.toJSON} */
+    toJSON(): ITable.ColumnJSON | null;
+    get [Symbol.toStringTag](): string;
+    toString(): string;
+    /** {@inheritDoc ITable.IColumn.isIColumn} */
+    get isIColumn(): true;
+}
+//# sourceMappingURL=_TableColumn.d.ts.map

package/types/src/table/_TableMessages.d.ts

@@ -0,0 +1,5 @@
+export declare const MODEL_DELETED = "Table has been deleted. No further operations are allowed.";
+export declare const MODEL_CLOSED = "Table has been closed. No further operations are allowed.";
+export declare const ERROR_GET_BY_NAME = "Get by name must take a valid name.";
+export declare const ERROR_TABLE_COLUMN_ID_IMMUTABLE = "Table column ID is immutable and can not be changed.";
+//# sourceMappingURL=_TableMessages.d.ts.map

package/types/src/table/_TableUtils.d.ts

@@ -0,0 +1,94 @@
+import { IRange } from '@sheetxl/primitives';
+import { ICondition } from '../condition';
+import { ISort } from '../sort';
+import { ITableStyle } from './ITableStyle';
+import { ITable } from './ITable';
+/**
+ * The default name a NEW table is created with, localized in the UI language
+ * (Excel de: `Tabelle1`), exactly like {@link defaultCreateSheetName}.
+ */
+export declare function defaultCreateTableName(index?: number): string;
+export declare const DEFAULT_HEADER_ROWS_COUNT = 1;
+export declare const DEFAULT_TOTALS_ROWS_COUNT = 0;
+/** The default name for a blank/empty table column (`Column`), localized at creation. */
+export declare function defaultEmptyColumnName(): string;
+/** The default label a table's totals row is created with (`Total`), localized at creation. */
+export declare function defaultTotalsRowLabel(): string;
+/** The default name for the implicit {@link AutoTable} (`AutoTable`), localized at creation. */
+export declare function defaultAutoTableName(): string;
+/** The default description for the implicit {@link AutoTable}, localized at creation. */
+export declare function defaultAutoTableDescription(): string;
+export type ColumnNamer = (name: string, index: number) => string;
+export declare function DefaultColumnNamer(name: string, index: number): string;
+export declare function toKey(name: string | null | undefined): string | null;
+export declare function deserializeRef(ref?: IRange.Coords | any): IRange.Coords;
+export declare const DefaultStyleOptions: ITableStyle.StyleOptions;
+/**
+ * Faster solution for normalize columns when empty.
+ */
+export declare function defaultColumns(count: number, emptyName?: string, emptyNamer?: ColumnNamer): ITable.ColumnProperties[];
+/**
+ * Ensure columns are in ITable.Column format.
+ */
+export declare function normalizeColumns(input: readonly (string | ITable.ColumnProperties | null)[] | null | undefined): ITable.ColumnProperties[];
+/**
+ * Creates new Columns for insert
+ *
+ * * **REVERSE ENGINEER** - Excel's behavior for preventing duplicates.
+ *
+ * @remarks
+ * **NOTE** Mutates the origColumns,
+ *
+ * @param origColumns
+ * @param start
+ * @param length
+ * @param emptyName
+ */
+export declare function insertColumns(origColumns: ITable.ColumnProperties[], start: number, length: number, emptyName?: string, emptyNamer?: ColumnNamer): ITable.ColumnProperties[];
+/**
+ * Creates unique table columns.
+ *
+ * @param origColumns The original columns in the table.
+ * @param newColumns The new columns to apply.
+ * @param start Where to start indexing from. All values before start are assumed to be depuped.
+ * @param preferBlanks If true, blanks are always given for empty names.
+ * @param emptyName The base name to use for empty columns.
+ * @param emptyNamer The function to use to generate names for empty columns.
+ *
+ * 1. case insensitive.
+ * 2. prevents duplicates.
+ *
+ * **REVERSE ENGINEER** - Excel's behavior for preventing duplicates.
+ *
+ * EmptyName: This is the name to use for blank or empty columns.
+ * DuplicateName: When a column has been given a value but it exists more than once.
+ * Offset: The number to append to make a name unique. (Both Blanks and Duplicates have different offsets)
+ *
+ * EmptyName vs DuplicateName Rules:
+ *    a. We determine the treatment of blank based on if the span length (length without blanks) of the previous columns.
+ *    b. If span length is 1 or less we generate a default name.
+ *    c. If span length is more than 1 we use the last used name and increment it.
+ *
+ * Increments Rules:
+ *   a. EmptyName increment is based on the largest existing increment for that name.
+ *   b. DuplicateName increment is based on the length of the previous column span + the largest (applied) EmptyName Offset.
+ */
+export declare function dedupColumns(origColumns: readonly (string | ITable.ColumnProperties | null)[] | null, newColumns: readonly (string | ITable.ColumnProperties | null)[], start?: number, preferBlanks?: boolean, emptyName?: string, emptyNamer?: ColumnNamer): ITable.ColumnProperties[];
+export declare function toColumnNames(columns: readonly (string | ITable.ColumnProperties)[]): string[];
+export declare function isEqualCols(a: readonly ITable.ColumnProperties[], b: readonly ITable.ColumnProperties[]): boolean;
+/**
+ * Used internally to reduce lookups
+ */
+export interface ColumnPropertiesState extends ITable.ColumnProperties {
+    index: number;
+    sortProps?: SortPropertiesState | null;
+    filterProps?: FilterPropertiesState | null;
+}
+export interface SortPropertiesState extends ISort.Options {
+    level: number;
+}
+export interface FilterPropertiesState {
+    condition: ICondition | null;
+    level: number;
+}
+//# sourceMappingURL=_TableUtils.d.ts.map

package/types/src/table/index.d.ts

@@ -0,0 +1,5 @@
+export * from './ITable';
+export * from './ITable';
+export * from './ITableStyle';
+export * from './ITableCollection';
+//# sourceMappingURL=index.d.ts.map

package/types/src/text/AutoNumberingScheme.d.ts

@@ -0,0 +1,175 @@
+export declare enum AutoNumberingSchemeType {
+    /**
+     * Lowercase alphabetic character enclosed in parentheses. Example: (a), (b),
+     * (c), ...
+     */
+    alphaLcParenBoth = 0,
+    /**
+     * Uppercase alphabetic character enclosed in parentheses. Example: (A), (B),
+     * (C), ...
+     */
+    alphaUcParenBoth = 1,
+    /**
+     * Lowercase alphabetic character followed by a closing parenthesis. Example:
+     * a), b), c), ...
+     */
+    alphaLcParenRight = 2,
+    /**
+     * Uppercase alphabetic character followed by a closing parenthesis. Example:
+     * A), B), C), ...
+     */
+    alphaUcParenRight = 3,
+    /**
+     * Lowercase Latin character followed by a period. Example: a., b., c., ...
+     */
+    alphaLcPeriod = 4,
+    /**
+     * Uppercase Latin character followed by a period. Example: A., B., C., ...
+     */
+    alphaUcPeriod = 5,
+    /**
+     * Arabic numeral enclosed in parentheses. Example: (1), (2), (3), ...
+     */
+    arabicParenBoth = 6,
+    /**
+     * Arabic numeral followed by a closing parenthesis. Example: 1), 2), 3), ...
+     */
+    arabicParenRight = 7,
+    /**
+     * Arabic numeral followed by a period. Example: 1., 2., 3., ...
+     */
+    arabicPeriod = 8,
+    /**
+     * Arabic numeral. Example: 1, 2, 3, ...
+     */
+    arabicPlain = 9,
+    /**
+     * Lowercase Roman numeral enclosed in parentheses. Example: (i), (ii), (iii),
+     * ...
+     */
+    romanLcParenBoth = 10,
+    /**
+     * Uppercase Roman numeral enclosed in parentheses. Example: (I), (II), (III),
+     * ...
+     */
+    romanUcParenBoth = 11,
+    /**
+     * Lowercase Roman numeral followed by a closing parenthesis. Example: i), ii),
+     * iii), ...
+     */
+    romanLcParenRight = 12,
+    /**
+     * Uppercase Roman numeral followed by a closing parenthesis. Example: I), II),
+     * III), ....
+     */
+    romanUcParenRight = 13,
+    /**
+     * Lowercase Roman numeral followed by a period. Example: i., ii., iii., ...
+     */
+    romanLcPeriod = 14,
+    /**
+     * Uppercase Roman numeral followed by a period. Example: I., II., III., ...
+     */
+    romanUcPeriod = 15,
+    /**
+     * Double byte circle numbers.
+     */
+    circleNumDbPlain = 16,
+    /**
+     * Wingdings black circle numbers.
+     */
+    circleNumWdBlackPlain = 17,
+    /**
+     * Wingdings white circle numbers.
+     */
+    circleNumWdWhitePlain = 18,
+    /**
+     * Double-byte Arabic numbers with double-byte period.
+     */
+    arabicDbPeriod = 19,
+    /**
+     * Double-byte Arabic numbers.
+     */
+    arabicDbPlain = 20,
+    /**
+     * Simplified Chinese with single-byte period.
+     */
+    ea1ChsPeriod = 21,
+    /**
+     * Simplified Chinese.
+     */
+    ea1ChsPlain = 22,
+    /**
+     * Traditional Chinese with single-byte period.
+     */
+    ea1ChtPeriod = 23,
+    /**
+     * Traditional Chinese.
+     */
+    ea1ChtPlain = 24,
+    /**
+     * Japanese with double-byte period.
+     */
+    ea1JpnChsDbPeriod = 25,
+    /**
+     * Japanese/Korean.
+     */
+    ea1JpnKorPlain = 26,
+    /**
+     * Japanese/Korean with single-byte period.
+     */
+    ea1JpnKorPeriod = 27,
+    /**
+     * Bidi Arabic 1 (AraAlpha) with ANSI minus symbol.
+     */
+    arabic1Minus = 28,
+    /**
+     * Bidi Arabic 2 (AraAbjad) with ANSI minus symbol.
+     */
+    arabic2Minus = 29,
+    /**
+     * Bidi Hebrew 2 with ANSI minus symbol.
+     */
+    hebrew2Minus = 30,
+    /**
+     * Thai alphabetic character followed by a period.
+     */
+    thaiAlphaPeriod = 31,
+    /**
+     * Thai alphabetic character followed by a closing parenthesis.
+     */
+    thaiAlphaParenRight = 32,
+    /**
+     * Thai alphabetic character enclosed by parentheses.
+     */
+    thaiAlphaParenBoth = 33,
+    /**
+     * Thai numeral followed by a period.
+     */
+    thaiNumPeriod = 34,
+    /**
+     * Thai numeral followed by a closing parenthesis.
+     */
+    thaiNumParenRight = 35,
+    /**
+     * Thai numeral enclosed in parentheses.
+     */
+    thaiNumParenBoth = 36,
+    /**
+     * Hindi alphabetic character followed by a period.
+     */
+    hindiAlphaPeriod = 37,
+    /**
+     * Hindi numeric character followed by a period.
+     */
+    hindiNumPeriod = 38,
+    /**
+     * Hindi numeric character followed by a closing parenthesis.
+     */
+    hindiNumParenRight = 39,
+    /**
+     * Hindi alphabetic character followed by a period.
+     */
+    hindiAlpha1Period = 40
+}
+//# sourceMappingURL=AutoNumberingScheme.d.ts.map

package/types/src/text/Bullet.d.ts

@@ -0,0 +1,34 @@
+import { Bounds } from '@sheetxl/utils';
+import { AutoNumberingSchemeType } from './AutoNumberingScheme';
+export interface IBullet {
+    readonly fontName: string;
+    readonly fontSize: number;
+    readonly autoNumberScheme: AutoNumberingSchemeType;
+    readonly startAt: number;
+    readonly character: string;
+    readonly imageScale: number;
+    readonly imageNaturalWidth: number;
+    readonly imageNaturalHeight: number;
+    readonly bounds?: Bounds;
+}
+export declare class DefaultBullet implements IBullet {
+    private _fontName;
+    private _fontSize;
+    private _autoNumberScheme;
+    private _startAt;
+    private _character;
+    private _imageScale;
+    private _imageNaturalWidth;
+    private _imageNaturalHeight;
+    private _bounds?;
+    get fontName(): string;
+    get fontSize(): number;
+    get autoNumberScheme(): AutoNumberingSchemeType;
+    get startAt(): number;
+    get character(): string;
+    get imageScale(): number;
+    get imageNaturalWidth(): number;
+    get imageNaturalHeight(): number;
+    get bounds(): Bounds | undefined;
+}
+//# sourceMappingURL=Bullet.d.ts.map

package/types/src/text/IText.d.ts

@@ -0,0 +1,53 @@
+import { ITextLine as _ITextLine } from './TextLine';
+import { ITextParagraph as _ITextParagraph } from './TextParagraph';
+import { ITextRun as _ITextRun } from './TextRun';
+import { IBullet as _IBullet } from './Bullet';
+/**
+ * Capabilities for working with text.
+ */
+export declare namespace IText {
+    type ITextLine = _ITextLine;
+    type ITextParagraph = _ITextParagraph;
+    type ITextRun = _ITextRun;
+    type IBullet = _IBullet;
+    /**
+     * Specifies capitalization options for text within a text frame.
+     */
+    const SmallCaps: {
+        /**
+         * Normal capitalization.
+         */
+        readonly None: "none";
+        /**
+         * Capitalize every letter but reduce the the size of all but the first letter.
+         *
+         * @see
+        {@link https://developer.mozilla.org/en-US/docs/Web/CSS/font-variant-caps}
+        */
+        readonly Small: "small";
+        /**
+         * Convert all text to uppercase.
+         */
+        readonly All: "all";
+    };
+    type SmallCaps = typeof SmallCaps[keyof typeof SmallCaps];
+    /**
+     * Indicate how and if a line will be drawing horizontally through the middle of the text.
+     */
+    const StrikeStyle: {
+        /**
+         * No strike-through
+         */
+        readonly None: "none";
+        /**
+         * A single line.
+         */
+        readonly Single: "single";
+        /**
+         * A double line.
+         */
+        readonly Double: "double";
+    };
+    type StrikeStyle = typeof StrikeStyle[keyof typeof StrikeStyle];
+}
+//# sourceMappingURL=IText.d.ts.map