catalyst-relay 0.2.2 → 0.2.4

package/dist/index.d.mts

@@ -108,7 +108,7 @@ interface TreeQuery {
 /**
  * Data preview query
  */
-interface PreviewQuery {
+interface PreviewSQL {
     /** Object name (table or CDS view) */
     objectName: string;
     /** Object type ('table' or 'view') */
@@ -311,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
  */
@@ -433,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[]>;
@@ -444,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 ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectRef, type ObjectWithContent, 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,7 +108,7 @@ interface TreeQuery {
 /**
  * Data preview query
  */
-interface PreviewQuery {
+interface PreviewSQL {
     /** Object name (table or CDS view) */
     objectName: string;
     /** Object type ('table' or 'view') */
@@ -311,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
  */
@@ -433,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[]>;
@@ -444,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 ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectRef, type ObjectWithContent, 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.js

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  buildSQLQuery: () => buildSQLQuery,
   createClient: () => createClient,
   err: () => err,
   ok: () => ok
@@ -404,7 +405,7 @@ function requireConfig(extension) {
   return [config, null];
 }
 
-// src/core/adt/read.ts
+// src/core/adt/craud/read.ts
 async function readObject(client, object) {
   const [config, configErr] = requireConfig(object.extension);
   if (configErr) return err(configErr);
@@ -428,7 +429,7 @@ async function readObject(client, object) {
   return ok(result);
 }
 
-// src/core/adt/lock.ts
+// src/core/adt/craud/lock.ts
 async function lockObject(client, object) {
   const [config, configErr] = requireConfig(object.extension);
   if (configErr) return err(configErr);
@@ -476,7 +477,7 @@ async function unlockObject(client, object, lockHandle) {
   return ok(void 0);
 }
 
-// src/core/adt/create.ts
+// src/core/adt/craud/create.ts
 async function createObject(client, object, packageName, transport, username) {
   const [config, configErr] = requireConfig(object.extension);
   if (configErr) return err(configErr);
@@ -513,7 +514,7 @@ async function createObject(client, object, packageName, transport, username) {
   return ok(void 0);
 }
 
-// src/core/adt/update.ts
+// src/core/adt/craud/update.ts
 async function updateObject(client, object, lockHandle, transport) {
   const [config, configErr] = requireConfig(object.extension);
   if (configErr) return err(configErr);
@@ -541,7 +542,7 @@ async function updateObject(client, object, lockHandle, transport) {
   return ok(void 0);
 }
 
-// src/core/adt/delete.ts
+// src/core/adt/craud/delete.ts
 async function deleteObject(client, object, lockHandle, transport) {
   const [config, configErr] = requireConfig(object.extension);
   if (configErr) return err(configErr);
@@ -566,7 +567,7 @@ async function deleteObject(client, object, lockHandle, transport) {
   return ok(void 0);
 }
 
-// src/core/adt/activation.ts
+// src/core/adt/craud/activation.ts
 async function activateObjects(client, objects) {
   if (objects.length === 0) {
     return ok([]);
@@ -676,7 +677,7 @@ function extractActivationErrors(objects, xml, _extension) {
   return ok(results);
 }
 
-// src/core/adt/tree.ts
+// src/core/adt/discovery/tree.ts
 async function getTree(client, query) {
   const internalQuery = {};
   if (query.package) {
@@ -793,7 +794,7 @@ function parseTreeResponse(xml) {
   return ok({ nodes, packages });
 }
 
-// src/core/adt/packages.ts
+// src/core/adt/discovery/packages.ts
 async function getPackages(client) {
   const [treeResult, treeErr] = await getTreeInternal(client, {}, "*");
   if (treeErr) {
@@ -802,7 +803,7 @@ async function getPackages(client) {
   return ok(treeResult.packages);
 }
 
-// src/core/adt/transports.ts
+// src/core/adt/transports/transports.ts
 async function getTransports(client, packageName) {
   const contentType = "application/vnd.sap.as+xml; charset=UTF-8; dataname=com.sap.adt.transport.service.checkData";
   const body = `<?xml version="1.0" encoding="UTF-8"?>
@@ -871,7 +872,7 @@ function extractTransports(xml) {
   return ok(transports);
 }
 
-// src/core/adt/previewParser.ts
+// src/core/adt/data_extraction/previewParser.ts
 function parseDataPreview(xml, maxRows, isTable) {
   const [doc, parseErr] = safeParseXml(xml);
   if (parseErr) {
@@ -930,7 +931,7 @@ function parseDataPreview(xml, maxRows, isTable) {
   return ok(dataFrame);
 }
 
-// src/core/adt/dataPreview.ts
+// src/core/adt/data_extraction/dataPreview.ts
 async function previewData(client, query) {
   const extension = query.objectType === "table" ? "astabldt" : "asddls";
   const config = getConfigByExtension(extension);
@@ -970,11 +971,83 @@ async function previewData(client, query) {
   return ok(dataFrame);
 }
 
-// src/core/adt/distinct.ts
+// src/core/adt/data_extraction/queryBuilder.ts
+function quoteString(value) {
+  return typeof value == "string" ? "'" + value + "'" : "" + value;
+}
+function basicFilterToWhere(filter) {
+  return `${filter.field} ${filter.operator} ${quoteString(filter.value)}`;
+}
+function betweenFilterToWhere(filter) {
+  return `${filter.field} between ${quoteString(filter.minimum)} and ${quoteString(filter.maximum)}`;
+}
+function listFilterToWhere(filter) {
+  return `${filter.field} ${filter.include ? "" : "not "}in ( ${filter.values.map(quoteString).join(", ")} )`;
+}
+function queryFilterToWhere(filter) {
+  if (filter.type === "list") return listFilterToWhere(filter);
+  if (filter.type === "between") return betweenFilterToWhere(filter);
+  return basicFilterToWhere(filter);
+}
+function queryFiltersToWhere(filters) {
+  if (filters.length === 0) return "";
+  return `
+where ${filters.map(queryFilterToWhere).join(" and ")}`;
+}
+function sortingsToOrderBy(sortings) {
+  if (sortings.length === 0) return "";
+  return `
+order by ${sortings.map((s) => `${s.field} ${s.direction}`).join(", ")}`;
+}
+function fieldsToGroupbyClause(fields) {
+  if (fields.length === 0) return "";
+  return `
+group by ${fields.join(", ")}`;
+}
+function aggregationToFieldDefinition(aggregation) {
+  if (aggregation.function === "count") {
+    return `count( distinct main~${aggregation.field} ) as ${aggregation.field}`;
+  }
+  return `${aggregation.function}( main~${aggregation.field} ) as ${aggregation.field}`;
+}
+function parametersToSQLParams(params) {
+  if (params.length === 0) return "";
+  return `( ${params.map((p) => `${p.name} = ${quoteString(p.value)}`).join(", ")})`;
+}
+function buildSQLQuery(query) {
+  const [parameters, filters, sortings, aggregations] = [query.parameters ?? [], query.filters ?? [], query.sortings ?? [], query.aggregations ?? []];
+  const groupingFields = query.fields.filter((f) => !aggregations.find((a) => a.field === f));
+  if (sortings.filter((s) => !query.fields.includes(s.field)).length > 0) {
+    return err(new Error("Sorting fields must be included in the selected fields."));
+  }
+  let selectClause = "select\n";
+  const fieldSelections = [];
+  for (const field of query.fields) {
+    const aggregation = aggregations.find((a) => a.field === field);
+    if (aggregation) {
+      fieldSelections.push(`	${aggregationToFieldDefinition(aggregation)}`);
+      continue;
+    }
+    fieldSelections.push(`	main~${field}`);
+  }
+  selectClause += fieldSelections.join(",\n") + `
+from ${query.objectName}${parametersToSQLParams(parameters)} as main
+`;
+  const [whereClause, groupbyClause, orderbyClause] = [queryFiltersToWhere(filters), aggregations.length ? fieldsToGroupbyClause(groupingFields) : "", sortingsToOrderBy(sortings)];
+  const result = {
+    objectName: query.objectName,
+    objectType: query.objectType,
+    sqlQuery: `${selectClause}${whereClause}${groupbyClause}${orderbyClause}`
+  };
+  if (query.limit !== void 0) result.limit = query.limit;
+  return ok(result);
+}
+
+// src/core/adt/data_extraction/distinct.ts
 var MAX_ROW_COUNT = 5e4;
-async function getDistinctValues(client, objectName, column, objectType = "view") {
+async function getDistinctValues(client, objectName, parameters, column, objectType = "view") {
   const columnName = column.toUpperCase();
-  const sqlQuery = `SELECT ${columnName} AS value, COUNT(*) AS count FROM ${objectName} GROUP BY ${columnName}`;
+  const sqlQuery = `SELECT ${columnName} AS value, COUNT(*) AS ValueCount FROM ${objectName}${parametersToSQLParams(parameters)} GROUP BY ${columnName} ORDER BY ValueCount DESCENDING`;
   const [dataFrame, error] = await previewData(client, {
     objectName,
     objectType,
@@ -991,7 +1064,7 @@ async function getDistinctValues(client, objectName, column, objectType = "view"
   return ok({ column, values });
 }
 
-// src/core/adt/count.ts
+// src/core/adt/data_extraction/count.ts
 async function countRows(client, objectName, objectType) {
   const sqlQuery = `SELECT COUNT(*) AS count FROM ${objectName}`;
   const [dataFrame, error] = await previewData(client, {
@@ -1014,7 +1087,7 @@ async function countRows(client, objectName, objectType) {
   return ok(count);
 }
 
-// src/core/adt/searchObjects.ts
+// src/core/adt/discovery/searchObjects.ts
 async function searchObjects(client, query, types) {
   const searchPattern = query || "*";
   const objectTypes = types && types.length > 0 ? types : getAllTypes();
@@ -1081,7 +1154,7 @@ function parseSearchResults(xml) {
   return ok(results);
 }
 
-// src/core/adt/whereUsed.ts
+// src/core/adt/discovery/whereUsed.ts
 async function findWhereUsed(client, object) {
   const config = getConfigByExtension(object.extension);
   if (!config) {
@@ -1155,7 +1228,7 @@ function parseWhereUsed(xml) {
   return ok(dependencies);
 }
 
-// src/core/adt/createTransport.ts
+// src/core/adt/transports/createTransport.ts
 async function createTransport(client, config) {
   const body = dictToAbapXml({
     DEVCLASS: config.package,
@@ -1186,7 +1259,7 @@ async function createTransport(client, config) {
   return ok(transportId);
 }
 
-// src/core/adt/gitDiff.ts
+// src/core/adt/craud/gitDiff.ts
 var import_diff = require("diff");
 function computeDiff(serverLines, localLines) {
   const changes = (0, import_diff.diffArrays)(serverLines, localLines);
@@ -2134,9 +2207,9 @@ var ADTClientImpl = class {
     if (!this.state.session) return err(new Error("Not logged in"));
     return previewData(this.requestor, query);
   }
-  async getDistinctValues(objectName, column, objectType = "view") {
+  async getDistinctValues(objectName, parameters, column, objectType = "view") {
     if (!this.state.session) return err(new Error("Not logged in"));
-    return getDistinctValues(this.requestor, objectName, column, objectType);
+    return getDistinctValues(this.requestor, objectName, parameters, column, objectType);
   }
   async countRows(objectName, objectType) {
     if (!this.state.session) return err(new Error("Not logged in"));
@@ -2181,20 +2254,9 @@ function createClient(config) {
   }
   return ok(new ADTClientImpl(config));
 }
-
-// src/core/config.ts
-var import_node_fs = require("fs");
-var import_zod2 = require("zod");
-var systemConfigSchema = import_zod2.z.record(
-  import_zod2.z.string(),
-  import_zod2.z.object({
-    adt: import_zod2.z.string().url().optional(),
-    odata: import_zod2.z.string().url().optional(),
-    instance_num: import_zod2.z.string().optional()
-  })
-);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  buildSQLQuery,
   createClient,
   err,
   ok