@kaizen/components 0.0.0-canary-test-slack-notify-20230816042051

package/dist/esm/dts/KaizenProvider/ThemeProvider/themes/types.d.ts

@@ -0,0 +1,229 @@
+import type { CSSProperties as ReactCSSProperties } from "react";
+/**
+ * Use a custom type for CSS properties becauase we should eventually write a more strongly typed version using template literal types.
+ * This could definitely be contributed back to the community too. An example starting point here https://github.com/ghoullier/awesome-template-literal-types#css-parser
+ * For example:
+ * ```ts
+ * type Font = {
+ *   fontSize: `${number}rem`,
+ *
+ *  }
+ * type HexDigit = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | A | B | C | D | E | F ;
+ * type Color = `rgba(${number}, ${number}, ${number}, ${number}) | #${HexDigit}${HexDigit}${HexDigit}` // You get the point
+ *
+ * ```
+ * */
+type KaizenCSSProperties = ReactCSSProperties;
+type Hex = string;
+export type TypographyFont = {
+    fontFamily: KaizenCSSProperties["fontFamily"];
+    fontWeight: KaizenCSSProperties["fontWeight"];
+    fontSize: KaizenCSSProperties["fontSize"];
+    lineHeight: KaizenCSSProperties["lineHeight"];
+    letterSpacing: KaizenCSSProperties["letterSpacing"];
+};
+export type ThemeKey = "heart" | "custom";
+export type Theme = {
+    themeKey: ThemeKey;
+    border: {
+        solid: {
+            borderWidth: KaizenCSSProperties["borderWidth"];
+            borderRadius: KaizenCSSProperties["borderRadius"];
+            borderStyle: KaizenCSSProperties["borderStyle"];
+            borderColor: KaizenCSSProperties["borderColor"];
+        };
+        dashed: {
+            borderWidth: KaizenCSSProperties["borderWidth"];
+            borderRadius: KaizenCSSProperties["borderRadius"];
+            borderStyle: KaizenCSSProperties["borderStyle"];
+        };
+        borderless: {
+            borderWidth: KaizenCSSProperties["borderWidth"];
+            borderRadius: KaizenCSSProperties["borderRadius"];
+            borderStyle: KaizenCSSProperties["borderStyle"];
+            borderColor: KaizenCSSProperties["borderColor"];
+        };
+        focusRing: {
+            borderWidth: KaizenCSSProperties["borderWidth"];
+            borderRadius: KaizenCSSProperties["borderRadius"];
+            borderStyle: KaizenCSSProperties["borderStyle"];
+        };
+    };
+    animation: {
+        easingFunction: {
+            easeInOut: string;
+            easeIn: string;
+            easeOut: string;
+            linear: string;
+            bounceIn: string;
+            bounceOut: string;
+            bounceInOut: string;
+        };
+        duration: {
+            instant: string;
+            immediate: string;
+            rapid: string;
+            fast: string;
+            slow: string;
+            deliberate: string;
+        };
+    };
+    color: {
+        purple: {
+            "100": Hex;
+            "200": Hex;
+            "300": Hex;
+            "400": Hex;
+            "500": Hex;
+            "600": Hex;
+            "700": Hex;
+            "800": Hex;
+        };
+        blue: {
+            "100": Hex;
+            "200": Hex;
+            "300": Hex;
+            "400": Hex;
+            "500": Hex;
+            "600": Hex;
+            "700": Hex;
+        };
+        green: {
+            "100": Hex;
+            "200": Hex;
+            "300": Hex;
+            "400": Hex;
+            "500": Hex;
+            "600": Hex;
+            "700": Hex;
+        };
+        yellow: {
+            "100": Hex;
+            "200": Hex;
+            "300": Hex;
+            "400": Hex;
+            "500": Hex;
+            "600": Hex;
+            "700": Hex;
+        };
+        red: {
+            "100": Hex;
+            "200": Hex;
+            "300": Hex;
+            "400": Hex;
+            "500": Hex;
+            "600": Hex;
+            "700": Hex;
+        };
+        orange: {
+            "100": Hex;
+            "200": Hex;
+            "300": Hex;
+            "400": Hex;
+            "500": Hex;
+            "600": Hex;
+            "700": Hex;
+        };
+        gray: {
+            "100": Hex;
+            "200": Hex;
+            "300": Hex;
+            "400": Hex;
+            "500": Hex;
+            "600": Hex;
+        };
+        white: Hex;
+    };
+    dataViz: {
+        favorable: Hex;
+        unfavorable: Hex;
+    };
+    layout: {
+        contentMaxWidth: string;
+        contentMaxWidthWithSidebar: string;
+        contentSideMargin: string;
+        mobileActionsDrawerHeight: string;
+        navigationBarHeight: string;
+        breakpoints: {
+            medium: string;
+            large: string;
+        };
+    };
+    shadow: {
+        small: {
+            boxShadow: string;
+        };
+        large: {
+            boxShadow: string;
+        };
+    };
+    spacing: {
+        xs: string;
+        sm: string;
+        md: string;
+        lg: string;
+        xl: string;
+        xxl: string;
+        xxxl: string;
+        xxxxl: string;
+        xxxxxl: string;
+        0: string;
+        1: string;
+        2: string;
+        4: string;
+        6: string;
+        8: string;
+        12: string;
+        16: string;
+        24: string;
+        32: string;
+        40: string;
+        48: string;
+        56: string;
+        64: string;
+        72: string;
+        80: string;
+        96: string;
+        112: string;
+        128: string;
+        160: string;
+        200: string;
+        240: string;
+        280: string;
+        320: string;
+    };
+    typography: {
+        dataLarge: TypographyFont;
+        dataLargeUnits: TypographyFont;
+        dataMedium: TypographyFont;
+        dataMediumUnits: TypographyFont;
+        dataSmall: TypographyFont;
+        dataSmallUnits: TypographyFont;
+        display0: TypographyFont;
+        heading1: TypographyFont;
+        heading2: TypographyFont;
+        heading3: TypographyFont;
+        heading4: TypographyFont;
+        heading5: TypographyFont;
+        heading6: TypographyFont;
+        paragraphIntroLede: TypographyFont;
+        paragraphBody: TypographyFont;
+        paragraphSmall: TypographyFont;
+        paragraphExtraSmall: TypographyFont;
+        paragraphBold: {
+            fontWeight: KaizenCSSProperties["fontWeight"];
+        };
+        buttonPrimary: TypographyFont;
+        buttonSecondary: TypographyFont;
+    };
+};
+export type DeepMapObjectLeafs<T, LeafType> = T extends string | number | bigint | boolean | symbol | null | undefined | ((...params: any[]) => any) ? LeafType : T extends Record<any, any> ? {
+    [Key in keyof T]: DeepMapObjectLeafs<T[Key], LeafType>;
+} : T;
+/**
+ * Apologies for the complex types.
+ * This type represents the Theme type but with every leaf value in the tree mapped strictly to a string, rather than a number or a more complex type such as a string union.
+ * The reason for this is to have a more accurate type for the generated hierarchy of design tokens which are represented as CSS custom properties, e.g. `var(--color-purple-800)`.
+ */
+export type CSSVariableTheme = DeepMapObjectLeafs<Theme, string>;
+export {};

