@prisma/studio-core 0.2.0 → 0.2.1

package/dist/{adapter-CKFCHq71.d.cts → query-Q-ZKX_Vr.d.cts}

@@ -1,3 +1,5 @@
+import { WhereInterface, DialectAdapter, QueryCompiler } from 'kysely';
+
 type Either<E, R> = [E] | [null, R];
 type NumericString = `${number}`;
 type BigIntString = `${bigint}`;
@@ -14,23 +16,23 @@ interface Adapter {
      *
      * @param options - Options for the introspection request.
      */
-    introspect(options: AdapterIntrospectOptions): Promise<Either<Error, Introspection>>;
+    introspect(options: AdapterIntrospectOptions): Promise<Either<AdapterError, AdapterIntrospectResult>>;
     /**
      * Executes a structured query against the database.
      */
-    query(details: AdapterQueryDetails, options: AdapterQueryOptions): Promise<Either<Error, AdapterQueryResult>>;
+    query(details: AdapterQueryDetails, options: AdapterQueryOptions): Promise<Either<AdapterError, AdapterQueryResult>>;
     /**
      * Inserts a single row into the database.
      */
-    insert(details: AdapterInsertDetails, options: AdapterInsertOptions): Promise<Either<Error, AdapterInsertResult>>;
+    insert(details: AdapterInsertDetails, options: AdapterInsertOptions): Promise<Either<AdapterError, AdapterInsertResult>>;
     /**
      * Updates a given row in the database with given changes.
      */
-    update(details: AdapterUpdateDetails, options: AdapterUpdateOptions): Promise<Either<Error, AdapterUpdateResult>>;
+    update(details: AdapterUpdateDetails, options: AdapterUpdateOptions): Promise<Either<AdapterError, AdapterUpdateResult>>;
     /**
      * Deletes given rows from the database.
      */
-    delete(details: AdapterDeleteDetails, options: AdapterDeleteOptions): Promise<Either<Error, AdapterDeleteResult>>;
+    delete(details: AdapterDeleteDetails, options: AdapterDeleteOptions): Promise<Either<AdapterError, AdapterDeleteResult>>;
 }
 interface AdapterBaseOptions {
 }
