@marktiderman/genesis-forms-studio 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -1,207 +1,55 @@
-import { C as ChipTone, S as SaveState, R as Readiness, P as PrefillChoice, F as FiltersValue, Q as QuestionSummary, a as QuestionDropOff } from './rules-Bpy8zTON.js';
-export { A as AnswerColumn, b as AvailabilityInput, c as Cell, d as ChoiceSummary, D as DatePreset, e as FollowUp, f as FormAvailability, g as FormNavItem, h as FormTab, H as Headline, i as HeadlineNumber, j as HeadlineNumbers, N as NO_FILTERS, k as RESPONSE_STATUS_LABEL, l as ResponseFilter, m as ResponseStatus, n as SAVE_STATE_LABEL, o as SLUG_PATTERN, p as STATUS_FILTER_LABEL, q as ScaleSummary, r as StatusFilter, s as SummaryItem, T as TextSummary, t as answerCell, u as answerColumns, v as answersByKey, w as comparisonFilter, x as copyTitle, y as dayLabel, z as dropOffByQuestion, B as embedSnippet, E as filterResponses, G as followUpOf, I as formAvailability, J as formCounts, K as formNavItems, L as formStatusChip, M as freeSlug, O as hasLowRating, U as hasLowRatingExcept, V as headlineCards, W as headlineNumbers, X as highestRating, Y as isFiltered, Z as isFull, _ as lowRatingAtMost, $ as lowRatingLabel, a0 as lowScaleAtMost, a1 as lowThisWeek, a2 as lowestRating, a3 as matchesStatus, a4 as needsFollowUp, a5 as offersSubmitAnother, a6 as parseInstant, a7 as plainLabel, a8 as prefilledUrl, a9 as presetRange, aa as readinessChip, ab as readinessOf, ac as slugFromTitle, ad as summarizeResponses, ae as takesResponses, af as toCsv, ag as toResponseFilter, ah as validateSlug, ai as valuesByKey } from './rules-Bpy8zTON.js';
+import { FiltersValue, QuestionSummary, QuestionDropOff } from './rules.js';
+export { AnswerColumn, AvailabilityInput, Cell, ChipTone, ChoiceSummary, DatePreset, DropOffSummary, FORM_READINESS_LABELS, FORM_READINESS_OPTIONS, FollowUp, FormAvailability, FormNavItem, FormTab, Headline, NO_FILTERS, PrefillChoice, RESPONSE_STATUS_LABEL, Readiness, ResponseFilter, ResponseStatus, SAVE_STATE_LABEL, SLUG_PATTERN, STATUS_FILTER_LABEL, SaveState, ScaleSummary, StatusFilter, SummaryItem, TextSummary, answerCell, answerColumns, answersByKey, comparisonFilter, copyTitle, dayLabel, dropOffByQuestion, dropOffSummary, embedSnippet, filterResponses, followUpOf, formAvailability, formCounts, formNavItems, formStatusChip, freeSlug, hasLowRating, hasLowRatingExcept, headlineCards, headlineNumbers, highestRating, isFiltered, isFull, lowRatingAtMost, lowRatingLabel, lowScaleAtMost, lowThisWeek, lowestRating, matchesStatus, needsFollowUp, offersSubmitAnother, parseInstant, plainLabel, prefilledUrl, presetRange, readinessChip, readinessOf, slugFromTitle, summarizeResponses, takesResponses, toCsv, toResponseFilter, validateSlug, valuesByKey } from './rules.js';
 import * as react from 'react';
-import { ReactNode } from 'react';
+import { ComponentProps, ReactNode } from 'react';
+import { Chip as Chip$1, FollowUpEntry as FollowUpEntry$1, FollowUpList as FollowUpList$1, HeadlineNumber as HeadlineNumber$1, HeadlineNumbers as HeadlineNumbers$1, ReadinessChip as ReadinessChip$1, ResourceHeader as ResourceHeader$1, ResourceHeaderProps as ResourceHeaderProps$1, ResourceSettingsPage as ResourceSettingsPage$1, ResponsesToolbar as ResponsesToolbar$1, ResponsesView as ResponsesView$1, ResourceSettingsSection, SettingsSection as SettingsSection$1, ShareDialog as ShareDialog$1, SummaryCard as SummaryCard$1 } from '@marktiderman/genesis-ui/resource';
 import * as lucide_react from 'lucide-react';
 import { PhotoRef } from '@marktiderman/genesis-forms';
 export { carryAnswers } from '@marktiderman/genesis-forms';
 import '@marktiderman/genesis-ui/layout';
