@ketvietlab/ketsuite 0.1.2 → 0.1.3

package/dist/modules/account/functions.d.ts

@@ -1,14 +1,142 @@
-import type { FnSpec } from '@ketvietlab/ketjs';
+import type { Ctx, FnSpec, Row } from '@ketvietlab/ketjs';
 export declare const ACCOUNT_TYPES: readonly ['asset_receivable', 'asset_cash', 'asset_current', 'asset_non_current', 'asset_prepayments', 'asset_fixed', 'liability_payable', 'liability_credit_card', 'liability_current', 'liability_non_current', 'equity', 'equity_unaffected', 'income', 'income_other', 'expense', 'expense_other', 'expense_depreciation', 'expense_direct_cost', 'off_balance'];
 export declare const JOURNAL_TYPES: readonly ['sale', 'purchase', 'cash', 'bank', 'general'];
 export declare const MOVE_TYPES: readonly ['entry', 'out_invoice', 'out_refund', 'in_invoice', 'in_refund', 'out_receipt', 'in_receipt'];
 export declare const MOVE_STATES: readonly ['draft', 'posted', 'cancel'];
-export declare const PAYMENT_STATES: readonly ['not_paid', 'in_payment', 'paid', 'partial', 'reversed', 'blocked', 'invoicing_legacy'];
+/**
+ * The four a document can actually be in.
+ *
+ * Three more were carried over from the ERP this vocabulary came from, and
+ * nothing in this ledger ever wrote them — so a filter offering them returned an
+ * empty list however the books were kept. Same reason `group` left
+ * TAX_AMOUNT_TYPES: a choice that cannot be reached only wastes the reader's
+ * time.
+ */
+export declare const PAYMENT_STATES: readonly ['not_paid', 'paid', 'partial', 'reversed'];
 export declare const TAX_USES: readonly ['sale', 'purchase', 'none'];
-export declare const TAX_AMOUNT_TYPES: readonly ['group', 'fixed', 'percent', 'division'];
+/**
+ * Group taxes are deliberately absent: a line takes a list of taxes and applies
+ * them in sequence, which is what a group would have expressed anyway. Offering
+ * `group` as a saveable amount type only produced taxes that threw on first use.
+ */
+export declare const TAX_AMOUNT_TYPES: readonly ['fixed', 'percent', 'division'];
 export declare const PAYMENT_TYPES: readonly ['outbound', 'inbound'];
 export declare const PARTNER_TYPES: readonly ['customer', 'supplier'];
+export declare const PAYMENT_SETTLEMENT_KINDS: readonly ['liquidity', 'stored_value'];
 export declare const PAYMENT_TERM_VALUES: readonly ['percent', 'fixed'];
 export declare const PAYMENT_TERM_DELAY_TYPES: readonly ['days_after', 'days_after_end_of_month', 'days_after_end_of_next_month', 'days_end_of_month_on_the'];
