@aerokit/sdk 12.44.0

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

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

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

@@ -0,0 +1,59 @@
+/**
+ * Provides an API for producing (sending) messages to JMS-style destinations,
+ * supporting both Queues (point-to-point) and Topics (publish/subscribe).
+ */
+/**
+ * The entry point for creating messaging producers.
+ * Use this class to obtain instances of Queue or Topic producers for sending messages.
+ */
+export declare class Producer {
+    /**
+     * Creates a Queue producer instance for point-to-point messaging.
+     * Messages sent to this destination are intended to be consumed by a single receiver.
+     *
+     * @param destination The name of the queue destination (e.g., 'task.queue').
+     * @returns A {@link Queue} instance.
+     */
+    static queue(destination: string): Queue;
+    /**
+     * Creates a Topic producer instance for publish/subscribe messaging.
+     * Messages sent to this destination can be consumed by multiple subscribers simultaneously.
+     *
+     * @param destination The name of the topic destination (e.g., 'sensor.data.topic').
+     * @returns A {@link Topic} instance.
+     */
+    static topic(destination: string): Topic;
+}
+/**
+ * Represents a producer for a Queue destination (point-to-point).
+ */
+declare class Queue {
+    private destination;
+    /**
+     * @param destination The name of the queue destination.
+     */
+    constructor(destination: string);
+    /**
+     * Sends a message to the configured queue destination.
+     *
+     * @param message The content of the message to send (typically a string or serialized object).
+     */
+    send(message: string): void;
+}
+/**
+ * Represents a producer for a Topic destination (publish/subscribe).
+ */
+declare class Topic {
+    private destination;
+    /**
+     * @param destination The name of the topic destination.
+     */
+    constructor(destination: string);
+    /**
+     * Sends a message to the configured topic destination. All active subscribers will receive the message.
+     *
+     * @param message The content of the message to publish (typically a string or serialized object).
+     */
+    send(message: string): void;
+}
+export {};

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

