react-semaphor 0.1.516 → 0.1.518

package/dist/surfboard/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../chunks/index-UNKSfi7s.cjs"),r=require("../chunks/common-types-nBuCd3u2.cjs"),o=require("../chunks/report-preferences-dialog-Cto0vDwI.cjs");exports.DisplayFormatPreferencesFields=e.DisplayFormatPreferencesFields;exports.Surfboard=e.DashboardPlus;exports.CONTROL_CARD_DEFAULT_VALUE=r.CONTROL_CARD_DEFAULT_VALUE;exports.EMPTY_SELECTION=r.EMPTY_SELECTION;exports.ReportPreferencesDialog=o.ReportPreferencesDialog;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../chunks/index-Dgv9vzT0.cjs"),r=require("../chunks/common-types-nBuCd3u2.cjs"),o=require("../chunks/report-preferences-dialog-DLnhOXXg.cjs");exports.DisplayFormatPreferencesFields=e.DisplayFormatPreferencesFields;exports.Surfboard=e.DashboardPlus;exports.CONTROL_CARD_DEFAULT_VALUE=r.CONTROL_CARD_DEFAULT_VALUE;exports.EMPTY_SELECTION=r.EMPTY_SELECTION;exports.ReportPreferencesDialog=o.ReportPreferencesDialog;

package/dist/surfboard/index.js

@@ -1,6 +1,6 @@
-import { b as a, a as o } from "../chunks/index-BVVl2JDK.js";
+import { b as a, a as o } from "../chunks/index-DqTelnri.js";
 import { C as f, E } from "../chunks/common-types-C6cAQgyh.js";
