@sfutureapps/db-sdk 0.3.20 → 0.3.22

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sfutureapps/db-sdk",
-  "version": "0.3.20",
+  "version": "0.3.22",
   "description": "SfutureApps JS SDK for ThinkPHP DB Gateway (MySQL)",
   "license": "MIT",
   "type": "module",

package/src/index.d.ts

@@ -1,4 +1,100 @@
 // src/index.d.ts
+export type QueryError = {
+  message: string;
+  [key: string]: any;
+};
+
+export type QueryMeta = {
+  page?: number;
+  limit?: number;
+  offset?: number;
+  total?: number;
+  last_page?: number;
+  [key: string]: any;
+};
+
+export type QueryResponse<T> = {
+  data: T;
+  error: QueryError | null;
+  count?: number | null;
+  meta?: QueryMeta | null;
+  [key: string]: any;
+};
+
+export type OrderOptions = {
+  ascending?: boolean;
+};
+
+export class QueryBuilder<T = any, TSingle extends boolean = false> {
+  constructor(table: string);
+
+  // ---- select ----
+  select(columns?: "*" | string | string[]): QueryBuilder<T, TSingle>;
+
+  // ---- filters ----
+  eq(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  neq(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  gt(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  gte(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  lt(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  lte(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+
+  like(col: keyof T | string, val: string): QueryBuilder<T, TSingle>;
+  notLike(col: keyof T | string, val: string): QueryBuilder<T, TSingle>;
+
+  between(col: keyof T | string, range: [any, any]): QueryBuilder<T, TSingle>;
+  notBetween(col: keyof T | string, range: [any, any]): QueryBuilder<T, TSingle>;
+
+  in(col: keyof T | string, vals: any[]): QueryBuilder<T, TSingle>;
+  notIn(col: keyof T | string, vals: any[]): QueryBuilder<T, TSingle>;
+
+  isNull(col: keyof T | string): QueryBuilder<T, TSingle>;
+  notNull(col: keyof T | string): QueryBuilder<T, TSingle>;
+
+  regexp(col: keyof T | string, pattern: string): QueryBuilder<T, TSingle>;
+  notRegexp(col: keyof T | string, pattern: string): QueryBuilder<T, TSingle>;
+
+  whereTime(col: keyof T | string, op: string, time: any): QueryBuilder<T, TSingle>;
+  betweenTime(col: keyof T | string, range: [any, any]): QueryBuilder<T, TSingle>;
+
+  findInSet(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+
+  // ---- order ----
+  order(col: keyof T | string, opts?: OrderOptions): QueryBuilder<T, TSingle>;
+
+  // ---- pagination ----
+  limit(n: number): QueryBuilder<T, TSingle>;
+  page(page: number, limit: number): QueryBuilder<T, TSingle>;
+  range(from: number, to: number): QueryBuilder<T, TSingle>;
+  withCount(): QueryBuilder<T, TSingle>;
+  single(): QueryBuilder<T, true>;
+
+  // ---- group/having/distinct ----
+  distinct(): QueryBuilder<T, TSingle>;
+  group(cols: string | string[]): QueryBuilder<T, TSingle>;
+  havingEq(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  havingGte(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  havingLte(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  havingGt(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  havingLt(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+  havingNeq(col: keyof T | string, val: any): QueryBuilder<T, TSingle>;
+
+  // ---- execute ----
+  execute(): Promise<QueryResponse<TSingle extends true ? T | null : T[]>>;
+
+  // ---- aggregates ----
+  count(field?: keyof T | string): Promise<QueryResponse<number>>;
+  sum(field: keyof T | string): Promise<QueryResponse<number>>;
+  avg(field: keyof T | string): Promise<QueryResponse<number>>;
+  min(field: keyof T | string): Promise<QueryResponse<number>>;
+  max(field: keyof T | string): Promise<QueryResponse<number>>;
+
+  // ---- write ----
+  insert(values: Partial<T> | Array<Partial<T>> | Record<string, any>): Promise<QueryResponse<any>>;
+  update(values: Partial<T> | Record<string, any>): Promise<QueryResponse<any>>;
+  delete(): Promise<QueryResponse<any>>;
+}
+
 export function createClient(
   baseUrl: string,
   opts?: {
@@ -7,5 +103,5 @@ export function createClient(
     headers?: Record<string, string>;
   }
 ): {
-  from<T = any>(table: string): any;
+  from<T = any>(table: string): QueryBuilder<T, false>;
 };

package/src/query-builder.js

@@ -120,10 +120,11 @@ export class QueryBuilder {
       distinct: this._distinct,
       group: this._group,
       having: this._having,
+      single: this._single,
     };
 
-    if (this._page !== null) payload.page = this._page;
-    if (this._offset !== null) payload.offset = this._offset;
+    if (this._page != null) payload.page = this._page;
+    if (this._offset != null) payload.offset = this._offset;
 
     const res = await post({ endpoint: "/db/v1/query", data: payload });
 
@@ -131,7 +132,7 @@ export class QueryBuilder {
 
     if (this._single) {
       const first = Array.isArray(res.data) ? (res.data[ 0 ] ?? null) : null;
-      return { data: first, error: null, count: res.count ?? null, meta: res.meta ?? null };
+      return { data: first, error: null, total_rows: res.total_rows ?? null, paginate: res.paginate ?? null };
     }
 
     return res;