@ptkl/sdk 0.1.0 → 0.2.1

package/README.md

@@ -0,0 +1,16 @@
+To use the SDK, you’ll first need to generate an access token.
+
+If you haven’t created any users or roles yet, head to the **IAM** section in the dashboard. Start by creating a [role](https://platform.protokol.io/admin/users/roles), then create a [user](https://platform.protokol.io/admin/users) and assign the appropriate role(s) to them.
+
+Once your user is set up, go to their **API user edit page**. From there, you can generate a new secret or create a token for an existing secret by clicking the **"Generate secret"** button.
+
+### Usage
+
+```
+const platform = new Platform({
+    token: // your generated token
+})
+
+// now you can
+const results = await platform.function().run("hello_world", {text: "Hi!"})
+```

package/dist/index.cjs.js

@@ -1,5 +1,7 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 var require$$1 = require('util');
 var stream = require('stream');
 var require$$1$1 = require('path');
@@ -17824,9 +17826,21 @@ class Functions extends BaseClient {
     async update(uuid, update) {
         return await this.client.patch(`/v1/system/function/${uuid}`, update);
     }
-    async run(id, input, query) {
-        const { data } = await this.client.post(`/v1/system/function/run/${id}`, input, {
-            params: query || {},
+    /**
+     * 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", { foo: "bar" }, { queryParam: "value" })
+     */
+    async run(id, d) {
+        const { data } = await this.client.post(`/v1/system/function/run/${id}`, d.input, {
+            params: d.query,
+            headers: d.headers
         });
         return data.data;
     }
@@ -17835,6 +17849,11 @@ class Functions extends BaseClient {
     }
 }
 
+var functions = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Functions
+});
+
 class Roles extends BaseClient {
     async create(role) {
         const res = await this.client.post("/v1/user/role/create", role);
@@ -17859,6 +17878,11 @@ class Roles extends BaseClient {
     }
 }
 
+var roles = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Roles
+});
+
 class APIUser extends BaseClient {
     async apiAuth(username, password) {
         return this.client.post("/v1/user/api/auth", {
@@ -17883,6 +17907,11 @@ class APIUser extends BaseClient {
     }
 }
 
+var apiUser = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: APIUser
+});
+
 class Users extends BaseClient {
     async invite(email, roles) {
         return await this.client.post("/v1/project/invite", {
@@ -17895,6 +17924,11 @@ class Users extends BaseClient {
     }
 }
 
+var users = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Users
+});
+
 class Apps extends BaseClient {
     constructor(client, appType) {
         super(client);
@@ -17908,10 +17942,17 @@ class Apps extends BaseClient {
         return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/download`, { version, uuid: ref }, { responseType: "arraybuffer" });
     }
     async upload(formData) {
-        return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/upload`, formData);
+        return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/upload`, formData, {
+            timeout: 60000
+        });
     }
 }
 
+var apps = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Apps
+});
+
 class Component extends BaseClient {
     constructor(adapter, ref) {
         super(adapter);
@@ -17921,8 +17962,29 @@ class Component extends BaseClient {
         this.ref = ref;
         return this;
     }
+    /**
+     * 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, opts) {
-        const { cache = false, buildttl = -1, locale = "en_US" } = opts !== null && opts !== undefined ? opts : {};
+        const { cache = false, buildttl = -1, locale = "en_US", } = opts !== null && opts !== undefined ? opts : {};
         return new Promise((resolve, reject) => {
             let payload = {
                 context: filters,
@@ -17950,7 +18012,6 @@ class Component extends BaseClient {
                 sortDesc: sortDesc,
                 filter: ctx.filter,
                 filterOn: ctx.filterOn.join(","),
-                disabled: ctx.disabled,
                 limit: limit,
                 dateFrom: ctx.dateFrom,
                 dateTo: ctx.dateTo,
@@ -17962,9 +18023,11 @@ class Component extends BaseClient {
             if (ctx.$aggregate && ctx.$aggregate.length > 0) {
                 params.$aggregate = JSON.stringify(ctx.$aggregate);
             }
-            Object.keys(opts || {}).forEach(k => {
-                params[`_opt_${k}`] = opts[k];
-            });
+            if (opts) {
+                Object.keys(opts).forEach(k => {
+                    params[`_opt_${k}`] = opts ? opts[k] : null;
+                });
+            }
             this.client.get(`/v3/system/component/${this.ref}/models`, {
                 params: params,
                 headers: {
@@ -17980,6 +18043,19 @@ class Component extends BaseClient {
             });
         });
     }
+    /**
+     * 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",
+     * })
+     **/
     async findOne(filter, opts) {
         const { items } = await this.find({
             $adv: filter
@@ -17989,6 +18065,12 @@ class Component extends BaseClient {
         }
         return null;
     }
+    /**
+     * Get model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @returns (Promise<Model>)
+     */
     get(uuid) {
         return new Promise((resolve, reject) => {
             this.client.get(`/v3/system/component/${this.ref}/model/${uuid}`).then((resp) => {
@@ -17998,10 +18080,17 @@ class Component extends BaseClient {
             });
         });
     }
-    update(uuid, model) {
+    /**
+     * Update model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @param data
+     * @returns
+     */
+    update(uuid, data) {
         return new Promise((resolve, reject) => {
             this.client.post(`/v3/system/component/${this.ref}/model/${uuid}`, {
-                data: model
+                data,
             }).then((resp) => {
                 resolve(resp.data);
             }).catch((error) => {
@@ -18009,11 +18098,11 @@ class Component extends BaseClient {
             });
         });
     }
-    concurrentUpdate(uuid, version, model) {
+    concurrentUpdate(uuid, version, data) {
         return new Promise((resolve, reject) => {
             this.client.post(`/v3/system/component/${this.ref}/model/${uuid}`, {
                 version: version,
-                data: model
+                data,
             }).then((resp) => {
                 resolve(resp.data);
             }).catch((error) => {
@@ -18039,9 +18128,9 @@ class Component extends BaseClient {
             });
         });
     }
-    aggregate(payload) {
+    aggregate(pipeline) {
         return new Promise((resolve, reject) => {
-            this.client.post(`/v3/system/component/${this.ref}/aggregate`, payload).then((resp) => {
+            this.client.post(`/v3/system/component/${this.ref}/aggregate`, pipeline).then((resp) => {
                 resolve(resp.data);
             }).catch((error) => {
                 reject(error);
@@ -18077,7 +18166,7 @@ class Component extends BaseClient {
         return data;
     }
     async workflow(event, input) {
-        return await this.client.post("/v1/system/component/" + this.ref + "/workflow/event", {
+        return await this.client.post(`/v1/system/component/${this.ref}/workflow/event`, {
             event,
             input
         });
@@ -18094,6 +18183,11 @@ class Component extends BaseClient {
     }
 }
 
+var component = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Component
+});
+
 class Invoicing extends BaseClient {
     async getSalesInvoices(provider, page) {
         return await this.request("GET", `/invoices/${provider}/sales`, {
@@ -18302,6 +18396,11 @@ class Integrations extends BaseClient {
     }
 }
 
+var integrations = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Integrations
+});
+
 class Ratchet extends BaseClient {
     async query(name, params) {
         let res = await this.client.post('/v1/ratchet/query', {
@@ -18312,12 +18411,32 @@ class Ratchet extends BaseClient {
     }
 }
 
+var ratchet = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Ratchet
+});
+
 class Sandbox extends BaseClient {
+    /**
+     * Call the sandbox service to execute a serverless function
+     *
+     * @param name
+     * @param data
+     * @returns
+     *
+     * @example
+     * const result = await platform.sandbox().spark("myFunction", { foo: "bar" })
+     */
     async spark(name, data) {
         return await this.client.post(`/v1/project/sandbox/spark/exec/${name}`, data);
     }
 }
 
+var sandbox = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Sandbox
+});
+
 class System extends BaseClient {
     async resourceResolver(ref, resourceName, format) {
         const { data } = await this.client.post("/v3/system/resource-resolver", {
@@ -18331,12 +18450,22 @@ class System extends BaseClient {
     }
 }
 
+var system = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: System
+});
+
 class Workflow extends BaseClient {
     async trigger(id, event, data) {
         return await this.client.post(`/v1/project/workflow/workflow/${id}/event/${event}`, data);
     }
 }
 
+var workflow = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  default: Workflow
+});
+
 class Forge extends BaseClient {
     constructor(client) {
         super(client);
@@ -18363,7 +18492,7 @@ const isBrowser = typeof window !== "undefined" &&
 class Platform {
     constructor(options) {
         var _a;
-        let { project = null, env = null, token, host, integrationHost } = options !== null && options !== undefined ? options : {};
+        let { env = null, token, host, integrationHost } = options !== null && options !== undefined ? options : {};
         let headers = {};
         if (isBrowser) {
             if (localStorage.getItem('protokol_context') == "forge") {
@@ -18372,7 +18501,6 @@ class Platform {
             else {
                 // this potentially means that it is running as dev server in local
                 headers['X-Project-Env'] = "dev";
-                // here we don't know actual project so we need a way to determine it
             }
         }
         if (token) {
@@ -18381,9 +18509,6 @@ class Platform {
         if (env) {
             headers['X-Project-Env'] = env;
         }
-        if (project) {
-            headers['X-Project-Uuid'] = project;
-        }
         this.platformClient = axios.create({
             baseURL: host !== null && host !== undefined ? host : "https://lemon.protokol.io",
             timeout: 15000,
@@ -18448,4 +18573,15 @@ class Platform {
     }
 }
 
-module.exports = Platform;
+exports.APIUser = apiUser;
+exports.Apps = apps;
+exports.Component = component;
+exports.Functions = functions;
+exports.Integration = integrations;
+exports.Ratchet = ratchet;
+exports.Roles = roles;
+exports.Sandbox = sandbox;
+exports.System = system;
+exports.Users = users;
+exports.Workflow = workflow;
+exports.default = Platform;

package/dist/index.esm.js

@@ -16,9 +16,21 @@ class Functions extends BaseClient {
     async update(uuid, update) {
         return await this.client.patch(`/v1/system/function/${uuid}`, update);
     }
-    async run(id, input, query) {
-        const { data } = await this.client.post(`/v1/system/function/run/${id}`, input, {
-            params: query || {},
+    /**
+     * 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", { foo: "bar" }, { queryParam: "value" })
+     */
+    async run(id, d) {
+        const { data } = await this.client.post(`/v1/system/function/run/${id}`, d.input, {
+            params: d.query,
+            headers: d.headers
         });
         return data.data;
     }
@@ -27,6 +39,11 @@ class Functions extends BaseClient {
     }
 }
 
+var functions = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Functions
+});
+
 class Roles extends BaseClient {
     async create(role) {
         const res = await this.client.post("/v1/user/role/create", role);
@@ -51,6 +68,11 @@ class Roles extends BaseClient {
     }
 }
 
+var roles = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Roles
+});
+
 class APIUser extends BaseClient {
     async apiAuth(username, password) {
         return this.client.post("/v1/user/api/auth", {
@@ -75,6 +97,11 @@ class APIUser extends BaseClient {
     }
 }
 
+var apiUser = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: APIUser
+});
+
 class Users extends BaseClient {
     async invite(email, roles) {
         return await this.client.post("/v1/project/invite", {
@@ -87,6 +114,11 @@ class Users extends BaseClient {
     }
 }
 
+var users = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Users
+});
+
 class Apps extends BaseClient {
     constructor(client, appType) {
         super(client);
@@ -100,10 +132,17 @@ class Apps extends BaseClient {
         return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/download`, { version, uuid: ref }, { responseType: "arraybuffer" });
     }
     async upload(formData) {
-        return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/upload`, formData);
+        return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/upload`, formData, {
+            timeout: 60000
+        });
     }
 }
 
+var apps = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Apps
+});
+
 class Component extends BaseClient {
     constructor(adapter, ref) {
         super(adapter);
@@ -113,8 +152,29 @@ class Component extends BaseClient {
         this.ref = ref;
         return this;
     }
+    /**
+     * 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, opts) {
-        const { cache = false, buildttl = -1, locale = "en_US" } = opts !== null && opts !== undefined ? opts : {};
+        const { cache = false, buildttl = -1, locale = "en_US", } = opts !== null && opts !== undefined ? opts : {};
         return new Promise((resolve, reject) => {
             let payload = {
                 context: filters,
@@ -142,7 +202,6 @@ class Component extends BaseClient {
                 sortDesc: sortDesc,
                 filter: ctx.filter,
                 filterOn: ctx.filterOn.join(","),
-                disabled: ctx.disabled,
                 limit: limit,
                 dateFrom: ctx.dateFrom,
                 dateTo: ctx.dateTo,
@@ -154,9 +213,11 @@ class Component extends BaseClient {
             if (ctx.$aggregate && ctx.$aggregate.length > 0) {
                 params.$aggregate = JSON.stringify(ctx.$aggregate);
             }
-            Object.keys(opts || {}).forEach(k => {
-                params[`_opt_${k}`] = opts[k];
-            });
+            if (opts) {
+                Object.keys(opts).forEach(k => {
+                    params[`_opt_${k}`] = opts ? opts[k] : null;
+                });
+            }
             this.client.get(`/v3/system/component/${this.ref}/models`, {
                 params: params,
                 headers: {
@@ -172,6 +233,19 @@ class Component extends BaseClient {
             });
         });
     }
+    /**
+     * 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",
+     * })
+     **/
     async findOne(filter, opts) {
         const { items } = await this.find({
             $adv: filter
@@ -181,6 +255,12 @@ class Component extends BaseClient {
         }
         return null;
     }
+    /**
+     * Get model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @returns (Promise<Model>)
+     */
     get(uuid) {
         return new Promise((resolve, reject) => {
             this.client.get(`/v3/system/component/${this.ref}/model/${uuid}`).then((resp) => {
@@ -190,10 +270,17 @@ class Component extends BaseClient {
             });
         });
     }
-    update(uuid, model) {
+    /**
+     * Update model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @param data
+     * @returns
+     */
+    update(uuid, data) {
         return new Promise((resolve, reject) => {
             this.client.post(`/v3/system/component/${this.ref}/model/${uuid}`, {
-                data: model
+                data,
             }).then((resp) => {
                 resolve(resp.data);
             }).catch((error) => {
@@ -201,11 +288,11 @@ class Component extends BaseClient {
             });
         });
     }
-    concurrentUpdate(uuid, version, model) {
+    concurrentUpdate(uuid, version, data) {
         return new Promise((resolve, reject) => {
             this.client.post(`/v3/system/component/${this.ref}/model/${uuid}`, {
                 version: version,
-                data: model
+                data,
             }).then((resp) => {
                 resolve(resp.data);
             }).catch((error) => {
@@ -231,9 +318,9 @@ class Component extends BaseClient {
             });
         });
     }
-    aggregate(payload) {
+    aggregate(pipeline) {
         return new Promise((resolve, reject) => {
-            this.client.post(`/v3/system/component/${this.ref}/aggregate`, payload).then((resp) => {
+            this.client.post(`/v3/system/component/${this.ref}/aggregate`, pipeline).then((resp) => {
                 resolve(resp.data);
             }).catch((error) => {
                 reject(error);
@@ -269,7 +356,7 @@ class Component extends BaseClient {
         return data;
     }
     async workflow(event, input) {
-        return await this.client.post("/v1/system/component/" + this.ref + "/workflow/event", {
+        return await this.client.post(`/v1/system/component/${this.ref}/workflow/event`, {
             event,
             input
         });
@@ -286,6 +373,11 @@ class Component extends BaseClient {
     }
 }
 
+var component = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Component
+});
+
 class Invoicing extends BaseClient {
     async getSalesInvoices(provider, page) {
         return await this.request("GET", `/invoices/${provider}/sales`, {
@@ -494,6 +586,11 @@ class Integrations extends BaseClient {
     }
 }
 
+var integrations = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Integrations
+});
+
 class Ratchet extends BaseClient {
     async query(name, params) {
         let res = await this.client.post('/v1/ratchet/query', {
@@ -504,12 +601,32 @@ class Ratchet extends BaseClient {
     }
 }
 
+var ratchet = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Ratchet
+});
+
 class Sandbox extends BaseClient {
+    /**
+     * Call the sandbox service to execute a serverless function
+     *
+     * @param name
+     * @param data
+     * @returns
+     *
+     * @example
+     * const result = await platform.sandbox().spark("myFunction", { foo: "bar" })
+     */
     async spark(name, data) {
         return await this.client.post(`/v1/project/sandbox/spark/exec/${name}`, data);
     }
 }
 
+var sandbox = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Sandbox
+});
+
 class System extends BaseClient {
     async resourceResolver(ref, resourceName, format) {
         const { data } = await this.client.post("/v3/system/resource-resolver", {
@@ -523,12 +640,22 @@ class System extends BaseClient {
     }
 }
 
+var system = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: System
+});
+
 class Workflow extends BaseClient {
     async trigger(id, event, data) {
         return await this.client.post(`/v1/project/workflow/workflow/${id}/event/${event}`, data);
     }
 }
 
+var workflow = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    default: Workflow
+});
+
 class Forge extends BaseClient {
     constructor(client) {
         super(client);
@@ -555,7 +682,7 @@ const isBrowser = typeof window !== "undefined" &&
 class Platform {
     constructor(options) {
         var _a;
-        let { project = null, env = null, token, host, integrationHost } = options !== null && options !== undefined ? options : {};
+        let { env = null, token, host, integrationHost } = options !== null && options !== undefined ? options : {};
         let headers = {};
         if (isBrowser) {
             if (localStorage.getItem('protokol_context') == "forge") {
@@ -564,7 +691,6 @@ class Platform {
             else {
                 // this potentially means that it is running as dev server in local
                 headers['X-Project-Env'] = "dev";
-                // here we don't know actual project so we need a way to determine it
             }
         }
         if (token) {
@@ -573,9 +699,6 @@ class Platform {
         if (env) {
             headers['X-Project-Env'] = env;
         }
-        if (project) {
-            headers['X-Project-Uuid'] = project;
-        }
         this.platformClient = axios.create({
             baseURL: host !== null && host !== undefined ? host : "https://lemon.protokol.io",
             timeout: 15000,
@@ -640,4 +763,4 @@ class Platform {
     }
 }
 
-export { Platform as default };
+export { apiUser as APIUser, apps as Apps, component as Component, functions as Functions, integrations as Integration, ratchet as Ratchet, roles as Roles, sandbox as Sandbox, system as System, users as Users, workflow as Workflow, Platform as default };

package/dist/index.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
-    typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory(require('axios')) :
-    typeof define === 'function' && define.amd ? define(['axios'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, global.ProtokolSDK = factory(global.axios));
-})(this, (function (axios) { 'use strict';
+    typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('axios')) :
+    typeof define === 'function' && define.amd ? define(['exports', 'axios'], factory) :
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.ProtokolSDK = {}, global.axios));
+})(this, (function (exports, axios) { 'use strict';
 
     class BaseClient {
         constructor(client) {
@@ -20,9 +20,21 @@
         async update(uuid, update) {
             return await this.client.patch(`/v1/system/function/${uuid}`, update);
         }
-        async run(id, input, query) {
-            const { data } = await this.client.post(`/v1/system/function/run/${id}`, input, {
-                params: query || {},
+        /**
+         * 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", { foo: "bar" }, { queryParam: "value" })
+         */
+        async run(id, d) {
+            const { data } = await this.client.post(`/v1/system/function/run/${id}`, d.input, {
+                params: d.query,
+                headers: d.headers
             });
             return data.data;
         }
@@ -31,6 +43,11 @@
         }
     }
 
+    var functions = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Functions
+    });
+
     class Roles extends BaseClient {
         async create(role) {
             const res = await this.client.post("/v1/user/role/create", role);
@@ -55,6 +72,11 @@
         }
     }
 
+    var roles = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Roles
+    });
+
     class APIUser extends BaseClient {
         async apiAuth(username, password) {
             return this.client.post("/v1/user/api/auth", {
@@ -79,6 +101,11 @@
         }
     }
 
+    var apiUser = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: APIUser
+    });
+
     class Users extends BaseClient {
         async invite(email, roles) {
             return await this.client.post("/v1/project/invite", {
@@ -91,6 +118,11 @@
         }
     }
 
+    var users = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Users
+    });
+
     class Apps extends BaseClient {
         constructor(client, appType) {
             super(client);
@@ -104,10 +136,17 @@
             return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/download`, { version, uuid: ref }, { responseType: "arraybuffer" });
         }
         async upload(formData) {
-            return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/upload`, formData);
+            return await this.client.post(`/v3/system/gateway/app-service/${this.appType}/upload`, formData, {
+                timeout: 60000
+            });
         }
     }
 
+    var apps = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Apps
+    });
+
     class Component extends BaseClient {
         constructor(adapter, ref) {
             super(adapter);
@@ -117,8 +156,29 @@
             this.ref = ref;
             return this;
         }
+        /**
+         * 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, opts) {
-            const { cache = false, buildttl = -1, locale = "en_US" } = opts !== null && opts !== undefined ? opts : {};
+            const { cache = false, buildttl = -1, locale = "en_US", } = opts !== null && opts !== undefined ? opts : {};
             return new Promise((resolve, reject) => {
                 let payload = {
                     context: filters,
@@ -146,7 +206,6 @@
                     sortDesc: sortDesc,
                     filter: ctx.filter,
                     filterOn: ctx.filterOn.join(","),
-                    disabled: ctx.disabled,
                     limit: limit,
                     dateFrom: ctx.dateFrom,
                     dateTo: ctx.dateTo,
@@ -158,9 +217,11 @@
                 if (ctx.$aggregate && ctx.$aggregate.length > 0) {
                     params.$aggregate = JSON.stringify(ctx.$aggregate);
                 }
-                Object.keys(opts || {}).forEach(k => {
-                    params[`_opt_${k}`] = opts[k];
-                });
+                if (opts) {
+                    Object.keys(opts).forEach(k => {
+                        params[`_opt_${k}`] = opts ? opts[k] : null;
+                    });
+                }
                 this.client.get(`/v3/system/component/${this.ref}/models`, {
                     params: params,
                     headers: {
@@ -176,6 +237,19 @@
                 });
             });
         }
+        /**
+         * 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",
+         * })
+         **/
         async findOne(filter, opts) {
             const { items } = await this.find({
                 $adv: filter
@@ -185,6 +259,12 @@
             }
             return null;
         }
+        /**
+         * Get model by uuid
+         *
+         * @param uuid string - The uuid of the model
+         * @returns (Promise<Model>)
+         */
         get(uuid) {
             return new Promise((resolve, reject) => {
                 this.client.get(`/v3/system/component/${this.ref}/model/${uuid}`).then((resp) => {
@@ -194,10 +274,17 @@
                 });
             });
         }
-        update(uuid, model) {
+        /**
+         * Update model by uuid
+         *
+         * @param uuid string - The uuid of the model
+         * @param data
+         * @returns
+         */
+        update(uuid, data) {
             return new Promise((resolve, reject) => {
                 this.client.post(`/v3/system/component/${this.ref}/model/${uuid}`, {
-                    data: model
+                    data,
                 }).then((resp) => {
                     resolve(resp.data);
                 }).catch((error) => {
@@ -205,11 +292,11 @@
                 });
             });
         }
-        concurrentUpdate(uuid, version, model) {
+        concurrentUpdate(uuid, version, data) {
             return new Promise((resolve, reject) => {
                 this.client.post(`/v3/system/component/${this.ref}/model/${uuid}`, {
                     version: version,
-                    data: model
+                    data,
                 }).then((resp) => {
                     resolve(resp.data);
                 }).catch((error) => {
@@ -235,9 +322,9 @@
                 });
             });
         }
-        aggregate(payload) {
+        aggregate(pipeline) {
             return new Promise((resolve, reject) => {
-                this.client.post(`/v3/system/component/${this.ref}/aggregate`, payload).then((resp) => {
+                this.client.post(`/v3/system/component/${this.ref}/aggregate`, pipeline).then((resp) => {
                     resolve(resp.data);
                 }).catch((error) => {
                     reject(error);
@@ -273,7 +360,7 @@
             return data;
         }
         async workflow(event, input) {
-            return await this.client.post("/v1/system/component/" + this.ref + "/workflow/event", {
+            return await this.client.post(`/v1/system/component/${this.ref}/workflow/event`, {
                 event,
                 input
             });
@@ -290,6 +377,11 @@
         }
     }
 
+    var component = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Component
+    });
+
     class Invoicing extends BaseClient {
         async getSalesInvoices(provider, page) {
             return await this.request("GET", `/invoices/${provider}/sales`, {
@@ -498,6 +590,11 @@
         }
     }
 
+    var integrations = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Integrations
+    });
+
     class Ratchet extends BaseClient {
         async query(name, params) {
             let res = await this.client.post('/v1/ratchet/query', {
@@ -508,12 +605,32 @@
         }
     }
 
+    var ratchet = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Ratchet
+    });
+
     class Sandbox extends BaseClient {
+        /**
+         * Call the sandbox service to execute a serverless function
+         *
+         * @param name
+         * @param data
+         * @returns
+         *
+         * @example
+         * const result = await platform.sandbox().spark("myFunction", { foo: "bar" })
+         */
         async spark(name, data) {
             return await this.client.post(`/v1/project/sandbox/spark/exec/${name}`, data);
         }
     }
 
+    var sandbox = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Sandbox
+    });
+
     class System extends BaseClient {
         async resourceResolver(ref, resourceName, format) {
             const { data } = await this.client.post("/v3/system/resource-resolver", {
@@ -527,12 +644,22 @@
         }
     }
 
+    var system = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: System
+    });
+
     class Workflow extends BaseClient {
         async trigger(id, event, data) {
             return await this.client.post(`/v1/project/workflow/workflow/${id}/event/${event}`, data);
         }
     }
 
+    var workflow = /*#__PURE__*/Object.freeze({
+        __proto__: null,
+        default: Workflow
+    });
+
     class Forge extends BaseClient {
         constructor(client) {
             super(client);
@@ -559,7 +686,7 @@
     class Platform {
         constructor(options) {
             var _a;
-            let { project = null, env = null, token, host, integrationHost } = options !== null && options !== undefined ? options : {};
+            let { env = null, token, host, integrationHost } = options !== null && options !== undefined ? options : {};
             let headers = {};
             if (isBrowser) {
                 if (localStorage.getItem('protokol_context') == "forge") {
@@ -568,7 +695,6 @@
                 else {
                     // this potentially means that it is running as dev server in local
                     headers['X-Project-Env'] = "dev";
-                    // here we don't know actual project so we need a way to determine it
                 }
             }
             if (token) {
@@ -577,9 +703,6 @@
             if (env) {
                 headers['X-Project-Env'] = env;
             }
-            if (project) {
-                headers['X-Project-Uuid'] = project;
-            }
             this.platformClient = axios.create({
                 baseURL: host !== null && host !== undefined ? host : "https://lemon.protokol.io",
                 timeout: 15000,
@@ -644,6 +767,19 @@
         }
     }
 
-    return Platform;
+    exports.APIUser = apiUser;
+    exports.Apps = apps;
+    exports.Component = component;
+    exports.Functions = functions;
+    exports.Integration = integrations;
+    exports.Ratchet = ratchet;
+    exports.Roles = roles;
+    exports.Sandbox = sandbox;
+    exports.System = system;
+    exports.Users = users;
+    exports.Workflow = workflow;
+    exports.default = Platform;
+
+    Object.defineProperty(exports, '__esModule', { value: true });
 
 }));

package/dist/package.json

@@ -1,8 +1,9 @@
 {
-  "name": "protokol-sdk",
-  "version": "0.8.0",
+  "name": "@ptkl/sdk",
+  "version": "0.2.1",
   "scripts": {
-    "build": "rollup -c"
+    "build": "rollup -c",
+    "docs": "typedoc"
   },
   "files": [
     "dist"
@@ -30,9 +31,10 @@
     "@types/lodash": "^4.17.13",
     "@types/node": "^22.9.0",
     "rollup": "^4.30.1",
+    "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-polyfill-node": "^0.13.0",
-    "typescript": "^5.6.3",
-    "rollup-plugin-copy": "^3.5.0"
+    "typedoc": "^0.28.4",
+    "typescript": "^5.6.3"
   },
   "dependencies": {
     "@rollup/plugin-replace": "^6.0.2",

package/dist/types/api/component.d.ts

@@ -1,17 +1,65 @@
+import { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model } from "src/types/component";
 import BaseClient from "./baseClient";
 import { AxiosInstance } from "axios";
 export default class Component extends BaseClient {
     private ref;
     constructor(adapter: AxiosInstance, ref: string);
     new(ref: string): this;
-    find(filters: any, opts?: any): Promise<any>;
-    findOne(filter: any, opts: any): Promise<any>;
-    get(uuid: string): Promise<any>;
-    update(uuid: string, model: Record<string, any>): Promise<unknown>;
-    concurrentUpdate(uuid: string, version: number, model: Record<string, any>): Promise<unknown>;
+    /**
+     * 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<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<Model>;
+    /**
+     * Update model by uuid
+     *
+     * @param uuid string - The uuid of the model
+     * @param data
+     * @returns
+     */
+    update(uuid: string, data: Record<string, any>): Promise<unknown>;
+    concurrentUpdate(uuid: string, version: number, data: Record<string, any>): Promise<unknown>;
     create(model: Record<string, any>): Promise<unknown>;
     delete(uuid: string): Promise<unknown>;
-    aggregate(payload: any[]): Promise<unknown>;
+    aggregate(pipeline: FindAggregateParams): Promise<unknown>;
     settings(): Promise<unknown>;
     saveSettings(settings: any): Promise<unknown>;
     saveTemplatesDist(version: string, sdkVersion: string, engine: string, dist: Record<string, string>): Promise<any>;
@@ -20,3 +68,4 @@ export default class Component extends BaseClient {
     all(): Promise<any>;
     setup(data: any): Promise<import("axios").AxiosResponse<any, any>>;
 }
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model };

package/dist/types/api/functions.d.ts

@@ -3,6 +3,21 @@ export default class Functions extends BaseClient {
     list(): Promise<any>;
     get(ref: string): Promise<any>;
     update(uuid: string, update: any): Promise<any>;
-    run(id: string, input: any, query: 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", { foo: "bar" }, { queryParam: "value" })
+     */
+    run(id: string, d: {
+        input?: any;
+        query: any;
+        headers: any;
+    }): Promise<any>;
     generateSignature(ref: string, env: string): Promise<import("axios").AxiosResponse<any, any>>;
 }

package/dist/types/api/platform.d.ts

@@ -15,7 +15,6 @@ export default class Platform {
     private platformClient;
     private integrationsClient;
     constructor(options: {
-        project?: string;
         env?: string;
         token?: string;
         host?: string;

package/dist/types/api/sandbox.d.ts

@@ -1,4 +1,14 @@
 import BaseClient from "./baseClient";
 export default class Sandbox extends BaseClient {
+    /**
+     * Call the sandbox service to execute a serverless function
+     *
+     * @param name
+     * @param data
+     * @returns
+     *
+     * @example
+     * const result = await platform.sandbox().spark("myFunction", { foo: "bar" })
+     */
     spark(name: string, data: any): Promise<import("axios").AxiosResponse<any, any>>;
 }

package/dist/types/index.d.ts

@@ -1,2 +1,13 @@
 import Platform from './api/platform';
+export * as Component from './api/component';
+export * as Integration from './api/integrations';
+export * as Ratchet from './api/ratchet';
+export * as Sandbox from './api/sandbox';
+export * as System from './api/system';
+export * as Users from './api/users';
+export * as Functions from './api/functions';
+export * as APIUser from './api/apiUser';
+export * as Roles from './api/roles';
+export * as Apps from './api/apps';
+export * as Workflow from './api/workflow';
 export default Platform;

package/dist/types/types/component.d.ts

@@ -0,0 +1,44 @@
+type FindParams = {
+    currentPage?: number;
+    perPage?: number;
+    sortBy?: string;
+    sortDesc?: boolean;
+    filterOn?: string[];
+    filter?: any;
+    disabled?: any;
+    dateFrom?: string;
+    dateTo?: string;
+    dateField?: string;
+    $adv?: FindAdvancedParams;
+    $aggregate?: FindAggregateParams[];
+};
+type FindOptions = {
+    cache?: boolean;
+    buildttl?: number;
+    locale?: string;
+    unmaskPasswords?: boolean;
+};
+type FindResponse = {
+    items: Model[];
+    total: number;
+    page: number;
+    pages: number;
+};
+type FindAdvancedParams = {
+    [key: string]: any;
+};
+type FindAggregateParams = {
+    [key: string]: any;
+};
+type Model = {
+    uuid: string;
+    __version__: number;
+    created_at: string;
+    updated_at: string;
+    created_by: string;
+    updated_by: string;
+    deleted_at: string;
+    deleted_by: string;
+    [key: string]: any;
+};
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, };

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@ptkl/sdk",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "scripts": {
-    "build": "rollup -c"
+    "build": "rollup -c",
+    "docs": "typedoc"
   },
   "files": [
     "dist"
@@ -30,9 +31,10 @@
     "@types/lodash": "^4.17.13",
     "@types/node": "^22.9.0",
     "rollup": "^4.30.1",
+    "rollup-plugin-copy": "^3.5.0",
     "rollup-plugin-polyfill-node": "^0.13.0",
-    "typescript": "^5.6.3",
-    "rollup-plugin-copy": "^3.5.0"
+    "typedoc": "^0.28.4",
+    "typescript": "^5.6.3"
   },
   "dependencies": {
     "@rollup/plugin-replace": "^6.0.2",