package/dist/esm/dts/KaizenProvider/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./KaizenProvider";
+export * from "./ThemeProvider";

package/dist/esm/dts/LabelledMessage/LabelledMessage.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+export interface LabelledMessageProps {
+    label: string | React.ReactElement;
+    message: string | React.ReactElement;
+}
+export declare const LabelledMessage: {
+    ({ label, message, }: LabelledMessageProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/LabelledMessage/index.d.ts

@@ -0,0 +1 @@
+export * from "./LabelledMessage";

package/dist/esm/dts/SVG/SVG.d.ts

@@ -0,0 +1,19 @@
+import { ReactNode, SVGAttributes } from "react";
+import { OverrideClassName } from "../types/OverrideClassName";
+type RolesType = "img" | "presentation";
+export interface SVGProps extends OverrideClassName<SVGAttributes<SVGElement>> {
+    children: ReactNode;
+    inheritSize?: boolean;
+    role?: RolesType;
+    title?: string;
+    desc?: string;
+}
+/**
+ * {@link https://cultureamp.design/components/icon/ Guidance} |
+ * {@link https://cultureamp.design/storybook/?path=/docs/components-icon--meaningful-kaizen-site-demo Storybook}
+ */
+export declare const SVG: {
+    ({ inheritSize, role, title, desc, viewBox, classNameOverride, children, ...props }: SVGProps): JSX.Element;
+    displayName: string;
+};
+export {};

package/dist/esm/dts/SVG/icons/AddIcon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const AddIcon: {
+    (props: Omit<SVGProps, "children">): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/SVG/icons/ArrowRightIcon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const ArrowRightIcon: {
+    (props: Omit<SVGProps, "children">): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/SVG/icons/CheckIcon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const CheckIcon: {
+    (props: Omit<SVGProps, "children">): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/SVG/icons/ChevronDownIcon.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const ChevronDownIcon: (props: Omit<SVGProps, "children">) => JSX.Element;

package/dist/esm/dts/SVG/icons/ChevronUpIcon.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const ChevronUpIcon: (props: Omit<SVGProps, "children">) => JSX.Element;

package/dist/esm/dts/SVG/icons/ClearIcon.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const ClearIcon: (props: Omit<SVGProps, "children">) => JSX.Element;

package/dist/esm/dts/SVG/icons/CloseIcon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const CloseIcon: {
+    (props: Omit<SVGProps, "children">): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/SVG/icons/EmailIcon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const EmailIcon: {
+    (props: Omit<SVGProps, "children">): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/SVG/icons/IndicatorActiveIcon.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const IndicatorActiveIcon: (props: Omit<SVGProps, "children">) => JSX.Element;

package/dist/esm/dts/SVG/icons/IndicatorInactiveIcon.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const IndicatorInactiveIcon: (props: Omit<SVGProps, "children">) => JSX.Element;

package/dist/esm/dts/SVG/icons/SearchIcon.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const SearchIcon: {
+    (props: Omit<SVGProps, "children">): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/SVG/icons/SuccessIcon.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const SuccessIcon: (props: Omit<SVGProps, "children">) => JSX.Element;

package/dist/esm/dts/SVG/icons/VisibleIcon.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="react" />
+import { SVGProps } from "..";
+export declare const VisibleIcon: (props: Omit<SVGProps, "children">) => JSX.Element;

package/dist/esm/dts/SVG/index.d.ts

@@ -0,0 +1 @@
+export * from "./SVG";

package/dist/esm/dts/Workflow/Workflow.d.ts

@@ -0,0 +1,29 @@
+import { HTMLAttributes } from "react";
+import { OverrideClassName } from "../types/OverrideClassName";
+import { FooterProps, HeaderProps } from "./subcomponents";
+export type WorkflowProps = OverrideClassName<HTMLAttributes<HTMLDivElement>> & FooterProps & HeaderProps;
+/**
+ * @deprecated Use { Workflow } from `@kaizen/components/future`
+ */
+export declare const Workflow: (({ stepName, steps, isComplete, workflowName, status, headerActions, children, nextAction, previousAction, classNameOverride, ...restProps }: WorkflowProps) => JSX.Element) & {
+    Header: {
+        ({ workflowName, stepName, status, headerActions, ...restProps }: HeaderProps): JSX.Element;
+        displayName: string;
+    };
+    Footer: {
+        ({ steps, stepName, isComplete, previousAction, nextAction, ...restProps }: FooterProps): JSX.Element;
+        displayName: string;
+    };
+    Main: {
+        ({ children, classNameOverride, ...restProps }: import("./subcomponents").WorkflowMainProps): JSX.Element;
+        displayName: string;
+    };
+    ProgressStepper: {
+        ({ stepName, steps, isComplete, ...restprops }: import("./subcomponents").ProgressStepperProps): JSX.Element;
+        displayName: string;
+    };
+    Wrapper: {
+        ({ children, classNameOverride, ...restProps }: import("./subcomponents").WorkflowWrapperProps): JSX.Element;
+        displayName: string;
+    };
+};

package/dist/esm/dts/Workflow/_docs/controls/controls.d.ts

@@ -0,0 +1,47 @@
+import React from "react";
+export declare const WorkflowControls: {
+    headerActions: {
+        control: {
+            type: string;
+        };
+        options: {
+            "Single action": React.JSX.Element[];
+            "Multiple actions": React.JSX.Element[];
+            "No actions": never[];
+        };
+    };
+    nextAction: {
+        control: {
+            type: string;
+        };
+        options: {
+            "Next active": React.JSX.Element;
+            "Next disabled": React.JSX.Element;
+            "Next submit": React.JSX.Element;
+            "No next action": undefined;
+        };
+    };
+    previousAction: {
+        control: {
+            type: string;
+        };
+        options: {
+            "Previous active": React.JSX.Element;
+            "Previous disabled": React.JSX.Element;
+            "Previous submit": React.JSX.Element;
+            "No Previous action": undefined;
+        };
+    };
+    currentStepId: {
+        control: {
+            type: string;
+        };
+        options: {
+            "settings-step": string;
+            "questions-step": string;
+            "preview-step": string;
+            "employees-step": string;
+            "schedule-step": string;
+        };
+    };
+};

package/dist/esm/dts/Workflow/_docs/controls/index.d.ts

@@ -0,0 +1 @@
+export * from "./controls";

package/dist/esm/dts/Workflow/index.d.ts

@@ -0,0 +1 @@
+export * from "./Workflow";

package/dist/esm/dts/Workflow/subcomponents/Footer/Footer.d.ts

@@ -0,0 +1,13 @@
+import { HTMLAttributes } from "react";
+import { OverrideClassName } from "../../../types/OverrideClassName";
+import { ProgressStepperProps } from "./components";
+export interface FooterProps extends OverrideClassName<Omit<HTMLAttributes<HTMLElement>, "children">>, ProgressStepperProps {
+    /** An action to return to a previous step */
+    previousAction?: JSX.Element;
+    /** An action to progress to the next step or submit the form */
+    nextAction?: JSX.Element;
+}
+export declare const Footer: {
+    ({ steps, stepName, isComplete, previousAction, nextAction, ...restProps }: FooterProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Footer/components/FooterActions/FooterActions.d.ts

@@ -0,0 +1,12 @@
+import { HTMLAttributes } from "react";
+import { OverrideClassName } from "../../../../../types/OverrideClassName";
+export interface FooterActionsProps extends OverrideClassName<Omit<HTMLAttributes<HTMLDivElement>, "children">> {
+    /** @default "start" */
+    actionType?: "Previous" | "Next";
+    action?: JSX.Element;
+}
+/** A simple wrapper for a Footer previous or next action  */
+export declare const FooterAction: {
+    ({ actionType, action, ...restProps }: FooterActionsProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Footer/components/FooterActions/index.d.ts

@@ -0,0 +1 @@
+export * from "./FooterActions";

package/dist/esm/dts/Workflow/subcomponents/Footer/components/ProgressStepper/ProgressStepper.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+export interface ProgressStepperProps {
+    stepName: string;
+    steps: [string, ...string[]];
+    isComplete?: boolean;
+}
+export declare const ProgressStepper: {
+    ({ stepName, steps, isComplete, ...restprops }: ProgressStepperProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Footer/components/ProgressStepper/index.d.ts

@@ -0,0 +1 @@
+export * from "./ProgressStepper";

package/dist/esm/dts/Workflow/subcomponents/Footer/components/Root/Root.d.ts

@@ -0,0 +1,7 @@
+import { HTMLAttributes } from "react";
+import { OverrideClassName } from "../../../../../types/OverrideClassName";
+export type FooterRootProps = OverrideClassName<HTMLAttributes<HTMLHeadingElement>>;
+export declare const FooterRoot: {
+    ({ children, classNameOverride, ...restProps }: FooterRootProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Footer/components/Root/index.d.ts

@@ -0,0 +1 @@
+export * from "./Root";

package/dist/esm/dts/Workflow/subcomponents/Footer/components/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./Root";
+export * from "./ProgressStepper";
+export * from "./FooterActions";

package/dist/esm/dts/Workflow/subcomponents/Footer/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Footer";
+export * from "./components";

package/dist/esm/dts/Workflow/subcomponents/Header/Header.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="react" />
+import { WorkflowTitlesProps, WorkflowActionsProps } from "./components";
+export type HeaderProps = WorkflowTitlesProps & WorkflowActionsProps;
+export declare const Header: {
+    ({ workflowName, stepName, status, headerActions, ...restProps }: HeaderProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Header/components/Actions/Actions.d.ts

@@ -0,0 +1,13 @@
+import { HTMLAttributes } from "react";
+import { OverrideClassName } from "../../../../../types/OverrideClassName";
+export interface WorkflowActionsProps extends OverrideClassName<Omit<HTMLAttributes<HTMLDivElement>, "children">> {
+    /**
+     * Header actions will render in order of the array.
+     */
+    headerActions?: JSX.Element[];
+}
+/** A wrapper for an exit trigger (and other) actions of the Header Workflow  */
+export declare const Actions: {
+    ({ headerActions, ...restProps }: WorkflowActionsProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Header/components/Actions/index.d.ts

@@ -0,0 +1 @@
+export * from "./Actions";

package/dist/esm/dts/Workflow/subcomponents/Header/components/Branding/Branding.d.ts

@@ -0,0 +1,12 @@
+import { HTMLAttributes } from "react";
+import { BrandProps } from "@kaizen/brand";
+import { OverrideClassName } from "../../../../../types/OverrideClassName";
+export interface WorflowBrandingProps extends OverrideClassName<HTMLAttributes<HTMLDivElement>> {
+    /** * @default: "logo-horizontal" */
+    variant?: BrandProps["variant"];
+    alt: string;
+}
+export declare const Branding: {
+    ({ variant, alt, }: WorflowBrandingProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Header/components/Branding/index.d.ts

@@ -0,0 +1 @@
+export * from "./Branding";

package/dist/esm/dts/Workflow/subcomponents/Header/components/Root/Root.d.ts

@@ -0,0 +1,7 @@
+import { HTMLAttributes } from "react";
+import { OverrideClassName } from "../../../../../types/OverrideClassName";
+export type HeaderRootProps = OverrideClassName<HTMLAttributes<HTMLHeadingElement>>;
+export declare const HeaderRoot: {
+    ({ children, classNameOverride, ...restProps }: HeaderRootProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Header/components/Root/index.d.ts

@@ -0,0 +1 @@
+export * from "./Root";

package/dist/esm/dts/Workflow/subcomponents/Header/components/Titles/Titles.d.ts

@@ -0,0 +1,17 @@
+import { HTMLAttributes } from "react";
+import { DefaultTagProps } from "@kaizen/draft-tag";
+import { OverrideClassName } from "../../../../../types/OverrideClassName";
+export type WorkflowStatus = {
+    /** @default: "statusDraft" */
+    variant?: DefaultTagProps["variant"];
+    content?: string;
+};
+export interface WorkflowTitlesProps extends OverrideClassName<HTMLAttributes<HTMLDivElement>> {
+    workflowName: string;
+    stepName: string;
+    status?: WorkflowStatus;
+}
+export declare const Titles: {
+    ({ workflowName, stepName, status, ...restProps }: WorkflowTitlesProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Header/components/Titles/index.d.ts

@@ -0,0 +1 @@
+export * from "./Titles";

package/dist/esm/dts/Workflow/subcomponents/Header/components/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./Titles";
+export * from "./Actions";
+export * from "./Branding";
+export * from "./Root";

package/dist/esm/dts/Workflow/subcomponents/Header/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Header";
+export * from "./components";

package/dist/esm/dts/Workflow/subcomponents/Main/Main.d.ts

@@ -0,0 +1,9 @@
+import { HTMLAttributes, ReactNode } from "react";
+import { OverrideClassName } from "../../../types/OverrideClassName";
+export type WorkflowMainProps = OverrideClassName<HTMLAttributes<HTMLDivElement>> & {
+    children: ReactNode;
+};
+export declare const Main: {
+    ({ children, classNameOverride, ...restProps }: WorkflowMainProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Main/index.d.ts

@@ -0,0 +1 @@
+export * from "./Main";

package/dist/esm/dts/Workflow/subcomponents/Wrapper/Wrapper.d.ts

@@ -0,0 +1,9 @@
+import { HTMLAttributes, ReactNode } from "react";
+import { OverrideClassName } from "../../../types/OverrideClassName";
+export type WorkflowWrapperProps = OverrideClassName<HTMLAttributes<HTMLDivElement>> & {
+    children: ReactNode;
+};
+export declare const Wrapper: {
+    ({ children, classNameOverride, ...restProps }: WorkflowWrapperProps): JSX.Element;
+    displayName: string;
+};

package/dist/esm/dts/Workflow/subcomponents/Wrapper/index.d.ts

@@ -0,0 +1 @@
+export * from "./Wrapper";

package/dist/esm/dts/Workflow/subcomponents/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./Footer";
+export * from "./Header";
+export * from "./Main";
+export * from "./Wrapper";