@aerokit/sdk 12.44.0

package/dist/dts/platform/workspace.d.ts

@@ -0,0 +1,421 @@
+/**
+ * @class Workspace
+ * @description Represents a logical container for projects, providing static methods for
+ * high-level workspace management and instance methods for project management within the workspace.
+ */
+export declare class Workspace {
+    /**
+     * Creates a new workspace with the given name.
+     *
+     * @param {string} name The name of the workspace to create.
+     * @returns {Workspace} The newly created Workspace instance.
+     */
+    static createWorkspace(name: string): Workspace;
+    /**
+     * Retrieves an existing workspace by name.
+     *
+     * @param {string} name The name of the workspace to retrieve.
+     * @returns {Workspace} The Workspace instance.
+     */
+    static getWorkspace(name: string): Workspace;
+    /**
+     * Retrieves the names of all existing workspaces.
+     *
+     * @returns {string[]} An array of workspace names.
+     */
+    static getWorkspacesNames(): string[];
+    /**
+     * Deletes the workspace with the specified name.
+     *
+     * @param {string} name The name of the workspace to delete.
+     */
+    static deleteWorkspace(name: string): void;
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object instance representing the workspace.
+     */
+    constructor(native: any);
+    /**
+     * Gets a collection of all projects within this workspace.
+     *
+     * @returns {Projects} A Projects collection instance.
+     */
+    getProjects(): Projects;
+    /**
+     * Creates a new project within this workspace.
+     *
+     * @param {string} name The name of the project to create.
+     * @returns {Project} The newly created Project instance.
+     */
+    createProject(name: string): Project;
+    /**
+     * Retrieves an existing project by name from this workspace.
+     *
+     * @param {string} name The name of the project to retrieve.
+     * @returns {Project} The Project instance.
+     */
+    getProject(name: string): Project;
+    /**
+     * Deletes a project from this workspace by name.
+     *
+     * @param {string} name The name of the project to delete.
+     */
+    deleteProject(name: string): void;
+    /**
+     * Checks if the workspace currently exists.
+     *
+     * @returns {boolean} True if the workspace exists, false otherwise.
+     */
+    exists(): boolean;
+    /**
+     * Checks if a specific folder path exists within the workspace's filesystem structure.
+     *
+     * @param {string} path The relative path to the folder.
+     * @returns {boolean} True if the folder exists.
+     */
+    existsFolder(path: string): boolean;
+    /**
+     * Checks if a specific file path exists within the workspace's filesystem structure.
+     *
+     * @param {string} path The relative path to the file.
+     * @returns {boolean} True if the file exists.
+     */
+    existsFile(path: string): boolean;
+    /**
+     * Copies a project from a source name to a target name within the workspace.
+     *
+     * @param {string} source The name of the project to copy.
+     * @param {string} target The name of the new project copy.
+     */
+    copyProject(source: string, target: string): void;
+    /**
+     * Moves a project from a source name to a target name (renaming it).
+     *
+     * @param {string} source The current name of the project.
+     * @param {string} target The new name/path of the project.
+     */
+    moveProject(source: string, target: string): void;
+}
+/**
+ * @class Projects
+ * @description A collection/list of projects within a workspace.
+ */
+export declare class Projects {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object representing the list of projects.
+     */
+    constructor(native: any);
+    /**
+     * Gets the number of projects in the collection.
+     * @returns {number} The size of the collection.
+     */
+    size(): number;
+    /**
+     * Gets a Project instance at the specified index.
+     * @param {number} index The index of the project.
+     * @returns {Project} The Project instance.
+     */
+    get(index: number): Project;
+}
+/**
+ * @class Project
+ * @description Represents a Project within a workspace. It provides methods for managing
+ * folders and files within the project.
+ */
+export declare class Project {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object instance representing the project.
+     */
+    constructor(native: any);
+    /**
+     * Gets the name of the project.
+     * @returns {string} The project name.
+     */
+    getName(): string;
+    /**
+     * Gets the path of the project.
+     * @returns {string} The project path (relative to the repository/workspace root).
+     */
+    getPath(): string;
+    /**
+     * Creates a new folder within the project.
+     *
+     * @param {string} path The path of the folder to create (relative to the project root).
+     * @returns {Folder} The newly created Folder instance.
+     */
+    createFolder(path: string): Folder;
+    /**
+     * Checks if the project itself exists.
+     * @returns {boolean} True if the project exists.
+     */
+    exists(): boolean;
+    /**
+     * Checks if a specific folder path exists within the project.
+     *
+     * @param {string} path The relative path to the folder.
+     * @returns {boolean} True if the folder exists.
+     */
+    existsFolder(path: string): boolean;
+    /**
+     * Retrieves a folder by its path relative to the project root.
+     *
+     * @param {string} path The relative path to the folder.
+     * @returns {Folder} The Folder instance.
+     */
+    getFolder(path: string): Folder;
+    /**
+     * Retrieves a collection of folders at a specific path.
+     *
+     * @param {string} path The path containing the folders to retrieve.
+     * @returns {Folders} The Folders collection instance.
+     */
+    getFolders(path: string): Folders;
+    /**
+     * Deletes a folder from the project.
+     *
+     * @param {string} path The path of the folder to delete (relative to the project root).
+     */
+    deleteFolder(path: string): void;
+    /**
+     * Creates a new file within the project.
+     *
+     * @param {string} path The path of the file to create (relative to the project root).
+     * @param {any[]} [input=[]] Optional initial content as a byte array.
+     * @returns {File} The newly created File instance.
+     */
+    createFile(path: string, input?: any[]): File;
+    /**
+     * Checks if a specific file path exists within the project.
+     *
+     * @param {string} path The relative path to the file.
+     * @returns {boolean} True if the file exists.
+     */
+    existsFile(path: string): boolean;
+    /**
+     * Retrieves a file by its path relative to the project root.
+     *
+     * @param {string} path The relative path to the file.
+     * @returns {File} The File instance.
+     */
+    getFile(path: string): File;
+    /**
+     * Retrieves a collection of files at a specific path.
+     *
+     * @param {string} path The path containing the files to retrieve.
+     * @returns {Files} The Files collection instance.
+     */
+    getFiles(path: string): Files;
+    /**
+     * Deletes a file from the project.
+     *
+     * @param {string} path The path of the file to delete (relative to the project root).
+     */
+    deleteFile(path: string): void;
+}
+/**
+ * @class Folders
+ * @description A collection/list of folders.
+ */
+export declare class Folders {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object representing the list of folders.
+     */
+    constructor(native: any);
+    /**
+     * Gets the number of folders in the collection.
+     * @returns {number} The size of the collection.
+     */
+    size(): number;
+    /**
+     * Gets a Folder instance at the specified index.
+     * @param {number} index The index of the folder.
+     * @returns {Folder} The Folder instance.
+     */
+    get(index: number): Folder;
+}
+/**
+ * @class Files
+ * @description A collection/list of files.
+ */
+export declare class Files {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object representing the list of files.
+     */
+    constructor(native: any);
+    /**
+     * Gets the number of files in the collection.
+     * @returns {number} The size of the collection.
+     */
+    size(): number;
+    /**
+     * Gets a File instance at the specified index.
+     * @param {number} index The index of the file.
+     * @returns {File} The File instance.
+     */
+    get(index: number): File;
+}
+/**
+ * @class Folder
+ * @description Represents a directory or folder within a project, providing methods for
+ * managing sub-folders and files.
+ */
+export declare class Folder {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object instance representing the folder.
+     */
+    constructor(native: any);
+    /**
+     * Gets the name of the folder.
+     * @returns {string} The folder name.
+     */
+    getName(): string;
+    /**
+     * Gets the full path of the folder.
+     * @returns {string} The folder path.
+     */
+    getPath(): string;
+    /**
+     * Creates a new sub-folder within this folder.
+     *
+     * @param {string} path The path of the sub-folder to create (relative to this folder).
+     * @returns {Folder} The newly created Folder instance.
+     */
+    createFolder(path: string): Folder;
+    /**
+     * Checks if the folder itself exists.
+     * @returns {boolean} True if the folder exists.
+     */
+    exists(): boolean;
+    /**
+     * Checks if a specific sub-folder path exists within this folder.
+     *
+     * @param {string} path The relative path to the sub-folder.
+     * @returns {boolean} True if the sub-folder exists.
+     */
+    existsFolder(path: string): boolean;
+    /**
+     * Retrieves a sub-folder by its path relative to this folder.
+     *
+     * @param {string} path The relative path to the sub-folder.
+     * @returns {Folder} The Folder instance.
+     */
+    getFolder(path: string): Folder;
+    /**
+     * Retrieves a collection of folders at a specific path relative to this folder.
+     *
+     * @param {string} path The path containing the folders to retrieve.
+     * @returns {Folders} The Folders collection instance.
+     */
+    getFolders(path: string): Folders;
+    /**
+     * Deletes a sub-folder from this folder.
+     *
+     * @param {string} path The path of the sub-folder to delete (relative to this folder).
+     */
+    deleteFolder(path: string): void;
+    /**
+     * Creates a new file within this folder.
+     *
+     * @param {string} path The path of the file to create (relative to this folder).
+     * @param {any[]} [input=[]] Optional initial content as a byte array.
+     * @returns {File} The newly created File instance.
+     */
+    createFile(path: string, input?: any[]): File;
+    /**
+     * Checks if a specific file path exists within this folder.
+     *
+     * @param {string} path The relative path to the file.
+     * @returns {boolean} True if the file exists.
+     */
+    existsFile(path: string): boolean;
+    /**
+     * Retrieves a file by its path relative to this folder.
+     *
+     * @param {string} path The relative path to the file.
+     * @returns {File} The File instance.
+     */
+    getFile(path: string): File;
+    /**
+     * Retrieves a collection of files at a specific path relative to this folder.
+     *
+     * @param {string} path The path containing the files to retrieve.
+     * @returns {Files} The Files collection instance.
+     */
+    getFiles(path: string): Files;
+    /**
+     * Deletes a file from this folder.
+     *
+     * @param {string} path The path of the file to delete (relative to this folder).
+     */
+    deleteFile(path: string): void;
+}
+/**
+ * @class File
+ * @description Represents a file (resource) within the workspace, providing methods for
+ * content access and manipulation.
+ */
+export declare class File {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object instance representing the file.
+     */
+    constructor(native: any);
+    /**
+     * Gets the name of the file.
+     * @returns {string} The file name.
+     */
+    getName(): string;
+    /**
+     * Gets the full path of the file.
+     * @returns {string} The file path.
+     */
+    getPath(): string;
+    /**
+     * Gets the content type (MIME type) of the file.
+     * @returns {string} The content type string.
+     */
+    getContentType(): string;
+    /**
+     * Checks if the file content is determined to be binary.
+     * @returns {boolean} True if binary, false if text.
+     */
+    isBinary(): boolean;
+    /**
+     * Gets the content of the file as a JavaScript-friendly byte array.
+     * @returns {any[]} The content bytes.
+     */
+    getContent(): any[];
+    /**
+     * Gets the content of the file as a text string.
+     * @returns {string} The text content.
+     */
+    getText(): string;
+    /**
+     * Sets the content of the file using a byte array.
+     * @param {any[]} input The new content bytes.
+     */
+    setContent(input: any[]): void;
+    /**
+     * Sets the content of the file using a text string.
+     * The string is converted to a byte array before saving.
+     * @param {string} input The new text content.
+     */
+    setText(input: string): void;
+    /**
+     * Checks if the file exists.
+     * @returns {boolean} True if the file exists.
+     */
+    exists(): boolean;
+}

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

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

