@flipdish/ui-library 0.31.3 → 0.31.5

package/dist/utilities/testIdUtils/index.d.ts

@@ -18,19 +18,45 @@
 export declare const TEST_ID_PREFIX = "fd";
 /** Separator placed between hierarchy levels (within a segment, use single `-`). */
 export declare const TEST_ID_SEPARATOR = "--";
-/** Convert an arbitrary string into a kebab-case, testid-safe segment. */
+/**
+ * Converts an arbitrary string into a kebab-case, testid-safe segment.
+ *
+ * @param value A label or id, in any case or punctuation.
+ * @returns Lower-case text with runs of non-alphanumerics collapsed to single hyphens.
+ */
 export declare const slugifyTestId: (value: string) => string;
-/** Build a root-level testid, e.g. `rootTestId('sidebar-navigation')` -> `fd-sidebar-navigation`. */
+/**
+ * Builds a root-level testid, e.g. `rootTestId('sidebar-navigation')` ->
+ * `fd-sidebar-navigation`.
+ *
+ * @param kebabName The component's kebab-case name.
+ * @returns The name prefixed with `fd-`.
+ */
 export declare const rootTestId: (kebabName: string) => string;
-/** Append a child segment to a parent testid, e.g. `joinTestId('fd-x', 'nav-item-orders')` -> `fd-x--nav-item-orders`. */
+/**
+ * Appends a child segment to a parent testid, e.g. `joinTestId('fd-x', 'nav-item-orders')` ->
+ * `fd-x--nav-item-orders`.
+ *
+ * @param prefix The ancestor's resolved testid.
+ * @param segment The child's own segment, already slugified.
+ * @returns The two joined with `--`.
+ */
 export declare const joinTestId: (prefix: string, segment: string) => string;