+import '@marktiderman/genesis-ui/resource/rules';
 
-interface ResourceHeaderProps {
-    /** The title, shown once: as the heading and the breadcrumb's last part. */
-    title: string;
-    /** Shown when the title is empty. Default "Untitled". */
-    untitled?: string | undefined;
-    /**
-     * The breadcrumb's parent link, e.g. `<Link to="/forms">Forms</Link>`: one element, so
-     * the host's router renders it.
-     */
-    parent?: ReactNode;
-    /** The status chip, e.g. formStatusChip's "Live · version 3" or "Draft". */
-    status?: {
-        label: string;
-        tone: ChipTone;
-    } | undefined;
-    /** Where saving the draft stands; no chip when absent. */
-    saveState?: SaveState | undefined;
-    /** Undo and redo buttons, shown when given (for example the builder's history). */
-    onUndo?: (() => void) | undefined;
-    onRedo?: (() => void) | undefined;
-    canUndo?: boolean | undefined;
-    canRedo?: boolean | undefined;
-    /** A Preview button. */
-    onPreview?: (() => void) | undefined;
-    /** A Share button (open a share dialog). */
-    onShare?: (() => void) | undefined;
-    /** The primary button: "Publish", or "Publish changes" once it is live. */
-    publish?: {
-        onClick: () => void;
-        label?: string | undefined;
-        loading?: boolean | undefined;
-        disabled?: boolean | undefined;
-    } | undefined;
-    /** Anything else for the right-hand side, before Preview (a Reload button, a menu). */
-    actions?: ReactNode;
-    className?: string | undefined;
-}
-/**
- * The header of a page that edits one publishable thing (a form, a course, a lesson, a
- * worksheet): the breadcrumb ("Forms › name"), the title once, its status and save-state
- * chips, and on the right undo and redo, Preview, Share and Publish. Every action is the
- * host's; a button shows only when its handler is given.
- */
-declare function ResourceHeader({ title, untitled, parent, status, saveState, onUndo, onRedo, canUndo, canRedo, onPreview, onShare, publish, actions, className, }: ResourceHeaderProps): react.JSX.Element;
-
-/**
- * "Ready to publish", or how many problems to fix: for the trailing slot of a resource
- * page's row of tabs (genesis-ui's `<AppShellSubNavEnd>`). With `onClick` it is a button (open the checks).
- */
-declare function ReadinessChip({ readiness, onClick, className, }: {
-    readiness: Readiness;
-    onClick?: (() => void) | undefined;
-    className?: string | undefined;
-}): react.JSX.Element;
-
-/** A small status chip in one of the studio's tones (tinted, AA-safe Genesis badges). */
-declare function Chip({ tone, icon, children, className, testID, }: {
-    tone: ChipTone;
-    icon?: ReactNode;
-    children: ReactNode;
-    className?: string | undefined;
-    testID?: string | undefined;
-}): react.JSX.Element;
-
-type ResponsesView = "summary" | "each";
-/**
- * The Responses tab's toolbar: a Summary / Each response switch, the host's filters
- * (ResponsesFilters, or its own) and, on the right, its export actions (open a Sheet,
- * Download CSV).
- */
-declare function ResponsesToolbar({ view, onViewChange, filters, actions, className, }: {
-    view: ResponsesView;
-    onViewChange: (view: ResponsesView) => void;
-    filters?: ReactNode;
-    actions?: ReactNode;
-    className?: string | undefined;
-}): react.JSX.Element;
-
-/**
- * One card of a summary column: an icon and a title, a short line on the right ("24
- * answers · average 4.1"), then whatever summarises it (bars, quotes, a split bar).
- */
-declare function SummaryCard({ icon, title, meta, children, className, testID, }: {
-    icon?: ReactNode;
-    title: string;
-    meta?: ReactNode;
-    children?: ReactNode;
-    className?: string | undefined;
-    testID?: string | undefined;
-}): react.JSX.Element;
-
-/** One response in the follow-up list, as the host describes it. */
-interface FollowUpEntry {
-    id: string;
-    /** Who answered: a name, or "Anonymous". */
-    name: string;
-    /** A tag beside the name, e.g. "Member" or "New lead". */
-    tag?: {
-        label: string;
-        tone?: ChipTone | undefined;
-    } | undefined;
-    /** One line under the name: "Today · 6:00 WOD · Leo". */
-    meta?: ReactNode;
-    /** What they wrote; null shows "No comment". */
-    comment?: string | null | undefined;
-    /** The low score, on its scale. */
-    rating?: {
-        value: number;
-        max: number;
-    } | null | undefined;
-}
-/**
- * Responses that need a follow-up (needsFollowUp), each with who answered, a tag, the day
- * and context, their comment, its low score and the host's actions (Reply, Mark handled).
- * Handled items are the host's to leave out.
- */
-declare function FollowUpList({ entries, actions, title, isLoading, empty, className, }: {
-    entries: readonly FollowUpEntry[];
-    /** Buttons for one entry. */
-    actions?: ((entry: FollowUpEntry) => ReactNode) | undefined;
-    title?: string | undefined;
-    isLoading?: boolean | undefined;
-    /** Said when the list is empty. */
-    empty?: ReactNode;
-    className?: string | undefined;
-}): react.JSX.Element;
-
-/**
- * Sharing one published page (a form, a course), as Google Forms' Send step: its link with Copy, a QR code
- * (and a printable poster when the host has one), an `<iframe>` to embed it on a website,
- * and a builder for prefilled links (`?class=…&coach=…`, or whatever the host offers).
- * Generic: the host passes the link, how to draw a QR code, and the prefill choices.
- * Moved up from Breakthrough's src/components/forms/ShareDialog.tsx.
- */
-declare function ShareDialog({ open, onOpenChange, noun, title, description, url, posterUrl, renderQr, name, prefill, prefillNote, defaultTab, }: {
-    open: boolean;
-    onOpenChange: (open: boolean) => void;
-    title?: string | undefined;
-    description?: ReactNode;
-    /** The public link; null while it is still loading. */
-    url: string | null;
-    /** A printable poster for a link (the base link, or a prefilled one), when the host has one. */
-    posterUrl?: ((url: string, prefill: Record<string, string>) => string | null) | undefined;
-    /** Draws a QR code for a link. */
-    renderQr?: ((url: string) => ReactNode) | undefined;
-    /** Its name, for the embed's accessible title. */
-    name: string;
-    /** What it is, in the default title and buttons: "form" (default), "course". */
-    noun?: string | undefined;
-    /** The search params a prefilled link may set, each with its choices. None hides the builder. */
-    prefill?: readonly PrefillChoice[] | undefined;
-    /** Said under the prefilled-link builder (what a prefilled link does). */
-    prefillNote?: ReactNode;
-    /** The tab it opens on (each time it opens). Default "link". */
-    defaultTab?: "link" | "qr" | "embed" | undefined;
-}): react.JSX.Element;
-
+/** A form's Share dialog words: "Share your form", "Anyone with the link can answer." */
+declare const FORM_SHARE_LABELS: {
+    readonly noun: "form";
+    readonly description: "Anyone with the link can answer.";
+};
+/** @deprecated import from @marktiderman/genesis-ui */
+type ResourceHeaderProps = ResourceHeaderProps$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+type ResponsesView = ResponsesView$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+type HeadlineNumber = HeadlineNumber$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+type FollowUpEntry = FollowUpEntry$1;
+/** @deprecated import `ResourceSettingsSection` from @marktiderman/genesis-ui */
+type SettingsPageSection = ResourceSettingsSection;
+/** @deprecated import from @marktiderman/genesis-ui */
+declare const ResourceHeader: typeof ResourceHeader$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+declare const Chip: typeof Chip$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+declare const ResponsesToolbar: typeof ResponsesToolbar$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+declare const HeadlineNumbers: typeof HeadlineNumbers$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+declare const SummaryCard: typeof SummaryCard$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+declare const FollowUpList: typeof FollowUpList$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+declare const SettingsSection: typeof SettingsSection$1;
+/** @deprecated import from @marktiderman/genesis-ui */
+declare const ResourceSettingsPage: typeof ResourceSettingsPage$1;
 /**
- * One group of settings as a card: an icon, a title and a sentence, then its rows
- * (genesis-ui `SettingsRow` and `ToggleRow`: a label, a one-sentence description and the
- * control), divided by lines. On a phone a row whose control isn't a switch puts the
- * control under its label, so wide controls (a link, a list of people) still fit.
+ * "Ready to publish", or how many problems to fix, in a form's words ("Add a question").
+ * @deprecated import from @marktiderman/genesis-ui and pass `labels={FORM_READINESS_LABELS}`
  */