package/dist/dts/qldb/qldb.d.ts

@@ -0,0 +1 @@
+export declare const QLDBRepository: any;

package/dist/dts/rabbitmq/consumer.d.ts

@@ -0,0 +1,25 @@
+/**
+ * RabbitMQ Consumer
+ *
+ * This facade provides static methods to start and stop listening on RabbitMQ queues,
+ * wrapping the underlying Java implementation provided by the `RabbitMQFacade`.
+ */
+export declare class Consumer {
+    /**
+     * Starts listening for messages on a specified RabbitMQ queue.
+     * The handler is typically a service or script URI that will be executed
+     * when a message arrives.
+     *
+     * @param queue The name of the RabbitMQ queue to listen to.
+     * @param handler The URI/name of the component/script that will handle the message.
+     */
+    static startListening(queue: string, handler: string): void;
+    /**
+     * Stops the message listener previously started on a specified RabbitMQ queue
+     * for a given handler.
+     *
+     * @param queue The name of the RabbitMQ queue.
+     * @param handler The URI/name of the component/script whose listener should be stopped.
+     */
+    static stopListening(queue: string, handler: string): void;
+}

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

@@ -0,0 +1,4 @@
+export * from "./consumer";
+export { Consumer as consumer } from "./consumer";
+export * from "./producer";
+export { Producer as producer } from "./producer";

