kysely 0.14.1 → 0.15.0

package/dist/esm/query-builder/returning-interface.d.ts

@@ -21,7 +21,6 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -35,7 +34,6 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      * const { id, first_name } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -51,7 +49,6 @@ export interface ReturningInterface<DB, TB extends keyof DB, O> {
      * const { id, full_name, first_pet_id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })

package/dist/esm/query-builder/update-query-builder.d.ts

@@ -626,7 +626,6 @@ export declare class UpdateQueryBuilder<DB, TB extends keyof DB, O> implements W
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -640,7 +639,6 @@ export declare class UpdateQueryBuilder<DB, TB extends keyof DB, O> implements W
      * const { id, first_name } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -656,7 +654,6 @@ export declare class UpdateQueryBuilder<DB, TB extends keyof DB, O> implements W
      * const { id, full_name, first_pet_id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })

package/dist/esm/query-creator.d.ts

@@ -137,7 +137,6 @@ export declare class QueryCreator<DB> {
      * const result = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -152,7 +151,6 @@ export declare class QueryCreator<DB> {
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })

package/dist/esm/query-creator.js

@@ -43,7 +43,6 @@ export class QueryCreator {
      * const result = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })
@@ -58,7 +57,6 @@ export class QueryCreator {
      * const { id } = await db
      *   .insertInto('person')
      *   .values({
-     *     id: db.generated,
      *     first_name: 'Jennifer',
      *     last_name: 'Aniston'
      *   })

package/dist/esm/util/column-type.d.ts

@@ -0,0 +1,165 @@
+/**
+ * This type can be used to specify a different type for
+ * select, insert and update operations.
+ *
+ * Also see the {@link Generated} type.
+ *
+ * ### Examples
+ *
+ * The next example defines a number column that is optional
+ * in inserts and updates. All columns are always optional
+ * in updates so therefore we don't need to specify `undefined`
+ * for the update type. The type below is useful for all kinds of
+ * database generated columns like identifiers. The `Generated`
+ * type is actually just a shortcut for the type in this example:
+ *
+ * ```ts
+ * ColumnType<number, number | undefined, number>
+ * ```
+ *
+ * The above example makes the column optional in inserts
+ * and updates, but you can still choose to provide the
+ * column. If you want to prevent insertion/update you
+ * can se the type as `never`:
+ *
+ * ```ts
+ * ColumnType<number, never, never>
+ * ```
+ *
+ * Here's one more example where the type is different
+ * for each different operation:
+ *
+ * ```ts
+ * ColumnType<Date, string, never>
+ * ```
+ */
+export declare type ColumnType<SelectType, InsertType = SelectType, UpdateType = SelectType> = {
+    readonly __select__: SelectType;
+    readonly __insert__: InsertType;
+    readonly __update__: UpdateType;
+};
+/**
+ * A shortcut for defining database-generated columns. The type
+ * is the same for all selects, inserts and updates but the
+ * column is optional for inserts and updates.
+ *
+ * This is implemented using {@link ColumnType} like this:
+ *
+ * ```ts
+ * type Generated<S> = ColumnType<S, S | undefined, S>
+ * ```
+ */
+export declare type Generated<S> = ColumnType<S, S | undefined, S>;
+/**
+ * Evaluates to `K` if `T` can be `null` or `undefined`.
+ */
+declare type IfNullable<T, K> = undefined extends T ? K : null extends T ? K : never;
+/**
+ * Evaluates to `K` if `T` can't be `null` or `undefined`.
+ */
+declare type IfNotNullable<T, K> = undefined extends T ? never : null extends T ? never : T extends never ? never : K;
+/**
+ * Evaluates to `K` if `T` isn't `never`.
+ */
+declare type IfNotNever<T, K> = T extends never ? never : K;
+export declare type SelectType<T> = T extends ColumnType<infer S, any, any> ? S : T;
+export declare type InsertType<T> = T extends ColumnType<any, infer I, any> ? I : T;
+export declare type UpdateType<T> = T extends ColumnType<any, any, infer U> ? U : T;
+/**
+ * Keys of `R` whose `InsertType` values can be `null` or `undefined`.
+ */
+export declare type NullableInsertKeys<R> = {
+    [K in keyof R]: IfNullable<InsertType<R[K]>, K>;
+}[keyof R];
+/**
+ * Keys of `R` whose `InsertType` values can't be `null` or `undefined`.
+ */
+export declare type NonNullableInsertKeys<R> = {
+    [K in keyof R]: IfNotNullable<InsertType<R[K]>, K>;
+}[keyof R];
+/**
+ * Keys of `R` whose `SelectType` values are not `never`
+ */
+declare type NonNeverSelectKeys<R> = {
+    [K in keyof R]: IfNotNever<SelectType<R[K]>, K>;
+}[keyof R];
+/**
+ * Keys of `R` whose `UpdateType` values are not `never`
+ */
+export declare type UpdateKeys<R> = {
+    [K in keyof R]: IfNotNever<UpdateType<R[K]>, K>;
+}[keyof R];
+/**
+ * Given a table interface, extracts the select type from all
+ * {@link ColumnType} types.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * interface PersonTable {
+ *   id: Generated<number>
+ *   first_name: string
+ *   modified_at: ColumnType<Date, string, never>
+ * }
+ *
+ * type Person = Selectable<PersonTable>
+ * // {
+ * //   id: number,
+ * //   first_name: string
+ * //   modified_at: Date
+ * // }
+ * ```
+ */
+export declare type Selectable<R> = {
+    [K in NonNeverSelectKeys<R>]: SelectType<R[K]>;
+};
+/**
+ * Given a table interface, extracts the insert type from all
+ * {@link ColumnType} types.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * interface PersonTable {
+ *   id: Generated<number>
+ *   first_name: string
+ *   modified_at: ColumnType<Date, string, never>
+ * }
+ *
+ * type InsertablePerson = Insertable<PersonTable>
+ * // {
+ * //   id?: number,
+ * //   first_name: string
+ * //   modified_at: string
+ * // }
+ * ```
+ */
+export declare type Insertable<R> = {
+    [K in NonNullableInsertKeys<R>]: InsertType<R[K]>;
+} & {
+    [K in NullableInsertKeys<R>]?: InsertType<R[K]>;
+};
+/**
+ * Given a table interface, extracts the update type from all
+ * {@link ColumnType} types.
+ *
+ * ### Examples
+ *
+ * ```ts
+ * interface PersonTable {
+ *   id: Generated<number>
+ *   first_name: string
+ *   modified_at: ColumnType<Date, string, never>
+ * }
+ *
+ * type UpdateablePerson = Updateable<PersonTable>
+ * // {
+ * //   id?: number,
+ * //   first_name?: string
+ * // }
+ * ```
+ */
+export declare type Updateable<R> = {
+    [K in UpdateKeys<R>]?: UpdateType<R[K]>;
+};
+export {};

package/dist/esm/util/column-type.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/util/private-symbols.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @internal
+ * @private
+ */
+export declare const PRIVATE_ADAPTER: unique symbol;

package/dist/esm/util/private-symbols.js

@@ -0,0 +1,5 @@
+/**
+ * @internal
+ * @private
+ */
+export const PRIVATE_ADAPTER = Symbol();

package/dist/esm/util/type-utils.d.ts

@@ -8,42 +8,6 @@ import { UpdateResult } from '../query-builder/update-result.js';
  * Given an object type, extracts the union of all value types.
  */
 export declare type ValueType<T> = T[keyof T];
-/**
- * Given a database type and a union of table names returns the row type
- * that you would get by selecting all columns from tables TB.
- *
- * Example:
- *
- * ```ts
- * interface Person {
- *   id: number
- * }
- *
- * interface Pet {
- *   name: string
- *   species: 'cat' | 'dog'
- * }
- *
- * interface Movie {
- *   stars: number
- * }
- *
- * interface Database {
- *   person: Person
- *   pet: Pet
- *   movie: Movie
- * }
- *
- * type Row = RowType<Database, 'person' | 'movie'>
- *
- * // Row == Person & Movie
- * ```
- */
-export declare type RowType<DB, TB extends keyof DB> = {
-    [C in AnyColumn<DB, TB>]: {
-        [T in TB]: C extends keyof DB[T] ? DB[T][C] : never;
-    }[TB];
-};
 /**
  * Given a database type and a union of table names in that db, returns
  * a union type with all possible column names.
@@ -142,10 +106,6 @@ export declare type SelectQueryBuilderFactory<DB, TB extends keyof DB> = (qb: Ex
 export declare type AliasedQueryBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedQueryBuilder;
 export declare type RawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyRawBuilder;
 export declare type AliasedRawBuilderFactory<DB, TB extends keyof DB> = (qb: ExpressionBuilder<DB, TB>) => AnyAliasedRawBuilder;
-export interface GeneratedPlaceholder {
-    /** @internal */
-    readonly __isGeneratedPlaceholder__: true;
-}
 export declare type SingleResultType<O> = O extends InsertResult ? O : O extends DeleteResult ? O : O extends UpdateResult ? O : O | undefined;
 export declare type UnknownRow = Record<string, unknown>;
 export declare type Nullable<T> = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kysely",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "Type safe SQL query builder",
   "repository": {
     "type": "git",

package/dist/cjs/util/generated-placeholder.d.ts

@@ -1,3 +0,0 @@
-import { GeneratedPlaceholder } from './type-utils.js';
-export declare const GENERATED_PLACEHOLDER: GeneratedPlaceholder;
-export declare function isGeneratedPlaceholder(obj: unknown): obj is GeneratedPlaceholder;

package/dist/cjs/util/generated-placeholder.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isGeneratedPlaceholder = exports.GENERATED_PLACEHOLDER = void 0;
-const object_utils_js_1 = require("./object-utils.js");
-exports.GENERATED_PLACEHOLDER = (0, object_utils_js_1.freeze)({
-    __isGeneratedPlaceholder__: true,
-});
-function isGeneratedPlaceholder(obj) {
-    return (0, object_utils_js_1.isObject)(obj) && obj.__isGeneratedPlaceholder__ === true;
-}
-exports.isGeneratedPlaceholder = isGeneratedPlaceholder;

package/dist/esm/util/generated-placeholder.d.ts

@@ -1,3 +0,0 @@
-import { GeneratedPlaceholder } from './type-utils.js';
-export declare const GENERATED_PLACEHOLDER: GeneratedPlaceholder;
-export declare function isGeneratedPlaceholder(obj: unknown): obj is GeneratedPlaceholder;

package/dist/esm/util/generated-placeholder.js

@@ -1,7 +0,0 @@
-import { freeze, isObject } from './object-utils.js';
-export const GENERATED_PLACEHOLDER = freeze({
-    __isGeneratedPlaceholder__: true,
-});
-export function isGeneratedPlaceholder(obj) {
-    return isObject(obj) && obj.__isGeneratedPlaceholder__ === true;
-}