-declare function SettingsSection({ id, icon, title, description, children, className, }: {
-    /** The jump link's target. */
-    id?: string | undefined;
-    icon?: ReactNode;
-    title: ReactNode;
-    description?: ReactNode;
-    children?: ReactNode;
-    className?: string | undefined;
-}): react.JSX.Element;
-interface SettingsPageSection {
-    id: string;
-    title: string;
-    icon?: ReactNode;
-    description?: ReactNode;
-    /** The rows. Absent: a jump link only, to `#id` elsewhere on the page (or `onSelect`). */
-    content?: ReactNode;
-    /** For a link-only section whose target has no id: scroll to it yourself. */
-    onSelect?: (() => void) | undefined;
-}
+declare function ReadinessChip({ labels, ...props }: ComponentProps<typeof ReadinessChip$1>): react.JSX.Element;
 /**
- * Every setting of one thing (a form, a course) on one page: jump links on the left ("On this page", the one in
- * view marked), the sections as cards on the right. On a phone the links sit above the
- * sections as a row that scrolls sideways.
- *
- * Not genesis-ui's `SettingsPage`: that one is a whole page with its own title, and plain
- * sections; these settings sit under the resource's header, as cards with icons.
+ * Sharing a published form: "Share your form", "Anyone with the link can answer."
+ * @deprecated import from @marktiderman/genesis-ui and pass `{...FORM_SHARE_LABELS}`
  */
