buildx-sdk 1.0.4

package/dist/services/Collections.d.ts

@@ -0,0 +1,126 @@
+import { BaseService } from "./BaseService";
+import { Collection, Document, QueryOptions, ErrorResponse, SuccessResponse, ImportMapping, PaginatedResult, CollectionRealtimeHandlers, CollectionRealtimeSubscribeOptions, CollectionRealtimeSubscription } from "../types/index";
+type UpdateDocumentOptions = {
+    updateOnly?: boolean;
+};
+/**
+ * Collections service for Buildx
+ * Handles collection management, documents, and queries
+ *
+ * @example
+ * ```typescript
+ * const collections = buildx.collections();
+ *
+ * // Get all collections
+ * const collectionsList = await collections.list();
+ *
+ * // Get collection schema
+ * const schema = await collections.getSchema('collection-id');
+ *
+ * // Query documents
+ * const docs = await collections.query('collection-id', {
+ *   filter: { status: 'active' },
+ *   limit: 10
+ * });
+ * ```
+ */
+export declare class Collections {
+    private baseService;
+    private static readonly RELATION_QUERY_CHUNK_SIZE;
+    private collectionWsClient;
+    private collectionWsCollectionId;
+    private collectionWsDisabledUntil;
+    constructor(baseService: BaseService);
+    /**
+     * List all collections in a project
+     */
+    list(withStats?: boolean, withBuildx?: boolean): Promise<Collection[] | ErrorResponse>;
+    /**
+     * Get collection schema
+     */
+    getSchema(collectionId: string, depth?: number): Promise<Collection | ErrorResponse>;
+    /**
+     * Create or update collection
+     */
+    set(collectionData: Partial<Collection>): Promise<Collection | ErrorResponse>;
+    /**
+     * Delete collection
+     */
+    deleteCollection(collectionId: string): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * Query documents in a collection
+     */
+    query(collectionId: string, options?: QueryOptions): Promise<Document[] | ErrorResponse>;
+    /**
+     * Query documents without server-side populate.
+     */
+    queryRaw(collectionId: string, options?: QueryOptions): Promise<Document[] | ErrorResponse>;
+    /**
+     * Query documents with pagination metadata.
+     */
+    queryWithPagination(collectionId: string, options?: QueryOptions): Promise<PaginatedResult<Document> | ErrorResponse>;
+    private queryWithPaginationViaHttp;
+    private queryWithPaginationViaWs;
+    private queryRawViaWs;
+    private getOrCreateCollectionWsClient;
+    private resetCollectionWsClient;
+    /**
+     * Subscribe realtime data events for a collection via SSE endpoint.
+     * Works in browser/EventSource-compatible runtimes.
+     */
+    subscribeRealtime(collectionId: string, handlers: CollectionRealtimeHandlers, options?: CollectionRealtimeSubscribeOptions): CollectionRealtimeSubscription;
+    /**
+     * Get lookup data for a collection (for dropdowns/autocomplete)
+     */
+    lookup(collectionId: string, options?: QueryOptions): Promise<Array<{
+        value: string;
+        label: string;
+    }> | ErrorResponse>;
+    private buildQueryParams;
+    private hydrateRelations;
+    /**
+     * Get single document by ID
+     */
+    getDocument(collectionId: string, documentId: string, populate?: string[]): Promise<Document | ErrorResponse>;
+    /**
+     * Create new document
+     */
+    createDocument(collectionId: string, data: any): Promise<Document | ErrorResponse>;
+    /**
+     * Update document
+     */
+    updateDocument(collectionId: string, documentId: string, data: any): Promise<Document | ErrorResponse>;
+    /**
+     * Update document with optional mode flags.
+     */
+    updateDocumentWithOptions(collectionId: string, documentId: string, data: any, options?: UpdateDocumentOptions): Promise<Document | ErrorResponse>;
+    /**
+     * Get document revisions
+     */
+    getDocumentRevisions(collectionId: string, documentId: string): Promise<Document[] | ErrorResponse>;
+    /**
+     * Delete document
+     */
+    deleteDocument(collectionId: string, documentId: string): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * Delete documents by filter
+     */
+    deleteByFilter(collectionId: string, filter: any): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * Import data to collection
+     */
+    import(collectionId: string, file: File, mapping: ImportMapping): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * Get collection data types
+     */
+    getDataTypes(): Promise<any | ErrorResponse>;
+    /**
+     * Validate collection data
+     */
+    validate(collectionId: string): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * Migrate collection data
+     */
+    migrate(collectionId: string): Promise<SuccessResponse | ErrorResponse>;
+}
+export {};

