catalyst-relay 0.5.13 → 0.6.0

package/README.md

@@ -170,6 +170,7 @@ curl -X POST http://localhost:3000/login \
 - Query table/view data with filtering and sorting
 - Get distinct column values
 - Count rows
+- Run freestyle OpenSQL queries with per-request row limits and timeouts
 
 ### Search
 - Search objects by name pattern
@@ -188,7 +189,9 @@ curl -X POST http://localhost:3000/login \
 | `asdcls` | Access Control | DCLS/DL |
 | `aclass` | ABAP Class | CLAS/OC |
 | `asprog` | ABAP Program | PROG/P |
+| `asinc` | ABAP Include | PROG/I |
 | `astabldt` | Table | TABL/DT |
+| `astablds` | Structure | STRU/D |
 
 ## Library Mode API Reference
 
@@ -199,21 +202,29 @@ curl -X POST http://localhost:3000/login \
 | `login()` | Authenticate and create session |
 | `logout()` | End session |
 | `refreshSession()` | Manually refresh session (keepalive) |
+| `exportSessionState()` | Serialize session for transfer to another process |
+| `importSessionState(state)` | Restore a previously exported session |
 | `read(objects)` | Batch read with content |
-| `create(object, package, transport?)` | Create new object |
-| `update(object, transport?)` | Update existing object |
-| `upsert(objects, package, transport?)` | Create or update |
-| `activate(objects)` | Compile and validate |
-| `delete(objects, transport?)` | Remove objects |
-| `getPackages()` | List packages |
-| `getPackageStats(name)` | Get package metadata and object count |
+| `create(object, package, transport?)` | Create a new object |
+| `update(object, transport?)` | Update an existing object |
+| `upsert(objects, package, transport?)` | Create or update a batch |
+| `activate(objects)` | Run-based activation; mixed extensions allowed |
+| `checkSyntax(objects)` | Syntax check (single extension per batch) |
+| `delete(objects, transport?)` | Multi-delete with dependency ordering; returns `DeleteResult[]` |
+| `getPackages(options?)` | List packages (filter, includeDescriptions) |
+| `getPackageStats(nameOrNames)` | Package description and recursive object count |
 | `getTree(query)` | Browse package tree (supports owner filter) |
 | `getTransports(package)` | List transports |
 | `createTransport(config)` | Create transport |
+| `deleteTransport(id, removeObjects?)` | Delete transport (optionally clear contents first) |
+| `removeFromTransport(id, objectName)` | Remove a single object from a transport |
+| `viewTransportObjects(id)` | List tasks and objects on a transport |
+| `getInactiveObjects()` | List objects/transports awaiting activation |
 | `previewData(query)` | Query table/view |
-| `getDistinctValues(object, column)` | Distinct values |
-| `countRows(object, type)` | Row count |
-| `search(query, types?)` | Search objects |
+| `getDistinctValues(name, parameters, column, type?)` | Distinct values with counts |
+| `countRows(name, type, parameters?)` | Row count |
+| `freestyleQuery(sqlQuery, limit?, timeout?)` | Run arbitrary read-only OpenSQL; optional row limit and per-request timeout (ms) |
+| `search(query, options?)` | Search objects (`{ types?, includePackages? }`) |
 | `whereUsed(object)` | Find dependencies |
 | `gitDiff(objects)` | Compare with server |
 | `getObjectConfig()` | Supported object types |