-import { R as t } from "../chunks/report-preferences-dialog-CHXPEl7v.js";
+import { R as t } from "../chunks/report-preferences-dialog-BzxqfcF8.js";
 export {
   f as CONTROL_CARD_DEFAULT_VALUE,
   a as DisplayFormatPreferencesFields,

package/dist/types/components/editor/editor-main/dashboard-variable-node.d.ts

@@ -1,10 +1,11 @@
 import { TextNode, DOMConversionMap, DOMExportOutput, EditorConfig, LexicalNode, NodeKey, SerializedTextNode } from 'lexical';
-import { DashboardInputVariableRef } from '../../../lib/types/common-types.js';
+import { DashboardInputVariableRef, TextVariablePresentation } from '../../../lib/types/common-types.js';
 import { TextVariableChipFace } from '../../../lib/text-variables/text-variable-types.js';
 export type SerializedDashboardVariableNode = SerializedTextNode & {
     ref: DashboardInputVariableRef;
     face?: TextVariableChipFace;
     token?: string;
+    presentation?: TextVariablePresentation;
     type: 'dashboard-variable';
     version: 1;
 };
@@ -13,14 +14,17 @@ export declare class DashboardVariableNode extends TextNode {
     __face: TextVariableChipFace;
     /** `name.part`, for copying the variable as a typed token. */
     __token: string;
+    /** How it shows its input's value (a date format); stored beside `ref`. */
+    __presentation: TextVariablePresentation | undefined;
     static getType(): string;
     static clone(node: DashboardVariableNode): DashboardVariableNode;
     static importJSON(serializedNode: SerializedDashboardVariableNode): DashboardVariableNode;
     static importDOM(): DOMConversionMap | null;
-    constructor(ref: DashboardInputVariableRef, face: TextVariableChipFace, token: string, key?: NodeKey);
+    constructor(ref: DashboardInputVariableRef, face: TextVariableChipFace, token: string, presentation?: TextVariablePresentation, key?: NodeKey);
     getRef(): DashboardInputVariableRef;
     getFace(): TextVariableChipFace;
     getToken(): string;
+    getPresentation(): TextVariablePresentation | undefined;
     /** Renames the chip when its input changes (its reference stays). */
     setFace(face: TextVariableChipFace, token: string): this;
     createDOM(_config: EditorConfig): HTMLElement;
@@ -31,5 +35,5 @@ export declare class DashboardVariableNode extends TextNode {
     canInsertTextBefore(): false;
     canInsertTextAfter(): false;
 }
-export declare function $createDashboardVariableNode(ref: DashboardInputVariableRef, face: TextVariableChipFace, token: string): DashboardVariableNode;
+export declare function $createDashboardVariableNode(ref: DashboardInputVariableRef, face: TextVariableChipFace, token: string, presentation?: TextVariablePresentation): DashboardVariableNode;
 export declare function $isDashboardVariableNode(node: LexicalNode | null | undefined): node is DashboardVariableNode;

package/dist/types/components/editor/editor-main/text-card-rich-editor.d.ts

@@ -1,10 +1,13 @@
 import { ResolvedDashboardInputContext, TextCardRichContent } from '../../../lib/types/common-types.js';
+import { DashboardTextRenderContext } from '../../../lib/dashboard-inputs/dashboard-input-display.js';
+/** The inputs a text visual's chips name, with the viewer's date preferences. */
+type TextCardEditorInputContext = Pick<ResolvedDashboardInputContext, 'variablesById' | 'variablesByName' | 'resolvedInputs'> & Pick<DashboardTextRenderContext, 'presentation'>;
 type TextCardRichEditorProps = {
     /** Initial content. Falsy ⇒ start with a single empty paragraph. */
     content: TextCardRichContent | undefined;
     /** Dashboard input context — drives the Insert Variable popover and
      *  the chip label for already-inserted variables. */
-    dashboardInputContext?: Pick<ResolvedDashboardInputContext, 'variablesById' | 'variablesByName' | 'resolvedInputs'>;
+    dashboardInputContext?: TextCardEditorInputContext;
     /** Fired whenever the editor content changes (debounced upstream). */
     onChange: (content: TextCardRichContent) => void;
     /** Visual disable — useful for previews / printing. */

package/dist/types/lib/charts/chart-availability.d.ts

@@ -5,3 +5,9 @@ export declare function isChartTypeAvailableForEditorMode(chartType: TChartType
 export declare function isChartTypeAvailableForCompactPicker(chartType: TChartType | string, input: {
     isDevMode: boolean;
 }): boolean;
+/**
+ * Chart types that switch the visual editor to SQL when picked. Text keeps
+ * the author's mode: static text runs no query, and dynamic text can come
+ * from SQL or drag and drop alike.
+ */
+export declare function selectingChartTypeForcesSqlMode(chartType: TChartType | string): boolean;

package/dist/types/lib/dashboard-inputs/dashboard-input-display.d.ts

@@ -0,0 +1,11 @@
+import { DashboardInputExportKey, ResolvedDashboardInput, ResolvedDashboardInputContext, TextVariablePresentation } from '../types/common-types.js';
+import { TemporalTextPresentationContext } from '../text-variables/temporal-input-text.js';
+/** What text visual rendering resolves variables against. */
+export type DashboardTextRenderContext = Pick<ResolvedDashboardInputContext, 'variablesById' | 'variablesByName'> & {
+    /** The viewer's Report preferences and Calendar; defaults when absent. */
+    presentation?: TemporalTextPresentationContext;
+};
+/** A date filter or a date control: its value can be formatted as a date. */
+export declare function isTemporalDashboardInput(input: ResolvedDashboardInput): boolean;
+/** One part of an input as text, with the variable's stored presentation. */
+export declare function getDashboardInputText(input: ResolvedDashboardInput, exportKey: DashboardInputExportKey, context: Pick<DashboardTextRenderContext, 'presentation'>, stored?: TextVariablePresentation): string;

package/dist/types/lib/dashboard-inputs/dashboard-input-text.d.ts

@@ -1,10 +1,11 @@
 import { DashboardInputTextContent, ResolvedDashboardInputContext } from '../types/common-types.js';
+import { DashboardTextRenderContext } from './dashboard-input-display.js';
 export type ParsedDashboardInputTextContent = {
     content: DashboardInputTextContent;
     unresolvedTokens: string[];
 };
 export declare function parseDashboardInputTextContent(value: string, context: Pick<ResolvedDashboardInputContext, 'variablesByName'>): ParsedDashboardInputTextContent;
-export declare function renderDashboardInputTextContent(content: DashboardInputTextContent | undefined, context: Pick<ResolvedDashboardInputContext, 'variablesById' | 'variablesByName'>): string;
+export declare function renderDashboardInputTextContent(content: DashboardInputTextContent | undefined, context: DashboardTextRenderContext): string;
 export declare function dashboardInputTextContentToEditableText(content: DashboardInputTextContent | undefined, context: Pick<ResolvedDashboardInputContext, 'variablesById' | 'variablesByName'>): string;
 export declare function hasDashboardInputVariableToken(value: string): boolean;
 export declare function htmlToDashboardInputText(value: string): string;

package/dist/types/lib/dashboard-inputs/text-card-rich-content.d.ts

@@ -1,5 +1,6 @@
-import { ResolvedDashboardInputContext, TextCardRichContent } from '../types/common-types.js';
+import { TextCardRichContent } from '../types/common-types.js';
+import { DashboardTextRenderContext } from './dashboard-input-display.js';
 export declare function createEmptyRichContent(): TextCardRichContent;
 export declare function isTextCardRichContent(value: unknown): value is TextCardRichContent;
-export declare function renderRichContentToHtml(content: TextCardRichContent | undefined, context: Pick<ResolvedDashboardInputContext, 'variablesById' | 'variablesByName'>): string;
+export declare function renderRichContentToHtml(content: TextCardRichContent | undefined, context: DashboardTextRenderContext): string;
 export declare function extractPlainTextFromRichContent(content: TextCardRichContent | undefined): string;

package/dist/types/lib/dashboard-inputs/text-variable-options.d.ts

@@ -1,15 +1,16 @@
-import { DashboardInputVariableRef, ResolvedDashboardInputContext } from '../types/common-types.js';
+import { DashboardInputVariableRef, ResolvedDashboardInputContext, TextVariablePresentation } from '../types/common-types.js';
 import { TextVariableChipFace, TextVariableOption, TextVariableSelection } from '../text-variables/text-variable-types.js';
+import { DashboardTextRenderContext } from './dashboard-input-display.js';
 /** What resolves a reference to its input. */
 type DashboardVariableLookup = Pick<ResolvedDashboardInputContext, 'variablesById' | 'variablesByName'>;
 /** The dashboard inputs a text visual can show, each part with its value now. */
-export declare function getDashboardTextVariableOptions(context?: Pick<ResolvedDashboardInputContext, 'resolvedInputs'>): TextVariableOption[];
+export declare function getDashboardTextVariableOptions(context?: Pick<ResolvedDashboardInputContext, 'resolvedInputs'> & Pick<DashboardTextRenderContext, 'presentation'>): TextVariableOption[];
 /** What a reference shows, as the picker names it; undefined when missing. */
-export declare function getDashboardVariableSelection(ref: DashboardInputVariableRef, context?: DashboardVariableLookup): TextVariableSelection | undefined;
+export declare function getDashboardVariableSelection(ref: DashboardInputVariableRef, context?: DashboardVariableLookup, presentation?: TextVariablePresentation): TextVariableSelection | undefined;
 /** The reference a picker selection stands for. */
 export declare function getDashboardVariableRefFromSelection(selection: TextVariableSelection): DashboardInputVariableRef;
 /** How a reference reads as a chip: the input's name, or Missing input. */
-export declare function getDashboardVariableChipFace(ref: DashboardInputVariableRef, context?: DashboardVariableLookup): TextVariableChipFace;
+export declare function getDashboardVariableChipFace(ref: DashboardInputVariableRef, context?: DashboardVariableLookup, presentation?: TextVariablePresentation): TextVariableChipFace;
 /** `name.part`, for copying a variable as a typed token. */
 export declare function getDashboardVariableToken(ref: DashboardInputVariableRef, context?: DashboardVariableLookup): string;
 export {};

package/dist/types/lib/document/document-variables.d.ts

@@ -1,6 +1,7 @@
 import { TFilterValue } from '../../components/surfboard/filter/types.js';
-import { ControlOption, DocumentInputDefinition, DocumentTextInlineFormat, DocumentTextContent, DocumentVariableRef, ResolvedDocumentInput } from '../types/common-types.js';
+import { ControlOption, DocumentInputDefinition, DocumentTextInlineFormat, DocumentTextContent, DocumentVariableRef, ResolvedDocumentInput, TextVariablePresentation } from '../types/common-types.js';
 import { TextVariableChipFace, TextVariableOption, TextVariableSelection } from '../text-variables/text-variable-types.js';
+import { TemporalTextPresentationContext } from '../text-variables/temporal-input-text.js';
 export type DocumentTextRenderContext = {
     inputs: DocumentInputDefinition[];
     resolvedInputsById: Record<string, ResolvedDocumentInput>;
@@ -11,6 +12,8 @@ export type DocumentTextRenderContext = {
     };
     timezone?: string;
     generatedAtFormat?: string;
+    /** The viewer's Report preferences and Calendar, for date inputs. */
+    presentation?: TemporalTextPresentationContext;
 };
 export type ParsedDocumentTextContent = {
     content: DocumentTextContent;
@@ -42,11 +45,11 @@ export declare function parseDocumentTextContentWithSource(value: string, inputs
 export declare function appendDocumentVariable(content: DocumentTextContent | undefined, ref: DocumentVariableRef): DocumentTextContent;
 export declare function getDocumentVariableLabel(ref: DocumentVariableRef, inputs: DocumentInputDefinition[]): string;
 /** What a reference shows, as the picker names it. */
-export declare function getDocumentVariableSelection(ref: DocumentVariableRef): TextVariableSelection;
+export declare function getDocumentVariableSelection(ref: DocumentVariableRef, inputs?: DocumentInputDefinition[], presentation?: TextVariablePresentation): TextVariableSelection;
 /** The reference a picker selection stands for. */
 export declare function getDocumentVariableRefFromSelection(selection: TextVariableSelection): DocumentVariableRef;
 /** How a reference reads as a chip: the input's name, or Missing input. */
-export declare function getDocumentVariableChipFace(ref: DocumentVariableRef, inputs: DocumentInputDefinition[]): TextVariableChipFace;
+export declare function getDocumentVariableChipFace(ref: DocumentVariableRef, inputs: DocumentInputDefinition[], presentation?: TextVariablePresentation): TextVariableChipFace;
 /**
  * The inputs and report values a Document text can show, each part with what
  * it holds now when `context` is given.
@@ -78,7 +81,7 @@ export declare function getDocumentInputTextUsage(document: {
     footer: boolean;
     textSections: number;
 };
-export declare function buildDocumentTextRenderContext({ inputs, filterValuesByInputId, controlValuesByInputId, controlOptionsByInputId, generatedAt, timezone, generatedAtFormat, pageNumber, pageCount, }: {
+export declare function buildDocumentTextRenderContext({ inputs, filterValuesByInputId, controlValuesByInputId, controlOptionsByInputId, generatedAt, timezone, generatedAtFormat, presentation: providedPresentation, pageNumber, pageCount, }: {
     inputs: DocumentInputDefinition[];
     filterValuesByInputId: Record<string, TFilterValue | undefined>;
     controlValuesByInputId: Record<string, unknown>;
@@ -86,6 +89,7 @@ export declare function buildDocumentTextRenderContext({ inputs, filterValuesByI
     generatedAt: string;
     timezone?: string;
     generatedAtFormat?: string;
+    presentation?: TemporalTextPresentationContext;
     pageNumber?: number;
     pageCount?: number;
 }): DocumentTextRenderContext;

package/dist/types/lib/text-variables/temporal-input-text.d.ts

@@ -0,0 +1,28 @@
+import { TFilterValue } from '../../components/surfboard/filter/types.js';
+import { TemporalInputCalendar, TemporalInputPart, TemporalInputPresentation, TemporalInputValue } from '../../shared/format-utils/temporal-input-presentation.js';
+import { ResolvedTemporalValueFormatPreferences } from '../../shared/value-format-preferences/index.js';
+/** The viewer's temporal preferences and Calendar, for formatting inputs. */
+export type TemporalTextPresentationContext = {
+    preferences: ResolvedTemporalValueFormatPreferences;
+    calendar: TemporalInputCalendar;
+};
+export declare function getTemporalTextPresentationContext(input: {
+    preferences?: ResolvedTemporalValueFormatPreferences | null;
+    calendar?: TemporalInputCalendar | null;
+}): TemporalTextPresentationContext;
+/** A date filter's current value as a temporal input value. */
+export declare function getTemporalValueFromFilter(filterValue: TFilterValue | undefined): TemporalInputValue | undefined;
+/** A date control's current value (one date) as a temporal input value. */
+export declare function getTemporalValueFromControl(value: unknown): TemporalInputValue | undefined;
+/** Which bound an input part shows. */
+export declare function getTemporalInputPart(exportKey: string): TemporalInputPart;
+/** A stored presentation, dropping (and reporting once) an invalid one. */
+export declare function readTextVariablePresentation(stored: unknown): TemporalInputPresentation | undefined;
+/** A date input's value as text; empty when it has no value. */
+export declare function formatTemporalInputText({ inputId, value, exportKey, presentation, context, }: {
+    inputId: string;
+    value: TemporalInputValue | undefined;
+    exportKey: string;
+    presentation?: TemporalInputPresentation;
+    context: TemporalTextPresentationContext;
+}): string;

package/dist/types/lib/text-variables/text-variable-types.d.ts

@@ -1,3 +1,4 @@
+import { TemporalInputPresentation } from '../../shared/format-utils/temporal-input-presentation.js';
 /** What kind of value a variable holds; picks the chip's icon. */
 export type TextVariableKind = 'filter' | 'date' | 'control' | 'report';
 /** How one variable reference reads as a chip. */
@@ -23,13 +24,28 @@ export type TextVariableOption = {
     kind: TextVariableKind;
     parts: TextVariablePart[];
     defaultPart: string;
+    /** A date input: its value can be shown in a chosen format (Plan 08). */
+    temporal?: {
+        /** What `part` prints now in `presentation` (automatic when omitted). */
+        preview: (part: string, presentation?: TemporalInputPresentation) => string;
+        /** The selection has a period name now ("Today"). */
+        hasPeriodName: boolean;
+    };
 };
-/** What a chip shows: an option and one of its parts. */
+/** What a chip shows: an option, one of its parts, and a date format. */
 export type TextVariableSelection = {
     optionId: string;
     part: string;
+    /** A date input's pinned format; omission means automatic. */
+    temporal?: TemporalInputPresentation;
 };
 export declare const TEXT_VARIABLE_PART_LABELS: Record<string, string>;
+/** A date part's label: the whole value reads as its dates. */
+export declare const TEMPORAL_TEXT_VARIABLE_PART_LABELS: Record<string, string>;
+/** A pinned date format, as the chip's suffix names it. */
+export declare function temporalFormatLabel(presentation: TemporalInputPresentation | undefined): string | undefined;
+/** The chip's suffix: a non-default part, then a pinned format. */
+export declare function chipPartLabel(partLabel: string | undefined, presentation?: TemporalInputPresentation): string | undefined;
 /** The picker's groups, in order. */
 export declare function textVariableGroup(kind: TextVariableKind): "Filters" | "Controls" | "Report";
 /**

package/dist/types/lib/types/common-types.d.ts

@@ -15,7 +15,7 @@ import { DashboardAIContext } from './assistant-types.js';
 import { CardInteractionConfig, InteractionTargetOverride } from './interaction-types.js';
 import { SemanticExecutionPayload } from './semantic-runtime-types.js';
 import { ReportRuntimeContext } from '../../shared/report-runtime-context/index.js';
-import { PresentationExecutionSnapshot } from '../../shared/format-utils/index.js';
+import { PresentationExecutionSnapshot, TemporalInputPresentation } from '../../shared/format-utils/index.js';
 import { JSX } from 'react';
 export type { DashboardFilterApplication, DashboardFilterBoundCardApplication, DashboardFilterCardApplication, DashboardFilterExcludedCardApplication, DashboardFilterTarget, DashboardFilterTargetField, DashboardFilterTargetSource, DashboardFilterOptionSource, } from '../../shared/dashboard-authoring/dashboard-filter-mapping-types.js';
 export type { ClickToFilterCardMapping, ClickToFilterFieldsRule, ClickToFilterMatrixSources, ClickToFilterSettings, LinkedClickToFilterOverrides, } from '../../shared/dashboard-authoring/click-to-filter-settings.js';
@@ -1185,6 +1185,13 @@ export type TextCardInlineFormat = {
     bold?: boolean;
     italic?: boolean;
 };
+/**
+ * How a variable in text shows its input's value (Plan 08). Sparse: omission
+ * means automatic (the viewer's Report preferences).
+ */
+export type TextVariablePresentation = {
+    temporal?: TemporalInputPresentation;
+};
 export type TextCardRichInline = {
     type: 'text';
     value: string;
@@ -1193,6 +1200,7 @@ export type TextCardRichInline = {
     type: 'variable';
     ref: DashboardInputVariableRef;
     format?: TextCardInlineFormat;
+    presentation?: TextVariablePresentation;
 } | {
     type: 'link';
     url: string;
@@ -1204,6 +1212,7 @@ export type TextCardRichInline = {
         type: 'variable';
         ref: DashboardInputVariableRef;
         format?: TextCardInlineFormat;
+        presentation?: TextVariablePresentation;
     }>;
 };
 export type TextCardRichBlock = {
@@ -1415,6 +1424,7 @@ export type DocumentTextNode = {
     type: 'variable';
     ref: DocumentVariableRef;
     format?: DocumentTextInlineFormat;
+    presentation?: TextVariablePresentation;
 };
 export type DocumentVariableRef = {
     source: 'input';

package/dist/types/shared/format-utils/index.d.ts

@@ -28,6 +28,7 @@ export * from './presentation-execution.js';
 export * from './temporal-bucket-format-policy.js';
 export * from './temporal-bucket.js';
 export * from './raw-temporal.js';
+export * from './temporal-input-presentation.js';
 export * from './flat-table-export-totals.js';
 export * from './aggregate-table-row-presentation.js';
 export { PDF_GROUP_CONTINUATION_CLASS } from './grouped-table-presentation.js';

package/dist/types/shared/format-utils/temporal-input-presentation.d.ts

@@ -0,0 +1,46 @@
+import { CalendarContext } from '../report-runtime-context/report-runtime-context.js';
+import { LocaleStyle, ResolvedTemporalValueFormatPreferences } from '../value-format-preferences/index.js';
+export type TemporalInputPrecision = 'day' | 'minute';
+/** One resolved date-input value. Bounds are canonical, never labels. */
+export type TemporalInputValue = {
+    bounds: readonly [string] | readonly [string, string];
+    precision: TemporalInputPrecision;
+    /** The selection's period name ("Today"), for a relative selection. */
+    periodLabel?: string;
+};
+export type TemporalInputPart = 'range' | 'start' | 'end';
+/** Authored per-variable presentation. Omission means automatic. */
+export type TemporalInputPresentation = {
+    mode: 'style';
+    dateStyle: LocaleStyle;
+} | {
+    mode: 'pattern';
+    dialect: 'semaphor_tokens';
+    pattern: string;
+} | {
+    mode: 'period_label';
+};
+export type TemporalInputFormatResult = {
+    ok: true;
+    text: string;
+} | {
+    ok: false;
+    /** The original canonical text, preserved. */
+    text: string;
+    diagnostic: {
+        code: 'invalid_temporal_input_value';
+        message: string;
+    };
+};
+export type TemporalInputCalendar = Pick<CalendarContext, 'tz'> & Partial<Pick<CalendarContext, 'weekStart' | 'fiscalCalendar'>>;
+/** A stored presentation, or undefined when absent or invalid. */
+export declare function parseTemporalInputPresentation(input: unknown): TemporalInputPresentation | undefined;
+/** Why a custom pattern cannot be used, or null when it can. */
+export declare function validateTemporalInputPattern(pattern: string): string | null;
+export declare function formatTemporalInputValue(input: {
+    value: TemporalInputValue;
+    part: TemporalInputPart;
+    presentation?: TemporalInputPresentation;
+    preferences: ResolvedTemporalValueFormatPreferences;
+    calendar: TemporalInputCalendar;
+}): TemporalInputFormatResult;

package/package.json

@@ -5,7 +5,7 @@
     "email": "support@semaphor.cloud"
   },
   "license": "MIT",
-  "version": "0.1.516",
+  "version": "0.1.518",
   "description": "Fully interactive and customizable dashboards for your apps.",
   "keywords": [
     "react",