@slickgrid-universal/sql 0.0.1 → 10.4.1

package/package.json

@@ -1,10 +1,47 @@
 {
   "name": "@slickgrid-universal/sql",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @slickgrid-universal/sql",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+  "version": "10.4.1",
+  "description": "SlickGrid Universal SQL Backend Service (implements BackendService for SQL)",
+  "type": "module",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "/dist",
+    "/src"
+  ],
+  "scripts": {
+    "build": "pnpm run clean && tsc",
+    "build:incremental": "tsc --incremental --declaration",
+    "clean": "remove dist tsconfig.tsbuildinfo",
+    "dev": "pnpm build:incremental"
+  },
+  "license": "MIT",
+  "author": "Ghislain B.",
+  "homepage": "https://github.com/ghiscoding/slickgrid-universal",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ghiscoding/slickgrid-universal.git",
+    "directory": "packages/sql"
+  },
+  "bugs": {
+    "url": "https://github.com/ghiscoding/slickgrid-universal/issues"
+  },
+  "dependencies": {
+    "@slickgrid-universal/common": "10.4.0",
+    "@slickgrid-universal/utils": "10.3.0"
+  },
+  "funding": {
+    "type": "ko_fi",
+    "url": "https://ko-fi.com/ghiscoding"
+  }
 }

package/src/index.ts

@@ -0,0 +1,2 @@
+export { SqlService } from './services/sql.service.js';
+export type * from './interfaces/index.js';

package/src/interfaces/index.ts

@@ -0,0 +1,3 @@
+export * from './sqlResult.interface.js';
+export * from './sqlServiceOption.interface.js';
+export * from './sqlServiceApi.interface.js';

package/src/interfaces/sqlResult.interface.ts

@@ -0,0 +1,6 @@
+import type { Metrics } from '@slickgrid-universal/common';
+
+export interface SqlResult<T = any> {
+  data: T[];
+  metrics?: Metrics;
+}

package/src/interfaces/sqlServiceApi.interface.ts

@@ -0,0 +1,27 @@
+import type { BackendServiceApi, Observable } from '@slickgrid-universal/common';
+import type { SqlService } from '../services/sql.service.js';
+import type { SqlResult } from './sqlResult.interface.js';
+import type { SqlServiceOption } from './sqlServiceOption.interface.js';
+
+export interface SqlServiceApi<T = any> extends BackendServiceApi {
+  /** Backend Service Options */
+  options: SqlServiceOption;
+
+  /** Backend Service instance */
+  service: SqlService;
+
+  /** On init (or on page load), what action to perform? */
+  onInit?: (query: string) => Promise<SqlResult<T>> | Observable<SqlResult<T>>;
+
+  /** On Processing, we get the query back from the service, and we need to provide a Promise/Observable. For example: this.http.get(mySqlUrl) */
+  process: (query: string) => Promise<SqlResult<T>> | Observable<SqlResult<T>>;
+
+  /** After executing the query, what action to perform? For example, stop the spinner */
+  postProcess?: (response: SqlResult<T>) => void;
+
+  /**
+   * INTERNAL USAGE ONLY by Slickgrid-Universal
+   * This internal process will be run just before postProcess and is meant to refresh the Dataset & Pagination after a SQL call
+   */
+  internalPostProcess?: (result: SqlResult<T>) => void;
+}

package/src/interfaces/sqlServiceOption.interface.ts

@@ -0,0 +1,61 @@
+import type { InfiniteScrollOption, SortDirection } from '@slickgrid-universal/common';
+
+export type IdentifierEscapeStyle = 'doubleQuote' | 'backtick' | 'bracket';
+
+export interface SqlServiceOption {
+  /** Name of the SQL table to query (required) */
+  tableName: string;
+  /** Optional: dataset/schema/database name for multi-database support */
+  datasetName?: string;
+  /**
+   * Controls how SQL identifiers (table/schema) are escaped in generated queries.
+   * - 'doubleQuote': "identifier" (PostgreSQL, ANSI SQL, default)
+   * - 'backtick': `identifier` (MySQL)
+   * - 'bracket': [identifier] (MSSQL)
+   */
+  identifierEscapeStyle?: IdentifierEscapeStyle;
+  /** Filtering options for WHERE clause */
+  filteringOptions?: SqlFilteringOption[];
+  /** Sorting options for ORDER BY clause */
+  sortingOptions?: SqlSortingOption[];
+  /** Pagination options (pageNumber, pageSize) */
+  paginationOptions?: SqlPaginationOption;
+  /** Any extra query arguments (for advanced use) */
+  extraQueryArguments?: SqlQueryArgument[];
+  /** Enable infinite scroll mode (disables LIMIT/OFFSET pagination) */
+  infiniteScroll?: boolean | InfiniteScrollOption;
+
+  /**
+   * Name of the total count column returned by the SQL query (default: 'totalCount').
+   * Use this to avoid conflicts or customize the count field name in the result set.
+   */
+  totalCountField?: string;
+
+  /**
+   * When false, searchTerms may be manipulated to be functional with certain filters eg: string only filters.
+   * When true, JSON.stringify is used on the searchTerms and used in the query "as-is". It is then the responsibility of the developer to sanitise the `searchTerms` property if necessary.
+   */
+  useVerbatimSearchTerms?: boolean;
+}
+
+export interface SqlFilteringOption {
+  field: string;
+  operator: string;
+  value: any;
+  type?: string;
+}
+
+export interface SqlSortingOption {
+  field: string;
+  direction: SortDirection;
+}
+
+export interface SqlPaginationOption {
+  pageNumber: number;
+  pageSize: number;
+}
+
+export interface SqlQueryArgument {
+  field: string;
+  value: any;
+}