package/dist/dts/rabbitmq/producer.d.ts

@@ -0,0 +1,15 @@
+/**
+ * RabbitMQ Producer
+ *
+ * This facade provides a static method to send messages to a RabbitMQ queue,
+ * wrapping the underlying Java implementation provided by the `RabbitMQFacade`.
+ */
+export declare class Producer {
+    /**
+     * Sends a message to the specified RabbitMQ queue.
+     *
+     * @param queue The name of the RabbitMQ queue to send the message to.
+     * @param message The content of the message to be sent (as a string).
+     */
+    static send(queue: string, message: string): void;
+}

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

@@ -0,0 +1,134 @@
+/**
+ * Redis Client
+ *
+ * This class serves as a facade for common Redis operations, providing a convenient
+ * JavaScript interface that wraps the underlying Java Redis client implementation.
+ */
+export declare class Client {
+    private readonly native;
+    /**
+     * Initializes the Redis Client and retrieves the native client instance
+     * from the Redis Facade.
+     */
+    constructor();
+    /**
+     * Appends a value to the value of a key. If the key does not exist,
+     * it is created and set to the initial value.
+     *
+     * @param key The key to append to.
+     * @param value The value string to append.
+     * @returns The length of the string after the append operation.
+     */
+    append(key: string, value: string): number;
+    /**
+     * Counts the number of set bits (1s) in the string value of a key.
+     *
+     * @param key The key to perform the bitcount on.
+     * @returns The number of set bits.
+     */
+    bitcount(key: string): number;
+    /**
+     * Decrements the number stored at key by one.
+     *
+     * @param key The key holding the numeric value.
+     * @returns The value of key after the decrement.
+     */
+    decr(key: string): number;
+    /**
+     * Deletes the specified key.
+     *
+     * @param key The key to delete.
+     * @returns The number of keys that were removed (1 if successful, 0 otherwise).
+     */
+    del(key: string): number;
+    /**
+     * Checks if the specified key exists.
+     *
+     * @param key The key to check.
+     * @returns True if the key exists, false otherwise.
+     */
+    exists(key: string): boolean;
+    /**
+     * Gets the value of the specified key.
+     *
+     * @param key The key to retrieve the value for.
+     * @returns The value of the key, or null if the key does not exist.
+     */
+    get(key: string): string;
+    /**
+     * Increments the number stored at key by one.
+     *
+     * @param key The key holding the numeric value.
+     * @returns The value of key after the increment.
+     */
+    incr(key: string): number;
+    /**
+     * Finds all keys matching the given pattern.
+     *
+     * @param pattern The pattern to match keys against (e.g., "user:*").
+     * @returns An array of matching keys.
+     */
+    keys(pattern: string): string[];
+    /**
+     * Sets the string value of a key.
+     *
+     * @param key The key to set.
+     * @param value The string value to assign to the key.
+     * @returns 'OK' on success.
+     */
+    set(key: string, value: string): string;
+    /**
+     * Gets an element from a list by its zero-based index.
+     *
+     * @param key The key of the list.
+     * @param index The zero-based index (0 is the first element, -1 is the last).
+     * @returns The element at the specified index, or null if the index is out of range.
+     */
+    lindex(key: string, index: number): string;
+    /**
+     * Gets the length of the list stored at the key.
+     *
+     * @param key The key of the list.
+     * @returns The length of the list.
+     */
+    llen(key: string): number;
+    /**
+     * Removes and returns the first element of the list stored at the key (Left POP).
+     *
+     * @param key The key of the list.
+     * @returns The first element of the list, or null when the list is empty.
+     */
+    lpop(key: string): string;
+    /**
+     * Inserts all specified values at the head of the list stored at the key (Left PUSH).
+     *
+     * @param key The key of the list.
+     * @param value One or more values to prepend to the list.
+     * @returns The new length of the list.
+     */
+    lpush(key: string, ...value: string[]): any;
+    /**
+     * Returns the specified elements of the list stored at the key.
+     *
+     * @param key The key of the list.
+     * @param start The starting zero-based offset.
+     * @param stop The stopping zero-based offset.
+     * @returns An array of elements in the specified range.
+     */
+    lrange(key: string, start: number, stop: number): string[];
+    /**
+     * Removes and returns the last element of the list stored at the key (Right POP).
+     *
+     * @param key The key of the list.
+     * @returns The last element of the list, or null when the list is empty.
+     */
+    rpop(key: string): string;
+    /**
+     * Inserts all specified values at the tail of the list stored at the key (Right PUSH).
+     *
+     * @param key The key of the list.
+     * @param value One or more values to append to the list.
+     * @returns The new length of the list.
+     */
+    rpush(key: string, ...value: string[]): number;
+}

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

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

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

