gantri-components 2.130.0 → 2.132.0

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-sku/__tests__/generate-sku.test.d.ts

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

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

@@ -0,0 +1,30 @@
+import { GenerateSkuProps } from './generate-sku.types';
+/**
+ * Provide a product's selected options and get the configured sku back.
+ *
+ * *`variants` must be input in the same index order they were provided in!*
+ *
+ * @example
+ *
+ * // options as strings
+ * const sku = generateSku({
+ *   color: 'carbon',
+ *   productId: 123456,
+ *   size: 'sm',
+ *   variants: ['chrome_rod_finish', 'white_cord_color'],
+ * });
+ *
+ * // options as code objects
+ * const sku = generateSku({
+ *   color: { code: 'carbon' },
+ *   productId: 123456,
+ *   size: { code: 'sm' },
+ *   variants: [{ code: 'chrome_rod_finish' }, { code: 'white_cord_color' }],
+ * });
+ *
+ * @returns
+ * ```
+ * '123456-sm-carbon-chrome_rod_finish-white_cord_color'
+ * ```
+ */
+export declare const generateSku: (props: GenerateSkuProps) => string;

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

@@ -0,0 +1,7 @@
+import { ProductOption } from '../generate-skus.types';
+export interface GenerateSkuProps {
+    color: ProductOption;
+    productId: number;
+    size: ProductOption;
+    variants: ProductOption[] | null | undefined;
+}

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

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

package/dist/helpers/generate-skus-functions/generate-skus/__tests__/generate-skus.test.d.ts

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

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

@@ -0,0 +1,41 @@
+import { GenerateSkusProps } from './generate-skus.types';
+/**
+ * Provide all of a product's options and get all possible skus back.
+ *
+ * *`variants` must be input in the same index order they were provided in!*
+ *
+ * @example
+ *
+ * // options as strings
+ * const sku = generateSkus({
+ *   color: ['carbon', 'snow'],
+ *   productId: 123456,
+ *   size: 'sm',
+ *   variants: [
+ *     ['chrome_rod_finish'],
+ *     ['black_cord_color', 'white_cord_color']
+ *   ],
+ * });
+ *
+ * // options as code objects
+ * const sku = generateSkus({
+ *   color: [{ code: 'carbon' }, {code: 'snow'}],
+ *   productId: 123456,
+ *   size: { code: 'sm' },
+ *   variants: [
+ *     [{ code: 'chrome_rod_finish' }],
+ *     [{ code: 'black_cord_color' }, { code: 'white_cord_color' }]
+ *   ],
+ * });
+ *
+ * @returns
+ * ```
+ * [
+ *   '123456-sm-carbon-chrome_rod_finish-black_cord_color',
+ *   '123456-sm-carbon-chrome_rod_finish-white_cord_color',
+ *   '123456-sm-snow-chrome_rod_finish-black_cord_color',
+ *   '123456-sm-snow-chrome_rod_finish-white_cord_color'
+ * ]
+ * ```
+ */
+export declare const generateSkus: (props: GenerateSkusProps) => string[];

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

@@ -0,0 +1,7 @@
+import { ProductOption } from '../generate-skus.types';
+export interface GenerateSkusProps {
+    colors: ProductOption[] | null | undefined;
+    productId: number;
+    size: ProductOption;
+    variants: ProductOption[][] | null | undefined;
+}

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

@@ -0,0 +1 @@
+export * from './generate-skus';

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

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

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

@@ -0,0 +1,42 @@
+import { GenerateSkusForProductIdProps } from './generate-skus-for-product-id.types';
+/**
+ * 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!*
+ *
+ * @example
+ *
+ * // options as strings
+ * const sku = generateSkusForProductId({
+ *   isPainted: true,
+ *   productId: 123456,
+ *   size: 'sm',
+ *   variants: [
+ *     ['chrome_rod_finish'],
+ *     ['black_cord_color', 'white_cord_color']
+ *   ],
+ * });
+ *
+ * // options as code objects
+ * const sku = generateSkusForProductId({
+ *   isPainted: true,
+ *   productId: 123456,
+ *   size: { code: 'sm' },
+ *   variants: [
+ *     [{ code: 'chrome_rod_finish' }],
+ *     [{ code: 'black_cord_color' }, { code: 'white_cord_color' }]
+ *   ],
+ * });
+ *
+ * @returns
+ * ```
+ * [
+ *   '123456-sm-blossompink-chrome_rod_finish-black_cord_color',
+ *   '123456-sm-blossompink-chrome_rod_finish-white_cord_color',
+ *   '123456-sm-canyon-chrome_rod_finish-black_cord_color',
+ *   '123456-sm-canyon-chrome_rod_finish-white_cord_color',
+ *    ...etc
+ * ]
+ * ```
+ */
+export declare const generateSkusForProductId: (props: GenerateSkusForProductIdProps) => string[];

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

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

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

@@ -0,0 +1 @@
+export * from './generate-skus-for-product-id';

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

@@ -0,0 +1,3 @@
+export type ProductOption = {
+    code: string;
+} | string | null | undefined;

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/helpers/flatten-options/flatten-options.d.ts

@@ -0,0 +1,2 @@
+import { FlattenOptionsProps } from './flatten-options.types';
+export declare const flattenOptions: (props: FlattenOptionsProps) => string[][];

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

@@ -0,0 +1,6 @@
+import { ProductOption } from '../../generate-skus.types';
+export interface FlattenOptionsProps {
+    colors: ProductOption[] | null | undefined;
+    size: ProductOption;
+    variants: ProductOption[][] | null | undefined;
+}

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

@@ -0,0 +1 @@
+export * from './flatten-options';

package/dist/helpers/generate-skus-functions/helpers/generate-skus-from-options/generate-skus-from-options.d.ts

@@ -0,0 +1,2 @@
+import { GenerateSkusFromOptionsProps } from './generate-skus-from-options.types';
+export declare const generateSkusFromOptions: (props: GenerateSkusFromOptionsProps) => string[];

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

@@ -0,0 +1,5 @@
+export interface GenerateSkusFromOptionsProps {
+    loopNum?: number;
+    options: string[][];
+    partialSkus: string[];
+}

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

@@ -0,0 +1 @@
+export * from './generate-skus-from-options';

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

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

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

@@ -0,0 +1,4 @@
+export declare const momaExclusiveColorsProductIds: number[];
+export declare const momaExclusiveColorCodes: readonly ["cobalt", "poppy"];
+export declare const kobbleExclusiveColorsProductIds: number[];
+export declare const kobbleExclusiveColorCodes: readonly ["glossysnowwhite"];

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

@@ -0,0 +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/helpers/get-is-color-available-for-product-id/index.d.ts

@@ -0,0 +1 @@
+export * from './get-is-color-available-for-product-id';

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

@@ -0,0 +1,3 @@
+export * from './flatten-options';
+export * from './generate-skus-from-options';
+export * from './get-is-color-available-for-product-id';

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

@@ -0,0 +1,5 @@
+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-details';

package/dist/helpers/index.d.ts

@@ -1,3 +1,4 @@
 export * from './layout.helpers';
 export * from './get-file-url';
 export * from './get-folder-structure';
+export * from './generate-skus-functions';