@marteye/studiojs 1.1.24 → 1.1.25

package/dist/index.d.ts

@@ -1,107 +1,5 @@
 import { z } from 'zod';
 
-declare const videoTaskSchema: z.ZodEnum<["compressed", "thumbnail"]>;
-declare const imageSizeSchema: z.ZodEnum<["small", "medium", "large"]>;
-type ImageSize = z.infer<typeof imageSizeSchema>;
-type VideoTask = z.infer<typeof videoTaskSchema>;
-type SupportedFileTypesNames$1 = "image" | "video" | "file";
-type VariantProcessingState = {
-    fileName: string;
-    thumbHash: string;
-    path: string;
-    url: string;
-    fileType: string;
-    variants: Partial<Record<ImageSize | VideoTask, {
-        url: string;
-        isProcessing: boolean;
-        type: SupportedFileTypesNames$1;
-    }>>;
-};
-/**
- |--------------------------------------------------
- | END OF MEDIA CRATE CODE
- |--------------------------------------------------
- */
-type MediaFinishUploadResponse = {
-    message: string;
-    mediaType: string;
-    process: VariantProcessingState;
-};
-type MediaUploadOptions = {
-    marketId: string;
-    saleId: string;
-    lotId: string;
-    attributeId: string;
-    options?: {
-        bucket?: "raw";
-        parallelParts?: number;
-        baseUrl?: string;
-        progressCallback?: (progress: {
-            /**
-             * The state of the upload
-             */
-            state: "uploading" | "finished" | "failed" | "starting";
-            /**
-             * The progress of the upload
-             */
-            progress: number;
-            /**
-             * The current part number
-             */
-            currentPart?: number;
-            /**
-             * The total parts
-             */
-            totalParts?: number;
-        }) => void;
-    };
-};
-type ChunkedFile = {
-    partNumber: string;
-    chunk: string;
-    fileExtension: string;
-    fileMimeType: string;
-};
-type FileInput = {
-    file: File;
-    uploadConfig: MediaUploadOptions;
-};
-type ChunkedInput = {
-    fileName: string;
-    chunks: ChunkedFile[];
-    uploadConfig: MediaUploadOptions;
-};
-/**
- * Handles the complete file upload process including chunking and progress tracking -
- * WEB: Pass in a file and we will chunk it and upload it in parallel
- * NATIVE: You need to chunk the file yourself.
- * @param {FileInput | ChunkedInput} input - Either {file, options} or {fileName, chunks, options}
- * @returns {Promise<MediaFinishUploadResponse>}
- * @throws {Error} When upload fails
- */
-declare const uploadFile: (input: FileInput | ChunkedInput, token: string) => Promise<MediaFinishUploadResponse>;
-
-declare function SimpleHttpClient(baseUrl: string, apiKey: string, fetch: any, defaultTimeout: number, debug?: boolean): {
-    get: <T>(path: string, queryParams?: any) => Promise<T>;
-    post: <T>(path: string, body: any) => Promise<T>;
-    delete: <T>(path: string) => Promise<T>;
-};
-type HttpClient = ReturnType<typeof SimpleHttpClient>;
-
-/**
- * Search result interface based on the API implementation
- */
-interface SearchResult {
-    hits: Array<{
-        id: string;
-        marketId: string;
-        title: string;
-        [key: string]: any;
-    }>;
-    processingTimeMs: number;
-    query: string;
-}
-
 type Timestamp = string;
 type ClientType = "Seller" | "Buyer";
 type SuperType = "Sheep" | "Goats" | "Cattle" | "Pigs" | "Horses" | "Deer" | "Poultry" | "Machinery" | "Antiques" | "Other";
