@aerokit/sdk 12.44.0

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

@@ -0,0 +1,354 @@
+/**
+ * @class Repository
+ * @description Static utility class providing high-level methods for interacting with the
+ * repository facade to manage resources and collections by path.
+ */
+export declare class Repository {
+    /**
+     * Retrieves a resource (file) object from the repository by its path.
+     *
+     * @param {string} path The absolute path to the resource.
+     * @returns {Resource} A Resource instance wrapping the native repository object.
+     */
+    static getResource(path: string): Resource;
+    /**
+     * Creates a new resource (file) with content provided as a string.
+     *
+     * @param {string} path The absolute path where the resource should be created.
+     * @param {string} content The string content for the resource.
+     * @param {string} contentType The MIME type of the content (e.g., "text/plain").
+     * @returns {Resource} The newly created Resource instance.
+     */
+    static createResource(path: string, content: string, contentType: string): Resource;
+    /**
+     * Creates a new resource (file) with content provided as a native byte array.
+     *
+     * @param {string} path The absolute path where the resource should be created.
+     * @param {any[]} content The native byte array content.
+     * @param {string} contentType The MIME type of the content.
+     * @returns {Resource} The newly created Resource instance.
+     */
+    static createResourceNative(path: string, content: any[], contentType: string): Resource;
+    /**
+     * Updates the content of an existing resource using a string.
+     *
+     * @param {string} path The absolute path to the resource to update.
+     * @param {string} content The new string content.
+     * @returns {Resource} The updated Resource instance.
+     */
+    static updateResource(path: string, content: string): Resource;
+    /**
+     * Updates the content of an existing resource using a native byte array.
+     *
+     * @param {string} path The absolute path to the resource to update.
+     * @param {any[]} content The new native byte array content.
+     * @returns {Resource} The updated Resource instance.
+     */
+    static updateResourceNative(path: string, content: any[]): Resource;
+    /**
+     * Deletes the resource (file) at the specified path.
+     *
+     * @param {string} path The absolute path of the resource to delete.
+     */
+    static deleteResource(path: string): void;
+    /**
+     * Retrieves a collection (folder) object from the repository by its path.
+     *
+     * @param {string} path The absolute path to the collection.
+     * @returns {Collection} A Collection instance wrapping the native repository object.
+     */
+    static getCollection(path: string): Collection;
+    /**
+     * Creates a new collection (folder) at the specified path.
+     *
+     * @param {string} path The absolute path where the collection should be created.
+     * @returns {Collection} The newly created Collection instance.
+     */
+    static createCollection(path: string): Collection;
+    /**
+     * Deletes the collection (folder) at the specified path.
+     *
+     * @param {string} path The absolute path of the collection to delete.
+     */
+    static deleteCollection(path: string): void;
+    /**
+     * Searches the repository starting from a given path for resources matching a glob pattern.
+     *
+     * @param {string} path The starting path for the search.
+     * @param {string} pattern The glob pattern to match resource names against (e.g., "*.js").
+     * @returns {string[]} An array of repository paths (strings) that match the search criteria.
+     */
+    static find(path: string, pattern: string): string[];
+}
+/**
+ * @class Resource
+ * @description Represents a file or resource (non-collection) within the Repository,
+ * providing instance methods for file operations.
+ */
+export declare class Resource {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object instance representing the repository resource.
+     */
+    constructor(native: any);
+    /**
+     * Gets the name of the resource (file name).
+     * @returns {string} The name.
+     */
+    getName(): string;
+    /**
+     * Gets the full repository path of the resource.
+     * @returns {string} The repository path.
+     */
+    getPath(): string;
+    /**
+     * Gets the parent collection (folder) of this resource.
+     * @returns {Collection} The parent Collection instance.
+     */
+    getParent(): Collection;
+    /**
+     * Gets detailed metadata about the resource.
+     * @returns {EntityInformation} The metadata object.
+     */
+    getInformation(): EntityInformation;
+    /**
+     * Creates the resource if it does not already exist.
+     */
+    create(): void;
+    /**
+     * Deletes the resource from the repository.
+     */
+    delete(): void;
+    /**
+     * Renames the resource within its current collection.
+     * @param {string} name The new name for the resource.
+     */
+    renameTo(name: string): void;
+    /**
+     * Moves the resource to a new path.
+     * @param {string} path The new absolute path for the resource.
+     */
+    moveTo(path: string): void;
+    /**
+     * Copies the resource to a new path.
+     * @param {string} path The new absolute path for the copied resource.
+     */
+    copyTo(path: string): void;
+    /**
+     * Checks if the resource currently exists in the repository.
+     * @returns {boolean} True if the resource exists, false otherwise.
+     */
+    exists(): boolean;
+    /**
+     * Checks if the resource (file) is empty (has zero size).
+     * @returns {boolean} True if the content is empty, false otherwise.
+     */
+    isEmpty(): boolean;
+    /**
+     * Gets the content of the resource as a text string.
+     * @returns {string} The text content.
+     */
+    getText(): string;
+    /**
+     * Gets the content of the resource as a JavaScript-friendly byte array.
+     * @returns {any[]} The content bytes.
+     */
+    getContent(): any[];
+    /**
+     * Gets the content of the resource as its native Java byte array representation.
+     * @returns {any[]} The content bytes.
+     */
+    getContentNative(): any[];
+    /**
+     * Sets the content of the resource using a text string.
+     * The string is converted to a byte array before saving.
+     * @param {string} text The new text content.
+     */
+    setText(text: string): void;
+    /**
+     * Sets the content of the resource using a JavaScript byte array.
+     * The array is converted to a native byte array before saving.
+     * @param {any[]} content The new content bytes.
+     */
+    setContent(content: any[]): void;
+    /**
+     * Sets the content of the resource using a native Java byte array.
+     * @param {any[]} content The new native content bytes.
+     */
+    setContentNative(content: any[]): void;
+    /**
+     * Checks if the resource content is determined to be binary.
+     * @returns {boolean} True if binary, false if text.
+     */
+    isBinary(): boolean;
+    /**
+     * Gets the content type (MIME type) of the resource.
+     * @returns {string} The content type string.
+     */
+    getContentType(): string;
+}
+/**
+ * @class Collection
+ * @description Represents a directory or folder within the Repository, providing
+ * instance methods for collection and resource management.
+ */
+export declare class Collection {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object instance representing the repository collection.
+     */
+    constructor(native: any);
+    /**
+     * Gets the name of the collection (folder name).
+     * @returns {string} The name.
+     */
+    getName(): string;
+    /**
+     * Gets the full repository path of the collection.
+     * @returns {string} The repository path.
+     */
+    getPath(): string;
+    /**
+     * Gets the parent collection (folder) of this collection.
+     * @returns {Collection} The parent Collection instance.
+     */
+    getParent(): Collection;
+    /**
+     * Gets detailed metadata about the collection.
+     * @returns {EntityInformation} The metadata object.
+     */
+    getInformation(): EntityInformation;
+    /**
+     * Creates the collection if it does not already exist.
+     */
+    create(): void;
+    /**
+     * Deletes the collection from the repository.
+     */
+    delete(): void;
+    /**
+     * Renames the collection within its current parent.
+     * @param {string} name The new name for the collection.
+     */
+    renameTo(name: string): void;
+    /**
+     * Moves the collection to a new path.
+     * @param {string} path The new absolute path for the collection.
+     */
+    moveTo(path: string): void;
+    /**
+     * Copies the collection to a new path.
+     * @param {string} path The new absolute path for the copied collection.
+     */
+    copyTo(path: string): void;
+    /**
+     * Checks if the collection currently exists in the repository.
+     * @returns {boolean} True if the collection exists, false otherwise.
+     */
+    exists(): boolean;
+    /**
+     * Checks if the collection is empty (contains no files or sub-directories).
+     * @returns {boolean} True if empty, false otherwise.
+     */
+    isEmpty(): boolean;
+    /**
+     * Gets the names of all sub-collections (folders) within this collection.
+     * @returns {string[]} An array of sub-collection names.
+     */
+    getCollectionsNames(): string[];
+    /**
+     * Creates a new sub-collection (folder) within this collection.
+     * @param {string} name The name of the new sub-collection.
+     * @returns {Collection} The newly created Collection instance.
+     */
+    createCollection(name: string): Collection;
+    /**
+     * Gets a specific sub-collection by name.
+     * @param {string} name The name of the sub-collection.
+     * @returns {Collection} The child Collection instance.
+     */
+    getCollection(name: string): Collection;
+    /**
+     * Removes a sub-collection by name.
+     * @param {string} name The name of the sub-collection to remove.
+     */
+    removeCollection(name: string): void;
+    /**
+     * Gets the names of all resources (files) within this collection.
+     * @returns {string[]} An array of resource names.
+     */
+    getResourcesNames(): string[];
+    /**
+     * Gets a specific resource (file) by name.
+     * @param {string} name The name of the resource.
+     * @returns {Resource} The child Resource instance.
+     */
+    getResource(name: string): Resource;
+    /**
+     * Removes a resource (file) by name.
+     * @param {string} name The name of the resource to remove.
+     */
+    removeResource(name: string): void;
+    /**
+     * Creates a new resource (file) within this collection.
+     * @param {string} name The name of the new resource.
+     * @param {string} content The string content for the resource.
+     * @returns {Resource} The newly created Resource instance.
+     */
+    createResource(name: string, content: string): Resource;
+}
+/**
+ * @class EntityInformation
+ * @description Represents detailed metadata (creation date, size, permissions, etc.) for a
+ * Resource or Collection.
+ */
+export declare class EntityInformation {
+    private readonly native;
+    /**
+     * @constructor
+     * @param {any} native The native Java object instance holding the entity information.
+     */
+    constructor(native: any);
+    /**
+     * Gets the name of the entity (resource or collection).
+     * @returns {string} The name.
+     */
+    getName(): string;
+    /**
+     * Gets the full repository path of the entity.
+     * @returns {string} The repository path.
+     */
+    getPath(): string;
+    /**
+     * Gets the access permissions for the entity (typically an integer bitmask).
+     * @returns {number} The permissions value.
+     */
+    getPermissions(): number;
+    /**
+     * Gets the size of the resource content in bytes (0 for a collection).
+     * @returns {number} The size in bytes.
+     */
+    getSize(): number;
+    /**
+     * Gets the user who created the entity.
+     * @returns {string} The creator's name.
+     */
+    getCreatedBy(): string;
+    /**
+     * Gets the creation timestamp.
+     * @returns {Date} The creation date and time.
+     */
+    getCreatedAt(): Date;
+    /**
+     * Gets the user who last modified the entity.
+     * @returns {string} The modifier's name.
+     */
+    getModifiedBy(): string;
+    /**
+     * Gets the last modification timestamp.
+     * @returns {Date} The modification date and time.
+     */
+    getModifiedAt(): Date;
+}