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

package/types/src/cellRange/_GraphNode.d.ts

@@ -1,38 +0,0 @@
-import { ICellRanges } from './ICellRanges';
-/**
- * The calculation-side backing for an anchored name node in a graph answer.
- *
- * @internal
- *
- * @remarks
- * A defined name appearing in a precedents/dependents walk is a node `(nameId, anchor)`: the id
- * carries the identity, the anchor carries the coords that let it ride in an `ICellRanges` beside
- * ordinary cell ranges (see DESIGN-NAMED-FORMULAS.md §4). The calculation layer knows the graph;
- * the sheet layer knows how to be a range — this is the seam between them, so neither imports the
- * other's classes.
- */
-export interface _NamedGraphNode {
-    /** The name's stable id — also the id of the virtual grid its body compiles into. */
-    id: string;
-    /** The name as authored, unqualified. Scope qualification is the view's job, led by the id. */
-    name: string;
-    /**
-     * The anchor sheet's display NAME, or `null` when it cannot be resolved (a file-loaded name
-     * whose defining sheet is unknowable) — the consumer picks a default sheet then.
-     */
-    sheetName: string | null;
-    /** The anchor cell — the name's defining cell (the active cell at authoring time). */
-    rowIndex: number;
-    colIndex: number;
-    /** Every range the name DESIGNATES (`INamed.getRanges`) — plural for union refers-tos, `null` for a value name. */
-    ranges(): ICellRanges | null;
-    /** What the body reads at the defining anchor — cells and names, one hop. */
-    directPrecedents(): ICellRanges | null;
-    /** {@link directPrecedents} walked to exhaustion across both graphs. */
-    precedents(): ICellRanges | null;
-    /** The node's dependents in NAME semantics — cells and names, one symbol hop. */
-    directDependents(): ICellRanges | null;
-    /** {@link directDependents} walked to exhaustion across both graphs. */
-    dependents(): ICellRanges | null;
-}
-//# sourceMappingURL=_GraphNode.d.ts.map

package/types/src/collections/OverlappingRangeIterator.d.ts

@@ -1,91 +0,0 @@
-import { RangeAxis, RangeCoords, CellCoords, RangeCoordValue } from '@sheetxl/utils';
-/**
- * Iterate over a collection of overlapping RangeCoords.
- *
- * This will iterator over CellCoords or RangeCoords.
- */
-type ESIterator<T, TReturn = any, TNext = undefined> = Iterator<T, TReturn, TNext>;
-export declare namespace OverlappingRange {
-    interface IteratorOptions {
-        /**
-         * The direction of the scan.
-         * @defaultValue RangeAxis.Row
-         */
-        axis?: RangeAxis;
-        /**
-         * Set iterator to increment by cells within an intersection.
-         *
-         * @defaultValue false
-         *
-         * @remarks
-         * Depending on the range intersect it is possible that some scan lines will be duplicated.
-         * This is desired as it makes merging ranges easier/possible.
-         */
-        byCell?: boolean;
-        /**
-         * Iterate in reverse order.
-         * @defaultValue false
-         */
-        reverse?: boolean;
-        /**
-         * If provided then iterator results will reuse the return results.
-         *
-         * @defaultValue `undefined` (Creates new instances for each iterator)
-         *
-         * @remarks
-         * - **Performance:** Setting this to `true` can drastically improve performance for large ranges,
-         *   but it will modify the original range data.
-         * - **Safety:**  If you need to preserve the original range data, set this to `false`.
-         */
-        reuseIterator?: boolean | IteratorResult<OverlappingRange.Intersection>;
-    }
-    /**
-     * When iterating a cursor is used to track the
-     * current location. The coords will always move forward.
-     */
-    interface Intersection {
-        /**
-         * The current coords.
-         */
-        cell: CellCoords;
-        /**
-         * This is a non-overlapping virtual range.
-         *
-         * @remarks
-         * This is not guaranteed to be the smallest packing size.
-         */
-        range: RangeCoords;
-        /**
-         * All ranges at the intersection. This may be a single range.
-         */
-        overlaps: RangeCoordValue[];
-    }
-    type Iterator = ESIterator<Intersection, Intersection, CellCoords>;
-    class IteratorInstance implements Iterator, IterableIterator<Intersection> {
-        private _isColumn;
-        private _isByCell;
-        private _isReverse;
-        private _cursor;
-        private _reuse;
-        private _localReuse;
-        private _eventsMajor;
-        private _eventMajorIndex;
-        private _majorStart;
-        private _majorEnd;
-        private _eventsMinor;
-        private _eventsMinorIterator;
-        private _eventMinorPeek;
-        private _minorStart;
-        private _minorEnd;
-        constructor(ranges: readonly RangeCoordValue[], options?: IteratorOptions);
-        /**
-         * Returns the next Intersection as a IteratorResult.
-         */
-        next(nextCell?: CellCoords): IteratorResult<Intersection>;
-        return(_value?: Intersection): IteratorResult<Intersection>;
-        throw(_e?: any): IteratorResult<Intersection>;
-        [Symbol.iterator](): IterableIterator<Intersection>;
-    }
-}
-export {};
-//# sourceMappingURL=OverlappingRangeIterator.d.ts.map

