@ekwo-ai/core 0.4.0

package/dist/books/columns.js

@@ -0,0 +1,466 @@
+/**
+ * What each tool reads back, written once.
+ *
+ * Two rules run through every list. A `numeric` column is asked for as
+ * `amount::text`, so the exact decimal arrives rather than a float; a `date`
+ * or a timestamp likewise, so `2026-06-15` is a string on both routes instead
+ * of whatever a driver decided a date object should be. Everything else —
+ * uuid, text, boolean, integer — crosses unchanged.
+ */
+export const COMPANY = [
+    'id',
+    'name',
+    'trade_name',
+    'legal_name',
+    'legal_form',
+    'country',
+    'fiscal_country',
+    'vat_number',
+    'registration_number',
+    'address_line1',
+    'address_line2',
+    'postal_code',
+    'city',
+    'country',
+    'region',
+    'email',
+    'phone',
+    'website',
+    'logo_url',
+    'share_capital::text',
+    'share_capital_currency',
+    'activity_code',
+    'activity_scheme',
+    'document_template',
+    'default_bank_account_id',
+    'language',
+    'currency_code',
+    'lock_date::text',
+    'tax_lock_date::text',
+    'receivable_account_id',
+    'payable_account_id',
+    'suspense_account_id',
+    'retained_earnings_account_id',
+    'sales_journal_id',
+    'purchase_journal_id',
+    'miscellaneous_journal_id',
+];
+export const FISCAL_YEAR = ['id', 'name', 'start_date::text', 'end_date::text', 'is_closed'];
+export const ACCOUNT = [
+    'id',
+    'code',
+    'name',
+    'account_type',
+    'internal_group',
+    'reconcilable',
+    'currency_code',
+    'deprecated',
+    'pinned',
+];
+export const JOURNAL = ['id', 'code', 'name', 'journal_type', 'active'];
+export const CONTACT = [
+    'id',
+    // The caller's own reference: the idempotency key of the creation.
+    'client_ref',
+    'name',
+    'contact_type',
+    'vat_number',
+    'auxiliary_code',
+    'email',
+    'country',
+    'payment_terms_days',
+    'receivable_account_id',
+    'payable_account_id',
+    'active',
+];
+export const TAX = [
+    'id',
+    'code',
+    'name',
+    'amount::text',
+    'amount_type',
+    'applies_to',
+    'treatment',
+    'vat_category',
+    'valid_from::text',
+    'valid_to::text',
+    'legal_reference',
+    // The generalised engine. `tax_kind` and `jurisdiction` say what a tax is
+    // where the code alone would have to be guessed at; `recoverable` and
+    // `price_include` change what a client should show; `cash_basis` is here so
+    // a reader is not surprised by it once cash-basis VAT starts writing it.
+    'tax_kind',
+    'recoverable',
+    'jurisdiction',
+    'price_include',
+    'cash_basis',
+    'active',
+];
+export const DOCUMENT = [
+    'id',
+    // The caller's own reference: the idempotency key of the creation.
+    'client_ref',
+    'company_id',
+    'doc_type',
+    'state',
+    'payment_state',
+    'number',
+    'supplier_reference',
+    'contact_id',
+    'journal_id',
+    'document_date::text',
+    'accounting_date::text',
+    'due_date::text',
+    'currency_code',
+    'language',
+    'amount_untaxed::text',
+    'amount_tax::text',
+    'amount_total::text',
+    'amount_paid::text',
+    'amount_residual::text',
+    'entry_id',
+    'sent_at::text',
+];
+/**
+ * The mentions the law of a country puts on one document, from the view that
+ * decides which of them apply. `text` is the sentence in the language the
+ * document was written in and `language` says which one that is; `text_i18n`
+ * crosses as it is, for a renderer printing a second language beside it.
+ */
+export const DOCUMENT_LEGAL_MENTION = [
+    'code',
+    'applies_when',
+    'language',
+    'text',
+    'text_i18n',
+    'sequence',
+    'legal_reference',
+];
+/**
+ * What the country of a document requires of it, beside the mentions: the
+ * payment term the law sets, how the number is built, when the tax falls due
+ * and how the document is exchanged. Read from `country_defaults`, which
+ * holds null wherever the pack has said nothing — and null is the answer, not
+ * an invitation to substitute another country's.
+ */
+export const COUNTRY_DOCUMENT_RULES = [
+    'country',
+    'numbering_gapless',
+    'number_format',
+    'legal_payment_days',
+    'late_payment_reference',
+    'tax_point_rule',
+    'einvoice_profile',
+    'einvoice_mandatory_from::text',
+    'party_scheme',
+    'vat_scheme',
+];
+/**
+ * The header of a document, from the view that assembles it: the seller, the
+ * buyer, the amounts, where it is paid and what the country of the document
+ * requires. `document_line_items` is the lines and `document_legal_mentions`
+ * the sentences — three reads, and no client holding a copy of the
+ * letterhead.
+ */
+export const DOCUMENT_HEADER = [
+    'document_id',
+    'company_id',
+    'doc_type',
+    'state',
+    'payment_state',
+    'number',
+    'supplier_reference',
+    'document_date::text',
+    'accounting_date::text',
+    'due_date::text',
+    'delivery_date::text',
+    'currency_code',
+    'amount_untaxed::text',
+    'amount_tax::text',
+    'amount_total::text',
+    'amount_paid::text',
+    'amount_residual::text',
+    'payment_terms',
+    'payment_means_code',
+    'payment_reference',
+    'buyer_reference',
+    'order_reference',
+    'contract_reference',
+    'project_reference',
+    'note',
+    'payee_iban',
+    'payee_bic',
+    'seller_name',
+    'seller_legal_name',
+    'seller_legal_form',
+    'seller_vat_number',
+    'seller_registration_number',
+    'seller_address_line1',
+    'seller_address_line2',
+    'seller_postal_code',
+    'seller_city',
+    'seller_country',
+    'seller_email',
+    'seller_phone',
+    'seller_website',
+    'seller_logo_url',
+    'seller_share_capital::text',
+    'seller_share_capital_currency',
+    'seller_activity_code',
+    'seller_activity_scheme',
+    'document_template',
+    'buyer_id',
+    'buyer_name',
+    'buyer_vat_number',
+    'buyer_registration_number',
+    'buyer_address_line1',
+    'buyer_address_line2',
+    'buyer_postal_code',
+    'buyer_city',
+    'buyer_country',
+    'buyer_email',
+    'language',
+    'country',
+    'number_format',
+    'numbering_gapless',
+    'legal_payment_days',
+    'late_payment_reference',
+    'tax_point_rule',
+    'einvoice_profile',
+    'einvoice_mandatory_from::text',
+    'party_scheme',
+    'vat_scheme',
+];
+export const PRODUCT = [
+    'id',
+    'company_id',
+    'code',
+    'name',
+    'description',
+    'kind',
+    'unit_code',
+    'currency_code',
+    'sale_price::text',
+    'purchase_price::text',
+    'sale_account_id',
+    'purchase_account_id',
+    'sale_tax_id',
+    'purchase_tax_id',
+    'active',
+];
+export const DOCUMENT_LINE = [
+    'id',
+    'document_id',
+    'sequence',
+    'line_type',
+    'name',
+    'description',
+    'product_id',
+    'quantity::text',
+    'unit_code',
+    'unit_price::text',
+    'discount_percent::text',
+    'tax_id',
+    'account_id',
+    'vat_category',
+    'vat_rate::text',
+    'amount_untaxed::text',
+    'unit_price_includes_tax',
+    'amount_incl_tax::text',
+];
+export const ENTRY = [
+    'id',
+    'company_id',
+    'journal_id',
+    'number',
+    'entry_date::text',
+    'reference',
+    'description',
+    'state',
+    'kind',
+    'document_id',
+    'total_debit::text',
+    'total_credit::text',
+    'is_balanced',
+    'posted_at::text',
+];
+export const ENTRY_LINE = [
+    'id',
+    'entry_id',
+    'account_id',
+    'sequence',
+    'name',
+    'debit::text',
+    'credit::text',
+    'balance::text',
+    'contact_id',
+    'date_maturity::text',
+    'tax_id',
+    'tax_line',
+    'declaration_box',
+    'box_amount::text',
+    'matching_number',
+    'matched_amount::text',
+    // The currency of the line and its amount in it, written whenever that
+    // currency is not the company's. A client matching two foreign lines needs
+    // both: that is the scale the matching is worked out on.
+    'currency_code',
+    'amount_currency::text',
+];
+export const BANK_ACCOUNT = [
+    'id',
+    'name',
+    'iban',
+    'bic',
+    'bank_name',
+    'currency_code',
+    'account_id',
+    'journal_id',
+    'active',
+];
+export const BANK_TRANSACTION = [
+    'id',
+    'company_id',
+    'bank_account_id',
+    'statement_id',
+    'transaction_date::text',
+    'value_date::text',
+    'amount::text',
+    'currency_code',
+    'description',
+    'counterpart_name',
+    'counterpart_iban',
+    'reference',
+    'structured_reference',
+    'contact_id',
+    'entry_id',
+    'state',
+];
+export const PAYMENT = [
+    'id',
+    // The caller's own reference: the idempotency key of the creation.
+    'client_ref',
+    'company_id',
+    'direction',
+    'payment_date::text',
+    'amount::text',
+    'currency_code',
+    'contact_id',
+    'journal_id',
+    'bank_account_id',
+    'entry_id',
+    'reference',
+    'memo',
+    'state',
+];
+/**
+ * An invitation, without its secret. `token_hash` is deliberately absent: it
+ * is of no use to a client, and a list of hashes is a thing to leak rather
+ * than a thing to show.
+ */
+/** What one person chose for themselves. Null everywhere is the fresh state. */
+export const USER_PREFERENCES = [
+    'user_id',
+    'preferred_company_id',
+    'language',
+    'timezone',
+    'date_display_format',
+    'number_display_format',
+    'theme',
+    'updated_at::text',
+];
+export const INVITATION = [
+    'id',
+    'company_id',
+    'email',
+    'role',
+    'capabilities_granted',
+    'invited_by',
+    'created_at::text',
+    'expires_at::text',
+    'accepted_at::text',
+    'accepted_by',
+    'revoked_at::text',
+];
+/** A machine key, without its hash. The secret is returned once, elsewhere. */
+export const API_KEY = [
+    'id',
+    'company_id',
+    'name',
+    'prefix',
+    'capabilities',
+    'created_by',
+    'created_at::text',
+    'expires_at::text',
+    'last_used_at::text',
+    'revoked_at::text',
+];
+/** A public link onto a document, without its secret. There is only a hash. */
+export const DOCUMENT_SHARE = [
+    'id',
+    'company_id',
+    'document_id',
+    'subject_kind',
+    'created_by',
+    'created_at::text',
+    'expires_at::text',
+    'revoked_at::text',
+    'view_count',
+    'last_viewed_at::text',
+];
+export const INSTANCE = [
+    'instance_id',
+    'organization_name',
+    'country',
+    'edition',
+    'schema_version',
+    'installed_at::text',
+    'registered_at::text',
+];
+export const RECONCILIATION = [
+    'id',
+    'debit_line_id',
+    'credit_line_id',
+    'amount::text',
+    'matching_number',
+    'matched_at::text',
+    // What the matching revealed, when it revealed something: the entry that
+    // booked the realised exchange difference, and the one that moved the share
+    // of a cash-basis tax the settlement made due. A client that shows a
+    // matching shows what it caused.
+    'fx_entry_id',
+    'tax_transfer_entry_id',
+];
+export const AUDIT_LOG = [
+    'id',
+    'occurred_at::text',
+    'actor_id',
+    'api_key_id',
+    'company_id',
+    'table_name',
+    'record_id',
+    'record_key',
+    'operation',
+    'action',
+    'old_values',
+    'new_values',
+];
+/**
+ * `country_packs` — which pack this installation holds, and where its rules
+ * come from. `sources` is the register the pack declares: a reader that wants
+ * to check a rate rather than trust it starts there.
+ */
+export const COUNTRY_PACK = [
+    'country',
+    'name',
+    'version',
+    'released_at::text',
+    'schema_min',
+    'certification_status',
+    'certified_by',
+    'certified_at::text',
+    'checksum',
+    'sources',
+    'installed_at::text',
+];
+//# sourceMappingURL=columns.js.map

