@sheetxl/sdk 0.8.0-beta.1 → 0.8.0-beta.11

package/types/src/style/StyleCollection.d.ts

@@ -3,28 +3,35 @@ import { IListener } from '../listener';
 import { IColor } from '../color';
 import { ITheme } from '../theme';
 import { ITableStyle } from '../table';
-import { IStyle } from './IStyle';
+import { ICellStyle } from './ICellStyle';
 import { IStyleCollection } from './IStyleCollection';
+import { INamedStyleCollection } from './INamedStyleCollection';
+import { ITableStyleCollection } from './ITableStyleCollection';
+import { NamedStyleCollection } from './NamedStyleCollection';
+import { TableStyleCollection } from './TableStyleCollection';
+import { ISlicerStyleCollection } from './ISlicerStyleCollection';
+import { SlicerStyleCollection } from './SlicerStyleCollection';
+import { ISlicerStyle } from '../slicer/ISlicerStyle';
 import { ListenerEmitter } from '../listener/ListenerEmitter';
 interface PersistScopeState {
     byJSONs: Map<string, number>;
-    byIds: Map<number, IStyle.JSON>;
+    byIds: Map<number, ICellStyle.JSON>;
     openScopes: Set<PersistScope>;
 }
 declare class PersistScope implements IStyleCollection.IPersistScope {
     protected _state: PersistScopeState;
-    protected _normalJSON: IStyle.JSON;
-    protected _toJSONInternal: (jsonSheetStyleShared: IStyle.JSON[]) => IStyleCollection.JSON;
+    protected _normalJSON: ICellStyle.JSON;
+    protected _toJSONInternal: (jsonSheetStyleShared: ICellStyle.JSON[]) => IStyleCollection.JSON;
     protected _fromJSONInternal: (json: IStyleCollection.JSON) => void;
     protected _onLastEnd: () => void;
     protected _isClosed: boolean;
-    constructor(state: PersistScopeState, normalJSON: IStyle.JSON, toJSONInternal: (jsonSheetStyleShared: IStyle.JSON[]) => IStyleCollection.JSON, fromJSONInternal: (json: IStyleCollection.JSON) => void, onLastEnd: () => void);
+    constructor(state: PersistScopeState, normalJSON: ICellStyle.JSON, toJSONInternal: (jsonSheetStyleShared: ICellStyle.JSON[]) => IStyleCollection.JSON, fromJSONInternal: (json: IStyleCollection.JSON) => void, onLastEnd: () => void);
     /** {@inheritDoc IStyleCollection.IPersistScope.endPersist} */
     endPersist(): void;
     /** {@inheritDoc IStyleCollection.IPersistScope.getElementID} */
-    getElementID(json: IStyle.JSON): number | null;
+    getElementID(json: ICellStyle.JSON): number | null;
     /** {@inheritDoc IStyleCollection.IPersistScope.getElementJSON} */
-    getElementJSON(id: number): IStyle.JSON;
+    getElementJSON(id: number): ICellStyle.JSON;
     /** {@inheritDoc IStyleCollection.IPersistScope.fromJSON} */
     fromJSON(json: IStyleCollection.JSON): void;
     /** {@inheritDoc IStyleCollection.IPersistScope.toJSON} */
@@ -42,25 +49,65 @@ export declare class StyleCollection implements IStyleCollection {
     protected _defaultFontSize: number;
     protected _schemeLookup: IColor.SchemeLookup;
     protected _indexedLookup: IColor.IndexedLookup;
-    protected _builtInsCellStyles: Map<string, IStyle.INamed>;
-    protected _customCellStyles: Map<string, IStyle.INamed>;
-    protected _builtInsTableStyles: Map<string, ITableStyle>;
+    /**
+     * The built-in named styles, keyed by lower-cased name in definition order. Only `Normal` is
+     * built at construction; the rest on first need — see {@link _ensureBuiltInCellStyles}.
+     */
+    protected _builtInsCellStyles: Map<string, ICellStyle.INamed>;
+    protected _builtInsCellStylesComplete: boolean;
+    protected _customCellStyles: Map<string, ICellStyle.INamed>;
+    /** The built-in table styles, keyed by lower-cased name; built on first need. */
+    protected _builtInsTableStyles: Map<string, ITableStyle> | null;
     protected _customTableStyles: Map<string, ITableStyle>;
     protected _emptyTableStyle: ITableStyle.Empty;
     protected _customIndexedColors: readonly IColor[];
     protected _mruColors: readonly IColor[];
-    protected _normalStyle: IStyle;
-    protected _normalRanged: IProperties.ICellRanged<IStyle.Properties>;
+    protected _normalStyle: ICellStyle;
+    protected _normalRanged: IProperties.ICellRanged<ICellStyle.Properties>;
     protected _defaultTableStyle: ITableStyle | null;
+    protected _namedStyles: NamedStyleCollection;
+    protected _tableStyles: TableStyleCollection;
+    /** The built-in slicer styles, keyed by lower-cased name; built on first need. */
+    protected _builtInSlicerStyles: Map<string, ISlicerStyle> | null;
+    protected _customSlicerStyles: Map<string, ISlicerStyle>;
+    /** The default slicer style's name, resolved on each read so a replaced or deleted style is not held. */
+    protected _defaultSlicerStyleName: string;
+    protected _slicerStyles: SlicerStyleCollection;
     protected _persistCache: PersistScopeState | null;
     constructor(theme?: ITheme | null, indexedColors?: string[] | null, defaultFontSize?: number);
-    protected _initializeNamedStyles(namedStyles: readonly IStyle.Properties[], builtInStyleMap: Map<string, IStyle.INamed>): void;
+    /** {@inheritDoc IStyleCollection.getNamedStyles} */
+    getNamedStyles(): INamedStyleCollection;
+    /** {@inheritDoc IStyleCollection.getTableStyles} */
+    getTableStyles(): ITableStyleCollection;
+    /** {@inheritDoc IStyleCollection.getSlicerStyles} */
+    getSlicerStyles(): ISlicerStyleCollection;
+    /** The built-in slicer styles, built on the first call. */
+    protected _ensureBuiltInSlicerStyles(): Map<string, ISlicerStyle>;
+    protected _setCustomSlicerStyleInternal(name: string, properties: Omit<ISlicerStyle.ResolvableProperties, 'name'>): ISlicerStyle;
+    protected _deleteCustomSlicerStyle(name: string): void;
+    /** The write behind {@link ISlicerStyleCollection.setDefault}; returns the previous default. */
+    protected _setDefaultSlicerStyle(style: ISlicerStyle | string): ISlicerStyle;
+    /** The read behind {@link ISlicerStyleCollection.getDefault}. */
+    protected _getDefaultSlicerStyle(): ISlicerStyle;
+    /**
+     * Builds the built-in named styles from `from` on, into the map in definition order.
+     */
+    protected _initializeNamedStyles(namedStyles: readonly ICellStyle.Properties[], builtInStyleMap: Map<string, ICellStyle.INamed>, from?: number, to?: number): void;
     protected _initializeTableStyles(): Map<string, ITableStyle>;
+    /**
+     * Builds what every collection needs at once: `Normal` (the base of every style) and the
+     * empty table style. The other built-ins wait for a first need — most collections are the
+     * fallback a detached item constructs and never ask for a gallery.
+     */
     protected _initializeBuiltIns(): void;
+    /** The built-in named styles, all of them, built on the first call. */
+    protected _ensureBuiltInCellStyles(): Map<string, ICellStyle.INamed>;
+    /** The built-in table styles, built on the first call. */
+    protected _ensureBuiltInTableStyles(): Map<string, ITableStyle>;
     /** {@inheritDoc IStyleCollection.getNormal} */
-    getNormal(): IStyle;
+    getNormal(): ICellStyle;
     /** {@inheritDoc IStyleCollection.getNormalRanged} */
-    getNormalRanged(): IProperties.ICellRanged<IStyle.Properties>;
+    getNormalRanged(): IProperties.ICellRanged<ICellStyle.Properties>;
     /** {@inheritDoc IStyleCollection.setTheme} */
     setTheme(theme: ITheme): void;
     /** {@inheritDoc IStyleCollection.getTheme} */
@@ -72,31 +119,37 @@ export declare class StyleCollection implements IStyleCollection {
     /** {@inheritDoc IStyleCollection.beginPersist} */
     beginPersist(): IStyleCollection.IPersistScope;
     /** {@inheritDoc IStyleCollection.getNamed} */
-    getNamed(name: string | IStyle.BuiltInName): IStyle.INamed | null;
+    getNamed(name: string | ICellStyle.BuiltInName): ICellStyle.INamed | null;
     /** {@inheritDoc IStyleCollection.getCustomNamed} */
-    getCustomNamed(): IStyle.INamed[];
+    getCustomNamed(): ICellStyle.INamed[];
     /** {@inheritDoc IStyleCollection.setNamed} */
-    setNamed(modifiers: IStyle.NamedUpdate, mergeIfExists?: boolean): IStyle.INamed;
-    protected _setCustomCellStyleInternal(modifiers: IStyle.NamedUpdate, mergeIfExists?: boolean, _i?: number | null): IStyle.INamed;
+    setNamed(modifiers: ICellStyle.NamedUpdate, mergeIfExists?: boolean): ICellStyle.INamed;
+    /** The validated write behind {@link INamedStyleCollection.set}; the collection announces it. */
+    protected _setNamedStyle(modifiers: ICellStyle.NamedUpdate, mergeIfExists?: boolean): ICellStyle.INamed;
+    protected _setCustomCellStyleInternal(modifiers: ICellStyle.NamedUpdate, mergeIfExists?: boolean, _i?: number | null): ICellStyle.INamed;
     protected _setCustomTableStyleInternal(name: string, properties: ITableStyle.ResolvableProperties): ITableStyle;
-    protected _hideOrRemoveNamed(style: IStyle.INamed | string): boolean;
+    protected _hideOrRemoveNamed(style: ICellStyle.INamed | string): boolean;
     /** {@inheritDoc IStyleCollection.getTableStyle} */
-    getTableStyle(name: string): ITableStyle | null;
+    getTableStyle(name?: string): ITableStyle | null;
     /** {@inheritDoc IStyleCollection.getCustomTableStyles} */
     getCustomTableStyles(): ITableStyle[];
     /** {@inheritDoc IStyleCollection.setDefaultTableStyle} */
-    setDefaultTableStyle(styleName: string): boolean;
+    setDefaultTableStyle(styleName: string): void;
     /** {@inheritDoc IStyleCollection.getDefaultTableStyle} */
     getDefaultTableStyle(): ITableStyle;
-    protected _deleteCustomTableStyle(styleName: string): boolean;
     /** {@inheritDoc IStyleCollection.setCustomTableStyle} */
     setCustomTableStyle(name: string, properties: ITableStyle.ResolvableProperties): ITableStyle;
+    /** The write behind {@link ITableStyleCollection.setDefault}; returns the previous default. */
+    protected _setDefaultTableStyle(style: ITableStyle | string): ITableStyle;
+    /** The read behind {@link ITableStyleCollection.getDefault}. */
+    protected _getDefaultTableStyle(): ITableStyle;
+    protected _deleteCustomTableStyle(styleName: string): boolean;
     /** {@inheritDoc IStyleCollection.validateStyleName} */
     validateStyleName(name: string, checkDuplicates?: boolean): void;
     /** {@inheritDoc IStyleCollection.normalize} */
-    normalize(values: IStyle.Modifiers, name?: string): Partial<IStyle.Properties>;
+    normalize(values: ICellStyle.Modifiers, name?: string): Partial<ICellStyle.Properties>;
     /** {@inheritDoc IStyleCollection.resolve} */
-    resolve(values: IStyle.Modifiers, name?: string): Partial<IStyle.Properties>;
+    resolve(values: ICellStyle.Modifiers, name?: string): Partial<ICellStyle.Properties>;
     /** {@inheritDoc IStyleCollection.schemeLookup} */
     schemeLookup(): IColor.SchemeLookup;
     /** {@inheritDoc IStyleCollection.indexedLookup} */
@@ -117,9 +170,11 @@ export declare class StyleCollection implements IStyleCollection {
     getIndexedColors(): readonly IColor[];
     /** {@inheritDoc IListener.ISource.addListeners} */
     addListeners(listeners: IStyleCollection.IListeners, options?: IListener.Options): IListener.Remove;
-    protected _toJSONInternal(jsonSheetStyleShared: IStyle.JSON[]): IStyleCollection.JSON;
+    protected _toJSONInternal(jsonSheetStyleShared: ICellStyle.JSON[]): IStyleCollection.JSON;
     protected _fromJSONIndexedColors(indexedColors: string[] | null | undefined): IColor[];
     protected _fromJSONInternal(json: IStyleCollection.JSON): void;
+    /** {@inheritDoc IStyleCollection.isIStyleCollection} */
+    get isIStyleCollection(): true;
 }
 export {};
 //# sourceMappingURL=StyleCollection.d.ts.map

package/types/src/style/TableStyleCollection.d.ts

@@ -0,0 +1,49 @@
+import { AbstractCollection } from '../type';
+import { ITableStyle } from '../table';
+import { ITableStyleCollection } from './ITableStyleCollection';
+/**
+ * Implementation for {@link ITableStyleCollection}.
+ *
+ * @remarks
+ * A front over the {@link StyleCollection}'s maps — the style collection keeps the definitions
+ * (they resolve against its theme) and this class keeps the API and the announcing.
+ */
+export declare class TableStyleCollection extends AbstractCollection<ITableStyle, ITableStyleCollection.GetItemsOptions> implements ITableStyleCollection {
+    private _host;
+    constructor(host: TableStyleCollection.Host);
+    /** {@inheritDoc AbstractCollection._getItems} */
+    protected _getItems(options?: ITableStyleCollection.GetItemsOptions): ITableStyle[];
+    /** {@inheritDoc ITableStyleCollection.getByName} */
+    getByName(name: string): ITableStyle | null;
+    /** {@inheritDoc ITableStyleCollection.set} */
+    set(name: string, properties: ITableStyle.ResolvableProperties): ITableStyle;
+    /** {@inheritDoc ITableStyleCollection.getDefault} */
+    getDefault(): ITableStyle;
+    /** {@inheritDoc ITableStyleCollection.setDefault} */
+    setDefault(style: ITableStyle | string): ITableStyle;
+    /** {@inheritDoc ITableStyleCollection.getNone} */
+    getNone(): ITableStyle;
+    /**
+     * Announces a change the host made itself — a custom style deleted, a load.
+     * @internal
+     */
+    _announceChange(): void;
+    /** {@inheritDoc ITableStyleCollection.isITableStyleCollection} */
+    get isITableStyleCollection(): true;
+}
+export declare namespace TableStyleCollection {
+    /**
+     * What the style collection lends this front: its maps, keyed by lower-cased name and in
+     * gallery order, the default, and the writes that need its resolvers.
+     */
+    interface Host {
+        builtIns(): ReadonlyMap<string, ITableStyle>;
+        customs(): ReadonlyMap<string, ITableStyle>;
+        set(name: string, properties: ITableStyle.ResolvableProperties): ITableStyle;
+        getDefault(): ITableStyle;
+        /** Returns the previous default. */
+        setDefault(style: ITableStyle | string): ITableStyle;
+        getNone(): ITableStyle;
+    }
+}
+//# sourceMappingURL=TableStyleCollection.d.ts.map

package/types/src/style/_BuiltInStyleDefs.d.ts

@@ -1,18 +1,19 @@
-import { ITextFrame, IStyledFont } from '../text';
-import { IBorder } from '../border';
-import { IStyle } from './IStyle';
+import { IFontStyle } from '../font';
+import { ITextFrame } from '../text';
+import { IBorders } from '../border';
 import { ICellProtection } from '../cell';
+import { ICellStyle } from './ICellStyle';
 /**
  * To avoid duplicating values.
  */
-export declare const _EmptyFontProperties: IStyledFont.Properties;
-export declare const _EmptyBorderStrokeProperties: IBorder.StrokeProperties;
-export declare const _EmptyBorderProperties: IBorder.Properties;
+export declare const _EmptyFontProperties: IFontStyle.Properties;
+export declare const _EmptyBorderStrokeProperties: IBorders.StrokeProperties;
+export declare const _EmptyBorderProperties: IBorders.Properties;
 export declare const _EmptyAlignmentProperties: ITextFrame.IAlignment.Properties;
 export declare const _EmptyProtectionProperties: ICellProtection.Properties;
 /**
  * Because all cells derived from the empty cell this is also the default values.
  */
-export declare const _EmptyCellStyleProperties: IStyle.Properties<any>;
-export declare const _BuiltInStyleDefs: readonly IStyle.Properties[];
+export declare const _EmptyCellStyleProperties: ICellStyle.Properties<any>;
+export declare const _BuiltInStyleDefs: readonly ICellStyle.Properties[];
 //# sourceMappingURL=_BuiltInStyleDefs.d.ts.map

package/types/src/style/_BuiltInStyleNames.d.ts

@@ -1,7 +1,7 @@
 /**
  * A localized-display descriptor for a built-in style name: a catalog message
  * key plus optional ICU params. Resolve it at the display boundary with
- * `t(key, params)`; the canonical {@link IStyle.BuiltInName} stays the identity.
+ * `t(key, params)`; the canonical {@link ICellStyle.BuiltInName} stays the identity.
  */
 export interface BuiltInStyleNameDisplay {
     key: string;
@@ -12,7 +12,7 @@ export interface BuiltInStyleNameDisplay {
  * `null` for a custom / non-built-in name (render its raw name unchanged).
  *
  * @remarks
- * The canonical {@link IStyle.BuiltInName} remains the API/storage identity; this
+ * The canonical {@link ICellStyle.BuiltInName} remains the API/storage identity; this
  * only maps it to a display string. Headings and accent tints compose via ICU
  * params (`Heading {n}`, `{pct}% - Accent{n}`) so each locale ships one template.
  */

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

@@ -1,5 +1,11 @@
-export * from './IStyle';
+export * from './ICellStyle';
 export * from './IStyleCollection';
+export * from './INamedStyleCollection';
+export * from './ITableStyleCollection';
+export * from './ISlicerStyleCollection';
 export * from './_BuiltInStyleNames';
 export * from './StyleCollection';
+export * from './NamedStyleCollection';
+export * from './TableStyleCollection';
+export * from './SlicerStyleCollection';
 //# sourceMappingURL=index.d.ts.map