gantri-components 1.142.2 → 1.143.0

package/dist/components/icon/__tests__/icon.test.d.ts

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

package/dist/components/icon/icon.presets.d.ts

@@ -1,2 +1,2 @@
-import { IconProps } from './icon.types';
-export declare const IconPresets: Partial<IconProps>;
+import { IconDefaultProps } from './icon.types';
+export declare const IconPresets: IconDefaultProps;

package/dist/components/icon/icon.styles.d.ts

@@ -1,11 +1,11 @@
 import { IconProps } from './icon.types';
 export declare const StyledSvgIcon: import("styled-components").StyledComponent<"svg", import("styled-components").DefaultTheme, {
-    $height: IconProps['height'];
-    $width: IconProps['width'];
-    bottom: IconProps['bottom'];
-    cursor: IconProps['cursor'];
-    left: IconProps['left'];
-    right: IconProps['right'];
-    size: IconProps['width'];
-    top: IconProps['top'];
+    $height?: IconProps['height'];
+    $width?: IconProps['width'];
+    bottom?: IconProps['bottom'];
+    cursor?: IconProps['cursor'];
+    left?: IconProps['left'];
+    right?: IconProps['right'];
+    size?: IconProps['width'];
+    top?: IconProps['top'];
 }, never>;

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

@@ -16,3 +16,4 @@ export interface IconProps extends SVGProps<any> {
     top?: Property.Top;
     width?: ResolutionAwareProp<Property.Width<string | any>>;
 }
+export declare type IconDefaultProps = Required<Pick<IconProps, 'color' | 'cursor' | 'opacity' | 'size'>>;

package/dist/helpers/get-file-url/get-file-url.constants.d.ts

@@ -1,3 +1 @@
-import { Environment } from './types/globals.types';
 export declare const cloudinaryPrefix = "https://res.cloudinary.com/gantri/image/upload";
-export declare const defaultEnv: Environment;

package/dist/helpers/get-file-url/get-file-url.d.ts

@@ -1,6 +1,5 @@
-import { GetFileUrlArgs } from './types/get-file-url.types';
-import { DirectoryName, Environment } from './types/globals.types';
-export declare const getCloudinaryEnvFolder: (buildEnv: Environment) => 'production' | 'staging' | 'develop';
+import { GetFileUrlArgs } from './get-file-url.types';
+import { DirectoryName } from '../get-folder-structure/types/globals.types';
 /**
  * https://www.notion.so/gantri/Asset-Directory-Structure-674ff9974018475c89a78249950b4216
  *

package/dist/helpers/get-file-url/get-file-url.types.d.ts

@@ -0,0 +1,5 @@
+import { GetFolderStructureArgs } from '../get-folder-structure/types/get-folder-structure.types';
+import { DirectoryName } from '../get-folder-structure/types/globals.types';
+export declare type GetFileUrlArgs<Directory extends DirectoryName> = GetFolderStructureArgs<Directory> & {
+    fileName: string;
+};

package/dist/helpers/get-folder-structure/__tests__/get-folder-structure.designers.test.d.ts

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

package/dist/helpers/get-folder-structure/__tests__/get-folder-structure.products.test.d.ts

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

package/dist/helpers/get-folder-structure/__tests__/get-folder-structure.test.d.ts

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

package/dist/helpers/get-folder-structure/get-folder-structure.constants.d.ts

@@ -0,0 +1,2 @@
+import { Environment } from './types/globals.types';
+export declare const defaultEnv: Environment;

package/dist/helpers/get-folder-structure/get-folder-structure.d.ts

@@ -0,0 +1,19 @@
+import { GetFolderStructureArgs } from './types/get-folder-structure.types';
+import { DirectoryName, Environment } from './types/globals.types';
+export declare const getCloudinaryEnvFolder: (buildEnv: Environment) => 'production' | 'staging' | 'develop';
+/**
+ * https://www.notion.so/gantri/Asset-Directory-Structure-674ff9974018475c89a78249950b4216
+ *
+ * While not strictly necessary, it's highly recommended that you copy the `directory` value to the type definition to ensure highly accurate types:
+ *
+ * @example
+ * const folder = getFolderStructure<'products'>({
+ *   directory: 'products',
+ *   fileType: 'value-props',
+ *   identifiers: {
+ *     productId: product.id,
+ *   },
+ * });
+ *
+ */
+export declare const getFolderStructure: <Directory extends DirectoryName>(args: GetFolderStructureArgs<Directory>) => string | undefined;