@@ -0,0 +1,367 @@
+/**
+ * Define a common type for input to functions that accept either a plain JavaScript object
+ * (which will be implicitly converted to DBObject) or an existing DBObject wrapper instance.
+ */
+type DBInput = {
+    [key: string]: any;
+} | DBObject | undefined | null;
+/**
+ * DBObject object represents a BSON document used for queries, insertions, and updates.
+ * It wraps the underlying native Java object.
+ */
+export declare class DBObject {
+    /**
+     * The underlying native Java object representing the BSON document.
+     * @private
+     */
+    native: any;
+    /**
+     * Constructs a new DBObject instance.
+     * @param native The native MongoDB object (e.g., com.mongodb.DBObject)
+     */
+    constructor(native: any);
+    /**
+     * Appends a key-value pair to the DBObject.
+     * @param key The field name.
+     * @param value The value to append.
+     * @returns The current DBObject instance for chaining.
+     */
+    append(key: string, value: any): DBObject;
+    /**
+     * Converts the DBObject to a standard JavaScript object representation (JSON).
+     * @returns A plain JavaScript object.
+     */
+    toJson(): {
+        [key: string]: any;
+    };
+    /**
+     * Marks the object as a partial object (used internally by MongoDB driver).
+     */
+    markAsPartialObject(): void;
+    /**
+     * Checks if the object is a partial object.
+     * @returns True if partial, false otherwise.
+     */
+    isPartialObject(): boolean;
+    /**
+     * Checks if the DBObject contains a field with the specified key.
+     * @param key The field name.
+     * @returns True if the field exists, false otherwise.
+     */
+    containsField(key: string): boolean;
+    /**
+     * Gets the value associated with the given key.
+     * @param key The field name.
+     * @returns The field value.
+     */
+    get(key: string): any;
+    /**
+     * Puts a key-value pair into the DBObject.
+     * @param key The field name.
+     * @param value The value to put.
+     * @returns The previous value associated with the key, or null.
+     */
+    put(key: string, value: any): any;
+    /**
+     * Removes a field from the DBObject.
+     * @param key The field name to remove.
+     * @returns The removed field value.
+     */
+    removeField(key: string): any;
+}
+/**
+ * Creates a new, empty DBObject instance.
+ * @returns A new DBObject.
+ */
+export declare function createBasicDBObject(): DBObject;
+/**
+ * Client object wrapper for connecting to MongoDB.
+ */
+export declare class Client {
+    /**
+     * The underlying native MongoDB client object.
+     * @private
+     */
+    private readonly native;
+    /**
+     * Constructs a new MongoDB Client instance.
+     * @param uri The MongoDB connection URI.
+     * @param user The username for authentication.
+     * @param password The password for authentication.
+     */
+    constructor(uri: string, user: string, password: string);
+    /**
+     * Retrieves a database instance.
+     * @param name Optional name of the database. If not provided, the default database name is used.
+     * @returns A DB instance.
+     */
+    getDB(name?: string): DB;
+}
+/**
+ * DB object wrapper for a MongoDB database.
+ */
+export declare class DB {
+    /**
+     * The underlying native MongoDB DB object.
+     * @private
+     */
+    private readonly native;
+    /**
+     * Constructs a new DB instance.
+     * @param native The native MongoDB DB object.
+     */
+    constructor(native: any);
+    /**
+     * Retrieves a collection instance from the database.
+     * @param name The name of the collection.
+     * @returns A DBCollection instance.
+     */
+    getCollection(name: string): DBCollection;
+}
+/**
+ * DBCollection object wrapper for a MongoDB collection.
+ */
+export declare class DBCollection {
+    /**
+     * The underlying native MongoDB DBCollection object.
+     * @private
+     */
+    private readonly native;
+    /**
+     * Constructs a new DBCollection instance.
+     * @param native The native MongoDB DBCollection object.
+     */
+    constructor(native: any);
+    /**
+     * Inserts a document into the collection.
+     * @param dbObject The document to insert (can be a plain JS object or DBObject).
+     */
+    insert(dbObject: DBInput): void;
+    /**
+     * Finds documents matching the query.
+     * @param query The query specification (can be a plain JS object or DBObject).
+     * @param projection The fields to include or exclude (can be a plain JS object or DBObject).
+     * @returns A DBCursor for iterating over results.
+     */
+    find(query?: DBInput, projection?: DBInput): DBCursor;
+    /**
+     * Finds a single document matching the query.
+     * @param query The query specification.
+     * @param projection The fields to include or exclude.
+     * @param sort The sorting specification.
+     * @returns The found document as a DBObject.
+     */
+    findOne(query: DBInput, projection: DBInput, sort: DBInput): DBObject;
+    /**
+     * Finds a single document by its string ID.
+     * @param id The string ID of the document.
+     * @param projection The fields to include or exclude.
+     * @returns The found document as a DBObject.
+     */
+    findOneById(id: string, projection?: DBInput): DBObject;
+    /**
+     * Counts the number of documents in the collection, optionally filtered by a query.
+     * @param query Optional query to filter the count.
+     * @returns The number of documents.
+     */
+    count(query?: DBInput): number;
+    /**
+     * Gets the count of documents (alias for count).
+     * @param query Optional query to filter the count.
+     * @returns The number of documents.
+     */
+    getCount(query: DBInput): number;
+    /**
+     * Creates an index on the collection.
+     * @param keys The index key specification.
+     * @param options Optional index options.
+     */
+    createIndex(keys: DBInput, options: DBInput): void;
+    /**
+     * Creates an index on a single field by name.
+     * @param name The name of the field to index.
+     */
+    createIndexForField(name: string): void;
+    /**
+     * Retrieves the distinct values for a specified field across a collection.
+     * NOTE: The signature in the original code seems slightly off compared to typical MongoDB drivers.
+     * This implementation follows the original structure using `keys.native` if `keys` is provided.
+     * @param name The field name.
+     * @param query Optional query to filter results.
+     * @param keys Optional keys to use for distinct (replaces 'name' if provided and query exists).
+     */
+    distinct(name: string, query: DBInput, keys: DBInput): void;
+    /**
+     * Drops a specified index.
+     * @param index The name of the index or the DBObject representing the index keys.
+     */
+    dropIndex(index: string | DBInput): void;
+    /**
+     * Drops a specified index by name.
+     * @param name The name of the index.
+     */
+    dropIndexByName(name: string): void;
+    /**
+     * Drops all indexes on the collection.
+     */
+    dropIndexes(): void;
+    /**
+     * Removes documents from the collection matching the query.
+     * @param query The deletion query specification.
+     */
+    remove(query: DBInput): void;
+    /**
+     * Renames the collection.
+     * @param newName The new name for the collection.
+     */
+    rename(newName: string): void;
+    /**
+     * Saves a document to the collection. If the document has an `_id`, it performs an update;
+     * otherwise, it performs an insert.
+     * @param dbObject The document to save.
+     */
+    save(dbObject: DBInput): void;
+    /**
+     * Updates documents in the collection matching the query.
+     * @param query The update query specification.
+     * @param update The update operation specification (e.g., {$set: {...}}).
+     * @param upsert If true, creates a new document if no documents match the query.
+     * @param multi If true, updates all documents matching the query; otherwise, only one.
+     */
+    update(query: DBInput, update: DBInput, upsert?: boolean, multi?: boolean): void;
+    /**
+     * Updates multiple documents in the collection matching the query.
+     * (Equivalent to calling `update` with `multi=true` and `upsert=true` implicitly).
+     * @param query The update query specification.
+     * @param update The update operation specification.
+     */
+    updateMulti(query: DBInput, update: DBInput): void;
+    /**
+     * Calculates the next sequential ID based on the largest existing `_id` in the collection.
+     * Assumes `_id` is a numeric field.
+     * @returns The next available sequential ID (starting at 1 if collection is empty).
+     */
+    getNextId(): number;
+    /**
+     * Generates a new random UUID (Universally Unique Identifier).
+     * @returns A string representing the UUID.
+     */
+    generateUUID(): string;
+}
+/**
+ * DBCursor object wrapper for iterating over results of a MongoDB query.
+ */
+export declare class DBCursor {
+    /**
+     * The underlying native MongoDB DBCursor object.
+     * @private
+     */
+    private readonly native;
+    /**
+     * Constructs a new DBCursor instance.
+     * @param native The native MongoDB DBCursor object.
+     */
+    constructor(native: any);
+    /**
+     * Returns the single result from the cursor.
+     * @returns A DBObject representing the document.
+     */
+    one(): DBObject;
+    /**
+     * Sets the batch size for the cursor.
+     * @param numberOfElements The batch size.
+     * @returns The DBCursor instance for chaining.
+     */
+    batchSize(numberOfElements: number): DBCursor;
+    /**
+     * Gets the current batch size.
+     * @returns The batch size.
+     */
+    getBatchSize(): number;
+    /**
+     * Gets the collection associated with this cursor.
+     * @returns The DBCollection instance.
+     */
+    getCollection(): DBCollection;
+    /**
+     * Gets the cursor ID.
+     * @returns The cursor ID string.
+     */
+    getCursorId(): string;
+    /**
+     * Gets the projection object (fields wanted) used in the query.
+     * @returns The projection DBObject.
+     */
+    getKeysWanted(): DBObject;
+    /**
+     * Gets the limit set on the cursor.
+     * @returns The limit number.
+     */
+    getLimit(): number;
+    /**
+     * Closes the cursor.
+     */
+    close(): void;
+    /**
+     * Checks if there is a next document in the cursor.
+     * @returns True if there is a next document, false otherwise.
+     */
+    hasNext(): boolean;
+    /**
+     * Retrieves the next document in the cursor.
+     * @returns The next document as a DBObject.
+     */
+    next(): DBObject;
+    /**
+     * Gets the query object used to create this cursor.
+     * @returns The query DBObject.
+     */
+    getQuery(): DBObject;
+    /**
+     * Gets the number of documents matched by the query.
+     * @returns The total number of documents.
+     */
+    length(): number;
+    /**
+     * Specifies the order in which the query returns the results.
+     * @param orderBy The sorting specification (e.g., {field: 1} for ascending).
+     * @returns The DBCursor instance for chaining.
+     */
+    sort(orderBy: DBInput): DBCursor;
+    /**
+     * Limits the number of results to be returned.
+     * @param limit The maximum number of documents to return.
+     * @returns The DBCursor instance for chaining.
+     */
+    limit(limit: number): DBCursor;
+    /**
+     * Specifies the exclusive upper bound for a specific index.
+     * @param min The minimum value.
+     * @returns The DBCursor instance for chaining.
+     */
+    min(min: number): DBCursor;
+    /**
+     * Specifies the exclusive upper bound for a specific index.
+     * @param max The maximum value.
+     * @returns The DBCursor instance for chaining.
+     */
+    max(max: number): DBCursor;
+    /**
+     * Sets a timeout for the server to execute the query.
+     * @param maxTime The maximum time in milliseconds.
+     * @returns The DBCursor instance for chaining.
+     */
+    maxTime(maxTime: number): DBCursor;
+    /**
+     * Gets the size of the result set.
+     * @returns The size number.
+     */
+    size(): number;
+    /**
+     * Skips the specified number of documents.
+     * @param numberOfElements The number of documents to skip.
+     * @returns The DBCursor instance for chaining.
+     */
+    skip(numberOfElements: number): DBCursor;
+}
+export {};

