@ptkl/sdk 0.10.2 → 1.0.0

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptkl/sdk",
-  "version": "0.10.1",
+  "version": "0.10.2",
   "scripts": {
     "build": "rollup -c",
     "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",
@@ -11,14 +11,19 @@
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.esm.js",
-      "require": "./dist/index.cjs.js",
-      "types": "./dist/types/index.d.ts"
+      "import": "./dist/v0.9/index.esm.js",
+      "require": "./dist/v0.9/index.cjs.js",
+      "types": "./dist/v0.9/index.d.ts"
+    },
+    "./beta": {
+      "import": "./dist/v0.10/index.esm.js",
+      "require": "./dist/v0.10/index.cjs.js",
+      "types": "./dist/v0.10/index.d.ts"
     }
   },
-  "main": "./dist/index.cjs.js",
-  "module": "./dist/index.esm.js",
-  "types": "./dist/types/index.d.ts",
+  "main": "./dist/v0.10/index.cjs.js",
+  "module": "./dist/v0.10/index.esm.js",
+  "types": "./dist/v0.10/index.d.ts",
   "author": "protokol.io",
   "license": "ISC",
   "type": "module",

package/dist/v0.10/api/component.d.ts

@@ -0,0 +1,128 @@
+import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, StreamHandler, AggregateChainable, ComponentOptions } from "../types/component";
+import PlatformBaseClient from "./platformBaseClient";
+import { AxiosResponse } from "axios";
+export default class Component extends PlatformBaseClient {
+    private ref;
+    private version;
+    constructor(ref?: string | null, options?: ComponentOptions);
+    /**
+     * Get the base path for component API calls
+     * @private
+     */
+    private getComponentPath;
+    /**
+     * Find method to search for models
+     *
+     * @param {FindParams} filters - The filters to apply to the search
+     * @param {FindOptions} opts - The options to apply to the search
+     *
+     * @returns {Promise<FindResponse>} - The result of the search
+     *
+     * @example
+     * platform.component(name).find({
+     *     currentPage: 1,
+     *     perPage: 10,
+     * })
+     *
+     * // advanced search
+     * platform.component(name).find({
+     *     $adv: {
+     *         name: "John Doe",
+     *     }
+     * )
+     **/
+    find(filters: FindParams, opts?: FindOptions): Promise<AxiosResponse<FindResponse>>;
+    /**
+     * FindOne method to search for a single model
+     *
+     * @param {FindAdvancedParams} filter - The filters to apply to the search
+     * @param {FindOptions} opts - The options to apply to the search
+     *
+     * @returns {Promise<?Model>} - The result of the search
+     *
+     * @example
+     * platform.component(name).findOne({
+     *     name: "John Doe",
+     * })
+     **/
+    findOne(filter: FindAdvancedParams, opts: FindOptions): Promise<Model | null>;
+    /**
+     * Get model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @returns (Promise<Model>)
+     */
+    get(uuid: string): Promise<AxiosResponse<Model>>;
+    /**
+     * Update model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @param data
+     * @returns
+     */
+    update(uuid: string, data: Record<string, any>, options: UpdateOptions): Promise<AxiosResponse<any, any>>;
+    /**
+     * Update many models
+     *
+     * @param data
+     * @param options
+     * @returns
+     */
+    updateMany(data: Record<string, any>[], options: UpdateOptions): Promise<AxiosResponse<any, any>>;
+    /**
+     * Modify models by filters
+     *
+     * @param data
+     * @param options
+     * @returns
+     */
+    modify(filters: Record<string, any>, data: Record<string, any>, options: ModifyOptions): Promise<AxiosResponse<any, any>>;
+    /**
+     * Concurrent update model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @param version number - The version of the model
+     * @param data
+     * @returns
+     */
+    concurrentUpdate(uuid: string, version: number, data: Record<string, any>, options: UpdateOptions): Promise<AxiosResponse<any, any>>;
+    create(model: Record<string, any>): Promise<AxiosResponse<any, any>>;
+    delete(uuid: string): Promise<AxiosResponse<any, any>>;
+    /**
+     * Execute aggregate pipeline with optional streaming support
+     *
+     * Returns a chainable object that allows both buffered and streaming modes.
+     * Call .onData() to enable streaming mode, or await directly for buffered mode.
+     *
+     * @param {FindAggregateParams} pipeline - MongoDB aggregation pipeline
+     *
+     * @returns {AggregateChainable} Chainable object with streaming methods and Promise interface
+     *
+     * @example
+     * ```typescript
+     * // Buffered response (default, up to 5K documents)
+     * const result = await component.aggregate([{ $match: { status: 'active' } }]);
+     * console.log(result.data); // All results at once
+     *
+     * // Streaming response (up to 25K documents)
+     * await component.aggregate([{ $match: { status: 'active' } }])
+     *   .onData((doc) => console.log('Received:', doc))
+     *   .onError((err) => console.error('Error:', err))
+     *   .onEnd(() => console.log('Stream complete'));
+     * ```
+     */
+    aggregate(pipeline: FindAggregateParams): AggregateChainable;
+    settings(): Promise<AxiosResponse<any, any>>;
+    saveSettings(settings: any, version: string): Promise<AxiosResponse<any, any>>;
+    saveTemplatesDist(version: string, sdkVersion: string, engine: string, dist: Record<string, string>): Promise<any>;
+    workflow(event: string, input: any): Promise<AxiosResponse<any, any>>;
+    function(name: string, input: any): Promise<AxiosResponse<any, any>>;
+    revisions(uuid: string): Promise<AxiosResponse<any, any>>;
+    /**
+     * Internal method to handle NDJSON streaming responses
+     *
+     * @private
+     */
+    private _streamNDJSON;
+}
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, StreamHandler, AggregateChainable, ComponentOptions, };

