gantri-components 1.152.6 → 1.153.0

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

@@ -1,5 +1,5 @@
 import { GetFileUrlArgs } from './get-file-url.types';
-import { DirectoryName } from '../get-folder-structure/types/globals.types';
+import { DirectoryName } from '../get-folder-structure/globals.types';
 /**
  * https://www.notion.so/gantri/Asset-Directory-Structure-674ff9974018475c89a78249950b4216
  *

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

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

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

@@ -1,2 +1,3 @@
-import { Environment } from './types/globals.types';
+import { Environment } from './globals.types';
 export declare const defaultEnv: Environment;
+export declare const dynamicFolder = "dynamic-assets";

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

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

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

@@ -0,0 +1,9 @@
+import { GetDesignersArgs, DesignersFileType } from './helpers/get-designers-path/get-designers-path.types';
+import { FloatingPartsFileType, GetFloatingPartsArgs } from './helpers/get-floating-parts-path/get-floating-parts-path.types';
+import { DirectoryName } from './globals.types';
+import { ProductsFileType, GetProductsArgs } from './helpers/get-products-path/get-products-path.types';
+import { GetInventoryPurchasesArgs, InventoryPurchasesFileType } from './helpers/get-inventory-purchases-path/get-inventory-purchases-path.types';
+import { DownloadsFileType, GetDownloadsArgs } from './helpers/get-downloads-path/get-downloads-path.types';
+import { GetUsersArgs, UsersFileType } from './helpers/get-users-path/get-users-path.types';
+import { DesignsFileType, GetDesignsArgs } from './helpers/get-designs-path/get-designs-path.types';
+export declare type GetFolderStructureArgs<Directory extends DirectoryName> = Directory extends 'products' ? GetProductsArgs<ProductsFileType> : Directory extends 'designers' ? GetDesignersArgs<DesignersFileType> : Directory extends 'floating-parts' ? GetFloatingPartsArgs<FloatingPartsFileType> : Directory extends 'inventory-purchases' ? GetInventoryPurchasesArgs<InventoryPurchasesFileType> : Directory extends 'downloads' ? GetDownloadsArgs<DownloadsFileType> : Directory extends 'users' ? GetUsersArgs<UsersFileType> : Directory extends 'designs' ? GetDesignsArgs<DesignsFileType> : never;

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

@@ -0,0 +1,3 @@
+export declare type DirectoryName = 'designers' | 'designs' | 'downloads' | 'floating-parts' | '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/helpers/build-folder-structure/build-folder-structure.d.ts

@@ -0,0 +1,2 @@
+import { BuildFolderStructureArgs } from './build-folder-structure.types';
+export declare const buildFolderStructure: (args: BuildFolderStructureArgs) => string;

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

@@ -0,0 +1,5 @@
+import { Environment } from '../../globals.types';
+export interface BuildFolderStructureArgs {
+    env: Environment;
+    path: string;
+}

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

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

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

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

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

@@ -0,0 +1,2 @@
+import { DesignersFileType, GetDesignersArgs } from './get-designers-path.types';
+export declare const getDesignersPath: (args: GetDesignersArgs<DesignersFileType>) => string;

package/dist/helpers/get-folder-structure/helpers/get-designers-path/get-designers-path.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/helpers/get-designers-path/index.d.ts

@@ -0,0 +1 @@
+export * from './get-designers-path';

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

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

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

@@ -0,0 +1,2 @@
+import { DesignsFileType, GetDesignsArgs } from './get-designs-path.types';
+export declare const getDesignsPath: (args: GetDesignsArgs<DesignsFileType>) => string;

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

@@ -0,0 +1,13 @@
+import { Environment } from '../../globals.types';
+export declare type DesignsFileType = 'concept-sketches' | 'concept-interior-fit' | 'model-assembly' | 'model-parts' | 'prototype-renders' | 'final-renders' | 'messages';
+interface DesignsRootLevel {
+    designId: number;
+}
+interface DesignsArgs<FileType extends DesignsFileType, Identifiers extends Record<string, any>> {
+    directory: 'designs';
+    env?: Environment;
+    fileType: FileType;
+    identifiers: Identifiers;
+}
+export declare type GetDesignsArgs<FileType extends DesignsFileType> = FileType extends 'concept-sketches' | 'concept-interior-fit' | 'model-assembly' | 'model-parts' | 'prototype-renders' | 'final-renders' | 'messages' ? DesignsArgs<FileType, DesignsRootLevel> : never;
+export {};

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

@@ -0,0 +1 @@
+export * from './get-designs-path';

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

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

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

@@ -0,0 +1,2 @@
+import { DownloadsFileType, GetDownloadsArgs } from './get-downloads-path.types';
+export declare const getDownloadsPath: (args: GetDownloadsArgs<DownloadsFileType>) => string;

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

@@ -0,0 +1,13 @@
+import { Environment } from '../../globals.types';
+export declare type DownloadsFileType = 'download';
+interface DownloadsRootLevel {
+    downloadId: number;
+}
+interface DownloadsArgs<Identifiers extends Record<string, any>> {
+    directory: 'downloads';
+    env?: Environment;
+    fileType: DownloadsFileType;
+    identifiers: Identifiers;
+}
+export declare type GetDownloadsArgs<FileType extends DownloadsFileType> = FileType extends 'download' ? DownloadsArgs<DownloadsRootLevel> : never;
+export {};

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

@@ -0,0 +1 @@
+export * from './get-downloads-path';

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

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

package/dist/helpers/get-folder-structure/helpers/get-floating-parts-path/get-floating-parts-path.d.ts

@@ -0,0 +1,2 @@
+import { FloatingPartsFileType, GetFloatingPartsArgs } from './get-floating-parts-path.types';
+export declare const getFloatingPartsPath: (args: GetFloatingPartsArgs<FloatingPartsFileType>) => string;

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

@@ -0,0 +1,13 @@
+import { Environment } from '../../globals.types';
+export declare type FloatingPartsFileType = 'part-files' | 'instructions';
+interface FloatingPartsRootLevel {
+    partId: number;
+}
+interface FloatingPartsArgs<FileType extends FloatingPartsFileType, Identifiers extends Record<string, any>> {
+    directory: 'floating-parts';
+    env?: Environment;
+    fileType: FileType;
+    identifiers: Identifiers;
+}
+export declare type GetFloatingPartsArgs<FileType extends FloatingPartsFileType> = FileType extends 'part-files' | 'instructions' ? FloatingPartsArgs<FileType, FloatingPartsRootLevel> : never;
+export {};

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

@@ -0,0 +1 @@
+export * from './get-floating-parts-path';

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

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

package/dist/helpers/get-folder-structure/helpers/get-inventory-purchases-path/get-inventory-purchases-path.d.ts

@@ -0,0 +1,3 @@
+import { InventoryPurchasesFileType, GetInventoryPurchasesArgs } from './get-inventory-purchases-path.types';
+export declare const getFormattedDate: (date: number | Date) => string;
+export declare const getInventoryPurchasesPath: (args: GetInventoryPurchasesArgs<InventoryPurchasesFileType>) => string;

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

@@ -0,0 +1,15 @@
+import { Environment } from '../../globals.types';
+export declare type InventoryPurchasesFileType = 'purchase';
+interface InventoryPurchasesRootLevel {
+    inventoryId: number;
+    purchaseDate: number | Date;
+    purchaseId: number;
+}
+interface InventoryPurchasesArgs<Identifiers extends Record<string, any>> {
+    directory: 'inventory-purchases';
+    env?: Environment;
+    fileType: InventoryPurchasesFileType;
+    identifiers: Identifiers;
+}
+export declare type GetInventoryPurchasesArgs<FileType extends InventoryPurchasesFileType> = FileType extends 'purchase' ? InventoryPurchasesArgs<InventoryPurchasesRootLevel> : never;
+export {};

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

@@ -0,0 +1 @@
+export * from './get-inventory-purchases-path';

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

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

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

@@ -0,0 +1,2 @@
+import { GetProductsArgs, ProductsFileType } from './get-products-path.types';
+export declare const getProductsPath: (args: GetProductsArgs<ProductsFileType>) => string;

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

@@ -0,0 +1,20 @@
+import { Environment, TemplateVersion } from '../../globals.types';
+export declare type ProductsFileType = 'bulb-change-instructions' | 'dimming-photos' | 'handouts' | 'instructions' | 'lifestyle-photos' | 'model' | 'part-files' | 'product-photos' | 'scale-photo' | 'value-props';
+interface ProductsRootLevel {
+    productId: number;
+}
+interface ProductsSkuLevel extends ProductsRootLevel {
+    sku: string;
+}
+interface ProductsTemplateLevel extends ProductsSkuLevel {
+    /** 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 'instructions' | 'part-files' ? ProductsArgs<FileType, ProductsTemplateLevel> : never;
+export {};

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

@@ -0,0 +1 @@
+export * from './get-products-path';

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

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

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

@@ -0,0 +1,2 @@
+import { UsersFileType, GetUsersArgs } from './get-users-path.types';
+export declare const getUsersPath: (args: GetUsersArgs<UsersFileType>) => string;

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

@@ -0,0 +1,13 @@
+import { Environment } from '../../globals.types';
+export declare type UsersFileType = 'resale-certificate';
+interface UsersRootLevel {
+    userId: number;
+}
+interface UsersArgs<Identifiers extends Record<string, any>> {
+    directory: 'users';
+    env?: Environment;
+    fileType: UsersFileType;
+    identifiers: Identifiers;
+}
+export declare type GetUsersArgs<FileType extends UsersFileType> = FileType extends 'resale-certificate' ? UsersArgs<UsersRootLevel> : never;
+export {};

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

@@ -0,0 +1 @@
+export * from './get-users-path';

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

@@ -1,3 +1,3 @@
 export * from './get-folder-structure';
-export type { DirectoryName } from './types/globals.types';
-export * from './types/get-folder-structure.types';
+export type { DirectoryName } from './globals.types';
+export * from './get-folder-structure.types';