package/dist/dts/mongodb/dao.d.ts

@@ -0,0 +1,24 @@
+export declare class DAO {
+    private orm;
+    $log: any;
+    constructor(orm: any, logCtxName?: string);
+    notify(event: any, ...a: any[]): void;
+    createNoSQLEntity(entity: any): any;
+    validateEntity(entity: any, skip: any): void;
+    insert(_entity: any): any;
+    update(entity: any): this;
+    remove(id: any): void;
+    expand(expansionPath: any, context: any): void;
+    find(id: any, expand: any, select: any): any;
+    count(): number;
+    list(settings: any): any[];
+    existsTable(): boolean;
+    createTable(): void;
+    dropTable(): DAO;
+}
+/**
+ * oDefinition can be table definition or standard orm definition object. Or it can be a valid path to
+ * a .table file, or any other text file contianing a standard dao orm definition.
+ */
+export declare function create(oDefinition: any, logCtxName: any, dataSourceName: any, databaseType: any): DAO;
+export declare function dao(oDefinition: any, logCtxName: any, dataSourceName: any, databaseType: any): DAO;

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

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

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

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

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

@@ -0,0 +1,6 @@
+export * from "./soap";
+export { SOAP as soap } from "./soap";
+export * from "./websockets";
+export { Websockets as websockets } from "./websockets";
+export * as decorators from "./decorators";
+export * from "./decorators";