package/dist/books/columns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"columns.js","sourceRoot":"","sources":["../../src/books/columns.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI;IACJ,MAAM;IACN,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,SAAS;IACT,gBAAgB;IAChB,YAAY;IACZ,qBAAqB;IACrB,eAAe;IACf,eAAe;IACf,aAAa;IACb,MAAM;IACN,SAAS;IACT,QAAQ;IACR,OAAO;IACP,OAAO;IACP,SAAS;IACT,UAAU;IACV,qBAAqB;IACrB,wBAAwB;IACxB,eAAe;IACf,iBAAiB;IACjB,mBAAmB;IACnB,yBAAyB;IACzB,UAAU;IACV,eAAe;IACf,iBAAiB;IACjB,qBAAqB;IACrB,uBAAuB;IACvB,oBAAoB;IACpB,qBAAqB;IACrB,8BAA8B;IAC9B,kBAAkB;IAClB,qBAAqB;IACrB,0BAA0B;CAC3B,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,WAAW,CAAC,CAAC;AAE7F,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI;IACJ,MAAM;IACN,MAAM;IACN,cAAc;IACd,gBAAgB;IAChB,cAAc;IACd,eAAe;IACf,YAAY;IACZ,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;AAExE,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI;IACJ,mEAAmE;IACnE,YAAY;IACZ,MAAM;IACN,cAAc;IACd,YAAY;IACZ,gBAAgB;IAChB,OAAO;IACP,SAAS;IACT,oBAAoB;IACpB,uBAAuB;IACvB,oBAAoB;IACpB,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,GAAG,GAAG;IACjB,IAAI;IACJ,MAAM;IACN,MAAM;IACN,cAAc;IACd,aAAa;IACb,YAAY;IACZ,WAAW;IACX,cAAc;IACd,kBAAkB;IAClB,gBAAgB;IAChB,iBAAiB;IACjB,0EAA0E;IAC1E,sEAAsE;IACtE,4EAA4E;IAC5E,yEAAyE;IACzE,UAAU;IACV,aAAa;IACb,cAAc;IACd,eAAe;IACf,YAAY;IACZ,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,IAAI;IACJ,mEAAmE;IACnE,YAAY;IACZ,YAAY;IACZ,UAAU;IACV,OAAO;IACP,eAAe;IACf,QAAQ;IACR,oBAAoB;IACpB,YAAY;IACZ,YAAY;IACZ,qBAAqB;IACrB,uBAAuB;IACvB,gBAAgB;IAChB,eAAe;IACf,UAAU;IACV,sBAAsB;IACtB,kBAAkB;IAClB,oBAAoB;IACpB,mBAAmB;IACnB,uBAAuB;IACvB,UAAU;IACV,eAAe;CAChB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,MAAM;IACN,cAAc;IACd,UAAU;IACV,MAAM;IACN,WAAW;IACX,UAAU;IACV,iBAAiB;CAClB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,SAAS;IACT,mBAAmB;IACnB,eAAe;IACf,oBAAoB;IACpB,wBAAwB;IACxB,gBAAgB;IAChB,kBAAkB;IAClB,+BAA+B;IAC/B,cAAc;IACd,YAAY;CACb,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,aAAa;IACb,YAAY;IACZ,UAAU;IACV,OAAO;IACP,eAAe;IACf,QAAQ;IACR,oBAAoB;IACpB,qBAAqB;IACrB,uBAAuB;IACvB,gBAAgB;IAChB,qBAAqB;IACrB,eAAe;IACf,sBAAsB;IACtB,kBAAkB;IAClB,oBAAoB;IACpB,mBAAmB;IACnB,uBAAuB;IACvB,eAAe;IACf,oBAAoB;IACpB,mBAAmB;IACnB,iBAAiB;IACjB,iBAAiB;IACjB,oBAAoB;IACpB,mBAAmB;IACnB,MAAM;IACN,YAAY;IACZ,WAAW;IACX,aAAa;IACb,mBAAmB;IACnB,mBAAmB;IACnB,mBAAmB;IACnB,4BAA4B;IAC5B,sBAAsB;IACtB,sBAAsB;IACtB,oBAAoB;IACpB,aAAa;IACb,gBAAgB;IAChB,cAAc;IACd,cAAc;IACd,gBAAgB;IAChB,iBAAiB;IACjB,4BAA4B;IAC5B,+BAA+B;IAC/B,sBAAsB;IACtB,wBAAwB;IACxB,mBAAmB;IACnB,UAAU;IACV,YAAY;IACZ,kBAAkB;IAClB,2BAA2B;IAC3B,qBAAqB;IACrB,qBAAqB;IACrB,mBAAmB;IACnB,YAAY;IACZ,eAAe;IACf,aAAa;IACb,UAAU;IACV,SAAS;IACT,eAAe;IACf,mBAAmB;IACnB,oBAAoB;IACpB,wBAAwB;IACxB,gBAAgB;IAChB,kBAAkB;IAClB,+BAA+B;IAC/B,cAAc;IACd,YAAY;CACb,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI;IACJ,YAAY;IACZ,MAAM;IACN,MAAM;IACN,aAAa;IACb,MAAM;IACN,WAAW;IACX,eAAe;IACf,kBAAkB;IAClB,sBAAsB;IACtB,iBAAiB;IACjB,qBAAqB;IACrB,aAAa;IACb,iBAAiB;IACjB,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,IAAI;IACJ,aAAa;IACb,UAAU;IACV,WAAW;IACX,MAAM;IACN,aAAa;IACb,YAAY;IACZ,gBAAgB;IAChB,WAAW;IACX,kBAAkB;IAClB,wBAAwB;IACxB,QAAQ;IACR,YAAY;IACZ,cAAc;IACd,gBAAgB;IAChB,sBAAsB;IACtB,yBAAyB;IACzB,uBAAuB;CACxB,CAAC;AAEF,MAAM,CAAC,MAAM,KAAK,GAAG;IACnB,IAAI;IACJ,YAAY;IACZ,YAAY;IACZ,QAAQ;IACR,kBAAkB;IAClB,WAAW;IACX,aAAa;IACb,OAAO;IACP,MAAM;IACN,aAAa;IACb,mBAAmB;IACnB,oBAAoB;IACpB,aAAa;IACb,iBAAiB;CAClB,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,IAAI;IACJ,UAAU;IACV,YAAY;IACZ,UAAU;IACV,MAAM;IACN,aAAa;IACb,cAAc;IACd,eAAe;IACf,YAAY;IACZ,qBAAqB;IACrB,QAAQ;IACR,UAAU;IACV,iBAAiB;IACjB,kBAAkB;IAClB,iBAAiB;IACjB,sBAAsB;IACtB,uEAAuE;IACvE,2EAA2E;IAC3E,yDAAyD;IACzD,eAAe;IACf,uBAAuB;CACxB,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI;IACJ,MAAM;IACN,MAAM;IACN,KAAK;IACL,WAAW;IACX,eAAe;IACf,YAAY;IACZ,YAAY;IACZ,QAAQ;CACT,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,IAAI;IACJ,YAAY;IACZ,iBAAiB;IACjB,cAAc;IACd,wBAAwB;IACxB,kBAAkB;IAClB,cAAc;IACd,eAAe;IACf,aAAa;IACb,kBAAkB;IAClB,kBAAkB;IAClB,WAAW;IACX,sBAAsB;IACtB,YAAY;IACZ,UAAU;IACV,OAAO;CACR,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI;IACJ,mEAAmE;IACnE,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,oBAAoB;IACpB,cAAc;IACd,eAAe;IACf,YAAY;IACZ,YAAY;IACZ,iBAAiB;IACjB,UAAU;IACV,WAAW;IACX,MAAM;IACN,OAAO;CACR,CAAC;AAEF;;;;GAIG;AACH,gFAAgF;AAChF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,SAAS;IACT,sBAAsB;IACtB,UAAU;IACV,UAAU;IACV,qBAAqB;IACrB,uBAAuB;IACvB,OAAO;IACP,kBAAkB;CACnB,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,IAAI;IACJ,YAAY;IACZ,OAAO;IACP,MAAM;IACN,sBAAsB;IACtB,YAAY;IACZ,kBAAkB;IAClB,kBAAkB;IAClB,mBAAmB;IACnB,aAAa;IACb,kBAAkB;CACnB,CAAC;AAEF,+EAA+E;AAC/E,MAAM,CAAC,MAAM,OAAO,GAAG;IACrB,IAAI;IACJ,YAAY;IACZ,MAAM;IACN,QAAQ;IACR,cAAc;IACd,YAAY;IACZ,kBAAkB;IAClB,kBAAkB;IAClB,oBAAoB;IACpB,kBAAkB;CACnB,CAAC;AAEF,+EAA+E;AAC/E,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,IAAI;IACJ,YAAY;IACZ,aAAa;IACb,cAAc;IACd,YAAY;IACZ,kBAAkB;IAClB,kBAAkB;IAClB,kBAAkB;IAClB,YAAY;IACZ,sBAAsB;CACvB,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,aAAa;IACb,mBAAmB;IACnB,SAAS;IACT,SAAS;IACT,gBAAgB;IAChB,oBAAoB;IACpB,qBAAqB;CACtB,CAAC;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,IAAI;IACJ,eAAe;IACf,gBAAgB;IAChB,cAAc;IACd,iBAAiB;IACjB,kBAAkB;IAClB,yEAAyE;IACzE,4EAA4E;IAC5E,qEAAqE;IACrE,iCAAiC;IACjC,aAAa;IACb,uBAAuB;CACxB,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG;IACvB,IAAI;IACJ,mBAAmB;IACnB,UAAU;IACV,YAAY;IACZ,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,YAAY;IACZ,WAAW;IACX,QAAQ;IACR,YAAY;IACZ,YAAY;CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,SAAS;IACT,MAAM;IACN,SAAS;IACT,mBAAmB;IACnB,YAAY;IACZ,sBAAsB;IACtB,cAAc;IACd,oBAAoB;IACpB,UAAU;IACV,SAAS;IACT,oBAAoB;CACrB,CAAC"}

