core-services-sdk 1.3.69 → 1.3.71

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-services-sdk",
-  "version": "1.3.69",
+  "version": "1.3.71",
   "main": "src/index.js",
   "type": "module",
   "types": "types/index.d.ts",

package/src/ids/generators.js

@@ -160,6 +160,14 @@ export const generateInvoiceItemId = () =>
 export const generateInvoiceCorrectionId = () =>
   generatePrefixedId(ID_PREFIXES.INVOICE_CORRECTION)
 
+/**
+ * Generates a counterparty ID.
+ *
+ * @returns {string}
+ */
+export const generateCounterpartyId = () =>
+  generatePrefixedId(ID_PREFIXES.COUNTERPARTY)
+
 /* =========================
  * AI / document processing
  * ========================= */

package/src/ids/prefixes.js

@@ -57,7 +57,7 @@ export const ID_PREFIXES = Object.freeze({
   DELIVERY_NOTE: 'dln',
   ORDER: 'ord',
   QUOTE: 'qte',
-
+  COUNTERPARTY: 'ctp',
   //////////////////////////////////////////////////////
   // AI / document processing
   //////////////////////////////////////////////////////

package/src/postgresql/connect-to-pg.js

@@ -1,22 +1,41 @@
 import knex from 'knex'
 
 /**
- * Creates and returns a Knex database connection instance.
+ * Creates and returns a Knex PostgreSQL connection instance
+ * with sane default pool and timeout configuration.
  *
- * This function initializes a Knex client configured for PostgreSQL
- * using the provided connection configuration.
+ * Defaults are optimized for typical API / service workloads
+ * and can be overridden by the caller if needed.
  *
  * @param {object|string} connection
- *   Knex connection configuration.
- *   Can be a connection object or a connection string.
+ *   Knex connection configuration or connection string.
+ *
+ * @param {object} [options]
+ *   Optional Knex overrides.
+ *
+ * @param {object} [options.pool]
+ *   Knex pool configuration overrides.
  *
  * @returns {import('knex').Knex}
  *   A configured Knex database instance.
  */
-export const connectToPg = (connection) => {
+export const connectToPg = (connection, options = {}) => {
   const db = knex({
-    connection,
     client: 'pg',
+    connection,
+
+    pool: {
+      min: 2,
+      max: 10,
+      acquireTimeoutMillis: 30000,
+      idleTimeoutMillis: 10000,
+      createTimeoutMillis: 30000,
+      reapIntervalMillis: 1000,
+      propagateCreateError: false,
+      ...(options.pool || {}),
+    },
+
+    ...options,
   })
 
   return db

package/tests/ids/generators.unit.test.js

@@ -72,6 +72,7 @@ import {
 
   // Bots
   generateBotFlowId,
+  generateCounterpartyId,
 } from '../../src/ids/generators.js'
 
 import { ID_PREFIXES } from '../../src/ids/prefixes.js'
@@ -143,6 +144,7 @@ describe('generate*Id functions', () => {
   it('accounting domain', () => {
     testPrefixFunction(generateSupplierId, ID_PREFIXES.SUPPLIER)
     testPrefixFunction(generateCustomerId, ID_PREFIXES.CUSTOMER)
+    testPrefixFunction(generateCounterpartyId, ID_PREFIXES.COUNTERPARTY)
     testPrefixFunction(generateInvoiceId, ID_PREFIXES.INVOICE)
     testPrefixFunction(generateInvoiceItemId, ID_PREFIXES.INVOICE_ITEM)
     testPrefixFunction(
@@ -199,3 +201,9 @@ describe('generate*Id functions', () => {
     testPrefixFunction(generateBotFlowId, ID_PREFIXES.BOT_FLOW)
   })
 })
+
+it('all prefixes are lowercase and reasonably short', () => {
+  Object.values(ID_PREFIXES).forEach((prefix) => {
+    expect(prefix).toMatch(/^[a-z0-9]{2,6}$/)
+  })
+})

package/tests/ids/prefixes.unit.test.js

@@ -29,10 +29,11 @@ describe('ID_PREFIXES', () => {
 
       // Accounting domain
       SUPPLIER: 'sup',
+      CUSTOMER: 'cust',
+      COUNTERPARTY: 'ctp',
       INVOICE: 'inv',
       INVOICE_ITEM: 'invi',
       INVOICE_CORRECTION: 'invc',
-      CUSTOMER: 'cust',
       PAYMENT: 'pay',
       TRANSACTION: 'txn',
       RECEIPT: 'rcp',

package/tests/postgresql/connect-to-pg.unit.test.js

@@ -0,0 +1,70 @@
+// @ts-nocheck
+import { describe, it, expect, afterEach } from 'vitest'
+import { connectToPg } from '../../src/postgresql/connect-to-pg.js'
+
+let db
+
+afterEach(async () => {
+  if (db) {
+    await db.destroy()
+    db = null
+  }
+})
+
+describe('connectToPg', () => {
+  it('creates knex instance with default pool settings', () => {
+    db = connectToPg('postgres://user:pass@localhost:5432/test')
+
+    const pool = db.client.pool
+
+    expect(pool).toBeDefined()
+    expect(pool.min).toBe(2)
+    expect(pool.max).toBe(10)
+    expect(pool.acquireTimeoutMillis).toBeGreaterThan(0)
+    expect(pool.idleTimeoutMillis).toBe(10000)
+  })
+
+  it('allows overriding pool settings', () => {
+    db = connectToPg('postgres://user:pass@localhost:5432/test', {
+      pool: {
+        min: 1,
+        max: 20,
+      },
+    })
+
+    const pool = db.client.pool
+
+    expect(pool.min).toBe(1)
+    expect(pool.max).toBe(20)
+    expect(pool.acquireTimeoutMillis).toBeGreaterThan(0)
+  })
+
+  it('allows overriding non-pool knex options', () => {
+    db = connectToPg('postgres://user:pass@localhost:5432/test', {
+      debug: true,
+    })
+
+    expect(db.client.config.debug).toBe(true)
+  })
+
+  it('does not lose default pool values when partial override is provided', () => {
+    db = connectToPg('postgres://user:pass@localhost:5432/test', {
+      pool: {
+        max: 15,
+      },
+    })
+
+    const pool = db.client.pool
+
+    expect(pool.min).toBe(2)
+    expect(pool.max).toBe(15)
+    expect(pool.acquireTimeoutMillis).toBeGreaterThan(0)
+  })
+
+  it('returns a valid knex instance', () => {
+    db = connectToPg('postgres://user:pass@localhost:5432/test')
+
+    expect(typeof db.raw).toBe('function')
+    expect(typeof db.destroy).toBe('function')
+  })
+})

package/types/ids/generators.d.ts

@@ -26,6 +26,7 @@ export function generateSupplierId(): string
 export function generateInvoiceId(): string
 export function generateInvoiceItemId(): string
 export function generateInvoiceCorrectionId(): string
+export function generateCounterpartyId(): string
 export function generateDocumentDataId(): string
 export function generateBotFlowId(): string
 export function generateCorrelationId(): string

package/types/ids/prefixes.d.ts

@@ -50,6 +50,7 @@ export const ID_PREFIXES: Readonly<{
   DELIVERY_NOTE: 'dln'
   ORDER: 'ord'
   QUOTE: 'qte'
+  COUNTERPARTY: 'ctp'
   DOCUMENT_DATA: 'docd'
   CORRELATION: 'crln'
   EVENT: 'evt'

package/types/postgresql/connect-to-pg.d.ts

@@ -1 +1,6 @@
-export function connectToPg(connection: object | string): import('knex').Knex
+export function connectToPg(
+  connection: object | string,
+  options?: {
+    pool?: object
+  },
+): import('knex').Knex