@squadbase/vantage 0.6.2-dev1.42c4e48 → 0.6.2-dev1.81c1bbe

package/dist/slide/index.d.ts

@@ -1,5 +1,6 @@
 import * as React from 'react';
 import { ReactNode, PropsWithChildren, CSSProperties, ReactElement } from 'react';
+import { V as ValueFormat } from '../format-U0cQl069.js';
 
 /**
  * Ported from open-slide (MIT) — https://github.com/1weiho/open-slide
@@ -227,4 +228,179 @@ 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;
+
+export { CANVAS_HEIGHT, CANVAS_WIDTH, type EntryDirection, type ExportDeckOptions, MorphElement, type MorphElementProps, type MorphTransition, type PptxExportProgress, Slide, SlideCanvas, type SlideCanvasProps, SlideChartInsight, type SlideChartInsightChart, type SlideChartInsightProps, SlideCover, type SlideCoverProps, SlideDeck, type SlideDeckProps, SlideExecSummary, type SlideExecSummaryPoint, type SlideExecSummaryProps, 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, type SlideTheme, type SlideTransition, Step, type StepController, type StepProps, Steps, type TransitionPhase, exportDeckAsPptx, useIsActiveSlide, useSlideNumber };