+/** The currency a ledger write is denominated in, with the scale its arithmetic must use. */
+export type Ledger = {
+    currency: string;
+    scale: number;
+    timezone: string;
+};
+export declare function ledgerOf(ctx: Ctx): Promise<Ledger>;
+export declare class DraftMoveBoundaryError extends Error {
+    field: string;
+    constructor(field: string, message: string);
+}
+/**
+ * The sole transaction-level boundary for a complete draft journal entry.
+ *
+ * Sale, Purchase and POS build their domain document inside a transaction, then
+ * hand the complete move here. The boundary re-derives every monetary invariant
+ * before any ledger row is accepted. Callers must pass their transaction context;
+ * this helper deliberately does not open a nested transaction.
+ */
+export declare function insertDraftMove(ctx: Ctx, input: {
+    move: Row;
+    lines: Row[];
+}): Promise<{
+    id: string;
+    existing: boolean;
+}>;
+export declare const ACCOUNT_RESOLUTION_EFFECTS: readonly ['read:account.Account', 'read:account.Defaults', 'read:account.CategoryAccount', 'read:product.Product', 'read:product.Template', 'read:partner.CompanyTerms'];
+/** Where an invoice line and its counterpart post, and what decided each. */
+export type ResolvedAccounts = {
+    lineAccountId: unknown;
+    lineAccountFrom: 'explicit' | 'category' | 'company' | null;
+    counterpartAccountId: unknown;
+    counterpartAccountFrom: 'explicit' | 'partner' | 'company' | null;
+};
+/** The ids of every posted move inside an optional inclusive civil-date window. */
+export declare function postedMoves(ctx: Ctx, dateFrom: unknown, dateTo: unknown): Promise<Map<string, Row>>;
+/**
+ * Journal items belonging to the given moves. The ids go into the query so the
+ * database does the narrowing; chunking keeps a long reporting window from
+ * building a parameter list no driver will accept.
+ */
+export declare function linesOfMoves(ctx: Ctx, moveIds: string[], accountId?: unknown): Promise<Row[]>;
+/**
+ * Every account of the active company, by id. Callers that classify a whole page
+ * of journal items need this once instead of a lookup per line — a chart of
+ * accounts is bounded by a company's configured chart while a ledger is not.
+ */
+export declare function accountsById(ctx: Ctx): Promise<Map<string, Row>>;
+/** One tax's share of a line, carrying where it has to post. */
+export type TaxShare = {
+    taxId: unknown;
+    name: string;
+    accountId: unknown;
+    amount: string;
+};
+export type LineAmounts = {
+    untaxed: string;
+    tax: string;
+    total: string;
+    shares: TaxShare[];
+};
+export type TaxQuote = {
+    ok: true;
+    currency: string;
+    scale: number;
+    quantity: string;
+    priceUnit: string;
+    discount: string;
+    amountUntaxed: string;
+    amountTax: string;
+    amountTotal: string;
+    taxIds: string[];
+    taxes: Array<{
+        id: string;
+        name: string;
+        amountType: string;
+        amount: string;
+        priceInclude: boolean;
+        includeBaseAmount: boolean;
+        sequence: number;
+        share: string;
+    }>;
+    shares: Array<{
+        taxId: unknown;
+        name: string;
+        amount: string;
+    }>;
+};
+export type TaxQuoteRefusal = {
+    ok: false;
+    errors: Array<{
+        field: string;
+        message: string;
+        code?: string;
+        params?: Record<string, unknown>;
+    }>;
+};
+/** Canonical product line calculation shared by Sales, POS and invoices. */
+export declare function quoteTaxLineForPosting(ctx: Ctx, input: {
+    productId?: unknown;
+    taxIds?: unknown;
+    quantity: unknown;
+    priceUnit: unknown;
+    discount?: unknown;
+    taxUse?: 'sale' | 'purchase';
+    /** Internal contra-line support; public product pricing remains non-negative. */
+    allowNegativePrice?: boolean;
+}): Promise<(Omit<TaxQuote, 'shares'> & {
+    shares: TaxShare[];
+}) | TaxQuoteRefusal>;
+/** Public calculation evidence intentionally excludes ledger account routing. */
+export declare function quoteTaxLine(ctx: Ctx, input: Parameters<typeof quoteTaxLineForPosting>[1]): Promise<TaxQuote | TaxQuoteRefusal>;
+export declare function postMoveById(ctx: Ctx, id: unknown, expectedRevision?: unknown): Promise<Record<string, unknown>>;
 export declare const functions: Record<string, FnSpec>;
 //# sourceMappingURL=functions.d.ts.map

