@fluidattacks/design 1.2.3 → 1.2.4-pr-0.1

package/dist/src/components/@core/types.d.ts

@@ -1,5 +1,82 @@
 import { Property } from 'csstype';
-import { DefaultTheme } from 'styled-components';
+type ColorPalette = "25" | "50" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
+/**
+ * Fluidattacks Default theme design
+ */
+interface DefaultTheme {
+    breakpoints: {
+        mobile: string;
+        tablet: string;
+        sm: string;
+        md: string;
+        lg: string;
+    };
+    spacing: {
+        0: "0rem";
+        0.125: "0.125rem";
+        0.25: "0.25rem";
+        0.5: "0.5rem";
+        0.625: "0.625rem";
+        0.75: "0.75rem";
+        1: "1rem";
+        1.25: "1.25rem";
+        1.5: "1.5rem";
+        1.75: "1.75rem";
+        2: "2rem";
+        2.25: "2.25rem";
+        2.5: "2.5rem";
+        3: "3rem";
+        3.5: "3.5rem";
+        4: "4rem";
+        5: "5rem";
+        6: "6rem";
+    };
+    typography: {
+        type: {
+            primary: string;
+            poppins: string;
+            mono: string;
+        };
+        heading: {
+            xxl: string;
+            xl: string;
+            lg: string;
+            md: string;
+            sm: string;
+            xs: string;
+        };
+        text: {
+            xl: string;
+            lg: string;
+            md: string;
+            sm: string;
+            xs: string;
+        };
+        weight: {
+            bold: string;
+            semibold: string;
+            regular: string;
+        };
+    };
+    shadows: {
+        none: string;
+        sm: string;
+        md: string;
+        lg: string;
+    };
+    palette: {
+        primary: Record<ColorPalette, string>;
+        complementary: Record<ColorPalette, string>;
+        error: Record<ColorPalette, string>;
+        info: Record<ColorPalette, string>;
+        warning: Record<ColorPalette, string>;
+        success: Record<ColorPalette, string>;
+        gray: Record<ColorPalette, string>;
+        black: string;
+        white: string;
+        gradients: Record<string, string>;
+    };
+}
 type TSpacing = keyof DefaultTheme["spacing"];
 type TShadows = keyof DefaultTheme["shadows"];
 interface IPaddingModifiable {
@@ -77,4 +154,4 @@ interface IInteractionModifiable {
     shadowHover?: TShadows;
 }
 type TModifiable = IBorderModifiable & IDisplayModifiable & IInteractionModifiable & IMarginModifiable & IPaddingModifiable & IPositionModifiable & ITextModifiable;
-export type { TSpacing, IPaddingModifiable, IMarginModifiable, IDisplayModifiable, ITextModifiable, IInteractionModifiable, IPositionModifiable, IBorderModifiable, TModifiable, };
+export type { DefaultTheme, TSpacing, IPaddingModifiable, IMarginModifiable, IDisplayModifiable, ITextModifiable, IInteractionModifiable, IPositionModifiable, IBorderModifiable, TModifiable, };

package/dist/src/components/cloud-image/index.d.ts

@@ -1,12 +1,5 @@
-import { Plugins } from '@cloudinary/html';
 import { default as React } from 'react';
-interface IImageProps {
-    alt?: string;
-    height?: number | string;
-    publicId: string;
-    width?: number | string;
-    plugins?: Plugins;
-}
-declare const MemoizedImage: React.MemoExoticComponent<({ alt, height, publicId, width, plugins, }: Readonly<IImageProps>) => JSX.Element>;
+import { IImageProps } from './types';
+declare const MemoizedImage: React.MemoExoticComponent<({ alt, height, width, plugins, publicId, }: Readonly<IImageProps>) => JSX.Element>;
 export type { IImageProps };
 export { MemoizedImage as CloudImage };

package/dist/src/components/cloud-image/types.d.ts

@@ -0,0 +1,17 @@
+import { Plugins } from '@cloudinary/html';
+/**
+ * Cloud image component props.
+ * @property {string} [alt] The alternate text for an image.
+ * @property {number | string} [height] The height of the image.
+ * @property {number | string} [width] The width of the image.
+ * @property {Plugins} [plugins] A list of cloudinary plugins.
+ * @property {string} publicId The publicId location in cloudinary.
+ */
+interface IImageProps {
+    alt?: string;
+    height?: number | string;
+    width?: number | string;
+    plugins?: Plugins;
+    publicId: string;
+}
+export type { IImageProps };

package/dist/src/components/container/index.d.ts

@@ -1,3 +1,4 @@
+import { PropsWithChildren } from 'react';
 import { IContainerProps } from './types';
-declare const Container: import('react').ForwardRefExoticComponent<Readonly<IContainerProps> & import('react').RefAttributes<HTMLDivElement>>;
+declare const Container: import('react').ForwardRefExoticComponent<Readonly<PropsWithChildren<IContainerProps>> & import('react').RefAttributes<HTMLDivElement>>;
 export { Container };

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

@@ -1,10 +1,18 @@
-import { ReactHTML } from 'react';
+import { HTMLAttributes, ReactHTML } from 'react';
 import { TModifiable } from '../@core/types';
 type THtmlTag = keyof ReactHTML;
-interface IContainerProps extends TModifiable, React.HTMLAttributes<HTMLDivElement> {
+/**
+ * Container component props.
+ * @extends TModifiable
+ * @extends HTMLAttributes<HTMLDivElement>
+ * @property {THtmlTag} [as] The react html tag to represent.
+ * @property {boolean} [center] Whether to center the content.
+ * @property {Function} [onHover] Function handler for hover event.
+ * @property {Function} [onLeave] Function handler for hover event.
+ */
+interface IContainerProps extends TModifiable, HTMLAttributes<HTMLDivElement> {
     as?: THtmlTag;
     center?: boolean;
-    children?: React.ReactNode;
     onHover?: () => void;
     onLeave?: () => void;
 }

package/dist/src/components/logo/index.d.ts

@@ -1,3 +1,3 @@
 import { ILogoProps } from './types';
-declare const Logo: ({ src, variant }: ILogoProps) => JSX.Element;
+declare const Logo: ({ publicId, variant }: Readonly<ILogoProps>) => JSX.Element;
 export { Logo };

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

@@ -1,6 +1,11 @@
 type TLogoVariant = "footer" | "header" | "icon";
+/**
+ * Logo component props.
+ * @property {string} publicId The publicId location in cloudinary.
+ * @property {TLogoVariant} variant The different types of logo used.
+ */
 interface ILogoProps {
-    readonly src: string;
-    readonly variant: TLogoVariant;
+    publicId: string;
+    variant: TLogoVariant;
 }
 export type { ILogoProps, TLogoVariant };

package/dist/src/hooks/use-cloudinary-image.d.ts

@@ -1,4 +1,9 @@
 import { CloudinaryImage } from '@cloudinary/url-gen';
+/**
+ * Cloudinary image hook props.
+ * @property {string} publicId The publicId location in cloudinary.
+ * @property {string} [format] The image format desired (e.g., png, jpg).
+ */
 interface IUseCloudinaryImageProps {
     readonly publicId: string;
     readonly format?: string;

package/package.json

@@ -21,6 +21,7 @@
     "eslint-plugin-functional": "7.0.2",
     "eslint-plugin-jsx-a11y": "6.10.0",
     "eslint-plugin-prettier": "5.2.1",
+    "eslint-plugin-project-structure": "3.0.1",
     "eslint-plugin-react": "7.37.0",
     "postcss-styled-syntax": "0.6.4",
     "stylelint": "16.9.0",
@@ -56,5 +57,5 @@
     "build": "tsc && vite build",
     "preview": "vite preview"
   },
-  "version": "1.2.3"
+  "version": "1.2.4-pr-0.1"
 }

package/dist/eslint.config.d.mts

@@ -1,2 +0,0 @@
-declare const _default: any[];
-export default _default;