catalyst-relay 0.2.1 → 0.2.4

package/README.md

@@ -270,9 +270,9 @@ if (!error) {
 ```typescript
 const [data, error] = await client.previewData({
     objectName: 'T000',
-    columns: ['MANDT', 'MTEXT'],
-    limit: 10,
-    where: "MANDT = '100'"
+    objectType: 'table',
+    sqlQuery: "SELECT MANDT, MTEXT FROM T000 WHERE MANDT = '100'",
+    limit: 10
 });
 ```
 
@@ -327,7 +327,8 @@ curl -X POST http://localhost:3000/preview/data \
   -H "x-session-id: abc123" \
   -d '{
     "objectName": "T000",
-    "columns": ["MANDT", "MTEXT"],
+    "objectType": "table",
+    "sqlQuery": "SELECT MANDT, MTEXT FROM T000 WHERE MANDT = '\''100'\''",
     "limit": 10
   }'
 ```

package/dist/index.d.mts

@@ -108,35 +108,15 @@ interface TreeQuery {
 /**
  * Data preview query
  */
-interface PreviewQuery {
+interface PreviewSQL {
     /** Object name (table or CDS view) */
     objectName: string;
     /** Object type ('table' or 'view') */
     objectType: 'table' | 'view';
-    /** WHERE clause filters */
-    filters?: Filter[];
-    /** ORDER BY columns */
-    orderBy?: OrderBy[];
+    /** SQL query to execute */
+    sqlQuery: string;
     /** Maximum rows to return (default: 100) */
     limit?: number;
-    /** Row offset for pagination */
-    offset?: number;
-}
-/**
- * Filter condition for data preview
- */
-interface Filter {
-    column: string;
-    operator: FilterOperator;
-    value: string | number | boolean | null;
-}
-type FilterOperator = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le' | 'like' | 'in';
-/**
- * Sort specification for data preview
- */
-interface OrderBy {
-    column: string;
-    direction: 'asc' | 'desc';
 }
 
 /**
@@ -331,6 +311,53 @@ interface ColumnInfo {
     label?: string;
 }
 
+/**
+ * Query Builder — Optional helper for building SQL queries for data preview
+ */
+
+type BasicFilter = {
+    type: "basic";
+    field: string;
+    value: string | number;
+    operator: "=" | "<>" | "<" | "<=" | ">" | ">=" | "like" | "not like";
+};
+type BetweenFilter = {
+    type: "between";
+    field: string;
+    minimum: string | number;
+    maximum: string | number;
+};
+type ListFilter = {
+    type: "list";
+    field: string;
+    values: (string | number)[];
+    include: boolean;
+};
+type QueryFilter = BasicFilter | BetweenFilter | ListFilter;
+type Sorting = {
+    field: string;
+    direction: "ascending" | "descending";
+};
+type Aggregation = {
+    field: string;
+    function: "count" | "sum" | "avg" | "min" | "max";
+};
+type Parameter = {
+    name: string;
+    value: string | number;
+};
+type DataPreviewQuery = {
+    objectName: string;
+    objectType: 'table' | 'view';
+    limit?: number;
+    fields: string[];
+    parameters?: Parameter[];
+    filters?: QueryFilter[];
+    sortings?: Sorting[];
+    aggregations?: Aggregation[];
+};
+declare function buildSQLQuery(query: DataPreviewQuery): Result<PreviewSQL>;
+
 /**
  * Distinct Values — Get distinct column values with counts
  */
@@ -453,8 +480,8 @@ interface ADTClient {
     getPackages(): AsyncResult<Package[]>;
     getTree(query: TreeQuery): AsyncResult<TreeNode[]>;
     getTransports(packageName: string): AsyncResult<Transport[]>;
-    previewData(query: PreviewQuery): AsyncResult<DataFrame>;
-    getDistinctValues(objectName: string, column: string, objectType?: 'table' | 'view'): AsyncResult<DistinctResult>;
+    previewData(query: PreviewSQL): AsyncResult<DataFrame>;
+    getDistinctValues(objectName: string, parameters: Parameter[], column: string, objectType?: 'table' | 'view'): AsyncResult<DistinctResult>;
     countRows(objectName: string, objectType: 'table' | 'view'): AsyncResult<number>;
     search(query: string, types?: string[]): AsyncResult<SearchResult[]>;
     whereUsed(object: ObjectRef): AsyncResult<Dependency[]>;
@@ -464,4 +491,4 @@ interface ADTClient {
 }
 declare function createClient(config: ClientConfig): Result<ADTClient, Error>;
 
-export { type ADTClient, type ActivationMessage, type ActivationResult, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type ClientConfig, type ColumnInfo, type DataFrame, type Dependency, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type Filter, type FilterOperator, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectRef, type ObjectWithContent, type OrderBy, type Package, type PreviewQuery, type Result, type SamlAuthConfig, type SearchResult, type Session, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeNode, type TreeQuery, type UpsertResult, createClient, err, ok };
+export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, type BetweenFilter, type ClientConfig, type ColumnInfo, type DataFrame, type DataPreviewQuery, type Dependency, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type ListFilter, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectRef, type ObjectWithContent, type Package, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchResult, type Session, type Sorting, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeNode, type TreeQuery, type UpsertResult, buildSQLQuery, createClient, err, ok };

package/dist/index.d.ts

@@ -108,35 +108,15 @@ interface TreeQuery {
 /**
  * Data preview query
  */
-interface PreviewQuery {
+interface PreviewSQL {
     /** Object name (table or CDS view) */
     objectName: string;
     /** Object type ('table' or 'view') */
     objectType: 'table' | 'view';
-    /** WHERE clause filters */
-    filters?: Filter[];
-    /** ORDER BY columns */
-    orderBy?: OrderBy[];
+    /** SQL query to execute */
+    sqlQuery: string;
     /** Maximum rows to return (default: 100) */
     limit?: number;
-    /** Row offset for pagination */
-    offset?: number;
-}
-/**
- * Filter condition for data preview
- */
-interface Filter {
-    column: string;
-    operator: FilterOperator;
-    value: string | number | boolean | null;
-}
-type FilterOperator = 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le' | 'like' | 'in';
-/**
- * Sort specification for data preview
- */
-interface OrderBy {
-    column: string;
-    direction: 'asc' | 'desc';
 }
 
 /**
@@ -331,6 +311,53 @@ interface ColumnInfo {
     label?: string;
 }
 
+/**
+ * Query Builder — Optional helper for building SQL queries for data preview
+ */
+
+type BasicFilter = {
+    type: "basic";
+    field: string;
+    value: string | number;
+    operator: "=" | "<>" | "<" | "<=" | ">" | ">=" | "like" | "not like";
+};
+type BetweenFilter = {
+    type: "between";
+    field: string;
+    minimum: string | number;
+    maximum: string | number;
+};
+type ListFilter = {
+    type: "list";
+    field: string;
+    values: (string | number)[];
+    include: boolean;
+};
+type QueryFilter = BasicFilter | BetweenFilter | ListFilter;
+type Sorting = {
+    field: string;
+    direction: "ascending" | "descending";
+};
+type Aggregation = {
+    field: string;
+    function: "count" | "sum" | "avg" | "min" | "max";
+};
+type Parameter = {
+    name: string;
+    value: string | number;
+};
+type DataPreviewQuery = {
+    objectName: string;
+    objectType: 'table' | 'view';
+    limit?: number;
+    fields: string[];
+    parameters?: Parameter[];
+    filters?: QueryFilter[];
+    sortings?: Sorting[];
+    aggregations?: Aggregation[];
+};
+declare function buildSQLQuery(query: DataPreviewQuery): Result<PreviewSQL>;
+
 /**
  * Distinct Values — Get distinct column values with counts
  */
@@ -453,8 +480,8 @@ interface ADTClient {
     getPackages(): AsyncResult<Package[]>;
     getTree(query: TreeQuery): AsyncResult<TreeNode[]>;
     getTransports(packageName: string): AsyncResult<Transport[]>;
-    previewData(query: PreviewQuery): AsyncResult<DataFrame>;
-    getDistinctValues(objectName: string, column: string, objectType?: 'table' | 'view'): AsyncResult<DistinctResult>;
+    previewData(query: PreviewSQL): AsyncResult<DataFrame>;
+    getDistinctValues(objectName: string, parameters: Parameter[], column: string, objectType?: 'table' | 'view'): AsyncResult<DistinctResult>;
     countRows(objectName: string, objectType: 'table' | 'view'): AsyncResult<number>;
     search(query: string, types?: string[]): AsyncResult<SearchResult[]>;
     whereUsed(object: ObjectRef): AsyncResult<Dependency[]>;
@@ -464,4 +491,4 @@ interface ADTClient {
 }
 declare function createClient(config: ClientConfig): Result<ADTClient, Error>;
 
-export { type ADTClient, type ActivationMessage, type ActivationResult, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type ClientConfig, type ColumnInfo, type DataFrame, type Dependency, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type Filter, type FilterOperator, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectRef, type ObjectWithContent, type OrderBy, type Package, type PreviewQuery, type Result, type SamlAuthConfig, type SearchResult, type Session, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeNode, type TreeQuery, type UpsertResult, createClient, err, ok };
+export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, type BetweenFilter, type ClientConfig, type ColumnInfo, type DataFrame, type DataPreviewQuery, type Dependency, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type ListFilter, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectRef, type ObjectWithContent, type Package, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchResult, type Session, type Sorting, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeNode, type TreeQuery, type UpsertResult, buildSQLQuery, createClient, err, ok };