catalyst-relay 0.3.1 → 0.4.1

package/dist/index.d.mts

@@ -102,12 +102,10 @@ interface ObjectContent extends ObjectRef {
  * Tree discovery query for hierarchical browsing
  */
 interface TreeQuery {
-    /** Package to browse (e.g., '$TMP', 'ZPACKAGE') */
+    /** Package to browse (e.g., '$TMP', 'ZSNAP_F01'). Omit to get top-level packages only. */
     package?: string;
-    /** Folder type to expand */
-    folderType?: 'PACKAGE' | 'TYPE' | 'GROUP' | 'API';
-    /** Parent path for nested queries */
-    parentPath?: string;
+    /** Path within the package for drilling down (e.g., 'CORE_DATA_SERVICES/DATA_DEFINITIONS') */
+    path?: string;
 }
 /**
  * Data preview query
@@ -159,11 +157,11 @@ type ErrorCode = 'AUTH_FAILED' | 'SESSION_EXPIRED' | 'SESSION_NOT_FOUND' | 'CSRF
  * }
  * // data is guaranteed non-null
  */
-type Result<T, E = Error> = [T, null] | [null, E];
+type Result<T, E extends Error = Error> = [T, null] | [null, E];
 /**
  * Async result type alias for convenience
  */
-type AsyncResult<T, E = Error> = Promise<Result<T, E>>;
+type AsyncResult<T, E extends Error = Error> = Promise<Result<T, E>>;
 /**
  * Create a success result
  */
@@ -171,7 +169,7 @@ declare function ok<T>(value: T): Result<T, never>;
 /**
  * Create an error result
  */
-declare function err<E = Error>(error: E): Result<never, E>;
+declare function err<E extends Error = Error>(error: E): Result<never, E>;
 
 /**
  * Session management type definitions
@@ -258,27 +256,42 @@ interface ActivationMessage {
 }
 
 /**
- * Tree — Hierarchical tree browsing for packages
+ * Tree types — Public and internal type definitions
  */
-
-/**
- * Tree node for hierarchical browsing
- */
-interface TreeNode {
+interface TreeResponse {
+    packages: PackageNode[];
+    folders: FolderNode[];
+    objects: ObjectNode[];
+}
+interface PackageNode {
+    name: string;
+    description?: string;
+    numContents: number;
+}
+interface FolderNode {
     name: string;
-    type: 'folder' | 'object';
-    objectType?: string;
-    extension?: string;
-    hasChildren?: boolean;
-    children?: TreeNode[];
+    displayName: string;
+    numContents: number;
 }
+interface ApiState {
+    useInCloudDevelopment: boolean;
+    useInCloudDvlpmntActive: boolean;
+    useInKeyUserApps: boolean;
+}
+interface ObjectNode {
+    name: string;
+    objectType: string;
+    extension: string;
+    apiState?: ApiState;
+}
+
 /**
- * Package info
+ * Packages — List available packages
  */
+
 interface Package {
     name: string;
     description?: string;
-    parentPackage?: string;
 }
 
 /**
@@ -466,7 +479,7 @@ interface DiffResult {
  * - Automatic retry on 403 CSRF errors
  * - Session reset on 500 errors
  *
- * Uses web standard APIs (fetch, Request, Response) - runtime-agnostic.
+ * Uses Node.js https module for all HTTP requests (works reliably with mTLS).
  */
 
 interface ADTClient {
@@ -481,7 +494,8 @@ interface ADTClient {
     activate(objects: ObjectRef[]): AsyncResult<ActivationResult[]>;
     delete(objects: ObjectRef[], transport?: string): AsyncResult<void>;
     getPackages(filter?: string): AsyncResult<Package[]>;
-    getTree(query: TreeQuery): AsyncResult<TreeNode[]>;
+    getTree(query: TreeQuery): AsyncResult<TreeResponse>;
+    getPackageStats(packageName: string): AsyncResult<PackageNode>;
     getTransports(packageName: string): AsyncResult<Transport[]>;
     previewData(query: PreviewSQL): AsyncResult<DataFrame>;
     getDistinctValues(objectName: string, parameters: Parameter[], column: string, objectType?: 'table' | 'view'): AsyncResult<DistinctResult>;
@@ -494,4 +508,4 @@ interface ADTClient {
 }
 declare function createClient(config: ClientConfig): Result<ADTClient, Error>;
 
-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 };
+export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type ApiState, 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 FolderNode, type ListFilter, 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 SearchResult, type Session, type Sorting, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeQuery, type TreeResponse, type UpsertResult, buildSQLQuery, createClient, err, ok };

package/dist/index.d.ts

@@ -102,12 +102,10 @@ interface ObjectContent extends ObjectRef {
  * Tree discovery query for hierarchical browsing
  */
 interface TreeQuery {
-    /** Package to browse (e.g., '$TMP', 'ZPACKAGE') */
+    /** Package to browse (e.g., '$TMP', 'ZSNAP_F01'). Omit to get top-level packages only. */
     package?: string;
-    /** Folder type to expand */
-    folderType?: 'PACKAGE' | 'TYPE' | 'GROUP' | 'API';
-    /** Parent path for nested queries */
-    parentPath?: string;
+    /** Path within the package for drilling down (e.g., 'CORE_DATA_SERVICES/DATA_DEFINITIONS') */
+    path?: string;
 }
 /**
  * Data preview query
@@ -159,11 +157,11 @@ type ErrorCode = 'AUTH_FAILED' | 'SESSION_EXPIRED' | 'SESSION_NOT_FOUND' | 'CSRF
  * }
  * // data is guaranteed non-null
  */
-type Result<T, E = Error> = [T, null] | [null, E];
+type Result<T, E extends Error = Error> = [T, null] | [null, E];
 /**
  * Async result type alias for convenience
  */
-type AsyncResult<T, E = Error> = Promise<Result<T, E>>;
+type AsyncResult<T, E extends Error = Error> = Promise<Result<T, E>>;
 /**
  * Create a success result
  */
@@ -171,7 +169,7 @@ declare function ok<T>(value: T): Result<T, never>;
 /**
  * Create an error result
  */
-declare function err<E = Error>(error: E): Result<never, E>;
+declare function err<E extends Error = Error>(error: E): Result<never, E>;
 
 /**
  * Session management type definitions
@@ -258,27 +256,42 @@ interface ActivationMessage {
 }
 
 /**
- * Tree — Hierarchical tree browsing for packages
+ * Tree types — Public and internal type definitions
  */
-
-/**
- * Tree node for hierarchical browsing
- */
-interface TreeNode {
+interface TreeResponse {
+    packages: PackageNode[];
+    folders: FolderNode[];
+    objects: ObjectNode[];
+}
+interface PackageNode {
+    name: string;
+    description?: string;
+    numContents: number;
+}
+interface FolderNode {
     name: string;
-    type: 'folder' | 'object';
-    objectType?: string;
-    extension?: string;
-    hasChildren?: boolean;
-    children?: TreeNode[];
+    displayName: string;
+    numContents: number;
 }
+interface ApiState {
+    useInCloudDevelopment: boolean;
+    useInCloudDvlpmntActive: boolean;
+    useInKeyUserApps: boolean;
+}
+interface ObjectNode {
+    name: string;
+    objectType: string;
+    extension: string;
+    apiState?: ApiState;
+}
+
 /**
- * Package info
+ * Packages — List available packages
  */
+
 interface Package {
     name: string;
     description?: string;
-    parentPackage?: string;
 }
 
 /**
@@ -466,7 +479,7 @@ interface DiffResult {
  * - Automatic retry on 403 CSRF errors
  * - Session reset on 500 errors
  *
- * Uses web standard APIs (fetch, Request, Response) - runtime-agnostic.
+ * Uses Node.js https module for all HTTP requests (works reliably with mTLS).
  */
 
 interface ADTClient {
@@ -481,7 +494,8 @@ interface ADTClient {
     activate(objects: ObjectRef[]): AsyncResult<ActivationResult[]>;
     delete(objects: ObjectRef[], transport?: string): AsyncResult<void>;
     getPackages(filter?: string): AsyncResult<Package[]>;
-    getTree(query: TreeQuery): AsyncResult<TreeNode[]>;
+    getTree(query: TreeQuery): AsyncResult<TreeResponse>;
+    getPackageStats(packageName: string): AsyncResult<PackageNode>;
     getTransports(packageName: string): AsyncResult<Transport[]>;
     previewData(query: PreviewSQL): AsyncResult<DataFrame>;
     getDistinctValues(objectName: string, parameters: Parameter[], column: string, objectType?: 'table' | 'view'): AsyncResult<DistinctResult>;
@@ -494,4 +508,4 @@ interface ADTClient {
 }
 declare function createClient(config: ClientConfig): Result<ADTClient, Error>;
 
-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 };
+export { type ADTClient, type ActivationMessage, type ActivationResult, type Aggregation, type ApiResponse, type ApiState, 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 FolderNode, type ListFilter, 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 SearchResult, type Session, type Sorting, type SsoAuthConfig, type SuccessResponse, type Transport, type TransportConfig, type TreeQuery, type TreeResponse, type UpsertResult, buildSQLQuery, createClient, err, ok };