@@ -261,11 +272,11 @@ if (error) {
 #### Searching Objects
 
 ```typescript
-const [results, error] = await client.search('ZSNAP*', ['DDLS/DF', 'CLAS/OC']);
+const [results, error] = await client.search('ZSNAP*', { types: ['DDLS', 'CLAS'] });
 
 if (!error) {
     for (const result of results) {
-        console.log(`${result.name} (${result.type})`);
+        console.log(`${result.name} (${result.objectType})`);
     }
 }
 ```
@@ -281,6 +292,18 @@ const [data, error] = await client.previewData({
 });
 ```
 
+#### Freestyle OpenSQL Query
+
+For cases where the structured preview isn't enough, run an arbitrary read-only `SELECT`. This is a power-user surface — the query is not parsed or restricted beyond an optional row `limit` (max 50,000) and per-request `timeout` in milliseconds (max 5 minutes), so callers are responsible for deciding who may issue arbitrary SQL.
+
+```typescript
+const [data, error] = await client.freestyleQuery(
+    "SELECT carrid, connid, fldate FROM sflight WHERE carrid = 'LH'",
+    500,    // optional row limit (default 100)
+    60000   // optional per-request timeout in ms
+);
+```
+
 ## Server Mode API Reference
 
 ### HTTP Endpoints
@@ -294,15 +317,21 @@ const [data, error] = await client.previewData({
 | GET | `/packages` | List available packages |
 | GET | `/packages/:name/stats` | Get package metadata and count |
 | POST | `/tree` | Browse package tree (supports owner filter) |
-| GET | `/transports/:package` | List transports |
+| GET | `/transports/:package` | List transports for a package |
 | POST | `/transports` | Create transport |
+| DELETE | `/transports/:transportId` | Delete a transport (`?removeObjects=true` to clear first) |
+| GET | `/transports/:transportId/objects` | List tasks/objects on a transport |
+| PUT | `/transports/:transportId/objects` | Remove a single object from a transport |
+| GET | `/inactive-objects` | List objects/transports awaiting activation |
 | POST | `/objects/read` | Batch read objects |
 | POST | `/objects/upsert/:package/:transport?` | Create/update objects |
 | POST | `/objects/activate` | Activate objects |
-| DELETE | `/objects/:transport?` | Delete objects |
+| POST | `/objects/check` | Syntax check objects |
+| DELETE | `/objects/:transport?` | Multi-delete with dependency ordering |
 | POST | `/preview/data` | Query table/view data |
 | POST | `/preview/distinct` | Get distinct values |
 | POST | `/preview/count` | Count rows |
+| POST | `/preview/freestyle` | Run arbitrary read-only OpenSQL |
 | POST | `/search/:query` | Search objects |
 | POST | `/where-used` | Find dependencies |
 | POST | `/git-diff` | Compare with server |
@@ -340,13 +369,26 @@ curl -X POST http://localhost:3000/preview/data \
   }'
 ```
 
+#### Freestyle OpenSQL Query
+
+```bash
+curl -X POST http://localhost:3000/preview/freestyle \
+  -H "Content-Type: application/json" \
+  -H "x-session-id: abc123" \
+  -d '{
+    "sqlQuery": "SELECT carrid, connid, fldate FROM sflight WHERE carrid = '\''LH'\''",
+    "limit": 500,
+    "timeout": 60000
+  }'
+```
+
 #### Search Objects
 
 ```bash
 curl -X POST "http://localhost:3000/search/ZSNAP*" \
   -H "Content-Type: application/json" \
   -H "x-session-id: abc123" \
-  -d '{ "types": ["DDLS/DF", "CLAS/OC"] }'
+  -d '["DDLS", "CLAS"]'
 ```
 
 ## Error Handling
@@ -483,4 +525,4 @@ Egan Bosch
 
 ---
 
-*Last updated: v0.4.5*
+*Last updated: v0.5.14*

package/dist/index.d.mts

@@ -125,6 +125,15 @@ interface ObjectRef {
     /** File extension indicating object type (e.g., 'asddls') */
     extension: string;
 }
+/**
+ * Behavior definition implementation type.
+ *
+ * Only managed RAP is supported today; the enum exists so callers specify the
+ * type explicitly and so it can be widened (unmanaged, abstract, projection) later.
+ */
+declare enum BehaviorImplementationType {
+    Managed = "Managed"
+}
 /**
  * Object with content for create/update operations
  */
@@ -133,6 +142,8 @@ interface ObjectContent extends ObjectRef {
     content: string;
     /** Optional description for transport */
     description?: string;
+    /** Implementation type for behavior definitions (.asbdef). Defaults to Managed. */
+    implementationType?: BehaviorImplementationType;
 }
 /**
  * Tree discovery query for hierarchical browsing
@@ -257,6 +268,10 @@ interface ObjectConfig {
     dpEndpoint?: string;
     /** Data preview parameter name (if supported) */
     dpParam?: string;
+    /** Extra attributes to add to the root element on create (e.g., srvd:srvdSourceType) */
+    rootAttributes?: Record<string, string>;
+    /** Inject an <adtcore:adtTemplate> block carrying the implementation type (behavior definitions) */
+    requiresImplementationType?: boolean;
 }
 /**
  * Result of upsert operation
@@ -307,6 +322,18 @@ interface ActivationMessage {
     line?: number;
     column?: number;
 }
+/**
+ * A pre-resolved object reference for activation.
+ *
+ * Used for objects that aren't source-file-backed (e.g. service bindings) and so
+ * can't be resolved through the extension registry.
+ */
+interface ActivationReference {
+    uri: string;
+    type: string;
+    name: string;
+    extension: string;
+}
 
 /**
  * Where-Used — Find object dependencies
@@ -597,6 +624,9 @@ interface TransportObject {
 
 interface TaskContents {
     taskId: string;
+    owner?: string;
+    description?: string;
+    status?: string;
     objects: TransportObject[];
 }
 
@@ -637,6 +667,43 @@ interface DiffResult {
     diffs: DiffHunk[];
 }
 
+/** Binding protocol. Only OData is supported today. */
+type ServiceBindingType = 'ODATA';
+/** Binding version. Only OData V4 (category 1) is supported today. */
+type ServiceBindingVersion = 'V4';
+/**
+ * Options for creating a service binding
+ */
+interface CreateServiceBindingOptions {
+    /** Name of the service binding to create (e.g., 'ZBEACON_DOCS_O5') */
+    bindingName: string;
+    /** Name of the backing service definition (e.g., 'ZBEACON_DOCS_API') */
+    serviceDefinition: string;
+    /** Target package */
+    packageName: string;
+    /** Optional description */
+    description?: string;
+    /** Binding protocol (default: 'ODATA') */
+    bindingType?: ServiceBindingType;
+    /** Binding version (default: 'V4') */
+    bindingVersion?: ServiceBindingVersion;
+    /** Transport request (required for non-$TMP packages) */
+    transport?: string;
+    /** Whether to publish the binding after activation (default: true) */
+    publish?: boolean;
+}
+/**
+ * Result of creating a service binding
+ */
+interface ServiceBindingResult {
+    name: string;
+    serviceDefinition: string;
+    created: boolean;
+    activation: ActivationResult[];
+    published: boolean;
+    publishMessage?: string;
+}
+
 /**
  * ADT Client Core Implementation
  *
@@ -674,6 +741,7 @@ interface ADTClient {
     previewData(query: PreviewSQL): AsyncResult<DataFrame>;
     getDistinctValues(objectName: string, parameters: Parameter[], column: string, objectType?: 'table' | 'view'): AsyncResult<DistinctResult>;
     countRows(objectName: string, objectType: 'table' | 'view', parameters?: Parameter[]): AsyncResult<number>;
+    freestyleQuery(sqlQuery: string, limit?: number, timeout?: number): AsyncResult<DataFrame>;
     search(query: string, options?: SearchOptions): AsyncResult<SearchResult[]>;
     whereUsed(object: ObjectRef): AsyncResult<Dependency[]>;
     createTransport(config: TransportConfig): AsyncResult<string>;
@@ -681,6 +749,8 @@ interface ADTClient {
     removeFromTransport(transportId: string, objectName: string): AsyncResult<void>;
     viewTransportObjects(transportId: string): AsyncResult<TaskContents[]>;
     gitDiff(objects: ObjectContent[]): AsyncResult<DiffResult[]>;
+    createServiceBinding(options: CreateServiceBindingOptions): AsyncResult<ServiceBindingResult>;
+    deleteServiceBinding(bindingName: string, transport?: string): AsyncResult<void>;
     getObjectConfig(): ObjectConfig[];
 }
 
@@ -706,4 +776,4 @@ declare function activateLogging(): void;
  */
 declare function deactivateLogging(): void;
 
