core-services-sdk 1.3.53 → 1.3.55

package/package.json

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

package/src/postgresql/validate-schema.js

@@ -6,19 +6,35 @@ import { connectToPg } from './connect-to-pg.js'
  * Checks all provided table names and collects any missing tables.
  * Throws a single error listing all missing tables after validation completes.
  *
- * @param {string|object} connection
+ * @param {Object} params
+ *   Parameters object.
+ *
+ * @param {string|Object} params.connection
  *   Database connection configuration.
  *   Can be a database connection URI or a Knex connection object.
  *
- * @param {string[]} tables
+ * @param {string[]} params.tables
  *   List of required table names to validate.
  *
+ * @param {Object} [params.log]
+ *   Optional logger object.
+ *
+ * @param {Function} [params.log.info]
+ *   Logger function for informational messages.
+ *
+ * @param {Function} [params.log.error]
+ *   Logger function for error messages.
+ *
  * @returns {Promise<void>}
  *
  * @throws {Error}
  *   Throws an error if one or more required tables are missing.
  */
-export async function validateSchema(connection, tables) {
+export async function validateSchema({
+  tables,
+  connection,
+  log = { info: console.info },
+}) {
   const db = connectToPg(connection)
 
   const missingTables = []
@@ -32,8 +48,11 @@ export async function validateSchema(connection, tables) {
 
   if (missingTables.length > 0) {
     throw new Error(
-      `Missing the following tables: ${missingTables.join(', ')}. ` +
-        `Did you run migrations?`,
+      `Missing the following tables: ${missingTables.join(', ')}. Did you run migrations?`,
     )
   }
+
+  if (tables.length) {
+    log.info(`All required tables are exists: ${tables.join(', ')}`)
+  }
 }

package/tests/postgresql/validate-schema.integration.test.js

@@ -37,18 +37,26 @@ describe('validateSchema', () => {
   })
 
   it('does not throw when all required tables exist', async () => {
-    await expect(validateSchema(DATABASE_URI, ['files'])).resolves.not.toThrow()
+    await expect(
+      validateSchema({ connection: DATABASE_URI, tables: ['files'] }),
+    ).resolves.not.toThrow()
   })
 
   it('throws a single error listing missing tables', async () => {
     await expect(
-      validateSchema(DATABASE_URI, ['files', 'documents', 'attachments']),
+      validateSchema({
+        connection: DATABASE_URI,
+        tables: ['files', 'documents', 'attachments'],
+      }),
     ).rejects.toThrow('Missing the following tables: documents, attachments')
   })
 
   it('throws when all tables are missing', async () => {
     await expect(
-      validateSchema(DATABASE_URI, ['missing_a', 'missing_b']),
+      validateSchema({
+        connection: DATABASE_URI,
+        tables: ['missing_a', 'missing_b'],
+      }),
     ).rejects.toThrow('Missing the following tables: missing_a, missing_b')
   })
 })

package/types/postgresql/validate-schema.d.ts

@@ -4,19 +4,39 @@
  * Checks all provided table names and collects any missing tables.
  * Throws a single error listing all missing tables after validation completes.
  *
- * @param {string|object} connection
+ * @param {Object} params
+ *   Parameters object.
+ *
+ * @param {string|Object} params.connection
  *   Database connection configuration.
  *   Can be a database connection URI or a Knex connection object.
  *
- * @param {string[]} tables
+ * @param {string[]} params.tables
  *   List of required table names to validate.
  *
+ * @param {Object} [params.log]
+ *   Optional logger object.
+ *
+ * @param {Function} [params.log.info]
+ *   Logger function for informational messages.
+ *
+ * @param {Function} [params.log.error]
+ *   Logger function for error messages.
+ *
  * @returns {Promise<void>}
  *
  * @throws {Error}
  *   Throws an error if one or more required tables are missing.
  */
-export function validateSchema(
-  connection: string | object,
-  tables: string[],
-): Promise<void>
+export function validateSchema({
+  tables,
+  connection,
+  log,
+}: {
+  connection: string | any
+  tables: string[]
+  log?: {
+    info?: Function
+    error?: Function
+  }
+}): Promise<void>