package/dist/books/contacts.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Contacts: the people and the companies the books name.
+ */
+import { type Backend } from './backend.js';
+import type { ContactType } from '../types.js';
+export declare const CONTACT_TYPES: readonly ["customer", "supplier", "both", "employee", "other"];
+export interface CreateContactArgs {
+    company_id: string;
+    name: string;
+    /** Left out, the database's own default applies. */
+    contact_type?: ContactType | undefined;
+    vat_number?: string | undefined;
+    email?: string | undefined;
+    country?: string | undefined;
+    payment_terms_days?: number | undefined;
+    auxiliary_code?: string | undefined;
+    address_line1?: string | undefined;
+    postal_code?: string | undefined;
+    city?: string | undefined;
+    /** Your own reference. Creating twice under one reference creates once. */
+    client_ref?: string | undefined;
+}
+export interface SearchContactsArgs {
+    company_id: string;
+    query?: string | undefined;
+    contact_type?: ContactType | undefined;
+    vat_number?: string | undefined;
+    limit?: number | undefined;
+}
+export declare function createContact(backend: Backend, args: CreateContactArgs): Promise<unknown>;
+export declare function searchContacts(backend: Backend, args: SearchContactsArgs): Promise<unknown>;
+/**
+ * The contact a person means by an id, a name or part of one.
+ *
+ * One match is the answer; several are listed and refused, because an invoice
+ * addressed to the wrong one of two namesakes is posted before anybody
+ * notices. An exact name wins over names that merely contain it.
+ */
+export declare function resolveContact(backend: Backend, company: string, wanted: string): Promise<{
+    id: string;
+    name: string;
+}>;
+//# sourceMappingURL=contacts.d.ts.map