@@ -547,6 +445,7 @@ interface Product {
     };
 }
 interface Cart {
+    customerId: string;
     updatedAt: Timestamp;
     itemsById: {
         [itemId: string]: CartItem;
@@ -665,7 +564,7 @@ declare const IMAGE_SIZES_VALUES: readonly ["small", "medium", "large"];
 declare const VIDEO_TASKS_VALUES: readonly ["compressed", "thumbnail"];
 type ImageSizes = (typeof IMAGE_SIZES_VALUES)[number];
 type VideoTasks = (typeof VIDEO_TASKS_VALUES)[number];
-type SupportedFileTypesNames = "image" | "video" | "file";
+type SupportedFileTypesNames$1 = "image" | "video" | "file";
 interface Media {
     id: string;
     fileName: string;
@@ -676,7 +575,7 @@ interface Media {
         url: string;
         isLocal?: boolean;
         isProcessing: boolean;
-        type: SupportedFileTypesNames;
+        type: SupportedFileTypesNames$1;
     }>>;
 }
 type MarketReportHeaders = "grossServices" | "vatOnServices" | "grossGoods" | "vatOnGoods" | "netTotal" | "contra";
@@ -927,6 +826,11 @@ interface Invoice extends Omit<Omit<Omit<Omit<DraftInvoice, "ledgerAccountTotals
      */
     internalNextInvoiceId: string | null;
     emailNotifications?: string[];
+    emailStatus?: {
+        recipient: string;
+        status: "sent" | "delivered" | "opened" | "bounced";
+        timestamp: Timestamp;
+    }[];
     pitchPayLink: string | null;
 }
 /**
@@ -1135,7 +1039,6 @@ type types_SuperType = SuperType;
 type types_SupportedAttributeTypes = SupportedAttributeTypes;
 type types_SupportedCountryCode = SupportedCountryCode;
 declare const types_SupportedCurrencyCodes: typeof SupportedCurrencyCodes;
-type types_SupportedFileTypesNames = SupportedFileTypesNames;
 declare const types_SupportedPaymentMethods: typeof SupportedPaymentMethods;
 declare const types_SupportedSuperTypes: typeof SupportedSuperTypes;
 declare const types_SupportedUnitsOfSale: typeof SupportedUnitsOfSale;
@@ -1149,7 +1052,122 @@ type types_WebhookEventName = WebhookEventName;
 declare const types_supportedWebhookEvents: typeof supportedWebhookEvents;
 declare namespace types {
   export { types_IMAGE_SIZES_VALUES as IMAGE_SIZES_VALUES, types_LivestockSuperTypes as LivestockSuperTypes, types_SupportedCurrencyCodes as SupportedCurrencyCodes, types_SupportedPaymentMethods as SupportedPaymentMethods, types_SupportedSuperTypes as SupportedSuperTypes, types_SupportedUnitsOfSale as SupportedUnitsOfSale, types_VIDEO_TASKS_VALUES as VIDEO_TASKS_VALUES, types_supportedWebhookEvents as supportedWebhookEvents };
-  export type { types_Accessory as Accessory, types_Address as Address, types_AddressWrapper as AddressWrapper, types_AdjustmentTarget as AdjustmentTarget, types_AdjustmentTotalTarget as AdjustmentTotalTarget, types_AdjustmentsConfiguration as AdjustmentsConfiguration, types_AppParameterConfig as AppParameterConfig, types_AttributeDefinition as AttributeDefinition, types_AttributeValueType as AttributeValueType, types_BankDetails as BankDetails, types_Cart as Cart, types_CartItem as CartItem, types_ChequeField as ChequeField, types_ClientType as ClientType, types_CurrenciesWithGuinea as CurrenciesWithGuinea, types_Currency as Currency, types_Customer as Customer, types_CustomerFromSearch as CustomerFromSearch, types_DeviceType as DeviceType, types_DraftInvoice as DraftInvoice, types_EmailWrapper as EmailWrapper, types_FarmAssurances as FarmAssurances, types_FieldPositions as FieldPositions, types_ImageSizes as ImageSizes, types_IncrementLadder as IncrementLadder, types_IncrementLadderItem as IncrementLadderItem, types_Invoice as Invoice, types_InvoiceField as InvoiceField, types_InvoiceLineItem as InvoiceLineItem, types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, types_InvoiceTotals as InvoiceTotals, types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_Lot as Lot, types_LotGeneratedValues as LotGeneratedValues, types_LotIssue as LotIssue, types_LotItem as LotItem, types_LotSaleStatus as LotSaleStatus, types_LotWithItemsAsArray as LotWithItemsAsArray, types_Market as Market, types_MarketBankDetails as MarketBankDetails, types_MarketReportHeaders as MarketReportHeaders, types_MartEyeLiveSaleSettings as MartEyeLiveSaleSettings, types_MartEyeTimedSaleSettings as MartEyeTimedSaleSettings, types_Media as Media, types_MemberSharingConfiguration as MemberSharingConfiguration, types_ObjectType as ObjectType, types_Payment as Payment, types_PaymentMethod as PaymentMethod, types_Payout as Payout, types_PayoutMethod as PayoutMethod, types_PhoneNumberWrapper as PhoneNumberWrapper, types_Printer as Printer, types_Product as Product, types_ProductCodeConfiguration as ProductCodeConfiguration, types_ProductConfiguration as ProductConfiguration, types_Sale as Sale, types_SaleFromSearch as SaleFromSearch, types_SettingsAccessories as SettingsAccessories, types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, types_SettingsGlobalAttributes as SettingsGlobalAttributes, types_SettingsMarketDefaults as SettingsMarketDefaults, types_SettingsPrinters as SettingsPrinters, types_SettingsProductCodes as SettingsProductCodes, types_SettingsTaxRates as SettingsTaxRates, types_ShortCustomerDetails as ShortCustomerDetails, types_SimplePaymentIn as SimplePaymentIn, types_SimplePaymentOut as SimplePaymentOut, types_StudioAppPartial as StudioAppPartial, types_SubtotalGroups as SubtotalGroups, types_SuperType as SuperType, types_SupportedAttributeTypes as SupportedAttributeTypes, types_SupportedCountryCode as SupportedCountryCode, types_SupportedFileTypesNames as SupportedFileTypesNames, types_TablePosition as TablePosition, types_TaxRate as TaxRate, types_UnitOfSale as UnitOfSale, types_VideoTasks as VideoTasks, types_WebhookEvent as WebhookEvent, types_WebhookEventName as WebhookEventName };
+  export type { types_Accessory as Accessory, types_Address as Address, types_AddressWrapper as AddressWrapper, types_AdjustmentTarget as AdjustmentTarget, types_AdjustmentTotalTarget as AdjustmentTotalTarget, types_AdjustmentsConfiguration as AdjustmentsConfiguration, types_AppParameterConfig as AppParameterConfig, types_AttributeDefinition as AttributeDefinition, types_AttributeValueType as AttributeValueType, types_BankDetails as BankDetails, types_Cart as Cart, types_CartItem as CartItem, types_ChequeField as ChequeField, types_ClientType as ClientType, types_CurrenciesWithGuinea as CurrenciesWithGuinea, types_Currency as Currency, types_Customer as Customer, types_CustomerFromSearch as CustomerFromSearch, types_DeviceType as DeviceType, types_DraftInvoice as DraftInvoice, types_EmailWrapper as EmailWrapper, types_FarmAssurances as FarmAssurances, types_FieldPositions as FieldPositions, types_ImageSizes as ImageSizes, types_IncrementLadder as IncrementLadder, types_IncrementLadderItem as IncrementLadderItem, types_Invoice as Invoice, types_InvoiceField as InvoiceField, types_InvoiceLineItem as InvoiceLineItem, types_InvoiceTotalAdjustmentConfiguration as InvoiceTotalAdjustmentConfiguration, types_InvoiceTotals as InvoiceTotals, types_LineItemAdjustmentConfiguration as LineItemAdjustmentConfiguration, types_Lot as Lot, types_LotGeneratedValues as LotGeneratedValues, types_LotIssue as LotIssue, types_LotItem as LotItem, types_LotSaleStatus as LotSaleStatus, types_LotWithItemsAsArray as LotWithItemsAsArray, types_Market as Market, types_MarketBankDetails as MarketBankDetails, types_MarketReportHeaders as MarketReportHeaders, types_MartEyeLiveSaleSettings as MartEyeLiveSaleSettings, types_MartEyeTimedSaleSettings as MartEyeTimedSaleSettings, types_Media as Media, types_MemberSharingConfiguration as MemberSharingConfiguration, types_ObjectType as ObjectType, types_Payment as Payment, types_PaymentMethod as PaymentMethod, types_Payout as Payout, types_PayoutMethod as PayoutMethod, types_PhoneNumberWrapper as PhoneNumberWrapper, types_Printer as Printer, types_Product as Product, types_ProductCodeConfiguration as ProductCodeConfiguration, types_ProductConfiguration as ProductConfiguration, types_Sale as Sale, types_SaleFromSearch as SaleFromSearch, types_SettingsAccessories as SettingsAccessories, types_SettingsAdjustmentsConfiguration as SettingsAdjustmentsConfiguration, types_SettingsGlobalAttributes as SettingsGlobalAttributes, types_SettingsMarketDefaults as SettingsMarketDefaults, types_SettingsPrinters as SettingsPrinters, types_SettingsProductCodes as SettingsProductCodes, types_SettingsTaxRates as SettingsTaxRates, types_ShortCustomerDetails as ShortCustomerDetails, types_SimplePaymentIn as SimplePaymentIn, types_SimplePaymentOut as SimplePaymentOut, types_StudioAppPartial as StudioAppPartial, types_SubtotalGroups as SubtotalGroups, types_SuperType as SuperType, types_SupportedAttributeTypes as SupportedAttributeTypes, types_SupportedCountryCode as SupportedCountryCode, SupportedFileTypesNames$1 as SupportedFileTypesNames, types_TablePosition as TablePosition, types_TaxRate as TaxRate, types_UnitOfSale as UnitOfSale, types_VideoTasks as VideoTasks, types_WebhookEvent as WebhookEvent, types_WebhookEventName as WebhookEventName };
+}
+
+declare const videoTaskSchema: z.ZodEnum<["compressed", "thumbnail"]>;
+declare const imageSizeSchema: z.ZodEnum<["thumbnail", "small", "medium", "large"]>;
+type ImageSize = z.infer<typeof imageSizeSchema>;
+type VideoTask = z.infer<typeof videoTaskSchema>;
+type SupportedFileTypesNames = "image" | "video" | "file";
+type VariantProcessingState = {
+    fileName: string;
+    thumbHash: string;
+    path: string;
+    url: string;
+    fileType: string;
+    variants: Partial<Record<ImageSize | VideoTask, {
+        url: string;
+        isProcessing: boolean;
+        type: SupportedFileTypesNames;
+    }>>;
+};
+/**
+ |--------------------------------------------------
+ | END OF MEDIA CRATE CODE
+ |--------------------------------------------------
+ */
+type MediaFinishUploadResponse = {
+    message: string;
+    mediaType: string;
+    process: VariantProcessingState;
+};
+type MediaUploadOptions = {
+    marketId: string;
+    saleId: string;
+    lotId: string;
+    attributeId: string;
+    options?: {
+        bucket?: "raw";
+        parallelParts?: number;
+        baseUrl?: string;
+        progressCallback?: (progress: {
+            /**
+             * The state of the upload
+             */
+            state: "uploading" | "finished" | "failed" | "starting";
+            /**
+             * The progress of the upload
+             */
+            progress: number;
+            /**
+             * The current part number
+             */
+            currentPart?: number;
+            /**
+             * The total parts
+             */
+            totalParts?: number;
+        }) => void;
+    };
+};
+type ChunkedFile = {
+    partNumber: string;
+    chunk: string;
+    fileExtension: string;
+    fileMimeType: string;
+};
+type FileInput = {
+    file: File;
+    uploadConfig: MediaUploadOptions;
+};
+type ChunkedInput = {
+    fileName: string;
+    chunks: ChunkedFile[];
+    uploadConfig: MediaUploadOptions;
+};
+/**
+ * Handles the complete file upload process including chunking and progress tracking -
+ * WEB: Pass in a file and we will chunk it and upload it in parallel
+ * NATIVE: You need to chunk the file yourself.
+ * @param {FileInput | ChunkedInput} input - Either {file, options} or {fileName, chunks, options}
+ * @returns {Promise<MediaFinishUploadResponse>}
+ * @throws {Error} When upload fails
+ */
+declare const uploadMultipartFile: (input: FileInput | ChunkedInput, token: string) => Promise<MediaFinishUploadResponse>;
+type SingleFileInput = {
+    file?: File;
+    filePath?: never;
+    uploadConfig: MediaUploadOptions;
+} | {
+    filePath?: string;
+    file?: never;
+    uploadConfig: MediaUploadOptions;
+};
+declare const uploadSingleFile: (input: SingleFileInput, token: string) => Promise<{
+    message: string;
+    data: Media;
+}>;
+
+declare function SimpleHttpClient(baseUrl: string, apiKey: string, fetch: any, defaultTimeout: number, debug?: boolean): {
+    get: <T>(path: string, queryParams?: any) => Promise<T>;
+    post: <T>(path: string, body: any) => Promise<T>;
+    delete: <T>(path: string) => Promise<T>;
+};
+type HttpClient = ReturnType<typeof SimpleHttpClient>;
+
+/**
+ * Search result interface based on the API implementation
+ */
+interface SearchResult {
+    hits: Array<{
+        id: string;
+        marketId: string;
+        title: string;
+        [key: string]: any;
+    }>;
+    processingTimeMs: number;
+    query: string;
 }
 
 interface CreateCustomerPayload {
@@ -1283,6 +1301,7 @@ declare function resources(httpClient: HttpClient): {
             endAt?: string | null;
             saleStatus?: LotSaleStatus;
             metadata?: Record<string, any>;
+            inputAccessories?: Record<string, any>;
         }) => Promise<Lot>;
         delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
     };
