@aerokit/sdk 12.44.0

package/dist/dts/db/translator.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Provides static methods for translating entity properties based on a dedicated language table.
+ * Translation is achieved by querying a separate table (e.g., 'BASE_TABLE_LANG') and merging
+ * the translated fields back into the original data.
+ */
+export declare class Translator {
+    /**
+     * Translates properties for a list of entities by querying the corresponding language table.
+     *
+     * @param list The array of entities to be translated.
+     * @param language The target language code (e.g., 'en', 'de'). If undefined, no translation occurs.
+     * @param basetTable The name of the base entity table (used to derive the language table name).
+     * @returns The translated array of entities.
+     */
+    static translateList(list: any[], language: string | undefined, basetTable: string): any[];
+    /**
+     * Translates properties for a single entity by querying the corresponding language table.
+     *
+     * @param entity The entity object to be translated.
+     * @param id The ID of the entity.
+     * @param language The target language code (e.g., 'en', 'de'). If undefined, no translation occurs.
+     * @param basetTable The name of the base entity table.
+     * @returns The translated entity object.
+     */
+    static translateEntity(entity: any, id: string | number, language: string | undefined, basetTable: string): any;
+}

package/dist/dts/db/update.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Interface used for complex parameter types if needed, otherwise primitive types are used directly.
+ */
+export interface UpdateParameter {
+    readonly value: any;
+}
+/**
+ * Facade class for executing SQL UPDATE, INSERT, and DELETE statements.
+ */
+export declare class Update {
+    /**
+     * Executes a parameterized SQL update statement (INSERT, UPDATE, or DELETE).
+     *
+     * @param sql The SQL statement to execute.
+     * @param parameters Optional array of parameters to bind to the SQL statement (replaces '?').
+     * These are serialized to JSON before being passed to the native API.
+     * @param datasourceName Optional name of the data source to use. Defaults to the primary data source.
+     * @returns The number of rows affected by the statement.
+     */
+    static execute(sql: string, parameters?: (string | number | boolean | Date | UpdateParameter)[], datasourceName?: string): number;
+}

package/dist/dts/etcd/client.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Represents the header metadata of an Etcd response.
+ */
+export declare class Header {
+    private readonly native;
+    constructor(native: any);
+    /** The revision of the key-value store when the request was processed. */
+    getRevision(): string;
+    /** The ID of the cluster which the request was sent to. */
+    getClusterId(): string;
+    /** The ID of the member which the request was handled by. */
+    getMemberId(): string;
+    /** The Raft term. */
+    getRaftTerm(): string;
+}
+/**
+ * Represents the response object for a Get operation from Etcd.
+ */
+export declare class GetResponse {
+    private readonly native;
+    constructor(native: any);
+    /** Retrieves the response header containing cluster metadata. */
+    getHeader(): Header;
+    /** Retrieves the Key-Value pairs with values converted to strings. */
+    getKvsString(): {
+        [key: string]: string;
+    };
+    /** Retrieves the Key-Value pairs with values converted to Int8Array (byte arrays). */
+    getKvsByteArray(): {
+        [key: string]: Int8Array;
+    };
+    /** Retrieves the number of Key-Value pairs returned. */
+    getCount(): number;
+}
+/**
+ * Client facade for interacting with the Etcd key-value store.
+ */
+export declare class Client {
+    private readonly native;
+    constructor();
+    /**
+     * Executes a blocking GET request on the specified key.
+     * @param key The key to retrieve.
+     * @returns The processed GetResponse object.
+     */
+    private get;
+    /**
+     * Puts (writes) a string value to the specified key.
+     * @param key The key to write to.
+     * @param value The string value.
+     */
+    putStringValue(key: string, value: string): void;
+    /**
+     * Puts (writes) a byte array value to the specified key.
+     * @param key The key to write to.
+     * @param value The Int8Array (byte array) value.
+     */
+    putByteArrayValue(key: string, value: Int8Array): void;
+    /**
+     * Retrieves the response header metadata for a key.
+     * @param key The key to query.
+     * @returns The {@link Header} object.
+     */
+    getHeader(key: string): Header;
+    /**
+     * Retrieves the Key-Value pairs as a JavaScript object with string values.
+     * @param key The key (or key prefix) to query.
+     * @returns An object mapping keys to string values.
+     */
+    getKvsStringValue(key: string): {
+        [key: string]: string;
+    };
+    /**
+     * Retrieves the Key-Value pairs as a JavaScript object with Int8Array values.
+     * @param key The key (or key prefix) to query.
+     * @returns An object mapping keys to Int8Array values.
+     */
+    getKvsByteArrayValue(key: string): {
+        [key: string]: Int8Array;
+    };
+    /**
+     * Retrieves the count of Key-Value pairs matching the key (or key prefix).
+     * @param key The key (or key prefix) to query.
+     * @returns The count of matching entries.
+     */
+    getCount(key: string): number;
+    /**
+     * Deletes the specified key.
+     * @param key The key to delete.
+     */
+    delete(key: string): void;
+}