package/dist/services/Flows.d.ts

@@ -0,0 +1,41 @@
+import { BaseService } from "./BaseService";
+import { ErrorResponse } from "../types/index";
+/**
+ * Flows service for Buildx
+ * Handles flow types and running flows
+ *
+ * @example
+ * ```typescript
+ * const flows = buildx.flows();
+ *
+ * // Get flow types
+ * const types = await flows.getTypes();
+ *
+ * // Run a flow
+ * const result = await flows.run('flow-id', 'session-id', 'root', { arg1: 'value' });
+ * ```
+ */
+export declare class Flows {
+    private baseService;
+    constructor(baseService: BaseService);
+    /**
+     * Get all flow types
+     */
+    getTypes(): Promise<any | ErrorResponse>;
+    /**
+     * Run a flow
+     */
+    run(flowId: string, sessionId?: string | null, state?: any, args?: any): Promise<any | ErrorResponse>;
+    /**
+     * Get GPT flow code suggestions
+     */
+    getGptFlowSuggestions(instruction: string): Promise<any | ErrorResponse>;
+    /**
+     * Get GPT collection suggestions
+     */
+    getGptCollectionSuggestions(instruction: string): Promise<any | ErrorResponse>;
+    /**
+     * Get GPT lifecycle suggestions
+     */
+    getGptLifecycleSuggestions(instruction: string): Promise<any | ErrorResponse>;
+}

package/dist/services/Functions.d.ts

@@ -0,0 +1,40 @@
+import { BaseService } from "./BaseService";
+import { Function, FunctionLog, ErrorResponse } from "../types/index";
+/**
+ * Functions service for Buildx
+ * Handles serverless functions management
+ *
+ * @example
+ * ```typescript
+ * const functions = buildx.functions();
+ *
+ * // Get all functions
+ * const funcs = await functions.list();
+ *
+ * // Get function by name
+ * const func = await functions.getByName('function-name');
+ *
+ * // Update function
+ * await functions.update('function-name', { code: 'new code' });
+ * ```
+ */
+export declare class Functions {
+    private baseService;
+    constructor(baseService: BaseService);
+    /**
+     * List all functions in a project
+     */
+    list(): Promise<Function[] | ErrorResponse>;
+    /**
+     * Get function by name
+     */
+    getByName(functionName: string): Promise<Function | ErrorResponse>;
+    /**
+     * Update function
+     */
+    update(functionName: string, data: Partial<Function>): Promise<Function | ErrorResponse>;
+    /**
+     * Get function logs
+     */
+    getLogs(functionName: string): Promise<FunctionLog[] | ErrorResponse>;
+}

package/dist/services/Projects.d.ts

@@ -0,0 +1,55 @@
+import { BaseService } from "./BaseService";
+import { Project, ErrorResponse, SuccessResponse } from "../types/index";
+/**
+ * Projects service for Buildx
+ * Handles project management operations
+ *
+ * @example
+ * ```typescript
+ * const projects = buildx.projects();
+ *
+ * // List all projects
+ * const projectList = await projects.list();
+ *
+ * // Create a new project
+ * const newProject = await projects.create({
+ *   name: 'My Project',
+ *   description: 'A new project'
+ * });
+ *
+ * // Get project by ID
+ * const project = await projects.get('project-id');
+ * ```
+ */
+export declare class Projects {
+    private baseService;
+    constructor(baseService: BaseService);
+    /**
+     * List all projects
+     */
+    list(): Promise<Project[] | ErrorResponse>;
+    /**
+     * Get project by ID
+     */
+    get(projectId: string): Promise<Project | ErrorResponse>;
+    /**
+     * Create a new project
+     */
+    create(projectData: Partial<Project>): Promise<Project | ErrorResponse>;
+    /**
+     * Update project
+     */
+    update(projectId: string, projectData: Partial<Project>): Promise<Project | ErrorResponse>;
+    /**
+     * Delete project
+     */
+    deleteById(projectId: string): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * Backup project
+     */
+    backup(projectId: string): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * Restore project from backup
+     */
+    restore(projectId: string, file: File): Promise<SuccessResponse | ErrorResponse>;
+}

