JsonPath arrow & dot improvements (#2)

a2lix · Oct 26, 2024 · 452471c · 452471c
1 parent fb73601
commit 452471c
Show file tree

Hide file tree

Showing 5 changed files with 153 additions and 45 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@a2lix/schemql",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "A lightweight TypeScript library that enhances your SQL workflow by combining raw SQL with targeted type safety and schema validation",
   "license": "MIT",
   "keywords": [
@@ -17,7 +17,9 @@
     "dbms-agnostic",
     "lightweight",
     "sql-first",
-    "query-builder"
+    "query-builder",
+    "json",
+    "jsonpath"
   ],
   "author": {
     "name": "David ALLIX",
@@ -56,8 +58,8 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
-    "@types/node": "^22.7.6",
-    "pkgroll": "^2.5.0",
+    "@types/node": "^22.8.1",
+    "pkgroll": "^2.5.1",
     "ts-node": "^10.9.2",
     "tsx": "^4.19.1",
     "typescript": "^5.6.3"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/index.ts b/src/index.ts
@@ -13,17 +13,35 @@ type ValidTableColumnCombinations<DB> = {
   [T in TableNames<DB>]: `${T}.${ColumnNames<DB, T>}` | `${T}.${ColumnNames<DB, T>}-`
 }[TableNames<DB>]
 
-type JsonPathForObject<T, Path extends string = ''> = {
-  [K in keyof T & string]:
-    | `${Path}->'${K}'`
-    | `${Path}->'${K}'-`
-    | `${Path}->>'${K}'`
-    | `${Path}->>'${K}'-`
-    | (T[K] extends object ? JsonPathForObject<T[K], `${Path}->'${K}'`> : never)
-}[keyof T & string]
+type JsonPathForObjectArrow<T, P extends string = ''> = T extends Record<string, any>
+  ? {
+      [K in keyof T & string]:
+        | `${P}->${K}`
+        | `${P}->${K}-`
+        | `${P}->>${K}`
+        | `${P}->>${K}-`
+        | (NonNullable<T[K]> extends Record<string, any>
+            ? `${P}->${K}${JsonPathForObjectArrow<NonNullable<T[K]>, ''>}`
+            : never)
+    }[keyof T & string]
+  : ''
+
+type JsonPathForObjectDot<T, P extends string = ''> = T extends Record<string, any>
+  ? {
+      [K in keyof T & string]:
+        | `${P}.${K}`
+        | (NonNullable<T[K]> extends Record<string, any>
+            ? `${P}.${K}${JsonPathForObjectDot<NonNullable<T[K]>, ''>}`
+            : never)
+    }[keyof T & string]
+  : ''
 
 type JsonPathCombinations<DB, T extends TableNames<DB>> = {
-  [K in ColumnNames<DB, T>]: DB[T][K] extends object ? JsonPathForObject<DB[T][K], `${T}.${K}`> : never
+  [K in ColumnNames<DB, T>]: DB[T][K] extends object
+    ?
+        | JsonPathForObjectArrow<ArrayElement<DB[T][K]>, `${T}.${K} `>
+        | JsonPathForObjectDot<ArrayElement<DB[T][K]>, `${T}.${K} $`>
+    : never
 }[ColumnNames<DB, T>]
 
 type ValidJsonPathCombinations<DB> = {
@@ -163,7 +181,32 @@ export class SchemQl<DB> {
     if (typeof value === 'string') {
       switch (true) {
         case value.startsWith('@'): {
-          return value.endsWith('-') ? (value.split('.')[1]?.slice(0, -1) ?? '') : value.slice(1)
+          // JsonPath dot? Add quotes
+          const jsonPathDotIndex = value.indexOf(' $.')
+          if (jsonPathDotIndex !== -1) {
+            return `'${value.slice(jsonPathDotIndex + 1)}'`
+          }
+
+          let str: string = value
+          // JsonPath arrow? Add quotes
+          const jsonPathArrowIndex = str.indexOf(' ->')
+          if (jsonPathArrowIndex !== -1) {
+            const jsonPathArrow = str
+              .slice(jsonPathArrowIndex + 1)
+              .split(/(?=->)/)
+              .reduce((path, segment) => {
+                const arrow = segment.startsWith('->>') ? '->>' : '->'
+                const value = segment.replace(arrow, '')
+                return `${path}${arrow}'${value}'`
+              }, '')
+            str = `${str.slice(0, jsonPathArrowIndex)}${jsonPathArrow}`
+          }
+
+          if (str.endsWith('-')) {
+            return str.split('.')[1]?.slice(0, -1) ?? ''
+          }
+
+          return str.slice(1)
         }
         case value.startsWith('$'):
         case value.startsWith('§'): // Trick for cond/raw

diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -251,10 +251,10 @@ describe('SchemQl - sql literal', () => {
           normalizeString(`
             SELECT
               *,
-              LENGTH(id) AS length_id
+              LENGTH(users.id) AS length_id
             FROM users
             WHERE
-              id = :id
+              users.id = :id
           `)
         )
         assert.deepEqual(params, { id: 'uuid-1' })
@@ -269,10 +269,10 @@ describe('SchemQl - sql literal', () => {
       normalizeString(s.sql`
           SELECT
             *,
-            LENGTH(${'@users.id-'}) AS ${'$length_id'}
+            LENGTH(${'@users.id'}) AS ${'$length_id'}
           FROM ${'@users'}
           WHERE
-            ${'@users.id-'} = ${':id'}
+            ${'@users.id'} = ${':id'}
     `)
     )
 
@@ -338,6 +338,67 @@ describe('SchemQl - sql literal advanced', () => {
       disabled_at: null,
     })
   })
+
+  it('should return the expected result - with sql helper', async () => {
+    const result = await schemQlUnconfigured.first({
+      queryFn: (sql, params) => {
+        assert.strictEqual(
+          sql,
+          normalizeString(`
+            UPDATE users
+            SET
+              metadata = json_set(users.metadata,
+                '$.email_variant', :emailVariant,
+                '$.email_verified_at', :emailVerifiedAt
+              )
+            WHERE
+              users.metadata->'role' = :role
+            RETURNING *
+          `)
+        )
+        assert.deepEqual(params, { role: 'admin', emailVariant: '[email protected]', emailVerifiedAt: 1500000000 })
+        return {
+          id: 'uuid-2',
+          email: '[email protected]',
+          metadata: '{"role":"admin","email_variant":"[email protected]","email_verified_at":1500000000}',
+          created_at: 1500000000,
+          disabled_at: null,
+        }
+      },
+      resultSchema: zUserDb,
+      params: {
+        role: 'admin',
+        emailVariant: '[email protected]',
+        emailVerifiedAt: 1500000000,
+      },
+      paramsSchema: z.object({ role: z.string(), emailVariant: z.string(), emailVerifiedAt: z.number().int() }),
+    })((s) =>
+      normalizeString(s.sql`
+        UPDATE ${'@users'}
+        SET
+          ${'@users.metadata-'} = json_set(${'@users.metadata'},
+            ${'@users.metadata $.email_variant'}, ${':emailVariant'},
+            ${'@users.metadata $.email_verified_at'}, ${':emailVerifiedAt'}
+          )
+        WHERE
+          ${'@users.metadata ->role'} = ${':role'}
+        RETURNING *
+      `)
+    )
+
+    assert.deepEqual(result, {
+      id: 'uuid-2',
+      email: '[email protected]',
+      metadata: {
+        role: 'admin',
+        email_variant: '[email protected]',
+        email_verified_at: 1500000000,
+      },
+      created_at: 1500000000,
+      disabled_at: null,
+    })
+  })
+
   it('should return the expected result - with sqlCond & sqlRaw helpers', async () => {
     const result = await schemQlUnconfigured.all({
       queryFn: (sql, params) => {

diff --git a/tests/schema_zod.ts b/tests/schema_zod.ts
@@ -8,6 +8,8 @@ export const zUserDb = z.object({
     parseJsonPreprocessor,
     z.object({
       role: z.enum(['user', 'admin']).default('user'),
+      email_variant: z.string().optional(),
+      email_verified_at: z.number().int().optional(),
     })
   ),
   created_at: z.number().int(),