package/types/src/condition/BuiltinSelectors/ListSelector.d.ts

@@ -1,12 +0,0 @@
-import { Scalar } from '@sheetxl/primitives';
-import { ICondition } from '../ICondition';
-import { BaseSelector, ConstructorOptions } from './BaseSelector';
-/**
- * ListSelector:
- */
-export declare class ListSelector<T extends Scalar = Scalar, I extends Scalar = T> extends BaseSelector<T, I> implements ICondition.IListSelector<T, I> {
-    constructor(options: ConstructorOptions);
-    /** {@inheritDoc ICondition.IListSelector.isList} */
-    get isList(): true;
-}
-//# sourceMappingURL=ListSelector.d.ts.map

package/types/src/dataValidation/_Utils.d.ts

@@ -1,10 +0,0 @@
-declare class ValidationMask {
-    private readonly bytes;
-    readonly length: number;
-    constructor(length: number);
-    setInvalid(index: number): void;
-    clearInvalid(index: number): void;
-    isInvalid(index: number): boolean;
-    clearAll(): void;
-}
-//# sourceMappingURL=_Utils.d.ts.map

package/types/src/font/CanvasFontMeasurer.d.ts

@@ -1,25 +0,0 @@
-import { IFont } from './IFont';
-/**
- * A canvas based getTextMetrics.
- *
- * Canvas has limited support for font metrics we can do css sniffing to find lineGap but all
- * rendering values (underline offset/width, stroke offset/width, subSetting, italic angle, etc)
- * are not available in browsers.
- *
- * To this end we approximate.
- * * lineGap.
- * * underlineOffset
- * * underlineWidth
- * * stroke offset
- *
- */
-export declare function CanvasFontMeasurer(text: string, size: number, family: string, options?: IFont.MetricOptions | null): IFont.ExtendedMetrics;
-export declare function getInstance(): IFont.Measurer;
-/**
- * Returns scaling to use for the current device.
- *
- * @remarks
- * **TODO** This is hardcoded to Non-HD DPI. Revisit.
- */
-export declare function getDeviceScale(): number;
-//# sourceMappingURL=CanvasFontMeasurer.d.ts.map

package/types/src/font/FontKitFontMeasurer.d.ts

@@ -1,11 +0,0 @@
-import { IFont } from './IFont';
-export declare function setFontFolder(path: string): void;
-/**
- * TODO - use fs selection to determine:
- * 1. panose
- * 2. if bold, italic
- */
-export declare function FontKitFontMeasurer(text: string, size: number, family: string, options?: IFont.MetricOptions | null): IFont.ExtendedMetrics;
-export declare function getInstance(): IFont.Measurer;
-export declare function getDeviceScale(): number;
-//# sourceMappingURL=FontKitFontMeasurer.d.ts.map

