@marteye/studiojs 1.1.37 → 1.1.39

package/dist/resources/activity.d.ts

@@ -0,0 +1,35 @@
+import { HttpClient } from "../net/http";
+import { ActivityLog } from "../types";
+export interface ActivityListResponse {
+    data: ActivityLog[];
+    lastId: string | null;
+    hasMore: boolean;
+}
+export interface ActivityListParams {
+    saleId?: string;
+    entityType?: string;
+    entityId?: string;
+    operation?: string;
+    memberId?: string;
+    from?: string;
+    to?: string;
+    limit?: number;
+    lastId?: string;
+}
+export default function create(httpClient: HttpClient): {
+    /**
+     * List activity logs for a market with pagination and filtering
+     * @param marketId - ID of the market
+     * @param params - Optional filtering and pagination parameters
+     * @returns Paginated list of activity logs
+     */
+    list: (marketId: string, params?: ActivityListParams) => Promise<ActivityListResponse>;
+    /**
+     * Get a specific activity log by ID
+     * @param marketId - ID of the market
+     * @param activityId - ID of the activity log entry
+     * @returns The activity log details
+     */
+    get: (marketId: string, activityId: string) => Promise<ActivityLog>;
+};
+export type Activity = ReturnType<typeof create>;

package/dist/resources/carts.d.ts

@@ -0,0 +1,35 @@
+import { HttpClient } from "../net/http";
+import { CartItem, Lot } from "../types";
+export interface LotsBySale {
+    saleId: string;
+    marketId: string;
+    lots: Lot[];
+}
+export interface CartResponse {
+    customerId: string;
+    extras: CartItem[];
+    lotsBuyingBySale: LotsBySale[];
+    lotsSellingBySale: LotsBySale[];
+}
+export interface AddExtraPayload {
+    productId: string;
+    clientType: "Seller" | "Buyer";
+    quantity: number;
+    unitPriceInCents: number;
+    passthroughFundsToCustomerId?: string | null;
+}
+export default function create(httpClient: HttpClient): {
+    /**
+     * Get the full cart for a customer including extras and uninvoiced lots
+     */
+    get: (marketId: string, customerId: string) => Promise<CartResponse>;
+    /**
+     * Add an extra product to the customer's cart
+     */
+    addExtra: (marketId: string, customerId: string, data: AddExtraPayload) => Promise<CartResponse>;
+    /**
+     * Remove an extra from the customer's cart
+     */
+    removeExtra: (marketId: string, customerId: string, itemId: string) => Promise<void>;
+};
+export type Carts = ReturnType<typeof create>;

package/dist/resources/ledger.d.ts

@@ -0,0 +1,79 @@
+import { HttpClient } from "../net/http";
+export interface LedgerBalanceResponse {
+    balanceInCents: number;
+}
+export interface LedgerTransaction {
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    transactionDate: string;
+    marketId: string;
+    account: string;
+    rollUpAccounts: string[];
+    accountType: "income" | "expense" | "asset" | "liability" | "equity";
+    accountName: string;
+    owner: "market" | string;
+    isMarketAccount: boolean;
+    amountInCents: number;
+    batchId: string;
+    batchDescription: string;
+    referenceId: string;
+    referenceType: string;
+    referenceTxnCount: number;
+    referenceGroupKey: string;
+    tags: Record<string, string | number | boolean>;
+    parentTransactionId: string | null;
+    currentBalanceInCents: number;
+    sumOfCreditsInCents: number;
+    sumOfDebitsInCents: number;
+    index: number;
+}
+export interface TransactionsListResponse {
+    transactions: LedgerTransaction[];
+    nextCursor: string | null;
+    hasMore: boolean;
+}
+export interface ListTransactionsParams {
+    account: string;
+    dateFrom?: string;
+    dateTo?: string;
+    limit?: number;
+    cursor?: string;
+}
+export default function create(httpClient: HttpClient): {
+    /**
+     * Get the current balance for a ledger account
+     * @param marketId - ID of the market
+     * @param account - Full account string (format: owner:accountType:accountName)
+     *                  e.g. "customerId:asset:trade receivable" or "market:liability:trade payable"
+     * @returns The current balance in cents
+     */
+    getBalance: (marketId: string, account: string) => Promise<LedgerBalanceResponse>;
+    /**
+     * Get a transaction by ID
+     * @param marketId - ID of the market
+     * @param transactionId - ID of the transaction
+     * @returns The transaction details
+     */
+    getTransaction: (marketId: string, transactionId: string) => Promise<LedgerTransaction>;
+    /**
+     * Get the latest transaction on an account
+     * @param marketId - ID of the market
+     * @param account - Full account string (format: owner:accountType:accountName)
+     * @returns The latest transaction on the account
+     */
+    getLatestTransaction: (marketId: string, account: string) => Promise<LedgerTransaction>;
+    /**
+     * List transactions for an account with optional date range and pagination
+     * @param marketId - ID of the market
+     * @param params - Query parameters
+     * @param params.account - Full account string (format: owner:accountType:accountName)
+     * @param params.dateFrom - Optional start date (ISO 8601 format, e.g. "2024-01-01")
+     * @param params.dateTo - Optional end date (ISO 8601 format, e.g. "2024-12-31")
+     * @param params.limit - Optional max results (default 50, max 100)
+     * @param params.cursor - Optional cursor for pagination
+     * @returns List of transactions with pagination info
+     */
+    listTransactions: (marketId: string, params: ListTransactionsParams) => Promise<TransactionsListResponse>;
+};
+export type Ledger = ReturnType<typeof create>;

