@ptkl/sdk 1.3.2 → 1.4.0

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.2",
+  "version": "1.4.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",