package/dist/services/Storage.d.ts

@@ -0,0 +1,44 @@
+import { BaseService } from "./BaseService";
+import { ErrorResponse, SuccessResponse } from "../types/index";
+/**
+ * Storage service for Buildx
+ * Handles file upload, download, and management
+ *
+ * @example
+ * ```typescript
+ * const storage = buildx.storage();
+ *
+ * // Upload file
+ * const result = await storage.upload(file, 'uploads/');
+ *
+ * // List files in directory
+ * const files = await storage.list('uploads/');
+ *
+ * // Delete file
+ * await storage.delete('uploads/file.txt');
+ * ```
+ */
+export declare class Storage {
+    private baseService;
+    constructor(baseService: BaseService);
+    /**
+     * Upload file to storage
+     */
+    upload(file: File, prefix?: string): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * Upload file to collection storage
+     */
+    uploadToCollection(file: File, collectionId: string, prefix?: string): Promise<SuccessResponse | ErrorResponse>;
+    /**
+     * List files in directory
+     */
+    list(path: string): Promise<any | ErrorResponse>;
+    /**
+     * Get storage size for path
+     */
+    getSize(path: string): Promise<any | ErrorResponse>;
+    /**
+     * Delete file from storage
+     */
+    delete(path: string): Promise<SuccessResponse | ErrorResponse>;
+}

package/dist/services/Templates.d.ts

