okmodel 0.0.0 → 0.1.0

package/dist/dialects/pg/enum.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Enum and domain columns.
+ *
+ * The catalog column type is the type name. Compile records a dependency on
+ * the enum, and `schema()` stores that enum as a catalog type.
+ */
+import { type ColumnBuilder, type ColumnFlags, type PlainFlags } from "./column.js";
+/**
+ * A named enum. The TypeScript type is the literal union.
+ *
+ * `okmodel/pg` exports this function as `enum`. The declaration stays
+ * `enumColumn` because `enum` is reserved in a function declaration.
+ *
+ * @param name - Postgres type name
+ * @param values - Labels, in stored order
+ * @returns An enum column
+ */
+export declare function enumColumn<const TValues extends readonly string[]>(name: string, values: TValues): ColumnBuilder<TValues[number], PlainFlags>;
+/**
+ * A named domain over a scalar column.
+ *
+ * Domains are not catalog objects in this version. Calling the builder fails
+ * with OKM1061 until 0.3, when a domain becomes a `type` subkind (D141).
+ *
+ * @param name - Domain name
+ * @param base - Scalar column the domain is based on
+ * @param check - Domain check expression
+ * @returns A domain column with the base codec, once 0.3 supports it
+ */
+export declare function domain<TValue, TFlags extends ColumnFlags>(_name: string, _base: ColumnBuilder<TValue, TFlags>, _check: string): ColumnBuilder<TValue, PlainFlags>;

package/dist/dialects/pg/errors.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Maps a Postgres {@link DriverError} to an {@link OkmError} (spec §4.2, §14).
+ *
+ * Adapters normalise the driver into `DriverError`. They do not construct
+ * `OkmError`. Constraint names follow the catalog: `{table}_{nameKey}_{tag}`.
+ */
+import { OkmError, type ErrorStatuses } from "../../contracts/error.js";
+/** Options for {@link mapPostgresError}. */
+export type MapPostgresErrorOptions = {
+    /**
+     * Keep row values on the error. Development only.
+     *
+     * The summary, the log, and {@link OkmError.fields} still omit them.
+     */
+    readonly includeValues?: boolean;
+    /** Category overrides from `connect({ errors })`. */
+    readonly http?: ErrorStatuses;
+};
+/**
+ * Maps a thrown driver error into an {@link OkmError}.
+ *
+ * An {@link OkmError} passes through. `timeout`, `cancelled`, and
+ * `outcome_unknown` follow the driver kind (D124). `57014` without that kind
+ * is `timeout`, because `cancelled` comes only from the caller's signal.
+ *
+ * @param error - Caught value, usually a `DriverError`
+ * @param options - `includeValues` keeps row values off the log
+ * @returns A categorised error
+ */
+export declare function mapPostgresError(error: unknown, options?: MapPostgresErrorOptions): OkmError;

package/dist/dialects/pg/finite.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Decimal text for finite numbers.
+ *
+ * Shared by numeric, real, double, and geometry so the spelling stays one place.
+ */
+/**
+ * Spells a finite number as a canonical decimal literal.
+ *
+ * Negative zero becomes `0`.
+ *
+ * @param value - Finite number
+ * @param role - Type name used when the value is not finite
+ * @returns Decimal text
+ */
+export declare function decimalText(value: number, role: string): string;

package/dist/dialects/pg/geometry.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Built-in geometric columns. PostGIS stays in an extension package.
+ */
+import { type ColumnBuilder, type PlainFlags } from "./column.js";
+/** A point on a plane. */
+export type Point = {
+    readonly x: number;
+    readonly y: number;
+};
+/** An infinite line `ax + by + c = 0`. */
+export type Line = {
+    readonly a: number;
+    readonly b: number;
+    readonly c: number;
+};
+/**
+ * Point. Wire text is `(x,y)`.
+ *
+ * @returns A point column
+ */
+export declare function point(): ColumnBuilder<Point, PlainFlags>;
+/**
+ * Infinite line. Wire text is `{a,b,c}`.
+ *
+ * @returns A line column
+ */
+export declare function line(): ColumnBuilder<Line, PlainFlags>;
+/**
+ * Encodes a point.
+ *
+ * @param value - Coordinates
+ * @returns `(x,y)`
+ */
+export declare function encodePoint(value: Point): string;
+/**
+ * Decodes `(x,y)`.
+ *
+ * @param wire - Point text
+ * @returns Coordinates
+ */
+export declare function decodePoint(wire: string): Point;
+/**
+ * Encodes a line.
+ *
+ * @param value - Line coefficients
+ * @returns `{a,b,c}`
+ */
+export declare function encodeLine(value: Line): string;
+/**
+ * Decodes `{a,b,c}`.
+ *
+ * @param wire - Line text
+ * @returns Coefficients
+ */
+export declare function decodeLine(wire: string): Line;

package/dist/dialects/pg/index.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Public entry for `okmodel/pg`.
+ *
+ * Column types, codecs, picklists, `table()`, and `schema()`.
+ * Each builder is a separate export so a bundle can keep only the ones it calls.
+ */
+export { schema, type BuiltSchema, type SchemaCodecs, type SchemaInput, type SchemaRequires, } from "./schema.js";
+export { index, sql, table, type AnyTable, type ColumnHandle, type IndexCall, type SqlText, type SqlValue, type Table, type TableOptions, } from "./table.js";
+export { custom } from "./custom.js";
+export { ColumnBuilder } from "./column.js";
+export type { ArrayOf, ColumnFlags, ColumnInsert, ColumnInsertOf, ColumnRow, ColumnRowOf, ColumnUpdate, ColumnUpdateOf, FlagTrue, IdFlags, IdentityFlags, PlainFlags, ReferenceModifier, ReferenceOptions, SqlForm, ValidateModifier, WithGenerated, } from "./column.js";
+export { bigint, identity, integer, smallint, type BigintAs, type BigintValue } from "./integer.js";
+export { double, numeric, real, type NumericAs, type NumericValue } from "./decimal.js";
+export { boolean, bytea } from "./bool.js";
+export { json, jsonb, jsonReplacer } from "./json.js";
+export { id, uuid } from "./keys.js";
+export { char, citext, text, varchar } from "./text.js";
+export { date, interval, time, timestamp, timestamptz, timetz } from "./time.js";
+export { type TimeWithOffset } from "./temporal.js";
+export { daterange, int4range, int8range, numrange, tstzrange, type Range } from "./range.js";
+export { cidr, inet, macaddr, macaddr8 } from "./network.js";
+export { line, point, type Line, type Point } from "./geometry.js";
+export { ltree, tsvector } from "./search.js";
+export { domain, enumColumn as enum } from "./enum.js";
+export { t } from "./namespace.js";
+export { between } from "./ops/between.js";
+export { contains } from "./ops/contains.js";
+export { endsWith } from "./ops/endsWith.js";
+export { eq } from "./ops/eq.js";
+export { every } from "./ops/every.js";
+export { gt } from "./ops/gt.js";
+export { inc } from "./ops/inc.js";
+export { gte } from "./ops/gte.js";
+export { has } from "./ops/has.js";
+export { ilike } from "./ops/ilike.js";
+export { inList } from "./ops/inList.js";
+export { like } from "./ops/like.js";
+export { lt } from "./ops/lt.js";
+export { lte } from "./ops/lte.js";
+export { none } from "./ops/none.js";
+export { not } from "./ops/not.js";
+export { notIn } from "./ops/notIn.js";
+export { or } from "./ops/or.js";
+export { startsWith } from "./ops/startsWith.js";
+export { many, one, type ManyRelation, type OneRelation, type RelationCall } from "./relations.js";