package/types/src/font/SimpleFontMeasurer.d.ts

@@ -1,4 +0,0 @@
-import { IFont } from './IFont';
-export declare function getInstance(): IFont.Measurer;
-export declare function getDeviceScale(): number;
-//# sourceMappingURL=SimpleFontMeasurer.d.ts.map

package/types/src/lib/utils/_Utils.d.ts

@@ -1,27 +0,0 @@
-/**
- * Two-tier node fingerprint.
- * - `stable`: hash of fields unlikely to change (arch, osType, platform, memoryGB).
- *   Used for hard enforcement.
- * - `full`: hash that also includes hostname.
- *   Passes silently if stable matches but full diverges (hostname rename, container re-creation).
- */
-export interface NodeFingerprint {
-    stable: string;
-    full: string;
-}
-export interface HostDetails {
-    cpus?: number;
-    memoryGB?: number;
-    domain?: string | null;
-    fingerprint?: NodeFingerprint;
-}
-/**
- * A placeholder license key: the "evaluation" spellings a caller may pass to
- * `LicenseManager.setLicenseKey` to run unlicensed on purpose (`eval`, `trial`, or the
- * `visit …`/`email …` pointer text a starter template ships with). These select an evaluation
- * license; they are never keys, so the persistent key store ignores them.
- */
-export declare function isPlaceholderLicenseKey(key: string | null | undefined): boolean;
-export declare function getBuildVersion(): string;
-export declare function getBuildDate(): string;
-//# sourceMappingURL=_Utils.d.ts.map

package/types/src/lib/utils/utils.browser.d.ts

@@ -1,33 +0,0 @@
-import { HostDetails } from './_Utils';
-import { LicenseDetails } from '../../license';
-export declare function getHostDetails(): Promise<HostDetails>;
-/**
- * Only the loopback host is a dev environment. A dev *build* served on any other host (a LAN IP,
- * a tunnel) is checked exactly like production: license domains apply and an evaluation shows
- * the watermark.
- */
-export declare function isDevEnv(): Promise<boolean>;
-/**
- * The runtime location - the current page url in the browser.
- */
-export declare function getLocation(): string;
-/**
- * The OS platform, used by the `INFO("system")` formula.
- */
-export declare function getOS(): string;
-export declare function findLicenseKey(): Promise<{
-    key: string;
-    from: string;
-} | null>;
-export declare function setKey(key: string, force?: boolean): Promise<void>;
-export declare function getKey(): Promise<string>;
-export declare function printBanner(isUser: boolean): Promise<void>;
-/**
- * The browser always gets the full banner — there is no piped output to protect, and
- * the console collapses repeats. (See the node variant for the throttled CLI behavior.)
- */
-export declare function claimFullLicensePrint(): Promise<boolean>;
-/** The one-line form of the unlicensed notice; in the browser only the activation pointer. */
-export declare function printLicenseNotice(): Promise<void>;
-export declare function printDetails(details: LicenseDetails, isUser?: boolean, expanded?: boolean, ignoreExceptions?: boolean): Promise<void>;
-//# sourceMappingURL=utils.browser.d.ts.map

package/types/src/movable/IGroup.d.ts

@@ -1,30 +0,0 @@
-import { IListener } from '../listener';
-import { IResource } from '../resource';
-import { IModel } from '../model';
-/**
- * Interface for working with Groups.
- *
- * @remarks
- * **PLACEHOLDER**
- */
-export interface IGroup extends IModel {
-    toJSON(toResourceId?: (resource: IResource) => number): IGroup.JSON;
-    getDescription(): string;
-}
-/**
- * {@inheritDoc IGroup}
- * @see
- * ### **Interface**
- *
- * {@link IGroup}
- */
-export declare namespace IGroup {
-    interface JSON {
-        grpSp?: any;
-    }
-    interface Events extends IModel.Events {
-    }
-    interface IListeners extends IListener.Callbacks<IGroup, IGroup.Events> {
-    }
-}
-//# sourceMappingURL=IGroup.d.ts.map

