@ptkl/sdk 1.6.0 → 1.6.2

package/dist/index.0.10.js

@@ -927,8 +927,8 @@ var ProtokolSDK010 = (function (exports, axios) {
         async list() {
             return await this.client.get("/v1/system/components");
         }
-        async create(data) {
-            return await this.client.post("/v3/system/component/create", data);
+        async delete(ref) {
+            return await this.client.delete(`/v3/system/component/${ref}`);
         }
         /**
          * Setup a component with settings in a single atomic operation.

package/dist/index.0.9.js

@@ -645,8 +645,11 @@ var ProtokolSDK09 = (function (exports, axios) {
         async list() {
             return await this.client.get("/v1/system/components");
         }
-        async create(data) {
-            return await this.client.post("/v3/system/component/create", data);
+        async delete(ref) {
+            return await this.client.delete(`/v3/system/component/${ref}`);
+        }
+        async setup(data) {
+            return await this.client.post("/v3/system/component/setup", data);
         }
     }
 

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptkl/sdk",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "scripts": {
     "build": "rollup -c",
     "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",

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

@@ -3,7 +3,7 @@ import { ComponentListResponse, SetupData, ComponentCreateResponse } from "../ty
 import PlatformBaseClient from "./platformBaseClient";
 export default class ComponentUtils extends PlatformBaseClient {
     list(): Promise<AxiosResponse<ComponentListResponse>>;
-    create(data: any): Promise<AxiosResponse<any, any>>;
+    delete(ref: string): Promise<AxiosResponse<any, any>>;
     /**
      * Setup a component with settings in a single atomic operation.
      * This is more comprehensive than create as it handles component creation

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

@@ -19893,8 +19893,8 @@ class ComponentUtils extends PlatformBaseClient {
     async list() {
         return await this.client.get("/v1/system/components");
     }
-    async create(data) {
-        return await this.client.post("/v3/system/component/create", data);
+    async delete(ref) {
+        return await this.client.delete(`/v3/system/component/${ref}`);
     }
     /**
      * Setup a component with settings in a single atomic operation.

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

@@ -926,8 +926,8 @@ class ComponentUtils extends PlatformBaseClient {
     async list() {
         return await this.client.get("/v1/system/components");
     }
-    async create(data) {
-        return await this.client.post("/v3/system/component/create", data);
+    async delete(ref) {
+        return await this.client.delete(`/v3/system/component/${ref}`);
     }
     /**
      * Setup a component with settings in a single atomic operation.

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

@@ -367,7 +367,7 @@ type Settings = {
     list?: {
         quick_actions?: boolean;
         perPage?: number;
-        fields?: Array<{
+        fields: Array<{
             key: string;
             label: Record<string, any>;
             name?: string;
@@ -382,7 +382,7 @@ type Settings = {
             formatter?: string;
             provided_template_component?: string;
             component_template?: string;
-        }>;
+        }> | null;
     };
     fields?: SettingsField[];
     model?: {
@@ -400,20 +400,15 @@ type Settings = {
 type SetupData = {
     name: string;
     label?: Record<string, any>;
-    tag: string;
+    tag?: string;
     scope?: string;
-    public_version?: string;
-    dev_version?: string;
-    project_uuid?: string;
+    public_version: string;
+    dev_version: string;
     workspaces?: string[];
-    roles?: string[];
-    settings?: Settings;
-    env?: string;
     is_active?: boolean;
     is_public?: boolean;
     icon?: string;
-    template_component_id?: string;
-    integrator?: string;
+    settings?: Settings;
 };
 type ComponentCreateResponse = ComponentListItem;
 export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, UpdateOperators, UpdateAggregate, ModelUpdateData, ComponentOptions, ComponentListResponse, ComponentListItem, ComponentLabel, ComponentWorkspace, StreamCallback, StreamHandler, AggregateChainable, UpdateManyOptions, CreateManyOptions, Settings, SettingsField, FieldRoles, FieldConstraints, Context, Preset, PresetContext, Filters, Function, Extension, Policy, FieldAccessConfig, TemplatesDist, SetupData, ComponentCreateResponse, };

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

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

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

@@ -19613,8 +19613,11 @@ class ComponentUtils extends PlatformBaseClient {
     async list() {
         return await this.client.get("/v1/system/components");
     }
-    async create(data) {
-        return await this.client.post("/v3/system/component/create", data);
+    async delete(ref) {
+        return await this.client.delete(`/v3/system/component/${ref}`);
+    }
+    async setup(data) {
+        return await this.client.post("/v3/system/component/setup", data);
     }
 }
 

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

@@ -644,8 +644,11 @@ class ComponentUtils extends PlatformBaseClient {
     async list() {
         return await this.client.get("/v1/system/components");
     }
-    async create(data) {
-        return await this.client.post("/v3/system/component/create", data);
+    async delete(ref) {
+        return await this.client.delete(`/v3/system/component/${ref}`);
+    }
+    async setup(data) {
+        return await this.client.post("/v3/system/component/setup", data);
     }
 }
 

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

@@ -9,12 +9,14 @@ type FindParams = {
     dateFrom?: string;
     dateTo?: string;
     dateField?: string;
+    only?: string[];
+    includeFields?: string[];
     $adv?: FindAdvancedParams;
     $aggregate?: FindAggregateParams[];
 };
 type FindOptions = {
-    cache?: boolean;
-    buildttl?: number;
+    cacheTTL?: number;
+    buildTTL?: number;
     locale?: string;
     unmaskPasswords?: boolean;
 };
@@ -77,6 +79,98 @@ type ModifyOptions = {
     upsert: boolean;
     force_update_protected_fields?: boolean;
 };
+/**
+ * MongoDB update operators that can be included inline in the `data` payload.
+ *
+ * Any key starting with `$` in the data object is automatically detected as an
+ * update operator and applied with MongoDB semantics instead of the default `$set`.
+ *
+ * Supported operators:
+ * - `$inc` — Increment a numeric field
+ * - `$push` — Append to an array
+ * - `$pull` — Remove from an array by condition
+ * - `$addToSet` — Add to array only if not present
+ * - `$pop` — Remove first (-1) or last (1) element from array
+ * - `$min` — Update only if new value is less than current
+ * - `$max` — Update only if new value is greater than current
+ * - `$mul` — Multiply a numeric field
+ *
+ * @example
+ * ```ts
+ * // Data with inline operators
+ * const data = {
+ *   name: "John",          // → $set
+ *   $inc: { views: 1 },    // → $inc
+ *   $push: { tags: "vip" } // → $push
+ * }
+ * ```
+ */
+type UpdateOperators = {
+    $inc?: Record<string, number>;
+    $push?: Record<string, any>;
+    $pull?: Record<string, any>;
+    $addToSet?: Record<string, any>;
+    $pop?: Record<string, 1 | -1>;
+    $min?: Record<string, any>;
+    $max?: Record<string, any>;
+    $mul?: Record<string, number>;
+};
+/**
+ * A single element in an `$aggregate` update array. Each element is a plain
+ * object mapping field names to MongoDB aggregation expressions. You do **not**
+ * need to wrap the object in a `$set` — the API does that automatically.
+ *
+ * @example
+ * ```ts
+ * const update: UpdateAggregate = [
+ *   {
+ *   avg_rating: { $avg: "$ratings" },
+ *   tier: { $cond: { if: { $gte: ["$avg_rating", 4.5] }, then: "platinum", else: "standard" } }
+ *   }
+ * ]
+ * ```
+ */
+type UpdateAggregate = Record<string, any>[];
+/**
+ * Aggregation-expression update (v4 only). An array of field→expression objects.
+ * Each element is automatically applied as a `$set` stage, so you can compute
+ * new field values from the existing document using MongoDB aggregation
+ * expressions (`$cond`, `$avg`, `$map`, `$ifNull`, etc.).
+ *
+ * The write always runs in a transaction and is rolled back if the resulting
+ * document fails IDL validation. Cannot be combined with regular update
+ * operators (`$inc`, `$push`, etc.) in the same request.
+ *
+ * @example
+ * ```ts
+ * await product.update(uuid, {
+ *   $aggregate: [
+ *     {
+ *       avg_rating: { $avg: "$ratings" },
+ *       tier: {
+ *         $cond: {
+ *           if: { $gte: ["$avg_rating", 4.5] },
+ *           then: "platinum",
+ *           else: "standard",
+ *         },
+ *       },
+ *     },
+ *   ],
+ * })
+ * ```
+ */
+/**
+ * Model data payload that supports inline update operators.
+ * Regular fields are applied via `$set`, operator keys are applied with their
+ * respective MongoDB semantics.
+ *
+ * Pass `$aggregate` (v4 only) to use an aggregation-expression update instead
+ * of plain operators. `$aggregate` and regular operators are mutually exclusive.
+ */
+type ModelUpdateData = Record<string, any> & UpdateOperators & {
+    /** Aggregation-expression update (v4 only). Mutually exclusive with operator keys. */
+    $aggregate?: UpdateAggregate;
+};
 type ComponentOptions = {
     version?: string;
 };
@@ -114,4 +208,207 @@ type ComponentListItem = {
     storage_size: number;
 };
 type ComponentListResponse = ComponentListItem[];
-export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, ComponentOptions, ComponentListResponse, ComponentListItem, ComponentLabel, ComponentWorkspace, StreamCallback, StreamHandler, AggregateChainable, UpdateManyOptions, CreateManyOptions, };
+type FieldRoles = {
+    see: string[];
+    edit: string[];
+};
+type Context = {
+    key: string;
+    value: any;
+};
+type FieldConstraints = {
+    required?: boolean;
+    unique?: boolean;
+    placeholder?: string;
+    default?: string;
+    length?: {
+        min?: number | null;
+        max?: number | null;
+    };
+    not_allowed_words?: string;
+    regex?: string;
+    date?: {
+        pattern?: string;
+        disable_past_dates?: boolean;
+        disable_future_dates?: boolean;
+        disabled_dates?: {
+            dates?: string[];
+            to?: string;
+            from?: string;
+            days?: number[];
+            days_of_month?: number[];
+            ranges?: Array<{
+                from: string;
+                to: string;
+            }>;
+        };
+        highlighted_dates?: {
+            dates?: string[];
+            to?: string;
+            from?: string;
+            days?: number[];
+            days_of_month?: number[];
+            ranges?: Array<{
+                from: string;
+                to: string;
+            }>;
+            include_disabled?: boolean;
+        };
+    };
+    selectables?: {
+        items?: any[];
+        multiple?: boolean;
+        range?: {
+            from: number;
+            to: number;
+        };
+        custom?: boolean;
+    };
+    table?: {
+        search?: boolean;
+        per_page?: number;
+        save_on_create?: boolean;
+        fields?: SettingsField[];
+    };
+    relation?: {
+        label?: string;
+        searchOn?: string[];
+    };
+};
+type SettingsField = {
+    name: string;
+    label: Record<string, any>;
+    key: string;
+    type: string;
+    description?: Record<string, any>;
+    module?: string;
+    group?: string;
+    sortOrder?: number;
+    visible?: boolean;
+    protected?: boolean;
+    roles?: FieldRoles;
+    context?: Context[];
+    constraints?: FieldConstraints;
+    relation?: {
+        foreign?: string;
+        key?: string[];
+        type?: string;
+        foreign_uuid?: string | null;
+    };
+    mutators?: {
+        get?: string;
+        set?: string;
+    };
+    provided_template?: boolean;
+    provided_template_component?: string;
+    component_template?: string;
+    template?: string;
+    permissions?: string[];
+};
+type Filters = {
+    filter?: string;
+    filterOn?: string[];
+    dateField?: string;
+    dateFrom?: string;
+    dateTo?: string;
+    $adv?: Record<string, any>;
+};
+type PresetContext = {
+    filters?: Filters;
+    default?: boolean;
+    locked?: boolean;
+    expr?: string;
+};
+type Preset = {
+    name: string;
+    roles: string[];
+    context: PresetContext;
+};
+type Function = {
+    name: string;
+    expr: string;
+};
+type Extension = {
+    name: string;
+    is_active: boolean;
+    fields?: SettingsField[];
+    functions?: Function[];
+    workflows?: Record<string, any>[];
+    templates?: Record<string, any>;
+    templates_dist?: TemplatesDist;
+    config?: Record<string, any>;
+    version?: string;
+};
+type FieldAccessConfig = {
+    fields: string[];
+    actions: string[];
+    roles: string[];
+};
+type Policy<T = Record<string, any>> = {
+    type: string;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    priority: number;
+    config?: T;
+};
+type TemplatesDist = {
+    sdk_version: number;
+    sdk_engine: string;
+    dist: Record<string, any>;
+};
+type Settings = {
+    version?: string;
+    appearance?: {
+        list_entrypoint?: string;
+        create_entrypoint?: string;
+        edit_entrypoint?: string;
+    };
+    list?: {
+        quick_actions?: boolean;
+        perPage?: number;
+        fields: Array<{
+            key: string;
+            label: Record<string, any>;
+            name?: string;
+            sortOrder?: number;
+            sortable?: boolean;
+            filterable?: boolean;
+            sortDirection?: string;
+            sortByFormatted?: boolean;
+            filterByFormatted?: boolean;
+            formatterEditor?: string;
+            variant?: string;
+            formatter?: string;
+            provided_template_component?: string;
+            component_template?: string;
+        }> | null;
+    };
+    fields?: SettingsField[];
+    model?: {
+        events?: Record<string, any>[];
+        unique_indexes_combinations?: string[][];
+    };
+    presets?: Preset[];
+    templates?: Record<string, any>[];
+    templates_dist?: TemplatesDist;
+    config?: Record<string, any>;
+    functions?: Function[];
+    extensions?: Extension[];
+    policies?: Policy[];
+};
+type SetupData = {
+    name: string;
+    label?: Record<string, any>;
+    tag?: string;
+    scope?: string;
+    public_version: string;
+    dev_version: string;
+    workspaces?: string[];
+    is_active?: boolean;
+    is_public?: boolean;
+    icon?: string;
+    settings?: Settings;
+};
+type ComponentCreateResponse = ComponentListItem;
+export { FindParams, FindOptions, FindResponse, FindAdvancedParams, FindAggregateParams, Model, UpdateOptions, ModifyOptions, UpdateOperators, UpdateAggregate, ModelUpdateData, ComponentOptions, ComponentListResponse, ComponentListItem, ComponentLabel, ComponentWorkspace, StreamCallback, StreamHandler, AggregateChainable, UpdateManyOptions, CreateManyOptions, Settings, SettingsField, FieldRoles, FieldConstraints, Context, Preset, PresetContext, Filters, Function, Extension, Policy, FieldAccessConfig, TemplatesDist, SetupData, ComponentCreateResponse, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ptkl/sdk",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "scripts": {
     "build": "rollup -c",
     "build:monaco": "npm run build && node scripts/generate-monaco-types.cjs",