@ptkl/sdk 1.3.4 → 1.4.0

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

@@ -45,7 +45,7 @@ export default class Component extends PlatformBaseClient {
      *     name: "John Doe",
      * })
      **/
-    findOne(filter: FindAdvancedParams, opts: FindOptions): Promise<Model | null>;
+    findOne(filter: FindAdvancedParams, opts?: FindOptions): Promise<Model | null>;
     /**
      * Get model by uuid
      *
@@ -60,7 +60,7 @@ export default class Component extends PlatformBaseClient {
      * @param data
      * @returns
      */
-    update(uuid: string, data: Record<string, any>, options: UpdateOptions): Promise<AxiosResponse<any, any>>;
+    update(uuid: string, data: Record<string, any>, options?: UpdateOptions): Promise<AxiosResponse<any, any>>;
     /**
      * Update many models
      *
@@ -68,7 +68,7 @@ export default class Component extends PlatformBaseClient {
      * @param options
      * @returns
      */
-    updateMany(data: Record<string, any>[], options: UpdateManyOptions): Promise<AxiosResponse<any, any>>;
+    updateMany(data: Record<string, any>[], options?: UpdateManyOptions): Promise<AxiosResponse<any, any>>;
     /**
      * Create many models
      *
@@ -76,7 +76,7 @@ export default class Component extends PlatformBaseClient {
      * @param options
      * @returns
      */
-    createMany(data: Record<string, any>[], options: CreateManyOptions): Promise<AxiosResponse<any, any>>;
+    createMany(data: Record<string, any>[], options?: CreateManyOptions): Promise<AxiosResponse<any, any>>;
     /**
      * Modify models by filters
      *
@@ -84,7 +84,7 @@ export default class Component extends PlatformBaseClient {
      * @param options
      * @returns
      */
-    modify(filters: Record<string, any>, data: Record<string, any>, options: ModifyOptions): Promise<AxiosResponse<any, any>>;
+    modify(filters: Record<string, any>, data: Record<string, any>, options?: ModifyOptions): Promise<AxiosResponse<any, any>>;
     /**
      * Concurrent update model by uuid
      *
@@ -93,7 +93,7 @@ export default class Component extends PlatformBaseClient {
      * @param data
      * @returns
      */
-    concurrentUpdate(uuid: string, version: number, data: Record<string, any>, options: UpdateOptions): Promise<AxiosResponse<any, any>>;
+    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>>;
     /**

package/dist/v0.9/api/functions.d.ts

@@ -1,18 +1,30 @@
 import PlatformBaseClient from "./platformBaseClient";
+import type { PlatformFunctions, FunctionInput, FunctionOutput } from "../types/functions";
 export default class Functions extends PlatformBaseClient {
     list(): Promise<any>;
     get(ref: string): Promise<any>;
     update(uuid: string, update: any): Promise<any>;
     /**
-     * Run platform function
+     * Run a platform function.
      *
-     * @param id - Function ID
-     * @param d - Object containing input data, query parameters, and headers
-     * @returns - Function result
+     * When the function name is registered in `PlatformFunctions`, input and
+     * output types are inferred automatically from the IDL signature.
+     * Register signatures by running `ptkl generate-types` in your project.
      *
      * @example
-     * const result = await platform.function().run("myFunction", {input: { foo: "bar" }})
+     * // Typed — "send_email" is registered in PlatformFunctions
+     * const result = await fn.run("send_email", { input: { body: "hi", to: "a@b.com" } })
+     * // result: { status: boolean }
+     *
+     * @example
+     * // Untyped fallback for unregistered names
+     * const result = await fn.run("unknown_func", { input: { foo: "bar" } })
      */