@@ -1333,7 +1352,11 @@ declare function resources(httpClient: HttpClient): {
         query: (marketId: string, query: string) => Promise<SearchResult>;
     };
     files: {
-        uploadFile: (input: Parameters<typeof uploadFile>[0], token: string) => Promise<{
+        uploadSingleFile: (input: Parameters<typeof uploadSingleFile>[0], token: string) => Promise<{
+            message: string;
+            data: Media;
+        }>;
+        uploadMultipartFile: (input: Parameters<typeof uploadMultipartFile>[0], token: string) => Promise<{
             message: string;
             mediaType: string;
             process: VariantProcessingState;
@@ -1462,6 +1485,7 @@ declare function Studio(info?: {
             endAt?: string | null;
             saleStatus?: LotSaleStatus;
             metadata?: Record<string, any>;
+            inputAccessories?: Record<string, any>;
         }) => Promise<Lot>;
         delete: (marketId: string, saleId: string, lotId: string) => Promise<unknown>;
     };
@@ -1512,7 +1536,11 @@ declare function Studio(info?: {
         query: (marketId: string, query: string) => Promise<SearchResult>;
     };
     files: {
-        uploadFile: (input: Parameters<typeof uploadFile>[0], token: string) => Promise<{
+        uploadSingleFile: (input: Parameters<typeof uploadSingleFile>[0], token: string) => Promise<{
+            message: string;
+            data: Media;
+        }>;
+        uploadMultipartFile: (input: Parameters<typeof uploadMultipartFile>[0], token: string) => Promise<{
             message: string;
             mediaType: string;
             process: VariantProcessingState;
@@ -1587,5 +1615,42 @@ declare function createAppManifest(appConfig: {
     readonly manifest: StudioManifest;
 };
 
-export { Studio, StudioHeaders, types as StudioTypes, createAppManifest, Studio as default };
+type CountryCode = keyof typeof EarTag.countryCodes;
+declare class EarTag {
+    static regexISO24631: RegExp;
+    static countryCodes: {
+        [key: string]: string;
+    };
+    static get countryCodesByNumber(): {
+        [code: string]: CountryCode;
+    };
+    private normalisedCountryCode;
+    private _raw;
+    get raw(): string;
+    private _isEartag;
+    isEartag(): boolean;
+    private _isoCountryCode?;
+    get isoCountryCode(): string | undefined;
+    private _nationalIdentifier?;
+    get nationalIdentifier(): string | undefined;
+    constructor(input: string, fallbackCountryCode?: CountryCode | string | null);
+    static parse(str: string, fallbackCountryCode?: CountryCode | string | null): EarTag;
+    static format(str: string, marketCountry?: string | null | undefined): string | null;
+    toString(): string;
+    isISO24631(): boolean;
+    toISO24631(): string;
+}
+
+declare function lotComparator<T extends {
+    lotNumber: string;
+}>(a: T, b: T): number;
+declare function sortByLotNumber<T extends {
+    lotNumber: string;
+}>(lots: T[]): T[];
+/***
+ * Generate the next lot number in a sequence:
+ */
+declare function nextLotNumber(previousLotNumber: string): string;
+
+export { EarTag, Studio, StudioHeaders, types as StudioTypes, createAppManifest, Studio as default, lotComparator, nextLotNumber, sortByLotNumber };
 export type { ChunkedFile, StudioInstance, StudioManifest };