package/dist/dts/net/soap.d.ts

@@ -0,0 +1,115 @@
+import { InputStream } from "@aerokit/sdk/io/streams";
+/**
+ * Utility class for creating, parsing, and calling SOAP messages.
+ * It wraps the underlying Java javax.xml.soap API.
+ */
+export declare class SOAP {
+    /**
+     * Call a given SOAP endpoint with a given request message
+     * @param message The SOAP Message wrapper object.
+     * @param url The target SOAP endpoint URL.
+     */
+    static call(message: Message, url: string): Message;
+    static trustAll(): void;
+    /**
+     * Creates a new, empty SOAP message.
+     */
+    static createMessage(): Message;
+    /**
+     * Parses a SOAP message from an InputStream and MimeHeaders.
+     * @param mimeHeaders The MimeHeaders wrapper object.
+     * @param inputStream The InputStream wrapper object.
+     */
+    static parseMessage(mimeHeaders: MimeHeaders, inputStream: InputStream): Message;
+    /**
+     * Parses a SOAP message from the current HTTP request input stream.
+     */
+    static parseRequest(): Message;
+    /**
+     * Creates a new, empty MimeHeaders object.
+     */
+    static createMimeHeaders(): MimeHeaders;
+}
+/**
+ * SOAP Message Wrapper
+ */
+declare class Message {
+    readonly native: any;
+    constructor(native: any);
+    getPart(): Part;
+    getMimeHeaders(): MimeHeaders;
+    save(): void;
+    getText(): string;
+}
+/**
+ * SOAP Part Wrapper
+ */
+declare class Part {
+    private readonly native;
+    constructor(native: any);
+    getEnvelope(): Envelope;
+}
+/**
+ * SOAP Mime Headers Wrapper
+ */
+declare class MimeHeaders {
+    readonly native: any;
+    constructor(native: any);
+    addHeader(name: string, value: string): void;
+    addBasicAuthenticationHeader(username: string, password: string): void;
+}
+/**
+ * SOAP Envelope Wrapper
+ */
+declare class Envelope {
+    private readonly native;
+    constructor(native: any);
+    addNamespaceDeclaration(prefix: string, uri: string): void;
+    getBody(): Body;
+    getHeader(): Header;
+    createName(localName: string, prefix: string, uri: string): Name;
+}
+/**
+ * SOAP Body Wrapper
+ */
+declare class Body {
+    private readonly native;
+    constructor(native: any);
+    addChildElement(localName: string, prefix: string): Element;
+    getChildElements(): Element[];
+}
+/**
+ * SOAP Header Wrapper
+ */
+declare class Header {
+    private readonly native;
+    constructor(native: any);
+    addHeaderElement(element: Element): void;
+}
+/**
+ * SOAP Name Wrapper
+ */
+declare class Name {
+    private readonly native;
+    constructor(native: any);
+    getNative(): string;
+    getLocalName(): string;
+    getPrefix(): string;
+    getQualifiedName(): string;
+    getURI(): string;
+}
+/**
+ * SOAP Element Wrapper
+ */
+declare class Element {
+    readonly native: any;
+    constructor(native: any);
+    addChildElement(localName: string, prefix: string): Element;
+    addTextNode(text: string): Element;
+    addAttribute(name: Name, value: any): Element;
+    getChildElements(): Element[];
+    getElementName(): Name | undefined;
+    getValue(): any;
+    isSOAPElement(): boolean;
+}
+export {};

