@sesamehr/react-design-system 2.1.0 → 3.1.0-beta.1

package/dist/Feedback/StatusBadge/StatusBadge.d.ts

@@ -1,5 +1,6 @@
 import { StatusBadgeVariants } from './index.ts';
 export interface StatusBadgeProps extends React.HTMLAttributes<HTMLSpanElement> {
+    /** Which tone the dot takes. The wording is yours — pass it as children. */
     status?: StatusBadgeVariants['status'];
     dataTestid: string;
 }

package/dist/Feedback/StatusBadge/index.d.ts

@@ -1,9 +1,14 @@
 import { VariantProps } from 'class-variance-authority';
 export { StatusBadge, type StatusBadgeProps } from './StatusBadge.tsx';
+/**
+ * Class names, not utilities: the declarations live in `StatusBadge.module.css`
+ * behind `@apply`. See `Button/index.ts` for why.
+ *
+ * The statuses are tones rather than states — `warning`, not `pending` — because
+ * the wording is the consumer's and only the colour is ours. A payroll run that
+ * is "Pendiente" and a document that is "Awaiting review" are the same badge.
+ */
 export declare const statusBadgeVariants: (props?: ({
-    status?: "paused" | "active" | "draft" | "completed" | "scheduled" | "deleted" | null | undefined;
-} & import('class-variance-authority/types').ClassProp) | undefined) => string;
-export declare const indicatorVariants: (props?: ({
-    status?: "paused" | "active" | "draft" | "completed" | "scheduled" | "deleted" | null | undefined;
+    status?: "success" | "error" | "info" | "warning" | "neutral" | null | undefined;
 } & import('class-variance-authority/types').ClassProp) | undefined) => string;
 export type StatusBadgeVariants = VariantProps<typeof statusBadgeVariants>;

package/dist/Locale/LocaleProvider/LocaleProvider.d.ts

@@ -1,3 +1,4 @@
+import { Translate } from '../useTranslate.ts';
 export interface LocaleProviderProps {
     /**
      * A BCP-47 language tag. Bare tags are fine — `es` is as valid as `es-ES`,
@@ -8,10 +9,21 @@ export interface LocaleProviderProps {
      * separately from their browser settings, or the two will disagree.
      */
     locale?: string;
+    /**
+     * Your i18n's `t`. `react-i18next`'s fits as-is, because this is the shape it
+     * already has.
+     *
+     * The design system carries no i18n of its own; it declares the keys in
+     * `en.ts` and this resolves them. Left out, every label renders its English
+     * source, which keeps a component renderable in isolation but is not a
+     * translation: a Spanish application that never passes this gets English
+     * `aria-label`s.
+     */
+    t?: Translate;
     children?: React.ReactNode;
 }
 /** LocaleProvider — mirrors `@sesame/orxata-core` LocaleProvider. */
 export declare const LocaleProvider: {
-    ({ locale, children }: LocaleProviderProps): import("react/jsx-runtime").JSX.Element;
+    ({ locale, t, children, }: LocaleProviderProps): import("react/jsx-runtime").JSX.Element;
     displayName: string;
 };

package/dist/Locale/index.d.ts

@@ -1,3 +1,5 @@
 export { LocaleProvider } from './LocaleProvider/LocaleProvider.tsx';
 export type { LocaleProviderProps } from './LocaleProvider/LocaleProvider.tsx';
 export { LocaleContext, normalizeLocale, useLocale } from './useLocale.ts';
+export { TranslateContext, useTranslate, type Translate, } from './useTranslate.ts';
+export { english, orxataMessages, type MessageKey, type Messages, } from './messages.ts';

package/dist/Locale/messages.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Every key the design system asks its `t` for.
+ *
+ * A plain `string`, not a union of the 29 key names. Deriving that union meant a
+ * generated file per package plus the script and CI job to keep them honest —
+ * ~240 lines to protect call sites we write once per component, in this
+ * repository, and which the components' own tests already cover: a mistyped key
+ * renders the key instead of its text, and every one of them is asserted by a
+ * `getByText` or a `getByRole(..., { name })` somewhere.
+ *
+ * It bought a consumer nothing either, once `orxataMessages` replaced the
+ * `messages` override prop — nobody outside this package writes a key any more.
+ */
+export type MessageKey = string;
+/** A catalogue: keys to strings. A pulled locale may be missing some. */
+export type Messages = Record<MessageKey, string>;
+/** Ready for `i18next`, placeholders already in its own `{{name}}` spelling. */
+export declare const orxataMessages: Record<string, Partial<Messages>>;
+/**
+ * The English source — `translations/en.json`, which is authored rather than
+ * pulled and therefore holds every key.
+ *
+ * Deliberately taken *before* `toI18next`: this is what `useTranslate` falls back
+ * to with no `t` injected, and it fills `{name}` blanks itself. Handing it the
+ * doubled spelling would leave `Remove {{label}}` matching on the inner braces
+ * and rendering `Remove {Ana}`.
+ */
+export declare const english: Partial<Messages>;

