@squadbase/vantage 0.6.2-stg.3a2ba98 → 0.7.0-dev1.19083f7

package/dist/slide/index.d.ts

@@ -1,5 +1,7 @@
 import * as React from 'react';
 import { ReactNode, PropsWithChildren, CSSProperties, ReactElement } from 'react';
+import { V as ValueFormat } from '../format-DihQkL1N.js';
+export { D as DeltaText, a as DeltaTextProps } from '../delta-text-CbrOaW83.js';
 
 /**
  * Ported from open-slide (MIT) — https://github.com/1weiho/open-slide
@@ -227,4 +229,273 @@ declare function exportDeckAsPptx({ slides, fileName, theme, onProgress, }: Expo
 declare const CANVAS_WIDTH = 1920;
 declare const CANVAS_HEIGHT = 1080;
 
-export { CANVAS_HEIGHT, CANVAS_WIDTH, type EntryDirection, type ExportDeckOptions, MorphElement, type MorphElementProps, type MorphTransition, type PptxExportProgress, Slide, SlideCanvas, type SlideCanvasProps, SlideDeck, type SlideDeckProps, type SlideProps, type SlideTheme, type SlideTransition, Step, type StepController, type StepProps, Steps, type TransitionPhase, exportDeckAsPptx, useIsActiveSlide, useSlideNumber };
+interface SlideChartInsightChart {
+    type: "line" | "bar" | "area";
+    /** The x-axis labels, one per value of each series. */
+    categories: string[];
+    series: {
+        name: string;
+        data: number[];
+    }[];
+}
+interface SlideChartInsightProps {
+    /** The conclusion as a sentence (an action title). */
+    title: string;
+    chart: SlideChartInsightChart;
+    /** 2–3 points that read the chart. */
+    insights: string[];
+    /** Which side the chart takes. Default `"left"`. */
+    chartSide?: "left" | "right";
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideChartInsight({ title, chart, insights, chartSide, asOf, source }: SlideChartInsightProps): React.JSX.Element;
+
+interface SlideCoverProps {
+    /** The name of the deck. */
+    title: string;
+    subtitle?: string;
+    /** The period the deck covers, e.g.「2026 年 7 月〜9 月」. */
+    period?: string;
+    author?: string;
+    /** The date the numbers were taken, date only, e.g. `"2026-10-20"`. Shown as「2026-10-20 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideCover({ title, subtitle, period, author, asOf, source }: SlideCoverProps): React.JSX.Element;
+
+interface SlideExecSummaryPoint {
+    /** The point in one line. */
+    headline: string;
+    /** One supporting line (a number, a cause). */
+    detail?: string;
+}
+interface SlideExecSummaryProps {
+    /** The conclusion as a sentence (an action title), not a topic. */
+    title: string;
+    /** 3–5 points. */
+    points: SlideExecSummaryPoint[];
+    layout?: "rows" | "columns";
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideExecSummary({ title, points, layout, asOf, source }: SlideExecSummaryProps): React.JSX.Element;
+
+/** A change: its size in the metric's units, signed. The direction is read from the sign. */
+interface SlideKpiGridDelta {
+    /** e.g. `0.074` with `format: "percent"` →「+7.4%」. */
+    value: number;
+    /** Default: the item's `format`. */
+    format?: ValueFormat;
+}
+interface SlideKpiGridItem {
+    label: string;
+    /** The number; `null` shows「—」. */
+    value: number | null;
+    format?: ValueFormat;
+    /** Replaces the shown text only (the number behind it stays `value`). */
+    display?: string;
+    delta?: SlideKpiGridDelta;
+    /** Which direction of `delta` is good. Default `"up"`. */
+    betterWhen?: "up" | "down";
+    /** What `delta` is against, e.g.「前月比」. */
+    comparisonLabel?: string;
+    /** The target, in the same `format` as `value`. The attainment rate is worked out here. */
+    target?: number;
+}
+interface SlideKpiGridProps {
+    /** The conclusion as a sentence (an action title). */
+    title: string;
+    /** 2–4 KPIs. */
+    items: SlideKpiGridItem[];
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideKpiGrid({ title, items, asOf, source }: SlideKpiGridProps): React.JSX.Element;
+
+/** A change: its size in the metric's units, signed. The direction is read from the sign. */
+interface SlideKpiHeroDelta {
+    /** e.g. `0.074` with `format: "percent"` →「+7.4%」. */
+    value: number;
+    /** Default: the metric's `format`. */
+    format?: ValueFormat;
+}
+interface SlideKpiHeroProps {
+    /** The conclusion as a sentence (an action title). */
+    title: string;
+    /** What the number is, e.g.「月次売上」. */
+    label: string;
+    /** The number; `null` shows「—」. */
+    value: number | null;
+    format?: ValueFormat;
+    /** Replaces the shown text only (the number behind it stays `value`). */
+    display?: string;
+    delta?: SlideKpiHeroDelta;
+    /** Which direction of `delta` is good. Default `"up"`. */
+    betterWhen?: "up" | "down";
+    /** What `delta` is against, e.g.「前月比」. */
+    comparisonLabel?: string;
+    /** Points of the line on the right; leave out for a number alone. */
+    trend?: {
+        x: string;
+        y: number;
+    }[];
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideKpiHero({ title, label, value, format, display, delta, betterWhen, comparisonLabel, trend, asOf, source }: SlideKpiHeroProps): React.JSX.Element;
+
+interface SlideNextActionsItem {
+    /** What to do, as one sentence starting from the verb's object. */
+    action: string;
+    owner?: string;
+    /** As written, e.g. `"10/31"`. */
+    due?: string;
+    /** What to look at to know it worked. */
+    metric?: string;
+}
+interface SlideNextActionsProps {
+    /** The decision or the plan as a sentence (an action title). */
+    title: string;
+    /** 3–5 actions. */
+    items: SlideNextActionsItem[];
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideNextActions({ title, items, asOf, source }: SlideNextActionsProps): React.JSX.Element;
+
+type SlideScorecardStatus = "on" | "risk" | "off";
+interface SlideScorecardRow {
+    metric: string;
+    /** The actual; `null` shows「—」. */
+    value: number | null;
+    format?: ValueFormat;
+    /** Replaces the shown actual only (the number behind it stays `value`). */
+    display?: string;
+    /** The target, in the same `format` as `value`. */
+    target?: number;
+    /** Which direction is good. Default `"up"`; it flips the attainment rate. */
+    betterWhen?: "up" | "down";
+    /** `on` = on track, `risk` = at risk, `off` = off track. */
+    status: SlideScorecardStatus;
+}
+interface SlideScorecardTableProps {
+    /** The conclusion as a sentence (an action title). */
+    title: string;
+    /** Up to 8 rows. */
+    rows: SlideScorecardRow[];
+    /** Header words; leave out what you do not rename. */
+    columns?: Partial<Record<"metric" | "target" | "actual" | "attainment" | "status", string>>;
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideScorecardTable({ title, rows, columns, asOf, source }: SlideScorecardTableProps): React.JSX.Element;
+
+interface SlideChartFullProps {
+    /** The conclusion as a sentence (an action title). */
+    title: string;
+    chart: SlideChartInsightChart;
+    /** One line under the chart. */
+    note?: string;
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideChartFull({ title, chart, note, asOf, source }: SlideChartFullProps): React.JSX.Element;
+
+interface SlideComparisonColumn {
+    /** What this column is, e.g.「旧プラン」「施策前」. */
+    heading: string;
+    /** The main number. `null` shows「—」. */
+    value?: number | null;
+    format?: ValueFormat;
+    /** The main number as a string you already formatted; wins over `value`. */
+    display?: string;
+    /** The change of the main number against the other side or the previous period. `format` falls back to the column's `format`. */
+    delta?: {
+        value: number | null;
+        format?: ValueFormat;
+    };
+    /** Name of what `delta` is measured against, e.g.「前月比」「旧プラン比」. Printed before the change. */
+    comparisonLabel?: string;
+    /** Which way is good for the main number. Default `"up"`. */
+    betterWhen?: "up" | "down";
+    /** 1–3 short points about this column. */
+    points: string[];
+}
+interface SlideComparisonProps {
+    /** The conclusion as a sentence (an action title). */
+    title: string;
+    /** 2–3 columns. */
+    columns: SlideComparisonColumn[];
+    /** One line that says which side wins or what follows. */
+    verdict?: string;
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(the block adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+}
+declare function SlideComparison({ title, columns, verdict, asOf, source }: SlideComparisonProps): React.JSX.Element;
+
+interface SlideSectionProps {
+    /** The chapter number, shown as「02」above the title. */
+    index?: number;
+    title: string;
+    /** One line under the title saying what the chapter answers. */
+    lead?: string;
+    /** The chapters of the deck, shown as a numbered agenda at the right. */
+    items?: string[];
+    /** The chapter in `items` to emphasise, 1-based. */
+    current?: number;
+}
+declare function SlideSection({ index, title, lead, items, current }: SlideSectionProps): React.JSX.Element;
+
+interface SlideHeadingProps {
+    /** The conclusion as a sentence (an action title). Clamped to 2 lines. */
+    title: string;
+    /** A short label above the title, e.g.「第 2 章 解約」. */
+    eyebrow?: string;
+}
+declare function SlideHeading({ title, eyebrow }: SlideHeadingProps): React.JSX.Element;
+
+interface SlideSourceLineProps {
+    /** The date the numbers were taken, date only, e.g. `"2026-10-01"`. Shown as「2026-10-01 時点」(this part adds「時点」once). */
+    asOf?: string;
+    /** Where the numbers come from, e.g.「社内 BI」. Shown as「出典: 社内 BI」. */
+    source?: string;
+    /** The page number, shown at the right as「3 / 12」. */
+    page?: {
+        current: number;
+        total: number;
+    };
+}
+declare function SlideSourceLine({ asOf, source, page }: SlideSourceLineProps): React.JSX.Element | null;
+
+interface SlideColumnsProps {
+    children: ReactNode;
+    /** Vertical alignment of the columns in the row. Default `"stretch"`. */
+    align?: "start" | "center" | "stretch";
+}
+declare function SlideColumns({ children, align }: SlideColumnsProps): React.JSX.Element;
+interface SlideColumnProps {
+    /** How many of the 12 columns it takes, 1–12. */
+    span: number;
+    children: ReactNode;
+}
+declare function SlideColumn({ span, children }: SlideColumnProps): React.JSX.Element;
+
+export { CANVAS_HEIGHT, CANVAS_WIDTH, type EntryDirection, type ExportDeckOptions, MorphElement, type MorphElementProps, type MorphTransition, type PptxExportProgress, Slide, SlideCanvas, type SlideCanvasProps, SlideChartFull, type SlideChartFullProps, SlideChartInsight, type SlideChartInsightChart, type SlideChartInsightProps, SlideColumn, type SlideColumnProps, SlideColumns, type SlideColumnsProps, SlideComparison, type SlideComparisonColumn, type SlideComparisonProps, SlideCover, type SlideCoverProps, SlideDeck, type SlideDeckProps, SlideExecSummary, type SlideExecSummaryPoint, type SlideExecSummaryProps, SlideHeading, type SlideHeadingProps, SlideKpiGrid, type SlideKpiGridDelta, type SlideKpiGridItem, type SlideKpiGridProps, SlideKpiHero, type SlideKpiHeroDelta, type SlideKpiHeroProps, SlideNextActions, type SlideNextActionsItem, type SlideNextActionsProps, type SlideProps, type SlideScorecardRow, type SlideScorecardStatus, SlideScorecardTable, type SlideScorecardTableProps, SlideSection, type SlideSectionProps, SlideSourceLine, type SlideSourceLineProps, type SlideTheme, type SlideTransition, Step, type StepController, type StepProps, Steps, type TransitionPhase, exportDeckAsPptx, useIsActiveSlide, useSlideNumber };