-declare function ResourceSettingsPage({ sections, navLabel, className, }: {
-    sections: readonly SettingsPageSection[];
-    navLabel?: string | undefined;
-    className?: string | undefined;
-}): react.JSX.Element;
+declare function ShareDialog({ noun, description, ...props }: ComponentProps<typeof ShareDialog$1>): react.JSX.Element;
 
 /** The form page's four places' icons, for `formNavItems(path, counts, FORM_NAV_ICONS)`. */
 declare const FORM_NAV_ICONS: {
@@ -270,13 +118,17 @@ declare function QuestionSummaryCards({ summaries, responses, isLoading, emptyTi
 }): react.JSX.Element;
 
 /**
- * Drop-off by question (dropOffByQuestion): for each question in order, how many people
- * reached it, how many stopped there, and that as a share, with the share as a bar (the
- * question most people left on in the warning colour). For a form that saves answers as
- * they go.
+ * Drop-off by question (`dropOffSummary`): how many people started, then for each question in
+ * order how many reached it, how many stopped there, and that as a share, with the share as
+ * a bar (the question most people left on in the warning colour). For a form that saves
+ * answers as they go. Spread `dropOffSummary(...)` into it; without `started` it falls back
+ * to the first question's views, which leaves out responses in progress and anyone logic
+ * hid the first question from.
  */
-declare function DropOffByQuestion({ dropOffs, isLoading, title, className, }: {
+declare function DropOffByQuestion({ dropOffs, started: startedCount, isLoading, title, className, }: {
     dropOffs: readonly QuestionDropOff[];
+    /** How many people started (`dropOffSummary`'s `started`). */
+    started?: number | undefined;
     isLoading?: boolean | undefined;
     title?: string | undefined;
     className?: string | undefined;
@@ -295,4 +147,4 @@ declare function PhotoAnswer({ photos, resolveUrl, className, testID, }: {
     testID?: string | undefined;
 }): react.JSX.Element | null;
 
-export { Chip, ChipTone, type ChoiceFilter, DropOffByQuestion, FORM_NAV_ICONS, FiltersValue, type FollowUpEntry, FollowUpList, PhotoAnswer, PrefillChoice, QuestionDropOff, QuestionSummary, QuestionSummaryCard, QuestionSummaryCards, Readiness, ReadinessChip, ResourceHeader, type ResourceHeaderProps, ResourceSettingsPage, ResponsesFilters, ResponsesToolbar, type ResponsesView, SaveState, type SettingsPageSection, SettingsSection, ShareDialog, SummaryCard };
+export { Chip, type ChoiceFilter, DropOffByQuestion, FORM_NAV_ICONS, FORM_SHARE_LABELS, FiltersValue, type FollowUpEntry, FollowUpList, type HeadlineNumber, HeadlineNumbers, PhotoAnswer, QuestionDropOff, QuestionSummary, QuestionSummaryCard, QuestionSummaryCards, ReadinessChip, ResourceHeader, type ResourceHeaderProps, ResourceSettingsPage, ResponsesFilters, ResponsesToolbar, type ResponsesView, type SettingsPageSection, SettingsSection, ShareDialog, SummaryCard };