package/dist/books/contacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../../src/books/contacts.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAc,KAAK,OAAO,EAAyB,MAAM,cAAc,CAAC;AAG/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE/C,eAAO,MAAM,aAAa,gEAAkG,CAAC;AAE7H,MAAM,WAAW,iBAAiB;IAChC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,YAAY,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACvC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,kBAAkB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,2EAA2E;IAC3E,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC;AAED,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,YAAY,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IACvC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,wBAAsB,aAAa,CACjC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,OAAO,CAAC,CAWlB;AAED,wBAAsB,cAAc,CAClC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,kBAAkB,GACvB,OAAO,CAAC,OAAO,CAAC,CAclB;AAID;;;;;;GAMG;AACH,wBAAsB,cAAc,CAClC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAyBvC"}

package/dist/books/contacts.js

@@ -0,0 +1,67 @@
+/**
+ * Contacts: the people and the companies the books name.
+ */
+import { BooksError } from './backend.js';
+import * as columns from './columns.js';
+import { createdBefore, only } from './shared.js';
+export const CONTACT_TYPES = ['customer', 'supplier', 'both', 'employee', 'other'];
+export async function createContact(backend, args) {
+    const before = await createdBefore(backend, 'contacts', args.company_id, args.client_ref, columns.CONTACT);
+    if (before !== undefined)
+        return { contact: before, replayed: true };
+    const { company_id, ...rest } = args;
+    const row = { company_id, ...rest };
+    const created = only(await backend.insert('contacts', [row], columns.CONTACT), 'the contact could not be created');
+    return { contact: created };
+}
+export async function searchContacts(backend, args) {
+    const where = [{ column: 'company_id', op: 'eq', value: args.company_id }];
+    if (args.query !== undefined)
+        where.push({ column: 'name', op: 'ilike', value: `%${args.query}%` });
+    if (args.contact_type !== undefined)
+        where.push({ column: 'contact_type', op: 'eq', value: args.contact_type });
+    if (args.vat_number !== undefined)
+        where.push({ column: 'vat_number', op: 'eq', value: args.vat_number });
+    const contacts = await backend.select({
+        table: 'contacts',
+        columns: columns.CONTACT,
+        where,
+        order: [{ column: 'name' }],
+        limit: args.limit ?? 50,
+    });
+    return { contacts, count: contacts.length };
+}
+const UUID = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
+/**
+ * The contact a person means by an id, a name or part of one.
+ *
+ * One match is the answer; several are listed and refused, because an invoice
+ * addressed to the wrong one of two namesakes is posted before anybody
+ * notices. An exact name wins over names that merely contain it.
+ */
+export async function resolveContact(backend, company, wanted) {
+    if (UUID.test(wanted))
+        return { id: wanted.toLowerCase(), name: wanted };
+    const found = await backend.select({
+        table: 'contacts',
+        columns: ['id', 'name'],
+        where: [
+            { column: 'company_id', op: 'eq', value: company },
+            { column: 'name', op: 'ilike', value: `%${wanted}%` },
+        ],
+        order: [{ column: 'name' }],
+        limit: 20,
+    });
+    const exact = found.filter((contact) => contact.name.toLowerCase() === wanted.toLowerCase());
+    const matches = exact.length > 0 ? exact : found;
+    if (matches.length === 0) {
+        throw new BooksError(`unknown_contact: no contact of this company is called ${wanted}, or has it in its name.`);
+    }
+    if (matches.length > 1) {
+        throw new BooksError(`ambiguous_contact: ${wanted} is ${matches.length} contacts: ${matches
+            .map((contact) => `${contact.name} (${contact.id})`)
+            .join(', ')}. Name one by its id.`);
+    }
+    return matches[0];
+}
+//# sourceMappingURL=contacts.js.map

