gantri-components 2.129.0-beta.1 → 2.129.0-beta.10

package/dist/components/components.types.d.ts

@@ -1,6 +1,9 @@
+import { TooltipProps } from './tooltip/tooltip.types';
 export type DynamicListItem<T extends Record<any, any>> = T & {
     disabled?: boolean;
-    disabledTooltipDescription?: string;
+    /** @deprecated use `disabledTooltipProps` to provide any overrides. */
+    disabledTooltipDescription?: TooltipProps['description'];
+    disabledTooltipProps?: TooltipProps;
 };
 export type DynamicListItemDefaultData = {
     label: string;

package/dist/components/tooltip/tooltip.types.d.ts

@@ -11,8 +11,10 @@ export type TooltipProps = Partial<TooltipDefaultProps> & Pick<OverlayProps, 'on
     /** Milliseconds to delay the unhover behavior. */
     closeDelay?: number;
     description?: string;
+    descriptionHtmlText?: string;
     descriptionTx?: string;
     title?: string;
+    titleHtmlText?: string;
     titleTx?: string;
 };
 export type TooltipDefaultProps = Required<Pick<OverlayProps, 'position' | 'triggerEvent'>> & {

package/dist/helpers/generate-skus-functions/generate-skus-for-product-id/generate-skus-for-product-id.d.ts

@@ -1,6 +1,6 @@
 import { GenerateSkusForProductIdProps } from './generate-skus-for-product-id.types';
 /**
- * Provide all of a product's options (available colors are automatically configured based on product ID) and get all possible skus back.
+ * Provide all of a product's options (if `isPainted` is `true`, available colors are automatically configured based on product ID) and get all possible skus back.
  *
  * *`variants` must be input in the same index order they were provided in!*
  *
@@ -8,6 +8,7 @@ import { GenerateSkusForProductIdProps } from './generate-skus-for-product-id.ty
  *
  * // options as strings
  * const sku = generateSkusForProductId({
+ *   isPainted: true,
  *   productId: 123456,
  *   size: 'sm',
  *   variants: [
@@ -18,6 +19,7 @@ import { GenerateSkusForProductIdProps } from './generate-skus-for-product-id.ty
  *
  * // options as code objects
  * const sku = generateSkusForProductId({
+ *   isPainted: true,
  *   productId: 123456,
  *   size: { code: 'sm' },
  *   variants: [

package/dist/helpers/generate-skus-functions/generate-skus-for-product-id/generate-skus-for-product-id.types.d.ts

@@ -1,5 +1,7 @@
 import { ProductOption } from '../generate-skus.types';
 export interface GenerateSkusForProductIdProps {
+    allowTradeColors: boolean;
+    isPainted: boolean;
     productId: number;
     size: ProductOption;
     variants: ProductOption[][] | null | undefined;

package/dist/helpers/generate-skus-functions/generate-skus.types.d.ts

@@ -1,14 +1,3 @@
-export interface VariantOption {
-    code: string;
-    name: string;
-    selections: VariantSelection[];
-}
-interface VariantSelection {
-    code: string;
-    label: string;
-    name: string;
-}
 export type ProductOption = {
     code: string;
 } | string | null | undefined;
-export {};

package/dist/helpers/generate-skus-functions/get-colors-by-product/__tests__/get-colors-by-product.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/generate-skus-functions/get-colors-by-product/get-colors-by-product.d.ts

@@ -0,0 +1,5 @@
+import { GetColorsByProductProps, ProductColorDetail } from './get-colors-by-product.types';
+/**
+ * Returns an array of colors that are available for a particular product ID.
+ */
+export declare const getColorsByProduct: (props: GetColorsByProductProps) => ProductColorDetail[];

package/dist/helpers/generate-skus-functions/get-colors-by-product/get-colors-by-product.types.d.ts

@@ -0,0 +1,11 @@
+import { ProductColorCode } from '../../../styles/theme';
+export interface ProductColorDetail {
+    code: ProductColorCode;
+    hexColor: string;
+    shortColorName: string;
+}
+export interface GetColorsByProductProps {
+    allowTradeColors: boolean;
+    isPainted: boolean;
+    productId: number;
+}

package/dist/helpers/generate-skus-functions/get-colors-by-product/index.d.ts

@@ -0,0 +1,2 @@
+export * from './get-colors-by-product';
+export * from './get-colors-by-product.types';

package/dist/helpers/generate-skus-functions/get-sku-details/get-sku-details.d.ts

@@ -0,0 +1,31 @@
+import { GetSkuDetailsProps } from './get-sku-details.types';
+/**
+ * Provide a sku and the variant options and get all the product option codes back.
+ *
+ * *`variantOptions` must be input in the same index order they were provided in!*
+ */
+export declare const getSkuDetails: (props: GetSkuDetailsProps) => {
+    color: string;
+    productId: number;
+    size: string;
+    /**
+     * The partial codes that make up the full variant code.
+     *
+     * @example
+     * ```
+     * // variants === ['black_7_10_feet_cord', 'chrome_rod_finish']
+     *
+     * [
+     *   ['black', '7_10_feet'],
+     *   ['chrome']
+     * ]
+     * ```
+     */
+    variantPartials: string[][];
+    /**
+     * The full variant codes.
+     *
+     * @example ['black_7_10_feet_cord', 'chrome_rod_finish']
+     */
+    variants: string[];
+};

package/dist/helpers/generate-skus-functions/get-sku-details/get-sku-details.types.d.ts

@@ -0,0 +1,18 @@
+export interface GetSkuDetailsProps {
+    sku: string;
+    skuPartialCodes: SkuPartialCode[][];
+}
+export interface SkuPartialCode {
+    /**
+     * The full variant code.
+     *
+     * @example 'black_7_10_feet_cord'
+     */
+    code: string;
+    /**
+     * The partial codes that make up the full variant code.
+     *
+     * @example ['black', '7_10_feet']
+     */
+    partialCodes: string[];
+}

package/dist/helpers/generate-skus-functions/get-sku-details/index.d.ts

@@ -0,0 +1 @@
+export * from './get-sku-details';

package/dist/helpers/generate-skus-functions/get-sku-selectors/get-sku-selectors.d.ts

@@ -8,6 +8,6 @@ export declare const getSkuSelectors: (props: GetSkuSelectorsProps) => {
     colorCode: string;
     productId: number;
     sizeCode: string;
-    variantCodes: string[];
-    variantSelectionCodes: string[][];
+    variantCompleteCodes: string[];
+    variantPartialCodes: string[][];
 };

package/dist/helpers/generate-skus-functions/get-sku-selectors/get-sku-selectors.types.d.ts

@@ -1,5 +1,8 @@
-import { VariantOption } from '../generate-skus.types';
 export interface GetSkuSelectorsProps {
     sku: string;
-    variantOptions: VariantOption[][];
+    variantOptions: VariantDetails[][];
+}
+export interface VariantDetails {
+    code: string;
+    partialCodes: string[];
 }

package/dist/helpers/generate-skus-functions/helpers/get-is-color-available-for-product-id/get-is-color-available-for-product-id.d.ts

@@ -1,5 +1,6 @@
 import { ProductColorCode } from '../../../../styles/theme';
 export declare const getIsColorAvailableForProductId: (props: {
+    allowTradeColors: boolean;
     colorCode: ProductColorCode;
     productId: number;
 }) => boolean;

package/dist/helpers/generate-skus-functions/index.d.ts

@@ -1,5 +1,5 @@
-export * from './get-colors-by-product-id';
+export * from './get-colors-by-product';
 export * from './generate-sku';
 export * from './generate-skus';
 export * from './generate-skus-for-product-id';
-export * from './get-sku-selectors';
+export * from './get-sku-details';