@@ -46,12 +48,15 @@ interface AdapterUpdateOptions extends AdapterBaseOptions {
 interface AdapterDeleteOptions extends AdapterBaseOptions {
 }
 type SchemaName = string;
-interface Introspection {
+interface AdapterIntrospectResult {
     schemas: Record<SchemaName, Schema>;
     timezone: string;
+    filterOperators: FilterOperator[];
+    query: Query;
 }
 type TableName = string;
 interface Schema {
+    name: string;
     tables: Record<TableName, Table>;
 }
 type ColumnName = string;
@@ -68,6 +73,9 @@ interface Column {
     nullable: boolean;
     schema: SchemaName;
     table: TableName;
+    fkSchema: SchemaName | null;
+    fkColumn: ColumnName | null;
+    fkTable: TableName | null;
 }
 interface DataType {
     /**
@@ -117,6 +125,25 @@ interface AdapterQueryDetails {
      * The table to select from.
      */
     table: Table;
+    /**
+     * The filter to be applied.
+     */
+    filter?: FilterGroup;
+}
+type FilterOperator = "=" | "!=" | ">" | ">=" | "<" | "<=" | "is" | "is not" | "like" | "not like" | "ilike" | "not ilike";
+interface ColumnFilter {
+    kind: "ColumnFilter";
+    column: string;
+    operator: FilterOperator;
+    value: unknown;
+    after: "and" | "or";
+    id: string;
+}
+interface FilterGroup {
+    kind: "FilterGroup";
+    filters: (ColumnFilter | FilterGroup)[];
+    after: "and" | "or";
+    id: string;
 }
 interface SortOrderItem {
     /**
@@ -129,6 +156,9 @@ interface SortOrderItem {
     direction: SortDirection;
 }
 type SortDirection = "asc" | "desc";
+declare class AdapterError extends Error {
+    query?: Query;
+}
 interface AdapterQueryResult {
     /**
      * The total number of rows the query would return if not limited.
@@ -140,6 +170,10 @@ interface AdapterQueryResult {
      * The rows returned by the query.
      */
     rows: Record<ColumnName, unknown>[];
+    /**
+     * The executed query string.
+     */
+    query: Query;
 }
 interface AdapterInsertDetails {
     /**
@@ -158,6 +192,10 @@ interface AdapterInsertResult {
      * The freshly inserted row data.
      */
     rows: Record<string, unknown>[];
+    /**
+     * The executed query string.
+     */
+    query: Query;
 }
 interface AdapterUpdateDetails {
     /**
@@ -183,6 +221,10 @@ interface AdapterUpdateResult {
          */
         __ps_updated_at__: string | number | Date;
     };
+    /**
+     * The executed query string.
+     */
+    query: Query;
 }
 interface AdapterDeleteDetails {
     /**
@@ -196,6 +238,51 @@ interface AdapterDeleteDetails {
 }
 interface AdapterDeleteResult {
     rows: Record<ColumnName, unknown>[];
+    /**
+     * The executed query string.
+     */
+    query: Query;
+}
+declare function createAdapterError(args: {
+    error: Error;
+    query?: Query;
+}): [AdapterError];
+
+interface BuilderRequirements {
+    Adapter: {
+        new (): DialectAdapter;
+    };
+    noParameters?: boolean;
+    QueryCompiler: {
+        new (): QueryCompiler;
+    };
+}
+declare const queryType: unique symbol;
+interface Query<T = unknown> {
+    [queryType]?: T;
+    parameters: readonly unknown[];
+    sql: string;
 }
+type QueryResult<T> = T extends Query<infer R> ? R[] : T extends (...args: any[]) => Query<infer R> ? R[] : never;
+/**
+ * Applies a filter to the given rows based on the primary key columns of the table.
+ *
+ * @example db.selectFrom("users").$call(applyInferredRowFilters(rows, columns)).selectAll()
+ */
+declare function applyInferredRowFilters(rows: Record<string, unknown>[], columns: Table["columns"]): <QB extends WhereInterface<any, any>>(qb: QB) => QB;
+/**
+ * Part of a filter that predicts a match.
+ * ie. ... WHERE $ColumName = $Value ...
+ */
+type RowFilterPredicate = [ColumnName: string, Value: unknown];
+/**
+ * A row filter is comprised of one or more predicates.
+ */
+type RowFilter = RowFilterPredicate[];
+/**
+ * Infers the filter that is necessary to uniquely identify a given row
+ * individually.
+ */
+declare function inferRowFilter(row: Record<string, unknown>, columns: Table["columns"]): RowFilter;
 
-export type { Adapter as A, BigIntString as B, Column as C, DataType as D, Either as E, Introspection as I, NumericString as N, Schema as S, Table as T, AdapterInsertDetails as a, AdapterQueryDetails as b, AdapterUpdateDetails as c, AdapterDeleteDetails as d, AdapterBaseOptions as e, AdapterIntrospectOptions as f, AdapterQueryOptions as g, AdapterInsertOptions as h, AdapterUpdateOptions as i, AdapterDeleteOptions as j, DataTypeGroup as k, SortOrderItem as l, SortDirection as m, AdapterQueryResult as n, AdapterInsertResult as o, AdapterUpdateResult as p, AdapterDeleteResult as q };
+export { type Adapter as A, type BuilderRequirements as B, type Column as C, type DataType as D, type Either as E, type FilterOperator as F, type NumericString as N, type Query as Q, type Schema as S, type Table as T, type QueryResult as a, AdapterError as b, type AdapterInsertDetails as c, type AdapterQueryDetails as d, type AdapterUpdateDetails as e, type AdapterDeleteDetails as f, applyInferredRowFilters as g, type AdapterBaseOptions as h, inferRowFilter as i, type AdapterIntrospectOptions as j, type AdapterQueryOptions as k, type AdapterInsertOptions as l, type AdapterUpdateOptions as m, type AdapterDeleteOptions as n, type AdapterIntrospectResult as o, type DataTypeGroup as p, type ColumnFilter as q, type FilterGroup as r, type SortOrderItem as s, type SortDirection as t, type AdapterQueryResult as u, type AdapterInsertResult as v, type AdapterUpdateResult as w, type AdapterDeleteResult as x, createAdapterError as y, type BigIntString as z };

package/dist/{adapter-CKFCHq71.d.ts → query-Q-ZKX_Vr.d.ts}

@@ -1,3 +1,5 @@
+import { WhereInterface, DialectAdapter, QueryCompiler } from 'kysely';
+
 type Either<E, R> = [E] | [null, R];
 type NumericString = `${number}`;
 type BigIntString = `${bigint}`;
@@ -14,23 +16,23 @@ interface Adapter {
      *
      * @param options - Options for the introspection request.
      */
-    introspect(options: AdapterIntrospectOptions): Promise<Either<Error, Introspection>>;
+    introspect(options: AdapterIntrospectOptions): Promise<Either<AdapterError, AdapterIntrospectResult>>;
     /**
      * Executes a structured query against the database.
      */
-    query(details: AdapterQueryDetails, options: AdapterQueryOptions): Promise<Either<Error, AdapterQueryResult>>;
+    query(details: AdapterQueryDetails, options: AdapterQueryOptions): Promise<Either<AdapterError, AdapterQueryResult>>;
     /**
      * Inserts a single row into the database.
      */
-    insert(details: AdapterInsertDetails, options: AdapterInsertOptions): Promise<Either<Error, AdapterInsertResult>>;
+    insert(details: AdapterInsertDetails, options: AdapterInsertOptions): Promise<Either<AdapterError, AdapterInsertResult>>;
     /**
      * Updates a given row in the database with given changes.
      */
-    update(details: AdapterUpdateDetails, options: AdapterUpdateOptions): Promise<Either<Error, AdapterUpdateResult>>;
+    update(details: AdapterUpdateDetails, options: AdapterUpdateOptions): Promise<Either<AdapterError, AdapterUpdateResult>>;
     /**
      * Deletes given rows from the database.
      */
-    delete(details: AdapterDeleteDetails, options: AdapterDeleteOptions): Promise<Either<Error, AdapterDeleteResult>>;
+    delete(details: AdapterDeleteDetails, options: AdapterDeleteOptions): Promise<Either<AdapterError, AdapterDeleteResult>>;
 }
 interface AdapterBaseOptions {
 }
@@ -46,12 +48,15 @@ interface AdapterUpdateOptions extends AdapterBaseOptions {
 interface AdapterDeleteOptions extends AdapterBaseOptions {
 }
 type SchemaName = string;
-interface Introspection {
+interface AdapterIntrospectResult {
     schemas: Record<SchemaName, Schema>;
     timezone: string;
+    filterOperators: FilterOperator[];
+    query: Query;
 }
 type TableName = string;
 interface Schema {
+    name: string;
     tables: Record<TableName, Table>;
 }
 type ColumnName = string;
@@ -68,6 +73,9 @@ interface Column {
     nullable: boolean;
     schema: SchemaName;
     table: TableName;
+    fkSchema: SchemaName | null;
+    fkColumn: ColumnName | null;
+    fkTable: TableName | null;
 }
 interface DataType {
     /**
@@ -117,6 +125,25 @@ interface AdapterQueryDetails {
      * The table to select from.
      */
     table: Table;
+    /**
+     * The filter to be applied.
+     */
+    filter?: FilterGroup;
+}
+type FilterOperator = "=" | "!=" | ">" | ">=" | "<" | "<=" | "is" | "is not" | "like" | "not like" | "ilike" | "not ilike";
+interface ColumnFilter {
+    kind: "ColumnFilter";
+    column: string;
+    operator: FilterOperator;
+    value: unknown;
+    after: "and" | "or";
+    id: string;
+}
+interface FilterGroup {
+    kind: "FilterGroup";
+    filters: (ColumnFilter | FilterGroup)[];
+    after: "and" | "or";
+    id: string;
 }
 interface SortOrderItem {
     /**
@@ -129,6 +156,9 @@ interface SortOrderItem {
     direction: SortDirection;
 }
 type SortDirection = "asc" | "desc";
+declare class AdapterError extends Error {
+    query?: Query;
+}
 interface AdapterQueryResult {
     /**
      * The total number of rows the query would return if not limited.
@@ -140,6 +170,10 @@ interface AdapterQueryResult {
      * The rows returned by the query.
      */
     rows: Record<ColumnName, unknown>[];
+    /**
+     * The executed query string.
+     */
+    query: Query;
 }
 interface AdapterInsertDetails {
     /**
@@ -158,6 +192,10 @@ interface AdapterInsertResult {
      * The freshly inserted row data.
      */
     rows: Record<string, unknown>[];
+    /**
+     * The executed query string.
+     */
+    query: Query;
 }
 interface AdapterUpdateDetails {
     /**
@@ -183,6 +221,10 @@ interface AdapterUpdateResult {
          */
         __ps_updated_at__: string | number | Date;
     };
+    /**
+     * The executed query string.
+     */
+    query: Query;
 }
 interface AdapterDeleteDetails {
     /**
@@ -196,6 +238,51 @@ interface AdapterDeleteDetails {
 }
 interface AdapterDeleteResult {
     rows: Record<ColumnName, unknown>[];
+    /**
+     * The executed query string.
+     */
+    query: Query;
+}
+declare function createAdapterError(args: {
+    error: Error;
+    query?: Query;
+}): [AdapterError];
+
+interface BuilderRequirements {
+    Adapter: {
+        new (): DialectAdapter;
+    };
+    noParameters?: boolean;
+    QueryCompiler: {
+        new (): QueryCompiler;
+    };
+}
+declare const queryType: unique symbol;
+interface Query<T = unknown> {
+    [queryType]?: T;
+    parameters: readonly unknown[];
+    sql: string;
 }
+type QueryResult<T> = T extends Query<infer R> ? R[] : T extends (...args: any[]) => Query<infer R> ? R[] : never;
+/**
+ * Applies a filter to the given rows based on the primary key columns of the table.
+ *
+ * @example db.selectFrom("users").$call(applyInferredRowFilters(rows, columns)).selectAll()
+ */
+declare function applyInferredRowFilters(rows: Record<string, unknown>[], columns: Table["columns"]): <QB extends WhereInterface<any, any>>(qb: QB) => QB;
+/**
+ * Part of a filter that predicts a match.
+ * ie. ... WHERE $ColumName = $Value ...
+ */
+type RowFilterPredicate = [ColumnName: string, Value: unknown];
+/**
+ * A row filter is comprised of one or more predicates.
+ */
+type RowFilter = RowFilterPredicate[];
+/**
+ * Infers the filter that is necessary to uniquely identify a given row
+ * individually.
+ */
+declare function inferRowFilter(row: Record<string, unknown>, columns: Table["columns"]): RowFilter;
 
-export type { Adapter as A, BigIntString as B, Column as C, DataType as D, Either as E, Introspection as I, NumericString as N, Schema as S, Table as T, AdapterInsertDetails as a, AdapterQueryDetails as b, AdapterUpdateDetails as c, AdapterDeleteDetails as d, AdapterBaseOptions as e, AdapterIntrospectOptions as f, AdapterQueryOptions as g, AdapterInsertOptions as h, AdapterUpdateOptions as i, AdapterDeleteOptions as j, DataTypeGroup as k, SortOrderItem as l, SortDirection as m, AdapterQueryResult as n, AdapterInsertResult as o, AdapterUpdateResult as p, AdapterDeleteResult as q };
+export { type Adapter as A, type BuilderRequirements as B, type Column as C, type DataType as D, type Either as E, type FilterOperator as F, type NumericString as N, type Query as Q, type Schema as S, type Table as T, type QueryResult as a, AdapterError as b, type AdapterInsertDetails as c, type AdapterQueryDetails as d, type AdapterUpdateDetails as e, type AdapterDeleteDetails as f, applyInferredRowFilters as g, type AdapterBaseOptions as h, inferRowFilter as i, type AdapterIntrospectOptions as j, type AdapterQueryOptions as k, type AdapterInsertOptions as l, type AdapterUpdateOptions as m, type AdapterDeleteOptions as n, type AdapterIntrospectResult as o, type DataTypeGroup as p, type ColumnFilter as q, type FilterGroup as r, type SortOrderItem as s, type SortDirection as t, type AdapterQueryResult as u, type AdapterInsertResult as v, type AdapterUpdateResult as w, type AdapterDeleteResult as x, createAdapterError as y, type BigIntString as z };