package/dist/books/contacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../../src/books/contacts.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAuC,MAAM,cAAc,CAAC;AAC/E,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAGlD,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAA2C,CAAC;AA2B7H,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,OAAgB,EAChB,IAAuB;IAEvB,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC3G,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAErE,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IACrC,MAAM,GAAG,GAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,EAAE,CAAC;IACzC,MAAM,OAAO,GAAG,IAAI,CAClB,MAAM,OAAO,CAAC,MAAM,CAAM,UAAU,EAAE,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAC7D,kCAAkC,CACnC,CAAC;IACF,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;AAC9B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAgB,EAChB,IAAwB;IAExB,MAAM,KAAK,GAAa,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACrF,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;IACpG,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IAChH,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAE1G,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAM;QACzC,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,KAAK;QACL,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC3B,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE;KACxB,CAAC,CAAC;IACH,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC;AAC9C,CAAC;AAED,MAAM,IAAI,GAAG,iEAAiE,CAAC;AAE/E;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAgB,EAChB,OAAe,EACf,MAAc;IAEd,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,MAAM,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IACzE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,MAAM,CAA+B;QAC/D,KAAK,EAAE,UAAU;QACjB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC;QACvB,KAAK,EAAE;YACL,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE;YAClD,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,MAAM,GAAG,EAAE;SACtD;QACD,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;QAC3B,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IACH,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7F,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACjD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,UAAU,CAAC,yDAAyD,MAAM,0BAA0B,CAAC,CAAC;IAClH,CAAC;IACD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,UAAU,CAClB,sBAAsB,MAAM,OAAO,OAAO,CAAC,MAAM,cAAc,OAAO;aACnE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,GAAG,CAAC;aACnD,IAAI,CAAC,IAAI,CAAC,uBAAuB,CACrC,CAAC;IACJ,CAAC;IACD,OAAO,OAAO,CAAC,CAAC,CAAiC,CAAC;AACpD,CAAC"}