package/dist/resources/payouts.d.ts

@@ -5,6 +5,31 @@ export interface PayoutsListResponse {
     lastId: string | null;
     hasMore: boolean;
 }
+export interface PayoutCreateResponse {
+    payout: Payout;
+}
+export interface CreatePayoutRequest {
+    /** IDs of the seller invoices this payout is for. All must be for the same customer and have status "issued". */
+    invoiceIds: string[];
+    /** Payout method */
+    method: "BACS" | "Cheque" | "Cash";
+    /** Payout amount in cents. If not provided, defaults to the sum of amountDueInCents across all invoices. */
+    amountInCents?: number;
+    /** Transaction date (ISO 8601). Defaults to now. */
+    transactionDate?: string;
+    /** Cheque number or BACS reference */
+    reference?: string | null;
+    /** Optional notes */
+    notes?: string | null;
+    /** Account holder name (BACS only). Falls back to customer bank details or display name. */
+    accountName?: string;
+    /** 8-digit account number (BACS only). Falls back to customer bank details. */
+    accountNumber?: string;
+    /** 6-digit sort code (BACS only). Falls back to customer bank details. */
+    sortCode?: string;
+    /** Name on cheque (Cheque only). Falls back to customer display name. */
+    chequeMadePayableTo?: string;
+}
 export default function create(httpClient: HttpClient): {
     /**
      * List all payouts for a market with pagination
@@ -20,5 +45,14 @@ export default function create(httpClient: HttpClient): {
      * @returns The payout details
      */
     get: (marketId: string, payoutId: string) => Promise<Payout>;
+    /**
+     * Create a payout for one or more seller invoices.
+     * Use this to re-create a payout after voiding (e.g., lost cheque).
+     * Payment details will fall back to customer defaults if not provided.
+     * @param marketId - ID of the market
+     * @param data - Payout creation data
+     * @returns The created payout
+     */
+    create: (marketId: string, data: CreatePayoutRequest) => Promise<PayoutCreateResponse>;
 };
 export type Payouts = ReturnType<typeof create>;

package/dist/resources/sales.d.ts

@@ -1,5 +1,5 @@
 import { HttpClient } from "../net/http";