-export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, type BetweenFilter, type CheckResult, type ClientConfig, type ColumnInfo, type DataFrame, type DataPreviewQuery, type DeleteResult, type Dependency, type DiffHunk, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type ExportableSessionState, type ExternalReference, ExternalReferencesError, type FolderNode, type GetPackagesOptions, type InactiveEntry, type InactiveObject, type InactiveRef, type InactiveTransport, type ListFilter, type ModifiedDiffHunk, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectNode, type ObjectRef, type ObjectWithContent, type Package, type PackageNode, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchOptions, type SearchResult, type Session, type SimpleDiffHunk, type Sorting, type SsoAuthConfig, type SuccessResponse, type TaskContents, type Transport, type TransportConfig, type TransportObject, type TreeQuery, type TreeResponse, type UpsertResult, activateLogging, buildSQLQuery, createClient, deactivateLogging, err, ok };
+export { type ADTClient, type ActivationMessage, type ActivationReference, type ActivationResult, type Aggregation, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, BehaviorImplementationType, type BetweenFilter, type CheckResult, type ClientConfig, type ColumnInfo, type CreateServiceBindingOptions, type DataFrame, type DataPreviewQuery, type DeleteResult, type Dependency, type DiffHunk, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type ExportableSessionState, type ExternalReference, ExternalReferencesError, type FolderNode, type GetPackagesOptions, type InactiveEntry, type InactiveObject, type InactiveRef, type InactiveTransport, type ListFilter, type ModifiedDiffHunk, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectNode, type ObjectRef, type ObjectWithContent, type Package, type PackageNode, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchOptions, type SearchResult, type ServiceBindingResult, type ServiceBindingType, type ServiceBindingVersion, type Session, type SimpleDiffHunk, type Sorting, type SsoAuthConfig, type SuccessResponse, type TaskContents, type Transport, type TransportConfig, type TransportObject, type TreeQuery, type TreeResponse, type UpsertResult, activateLogging, buildSQLQuery, createClient, deactivateLogging, err, ok };