package/dist/dts/net/websockets.d.ts

@@ -0,0 +1,100 @@
+/**
+ * @class Websockets
+ * @description Static utility class for accessing and managing WebSocket functionality.
+ */
+export declare class Websockets {
+    /**
+     * Creates a new WebSocket client connection to a specified URI, managed by a handler script.
+     *
+     * @param uri The target WebSocket URI (e.g., 'ws://example.com/socket').
+     * @param handler The identifier or path of the script handling the WebSocket events.
+     * @returns A wrapper object for the new WebSocket session.
+     */
+    static createWebsocket(uri: string, handler: string): WebsocketClient;
+    /**
+     * Retrieves a list of all active WebSocket clients.
+     *
+     * @returns An array of objects detailing the URI and handler of each client.
+     */
+    static getClients(): {
+        uri: string;
+        handler: string;
+    }[];
+    /**
+     * Retrieves a specific WebSocket client wrapper by its session ID.
+     *
+     * @param id The session ID of the client.
+     * @returns The client wrapper or undefined if not found.
+     */
+    static getClient(id: string): WebsocketClient | undefined;
+    /**
+     * Retrieves a specific WebSocket client wrapper by its handler identifier.
+     *
+     * @param handler The handler identifier associated with the client.
+     * @returns The client wrapper or undefined if not found.
+     */
+    static getClientByHandler(handler: string): WebsocketClient | undefined;
+    /**
+     * Retrieves the message payload from the current context, typically used inside an 'onmessage' handler.
+     *
+     * @returns The message content.
+     */
+    static getMessage(): any;
+    /**
+     * Retrieves error details from the current context, typically used inside an 'onerror' handler.
+     *
+     * @returns The error object or string.
+     */
+    static getError(): any;
+    /**
+     * Retrieves the event method name that triggered the current script execution (e.g., "onopen", "onmessage").
+     *
+     * @returns The name of the event method.
+     */
+    static getMethod(): string;
+    /**
+     * Checks if the current event context is 'onopen'.
+     * @returns True if the method is 'onopen'.
+     */
+    static isOnOpen(): boolean;
+    /**
+     * Checks if the current event context is 'onmessage'.
+     * @returns True if the method is 'onmessage'.
+     */
+    static isOnMessage(): boolean;
+    /**
+     * Checks if the current event context is 'onerror'.
+     * @returns True if the method is 'onerror'.
+     */
+    static isOnError(): boolean;
+    /**
+     * Checks if the current event context is 'onclose'.
+     * @returns True if the method is 'onclose'.
+     */
+    static isOnClose(): boolean;
+}
+/**
+ * @class WebsocketClient
+ * @description Wrapper for a native WebSocket session, providing methods to send and close the connection.
+ */
+declare class WebsocketClient {
+    private readonly _session;
+    private readonly uri;
+    private readonly handler;
+    /**
+     * @param session The native Java session object.
+     * @param uri The connected URI.
+     * @param handler The handler identifier.
+     */
+    constructor(session: null | any, uri: string, handler: string);
+    /**
+     * Sends a text message over the WebSocket connection.
+     * @param text The message to send.
+     */
+    send(text: string): void;
+    /**
+     * Closes the WebSocket connection.
+     */
+    close(): void;
+}
+export {};