@singlestore/client - npm Package Compare versions

Comparing version 0.0.30 to 0.0.31

dist/index.d.ts

@@ -177,3 +177,3 @@ import { AnyAI, CreateChatCompletionResult } from '@singlestore/ai';
 
-type SelectClause<TColumn> = (keyof TColumn | (string & {}))[];
+type SelectClause<TTableName extends string, TTableType extends TableType, TDatabaseType extends DatabaseType, _TTableColumns = TTableType["columns"]> = ((string & {}) | keyof _TTableColumns)[];
 type WhereOperator<TColumnValue> = TColumnValue extends string ? {
@@ -195,35 +195,38 @@ eq?: TColumnValue;
 } : never;
-type WhereClause<TColumn> = {
-    [K in keyof TColumn]?: WhereOperator<TColumn[K]> | TColumn[K];
+type WhereClause<TTableName extends string, TTableType extends TableType, TDatabaseType extends DatabaseType, _TTableColumns = TTableType["columns"]> = {
+    [K in keyof _TTableColumns]?: WhereOperator<_TTableColumns[K]> | _TTableColumns[K];
 } & {
-    OR?: WhereClause<TColumn>[];
-    NOT?: WhereClause<TColumn>;
+    OR?: WhereClause<TTableName, TTableType, TDatabaseType>[];
+    NOT?: WhereClause<TTableName, TTableType, TDatabaseType>;
 };
-type GroupByClause<TColumn> = (keyof TColumn)[];
+type GroupByClause<TTableName extends string, TTableType extends TableType, TDatabaseType extends DatabaseType, _TTableColumns = TTableType["columns"]> = ((string & {}) | keyof _TTableColumns)[];
 type OrderByDirection = "asc" | "desc";
-type OrderByClause<TColumn> = {
-    [K in keyof TColumn]?: OrderByDirection;
+type OrderByClause<TTableName extends string, TTableType extends TableType, TDatabaseType extends DatabaseType, _TTableColumns = TTableType["columns"]> = {
+    [K in string & {}]: OrderByDirection;
+} & {
+    [K in keyof _TTableColumns]?: OrderByDirection;
 };
-interface QueryBuilderParams<TTableType extends TableType, TDatabaseType extends DatabaseType = DatabaseType> {
-    select?: SelectClause<TTableType["columns"]>;
-    where?: WhereClause<TTableType["columns"]>;
-    groupBy?: GroupByClause<TTableType["columns"]>;
-    orderBy?: OrderByClause<TTableType["columns"]>;
+interface QueryBuilderParams<TTableName extends string, TTableType extends TableType, TDatabaseType extends DatabaseType> {
+    select?: SelectClause<TTableName, TTableType, TDatabaseType>;
+    where?: WhereClause<TTableName, TTableType, TDatabaseType>;
+    groupBy?: GroupByClause<TTableName, TTableType, TDatabaseType>;
+    orderBy?: OrderByClause<TTableName, TTableType, TDatabaseType>;
     limit?: number;
     offset?: number;
 }
-type ExtractQuerySelectedColumn<TColumn, TParams extends QueryBuilderParams<any, any> | undefined> = TParams extends QueryBuilderParams<any, any> ? TParams["select"] extends (keyof TColumn)[] ? Pick<TColumn, TParams["select"][number]> : TColumn : TColumn;
-declare class QueryBuilder<TTableType extends TableType, TDatabaseType extends DatabaseType = DatabaseType> {
+type AnyQueryBuilderParams = QueryBuilderParams<any, any, any>;
+type ExtractQuerySelectedColumn<TTableName extends string, TDatabaseType extends DatabaseType, TParams extends AnyQueryBuilderParams | undefined, _Table extends TDatabaseType["tables"][TTableName] = TDatabaseType["tables"][TTableName]> = TParams extends AnyQueryBuilderParams ? TParams["select"] extends (keyof _Table["columns"])[] ? Pick<_Table["columns"], TParams["select"][number]> : _Table["columns"] : _Table["columns"];
+declare class QueryBuilder<TName extends string, TTableType extends TableType, TDatabaseType extends DatabaseType> {
     private _databaseName;
     private _tableName;
-    constructor(_databaseName: string, _tableName: string);
-    buildSelectClause(select?: SelectClause<any>): string;
+    constructor(_databaseName: string, _tableName: TName);
+    buildSelectClause(select?: SelectClause<any, any, any>): string;
     buildFromClause(): string;
     buildWhereCondition(column: string, operator: string, value: any): string;
-    buildWhereClause(conditions?: WhereClause<any>): string;
-    buildGroupByClause(columns?: GroupByClause<any>): string;
-    buildOrderByClause(clauses?: OrderByClause<any>): string;
+    buildWhereClause(conditions?: WhereClause<any, any, any>): string;
+    buildGroupByClause(columns?: GroupByClause<any, any, any>): string;
+    buildOrderByClause(clauses?: OrderByClause<any, any, any>): string;
     buildLimitClause(limit?: number): string;
     buildOffsetClause(offset?: number): string;
-    buildClauses(params?: QueryBuilderParams<TTableType, TDatabaseType>): {
+    buildClauses<TParams extends QueryBuilderParams<TName, TTableType, TDatabaseType>>(params?: TParams): {
         select: string;
@@ -237,3 +240,3 @@ from: string;
     };
-    buildQuery(params?: QueryBuilderParams<TTableType, TDatabaseType>): string;
+    buildQuery<TParams extends QueryBuilderParams<TName, TTableType, TDatabaseType>>(params?: TParams): string;
 }
@@ -252,5 +255,6 @@
  *
+ * @typeParam TName - A type extending `string` that defines the name of the table.
  * @typeParam TType - A type extending `TableType` that defines the structure of the table.
  *
- * @property {string} name - The name of the table.
+ * @property {TName} name - The name of the table.
  * @property {Object} columns - An object where each key is a column name and each value is the schema of that column, excluding the name.
@@ -261,4 +265,4 @@ * @property {string[]} [primaryKeys] - An optional array of column names that form the primary key.
  */
-interface TableSchema<TType extends TableType> {
-    name: string;
+interface TableSchema<TName extends string, TType extends TableType> {
+    name: TName;
     columns: {
@@ -319,10 +323,10 @@ [K in keyof TType["columns"]]: Omit<ColumnSchema, "name">;
  */
-declare class Table<TType extends TableType = TableType, TDatabaseType extends DatabaseType = DatabaseType, TAi extends AnyAI | undefined = undefined> {
+declare class Table<TName extends string = string, TType extends TableType = TableType, TDatabaseType extends DatabaseType = DatabaseType, TAi extends AnyAI | undefined = undefined> {
     private _connection;
     databaseName: string;
-    name: string;
+    name: TName;
     private _ai?;
     private _path;
     vScoreKey: VectorScoreKey;
-    constructor(_connection: Connection, databaseName: string, name: string, _ai?: TAi | undefined);
+    constructor(_connection: Connection, databaseName: string, name: TName, _ai?: TAi | undefined);
     private get ai();
@@ -348,6 +352,7 @@ /**
      */
-    static schemaToClauses(schema: TableSchema<any>): string;
+    static schemaToClauses(schema: TableSchema<any, any>): string;
     /**
      * Creates a new table in the database with the specified schema.
      *
+     * @typeParam TName - The name of the table, which extends `string`.
      * @typeParam TType - The type of the table, which extends `TableType`.
@@ -362,5 +367,5 @@ * @typeParam TDatabaseType - The type of the database, which extends `DatabaseType`.
      *
-     * @returns {Promise<Table<TDatabaseType, TType, TAi>>} A promise that resolves to the created `Table` instance.
+     * @returns {Promise<Table<TName, TType, TDatabaseType, TAi>>} A promise that resolves to the created `Table` instance.
      */
-    static create<TType extends TableType = TableType, TDatabaseType extends DatabaseType = DatabaseType, TAi extends AnyAI | undefined = undefined>(connection: Connection, databaseName: string, schema: TableSchema<TType>, ai?: TAi): Promise<Table<TType, TDatabaseType, TAi>>;
+    static create<TName extends string = string, TType extends TableType = TableType, TDatabaseType extends DatabaseType = DatabaseType, TAi extends AnyAI | undefined = undefined>(connection: Connection, databaseName: string, schema: TableSchema<TName, TType>, ai?: TAi): Promise<Table<TName, TType, TDatabaseType, TAi>>;
     /**
@@ -451,5 +456,5 @@ * Drops an existing table from the database by name.
      *
-     * @returns {Promise<(ExtractQuerySelectedColumn<TType["columns"], TParams> & RowDataPacket)[]>} A promise that resolves to an array of selected rows.
+     * @returns {Promise<(ExtractQuerySelectedColumn<TName, TDatabaseType, TParams> & RowDataPacket)[]>} A promise that resolves to an array of selected rows.
      */
-    find<TParams extends QueryBuilderParams<TType, TDatabaseType> | undefined>(params?: TParams): Promise<(ExtractQuerySelectedColumn<TType["columns"], TParams> & RowDataPacket)[]>;
+    find<TParams extends QueryBuilderParams<TName, TType, TDatabaseType>>(params?: TParams): Promise<(ExtractQuerySelectedColumn<TName, TDatabaseType, TParams> & RowDataPacket)[]>;
     /**
@@ -459,15 +464,15 @@ * Updates rows in the table based on the specified values and filters.
      * @param {Partial<TType["columns"]>} values - The values to update in the table.
-     * @param {WhereClause<TType["columns"]>} where - The where clause to apply to the update query.
+     * @param {WhereClause<TName, TDatabaseType>} where - The where clause to apply to the update query.
      *
      * @returns {Promise<[ResultSetHeader, FieldPacket[]]>} A promise that resolves when the update is complete.
      */
-    update(values: Partial<TType["columns"]>, where: WhereClause<TType["columns"]>): Promise<[ResultSetHeader, FieldPacket[]]>;
+    update(values: Partial<TType["columns"]>, where: WhereClause<TName, TType, TDatabaseType>): Promise<[ResultSetHeader, FieldPacket[]]>;
     /**
      * Deletes rows from the table based on the specified filters. If no filters are provided, the table is truncated.
      *
-     * @param {WhereClause<TType["columns"]>} [where] - The where clause to apply to the delete query.
+     * @param {WhereClause<TName, TDatabaseType>} [where] - The where clause to apply to the delete query.
      *
      * @returns {Promise<[ResultSetHeader, FieldPacket[]]>} A promise that resolves when the delete operation is complete.
      */
-    delete(where?: WhereClause<TType["columns"]>): Promise<[ResultSetHeader, FieldPacket[]]>;
+    delete(where?: WhereClause<TName, TType, TDatabaseType>): Promise<[ResultSetHeader, FieldPacket[]]>;
     /**
@@ -492,3 +497,3 @@ * Performs a vector search on the table using a prompt and a specified vector column.
      *
-     * @returns {Promise<(ExtractQuerySelectedColumn<TType["columns"], TQueryParams> & { [K in VectorScoreKey]: number } & RowDataPacket)[]>}
+     * @returns {Promise<(ExtractQuerySelectedColumn<TName, TDatabaseType, TQueryParams> & { v_score: number } & RowDataPacket)[]>}
      * A promise that resolves to an array of rows matching the vector search criteria, each row including
@@ -501,4 +506,4 @@ * the selected columns and a vector similarity score.
         embeddingParams?: TAi extends AnyAI ? Parameters<TAi["embeddings"]["create"]>[1] : never;
-    }, TQueryParams extends QueryBuilderParams<TType, TDatabaseType>>(params: TParams, queryParams?: TQueryParams): Promise<(ExtractQuerySelectedColumn<TType["columns"], TQueryParams> & {
-        [K in VectorScoreKey]: number;
+    }, TQueryParams extends QueryBuilderParams<TName, TType, TDatabaseType>>(params: TParams, queryParams?: TQueryParams): Promise<(ExtractQuerySelectedColumn<TName, TDatabaseType, TQueryParams> & {
+        v_score: number;
     } & RowDataPacket)[]>;
@@ -533,3 +538,3 @@ /**
         template?: string;
-    }, TQueryParams extends QueryBuilderParams<TType, TDatabaseType>>(params: TParams, queryParams?: TQueryParams): Promise<CreateChatCompletionResult<TParams["stream"]>>;
+    }, TQueryParams extends QueryBuilderParams<TName, TType, TDatabaseType>>(params: TParams, queryParams?: TQueryParams): Promise<CreateChatCompletionResult<TParams["stream"]>>;
 }
@@ -556,3 +561,3 @@
     tables?: {
-        [K in keyof TType["tables"]]: Omit<TableSchema<TType["tables"][K]>, "name">;
+        [K in keyof TType["tables"]]: Omit<TableSchema<any, TType["tables"][K]>, "name">;
     };
@@ -736,5 +741,5 @@ }
      *
-     * @returns {Table<TType extends TableType ? TType : TDatabaseType["tables"][TName] extends TableType ? TDatabaseType["tables"][TName] : TableType, TDatabaseType, TAi>} A `Table` instance representing the specified table.
+     * @returns {Table<TName, TType extends TableType ? TType : TDatabaseType["tables"][TName] extends TableType ? TDatabaseType["tables"][TName] : TableType, TDatabaseType, TAi>} A `Table` instance representing the specified table.
      */
-    table<TType, TName extends DatabaseTableName<TDatabaseType> | (string & {}) = DatabaseTableName<TDatabaseType> | (string & {})>(name: TName): Table<TType extends TableType ? TType : TDatabaseType["tables"][TName] extends TableType ? TDatabaseType["tables"][TName] : TableType, TDatabaseType, TAi>;
+    table<TType, TName extends DatabaseTableName<TDatabaseType> | (string & {}) = DatabaseTableName<TDatabaseType> | (string & {})>(name: TName): Table<TName, TType extends TableType ? TType : TDatabaseType["tables"][TName] extends TableType ? TDatabaseType["tables"][TName] : TableType, TDatabaseType, TAi>;
     /**
@@ -759,3 +764,3 @@ * Retrieves information about all tables in the database, optionally including extended details.
      */
-    createTable<TType extends TableType = TableType>(schema: TableSchema<TType>): Promise<Table<TType, TDatabaseType, TAi>>;
+    createTable<TName extends string = string, TType extends TableType = TableType>(schema: TableSchema<TName, TType>): Promise<Table<TName, TType, TDatabaseType, TAi>>;
     /**
@@ -936,2 +941,2 @@ * Drops a specific table from the database.
 
-export { type AnyDatabase, Column, type ColumnInfo, type ColumnSchema, type ColumnType, type ConnectWorkspaceConfig, Connection, type ConnectionConfig, Database, type DatabaseInfo, type DatabaseInfoExtended, type DatabaseSchema, type DatabaseTableName, type DatabaseTablesToRecords, type DatabaseType, type ExtractQuerySelectedColumn, type GroupByClause, type InferDatabaseType, type OrderByClause, type OrderByDirection, QueryBuilder, type QueryBuilderParams, type SelectClause, SingleStoreClient, type SingleStoreClientConfig, Table, type TableColumnName, type TableInfo, type TableInfoExtended, type TableSchema, type TableType, type WhereClause, type WhereOperator, Workspace, type WorkspaceConfig, type WorkspaceDatabaseName, type WorkspaceSchema, type WorkspaceType };
+export { type AnyDatabase, type AnyQueryBuilderParams, Column, type ColumnInfo, type ColumnSchema, type ColumnType, type ConnectWorkspaceConfig, Connection, type ConnectionConfig, Database, type DatabaseInfo, type DatabaseInfoExtended, type DatabaseSchema, type DatabaseTableName, type DatabaseTablesToRecords, type DatabaseType, type ExtractQuerySelectedColumn, type GroupByClause, type InferDatabaseType, type OrderByClause, type OrderByDirection, QueryBuilder, type QueryBuilderParams, type SelectClause, SingleStoreClient, type SingleStoreClientConfig, Table, type TableColumnName, type TableInfo, type TableInfoExtended, type TableSchema, type TableType, type WhereClause, type WhereOperator, Workspace, type WorkspaceConfig, type WorkspaceDatabaseName, type WorkspaceSchema, type WorkspaceType };

dist/index.js

@@ -23,2 +23,3 @@ "use strict";
 __export(src_exports, {
+  QueryBuilder: () => QueryBuilder,
   SingleStoreClient: () => SingleStoreClient,
@@ -276,3 +277,3 @@ escape: () => import_mysql22.escape
   buildQuery(params) {
-    return Object.values(this.buildClauses(params)).join(" ");
+    return Object.values(this.buildClauses(params)).join(" ").trim();
   }
@@ -339,2 +340,3 @@ };
    *
+   * @typeParam TName - The name of the table, which extends `string`.
    * @typeParam TType - The type of the table, which extends `TableType`.
@@ -349,3 +351,3 @@ * @typeParam TDatabaseType - The type of the database, which extends `DatabaseType`.
    *
-   * @returns {Promise<Table<TDatabaseType, TType, TAi>>} A promise that resolves to the created `Table` instance.
+   * @returns {Promise<Table<TName, TType, TDatabaseType, TAi>>} A promise that resolves to the created `Table` instance.
    */
@@ -482,3 +484,3 @@ static async create(connection, databaseName, schema, ai) {
    *
-   * @returns {Promise<(ExtractQuerySelectedColumn<TType["columns"], TParams> & RowDataPacket)[]>} A promise that resolves to an array of selected rows.
+   * @returns {Promise<(ExtractQuerySelectedColumn<TName, TDatabaseType, TParams> & RowDataPacket)[]>} A promise that resolves to an array of selected rows.
    */
@@ -495,3 +497,3 @@ async find(params) {
    * @param {Partial<TType["columns"]>} values - The values to update in the table.
-   * @param {WhereClause<TType["columns"]>} where - The where clause to apply to the update query.
+   * @param {WhereClause<TName, TDatabaseType>} where - The where clause to apply to the update query.
    *
@@ -509,3 +511,3 @@ * @returns {Promise<[ResultSetHeader, FieldPacket[]]>} A promise that resolves when the update is complete.
    *
-   * @param {WhereClause<TType["columns"]>} [where] - The where clause to apply to the delete query.
+   * @param {WhereClause<TName, TDatabaseType>} [where] - The where clause to apply to the delete query.
    *
@@ -539,3 +541,3 @@ * @returns {Promise<[ResultSetHeader, FieldPacket[]]>} A promise that resolves when the delete operation is complete.
    *
-   * @returns {Promise<(ExtractQuerySelectedColumn<TType["columns"], TQueryParams> & { [K in VectorScoreKey]: number } & RowDataPacket)[]>}
+   * @returns {Promise<(ExtractQuerySelectedColumn<TName, TDatabaseType, TQueryParams> & { v_score: number } & RowDataPacket)[]>}
    * A promise that resolves to an array of rows matching the vector search criteria, each row including
@@ -725,3 +727,3 @@ * the selected columns and a vector similarity score.
    *
-   * @returns {Table<TType extends TableType ? TType : TDatabaseType["tables"][TName] extends TableType ? TDatabaseType["tables"][TName] : TableType, TDatabaseType, TAi>} A `Table` instance representing the specified table.
+   * @returns {Table<TName, TType extends TableType ? TType : TDatabaseType["tables"][TName] extends TableType ? TDatabaseType["tables"][TName] : TableType, TDatabaseType, TAi>} A `Table` instance representing the specified table.
    */
@@ -888,2 +890,3 @@ table(name) {
 0 && (module.exports = {
+  QueryBuilder,
   SingleStoreClient,
@@ -890,0 +893,0 @@ escape

package.json

 {
   "name": "@singlestore/client",
-  "version": "0.0.30",
+  "version": "0.0.31",
   "license": "Apache-2.0",
@@ -5,0 +5,0 @@ "sideEffects": false,

No alert changes

Improved metrics

Total package byte prevSize

327080

increased by1.89%

Lines of code

2648

increased by0.46%

No dependency changes