buildx-connect/dist/Buildx.d.ts

Official JavaScript/TypeScript SDK for Buildx low-code platform

import { BuildxConfig } from "./types";
import { Auth } from "./services/Auth";
import { Projects } from "./services/Projects";
import { Collections } from "./services/Collections";
import { Storage } from "./services/Storage";
import { Flows } from "./services/Flows";
import { Templates } from "./services/Templates";
import { Functions } from "./services/Functions";
import { BuildxObjects } from "./services/BuildxObjects";
import { ApiKeys } from "./services/ApiKeys";
/**
 * Main Buildx SDK class
 *
 * @example
 * ```typescript
 * import { Buildx } from 'buildx-connect';
 *
 * const buildx = new Buildx({
 *   apiEndpoint: 'https://api.buildx.com',
 *   apiKey: 'your-api-key',
 *   projectId: 'your-project-id'
 * });
 *
 * // Use different services
 * const auth = buildx.auth();
 * const projects = buildx.projects();
 * const collections = buildx.collections();
 * ```
 */
export declare class Buildx {
    private config;
    private _auth;
    private _projects;
    private _collections;
    private _storage;
    private _flows;
    private _templates;
    private _functions;
    private _buildxObjects;
    private _apiKeys;
    constructor(config: BuildxConfig);
    /**
     * Get the current configuration
     */
    getConfig(): BuildxConfig;
    /**
     * Update the configuration
     */
    updateConfig(config: Partial<BuildxConfig>): void;
    /**
     * Authentication service
     * Handles user authentication, login, signup, and user management
     */
    auth(): Auth;
    /**
     * Projects service
     * Manages projects, including CRUD operations
     */
    projects(): Projects;
    /**
     * Collections service
     * Manages data collections, documents, and queries
     */
    collections(): Collections;
    /**
     * Storage service
     * Handles file upload, download, and management
     */
    storage(): Storage;
    /**
     * Flows service
     * Manages workflow execution and flow types
     */
    flows(): Flows;
    /**
     * Templates service
     * Handles template rendering and preview
     */
    templates(): Templates;
    /**
     * Functions service
     * Manages serverless functions
     */
    functions(): Functions;
    /**
     * Buildx Objects service
     * Manages Buildx-specific objects (users, roles, etc.)
     */
    buildxObjects(): BuildxObjects;
    /**
     * API Keys service
     * Manages API key operations
     */
    apiKeys(): ApiKeys;
}
export default Buildx;