@sqlbraid/core 0.1.0-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SQLBraid contributors
+
+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,41 @@
+# @sqlbraid/core
+
+Public SQLBraid contracts for rendered statements, execution, leases, observers, Standard Schema mapping, streaming, and routine results.
+
+```sh
+npm install @sqlbraid/core
+```
+
+Adapter authors implement `QueryExecutor.query`, `QueryExecutor.stream`, and
+`QueryExecutor.call` through the value-only `RenderedStatement` boundary. Every
+operation uses `(statement, binding?, options?)`; `ExecutionOptions` carries an
+optional `AbortSignal`, and row/stream options add Standard Schema validation.
+`QueryExecutor.bulk` and `StatementBindingAdapter.describeBulk` are optional
+command-only homogeneous DML capabilities. `QueryExecutor.call` returns
+normalized internal `DriverRoutineResult`; application code receives
+`RoutineCallResult<Output, Sets, ReturnValue>` with `output`, heterogeneous
+`resultSets`, and an optional `returnValue` after runtime mapping.
+
+`UnsupportedFeatureError` is the portable rejection type for missing
+capabilities. It carries `feature`, a stable `BRAID_*` `code`, and `message`.
+Active cancellation must be rejected before I/O with
+`BRAID_CANCEL_UNSUPPORTED` when an adapter cannot cancel. Do not
+buffer streams or guess routine carriers to fake an unsupported operation.
+
+`TransactionOptions` contains `isolation` (`read-uncommitted`,
+`read-committed`, `repeatable-read`, or `serializable`) and `readOnly`.
+Adapters advertise which combinations they can honor; unsupported options
+reject rather than silently changing an active transaction.
+
+```ts
+import type {
+  BulkBindingDescription,
+  BulkExecutionResult,
+  DriverRoutineResult,
+  RenderedBulk,
+  RoutineCallResult,
+  QueryExecutor,
+} from "@sqlbraid/core";
+```
+
+See the [driver-author guide](https://clickin.github.io/SQLBraid/dev/agents/driver-author/) and [routine guide](https://clickin.github.io/SQLBraid/concepts/routines/).