package/dist/index.d.ts

@@ -125,6 +125,15 @@ interface ObjectRef {
     /** File extension indicating object type (e.g., 'asddls') */
     extension: string;
 }
+/**
+ * Behavior definition implementation type.
+ *
+ * Only managed RAP is supported today; the enum exists so callers specify the
+ * type explicitly and so it can be widened (unmanaged, abstract, projection) later.
+ */
+declare enum BehaviorImplementationType {
+    Managed = "Managed"
+}
 /**
  * Object with content for create/update operations
  */
@@ -133,6 +142,8 @@ interface ObjectContent extends ObjectRef {
     content: string;
     /** Optional description for transport */
     description?: string;
+    /** Implementation type for behavior definitions (.asbdef). Defaults to Managed. */
+    implementationType?: BehaviorImplementationType;
 }
 /**
  * Tree discovery query for hierarchical browsing
@@ -257,6 +268,10 @@ interface ObjectConfig {
     dpEndpoint?: string;
     /** Data preview parameter name (if supported) */
     dpParam?: string;
+    /** Extra attributes to add to the root element on create (e.g., srvd:srvdSourceType) */
+    rootAttributes?: Record<string, string>;
+    /** Inject an <adtcore:adtTemplate> block carrying the implementation type (behavior definitions) */
+    requiresImplementationType?: boolean;
 }
 /**
  * Result of upsert operation
@@ -307,6 +322,18 @@ interface ActivationMessage {
     line?: number;
     column?: number;
 }
+/**
+ * A pre-resolved object reference for activation.
+ *
+ * Used for objects that aren't source-file-backed (e.g. service bindings) and so
+ * can't be resolved through the extension registry.
+ */
+interface ActivationReference {
+    uri: string;
+    type: string;
+    name: string;
+    extension: string;
+}
 
 /**
  * Where-Used — Find object dependencies
@@ -597,6 +624,9 @@ interface TransportObject {
 
 interface TaskContents {
     taskId: string;
+    owner?: string;
+    description?: string;
+    status?: string;
     objects: TransportObject[];
 }
 
@@ -637,6 +667,43 @@ interface DiffResult {
     diffs: DiffHunk[];
 }
 
+/** Binding protocol. Only OData is supported today. */
+type ServiceBindingType = 'ODATA';
+/** Binding version. Only OData V4 (category 1) is supported today. */
+type ServiceBindingVersion = 'V4';
+/**
+ * Options for creating a service binding
+ */
+interface CreateServiceBindingOptions {
+    /** Name of the service binding to create (e.g., 'ZBEACON_DOCS_O5') */
+    bindingName: string;
+    /** Name of the backing service definition (e.g., 'ZBEACON_DOCS_API') */
+    serviceDefinition: string;
+    /** Target package */
+    packageName: string;
+    /** Optional description */
+    description?: string;
+    /** Binding protocol (default: 'ODATA') */
+    bindingType?: ServiceBindingType;
+    /** Binding version (default: 'V4') */
+    bindingVersion?: ServiceBindingVersion;
+    /** Transport request (required for non-$TMP packages) */
+    transport?: string;
+    /** Whether to publish the binding after activation (default: true) */
+    publish?: boolean;
+}
+/**
+ * Result of creating a service binding
+ */
+interface ServiceBindingResult {
+    name: string;
+    serviceDefinition: string;
+    created: boolean;
+    activation: ActivationResult[];
+    published: boolean;
+    publishMessage?: string;
+}
+
 /**
  * ADT Client Core Implementation
  *
@@ -674,6 +741,7 @@ interface ADTClient {
     previewData(query: PreviewSQL): AsyncResult<DataFrame>;
     getDistinctValues(objectName: string, parameters: Parameter[], column: string, objectType?: 'table' | 'view'): AsyncResult<DistinctResult>;
     countRows(objectName: string, objectType: 'table' | 'view', parameters?: Parameter[]): AsyncResult<number>;
+    freestyleQuery(sqlQuery: string, limit?: number, timeout?: number): AsyncResult<DataFrame>;
     search(query: string, options?: SearchOptions): AsyncResult<SearchResult[]>;
     whereUsed(object: ObjectRef): AsyncResult<Dependency[]>;
     createTransport(config: TransportConfig): AsyncResult<string>;
@@ -681,6 +749,8 @@ interface ADTClient {
     removeFromTransport(transportId: string, objectName: string): AsyncResult<void>;
     viewTransportObjects(transportId: string): AsyncResult<TaskContents[]>;
     gitDiff(objects: ObjectContent[]): AsyncResult<DiffResult[]>;
+    createServiceBinding(options: CreateServiceBindingOptions): AsyncResult<ServiceBindingResult>;
+    deleteServiceBinding(bindingName: string, transport?: string): AsyncResult<void>;
     getObjectConfig(): ObjectConfig[];
 }
 
@@ -706,4 +776,4 @@ declare function activateLogging(): void;
  */
 declare function deactivateLogging(): void;
 