package/dist/books/documents.d.ts

@@ -0,0 +1,87 @@
+/**
+ * Documents: drafts and their lines, and the one call that books them.
+ *
+ * One rule holds everywhere here: the ledger is written by the schema, never
+ * by this package. `post_document` carries the accounting rules — balance,
+ * numbering, period locks, the counterpart that is the difference of
+ * everything else — and this file calls it. Nothing here inserts an `entries`
+ * or an `entry_lines` row. Direct inserts are for the objects a person types:
+ * draft documents and their lines.
+ */
+import { type Backend } from './backend.js';
+import type { DocType } from '../types.js';
+export declare const DOC_TYPES: readonly ["sale_invoice", "sale_credit_note", "sale_quote", "purchase_invoice", "purchase_credit_note", "purchase_order"];
+export declare const DOCUMENT_STATES: readonly ["draft", "posted", "cancelled"];
+export declare const PAYMENT_STATES: readonly ["not_paid", "partially_paid", "paid", "overpaid", "reversed"];
+/** A line as a caller writes it: codes or ids, and whatever a product can fill in. */
+export interface LineArgs {
+    name?: string | undefined;
+    description?: string | undefined;
+    quantity?: string | number | undefined;
+    unit_code?: string | undefined;
+    unit_price?: string | number | undefined;
+    discount_percent?: string | number | undefined;
+    product_id?: string | undefined;
+    product_code?: string | undefined;
+    account_id?: string | undefined;
+    account_code?: string | undefined;
+    tax_id?: string | undefined;
+    tax_code?: string | undefined;
+}
+export interface CreateDocumentArgs {
+    company_id: string;
+    doc_type: DocType;
+    contact_id: string;
+    document_date: string;
+    due_date?: string | undefined;
+    accounting_date?: string | undefined;
+    number?: string | undefined;
+    supplier_reference?: string | undefined;
+    currency_code?: string | undefined;
+    journal_id?: string | undefined;
+    payment_reference?: string | undefined;
+    /** Your own reference. Creating twice under one reference creates once. */
+    client_ref?: string | undefined;
+    lines: LineArgs[];
+}
+export interface UpdateDocumentLinesArgs {
+    document_id: string;
+    lines: LineArgs[];
+}
+export interface AddDocumentLineArgs {
+    document_id: string;
+    line: LineArgs;
+}
+export interface PostDocumentArgs {
+    document_id: string;
+    /** Ask the database what posting would write, and write nothing. */
+    dry_run?: boolean | undefined;
+}
+export interface ListDocumentsArgs {
+    company_id: string;
+    doc_type?: DocType | undefined;
+    state?: (typeof DOCUMENT_STATES)[number] | undefined;
+    payment_state?: (typeof PAYMENT_STATES)[number] | undefined;
+    contact_id?: string | undefined;
+    from?: string | undefined;
+    to?: string | undefined;
+    /** Posted and still owed: not paid, or partially. Drafts are owed by nobody. */
+    unpaid?: boolean | undefined;
+    limit?: number | undefined;
+}
+export interface GetDocumentArgs {
+    document_id: string;
+}
+export declare function createDocument(backend: Backend, args: CreateDocumentArgs): Promise<unknown>;
+/** One more line at the end of a draft. The lines already there are untouched. */
+export declare function addDocumentLine(backend: Backend, args: AddDocumentLineArgs): Promise<unknown>;
+export declare function updateDocumentLines(backend: Backend, args: UpdateDocumentLinesArgs): Promise<unknown>;
+export declare function postDocument(backend: Backend, args: PostDocumentArgs): Promise<unknown>;
+export declare function listDocuments(backend: Backend, args: ListDocumentsArgs): Promise<unknown>;
+export declare function getDocument(backend: Backend, args: GetDocumentArgs): Promise<unknown>;
+/**
+ * The document a person means: its id, its number, or the reference its
+ * creator gave it. A draft has no number yet, which is what the third is for.
+ */
+export declare function resolveDocument(backend: Backend, company: string, wanted: string): Promise<string>;
+//# sourceMappingURL=documents.d.ts.map