package/dist/helpers/get-folder-structure/index.d.ts

@@ -0,0 +1 @@
+export * from './get-folder-structure';

package/dist/helpers/get-folder-structure/types/designers.types.d.ts

@@ -0,0 +1,17 @@
+import { Environment } from './globals.types';
+export declare type DesignersFileType = 'collection-pages-lifestyle-imagery' | 'collection-pages-value-props' | 'collection-pages' | 'editorial-imagery' | 'handouts' | 'headshot' | 'hero-imagery' | 'logo' | 'process-imagery' | 'quote-imagery';
+interface DesignersRootLevel {
+    /** User ID, NOT designer ID! */
+    userId: number;
+}
+interface DesignersCollectionPagesLevel extends DesignersRootLevel {
+    collectionId: number;
+}
+interface DesignersArgs<FileType extends DesignersFileType, Identifiers extends Record<string, any>> {
+    directory: 'designers';
+    env?: Environment;
+    fileType: FileType;
+    identifiers: Identifiers;
+}
+export declare type GetDesignersArgs<FileType extends DesignersFileType> = FileType extends 'editorial-imagery' | 'handouts' | 'headshot' | 'hero-imagery' | 'logo' | 'process-imagery' | 'quote-imagery' ? DesignersArgs<FileType, DesignersRootLevel> : FileType extends 'collection-pages-lifestyle-imagery' | 'collection-pages-value-props' | 'collection-pages' ? DesignersArgs<FileType, DesignersCollectionPagesLevel> : never;
+export {};

package/dist/helpers/get-folder-structure/types/get-folder-structure.types.d.ts

@@ -0,0 +1,4 @@
+import { GetDesignersArgs, DesignersFileType } from './designers.types';
+import { DirectoryName } from './globals.types';
+import { ProductsFileType, GetProductsArgs } from './products.types';
+export declare type GetFolderStructureArgs<Directory extends DirectoryName> = Directory extends 'products' ? GetProductsArgs<ProductsFileType> : Directory extends 'designers' ? GetDesignersArgs<DesignersFileType> : never;

package/dist/helpers/get-folder-structure/types/globals.types.d.ts

@@ -0,0 +1,3 @@
+export declare type DirectoryName = 'designers' | 'designs' | 'downloads' | 'inventory-purchases' | 'parts' | 'products' | 'stocks' | 'users';
+export declare type TemplateVersion = 'draft' | string;
+export declare type Environment = 'local' | 'develop' | 'staging' | 'production';

package/dist/helpers/get-folder-structure/types/products.types.d.ts

@@ -0,0 +1,21 @@
+import { Environment, TemplateVersion } from './globals.types';
+export declare type ProductsFileType = 'bulb-change-instructions' | 'dimming-photos' | 'handouts' | 'job-instructions' | 'lifestyle-photos' | 'model' | 'part-stl' | 'part-thumbnail' | 'product-photos' | 'scale-photo' | 'value-props';
+interface ProductsRootLevel {
+    productId: number;
+}
+interface ProductsSkuLevel extends ProductsRootLevel {
+    sku: string;
+}
+interface ProductsTemplateLevel extends ProductsRootLevel {
+    partId: number;
+    /** String with the value of `draft` or `${number}.${number}`. */
+    templateVersion: TemplateVersion;
+}
+interface ProductsArgs<FileType extends ProductsFileType, Identifiers extends Record<string, any>> {
+    directory: 'products';
+    env?: Environment;
+    fileType: FileType;
+    identifiers: Identifiers;
+}
+export declare type GetProductsArgs<FileType extends ProductsFileType> = FileType extends 'bulb-change-instructions' | 'handouts' | 'value-props' ? ProductsArgs<FileType, ProductsRootLevel> : FileType extends 'dimming-photos' | 'lifestyle-photos' | 'model' | 'product-photos' | 'scale-photo' ? ProductsArgs<FileType, ProductsSkuLevel> : FileType extends 'job-instructions' | 'part-stl' | 'part-thumbnail' ? ProductsArgs<FileType, ProductsTemplateLevel> : never;
+export {};

package/dist/helpers/index.d.ts

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