-export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, type BetweenFilter, type CheckResult, type ClientConfig, type ColumnInfo, type DataFrame, type DataPreviewQuery, type DeleteResult, type Dependency, type DiffHunk, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type ExportableSessionState, type ExternalReference, ExternalReferencesError, type FolderNode, type GetPackagesOptions, type InactiveEntry, type InactiveObject, type InactiveRef, type InactiveTransport, type ListFilter, type ModifiedDiffHunk, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectNode, type ObjectRef, type ObjectWithContent, type Package, type PackageNode, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchOptions, type SearchResult, type Session, type SimpleDiffHunk, type Sorting, type SsoAuthConfig, type SuccessResponse, type TaskContents, type Transport, type TransportConfig, type TransportObject, type TreeQuery, type TreeResponse, type UpsertResult, activateLogging, buildSQLQuery, createClient, deactivateLogging, err, ok };
+export { type ADTClient, type ActivationMessage, type ActivationReference, type ActivationResult, type Aggregation, type ApiResponse, type AsyncResult, type AuthConfig, type AuthType, type BasicAuthConfig, type BasicFilter, BehaviorImplementationType, type BetweenFilter, type CheckResult, type ClientConfig, type ColumnInfo, type CreateServiceBindingOptions, type DataFrame, type DataPreviewQuery, type DeleteResult, type Dependency, type DiffHunk, type DiffResult, type DistinctResult, type ErrorCode, type ErrorResponse, type ExportableSessionState, type ExternalReference, ExternalReferencesError, type FolderNode, type GetPackagesOptions, type InactiveEntry, type InactiveObject, type InactiveRef, type InactiveTransport, type ListFilter, type ModifiedDiffHunk, type ObjectConfig, type ObjectContent, type ObjectMetadata, type ObjectNode, type ObjectRef, type ObjectWithContent, type Package, type PackageNode, type Parameter, type PreviewSQL, type QueryFilter, type Result, type SamlAuthConfig, type SearchOptions, type SearchResult, type ServiceBindingResult, type ServiceBindingType, type ServiceBindingVersion, type Session, type SimpleDiffHunk, type Sorting, type SsoAuthConfig, type SuccessResponse, type TaskContents, type Transport, type TransportConfig, type TransportObject, type TreeQuery, type TreeResponse, type UpsertResult, activateLogging, buildSQLQuery, createClient, deactivateLogging, err, ok };