package/dist/modules/account/functions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../../../../../packages/ketsuite/src/modules/account/functions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAO,MAAM,EAAO,MAAM,mBAAmB,CAAA;AAGzD,eAAO,MAAM,aAAa,YACxB,kBAAkB,EAClB,YAAY,EACZ,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EACb,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,uBAAuB,EACvB,QAAQ,EACR,mBAAmB,EACnB,QAAQ,EACR,cAAc,EACd,SAAS,EACT,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,aAAa,CACL,CAAA;AACV,eAAO,MAAM,aAAa,YAAI,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAU,CAAA;AACrF,eAAO,MAAM,UAAU,YACrB,OAAO,EACP,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,aAAa,EACb,YAAY,CACJ,CAAA;AACV,eAAO,MAAM,WAAW,YAAI,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAA;AACjE,eAAO,MAAM,cAAc,YACzB,UAAU,EACV,YAAY,EACZ,MAAM,EACN,SAAS,EACT,UAAU,EACV,SAAS,EACT,kBAAkB,CACV,CAAA;AACV,eAAO,MAAM,QAAQ,YAAI,MAAM,EAAE,UAAU,EAAE,MAAM,CAAU,CAAA;AAC7D,eAAO,MAAM,gBAAgB,YAAI,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,CAAU,CAAA;AAClF,eAAO,MAAM,aAAa,YAAI,UAAU,EAAE,SAAS,CAAU,CAAA;AAC7D,eAAO,MAAM,aAAa,YAAI,UAAU,EAAE,UAAU,CAAU,CAAA;AAC9D,eAAO,MAAM,mBAAmB,YAAI,SAAS,EAAE,OAAO,CAAU,CAAA;AAChE,eAAO,MAAM,wBAAwB,YACnC,YAAY,EACZ,yBAAyB,EACzB,8BAA8B,EAC9B,0BAA0B,CAClB,CAAA;AAiIV,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAy4B5C,CAAA"}
+{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../../../../../packages/ketsuite/src/modules/account/functions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,mBAAmB,CAAA;AA4BzD,eAAO,MAAM,aAAa,YACxB,kBAAkB,EAClB,YAAY,EACZ,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,aAAa,EACb,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,uBAAuB,EACvB,QAAQ,EACR,mBAAmB,EACnB,QAAQ,EACR,cAAc,EACd,SAAS,EACT,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,aAAa,CACL,CAAA;AACV,eAAO,MAAM,aAAa,YAAI,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAU,CAAA;AACrF,eAAO,MAAM,UAAU,YACrB,OAAO,EACP,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,aAAa,EACb,YAAY,CACJ,CAAA;AACV,eAAO,MAAM,WAAW,YAAI,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAA;AACjE;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc,YAAI,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,CAAU,CAAA;AAClF,eAAO,MAAM,QAAQ,YAAI,MAAM,EAAE,UAAU,EAAE,MAAM,CAAU,CAAA;AAC7D;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,YAAI,OAAO,EAAE,SAAS,EAAE,UAAU,CAAU,CAAA;AACzE,eAAO,MAAM,aAAa,YAAI,UAAU,EAAE,SAAS,CAAU,CAAA;AAC7D,eAAO,MAAM,aAAa,YAAI,UAAU,EAAE,UAAU,CAAU,CAAA;AAC9D,eAAO,MAAM,wBAAwB,YAAI,WAAW,EAAE,cAAc,CAAU,CAAA;AAC9E,eAAO,MAAM,mBAAmB,YAAI,SAAS,EAAE,OAAO,CAAU,CAAA;AAChE,eAAO,MAAM,wBAAwB,YACnC,YAAY,EACZ,yBAAyB,EACzB,8BAA8B,EAC9B,0BAA0B,CAClB,CAAA;AA8PV,6FAA6F;AAC7F,MAAM,MAAM,MAAM,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAE1E,wBAAsB,QAAQ,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAOxD;AAMD,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAGzC;CACF;AAMD;;;;;;;GAOG;AACH,wBAAsB,eAAe,CACnC,GAAG,EAAE,GAAG,EACR,KAAK,EAAE;IAAE,IAAI,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,GAAG,EAAE,CAAA;CAAE,GACjC,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAC,CAwK5C;AAsBD,eAAO,MAAM,0BAA0B,YACrC,sBAAsB,EACtB,uBAAuB,EACvB,8BAA8B,EAC9B,sBAAsB,EACtB,uBAAuB,EACvB,2BAA2B,CACnB,CAAA;AAEV,6EAA6E;AAC7E,MAAM,MAAM,gBAAgB,GAAG;IAC7B,aAAa,EAAE,OAAO,CAAA;IACtB,eAAe,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,GAAG,IAAI,CAAA;IAC3D,oBAAoB,EAAE,OAAO,CAAA;IAC7B,sBAAsB,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI,CAAA;CAClE,CAAA;AAwFD,mFAAmF;AACnF,wBAAsB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAezG;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,CAanG;AAED;;;;GAIG;AACH,wBAAsB,YAAY,CAAC,GAAG,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAEtE;AA2BD,gEAAgE;AAChE,MAAM,MAAM,QAAQ,GAAG;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAC3F,MAAM,MAAM,WAAW,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAA;AA4F7F,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,IAAI,CAAA;IACR,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,EAAE,CAAA;IAChB,KAAK,EAAE,KAAK,CAAC;QACX,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;QACZ,UAAU,EAAE,MAAM,CAAA;QAClB,MAAM,EAAE,MAAM,CAAA;QACd,YAAY,EAAE,OAAO,CAAA;QACrB,iBAAiB,EAAE,OAAO,CAAA;QAC1B,QAAQ,EAAE,MAAM,CAAA;QAChB,KAAK,EAAE,MAAM,CAAA;KACd,CAAC,CAAA;IACF,MAAM,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,CAAA;CAChE,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,EAAE,EAAE,KAAK,CAAA;IACT,MAAM,EAAE,KAAK,CAAC;QACZ,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,MAAM,CAAA;QACf,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,CAAC,CAAA;CACH,CAAA;AAED,4EAA4E;AAC5E,wBAAsB,sBAAsB,CAC1C,GAAG,EAAE,GAAG,EACR,KAAK,EAAE;IACL,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,GAAG,UAAU,CAAA;IAC5B,iFAAiF;IACjF,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B,GACA,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;CAAE,CAAC,GAAG,eAAe,CAAC,CAkEhF;AAED,iFAAiF;AACjF,wBAAsB,YAAY,CAChC,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAC,CAAC,CAAC,GAClD,OAAO,CAAC,QAAQ,GAAG,eAAe,CAAC,CAOrC;AAmBD,wBAAsB,YAAY,CAChC,GAAG,EAAE,GAAG,EACR,EAAE,EAAE,OAAO,EACX,gBAAgB,CAAC,EAAE,OAAO,GACzB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAkLlC;AAmDD,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAiuE5C,CAAA"}