package/types/src/movable/IMovableSelection.d.ts

@@ -1,49 +0,0 @@
-import { IListener } from '../listener';
-import { IMovable } from './IMovable';
-/**
- * Manages a selection of `IMovable`s.
- */
-export interface IMovableSelection extends IListener.ISource<IMovableSelection> {
-    /**
-     * The movable selection.
-     */
-    getMovableSelection(): readonly IMovable[];
-    /**
-     * Select a movable object.
-     *
-     * @param movables
-     * @param addToSelection
-     */
-    selectMovables(movables: readonly IMovable[], addToSelection?: boolean): this;
-    /**
-     * Returns the movable from the selection.
-     *
-     * @param movables
-     */
-    unselectMovables(movables: IMovable[]): this;
-    /**
-     * Add Listeners.
-     *
-     * @see
-     * {@link IListener.ISource.addListeners}
-     */
-    addListeners(listeners: IMovableSelection.IListeners, options?: IListener.Options): IListener.Remove;
-}
-/**
- * {@inheritDoc IMovableSelection}
- * @see
- * ### **Interface**
- *
- * {@link IMovableSelection}
- */
-export declare namespace IMovableSelection {
-    interface Events {
-        /**
-         * Called when the selection has changed.
-         */
-        onMovableSelectionChange?(source: IMovableSelection): void;
-    }
-    interface IListeners extends IListener.Callbacks<IMovableSelection, IMovableSelection.Events> {
-    }
-}
-//# sourceMappingURL=IMovableSelection.d.ts.map

package/types/src/print/IPrint.d.ts