package/dist/v0.10/api/index.d.ts

@@ -0,0 +1,22 @@
+export { default as Component } from './component';
+export { default as Platform } from './platform';
+export { default as Functions } from './functions';
+export { default as APIUser } from './apiUser';
+export { default as Users } from './users';
+export { default as Apps } from './apps';
+export { default as ComponentUtils } from './componentUtils';
+export { default as Thunder } from './thunder';
+export { default as Ratchet } from './ratchet';
+export { default as Sandbox } from './sandbox';
+export { default as System } from './system';
+export { default as Workflow } from './workflow';
+export { default as Forge } from './forge';
+export { default as Project } from './project';
+export { default as Config } from './config';
+export { default as Integrations } from './integrations';
+export { default as Integration } from './integrations';
+export { default as Payments } from './integrations/payments';
+export { default as Invoicing } from './integrations/invoicing';
+export { default as DMS } from './integrations/dms';
+export { default as SerbiaUtil } from './integrations/serbiaUtil';
+export { default as VPFR } from './integrations/vpfr';

package/dist/{types → v0.10}/api/integrationsBaseClient.d.ts

@@ -1,5 +1,8 @@
 import BaseClient from "./baseClient";
 export default class IntegrationsBaseClient extends BaseClient {
+    protected env: string | null;
+    protected token: string | null;
+    protected host: string | null;
     constructor(options?: {
         env?: string;
         token?: string;

package/dist/{types → v0.10}/api/platform.d.ts

@@ -3,7 +3,7 @@ import Functions from "./functions";
 import APIUser from "./apiUser";
 import Users from "./users";
 import Apps from "./apps";
-import Component from "./component";
+import Component, { ComponentOptions } from "./component";
 import ComponentUtils from "./componentUtils";
 import Thunder from "./thunder";
 import Ratchet from "./ratchet";
@@ -22,7 +22,7 @@ export default class Platform extends PlatformBaseClient {
     user(): Users;
     app(appType: string): Apps;
     forge(): Forge;
-    component(ref: string): Component;
+    component(ref: string, options?: ComponentOptions): Component;
     componentUtils(): ComponentUtils;
     ratchet(): Ratchet;
     sandbox(): Sandbox;

package/dist/v0.10/apiUser.d.ts

@@ -0,0 +1,9 @@
+import PlatformBaseClient from "./platformBaseClient";
+export default class APIUser extends PlatformBaseClient {
+    auth(username: string, password: string, project: string): Promise<import("axios").AxiosResponse<any, any>>;
+    newSecret(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
+    revokeSecret(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
+    edit(uuid: string, roles: string[]): Promise<import("axios").AxiosResponse<any, any>>;
+    list(): Promise<any>;
+    get(uuid: string): Promise<import("axios").AxiosResponse<any, any>>;
+}

package/dist/v0.10/apps.d.ts

@@ -0,0 +1,8 @@
+import PlatformBaseClient from "./platformBaseClient";
+export default class Apps extends PlatformBaseClient {
+    private appType;
+    constructor(appType?: string);
+    updateSettings(updateValues: any, ref: string): Promise<any>;
+    download(ref: string, version: string): Promise<any>;
+    upload(formData: FormData): Promise<any>;
+}

package/dist/v0.10/baseClient.d.ts

@@ -0,0 +1,6 @@
+import { AxiosInstance } from "axios";
+export default class BaseClient {
+    client: AxiosInstance;
+    constructor(client: AxiosInstance);
+    setClient(client: AxiosInstance): this;
+}

package/dist/{types/api → v0.10}/component.d.ts

@@ -1,9 +1,15 @@
-import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions } from "src/types/component";
+import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, StreamHandler, AggregateChainable, ComponentOptions } from "./types/component";
 import PlatformBaseClient from "./platformBaseClient";
 import { AxiosResponse } from "axios";
 export default class Component extends PlatformBaseClient {
     private ref;
-    constructor(ref?: string | null);
+    private version;
+    constructor(ref?: string | null, options?: ComponentOptions);
+    /**
+     * Get the base path for component API calls
+     * @private
+     */
+    private getComponentPath;
     /**
      * Find method to search for models
      *
@@ -82,12 +88,41 @@ export default class Component extends PlatformBaseClient {
     concurrentUpdate(uuid: string, version: number, data: Record<string, any>, options: UpdateOptions): Promise<AxiosResponse<any, any>>;
     create(model: Record<string, any>): Promise<AxiosResponse<any, any>>;
     delete(uuid: string): Promise<AxiosResponse<any, any>>;
-    aggregate(pipeline: FindAggregateParams): Promise<AxiosResponse<any, any>>;
+    /**
+     * Execute aggregate pipeline with optional streaming support
+     *
+     * Returns a chainable object that allows both buffered and streaming modes.
+     * Call .onData() to enable streaming mode, or await directly for buffered mode.
+     *
+     * @param {FindAggregateParams} pipeline - MongoDB aggregation pipeline
+     *
+     * @returns {AggregateChainable} Chainable object with streaming methods and Promise interface
+     *
+     * @example
+     * ```typescript
+     * // Buffered response (default, up to 5K documents)
+     * const result = await component.aggregate([{ $match: { status: 'active' } }]);
+     * console.log(result.data); // All results at once
+     *
+     * // Streaming response (up to 25K documents)
+     * await component.aggregate([{ $match: { status: 'active' } }])
+     *   .onData((doc) => console.log('Received:', doc))
+     *   .onError((err) => console.error('Error:', err))
+     *   .onEnd(() => console.log('Stream complete'));
+     * ```
+     */
+    aggregate(pipeline: FindAggregateParams): AggregateChainable;
     settings(): Promise<AxiosResponse<any, any>>;
     saveSettings(settings: any, version: string): Promise<AxiosResponse<any, any>>;
     saveTemplatesDist(version: string, sdkVersion: string, engine: string, dist: Record<string, string>): Promise<any>;
     workflow(event: string, input: any): Promise<AxiosResponse<any, any>>;
     function(name: string, input: any): Promise<AxiosResponse<any, any>>;
     revisions(uuid: string): Promise<AxiosResponse<any, any>>;
+    /**
+     * Internal method to handle NDJSON streaming responses
+     *
+     * @private
+     */
+    private _streamNDJSON;
 }
-export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, };
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, StreamHandler, AggregateChainable, ComponentOptions, };

package/dist/v0.10/componentUtils.d.ts

@@ -0,0 +1,7 @@
+import { AxiosResponse } from "axios";
+import { ComponentListResponse } from "./types/component";
+import PlatformBaseClient from "./platformBaseClient";
+export default class ComponentUtils extends PlatformBaseClient {
+    list(): Promise<AxiosResponse<ComponentListResponse>>;
+    create(data: any): Promise<AxiosResponse<any, any>>;
+}

package/dist/v0.10/config.d.ts

@@ -0,0 +1,14 @@
+import PlatformBaseClient from "./platformBaseClient";
+import { AxiosResponse } from "axios";
+import { ConfigUpdateRequest, UserConfig } from './types/config';
+export default class Config extends PlatformBaseClient {
+    /**
+     * Get user configuration
+     */
+    getUserConfig(): Promise<AxiosResponse<UserConfig>>;
+    /**
+     * Update user configuration
+     * @param config Configuration data
+     */
+    updateUserConfig(config: ConfigUpdateRequest): Promise<AxiosResponse<any>>;
+}

package/dist/v0.10/forge.d.ts

@@ -0,0 +1,7 @@
+import PlatformBaseClient from "./platformBaseClient";
+export default class Forge extends PlatformBaseClient {
+    bundleUpload(buffer: Buffer): Promise<any>;
+    getWorkspaceApps(): Promise<any>;
+    removeVersion(ref: string, version: string): Promise<any>;
+    list(): Promise<any>;
+}

package/dist/v0.10/functions.d.ts

@@ -0,0 +1,23 @@
+import PlatformBaseClient from "./platformBaseClient";
+export default class Functions extends PlatformBaseClient {
+    list(): Promise<any>;
+    get(ref: string): Promise<any>;
+    update(uuid: string, update: any): Promise<any>;
+    /**
+     * Run platform function
+     *
+     * @param id - Function ID
+     * @param input - Input data
+     * @param query - Query parameters
+     * @returns - Function result
+     *
+     * @example
+     * const result = await platform.function().run("myFunction", {input: { foo: "bar" }})
+     */
+    run(id: string, d: {
+        input?: Record<string, any>;
+        query?: Record<string, string>;
+        headers?: Record<string, string>;
+    }): Promise<any>;
+    generateSignature(ref: string, env: string): Promise<import("axios").AxiosResponse<any, any>>;
+}