@@ -0,0 +1,4 @@
+/**
+ * @param {string[]} roles
+ */
+export declare function Roles(roles: any): (target: any, _context: any) => any;

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

@@ -0,0 +1,5 @@
+export * from "./user";
+export { User as user } from "./user";
+export * from "./oauth";
+export * from "./decorators";
+export * as decorators from "./decorators";

package/dist/dts/security/oauth.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Configuration structure for the OAuth client.
+ */
+export interface OAuthClientConfig {
+    /** The URL endpoint for the OAuth token service (e.g., '/oauth/token'). */
+    readonly url: string;
+    /** The client ID for authentication. */
+    readonly clientId: string;
+    /** The client secret for authentication. */
+    readonly clientSecret: string;
+    /** The grant type to be used. Defaults to 'client_credentials'. */
+    readonly grantType?: string;
+}
+/**
+ * A client class for fetching OAuth access tokens.
+ *
+ * It uses the HTTP client to send a POST request with client credentials
+ * to the specified token endpoint.
+ */
+export declare class OAuthClient {
+    private config;
+    /**
+     * Initializes the OAuthClient with the required configuration.
+     * Sets 'client_credentials' as the default grant type if none is provided.
+     *
+     * @param config The configuration object containing URL, client ID, and secret.
+     */
+    constructor(config: OAuthClientConfig);
+    /**
+     * Executes the OAuth token request and returns the parsed response.
+     *
+     * The request uses the client credentials grant type (default) and
+     * sends credentials as URL-encoded parameters in the body.
+     *
+     * @returns A parsed JSON object containing the OAuth token (e.g., { access_token: string, expires_in: number, ... }).
+     * @throws {Error} If the HTTP status code is not 200.
+     */
+    getToken(): any;
+}