+    run<K extends keyof PlatformFunctions>(id: K, d: {
+        input?: FunctionInput<K>;
+        query?: Record<string, string>;
+        headers?: Record<string, string>;
+    }): Promise<FunctionOutput<K>>;
     run(id: string, d: {
         input?: Record<string, any>;
         query?: Record<string, string>;

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

@@ -21,5 +21,6 @@ export { default as DMS } from './integrations/dms';
 export { default as SerbiaUtil } from './integrations/serbiaUtil';
 export { default as VPFR } from './integrations/vpfr';
 export { default as Mail } from './integrations/mail';
+export { default as Ecommerce } from './integrations/ecommerce';
 import Platfrom from './platform';
 export default Platfrom;

package/dist/v0.9/api/integrations/ecommerce.d.ts

@@ -0,0 +1,42 @@
+import IntegrationsBaseClient from "../integrationsBaseClient";
+import { EcommerceIntegrationUser, UpdateEcommerceSettingsRequest, CheckDomainResponse, AddDomainResponse, DomainsResponse } from "../../types/integrations/ecommerce";
+export default class Ecommerce extends IntegrationsBaseClient {
+    /**
+     * Get the ecommerce integration user for the current project.
+     */
+    get(): Promise<EcommerceIntegrationUser>;
+    /**
+     * Update ecommerce integration settings (onboarding or partial update).
+     */
+    update(req: UpdateEcommerceSettingsRequest): Promise<EcommerceIntegrationUser>;
+    /**
+     * Check whether a base domain subdomain is available.
+     */
+    checkBaseDomain(domain: string): Promise<CheckDomainResponse>;
+    /**
+     * Add a custom domain (returns a verification token for DNS validation).
+     */
+    addCustomDomain(domain: string): Promise<AddDomainResponse>;
+    /**
+     * Validate a custom domain with its verification token.
+     */
+    validateCustomDomain(domain: string, token: string): Promise<{
+        integration: EcommerceIntegrationUser;
+        message: string;
+    }>;
+    /**
+     * Remove a custom domain.
+     */
+    removeCustomDomain(domain: string): Promise<{
+        integration: EcommerceIntegrationUser;
+        message: string;
+    }>;
+    /**
+     * List pending (unvalidated) custom domains.
+     */
+    getPendingDomains(): Promise<DomainsResponse>;
+    /**
+     * List validated custom domains.
+     */
+    getValidatedDomains(): Promise<DomainsResponse>;
+}

package/dist/v0.9/api/integrations.d.ts

@@ -5,6 +5,7 @@ import VPFR from "./integrations/vpfr";
 import IntegrationsBaseClient from "./integrationsBaseClient";
 import Payments from "./integrations/payments";
 import Minimax from "./integrations/minimax";
+import Ecommerce from "./integrations/ecommerce";
 export default class Integrations extends IntegrationsBaseClient {
     private integrations;
     constructor(options?: {
@@ -19,6 +20,7 @@ export default class Integrations extends IntegrationsBaseClient {
     getMail(): Mail;
     getPayments(): Payments;
     getMinimax(): Minimax;
+    getEcommerce(): Ecommerce;
     isInstalled(id: string): Promise<boolean>;
     getInterfaceOf(id: string): any;
 }

package/dist/v0.9/api/system.d.ts

@@ -1,4 +1,4 @@
 import PlatformBaseClient from "./platformBaseClient";
 export default class System extends PlatformBaseClient {
-    resourceResolver(ref: string, resourceName: string, format?: string): Promise<import("axios").AxiosResponse<any, any>>;
+    resourceResolver(prn: string, format?: string): Promise<import("axios").AxiosResponse<any, any>>;
 }

package/dist/v0.9/index.cjs.js

@@ -19016,11 +19016,15 @@ class PlatformBaseClient extends BaseClient {
             token = token !== null && token !== void 0 ? token : __global_env__ === null || __global_env__ === void 0 ? void 0 : __global_env__.PROJECT_API_TOKEN;
             project_uuid = __global_env__ === null || __global_env__ === void 0 ? void 0 : __global_env__.PROJECT_UUID;
             if (isBrowser) {
-                if (sessionStorage.getItem('protokol_context') == "forge") {
-                    headers['X-Project-Env'] = (_b = sessionStorage.getItem('forge_app_env')) !== null && _b !== void 0 ? _b : "dev";
+                if (sessionStorage.getItem('protokol_context') === 'forge') {
+                    headers['X-Project-Env'] = (_b = sessionStorage.getItem('forge_app_env')) !== null && _b !== void 0 ? _b : 'dev';
+                    // pick up forge actor token — overrides any other token source
+                    const forgeToken = sessionStorage.getItem('forge_actor_token');
+                    if (forgeToken)
+                        token = forgeToken;
                 }
                 else {
-                    headers['X-Project-Env'] = (_c = localStorage.getItem('current_env')) !== null && _c !== void 0 ? _c : "dev";
+                    headers['X-Project-Env'] = (_c = localStorage.getItem('current_env')) !== null && _c !== void 0 ? _c : 'dev';
                 }
             }
         }
@@ -19204,7 +19208,7 @@ class Component extends PlatformBaseClient {
     async updateMany(data, options) {
         return await this.client.patch(`${this.getComponentPath()}/models/bulk`, {
             data,
-            options
+            options,
         });
     }
     /**
@@ -19438,16 +19442,6 @@ class Functions extends PlatformBaseClient {
     async update(uuid, update) {
         return await this.client.patch(`/v1/system/function/${uuid}`, update);
     }
-    /**
-     * Run platform function
-     *
-     * @param id - Function ID
-     * @param d - Object containing input data, query parameters, and headers
-     * @returns - Function result
-     *
-     * @example
-     * const result = await platform.function().run("myFunction", {input: { foo: "bar" }})
-     */
     async run(id, d) {
         const { data } = await this.client.post(`/v1/system/function/run/${id}`, d.input, {
             params: d.query,
@@ -19891,10 +19885,9 @@ class Sandbox extends PlatformBaseClient {
 }
 
 class System extends PlatformBaseClient {
-    async resourceResolver(ref, resourceName, format) {
+    async resourceResolver(prn, format) {
         return await this.client.post("/v3/system/resource-resolver", {
-            type: resourceName,
-            ref,
+            prn,
             format,
         });
     }
@@ -20221,11 +20214,15 @@ class IntegrationsBaseClient extends BaseClient {
             env = env !== null && env !== void 0 ? env : __global_env__ === null || __global_env__ === void 0 ? void 0 : __global_env__.PROJECT_ENV;
             token = token !== null && token !== void 0 ? token : __global_env__ === null || __global_env__ === void 0 ? void 0 : __global_env__.PROJECT_API_TOKEN;
             if (isBrowser) {
-                if (sessionStorage.getItem('protokol_context') == "forge") {
-                    headers['X-Project-Env'] = (_b = sessionStorage.getItem('forge_app_env')) !== null && _b !== void 0 ? _b : "dev";
+                if (sessionStorage.getItem('protokol_context') === 'forge') {
+                    headers['X-Project-Env'] = (_b = sessionStorage.getItem('forge_app_env')) !== null && _b !== void 0 ? _b : 'dev';
+                    // pick up forge actor token — overrides any other token source
+                    const forgeToken = sessionStorage.getItem('forge_actor_token');
+                    if (forgeToken)
+                        token = forgeToken;
                 }
                 else {
-                    headers['X-Project-Env'] = (_c = localStorage.getItem('current_env')) !== null && _c !== void 0 ? _c : "dev";
+                    headers['X-Project-Env'] = (_c = localStorage.getItem('current_env')) !== null && _c !== void 0 ? _c : 'dev';
                 }
             }
         }
@@ -21859,6 +21856,57 @@ class Minimax extends IntegrationsBaseClient {
     }
 }
 
+class Ecommerce extends IntegrationsBaseClient {
+    /**
+     * Get the ecommerce integration user for the current project.
+     */
+    async get() {
+        return await this.client.get(`/v1/ecomm/user`);
+    }
+    /**
+     * Update ecommerce integration settings (onboarding or partial update).
+     */
+    async update(req) {
+        return await this.client.patch(`/v1/ecomm/user`, req);
+    }
+    /**
+     * Check whether a base domain subdomain is available.
+     */
+    async checkBaseDomain(domain) {
+        return await this.client.post(`/v1/ecomm/base-domain/check`, { domain });
+    }
+    /**
+     * Add a custom domain (returns a verification token for DNS validation).
+     */
+    async addCustomDomain(domain) {
+        return await this.client.post(`/v1/ecomm/domains`, { domain });
+    }
+    /**
+     * Validate a custom domain with its verification token.
+     */
+    async validateCustomDomain(domain, token) {
+        return await this.client.post(`/v1/ecomm/domains/validate`, { domain, token });
+    }
+    /**
+     * Remove a custom domain.
+     */
+    async removeCustomDomain(domain) {
+        return await this.client.delete(`/v1/ecomm/domains`, { data: { domain } });
+    }
+    /**
+     * List pending (unvalidated) custom domains.
+     */
+    async getPendingDomains() {
+        return await this.client.get(`/v1/ecomm/domains/pending`);
+    }
+    /**
+     * List validated custom domains.
+     */
+    async getValidatedDomains() {
+        return await this.client.get(`/v1/ecomm/domains/validated`);
+    }
+}
+
 // import integrations
 class Integrations extends IntegrationsBaseClient {
     constructor(options) {
@@ -21871,6 +21919,7 @@ class Integrations extends IntegrationsBaseClient {
             'serbia-utilities': new SerbiaUtil().setClient(this.client),
             'protokol-payments': new Payments().setClient(this.client),
             'protokol-minimax': new Minimax().setClient(this.client),
+            'protokol-ecommerce': new Ecommerce().setClient(this.client),
         };
     }
     getSerbiaUtilities() {
@@ -21894,6 +21943,9 @@ class Integrations extends IntegrationsBaseClient {
     getMinimax() {
         return this.getInterfaceOf('protokol-minimax');
     }
+    getEcommerce() {
+        return this.getInterfaceOf('protokol-ecommerce');
+    }
     async isInstalled(id) {
         const { data } = await this.client.get("/v1/integrations");
         return data.find((i) => i.id == id) !== undefined;
@@ -21918,6 +21970,7 @@ exports.Component = Component;
 exports.ComponentUtils = ComponentUtils;
 exports.Config = Config;
 exports.DMS = DMS;
+exports.Ecommerce = Ecommerce;
 exports.Forge = Forge;
 exports.Functions = Functions;
 exports.Integration = Integrations;

package/dist/v0.9/index.esm.js

@@ -47,11 +47,15 @@ class PlatformBaseClient extends BaseClient {
             token = token !== null && token !== void 0 ? token : __global_env__ === null || __global_env__ === void 0 ? void 0 : __global_env__.PROJECT_API_TOKEN;
             project_uuid = __global_env__ === null || __global_env__ === void 0 ? void 0 : __global_env__.PROJECT_UUID;
             if (isBrowser) {
-                if (sessionStorage.getItem('protokol_context') == "forge") {
-                    headers['X-Project-Env'] = (_b = sessionStorage.getItem('forge_app_env')) !== null && _b !== void 0 ? _b : "dev";
+                if (sessionStorage.getItem('protokol_context') === 'forge') {
+                    headers['X-Project-Env'] = (_b = sessionStorage.getItem('forge_app_env')) !== null && _b !== void 0 ? _b : 'dev';
+                    // pick up forge actor token — overrides any other token source
+                    const forgeToken = sessionStorage.getItem('forge_actor_token');
+                    if (forgeToken)
+                        token = forgeToken;
                 }
                 else {
-                    headers['X-Project-Env'] = (_c = localStorage.getItem('current_env')) !== null && _c !== void 0 ? _c : "dev";
+                    headers['X-Project-Env'] = (_c = localStorage.getItem('current_env')) !== null && _c !== void 0 ? _c : 'dev';
                 }
             }
         }
@@ -235,7 +239,7 @@ class Component extends PlatformBaseClient {
     async updateMany(data, options) {
         return await this.client.patch(`${this.getComponentPath()}/models/bulk`, {
             data,
-            options
+            options,
         });
     }
     /**
@@ -469,16 +473,6 @@ class Functions extends PlatformBaseClient {
     async update(uuid, update) {
         return await this.client.patch(`/v1/system/function/${uuid}`, update);
     }
-    /**
-     * Run platform function
-     *
-     * @param id - Function ID
-     * @param d - Object containing input data, query parameters, and headers
-     * @returns - Function result
-     *
-     * @example
-     * const result = await platform.function().run("myFunction", {input: { foo: "bar" }})
-     */
     async run(id, d) {
         const { data } = await this.client.post(`/v1/system/function/run/${id}`, d.input, {
             params: d.query,
@@ -922,10 +916,9 @@ class Sandbox extends PlatformBaseClient {
 }
 
 class System extends PlatformBaseClient {
-    async resourceResolver(ref, resourceName, format) {
+    async resourceResolver(prn, format) {
         return await this.client.post("/v3/system/resource-resolver", {
-            type: resourceName,
-            ref,
+            prn,
             format,
         });
     }
@@ -1252,11 +1245,15 @@ class IntegrationsBaseClient extends BaseClient {
             env = env !== null && env !== void 0 ? env : __global_env__ === null || __global_env__ === void 0 ? void 0 : __global_env__.PROJECT_ENV;
             token = token !== null && token !== void 0 ? token : __global_env__ === null || __global_env__ === void 0 ? void 0 : __global_env__.PROJECT_API_TOKEN;
             if (isBrowser) {
-                if (sessionStorage.getItem('protokol_context') == "forge") {
-                    headers['X-Project-Env'] = (_b = sessionStorage.getItem('forge_app_env')) !== null && _b !== void 0 ? _b : "dev";
+                if (sessionStorage.getItem('protokol_context') === 'forge') {
+                    headers['X-Project-Env'] = (_b = sessionStorage.getItem('forge_app_env')) !== null && _b !== void 0 ? _b : 'dev';
+                    // pick up forge actor token — overrides any other token source
+                    const forgeToken = sessionStorage.getItem('forge_actor_token');
+                    if (forgeToken)
+                        token = forgeToken;
                 }
                 else {
-                    headers['X-Project-Env'] = (_c = localStorage.getItem('current_env')) !== null && _c !== void 0 ? _c : "dev";
+                    headers['X-Project-Env'] = (_c = localStorage.getItem('current_env')) !== null && _c !== void 0 ? _c : 'dev';
                 }
             }
         }
@@ -2890,6 +2887,57 @@ class Minimax extends IntegrationsBaseClient {
     }
 }
 
+class Ecommerce extends IntegrationsBaseClient {
+    /**
+     * Get the ecommerce integration user for the current project.
+     */
+    async get() {
+        return await this.client.get(`/v1/ecomm/user`);
+    }
+    /**
+     * Update ecommerce integration settings (onboarding or partial update).
+     */
+    async update(req) {
+        return await this.client.patch(`/v1/ecomm/user`, req);
+    }
+    /**
+     * Check whether a base domain subdomain is available.
+     */
+    async checkBaseDomain(domain) {
+        return await this.client.post(`/v1/ecomm/base-domain/check`, { domain });
+    }
+    /**
+     * Add a custom domain (returns a verification token for DNS validation).
+     */
+    async addCustomDomain(domain) {
+        return await this.client.post(`/v1/ecomm/domains`, { domain });
+    }
+    /**
+     * Validate a custom domain with its verification token.
+     */
+    async validateCustomDomain(domain, token) {
+        return await this.client.post(`/v1/ecomm/domains/validate`, { domain, token });
+    }
+    /**
+     * Remove a custom domain.
+     */
+    async removeCustomDomain(domain) {
+        return await this.client.delete(`/v1/ecomm/domains`, { data: { domain } });
+    }
+    /**
+     * List pending (unvalidated) custom domains.
+     */
+    async getPendingDomains() {
+        return await this.client.get(`/v1/ecomm/domains/pending`);
+    }
+    /**
+     * List validated custom domains.
+     */
+    async getValidatedDomains() {
+        return await this.client.get(`/v1/ecomm/domains/validated`);
+    }
+}
+
 // import integrations
 class Integrations extends IntegrationsBaseClient {
     constructor(options) {
@@ -2902,6 +2950,7 @@ class Integrations extends IntegrationsBaseClient {
             'serbia-utilities': new SerbiaUtil().setClient(this.client),
             'protokol-payments': new Payments().setClient(this.client),
             'protokol-minimax': new Minimax().setClient(this.client),
+            'protokol-ecommerce': new Ecommerce().setClient(this.client),
         };
     }
     getSerbiaUtilities() {
@@ -2925,6 +2974,9 @@ class Integrations extends IntegrationsBaseClient {
     getMinimax() {
         return this.getInterfaceOf('protokol-minimax');
     }
+    getEcommerce() {
+        return this.getInterfaceOf('protokol-ecommerce');
+    }
     async isInstalled(id) {
         const { data } = await this.client.get("/v1/integrations");
         return data.find((i) => i.id == id) !== undefined;
@@ -2943,4 +2995,4 @@ class Integrations extends IntegrationsBaseClient {
 // Export all API modules for version 0.9
 // This version has specific method signatures and behaviors for v0.9
 
-export { APIUser, Apps, Component, ComponentUtils, Config, DMS, Forge, Functions, Integrations as Integration, Integrations, Invoicing, Mail, Payments, Platform, Project, Ratchet, Sandbox, SerbiaUtil, System, Thunder, Users, VPFR, Workflow, Platform as default };
+export { APIUser, Apps, Component, ComponentUtils, Config, DMS, Ecommerce, Forge, Functions, Integrations as Integration, Integrations, Invoicing, Mail, Payments, Platform, Project, Ratchet, Sandbox, SerbiaUtil, System, Thunder, Users, VPFR, Workflow, Platform as default };

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

@@ -65,16 +65,17 @@ type Model = {
     [key: string]: any;
 };
 type UpdateOptions = {
-    forceUpdateProtectedFields: boolean;
+    force_update_protected_fields: boolean;
 };
 type UpdateManyOptions = UpdateOptions & {
-    rollbackOnError: boolean;
+    rollback_on_error: boolean;
 };
 type CreateManyOptions = {
-    rollbackOnError: boolean;
+    rollback_on_error: boolean;
 };
 type ModifyOptions = {
     upsert: boolean;
+    force_update_protected_fields?: boolean;
 };
 type ComponentOptions = {
     version?: string;

package/dist/v0.9/types/functions.d.ts

@@ -0,0 +1,41 @@
+/**
+ * PlatformFunctions is an open interface that serves as a registry of platform
+ * function signatures. It is empty by default and can be extended in two ways:
+ *
+ * 1. **At build time** — run `ptkl generate-types` to fetch your project's
+ *    functions and emit a `.d.ts` file with a module augmentation block:
+ *    ```ts
+ *    declare module "@ptkl/sdk" {
+ *      interface PlatformFunctions {
+ *        "send_email": { input: { body: string; to: string }; output: { status: boolean } }
+ *      }
+ *    }
+ *    ```
+ *
+ * 2. **At runtime in Monaco editors** — the editor auto-patches the interface
+ *    from your project's live function signatures.
+ */
+export interface PlatformFunctions {
+}
+/**
+ * Access a single platform function's signature type by name.
+ *
+ * @example
+ * type EmailSig = PlatformFunction<"send_email">
+ * // → { input: { body: string; to: string }; output: { status: boolean } }
+ */
+export type PlatformFunction<K extends keyof PlatformFunctions> = PlatformFunctions[K];
+/** Inferred input type for a registered function, falling back to a generic record. */
+export type FunctionInput<K extends keyof PlatformFunctions> = PlatformFunctions[K] extends {
+    input: infer I;
+} ? I : Record<string, any>;
+/** Inferred output type for a registered function, falling back to any. */
+export type FunctionOutput<K extends keyof PlatformFunctions> = PlatformFunctions[K] extends {
+    output: infer O;
+} ? O : any;
+/** Parameters shape for a typed function call. */
+export type FunctionCallParams<K extends keyof PlatformFunctions> = {
+    input: FunctionInput<K>;
+    query?: Record<string, string>;
+    headers?: Record<string, string>;
+};