@@ -1,234 +0,0 @@
-import { IRange } from '@sheetxl/primitives';
-/**
- * Namespace for print-related configurations and settings.
- */
-export declare namespace IPrint {
-    /**
-     * Interface representing multi-page print options.
-     */
-    interface MultiPage {
-        /**
-         * Whether content should be aligned with the page margins.
-         */
-        alignWithMargins?: boolean;
-        /**
-         * Specifies if the first page is different from subsequent pages.
-         */
-        differentFirst?: boolean;
-        /**
-         * Specifies if odd and even pages should have different settings.
-         */
-        differentOddEven?: boolean;
-        /**
-         * Whether the content should scale proportionally with the document.
-         */
-        scaleWithDoc?: boolean;
-    }
-    /**
-     * Interface for configuring headers and footers for print, supporting
-     * different settings for first, odd, and even pages.
-     */
-    interface HeaderFooter extends MultiPage {
-        /**
-         * Configuration for general header and footer settings.
-         */
-        headerFooter?: MultiPage;
-        /**
-         * Configuration for the footer on even pages.
-         */
-        evenFooter?: MultiPage;
-        /**
-         * Configuration for the header on even pages.
-         */
-        evenHeader?: MultiPage;
-        /**
-         * Configuration for the footer on the first page.
-         */
-        firstFooter?: MultiPage;
-        /**
-         * Configuration for the header on the first page.
-         */
-        firstHeader?: MultiPage;
-        /**
-         * Configuration for the footer on odd pages.
-         */
-        oddFooter?: MultiPage;
-        /**
-         * Configuration for the header on odd pages.
-         */
-        oddHeader?: MultiPage;
-    }
-    /**
-     * Interface representing the margins of a printed page, specified in inches.
-     */
-    interface PageMargin {
-        /**
-         * Margin from the bottom of the page.
-         */
-        bottom?: number;
-        /**
-         * Distance of the footer from the bottom of the page.
-         */
-        footer: number;
-        /**
-         * Distance of the header from the top of the page.
-         */
-        header: number;
-        /**
-         * Margin from the left side of the page.
-         */
-        left: number;
-        /**
-         * Margin from the right side of the page.
-         */
-        right: number;
-        /**
-         * Margin from the top of the page.
-         */
-        top: number;
-    }
-    /**
-     * Interface for configuring page setup options for print.
-     */
-    interface PageSetup {
-        /**
-         * Whether to print in black and white.
-         */
-        blackAndWhite?: boolean;
-        /**
-         * Specifies how cell comments are printed.
-         * @see {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_CellComments_topic_ID0EXMDFB.html#topic_ID0EXMDFB}
-         */
-        cellComments?: string;
-        /**
-         * The number of copies to print.
-         */
-        copies?: number;
-        /**
-         * Whether to print in draft mode for quicker printing.
-         */
-        draft?: boolean;
-        /**
-         * Specifies how errors should be displayed in the print.
-         * @see {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_PrintError_topic_ID0EUTTFB.html#topic_ID0EUTTFB}
-         */
-        errors?: string;
-        /**
-         * The page number to start printing from.
-         */
-        firstPageNumber?: number;
-        /**
-         * The number of pages to fit vertically.
-         */
-        fitToHeight?: number;
-        /**
-         * The number of pages to fit horizontally.
-         */
-        fitToWidth?: number;
-        /**
-         * The horizontal DPI (dots per inch) for printing.
-         */
-        horizontalDpi?: number;
-        /**
-         * The orientation of the page (portrait or landscape).
-         * @see
-         * {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_Orientation_topic_ID0E4XPFB.html#topic_ID0E4XPFB}
-         */
-        orientation?: string;
-        /**
-         * Specifies the order of pages when printed.
-         * @see
-         * {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_PageOrder_topic_ID0EN5PFB.html#topic_ID0EN5PFB}
-         */
-        pageOrder?: string;
-        /**
-         * Specifies the paper size for printing (enum values 1-68).
-         * @see
-         * {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_pageSetup_topic_ID0EHZ54.html#topic_ID0EHZ54}
-         */
-        paperSize?: number;
-        /**
-         * Specifies the scaling factor for printing (between 10 and 400).
-         */
-        scale?: number;
-        /**
-         * Whether to use the first page number specified in `firstPageNumber`.
-         */
-        useFirstPageNumber?: boolean;
-        /**
-         * Whether to use the printer's default settings for the print job.
-         */
-        usePrinterDefaults?: boolean;
-        /**
-         * The vertical DPI (dots per inch) for printing.
-         */
-        verticalDpi?: number;
-    }
-    /**
-     * Interface for additional properties of page setup,
-     * such as auto page breaks and fitting content to a page.
-     */
-    interface PageSetUpProperties {
-        /**
-         * Whether to automatically break pages when content overflows.
-         */
-        autoPageBreak?: boolean;
-        /**
-         * Whether content should fit to a single page when printed.
-         */
-        fitToPage?: boolean;
-    }
-    /**
-     * Interface for configuring print options, such as grid lines
-     * and content alignment.
-     */
-    interface PrintOptions {
-        /**
-         * Whether to print grid lines on the sheet.
-         */
-        gridLines?: boolean;
-        /**
-         * Whether grid lines are explicitly set for printing.
-         */
-        gridLinesSet?: boolean;
-        /**
-         * Whether to print row and column headings.
-         */
-        headings?: boolean;
-        /**
-         * Whether content should be horizontally centered on the page.
-         */
-        horizontalCentered?: boolean;
-        /**
-         * Whether content should be vertically centered on the page.
-         */
-        verticalCentered?: boolean;
-    }
-    /**
-     * Interface for outline properties used in print, such as
-     * the summary position and style application.
-     */
-    interface OutlineProperties {
-        /**
-         * Whether to apply styles to outline symbols.
-         */
-        applyStyles?: boolean;
-        /**
-         * Whether to display outline symbols in the print.
-         */
-        showOutlineSymbols?: boolean;
-        /**
-         * Whether the summary rows are displayed below the details.
-         */
-        summaryBelow?: boolean;
-        /**
-         * Whether the summary columns are displayed to the right of the details.
-         */
-        summaryRight?: boolean;
-    }
-    type Break = IRange.JSONReference<{
-        man?: boolean;
-        pt?: boolean;
-    }>;
-}
-//# sourceMappingURL=IPrint.d.ts.map