package/dist/dts/etcd/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export { Client as client } from "./client";

package/dist/dts/extensions/decorators.d.ts

@@ -0,0 +1,11 @@
+export interface ExtensionOptions {
+    name: string;
+    to: string;
+}
+/**
+ * @Extension decorator
+ * Marks an entire class as a extension
+ *
+ * introduced in TypeScript 5.0, which expects a ClassDecoratorContext object.
+ */
+export declare function Extension(options: ExtensionOptions): <T extends abstract new (...args: any) => any>(target: T, context: ClassDecoratorContext<T>) => void;

package/dist/dts/extensions/extensions.d.ts

@@ -0,0 +1,41 @@
+/**
+ * API Extensions
+ *
+ */
+/**
+ * Provides functionality for discovering and loading extensions defined
+ * against the Dirigible extension model.
+ */
+export declare class Extensions {
+    /**
+     * Retrieves the list of extension module paths registered for a specific extension point.
+     *
+     * @param extensionPoint The unique identifier of the extension point (e.g., "my.extension.point").
+     * @returns An array of string paths (modules) registered for the given extension point.
+     */
+    static getExtensions(extensionPoint: string): string[];
+    /**
+     * Retrieves all available extension point identifiers.
+     *
+     * @returns An array of strings representing all registered extension point IDs.
+     */
+    static getExtensionPoints(): string[];
+    /**
+     * Loads extension modules registered for a specific extension point.
+     * It handles both synchronous (require) and asynchronous (import) loading.
+     *
+     * @param extensionPoint The unique identifier of the extension point.
+     * @param requiredFunctions An optional list of function names that the extension module must export to be included.
+     * @param throwError If true, throws an error on failure; otherwise, logs the error and continues.
+     * @returns A Promise that resolves to an array of successfully loaded and validated extension modules (exports).
+     */
+    static loadExtensionModules(extensionPoint: string, requiredFunctions?: string[], throwError?: boolean): Promise<any[]>;
+    /**
+     * Logs an error to the console and optionally throws an exception.
+     * @param throwError If true, an exception is thrown.
+     * @param errorData The data/message to log and/or use for the error message.
+     */
+    private static logError;
+    /** Alias for loadExtensionModules */
+    static load(extensionPoint: string, requiredFunctions?: string[], throwError?: boolean): Promise<any[]>;
+}

package/dist/dts/extensions/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./extensions";
+export { Extensions as extensions } from "./extensions";
+export * as decorators from "./decorators";
+export * from "./decorators";

package/dist/dts/git/client.d.ts