package/dist/Locale/useTranslate.d.ts

@@ -0,0 +1,36 @@
+import { MessageKey } from './messages.ts';
+/**
+ * What the design system asks an application's i18n for.
+ *
+ * Deliberately the shape `react-i18next`'s `t` already has, so the common case
+ * is passing it straight through — `t={t}` — with no adapter. `key` is narrowed
+ * to `MessageKey` for callers inside this package; a `t` that takes `string` is
+ * assignable to it, which is what makes theirs fit without a cast.
+ */
+export type Translate = (key: MessageKey, params?: Record<string, string | number>) => string;
+export declare const TranslateContext: import('react').Context<Translate | undefined>;
+/**
+ * The `t` a design-system component calls.
+ *
+ * **This package carries no i18n.** It declares the keys it needs and ships the
+ * translations for them (`orxataMessages`, already in i18next's `{{name}}`
+ * spelling), and the application resolves them with the i18n it already has:
+ *
+ * ```ts
+ * Object.entries(orxataMessages).forEach(([locale, messages]) =>
+ *   i18n.addResourceBundle(locale, 'translation', messages, true, false)
+ * );
+ * ```
+ *
+ * ```tsx
+ * <OxLocaleProvider locale="es" t={t}>
+ *   <App />
+ * </OxLocaleProvider>
+ * ```
+ *
+ * With no `t` injected, a key reads its English source, with its `{name}` blanks
+ * filled — a dictionary lookup, not a fallback chain and not a locale. That is
+ * enough to keep a component renderable on its own in a test, and honest about
+ * being English rather than a translation.
+ */
+export declare const useTranslate: () => Translate;

package/dist/main.d.ts

@@ -16,7 +16,9 @@ export { Divider as OxDivider, type DividerProps, } from './Layout/Divider/index
 export { Resizable as OxResizable, ResizablePanel as OxResizablePanel, ResizableHandle as OxResizableHandle, } from './Layout/Resizable/index.ts';
 export { Scrollbar as OxScrollbar, useScrollbar, SCROLLBAR_THICKNESS, type ScrollbarProps, type UseScrollbarReturn, } from './Layout/Scrollbar/index.ts';
 export { LocaleProvider as OxLocaleProvider } from './Locale/index.ts';
-export { normalizeLocale, useLocale } from './Locale/index.ts';
+export { normalizeLocale, useLocale, useTranslate, type Translate, } from './Locale/index.ts';
+export { LocaleContext, TranslateContext } from './Locale/index.ts';
+export { english, orxataMessages, type MessageKey, type Messages, } from './Locale/index.ts';
 export { AvatarRounded as OxAvatarRounded, AvatarSkeleton as OxAvatarSkeleton, AvatarSquare as OxAvatarSquare, avatarRoundedVariants, avatarSquareVariants, type AvatarRoundedVariants, type AvatarSize, type AvatarSquareVariants, type AvatarTone, } from './Display/Avatar/index.ts';
 export { AvatarDetails as OxAvatarDetails, type AvatarDetailsAvatar, } from './Display/AvatarDetails/index.ts';
 export { AvatarGroup as OxAvatarGroup, type AvatarItem, } from './Display/AvatarGroup/index.ts';
@@ -30,7 +32,7 @@ export { ChatBubble as OxChatBubble, chatBubbleVariants, type ChatBubbleDelivery
 export { ChatBubbleStatus as OxChatBubbleStatus, chatBubbleStatusVariants, type ChatBubbleStatusVariants, } from './Display/ChatBubble/ChatBubbleStatus/index.ts';
 export { Chip as OxChip, chipVariants, type ChipVariants, } from './Display/Chip/index.ts';
 export { PointMarker as OxPointMarker, pointMarkerVariants, type PointMarkerVariants, } from './Display/PointMarker/index.ts';
-export { StatusBadge as OxStatusBadge, statusBadgeVariants, indicatorVariants, type StatusBadgeVariants, } from './Feedback/StatusBadge/index.ts';
+export { StatusBadge as OxStatusBadge, statusBadgeVariants, type StatusBadgeVariants, } from './Feedback/StatusBadge/index.ts';
 export { Bullet as OxBullet, bulletVariants, type BulletVariants, } from './Feedback/Bullet/index.ts';
 export { Loader as OxLoader } from './Feedback/Loader/index.ts';
 export { Progress as OxProgress } from './Feedback/Progress/index.ts';