@dreamboard-games/sdk 0.2.0

package/LICENSE.md

@@ -0,0 +1,96 @@
+# PolyForm Shield License 1.0.0
+
+<https://polyformproject.org/licenses/shield/1.0.0>
+
+Required Notice: Copyright Dreamboard Games.
+Licensor Line of Business: Dreamboard.Games game authoring, publishing, hosting, play, and platform services (https://dreamboard.games)
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose. However, you may only distribute the software according to Distribution License and make changes or new works based on the software according to Changes and New Works License.
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software. Your license to distribute covers distributing the software with changes and new works permitted by Changes and New Works License.
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software. For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncompete
+
+Any purpose is a permitted purpose, except for providing any product that competes with the software or any product the licensor or any of its affiliates provides using the software.
+
+## Competition
+
+Goods and services compete even when they provide functionality through different kinds of interfaces or for different technical platforms. Applications can compete with services, libraries with plugins, frameworks with development tools, and so on, even if they're written in different programming languages or for different computer architectures. Goods and services compete even when provided free of charge.
+
+If you market a product as a practical substitute for the software or another product, it definitely competes.
+
+## New Products
+
+If you are using the software to provide a product that does not compete, but the licensor or any of its affiliates brings your product into competition by providing a new version of the software or another product using the software, you may continue using versions of the software available under these terms beforehand to provide your competing product, but not any later versions.
+
+## Discontinued Products
+
+You may begin using the software to compete with a product or service that the licensor or any of its affiliates has stopped providing, unless the licensor includes a plain-text line beginning with `Licensor Line of Business:` with the software that mentions that line of business. For example:
+
+> Licensor Line of Business: YoyodyneCMS Content Management System (http://example.com/cms)
+
+## Sales of Business
+
+If the licensor or any of its affiliates sells a line of business developing the software or using the software to provide a product, the buyer can also enforce Noncompete for that product.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else. These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice. Otherwise, all your licenses end immediately.
+
+## No Liability
+
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+## Definitions
+
+The licensor is the individual or entity offering these terms, and the software is the software the licensor makes available under these terms.
+
+A product can be a good or service, or a combination of them.
+
+You refers to the individual or entity agreeing to these terms.
+
+Your company is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all its affiliates.
+
+Affiliates means the other organizations than an organization has control over, is under the control of, or is under common control with.
+
+Control means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+Your licenses are all the licenses granted to you for the software under these terms.
+
+Use means anything you do with the software requiring one of your licenses.
+
+(c) PolyForm Project Inc.

package/README.md

@@ -0,0 +1,12 @@
+# @dreamboard-games/sdk
+
+Package-set metadata for the public Dreamboard SDK release train. The individual SDK packages are versioned together and published as `@dreamboard-games/*`.
+
+Typical imports:
+
+```ts
+import {
+  DREAMBOARD_SDK_PACKAGE_SET,
+  DREAMBOARD_SDK_VERSION,
+} from "@dreamboard-games/sdk";
+```

package/dist/HandView-ncJIVLhN.d.ts

@@ -0,0 +1,193 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode, CSSProperties } from 'react';
+import { V as ViewCard } from './cards-Sl3b40Mv.js';
+
+/**
+ * Controlled visual state contract for `@dreamboard-games/sdk/ui` components.
+ *
+ * The SDK is Dreamboard-interaction unaware: components consume `display data`
+ * and `controlled semantic states`. Runtime adapters compute these states from
+ * descriptors/drafts and pass them in as plain props.
+ */
+/**
+ * Generic semantic state attached to a presentational component.
+ *
+ * Every flag is optional and renders as a stable `data-*` attribute on the
+ * underlying element so that selectors, snapshot diffs and accessibility
+ * announcements can react to state without inspecting class strings.
+ */
+interface InteractionVisualState {
+    /** Caller may activate this surface right now. */
+    eligible?: boolean;
+    /**
+     * Eligible *and* a meaningful subset — i.e. at least one peer surface is not
+     * eligible. Use this (rather than `eligible`) to drive a "highlight the
+     * playable cards" affordance: when every card in a hand is a legal target
+     * (e.g. a pass where any card may be chosen, or a turn where you may play
+     * anything) the highlight carries no information, so `distinctlyEligible` is
+     * `false` for all of them and the ring naturally disappears. `eligible`
+     * keeps its literal meaning ("is a legal target") for dimming/logic.
+     */
+    distinctlyEligible?: boolean;
+    /** Currently chosen as part of a draft selection or focus state. */
+    selected?: boolean;
+    /** Surface is non-interactive and visually muted. */
+    disabled?: boolean;
+    /** Caller's draft is invalid — render an error tint without removing the surface. */
+    invalid?: boolean;
+    /** Action has been submitted; render a settled/locked feedback state. */
+    submitted?: boolean;
+    /** Surface is being previewed (long-press, hover hold) without commitment. */
+    previewing?: boolean;
+    /**
+     * Optional 0..1 progress reading for an in-flight UI intent (swipe, hold,
+     * etc.). Components may render this as a fill, scale or halo without owning
+     * the gesture pipeline themselves.
+     */
+    intentProgress?: number;
+}
+/**
+ * Generic UI intent emitted by SDK components.
+ *
+ * Components do not know what `activate`/`drop` mean in Dreamboard terms —
+ * that mapping belongs to a runtime adapter. They only emit when a generic
+ * pointer/keyboard gesture completes.
+ *
+ * - `activate` is a single-target commit produced by a desktop click or a
+ *   keyboard activation in `direct-activate` mode.
+ * - `drop` is a card→target commit produced by mobile drag or keyboard drop
+ *   in `drag-to-target` mode. The opaque `targetId` is registered by a
+ *   `CardDropTargetView` and resolved against pointer geometry inside the
+ *   `CardDragSurface`.
+ * - `previewStart`/`previewEnd` bracket a long-press inspection that does
+ *   not commit.
+ */
+type CardIntent<CardId extends string = string, TargetId extends string = string> = {
+    type: "activate";
+    cardId: CardId;
+    source: "tap" | "keyboard";
+} | {
+    type: "previewStart";
+    cardId: CardId;
+} | {
+    type: "previewEnd";
+    cardId: CardId;
+} | {
+    type: "drop";
+    cardId: CardId;
+    targetId: TargetId;
+    source: "pointer" | "keyboard";
+};
+/**
+ * Generic UI intent emitted for a board target (space/edge/vertex).
+ */
+type TargetIntent<TargetId extends string = string> = {
+    type: "activate";
+    targetId: TargetId;
+    source: "tap" | "keyboard";
+} | {
+    type: "previewStart";
+    targetId: TargetId;
+} | {
+    type: "previewEnd";
+    targetId: TargetId;
+};
+/**
+ * Controlled visual state for a card drop target rendered through
+ * `CardDropTargetView`.
+ *
+ * `active` is `true` when any card is currently being dragged anywhere on
+ * the surface (eligible target should advertise itself). `over` is `true`
+ * only for the target that the lifted pointer would currently drop on.
+ */
+interface CardDropTargetVisualState extends InteractionVisualState {
+    active?: boolean;
+    over?: boolean;
+}
+/**
+ * Build the `data-*` attribute bag for an {@link InteractionVisualState} so
+ * that components apply a single consistent attribute surface.
+ *
+ * `undefined` values are emitted (rather than `false`) so that CSS
+ * `[data-…="true"]` selectors do not match by mistake.
+ */
+declare function visualStateDataAttributes(state: InteractionVisualState | undefined): Readonly<Record<string, string | undefined>>;
+/**
+ * Build the `data-*` attribute bag for a {@link CardDropTargetVisualState}.
+ */
+declare function dropTargetVisualStateDataAttributes(state: CardDropTargetVisualState | undefined): Readonly<Record<string, string | undefined>>;
+
+/**
+ * Pure layout math for the controlled `HandView`.
+ *
+ * The functions here are independent of React and DOM measurement so they can
+ * be unit-tested directly. {@link computeFanLayout} matches the algorithm
+ * documented in `docs/references/ui-sdk-mobile-hand-and-card-interactions.md`,
+ * and {@link chooseHandLayoutMode} translates a measured container width and a
+ * caller policy into the actual presentation mode the hand should render.
+ */
+type HandPresentationMode = "fan" | "compressed-fan" | "strip" | "tray";
+
+/**
+ * Deterministic pointer recognizer for the controlled hand view.
+ *
+ * The engine is independent from React: it consumes pointer events and a
+ * caller-supplied callbacks bag, and produces semantic gesture events. It
+ * owns no DOM, emits no `CardIntent`, and does not track the drag-lifecycle
+ * `phase` — that responsibility lives in `CardDragSurface`. The engine only
+ * recognizes `tap`, `previewStart`/`previewEnd`, `liftStart`/`liftMove`/
+ * `liftEnd`/`liftCancel`, and a `horizontalBrowse` informational signal.
+ *
+ * The thresholds match
+ * `docs/references/ui-sdk-mobile-hand-and-card-interactions.md`:
+ *
+ * | Threshold                 | Default     |
+ * | ------------------------- | ----------- |
+ * | Press preview delay       | `220ms`     |
+ * | Movement slop             | `8px`       |
+ * | Axis bias                 | `1.25`      |
+ * | Drag lift distance        | `28px`      |
+ *
+ * Callers wire the engine's `handlePointerDown` / `handlePointerMove` /
+ * `handlePointerUp` / `handlePointerCancel` to the matching DOM events on
+ * each interactive card.
+ */
+type HandInteractionPolicy = "direct-activate" | "drag-to-target";
+
+type HandLayoutKind = HandPresentationMode | "stack";
+interface HandLayoutPolicy {
+    desktop?: HandLayoutKind;
+    mobile?: HandLayoutKind;
+}
+interface HandViewProps<CardData extends ViewCard = ViewCard> {
+    cards: readonly CardData[];
+    /**
+     * Layout policy. Pass a single layout kind to use the same layout in every
+     * viewport, or pass `{ desktop, mobile }` for a measured-width decision.
+     * Defaults to `{ desktop: "fan", mobile: "tray" }`.
+     */
+    layout?: HandLayoutKind | HandLayoutPolicy;
+    /**
+     * Mobile interaction policy. Defaults to `direct-activate`. Use
+     * `drag-to-target` together with a surrounding `CardDragSurface` and one
+     * or more `CardDropTargetView` children.
+     */
+    mobileInteraction?: HandInteractionPolicy;
+    /** Returns the controlled visual state for a card. */
+    stateForCard?: (card: CardData, index: number) => InteractionVisualState | undefined;
+    /** Visual surface renderer. */
+    renderCard: (card: CardData, state: InteractionVisualState, index: number) => ReactNode;
+    /** Generic UI intent callback. */
+    onCardIntent?: (intent: CardIntent<CardData["id"] & string>) => void;
+    /** Card width hint for fan geometry. */
+    cardSize?: "sm" | "md" | "lg";
+    /** Slot for the empty state. Defaults to nothing rendered. */
+    renderEmpty?: () => ReactNode;
+    /** ARIA label for the hand region. */
+    "aria-label"?: string;
+    className?: string;
+    style?: CSSProperties;
+}
+declare function HandView<CardData extends ViewCard = ViewCard>({ cards, layout, mobileInteraction, stateForCard, renderCard, onCardIntent, cardSize, renderEmpty, "aria-label": ariaLabel, className, style, }: HandViewProps<CardData>): react_jsx_runtime.JSX.Element;
+
+export { type CardDropTargetVisualState as C, type HandInteractionPolicy as H, type InteractionVisualState as I, type TargetIntent as T, type CardIntent as a, type HandLayoutKind as b, type HandLayoutPolicy as c, HandView as d, type HandViewProps as e, dropTargetVisualStateDataAttributes as f, visualStateDataAttributes as v };

package/dist/ResourceCounter-CTREyF73.d.ts

@@ -0,0 +1,102 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { ReactNode, HTMLAttributes, ComponentType, ReactElement } from 'react';
+import { P as PrimitiveCommonProps } from './primitive-props-DpKs-GCr.js';
+
+type HandRole = "primary" | "auxiliary" | "task";
+interface MobileHandRegistration {
+    id: string;
+    zone: string;
+    label: string;
+    role: HandRole;
+    order?: number;
+    version: string;
+    count: number;
+    active: boolean;
+    autoOpen: boolean;
+    content: ReactNode;
+}
+declare function MobileHandTrayProvider({ children }: {
+    children: ReactNode;
+}): react_jsx_runtime.JSX.Element;
+declare function useRegisterMobileHand(hand: MobileHandRegistration): void;
+/**
+ * Whether the mobile hand tray is currently presenting hands — i.e. the
+ * viewport is below the mobile breakpoint and at least one primary/auxiliary
+ * hand has registered. Authors can use this to drop redundant inline hand
+ * chrome (labels, framing) that the tray already provides, instead of guessing
+ * the breakpoint with a CSS media query. Returns `false` outside `<UI.Root>`.
+ */
+declare function useMobileHandTrayActive(): boolean;
+
+type ResourceId = string;
+interface ResourceDisplayConfig<Resource extends string = ResourceId> {
+    type: Resource;
+    label: string;
+    icon: ReactNode | ComponentType<{
+        className?: string;
+        strokeWidth?: number;
+        "aria-hidden"?: boolean | "true" | "false";
+    }>;
+    iconColor?: string;
+    bgColor?: string;
+    textColor?: string;
+}
+interface ResourceCounterItemState<Resource extends string = ResourceId> {
+    type: Resource;
+    label: string;
+    icon: ResourceDisplayConfig<Resource>["icon"];
+    iconColor?: string;
+    bgColor?: string;
+    textColor?: string;
+    count: number;
+    isZero: boolean;
+    interactive: boolean;
+    select: () => void;
+    renderIcon: (props?: ResourceIconProps) => ReactNode;
+    dataAttributes: {
+        "data-resource-id": Resource;
+        "data-resource-count": number;
+        "data-resource-zero": boolean | undefined;
+        "data-interactive": boolean | undefined;
+    };
+}
+interface ResourceIconProps {
+    className?: string;
+    strokeWidth?: number;
+    "aria-hidden"?: boolean | "true" | "false";
+}
+type ResourceCounterRootProps<Resource extends string = ResourceId> = Omit<PrimitiveCommonProps, "children"> & Omit<HTMLAttributes<HTMLElement>, "children"> & {
+    resources: ReadonlyArray<ResourceDisplayConfig<Resource>>;
+    counts: Partial<Record<Resource, number>>;
+    zero?: "show" | "hide";
+    onResourceClick?: (resourceType: Resource) => void;
+    children: ReactNode;
+};
+type BoundResourceCounterRootProps<Resource extends string = ResourceId> = Omit<ResourceCounterRootProps<Resource>, "resources">;
+type ResourceCounterProps<Resource extends string = ResourceId> = ResourceCounterRootProps<Resource>;
+type ResourceCounterPartProps<Resource extends string = ResourceId> = Omit<PrimitiveCommonProps, "children"> & Omit<HTMLAttributes<HTMLElement>, "children"> & {
+    children?: ReactNode | ((resource: ResourceCounterItemState<Resource>) => ReactNode);
+};
+declare function ResourceCounterRoot<Resource extends string = ResourceId>({ resources, counts, zero, onResourceClick, children, "aria-label": ariaLabel, ...props }: ResourceCounterRootProps<Resource>): ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+declare function ResourceCounterItem<Resource extends string = ResourceId>({ children, onClick, "aria-label": ariaLabel, ...props }: ResourceCounterPartProps<Resource>): ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+declare function ResourceCounterIcon<Resource extends string = ResourceId>({ className, strokeWidth, "aria-hidden": ariaHidden, }: ResourceIconProps): ReactNode;
+declare function ResourceCounterCount<Resource extends string = ResourceId>({ children, ...props }: ResourceCounterPartProps<Resource>): ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+declare function ResourceCounterLabel<Resource extends string = ResourceId>({ children, ...props }: ResourceCounterPartProps<Resource>): ReactElement<unknown, string | react.JSXElementConstructor<any>>;
+interface ResourceCounterComponents<Resource extends string = ResourceId> {
+    Root(props: BoundResourceCounterRootProps<Resource>): ReactElement;
+    Item(props: ResourceCounterPartProps<Resource>): ReactElement;
+    Icon(props: ResourceIconProps): ReactNode;
+    Count(props: ResourceCounterPartProps<Resource>): ReactElement;
+    Label(props: ResourceCounterPartProps<Resource>): ReactElement;
+}
+declare function createResourceCounter<Resource extends string>(resources: ReadonlyArray<ResourceDisplayConfig<Resource>>): ResourceCounterComponents<Resource>;
+declare const ResourceCounter: {
+    Root: typeof ResourceCounterRoot;
+    Item: typeof ResourceCounterItem;
+    Icon: typeof ResourceCounterIcon;
+    Count: typeof ResourceCounterCount;
+    Label: typeof ResourceCounterLabel;
+};
+
+export { type BoundResourceCounterRootProps as B, type HandRole as H, type MobileHandRegistration as M, ResourceCounter as R, MobileHandTrayProvider as a, type ResourceCounterComponents as b, ResourceCounterCount as c, ResourceCounterIcon as d, ResourceCounterItem as e, type ResourceCounterItemState as f, ResourceCounterLabel as g, type ResourceCounterPartProps as h, type ResourceCounterProps as i, ResourceCounterRoot as j, type ResourceCounterRootProps as k, type ResourceDisplayConfig as l, type ResourceIconProps as m, createResourceCounter as n, useRegisterMobileHand as o, useMobileHandTrayActive as u };

package/dist/ThemeProvider-fy0_QzgO.d.ts

@@ -0,0 +1,99 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { CSSProperties, ReactNode } from 'react';
+import { _ as Theme, a0 as ThemeOverride } from './hex-board-view-D_07hO6O.js';
+
+/**
+ * The set of preset theme ids ships in `@dreamboard-games/sdk/ui`. Authors
+ * may register additional ones by passing a fully-resolved {@link Theme}
+ * instead of an id.
+ */
+type ThemePresetId = "tabletop" | "arcade" | "studio";
+/**
+ * Resolve a preset id (or a full theme) into a {@link Theme}.
+ *
+ * Used internally by {@link ThemeProvider}; exported so authors who
+ * compose at the call site (e.g. for a side-by-side preview) can do
+ * the same resolution without mounting a provider.
+ */
+declare function resolveTheme(input: ThemePresetId | Theme | undefined): Theme;
+/** Look up a registered preset by id. Returns `undefined` if missing. */
+declare function getThemePreset(id: ThemePresetId): Theme | undefined;
+/**
+ * Subset returned by {@link useTheme} — the resolved theme plus a
+ * stable copy of its CSS-variable map so consumers can reuse it (for
+ * example, to apply tokens to a portal that escapes the provider).
+ */
+interface ThemeContextValue {
+    /** Fully resolved theme. */
+    readonly theme: Theme;
+    /** CSS-var map consumable as `style` on a wrapper. */
+    readonly cssVars: CSSProperties;
+}
+interface ThemeProviderProps {
+    /**
+     * Preset id, a full {@link Theme}, or omitted to use the `tabletop`
+     * default.
+     */
+    theme?: ThemePresetId | Theme;
+    /**
+     * Deep-partial overrides merged onto the resolved base theme. Use
+     * for one-off tweaks (e.g. swapping the player palette per game)
+     * without writing a full theme.
+     */
+    override?: ThemeOverride;
+    /**
+     * Render mode for reduced-motion enforcement.
+     *
+     * - `auto` (default): respect the user's OS-level preference via
+     *   `prefers-reduced-motion: reduce`.
+     * - `force`: force `motion.reducedMotion = "true"` regardless of the
+     *   OS preference (useful for screenshot CI).
+     * - `ignore`: never override motion (use only when the embedding
+     *   shell already decides motion behaviour).
+     */
+    reducedMotion?: "auto" | "force" | "ignore";
+    /**
+     * Where to mount the wrapper. `block` (default) renders a `div` and
+     * applies the CSS variables to it. `none` skips the wrapper entirely
+     * — only useful when the parent is already a Dreamboard provider and
+     * just needs to publish a different sub-tree (rare).
+     */
+    as?: "block" | "none";
+    /** Extra style merged after the CSS-var map. */
+    style?: CSSProperties;
+    /** Extra className for the wrapper. */
+    className?: string;
+    children: ReactNode;
+}
+/**
+ * Mounts a Dreamboard theme. The provider:
+ *
+ * 1. Resolves the preset (or accepts a full theme).
+ * 2. Applies any deep-partial `override`.
+ * 3. Optionally clamps `motion.reducedMotion` to `"true"` based on the
+ *    OS-level preference (or a forced override).
+ * 4. Serialises the resolved theme into CSS variables on a wrapper
+ *    element so descendants can read tokens via `useTheme()` *or* via
+ *    `var(--db-...)` references in their own CSS / Tailwind.
+ *
+ * Defaults such as `<GameLayout>` mount this for you with the configured
+ * theme; mount it manually only when you need a sub-tree to use a different
+ * theme (e.g. a dark sheet over a light layout).
+ */
+declare function ThemeProvider({ theme: themeInput, override, reducedMotion, as, style, className, children, }: ThemeProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Read the active {@link Theme} from a {@link ThemeProvider} ancestor.
+ *
+ * Falls back to the `tabletop` preset (with no overrides) when called
+ * outside a provider — components remain renderable in isolated tests
+ * and Storybook/Cosmos fixtures without a wrapping shell.
+ */
+declare function useTheme(): Theme;
+/**
+ * Read the {@link CSSProperties} that publish the active theme as CSS
+ * variables. Useful when porting a theme into a portal or drawer that
+ * is rendered outside the provider's DOM subtree.
+ */
+declare function useThemeCssVars(): CSSProperties;
+
+export { type ThemeContextValue as T, type ThemePresetId as a, ThemeProvider as b, type ThemeProviderProps as c, useThemeCssVars as d, getThemePreset as g, resolveTheme as r, useTheme as u };