Fix $prefix with optional resultSchema

a2lix · Oct 17, 2024 · 4a68132 · 4a68132
1 parent 15309fd
commit 4a68132
Show file tree

Hide file tree

Showing 5 changed files with 137 additions and 99 deletions.
diff --git a/biome.json b/biome.json
@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.9.3/schema.json",
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
   "formatter": {
     "useEditorconfig": true,
     "formatWithErrors": true,

diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
-	"name": "@a2lix/schemql",
-	"version": "0.1.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": [
+  "name": "@a2lix/schemql",
+  "version": "0.1.1",
+  "description": "A lightweight TypeScript library that enhances your SQL workflow by combining raw SQL with targeted type safety and schema validation",
+  "license": "MIT",
+  "keywords": [
     "sql",
     "typescript",
     "database",
@@ -19,45 +19,47 @@
     "sql-first",
     "query-builder"
   ],
-	"author": {
-		"name": "David ALLIX",
-		"url": "https://a2lix.fr"
-	},
-	"homepage": "https://github.com/a2lix/schemql",
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/a2lix/schemql.git"
-	},
-	"main": "./dist/index.cjs",
-	"module": "./dist/index.mjs",
-	"types": "./dist/index.d.ts",
-	"exports": {
-		".": {
-			"import": {
-				"types": "./dist/index.d.mts",
-				"default": "./dist/index.mjs"
-			},
-			"require": {
-				"types": "./dist/index.d.cts",
-				"default": "./dist/index.cjs"
-			}
-		}
-	},
-	"files": ["dist"],
-	"scripts": {
-		"biome": "biome check --write ./src ./tests",
-		"test": "npx tsx --test **/tests/*.ts",
-		"build": "pkgroll --clean-dist --minify --src src/"
-	},
-	"dependencies": {
-		"zod": "^3.23.8"
-	},
-	"devDependencies": {
-		"@biomejs/biome": "^1.9.3",
-		"@types/node": "^22.7.5",
-		"pkgroll": "^2.5.0",
-		"ts-node": "^10.9.2",
-		"tsx": "^4.19.1",
-		"typescript": "^5.6.3"
-	}
+  "author": {
+    "name": "David ALLIX",
+    "url": "https://a2lix.fr"
+  },
+  "homepage": "https://github.com/a2lix/schemql",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/a2lix/schemql.git"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "biome": "biome check --write ./src ./tests",
+    "test": "tsx --test ./tests/**/*.ts",
+    "build": "pkgroll --clean-dist --minify --src src/"
+  },
+  "dependencies": {
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "^1.9.4",
+    "@types/node": "^22.7.6",
+    "pkgroll": "^2.5.0",
+    "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
@@ -36,7 +36,7 @@ type SqlTemplateValue<TResultSchema, TParams, DB> =
   | `@${TableNames<DB>}.*`
   | `@${ValidTableColumnCombinations<DB>}`
   | `@${ValidJsonPathCombinations<DB>}`
-  | `$${keyof ArrayElement<TResultSchema> & string}`
+  | `$${keyof ArrayElement<Exclude<TResultSchema, undefined>> & string}`
   | `:${keyof TParams & string}`
   | `§${string}`
 

diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -242,6 +242,42 @@ describe('SchemQl - sql literal', () => {
       length_id: 6,
     })
   })
+
+  it('should return the expected result, undefined case', async () => {
+    const result = await schemQlUnconfigured.first({
+      queryFn: (sql, params) => {
+        assert.strictEqual(
+          sql,
+          normalizeString(`
+            SELECT
+              *,
+              LENGTH(id) AS length_id
+            FROM users
+            WHERE
+              id = :id
+          `)
+        )
+        assert.deepEqual(params, { id: 'uuid-1' })
+        return undefined
+      },
+      resultSchema: zUserDb.and(z.object({ length_id: z.number() })).optional(),
+      params: {
+        id: 'uuid-1',
+      },
+      paramsSchema: zUserDb.pick({ id: true }),
+    })((s) =>
+      normalizeString(s.sql`
+          SELECT
+            *,
+            LENGTH(${'@users.id-'}) AS ${'$length_id'}
+          FROM ${'@users'}
+          WHERE
+            ${'@users.id-'} = ${':id'}
+    `)
+    )
+
+    assert.deepEqual(result, undefined)
+  })
 })
 
 describe('SchemQl - sql literal advanced', () => {