@@ -0,0 +1,36 @@
+import { BaseService } from "./BaseService";
+import { ErrorResponse, SuccessResponse } from "../types/index";
+/**
+ * Templates service for Buildx
+ * Handles template rendering and preview
+ *
+ * @example
+ * ```typescript
+ * const templates = buildx.templates();
+ *
+ * // Preview a template
+ * const preview = await templates.preview('template', { name: 'John' });
+ *
+ * // Render a template
+ * const rendered = await templates.render('template-id', { name: 'John' });
+ *
+ * // Generate PDF
+ * await templates.generatePDF('template-id', data);
+ * ```
+ */
+export declare class Templates {
+    private baseService;
+    constructor(baseService: BaseService);
+    /**
+     * Preview a template with data
+     */
+    preview(template: any, data: any): Promise<any | ErrorResponse>;
+    /**
+     * Render a template by ID with data
+     */
+    render(templateId: string, data: any): Promise<any | ErrorResponse>;
+    /**
+     * Render a template as PDF and download (browser only)
+     */
+    renderPDF(templateId: string, data: any): Promise<SuccessResponse | ErrorResponse>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,256 @@
+export interface ApiHeaders {
+    "Content-Type": string;
+    "Authorization"?: string;
+    "X-API-Key": string;
+    [key: string]: string | undefined;
+}
+export interface ErrorResponse {
+    error: string;
+    message: string;
+    statusCode: number;
+    success: false;
+}
+export interface SuccessResponse<T = any> {
+    success: true;
+    data?: T;
+    message?: string;
+}
+export interface Project {
+    _id: string;
+    name: string;
+    description?: string;
+    created_at: string;
+    updated_at: string;
+    [key: string]: any;
+}
+export interface Collection {
+    _id: string;
+    collection_id: string;
+    name: string;
+    description?: string;
+    schema?: any;
+    lifecycle?: any;
+    created_at: string;
+    updated_at: string;
+    [key: string]: any;
+}
+export interface Document {
+    _id: string;
+    [key: string]: any;
+}
+export interface QueryOptions {
+    filter?: any;
+    jsonFilter?: any;
+    select?: string | string[];
+    projection?: string;
+    options?: any;
+    sort?: any;
+    limit?: number;
+    skip?: number;
+    q?: string;
+    quick_filter_fields?: string | string[];
+    noPopulate?: boolean;
+    relations?: RelationHydrationConfig[];
+    relationSelect?: string | string[];
+    populate?: string[];
+    paginationTransport?: "auto" | "http" | "ws";
+    wsFactory?: (url: string) => PaginationWebSocketLike;
+}
+export interface PaginationWebSocketLike {
+    readyState: number;
+    send: (data: string) => void;
+    close: () => void;
+    onopen?: ((event: any) => void) | null;
+    onmessage?: ((event: {
+        data: string;
+    }) => void) | null;
+    onerror?: ((event: any) => void) | null;
+    onclose?: ((event: any) => void) | null;
+    addEventListener?: (event: "open" | "message" | "error" | "close", handler: (event: any) => void) => void;
+}
+export interface PaginationMeta {
+    count: number;
+    limit: number;
+    skip: number;
+    pagination_field?: string;
+    sort?: Record<string, any>;
+    select_fields?: string[];
+    transport?: "http" | "ws";
+}
+export interface PaginatedResult<T = Document> {
+    data: T[];
+    meta: PaginationMeta;
+}
+export interface RelationHydrationConfig {
+    field: string;
+    collectionId: string;
+    many?: boolean;
+    select?: string | string[];
+}
+export interface CollectionRealtimeEvent {
+    type: string;
+    project_id: string;
+    collection_id: string;
+    document_id?: string;
+    document_ids?: string[];
+    payload?: any;
+    timestamp: number;
+}
+export interface CollectionRealtimeHandlers {
+    onConnected?: () => void;
+    onEvent?: (event: CollectionRealtimeEvent) => void;
+    onError?: (error: any) => void;
+}
+export interface CollectionRealtimeSubscribeOptions {
+    apiKey?: string;
+    token?: string;
+    lastEventId?: string;
+    eventSourceFactory?: (url: string) => {
+        onopen: ((event: any) => void) | null;
+        onmessage: ((event: any) => void) | null;
+        onerror: ((event: any) => void) | null;
+        addEventListener?: (event: string, handler: (event: any) => void) => void;
+        close: () => void;
+    };
+}
+export interface CollectionRealtimeSubscription {
+    close: () => void;
+}
+export interface AuthUser {
+    _id: string;
+    username: string;
+    email?: string;
+    role?: string;
+    created_at: string;
+    updated_at: string;
+    access_token?: string;
+    refresh_token?: string;
+    [key: string]: any;
+}
+export interface AuthResponse {
+    user: AuthUser;
+    access_token: string;
+    refresh_token?: string;
+}
+export interface LoginCredentials {
+    username: string;
+    password: string;
+}
+export interface GoogleCredentials {
+    credential: string;
+}
+export interface EotpRequest {
+    email: string;
+}
+export interface EotpVerify {
+    email: string;
+    otp: string;
+}
+export interface PasswordResetRequest {
+    email: string;
+    reset_url?: string;
+    resetUrl?: string;
+}
+export interface PasswordResetPayload {
+    token: string;
+    new_password?: string;
+    password?: string;
+    email?: string;
+}
+export interface ChangePasswordRequest {
+    password?: string;
+    newPassword?: string;
+    new_password?: string;
+    currentPassword?: string;
+    current_password?: string;
+}
+export interface ApiKey {
+    _id: string;
+    name: string;
+    key: string;
+    permissions?: string[];
+    created_at: string;
+    updated_at: string;
+    [key: string]: any;
+}
+export interface StorageFile {
+    name: string;
+    size: number;
+    type: string;
+    url?: string;
+    path: string;
+    created_at: string;
+    [key: string]: any;
+}
+export interface Flow {
+    _id: string;
+    name: string;
+    type: string;
+    config: any;
+    created_at: string;
+    updated_at: string;
+    [key: string]: any;
+}
+export interface FlowRunOptions {
+    session_id?: string;
+    state?: string;
+    args?: any;
+}
+export interface Template {
+    _id: string;
+    name: string;
+    content: string;
+    type: string;
+    created_at: string;
+    updated_at: string;
+    [key: string]: any;
+}
+export interface BuildxObject {
+    _id: string;
+    _display?: string;
+    [key: string]: any;
+}
+export interface BuildxConfig {
+    apiEndpoint: string;
+    apiKey: string;
+    projectId?: string;
+    organizationId?: string;
+}
+export interface Function {
+    _id: string;
+    name: string;
+    code: string;
+    runtime: string;
+    created_at: string;
+    updated_at: string;
+    [key: string]: any;
+}
+export interface FunctionLog {
+    _id: string;
+    function_name: string;
+    level: string;
+    message: string;
+    timestamp: string;
+    [key: string]: any;
+}
+export interface Lifecycle {
+    states: string[];
+    transitions: LifecycleTransition[];
+    [key: string]: any;
+}
+export interface LifecycleTransition {
+    from: string;
+    to: string;
+    conditions?: any;
+    actions?: any;
+}
+export interface ImportMapping {
+    [field: string]: string;
+}
+export interface BackupData {
+    project: Project;
+    collections: Collection[];
+    data: {
+        [collectionId: string]: Document[];
+    };
+}

package/package.json

@@ -0,0 +1,92 @@
+{
+	"name": "buildx-sdk",
+	"version": "1.0.4",
+	"description": "Official JavaScript/TypeScript SDK for Buildx low-code platform",
+	"type": "module",
+	"main": "dist/index.cjs",
+	"module": "dist/index.esm.js",
+	"types": "dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.esm.js",
+			"require": "./dist/index.cjs",
+			"default": "./dist/index.esm.js"
+		},
+		"./dist/*": "./dist/*",
+		"./package.json": "./package.json"
+	},
+	"files": [
+		"dist",
+		"README.md",
+		"LICENSE"
+	],
+	"scripts": {
+		"build": "rimraf dist && rollup -c",
+		"dev": "rollup -c -w",
+		"test": "jest",
+		"test:watch": "jest --watch",
+		"lint": "eslint src --ext .ts",
+		"lint:fix": "eslint src --ext .ts --fix",
+		"clean": "rimraf dist",
+		"prepublishOnly": "npm run clean && npm run build",
+		"docs": "typedoc --options typedoc.json",
+		"docs:clean": "rimraf docs/api",
+		"validate": "concurrently \"yarn lint\" \"yarn test\""
+	},
+	"keywords": [
+		"buildx",
+		"low-code",
+		"api",
+		"sdk",
+		"typescript",
+		"javascript"
+	],
+	"author": "Buildx Team",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/mekku/buildx.git"
+	},
+	"bugs": {
+		"url": "https://github.com/mekku/buildx/issues"
+	},
+	"homepage": "https://github.com/mekku/buildx/tree/main/packages/buildx-sdk#readme",
+	"devDependencies": {
+		"@rollup/plugin-commonjs": "^25.0.0",
+		"@rollup/plugin-node-resolve": "^15.0.0",
+		"@rollup/plugin-typescript": "^11.0.0",
+		"@types/jest": "^29.0.0",
+		"@types/lodash": "^4.14.0",
+		"@typescript-eslint/eslint-plugin": "^8.34.1",
+		"@typescript-eslint/parser": "^8.34.1",
+		"clean-jsdoc-theme": "^4.2.9",
+		"concurrently": "^9.1.2",
+		"esbuild": "^0.25.5",
+		"eslint": "^9.29.0",
+		"eslint-import-resolver-typescript": "^4.4.3",
+		"eslint-plugin-import": "^2.31.0",
+		"eslint-plugin-vitest-globals": "^1.5.0",
+		"jest": "^29.0.0",
+		"rimraf": "^6.0.1",
+		"rollup": "^4.44.0",
+		"rollup-plugin-dts": "^6.2.1",
+		"rollup-plugin-esbuild": "^6.2.1",
+		"rollup-plugin-terser": "^7.0.0",
+		"ts-jest": "^29.0.0",
+		"typedoc": "^0.28.5",
+		"typedoc-github-theme": "^0.3.0",
+		"typedoc-plugin-markdown": "^4.0.0",
+		"typescript": "5.3.3"
+	},
+	"dependencies": {
+		"axios": "^1.10.0",
+		"buildx-common": "^0.1.66",
+		"lodash": "^4.17.0",
+		"tslib": "^2.8.1",
+		"typedoc-plugin-jekyll": "^0.1.0"
+	},
+	"engines": {
+		"node": ">=14.0.0"
+	}
+}