@vireocodedev/query 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 vireocodedev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,104 @@
+# @vireocodedev/query
+
+Framework-free query metadata, transport ports, filter compilation, and parameterized SQLite execution for Vireo Starter.
+
+The package owns reusable query contracts. An application still owns its entity-key vocabulary, HTTP implementation, database schema, SQL expressions, authorization, cache lifecycle, and product UI.
+
+## Install
+
+```bash
+npm install @vireocodedev/query zod
+```
+
+The package is published publicly on npm; installation requires no registry
+authentication. TypeScript declarations are verified from the packed artifact
+with TypeScript 6, `moduleResolution: "Bundler"`, and `skipLibCheck: false`.
+Relative source maps with embedded source content are published intentionally
+for debugging.
+
+The sole peer dependency is `zod >=4.4 <5`. The root entry point is React-free,
+browser-global-free, and worker-safe.
+
+React Query integration lives in `@vireocodedev/ui/tanstack-query`:
+
+```bash
+npm install @vireocodedev/ui @tanstack/react-query
+```
+
+## Public architecture
+
+```text
+application transport
+  -> createQueryEngineApi
+  -> Zod-validated entity metadata
+  -> application cache or createVireoQueryEngineQueries
+  -> query-filter JSON
+  -> compileQueryFilterWhere / compileSearchTextWhere
+  -> createSqliteQueryExecutor
+  -> application-owned SQLite worker port
+```
+
+There are no package-global signals or caches. Every API, executor, and config client is instance-scoped.
+
+## Entity metadata and API
+
+`createQueryEngineEntitySchemas` builds recursive Zod schemas from an optional application-owned entity-key schema. The default accepts any non-empty string, keeping this package generic while rejecting unusable identifiers.
+
+`createQueryEngineApi` accepts a minimal `get(path, options)` port. It validates all responses, encodes dynamic path segments, forwards abort signals, preserves transport and Zod failures, and can optionally retry an application-provided legacy entity key.
+
+```ts
+import { createQueryEngineApi } from "@vireocodedev/query";
+import z from "zod";
+
+const api = createQueryEngineApi(fetchAdapter, {
+  entityKeySchema: z.enum(["CUSTOMER", "ORDER"]),
+  legacyEntityKey: key => (key === "CUSTOMER" ? "customer" : undefined),
+});
+```
+
+## Filter compilation
+
+`bindSqliteSearchColumns` creates one explicit registry for selectable columns, filter fields, and sort expressions. `compileQueryFilterWhere` compiles supported operators into SQL placeholders plus bound values. `compileSearchTextWhere` does the same for free-text search.
+
+The compiler fails closed. Malformed JSON, a mismatched entity, unknown fields, duplicate bindings, and invalid typed values throw instead of silently removing restrictions.
+
+Application-authored SQL expressions remain trusted configuration. Runtime filter/search values are always returned separately as parameters.
+
+## SQLite execution
+
+`createSqliteQueryExecutor` provides paged searches, optional count probing, concurrent-request deduplication, matching-key lookup, timing hooks, and deterministic row mapping over injected execution ports.
+
+`executeParameterizedSqliteQuery` and `executeParameterizedSqlitePagedQuery` are worker-side helpers. Pagination is normalized to whole rows before transport and validated again before interpolation into SQL.
+
+## Config persistence
+
+`createQueryEngineConfigClient` owns instance-local in-memory fallback state and an injected request transport. `createQueryEngineConfigSqliteRequestHandlers`, `replaceQueryEngineConfig`, and `getQueryEngineConfig` provide the worker-side persistence boundary.
+
+Table identifiers, singleton keys, request names, snapshot shape, and persisted JSON are validated. Corrupt storage is reported explicitly and never replaced with an empty configuration.
+
+## React Query integration
+
+The optional React adapter belongs to Starter UI because it imports React Query:
+
+```ts
+import { createVireoQueryEngineQueries } from "@vireocodedev/ui/tanstack-query";
+
+export const QueryEngineQueries = createVireoQueryEngineQueries(api);
+```
+
+The adapter creates stable query options without mutating global signals. Applications remain free to use another cache or the framework-free API directly.
+
+## Failure semantics
+
+- Invalid API response data raises the original Zod error.
+- Transport failures remain transport failures when no legacy retry applies.
+- Aborted requests are never retried.
+- Invalid filter contracts fail closed before SQL execution.
+- Invalid pagination fails before a statement is prepared.
+- Invalid SQLite config identifiers fail synchronously.
+- Malformed or shape-incompatible persisted config raises an error.
+- Duplicate request and filter registrations are rejected.
+
+## Verification and live documentation
+
+Package tests cover public schemas, API paths and failures, filter compilation, pagination, config persistence, concurrency, and framework boundaries. The unified Vireo Storybook contains executable examples under **Query Engine**; every displayed source file is the same TypeScript module Storybook executes.

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@vireocodedev/query",
+  "version": "0.2.0",
+  "description": "Framework-free query schemas, transport ports, and parameterized SQLite execution for Vireo Starter.",
+  "type": "module",
+  "sideEffects": false,
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vireocodedev/starter.git",
+    "directory": "packages/queryengine"
+  },
+  "keywords": [
+    "queryengine",
+    "filters",
+    "zod",
+    "starter"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "dev": "vite build --watch --mode watch",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "vitest run"
+  },
+  "peerDependencies": {
+    "zod": ">=4.4 <5"
+  },
+  "devDependencies": {
+    "typescript": "npm:@typescript/typescript6@^6.0.2",
+    "vite": "^8.2.2",
+    "vite-plugin-dts": "^5.0.3",
+    "vitest": "^4.1.11",
+    "zod": "^4.4.3"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true,
+    "registry": "https://registry.npmjs.org"
+  }
+}