@ptkl/sdk 1.3.4 → 1.5.0

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';
                 }
             }
         }
@@ -76,8 +80,7 @@ class PlatformBaseClient extends BaseClient {
             headers: {
                 ...headers,
                 'Content-Type': 'application/json',
-            },
-            withCredentials: true,
+            }
         });
         super(client);
         this.env = null;
@@ -235,7 +238,7 @@ class Component extends PlatformBaseClient {
     async updateMany(data, options) {
         return await this.client.patch(`${this.getComponentPath()}/models/bulk`, {
             data,
-            options
+            options,
         });
     }
     /**
@@ -469,16 +472,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 +915,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 +1244,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';
                 }
             }
         }
@@ -1280,8 +1276,7 @@ class IntegrationsBaseClient extends BaseClient {
             timeout: 30000,
             headers: {
                 ...headers,
-            },
-            withCredentials: true,
+            }
         });
         super(client);
         this.env = null;
@@ -2890,6 +2885,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 +2948,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 +2972,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 +2993,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>;
+};

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

@@ -0,0 +1,199 @@
+export type IDNamePair = {
+    id: string;
+    name: string;
+};
+export type ShippingMethodsConfig = {
+    methods: IDNamePair[];
+};
+export type PaymentMethodsConfig = {
+    methods: IDNamePair[];
+};
+export type PaymentProvidersConfig = {
+    options?: IDNamePair;
+};
+export type CartSettings = {
+    shipping_methods: ShippingMethodsConfig;
+    payment_methods: PaymentMethodsConfig;
+    payment_providers: PaymentProvidersConfig;
+};
+export type PriceSettings = {
+    default_currency: IDNamePair;
+};
+export type I18nSettings = {
+    default_locale: IDNamePair;
+    locales: IDNamePair[];
+};
+export type LogoConfig = {
+    position: number;
+    src: string;
+    alt: string;
+    width: number;
+    height: number;
+};
+export type ItemsConfig = {
+    position: number;
+    menu: IDNamePair;
+};
+export type ActionsConfig = {
+    position: number;
+    icons: Record<string, any>;
+};
+export type HeaderSettings = {
+    logo: LogoConfig;
+    items: ItemsConfig;
+    actions: ActionsConfig;
+};
+export type HomepageSection = {
+    id: string;
+    type: string;
+    show: boolean;
+    settings: Record<string, any>;
+};
+export type HomepageSettings = {
+    sections: HomepageSection[];
+};
+export type CategoryInfoConfig = {
+    text_position: IDNamePair;
+    show_title: boolean;
+    show_description: boolean;
+    show_image: boolean;
+};
+export type CategoryHeaderConfig = {
+    use_breadcrumbs: boolean;
+    category_info: CategoryInfoConfig;
+};
+export type CategoryFiltersConfig = {
+    show: boolean;
+    type: IDNamePair;
+    use_accordion: boolean;
+};
+export type CategorySettings = {
+    header: CategoryHeaderConfig;
+    filters: CategoryFiltersConfig;
+};
+export type DisplayConfig = {
+    show: boolean;
+    text_position: IDNamePair;
+    position: number;
+};
+export type SimpleDisplayConfig = {
+    show: boolean;
+};
+export type InventoryConfig = {
+    show: boolean;
+    text_position: IDNamePair;
+    position: number;
+    allow_backorder: boolean;
+};
+export type ActionButtonConfig = {
+    icon: IDNamePair;
+    button_variant: IDNamePair;
+    show: boolean;
+};
+export type ProductActionsConfig = {
+    position: number;
+    align: IDNamePair;
+    add_to_cart: ActionButtonConfig;
+    add_to_wishlist: ActionButtonConfig;
+};
+export type QuantitySelectorConfig = {
+    show: boolean;
+    text_position: IDNamePair;
+};
+export type ProductInfoConfig = {
+    title: DisplayConfig;
+    sku: DisplayConfig;
+    stock_status: SimpleDisplayConfig;
+    inventory: InventoryConfig;
+    description: DisplayConfig;
+    variants: DisplayConfig;
+    price: DisplayConfig;
+    actions: ProductActionsConfig;
+    discount_badge?: SimpleDisplayConfig;
+    quantity_selector?: QuantitySelectorConfig;
+    specifications?: SimpleDisplayConfig;
+};
+export type ProductSettings = {
+    product_info: ProductInfoConfig;
+};
+export type FooterLogoConfig = {
+    src: string;
+    alt: string;
+    width: number;
+    height: number;
+};
+export type FooterColumnOne = {
+    logo: FooterLogoConfig;
+    socials: any[];
+};
+export type FooterSettings = {
+    column_one: FooterColumnOne;
+};
+export type EcommerceSettings = {
+    maintenance: boolean;
+    cart: CartSettings;
+    price: PriceSettings;
+    i18n: I18nSettings;
+    header: HeaderSettings;
+    homepage: HomepageSettings;
+    category: CategorySettings;
+    product: ProductSettings;
+    footer: FooterSettings;
+    theme?: any;
+};
+export type EcommEnvSettings = {
+    dev: EcommerceSettings | null;
+    live: EcommerceSettings | null;
+};
+export type CompanyInfo = {
+    vat_number: string;
+    legal_name: string;
+    company_name: string;
+    address: string;
+    city: string;
+    zip_code: string;
+    phone: string;
+    email: string;
+    legal_representative: string;
+    additional_info?: Record<string, any>;
+};
+export type Documentation = {
+    terms_of_service: string | null;
+    privacy_policy: string | null;
+};
+export type EcommerceIntegrationUser = {
+    project_uuid: string;
+    base_domain: string;
+    custom_domains: string[];
+    company: CompanyInfo;
+    merchant_description: string;
+    mcc: string[];
+    documentation: Documentation;
+    product_types: string[];
+    settings: EcommEnvSettings;
+    data: Record<string, any>;
+    created_at: string;
+    updated_at: string;
+    deleted_at?: string | null;
+};
+export type UpdateEcommerceSettingsRequest = {
+    base_domain?: string;
+    custom_domains?: string[];
+    company?: Partial<CompanyInfo>;
+    merchant_description?: string;
+    mcc?: string[];
+    product_types?: string[];
+    documentation?: Partial<Documentation>;
+    settings?: Partial<EcommEnvSettings>;
+};
+export type CheckDomainResponse = {
+    domain: string;
+    available: boolean;
+};
+export type AddDomainResponse = {
+    integration: EcommerceIntegrationUser;
+    verification_token: string;
+};
+export type DomainsResponse = {
+    domains: string[];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptkl/sdk",
-  "version": "1.3.4",
+  "version": "1.5.0",
   "scripts": {
     "build": "rollup -c",
     "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",
@@ -13,17 +13,17 @@
     ".": {
       "import": "./dist/v0.9/index.esm.js",
       "require": "./dist/v0.9/index.cjs.js",
-      "types": "./dist/v0.9/index.d.ts"
+      "types": "./dist/v0.9/api/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"
+      "types": "./dist/v0.10/api/index.d.ts"
     }
   },
   "main": "./dist/v0.10/index.cjs.js",
   "module": "./dist/v0.10/index.esm.js",
-  "types": "./dist/v0.10/index.d.ts",
+  "types": "./dist/v0.10/api/index.d.ts",
   "author": "protokol.io",
   "license": "ISC",
   "type": "module",
@@ -44,6 +44,7 @@
     "typescript": "^5.6.3"
   },
   "dependencies": {
+    "@ptkl/sdk": "file:",
     "@rollup/plugin-replace": "^6.0.2",
     "axios": "^1.7.7",
     "dom-parser": "^1.1.5",