@sheetxl/query 0.8.0-beta.10 → 0.8.0-beta.12

package/types/src/markdown/renderPageLayout.d.ts

@@ -0,0 +1,22 @@
+import { IPageLayout, IWorksheet } from '@sheetxl/sdk';
+/**
+ * The sheet report's `Print:` line — what differs from Excel's defaults — or `null` when nothing
+ * does.
+ *
+ * @remarks
+ * Built from the settings a reader acts on, not from `toJSON()`: a file routinely carries print
+ * state nobody chose (the printer's resolution, its opaque settings, the automatic breaks Excel
+ * last paginated with), and a sheet whose only print state is that is a default sheet.
+ */
+export declare function describePageLayout(sheet: IWorksheet): string | null;
+/**
+ * Renders a sheet's print layout — what `getPageLayout()` answers with.
+ *
+ * @remarks
+ * The page-shaping settings (orientation, paper, scale, margins, print area, titles, breaks) are
+ * always listed, marked when they are the default, so the report says how the sheet prints and not
+ * only how it differs. The rest is listed only when set: a line per default would bury the few that
+ * are not.
+ */
+export declare function renderPageLayout(layout: IPageLayout): string;
+//# sourceMappingURL=renderPageLayout.d.ts.map

package/types/src/markdown/renderProtection.d.ts

@@ -1,4 +1,4 @@
-import { ICellRange, ICell, IProtectedRange, IProtection, ISheet, ISheetProtection, IWorkbookProtection } from '@sheetxl/sdk';
+import { ICellRange, ICell, IProtectedRange, IProtection, IWorksheet, IWorksheetProtection, IWorkbookProtection } from '@sheetxl/sdk';
 import { MarkdownBuilder } from './MarkdownBuilder';
 type AnyProtection = IProtection<any, any, any>;
 /**
@@ -21,7 +21,7 @@ export declare const describeWorkbookProtection: (protection: IWorkbookProtectio
  *
  * @returns `null` when the sheet is not protected.
  */
-export declare function summarizeSheetProtection(sheet: ISheet): {
+export declare function summarizeSheetProtection(sheet: IWorksheet): {
     extent: string;
     detail: string;
 } | null;
@@ -38,7 +38,7 @@ export declare function summarizeSheetProtection(sheet: ISheet): {
  * own: on an unprotected sheet an unlocked cell refuses nothing and says nothing, and on a
  * protected one it is this section's body.
  */
-export declare function appendSheetProtection(md: MarkdownBuilder, sheet: ISheet): void;
+export declare function appendSheetProtection(md: MarkdownBuilder, sheet: IWorksheet): void;
 /**
  * A range report's `Protection:` line — how much of the range a write reaches — or `null` when the
  * sheet is not locked.
@@ -68,7 +68,7 @@ export declare function protectionPointerFor(error: unknown): string | null;
  * `sheet.getRegions("unlock")` on their own. An unprotected object still renders — the caller asked
  * — as the one line that says so, plus the options it keeps for its next lock.
  */
-export declare function renderProtection(protection: ISheetProtection | IWorkbookProtection): string;
+export declare function renderProtection(protection: IWorksheetProtection | IWorkbookProtection): string;
 /**
  * Renders one unlocked range — a member of what `sheet.getProtectedRanges()` holds.
  *

package/types/src/markdown/renderRegions.d.ts

@@ -50,7 +50,15 @@ export declare function appendRegionList(md: MarkdownBuilder, regions: readonly
     payload?: RegionPayload;
     profile?: boolean;
     series?: boolean;
+    collapse?: RegionKey;
 }): void;
+/** What a region says, as a key two regions saying the same thing share; `null` keeps it on its own. */
+export type RegionKey = (region: ICellRegion) => string | null;
+/**
+ * An `anomalies` region's key: its findings, check and evidence, without the rank. Two regions
+ * with the same findings are one line of the listing.
+ */
+export declare const anomalyRegionKey: RegionKey;
 /**
  * Renders a partition — the unit `getRegions` returns, so an agent addresses structure instead
  * of guessing ranges.

package/types/src/markdown/renderWorkbook.d.ts

@@ -21,7 +21,7 @@ export interface RenderWorkbookOptions extends Pick<AppendNamesOptions, 'maxName
  * regions and distinct formulas say how many ideas the model has, and distinct fonts and formats
  * say whether the styling is a convention. A layer that is empty has no line. The structure
  * behind each line is the sheet report's, and the `content` line carries that sheet's call
- * (`wb.getSheet("Sales") lists the blocks`): a reader routes by copying an address off the roster,
+ * (`wb.getWorksheet("Sales") lists the blocks`): a reader routes by copying an address off the roster,
  * so the call to the fuller report sits on the line the address is read from. **Twins** — sheets
  * whose formula partitions are identical, where the audit is the diff between them — are named on
  * the sheet.

package/types/src/markdown/{renderSheet.d.ts → renderWorksheet.d.ts}

@@ -1,9 +1,9 @@
-import { ISheet } from '@sheetxl/sdk';
+import { IWorksheet } from '@sheetxl/sdk';
 import { AppendFeatureOptions } from './appendSections';
 /**
- * Options for {@link renderSheet}.
+ * Options for {@link renderWorksheet}.
  */
-export interface RenderSheetOptions extends AppendFeatureOptions {
+export interface RenderWorksheetOptions extends AppendFeatureOptions {
 }
 /**
  * Renders a markdown report of a sheet: counts, one section per feature partition, the sheet-level
@@ -24,5 +24,5 @@ export interface RenderSheetOptions extends AppendFeatureOptions {
  * then asked for, so the two calls compose into the whole read: this one to find the blocks,
  * that one to read one.
  */
-export declare function renderSheet(sheet: ISheet, options?: RenderSheetOptions): Promise<string>;
-//# sourceMappingURL=renderSheet.d.ts.map
+export declare function renderWorksheet(sheet: IWorksheet, options?: RenderWorksheetOptions): Promise<string>;
+//# sourceMappingURL=renderWorksheet.d.ts.map