-/** Return the override when provided, otherwise the fallback (explicit-child case). */
+/**
+ * Returns the override when provided, otherwise the fallback (explicit-child case).
+ *
+ * @param override A consumer-provided `data-testid`, if any.
+ * @param fallback The derived default to use without one.
+ * @returns Whichever applies.
+ */
 export declare const resolveTestId: (override: string | undefined, fallback: string) => string;
 /**
- * Spread helper for the resolved testid. Returns `{ 'data-testid': value }` when
- * a value is present, otherwise an empty object. Centralising this keeps the
- * emitted attribute name in one place (a React Native sibling can map it to
- * `testID` in a follow-up without touching call sites).
+ * Spread helper for a resolved test id: `{ 'data-testid': value }` when present, else an empty
+ * object. Centralising it keeps the attribute name in one place so a React Native sibling can
+ * map it to `testID`.
+ *
+ * @param testId The resolved id, or `undefined` to emit nothing.
+ * @returns Props to spread onto the rendered element.
  */
 export declare const testIdProps: (testId: string | undefined) => {
     "data-testid"?: string;
@@ -39,7 +65,11 @@ export declare const testIdProps: (testId: string | undefined) => {
 export declare const TestIdContext: import("react").Context<string | undefined>;
 /** Provides a resolved testid as the prefix for descendant library components. */
 export declare const TestIdProvider: import("react").Provider<string | undefined>;
-/** Read the testid prefix contributed by an ancestor component (`undefined` at the root). */
+/**
+ * Reads the testid prefix contributed by an ancestor component.
+ *
+ * @returns The ancestor's resolved testid, or `undefined` at the root.
+ */
 export declare const useTestIdPrefix: () => string | undefined;
 export interface UseResolvedTestIdOptions {
     /** Consumer-provided override; wins over any derived value. */
@@ -50,8 +80,12 @@ export interface UseResolvedTestIdOptions {
     rootName: string;
 }
 /**
- * Resolve a component's testid: an explicit override wins; otherwise derive
+ * Resolves a component's testid: an explicit override wins; otherwise derive
  * `<ancestorPrefix>--<segment>` when nested, or `fd-<rootName>` at the root.
+ *
+ * @param options The consumer `testId` override, the component's `segment`, and its
+ *   `rootName`.
+ * @returns The id to render as `data-testid`.
  */
 export declare const useResolvedTestId: ({ testId, segment, rootName }: UseResolvedTestIdOptions) => string;
 //# sourceMappingURL=index.d.ts.map

package/dist/utilities/testIdUtils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utilities/testIdUtils/index.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;GAeG;AAEH,sDAAsD;AACtD,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC,oFAAoF;AACpF,eAAO,MAAM,iBAAiB,OAAO,CAAC;AAEtC,0EAA0E;AAC1E,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,KAAG,MAKlB,CAAC;AAE7B,qGAAqG;AACrG,eAAO,MAAM,UAAU,GAAI,WAAW,MAAM,KAAG,MAA0C,CAAC;AAE1F,0HAA0H;AAC1H,eAAO,MAAM,UAAU,GAAI,QAAQ,MAAM,EAAE,SAAS,MAAM,KAAG,MAAmD,CAAC;AAEjH,uFAAuF;AACvF,eAAO,MAAM,aAAa,GAAI,UAAU,MAAM,GAAG,SAAS,EAAE,UAAU,MAAM,KAAG,MAA8B,CAAC;AAE9G;;;;;GAKG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,MAAM,GAAG,SAAS,KAAG;IAAE,aAAa,CAAC,EAAE,MAAM,CAAA;CAA+C,CAAC;AAEjI,kGAAkG;AAClG,eAAO,MAAM,aAAa,6CAA+C,CAAC;AAE1E,kFAAkF;AAClF,eAAO,MAAM,cAAc,8CAAyB,CAAC;AAErD,6FAA6F;AAC7F,eAAO,MAAM,eAAe,QAAO,MAAM,GAAG,SAAsC,CAAC;AAEnF,MAAM,WAAW,wBAAwB;IACvC,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB,2EAA2E;IAC3E,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,GAAI,+BAA+B,wBAAwB,KAAG,MAG3F,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utilities/testIdUtils/index.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;GAeG;AAEH,sDAAsD;AACtD,eAAO,MAAM,cAAc,OAAO,CAAC;AAEnC,oFAAoF;AACpF,eAAO,MAAM,iBAAiB,OAAO,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,OAAO,MAAM,KAAG,MAKlB,CAAC;AAE7B;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,GAAI,WAAW,MAAM,KAAG,MAA0C,CAAC;AAE1F;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,MAAM,EAAE,SAAS,MAAM,KAAG,MAAmD,CAAC;AAEjH;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,MAAM,GAAG,SAAS,EAAE,UAAU,MAAM,KAAG,MAA8B,CAAC;AAE9G;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW,GAAI,QAAQ,MAAM,GAAG,SAAS,KAAG;IAAE,aAAa,CAAC,EAAE,MAAM,CAAA;CAA+C,CAAC;AAEjI,kGAAkG;AAClG,eAAO,MAAM,aAAa,6CAA+C,CAAC;AAE1E,kFAAkF;AAClF,eAAO,MAAM,cAAc,8CAAyB,CAAC;AAErD;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAO,MAAM,GAAG,SAAsC,CAAC;AAEnF,MAAM,WAAW,wBAAwB;IACvC,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB,2EAA2E;IAC3E,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,iBAAiB,GAAI,+BAA+B,wBAAwB,KAAG,MAG3F,CAAC"}

package/dist/utilities/testIdUtils/index.js

@@ -20,34 +20,68 @@ import { createContext, useContext } from 'react';
 const TEST_ID_PREFIX = 'fd';
 /** Separator placed between hierarchy levels (within a segment, use single `-`). */
 const TEST_ID_SEPARATOR = '--';
-/** Convert an arbitrary string into a kebab-case, testid-safe segment. */
+/**
+ * Converts an arbitrary string into a kebab-case, testid-safe segment.
+ *
+ * @param value A label or id, in any case or punctuation.
+ * @returns Lower-case text with runs of non-alphanumerics collapsed to single hyphens.
+ */
 const slugifyTestId = (value) => value
     .toLowerCase()
     .trim()
     .replace(/[^a-z0-9]+/g, '-')
     .replace(/^-+|-+$/g, '');
-/** Build a root-level testid, e.g. `rootTestId('sidebar-navigation')` -> `fd-sidebar-navigation`. */
+/**
+ * Builds a root-level testid, e.g. `rootTestId('sidebar-navigation')` ->
+ * `fd-sidebar-navigation`.
+ *
+ * @param kebabName The component's kebab-case name.
+ * @returns The name prefixed with `fd-`.
+ */
 const rootTestId = (kebabName) => `${TEST_ID_PREFIX}-${kebabName}`;
-/** Append a child segment to a parent testid, e.g. `joinTestId('fd-x', 'nav-item-orders')` -> `fd-x--nav-item-orders`. */
+/**
+ * Appends a child segment to a parent testid, e.g. `joinTestId('fd-x', 'nav-item-orders')` ->
+ * `fd-x--nav-item-orders`.
+ *
+ * @param prefix The ancestor's resolved testid.
+ * @param segment The child's own segment, already slugified.
+ * @returns The two joined with `--`.
+ */
 const joinTestId = (prefix, segment) => `${prefix}${TEST_ID_SEPARATOR}${segment}`;
-/** Return the override when provided, otherwise the fallback (explicit-child case). */
+/**
+ * Returns the override when provided, otherwise the fallback (explicit-child case).
+ *
+ * @param override A consumer-provided `data-testid`, if any.
+ * @param fallback The derived default to use without one.
+ * @returns Whichever applies.
+ */
 const resolveTestId = (override, fallback) => override ?? fallback;
 /**
- * Spread helper for the resolved testid. Returns `{ 'data-testid': value }` when
- * a value is present, otherwise an empty object. Centralising this keeps the
- * emitted attribute name in one place (a React Native sibling can map it to
- * `testID` in a follow-up without touching call sites).
+ * Spread helper for a resolved test id: `{ 'data-testid': value }` when present, else an empty
+ * object. Centralising it keeps the attribute name in one place so a React Native sibling can
+ * map it to `testID`.
+ *
+ * @param testId The resolved id, or `undefined` to emit nothing.
+ * @returns Props to spread onto the rendered element.
  */
 const testIdProps = (testId) => (testId ? { 'data-testid': testId } : {});
 /** Context carrying the current resolved testid, used as the prefix for descendant components. */
 const TestIdContext = createContext(undefined);
 /** Provides a resolved testid as the prefix for descendant library components. */
 const TestIdProvider = TestIdContext.Provider;
-/** Read the testid prefix contributed by an ancestor component (`undefined` at the root). */
+/**
+ * Reads the testid prefix contributed by an ancestor component.
+ *
+ * @returns The ancestor's resolved testid, or `undefined` at the root.
+ */
 const useTestIdPrefix = () => useContext(TestIdContext);
 /**
- * Resolve a component's testid: an explicit override wins; otherwise derive
+ * Resolves a component's testid: an explicit override wins; otherwise derive
  * `<ancestorPrefix>--<segment>` when nested, or `fd-<rootName>` at the root.
+ *
+ * @param options The consumer `testId` override, the component's `segment`, and its
+ *   `rootName`.
+ * @returns The id to render as `data-testid`.
  */
 const useResolvedTestId = ({ testId, segment, rootName }) => {
     const prefix = useTestIdPrefix();

package/dist/utilities/testIdUtils/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../src/utilities/testIdUtils/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAIA;;;;;;;;;;;;;;;AAeG;AAEH;AACO,MAAM,cAAc,GAAG;AAE9B;AACO,MAAM,iBAAiB,GAAG;AAEjC;MACa,aAAa,GAAG,CAAC,KAAa,KACzC;AACG,KAAA,WAAW;AACX,KAAA,IAAI;AACJ,KAAA,OAAO,CAAC,aAAa,EAAE,GAAG;AAC1B,KAAA,OAAO,CAAC,UAAU,EAAE,EAAE;AAE3B;AACO,MAAM,UAAU,GAAG,CAAC,SAAiB,KAAa,CAAA,EAAG,cAAc,CAAA,CAAA,EAAI,SAAS;AAEvF;AACO,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,OAAe,KAAa,GAAG,MAAM,CAAA,EAAG,iBAAiB,CAAA,EAAG,OAAO;AAE9G;AACO,MAAM,aAAa,GAAG,CAAC,QAA4B,EAAE,QAAgB,KAAa,QAAQ,IAAI;AAErG;;;;;AAKG;AACI,MAAM,WAAW,GAAG,CAAC,MAA0B,MAAkC,MAAM,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE;AAE/H;MACa,aAAa,GAAG,aAAa,CAAqB,SAAS;AAExE;AACO,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C;AACO,MAAM,eAAe,GAAG,MAA0B,UAAU,CAAC,aAAa;AAWjF;;;AAGG;AACI,MAAM,iBAAiB,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAA4B,KAAY;AACnG,IAAA,MAAM,MAAM,GAAG,eAAe,EAAE;IAChC,OAAO,MAAM,KAAK,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;AAChF;;"}
+{"version":3,"file":"index.js","sources":["../../../src/utilities/testIdUtils/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAIA;;;;;;;;;;;;;;;AAeG;AAEH;AACO,MAAM,cAAc,GAAG;AAE9B;AACO,MAAM,iBAAiB,GAAG;AAEjC;;;;;AAKG;MACU,aAAa,GAAG,CAAC,KAAa,KACzC;AACG,KAAA,WAAW;AACX,KAAA,IAAI;AACJ,KAAA,OAAO,CAAC,aAAa,EAAE,GAAG;AAC1B,KAAA,OAAO,CAAC,UAAU,EAAE,EAAE;AAE3B;;;;;;AAMG;AACI,MAAM,UAAU,GAAG,CAAC,SAAiB,KAAa,CAAA,EAAG,cAAc,CAAA,CAAA,EAAI,SAAS;AAEvF;;;;;;;AAOG;AACI,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,OAAe,KAAa,GAAG,MAAM,CAAA,EAAG,iBAAiB,CAAA,EAAG,OAAO;AAE9G;;;;;;AAMG;AACI,MAAM,aAAa,GAAG,CAAC,QAA4B,EAAE,QAAgB,KAAa,QAAQ,IAAI;AAErG;;;;;;;AAOG;AACI,MAAM,WAAW,GAAG,CAAC,MAA0B,MAAkC,MAAM,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,GAAG,EAAE;AAE/H;MACa,aAAa,GAAG,aAAa,CAAqB,SAAS;AAExE;AACO,MAAM,cAAc,GAAG,aAAa,CAAC;AAE5C;;;;AAIG;AACI,MAAM,eAAe,GAAG,MAA0B,UAAU,CAAC,aAAa;AAWjF;;;;;;;AAOG;AACI,MAAM,iBAAiB,GAAG,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAA4B,KAAY;AACnG,IAAA,MAAM,MAAM,GAAG,eAAe,EAAE;IAChC,OAAO,MAAM,KAAK,MAAM,GAAG,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC;AAChF;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flipdish/ui-library",
-  "version": "0.31.3",
+  "version": "0.31.5",
   "description": "Flipdish Design System — atomic-design component library (Tailwind v4 + UntitledUI + React Aria).",
   "type": "module",
   "imports": {