@@ -0,0 +1,478 @@
+/**
+ * Describes a file within the workspace, potentially with Git status information.
+ */
+export interface FileDescriptor {
+    name: string;
+    path: string;
+    contentType: string;
+    status: string;
+}
+/**
+ * Describes a folder within the workspace, potentially with Git status information.
+ */
+export interface FolderDescriptor {
+    name: string;
+    path: string;
+    status: string;
+    folders: FolderDescriptor[];
+    files: FileDescriptor[];
+}
+/**
+ * Describes a Git-managed project/repository in the workspace.
+ */
+export interface ProjectDescriptor {
+    name: string;
+    path: string;
+    git: boolean;
+    gitName: string;
+    folders: FolderDescriptor[];
+    files: FileDescriptor[];
+}
+/**
+ * Describes a single Git commit.
+ */
+export interface GitCommitInfo {
+    id: string;
+    author: string;
+    emailAddress: string;
+    dateTime: string;
+    message: string;
+}
+/**
+ * Describes a Git branch (local or remote).
+ */
+export interface GitBranch {
+    name: string;
+    remote: boolean;
+    current: boolean;
+    commitObjectId: string;
+    commitShortId: string;
+    commitDate: string;
+    commitMessage: string;
+    commitAuthor: string;
+}
+/**
+ * Describes a file that has been changed (staged or unstaged).
+ */
+export interface GitChangedFile {
+    path: string;
+    type: number;
+}
+/**
+* The IGitConnector provides the simplified methods for communicating with a Git SCM server.
+* This interface is primarily implemented by the object returned from the native Java facade.
+*/
+export interface GitConnector {
+    /**
+     * Gets the origin urls.
+     *
+     * @returns An object containing the fetch and push URLs.
+     */
+    getOriginUrls(): {
+        fetchUrl: string;
+        pushUrl: string;
+    };
+    /**
+     * Sets the fetch url.
+     *
+     * @param fetchUrl The new fetch URL.
+     * @throws URISyntaxException, GitAPIException
+     */
+    setFetchUrl(fetchUrl: string): void;
+    /**
+     * Sets the push url.
+     *
+     * @param pushUrl The new push URL.
+     * @throws URISyntaxException, GitAPIException
+     */
+    setPushUrl(pushUrl: string): void;
+    /**
+     * Adds file(s) to the staging index.
+     *
+     * @param filePattern File to add content from. Example: "." includes all files.
+     * @throws IOException, NoFilepatternException, GitAPIException
+     */
+    add(filePattern: string): void;
+    /**
+     * Adds deleted file(s) to the staging index.
+     *
+     * @param filePattern File to add content from. Example: "." includes all files.
+     * @throws IOException, NoFilepatternException, GitAPIException
+     */
+    addDeleted(filePattern: string): void;
+    /**
+     * Remove from the index.
+     *
+     * @param path The path to be removed.
+     * @throws IOException, NoFilepatternException, GitAPIException
+     */
+    remove(path: string): void;
+    /**
+     * Revert to head revision.
+     *
+     * @param path The path to be reverted.
+     * @throws IOException, NoFilepatternException, GitAPIException
+     */
+    revert(path: string): void;
+    /**
+     * Adds changes to the staging index, then performs a commit.
+     *
+     * @param message The commit message.
+     * @param name The name of the committer.
+     * @param email The email of the committer.
+     * @param all If true, automatically stages modified and deleted files.
+     * @throws Various Git exceptions
+     */
+    commit(message: string, name: string, email: string, all: boolean): void;
+    /**
+     * Creates new branch from a particular start point.
+     *
+     * @param name The new branch name.
+     * @param startPoint Valid tree-ish object (e.g., "master", "HEAD", commit hash).
+     * @throws RefAlreadyExistsException, GitAPIException
+     */
+    createBranch(name: string, startPoint: string): void;
+    /**
+     * Deletes the branch.
+     *
+     * @param name The branch name to delete.
+     * @throws RefAlreadyExistsException, GitAPIException
+     */
+    deleteBranch(name: string): void;
+    /**
+     * Renames the branch.
+     *
+     * @param oldName The old branch name.
+     * @param newName The new branch name.
+     * @throws RefAlreadyExistsException, GitAPIException
+     */
+    renameBranch(oldName: string, newName: string): void;
+    /**
+     * Creates new remote branch from a particular start point.
+     *
+     * @param name The branch name.
+     * @param startPoint Valid tree-ish object.
+     * @param username Username for the remote repository.
+     * @param password Password for the remote repository.
+     * @throws RefAlreadyExistsException, GitAPIException
+     */
+    createRemoteBranch(name: string, startPoint: string, username: string, password: string): void;
+    /**
+     * Deletes the remote branch.
+     *
+     * @param name The name of the remote branch to delete.
+     * @param username Username for the remote repository.
+     * @param password Password for the remote repository.
+     * @throws RefAlreadyExistsException, GitAPIException
+     */
+    deleteRemoteBranch(name: string, username: string, password: string): void;
+    /**
+     * Checkout to a valid tree-ish object (e.g., branch name, commit hash).
+     *
+     * @param name The tree-ish object.
+     * @returns The JGit Ref object.
+     * @throws RefAlreadyExistsException, GitAPIException
+     */
+    checkout(name: string): any;
+    /**
+     * Hard reset the repository. Resets working directory and staging index to match the Git repository HEAD.
+     *
+     * @throws CheckoutConflictException, GitAPIException
+     */
+    hardReset(): void;
+    /**
+     * Fetches from a remote repository and tries to merge into the current branch (Pull).
+     *
+     * @throws Various Git exceptions
+     */
+    pull(): void;
+    /**
+     * Fetches from a remote repository and tries to merge into the current branch (Pull).
+     *
+     * @param username Username for the remote repository.
+     * @param password Password for the remote repository.
+     * @throws Various Git exceptions
+     */
+    pull(username: string, password: string): void;
+    /**
+     * Pushes the committed changes to the remote repository.
+     *
+     * @param username Username for the remote repository.
+     * @param password Password for the remote repository.
+     * @throws InvalidRemoteException, TransportException, GitAPIException
+     */
+    push(username: string, password: string): void;
+    /**
+     * Tries to rebase the selected branch on top of the current one.
+     *
+     * @param name The branch to rebase.
+     * @throws NoHeadException, WrongRepositoryStateException, GitAPIException
+     */
+    rebase(name: string): void;
+    /**
+     * Get the current status of the Git repository.
+     *
+     * @returns The JGit Status object.
+     * @throws NoWorkTreeException, GitAPIException
+     */
+    status(): any;
+    /**
+     * Get the name of the current branch of the Git repository.
+     *
+     * @returns The branch name as a string.
+     * @throws IOException
+     */
+    getBranch(): string;
+    /**
+     * List all the local branches info.
+     *
+     * @returns A list of local {@link GitBranch} objects.
+     * @throws GitConnectorException
+     */
+    getLocalBranches(): GitBranch[];
+    /**
+     * List all the remote branches info.
+     *
+     * @returns A list of remote {@link GitBranch} objects.
+     * @throws GitConnectorException
+     */
+    getRemoteBranches(): GitBranch[];
+    /**
+     * Get the list of the unstaged files.
+     *
+     * @returns A list of {@link GitChangedFile} objects.
+     * @throws GitConnectorException
+     */
+    getUnstagedChanges(): GitChangedFile[];
+    /**
+     * Get the list of the staged files.
+     *
+     * @returns A list of {@link GitChangedFile} objects.
+     * @throws GitConnectorException
+     */
+    getStagedChanges(): GitChangedFile[];
+    /**
+     * Get file content from the HEAD.
+     *
+     * @param path The file path.
+     * @param revStr The revision string (e.g., commit hash, branch name).
+     * @returns The content of the file as a string.
+     * @throws GitConnectorException
+     */
+    getFileContent(path: string, revStr: string): string;
+    /**
+     * Get history of the repository or a specific file.
+     *
+     * @param path The file path or null to get the entire repository history.
+     * @returns A list of {@link GitCommitInfo} objects.
+     * @throws GitConnectorException
+     */
+    getHistory(path: string): GitCommitInfo[];
+}
+/**
+ * Static client facade for workspace-level Git operations, abstracting the native GitFacade.
+ */
+export declare class Client {
+    /**
+     * Initializes a new Git repository for a project, performs an initial commit, and pushes.
+     *
+     * @param user The username of the committer.
+     * @param email The email address of the committer.
+     * @param workspaceName The name of the workspace.
+     * @param projectName The name of the project.
+     * @param repositoryName The name of the repository (where to put the git folder).
+     * @param commitMessage The initial commit message.
+     */
+    static initRepository(user: string, email: string, workspaceName: string, projectName: string, repositoryName: string, commitMessage: string): void;
+    /**
+     * Performs a commit in the specified repository.
+     *
+     * @param user The username of the committer.
+     * @param email The email address of the committer.
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param commitMessage The commit message.
+     * @param all If true, automatically stages modified and deleted files before committing.
+     */
+    static commit(user: string, email: string, workspaceName: string, repositoryName: string, commitMessage: string, all: boolean): void;
+    /**
+     * Retrieves a list of all Git repositories (projects) within the specified workspace.
+     *
+     * @param workspaceName The name of the workspace.
+     * @returns An array of {@link ProjectDescriptor} objects.
+     */
+    static getGitRepositories(workspaceName: string): ProjectDescriptor[];
+    /**
+     * Retrieves the commit history for the specified repository or a specific file path within it.
+     *
+     * @param repositoryName The name of the repository.
+     * @param workspaceName The name of the workspace.
+     * @param path The file path for history, or null/empty string for full repository history.
+     * @returns An array of {@link GitCommitInfo} objects.
+     */
+    static getHistory(repositoryName: string, workspaceName: string, path: string): GitCommitInfo[];
+    /**
+     * Deletes the specified Git repository.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository to delete.
+     */
+    static deleteRepository(workspaceName: string, repositoryName: string): void;
+    /**
+     * Clones a remote repository into the local workspace.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryUri The URI of the remote repository.
+     * @param username The username for authentication.
+     * @param password The password for authentication.
+     * @param branch The specific branch to checkout after cloning.
+     * @returns A GitConnector instance for interacting directly with the cloned repository.
+     */
+    static cloneRepository(workspaceName: string, repositoryUri: string, username: string, password: string, branch: string): GitConnector;
+    /**
+     * Pulls changes from the remote repository and attempts to merge them into the current branch.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param username The username for authentication.
+     * @param password The password for authentication.
+     */
+    static pull(workspaceName: string, repositoryName: string, username: string, password: string): void;
+    /**
+     * Pushes the local commits to the remote repository.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param username The username for authentication.
+     * @param password The password for authentication.
+     */
+    static push(workspaceName: string, repositoryName: string, username: string, password: string): void;
+    /**
+     * Checks out a specific branch, commit, or tag in the repository.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param branch The branch or tree-ish object to check out.
+     */
+    static checkout(workspaceName: string, repositoryName: string, branch: string): void;
+    /**
+     * Creates a new branch starting from a specified point (e.g., HEAD, a commit hash, or another branch).
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param branch The name of the new branch to create.
+     * @param startingPoint The tree-ish object to start the new branch from.
+     */
+    static createBranch(workspaceName: string, repositoryName: string, branch: string, startingPoint: string): void;
+    /**
+     * Deletes a local branch.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param branch The name of the branch to delete.
+     */
+    static deleteBranch(workspaceName: string, repositoryName: string, branch: string): void;
+    /**
+     * Renames a local branch.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param oldName The current name of the branch.
+     * @param newName The new name for the branch.
+     */
+    static renameBranch(workspaceName: string, repositoryName: string, oldName: string, newName: string): void;
+    /**
+     * Creates a new remote branch on the Git server.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param branch The name of the remote branch to create.
+     * @param startingPoint The tree-ish object to start the new remote branch from.
+     * @param username The username for authentication.
+     * @param password The password for authentication.
+     */
+    static createRemoteBranch(workspaceName: string, repositoryName: string, branch: string, startingPoint: string, username: string, password: string): void;
+    /**
+     * Deletes a remote branch on the Git server.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param branch The name of the remote branch to delete.
+     * @param username The username for authentication.
+     * @param password The password for authentication.
+     */
+    static deleteRemoteBranch(workspaceName: string, repositoryName: string, branch: string, username: string, password: string): void;
+    /**
+     * Resets the repository, discarding all uncommitted changes in the working directory and index.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     */
+    static hardReset(workspaceName: string, repositoryName: string): void;
+    /**
+     * Reapplies commits from the specified branch onto the current branch.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param branch The branch to rebase.
+     */
+    static rebase(workspaceName: string, repositoryName: string, branch: string): void;
+    /**
+     * Retrieves the current status of the repository (staged, unstaged, untracked files).
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @returns A string representation of the repository status.
+     */
+    static status(workspaceName: string, repositoryName: string): string;
+    /**
+     * Retrieves the name of the currently active branch.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @returns The name of the current branch.
+     */
+    static getBranch(workspaceName: string, repositoryName: string): string;
+    /**
+     * Retrieves a list of all local branches in the repository.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @returns An array of {@link GitBranch} objects representing local branches.
+     */
+    static getLocalBranches(workspaceName: string, repositoryName: string): GitBranch[];
+    /**
+     * Retrieves a list of all remote branches configured for the repository.
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @returns An array of {@link GitBranch} objects representing remote branches.
+     */
+    static getRemoteBranches(workspaceName: string, repositoryName: string): GitBranch[];
+    /**
+     * Retrieves a list of all unstaged files (changes not yet added to the index).
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @returns An array of {@link GitChangedFile} objects.
+     */
+    static getUnstagedChanges(workspaceName: string, repositoryName: string): GitChangedFile[];
+    /**
+     * Retrieves a list of all staged files (changes added to the index, ready for commit).
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @returns An array of {@link GitChangedFile} objects.
+     */
+    static getStagedChanges(workspaceName: string, repositoryName: string): GitChangedFile[];
+    /**
+     * Retrieves the content of a file at a specific revision (commit, branch, or tag).
+     *
+     * @param workspaceName The name of the workspace.
+     * @param repositoryName The name of the repository.
+     * @param filePath The path to the file.
+     * @param revStr The revision string (e.g., commit hash or branch name).
+     * @returns The content of the file as a string.
+     */
+    static getFileContent(workspaceName: string, repositoryName: string, filePath: string, revStr: string): string;
+}

package/dist/dts/git/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./client";
+export { Client as client } from "./client";