-import { Sale } from "../types";
+import { Sale, SalePublishStatus } from "../types";
 type SalesListResponse = {
     start: string;
     end: string;
@@ -36,6 +36,7 @@ export default function create(httpClient: HttpClient): {
         recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
         defaultProductCode?: string;
         attributeDefaults?: Record<string, any>;
+        publishStatus?: SalePublishStatus;
         marteyeSettings?: {
             description?: string;
             image?: string;

package/dist/resources.d.ts

@@ -1,5 +1,9 @@
 import type { HttpClient } from "./net/http";
 export default function resources(httpClient: HttpClient): {
+    activity: {
+        list: (marketId: string, params?: import("./resources/activity").ActivityListParams) => Promise<import("./resources/activity").ActivityListResponse>;
+        get: (marketId: string, activityId: string) => Promise<import("./types").ActivityLog>;
+    };
     markets: {
         get: (marketId: string) => Promise<import("./types").Market>;
     };
@@ -36,6 +40,7 @@ export default function resources(httpClient: HttpClient): {
             recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
             defaultProductCode?: string;
             attributeDefaults?: Record<string, any>;
+            publishStatus?: import("./types").SalePublishStatus;
             marteyeSettings?: {
                 description?: string;
                 image?: string;
@@ -135,6 +140,11 @@ export default function resources(httpClient: HttpClient): {
         }) => Promise<import("./types").LotItem>;
         delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
     };
+    carts: {
+        get: (marketId: string, customerId: string) => Promise<import("./resources/carts").CartResponse>;
+        addExtra: (marketId: string, customerId: string, data: import("./resources/carts").AddExtraPayload) => Promise<import("./resources/carts").CartResponse>;
+        removeExtra: (marketId: string, customerId: string, itemId: string) => Promise<void>;
+    };
     cph: {
         lookup: (marketId: string, cph: string) => Promise<import("./types").CphLookupResponse>;
     };
@@ -221,6 +231,7 @@ export default function resources(httpClient: HttpClient): {
     payouts: {
         list: (marketId: string, lastId?: string | null) => Promise<import("./resources/payouts").PayoutsListResponse>;
         get: (marketId: string, payoutId: string) => Promise<import("./types").Payout>;
+        create: (marketId: string, data: import("./resources/payouts").CreatePayoutRequest) => Promise<import("./resources/payouts").PayoutCreateResponse>;
     };
     search: {
         query: (marketId: string, query: string) => Promise<import("./resources/search").SearchResult>;
@@ -249,4 +260,10 @@ export default function resources(httpClient: HttpClient): {
         update: (marketId: string, customerId: string, contactId: string, payload: import("./resources/contacts").CreateOrUpdateContactPayload) => Promise<import("./types").CustomerContact>;
         delete: (marketId: string, customerId: string, contactId: string) => Promise<void>;
     };
+    ledger: {
+        getBalance: (marketId: string, account: string) => Promise<import("./resources/ledger").LedgerBalanceResponse>;
+        getTransaction: (marketId: string, transactionId: string) => Promise<import("./resources/ledger").LedgerTransaction>;
+        getLatestTransaction: (marketId: string, account: string) => Promise<import("./resources/ledger").LedgerTransaction>;
+        listTransactions: (marketId: string, params: import("./resources/ledger").ListTransactionsParams) => Promise<import("./resources/ledger").TransactionsListResponse>;
+    };
 };

package/dist/studio.d.ts

@@ -9,6 +9,10 @@ export declare function Studio(info?: {
     debug?: boolean;
 }): {
     isDebugMode: boolean;
+    activity: {
+        list: (marketId: string, params?: import("./resources/activity").ActivityListParams) => Promise<import("./resources/activity").ActivityListResponse>;
+        get: (marketId: string, activityId: string) => Promise<import("./types").ActivityLog>;
+    };
     markets: {
         get: (marketId: string) => Promise<import("./types").Market>;
     };
@@ -45,6 +49,7 @@ export declare function Studio(info?: {
             recurring?: "Weekly" | "Bi-weekly" | "Monthly" | null;
             defaultProductCode?: string;
             attributeDefaults?: Record<string, any>;
+            publishStatus?: import("./types").SalePublishStatus;
             marteyeSettings?: {
                 description?: string;
                 image?: string;
@@ -144,6 +149,11 @@ export declare function Studio(info?: {
         }) => Promise<import("./types").LotItem>;
         delete: (marketId: string, saleId: string, lotId: string, itemId: string) => Promise<unknown>;
     };
+    carts: {
+        get: (marketId: string, customerId: string) => Promise<import("./resources/carts").CartResponse>;
+        addExtra: (marketId: string, customerId: string, data: import("./resources/carts").AddExtraPayload) => Promise<import("./resources/carts").CartResponse>;
+        removeExtra: (marketId: string, customerId: string, itemId: string) => Promise<void>;
+    };
     cph: {
         lookup: (marketId: string, cph: string) => Promise<import("./types").CphLookupResponse>;
     };
@@ -230,6 +240,7 @@ export declare function Studio(info?: {
     payouts: {
         list: (marketId: string, lastId?: string | null) => Promise<import("./resources/payouts").PayoutsListResponse>;
         get: (marketId: string, payoutId: string) => Promise<import("./types").Payout>;
+        create: (marketId: string, data: import("./resources/payouts").CreatePayoutRequest) => Promise<import("./resources/payouts").PayoutCreateResponse>;
     };
     search: {
         query: (marketId: string, query: string) => Promise<import("./resources/search").SearchResult>;
@@ -258,4 +269,10 @@ export declare function Studio(info?: {
         update: (marketId: string, customerId: string, contactId: string, payload: import("./resources/contacts").CreateOrUpdateContactPayload) => Promise<import("./types").CustomerContact>;
         delete: (marketId: string, customerId: string, contactId: string) => Promise<void>;
     };
+    ledger: {
+        getBalance: (marketId: string, account: string) => Promise<import("./resources/ledger").LedgerBalanceResponse>;
+        getTransaction: (marketId: string, transactionId: string) => Promise<import("./resources/ledger").LedgerTransaction>;
+        getLatestTransaction: (marketId: string, account: string) => Promise<import("./resources/ledger").LedgerTransaction>;
+        listTransactions: (marketId: string, params: import("./resources/ledger").ListTransactionsParams) => Promise<import("./resources/ledger").TransactionsListResponse>;
+    };
 };

package/dist/types.d.ts

@@ -46,6 +46,7 @@ export interface SettingsMarketDefaults {
     defaultUnitOfSale: UnitOfSale;
     defaultSuperType?: SuperType | null;
     defaultSettleDebtsFirst?: boolean;
+    liveEmailsEnabled?: boolean;
     lotDescriptionTemplateMap?: {
         default: string | undefined;
         [supertype: string]: string | undefined;
@@ -133,6 +134,7 @@ export type DisplayBoardMode = "off" | "live" | "manual" | {
     type: "focused";
     field: string;
 };
+export type SalePublishStatus = "unpublished" | "sale" | "saleAndCatalog";
 export interface Sale {
     id: string;
     createdAt: Timestamp;
@@ -200,6 +202,13 @@ export interface Sale {
         };
     };
     editedBy?: string[];
+    /**
+     * Publishing status for external systems
+     * - unpublished: Not listed in external system
+     * - sale: Sale date is listed externally
+     * - saleAndCatalog: Sale and catalog information synced
+     */
+    publishStatus?: SalePublishStatus;
 }
 export interface TemplateSaleData {
     name?: string;
@@ -644,6 +653,7 @@ export interface Customer {
     notes?: string;
     status?: "archived" | "deleted" | null;
     deleteAfter?: Timestamp;
+    casualBuyerLabels?: string[];
 }
 export interface CustomerFromSearch extends Omit<Customer, "createdAt" | "updatedAt" | "lastItemPurchaseDate" | "lastItemSaleDate"> {
     createdAt: number;
@@ -1056,6 +1066,7 @@ export interface AttributeDefinition {
     prefillableFromPreviousLot?: boolean;
     hidden?: boolean;
     showInSellerDetailsPanel?: boolean;
+    showInSellerReviewPanel?: boolean;
     displayTemplate?: string;
     displayTemplateMultiValue?: string;
     type: SupportedAttributeTypes;
@@ -1106,4 +1117,26 @@ export interface CphLookupResponse {
     cphValid?: boolean | null;
     farmName?: string | null;
 }
+export type ActivityOperation = "created" | "updated" | "deleted" | "voided";
+export interface ActivityChange {
+    before?: any;
+    after?: any;
+}
+export interface ActivityLog {
+    id: string;
+    firstEventAt: Timestamp;
+    lastEventAt: Timestamp;
+    userId: string | null;
+    userName?: string;
+    eventType: WebhookEventName;
+    entityType: ObjectType;
+    entityId: string;
+    entityLabel?: string;
+    saleIds: string[];
+    operation: ActivityOperation;
+    changeCount: number;
+    changes?: {
+        [fieldPath: string]: ActivityChange;
+    };
+}
 export {};

package/dist/utils/lots.d.ts

@@ -5,6 +5,12 @@ export declare function sortByLotNumber<T extends {
     lotNumber: string;
 }>(lots: T[]): T[];
 /***
- * Generate the next lot number in a sequence:
+ * Generate the next lot number in a sequence.
+ * Handles various formats:
+ * - Simple: "7" -> "8"
+ * - Alphanumeric: "7A" -> "7B"
+ * - Range: "1-3" -> "4", "1 - 3" -> "4" (flexible whitespace)
+ * - Range with alpha: "1-3A" -> "3B"
+ * - Compound: "1-3, 10" -> "11", "1-5, 7-9" -> "10"
  */
 export declare function nextLotNumber(previousLotNumber: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@marteye/studiojs",
-  "version": "1.1.37",
+  "version": "1.1.39",
   "description": "MartEye Studio JavaScript SDK",
   "license": "MIT",
   "source": "src/index.ts",