@commercelayer/app-elements 5.4.2 → 5.5.1

package/dist/ui/forms/RuleEngine/Condition/ValueComponents/InputTextRange.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+import { ItemWithValue } from '../../utils';
+export declare function InputTextRange({ value, onChange }: {
+    value: ItemWithValue['value'];
+    onChange: (value: [string | null, string | null]) => void;
+}): React.JSX.Element;

package/dist/ui/forms/RuleEngine/Condition/hooks.d.ts

@@ -0,0 +1,5 @@
+import { atPath } from '../../CodeEditor/fetchCoreResourcesSuggestions';
+import { SchemaConditionItem } from '../utils';
+export declare function useResourcePathInfos(item: SchemaConditionItem | null): {
+    infos: Awaited<ReturnType<typeof atPath>> | undefined;
+};

package/dist/ui/forms/RuleEngine/Condition/index.d.ts

@@ -0,0 +1,8 @@
+import { default as React } from 'react';
+import { SchemaCondition } from '../utils';
+export declare function Condition({ item, children, nestingLevel, pathPrefix }: {
+    item?: SchemaCondition;
+    nestingLevel?: number;
+    children?: React.JSX.Element;
+    pathPrefix: string;
+}): React.JSX.Element;

package/dist/ui/forms/RuleEngine/Condition/utils.d.ts

@@ -0,0 +1,3 @@
+import { atPath } from '../../CodeEditor/fetchCoreResourcesSuggestions';
+import { ItemWithValue } from '../utils';
+export declare function guessFieldType(value: ItemWithValue['value'] | undefined): NonNullable<Awaited<ReturnType<typeof atPath>>['field']>['type'];

package/dist/ui/forms/RuleEngine/RuleEngine.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+import { RuleEngineProps } from './RuleEngineComponent';
+export declare const RuleEngine: React.FC<RuleEngineProps>;

package/dist/ui/forms/RuleEngine/RuleEngineComponent.d.ts

@@ -0,0 +1,22 @@
+import { CodeEditorProps } from '../CodeEditor';
+import { InputWrapperBaseProps } from '../../internals/InputWrapper';
+import { default as React } from 'react';
+import { SetOptional, SetRequired } from 'type-fest';
+import { RulesForOrderContext } from './schema.order_rules';
+type Schema = SetRequired<RulesForOrderContext, 'rules'>;
+export interface RuleEngineProps extends Omit<InputWrapperBaseProps, 'label' | 'inline'>, SetOptional<Pick<HTMLInputElement, 'id' | 'name'>, 'id' | 'name'>, Pick<CodeEditorProps, 'defaultValue' | 'value'> {
+    /**
+     * Default value for the CodeEditor visibility.
+     * If not provided, the CodeEditor will be hidden by default.
+     * @default false
+     */
+    defaultCodeEditorVisible?: boolean;
+    /**
+     * Triggered when the editor value changes.
+     * @param value The new editor value.
+     * @returns
+     */
+    onChange?: (value: Schema) => void;
+}
+export declare function RuleEngine(props: RuleEngineProps): React.JSX.Element;
+export {};

package/dist/ui/forms/RuleEngine/RuleEngineContext.d.ts

@@ -0,0 +1,18 @@
+import { default as React } from 'react';
+import { Schema } from './utils';
+interface State {
+    value: Schema;
+    selectedRuleIndex: number;
+}
+interface RuleEngineContextType {
+    state: State;
+    setPath: (path: string, value: unknown) => void;
+    setSelectedRuleIndex: (index: number) => void;
+    setValue: (value: Schema) => void;
+}
+export declare function RuleEngineProvider({ children, initialValue }: {
+    children: React.ReactNode;
+    initialValue: Schema;
+}): React.JSX.Element;
+export declare function useRuleEngine(): RuleEngineContextType;
+export {};

package/dist/ui/forms/RuleEngine/RuleName.d.ts

@@ -0,0 +1 @@
+export declare function RuleName(): React.JSX.Element;

package/dist/ui/forms/RuleEngine/index.d.ts

@@ -0,0 +1,2 @@
+export { RuleEngine } from './RuleEngine';
+export type { RuleEngineProps } from './RuleEngineComponent';

package/dist/ui/forms/RuleEngine/schema.order_rules.d.ts

@@ -0,0 +1,335 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * The logic to determine an overall match of the conditions.
+ */
+export type ConditionsLogic = "and" | "or";
+/**
+ * Policy to determine if a condition is a match. If value is any (default), it will match as long as one fact it's a match, if value is all, it will match if all facts are a match.
+ */
+export type Scope = "any" | "all";
+/**
+ * Identifier of the group to assign the matches of the condition invoked.
+ */
+export type Group = string;
+/**
+ * An array who contains all conditions to be evaluated by the engine within the rule.
+ */
+export type Conditions = ({
+    /**
+     * Field to apply the condition.
+     */
+    field: string;
+    /**
+     * Matcher to be used against the field and value.
+     */
+    matcher: "start_with" | "not_start_with" | "end_with" | "not_end_with" | "does_not_match" | "matches" | "multiple" | "eq" | "not_eq" | "lt" | "lteq" | "gt" | "gteq" | "gt_lt" | "gteq_lt" | "gt_lteq" | "gteq_lteq" | "is_in" | "is_not_in" | "array_match";
+    scope?: Scope;
+    group?: Group;
+    value: number | string | boolean | (string | number)[] | {
+        /**
+         * Items that are in to match in AND logic.
+         */
+        in_and?: (string | number)[];
+        /**
+         * Items that are in to match in OR logic.
+         */
+        in_or?: (string | number)[];
+        /**
+         * Items that are not in to match in AND logic.
+         */
+        not_in_and?: (string | number)[];
+        /**
+         * Items that are not to match in OR logic.
+         */
+        not_in_or?: (string | number)[];
+    };
+    /**
+     * Aggregation conditions to execute within the result of the existing condition.
+     */
+    aggregations?: Aggregation[];
+    /**
+     * Nested conditions to be evaluated within the context of the main condition.
+     */
+    nested?: {
+        conditions_logic?: ConditionsLogic;
+        conditions?: Conditions;
+        [k: string]: unknown;
+    };
+} | {
+    /**
+     * Field to apply the condition.
+     */
+    field: string;
+    /**
+     * Matcher to be used against the field.
+     */
+    matcher: "blank" | "present" | "null" | "not_null";
+    scope?: Scope;
+    group?: Group;
+    /**
+     * Aggregation conditions to execute within the result of the existing condition.
+     */
+    aggregations?: Aggregation[];
+    /**
+     * Nested conditions to be evaluated within the context of the main condition.
+     */
+    nested?: {
+        conditions_logic?: ConditionsLogic;
+        conditions?: Conditions;
+        [k: string]: unknown;
+    };
+})[];
+/**
+ * The resource on which to apply the action (expressed in dot notation). Can be an attribute if you set also the identifier key.
+ */
+export type Selector = string;
+/**
+ * An identifier value to address one or more specific instances based on the attribute defined in the selector key (if any). Cannot be used if the selector is a resource.
+ */
+export type Identifier = string;
+/**
+ * The groups on which to apply the action (must be one or more among the ones defined when grouping the matches of the related conditions).
+ */
+export type Groups = string[];
+/**
+ * If provided, applies the action to a specific attribute instead of the default one.
+ */
+export type ApplyOn = string;
+/**
+ * Creates bundles based on the groups provided.
+ */
+export type Bundle = {
+    /**
+     * The criteria to be used to select the matches and create the bundles across groups.
+     */
+    type?: "balanced";
+    sort: Sort;
+} | {
+    /**
+     * The criteria to be used to select the matches and create the bundles across groups.
+     */
+    type?: "every";
+    sort: Sort;
+    /**
+     * Value to be used to do the bundle every calculation.
+     */
+    value: number;
+};
+/**
+ * Rules payload within order context for the rules engine of Commerce Layer.
+ */
+export interface RulesForOrderContext {
+    /**
+     * Main container with all rules.
+     */
+    rules?: {
+        /**
+         * Identifier of the rule, recommended to use UUID.
+         */
+        id?: string;
+        /**
+         * Name of the rule
+         */
+        name: string;
+        /**
+         * The priority order of the rule evaluation.
+         */
+        priority?: number;
+        conditions_logic?: ConditionsLogic;
+        conditions: Conditions;
+        /**
+         * Array of actions that will be executed if the rule it's a match.
+         */
+        actions: ({
+            /**
+             * The type of action you want to apply.
+             */
+            type: "percentage";
+            selector: Selector;
+            identifier?: Identifier;
+            groups: Groups;
+            aggregation?: Aggregation;
+            /**
+             * Percentage to be discounted,
+             */
+            value: number;
+            apply_on?: ApplyOn;
+            bundle?: Bundle;
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "percentage";
+            selector: Selector;
+            identifier?: Identifier;
+            groups?: Groups;
+            aggregation?: Aggregation;
+            /**
+             * Percentage to be discounted,
+             */
+            value: number;
+            apply_on?: ApplyOn;
+            limit?: Limit;
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "fixed_amount";
+            selector: Selector;
+            identifier?: Identifier;
+            groups: Groups;
+            aggregation?: Aggregation;
+            /**
+             * The discount fixed amount to be applied.
+             */
+            value: number;
+            bundle?: Bundle;
+            apply_on?: ApplyOn;
+            /**
+             * The type of distribution of the discount over the items.
+             */
+            discount_mode?: "distributed" | "default";
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "fixed_amount";
+            selector: Selector;
+            identifier?: Identifier;
+            groups?: Groups;
+            aggregation?: Aggregation;
+            /**
+             * The discount fixed amount to be applied.
+             */
+            value: number;
+            apply_on?: ApplyOn;
+            limit?: Limit;
+            /**
+             * The type of distribution of the discount over the items.
+             */
+            discount_mode?: "distributed" | "default";
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "fixed_price";
+            selector: Selector;
+            identifier?: Identifier;
+            groups: Groups;
+            aggregation?: Aggregation;
+            /**
+             * The price fixed amount to be applied.
+             */
+            value: number;
+            bundle?: Bundle;
+            apply_on?: ApplyOn;
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "fixed_price";
+            selector: Selector;
+            identifier?: Identifier;
+            groups?: Groups;
+            aggregation?: Aggregation;
+            /**
+             * The price fixed amount to be applied.
+             */
+            value: number;
+            apply_on?: ApplyOn;
+            limit?: Limit;
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "buy_x_pay_y";
+            selector?: Selector;
+            identifier?: Identifier;
+            groups?: Groups;
+            aggregation?: Aggregation;
+            value: {
+                /**
+                 * The buy X part of the action
+                 */
+                x: number;
+                /**
+                 * The pay Y part of the action.
+                 */
+                y: number;
+                /**
+                 * Max number of items to consider for the calculation.
+                 */
+                result_item_limit?: number;
+                [k: string]: unknown;
+            };
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "every_x_discount_y";
+            selector: Selector;
+            identifier?: Identifier;
+            groups?: Groups;
+            aggregation?: Aggregation;
+            value: {
+                /**
+                 * Amount to discount every.
+                 */
+                x: number;
+                /**
+                 * Amount to be discounted to each interval.
+                 */
+                y: number;
+                /**
+                 * Uses the field to do the calculation for the action.
+                 */
+                attribute: string;
+                [k: string]: unknown;
+            };
+        })[];
+    }[];
+    [k: string]: unknown;
+}
+export interface Aggregation {
+    /**
+     * Field to apply the condition.
+     */
+    field: string;
+    /**
+     * Matcher to be used against the field and value.
+     */
+    matcher: "multiple" | "eq" | "not_eq" | "lt" | "lteq" | "gt" | "gteq";
+    value: number;
+    /**
+     * Operator to aggregate over previous results.
+     */
+    operator: "sum" | "min" | "max" | "count" | "count_uniq";
+}
+/**
+ * Sorting configuration for the given function
+ */
+export interface Sort {
+    /**
+     * The field to apply the sorting.
+     */
+    attribute: string;
+    /**
+     * The sort criteria to be used.
+     */
+    direction: "asc" | "desc";
+    [k: string]: unknown;
+}
+/**
+ * Restriction on how many resources will be affected by the action.
+ */
+export interface Limit {
+    /**
+     * The number of items to return based on the limit type.
+     */
+    value: number;
+    sort: Sort;
+}

package/dist/ui/forms/RuleEngine/schema.price_rules.d.ts

@@ -0,0 +1,286 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * The logic to determine an overall match of the conditions.
+ */
+export type ConditionsLogic = "and" | "or";
+/**
+ * Policy to determine if a condition is a match. If value is any (default), it will match as long as one fact it's a match, if value is all, it will match if all facts are a match.
+ */
+export type Scope = "any" | "all";
+/**
+ * Identifier of the group to assign the matches of the condition invoked.
+ */
+export type Group = string;
+/**
+ * An array who contains all conditions to be evaluated by the engine within the rule.
+ */
+export type Conditions = ({
+    /**
+     * Field to apply the condition.
+     */
+    field: string;
+    /**
+     * Matcher to be used against the field and value.
+     */
+    matcher: "start_with" | "not_start_with" | "end_with" | "not_end_with" | "does_not_match" | "matches" | "multiple" | "eq" | "not_eq" | "lt" | "lteq" | "gt" | "gteq" | "gt_lt" | "gteq_lt" | "gt_lteq" | "gteq_lteq" | "is_in" | "is_not_in" | "array_match";
+    scope?: Scope;
+    group?: Group;
+    value: number | string | boolean | (string | number)[] | {
+        /**
+         * Items that are in to match in AND logic.
+         */
+        in_and?: (string | number)[];
+        /**
+         * Items that are in to match in OR logic.
+         */
+        in_or?: (string | number)[];
+        /**
+         * Items that are not in to match in AND logic.
+         */
+        not_in_and?: (string | number)[];
+        /**
+         * Items that are not to match in OR logic.
+         */
+        not_in_or?: (string | number)[];
+    };
+    /**
+     * Aggregation conditions to execute within the result of the existing condition.
+     */
+    aggregations?: Aggregation[];
+    /**
+     * Nested conditions to be evaluated within the context of the main condition.
+     */
+    nested?: {
+        conditions_logic?: ConditionsLogic;
+        conditions?: Conditions;
+        [k: string]: unknown;
+    };
+} | {
+    /**
+     * Field to apply the condition.
+     */
+    field: string;
+    /**
+     * Matcher to be used against the field.
+     */
+    matcher: "blank" | "present" | "null" | "not_null";
+    scope?: Scope;
+    group?: Group;
+    /**
+     * Aggregation conditions to execute within the result of the existing condition.
+     */
+    aggregations?: Aggregation[];
+    /**
+     * Nested conditions to be evaluated within the context of the main condition.
+     */
+    nested?: {
+        conditions_logic?: ConditionsLogic;
+        conditions?: Conditions;
+        [k: string]: unknown;
+    };
+})[];
+/**
+ * The resource on which to apply the action (expressed in dot notation). Can be an attribute if you set also the identifier key.
+ */
+export type Selector = string;
+/**
+ * An identifier value to address one or more specific instances based on the attribute defined in the selector key (if any). Cannot be used if the selector is a resource.
+ */
+export type Identifier = string;
+/**
+ * The groups on which to apply the action (must be one or more among the ones defined when grouping the matches of the related conditions).
+ */
+export type Groups = string[];
+/**
+ * If provided, applies the action to a specific attribute instead of the default one.
+ */
+export type ApplyOn = string;
+/**
+ * Creates bundles based on the groups provided.
+ */
+export type Bundle = {
+    /**
+     * The criteria to be used to select the matches and create the bundles across groups.
+     */
+    type?: "balanced";
+    sort: Sort;
+} | {
+    /**
+     * The criteria to be used to select the matches and create the bundles across groups.
+     */
+    type?: "every";
+    sort: Sort;
+    /**
+     * Value to be used to do the bundle every calculation.
+     */
+    value: number;
+};
+/**
+ * Rules payload within price context for the rules engine of Commerce Layer.
+ */
+export interface RulesForPriceContext {
+    /**
+     * Main container with all rules.
+     */
+    rules?: {
+        /**
+         * Identifier of the rule, recommended to use UUID.
+         */
+        id?: string;
+        name: {
+            [k: string]: unknown;
+        };
+        /**
+         * The priority order of the rule evaluation.
+         */
+        priority?: number;
+        conditions_logic?: ConditionsLogic;
+        conditions: Conditions;
+        /**
+         * Array of actions that will be executed if the rule it's a match.
+         */
+        actions: ({
+            /**
+             * The type of action you want to apply.
+             */
+            type: "percentage";
+            selector: Selector;
+            identifier?: Identifier;
+            groups: Groups;
+            aggregation?: Aggregation;
+            /**
+             * Percentage to be discounted,
+             */
+            value: number;
+            apply_on?: ApplyOn;
+            bundle?: Bundle;
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "percentage";
+            selector: Selector;
+            identifier?: Identifier;
+            groups?: Groups;
+            aggregation?: Aggregation;
+            /**
+             * Percentage to be discounted,
+             */
+            value: number;
+            apply_on?: ApplyOn;
+            limit?: Limit;
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "fixed_amount";
+            selector: Selector;
+            identifier?: Identifier;
+            groups: Groups;
+            aggregation?: Aggregation;
+            /**
+             * The discount fixed amount to be applied.
+             */
+            value: number;
+            bundle?: Bundle;
+            apply_on?: ApplyOn;
+            /**
+             * The type of distribution of the discount over the items.
+             */
+            discount_mode?: ["distributed", "default"];
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "fixed_amount";
+            selector: Selector;
+            identifier?: Identifier;
+            groups?: Groups;
+            aggregation?: Aggregation;
+            /**
+             * The discount fixed amount to be applied.
+             */
+            value: number;
+            apply_on?: ApplyOn;
+            limit?: Limit;
+            /**
+             * The type of distribution of the discount over the items.
+             */
+            discount_mode?: ["distributed", "default"];
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "fixed_price";
+            selector: Selector;
+            identifier?: Identifier;
+            groups: Groups;
+            aggregation?: Aggregation;
+            /**
+             * The price fixed amount to be applied.
+             */
+            value: number;
+            bundle?: Bundle;
+            apply_on?: ApplyOn;
+        } | {
+            /**
+             * The type of action you want to apply.
+             */
+            type: "fixed_price";
+            selector: Selector;
+            identifier?: Identifier;
+            groups?: Groups;
+            aggregation?: Aggregation;
+            /**
+             * The price fixed amount to be applied.
+             */
+            value: number;
+            apply_on?: ApplyOn;
+            limit?: Limit;
+        })[];
+    }[];
+    [k: string]: unknown;
+}
+export interface Aggregation {
+    /**
+     * Field to apply the condition.
+     */
+    field: string;
+    /**
+     * Matcher to be used against the field and value.
+     */
+    matcher: "multiple" | "eq" | "not_eq" | "lt" | "lteq" | "gt" | "gteq";
+    value: number;
+    /**
+     * Operator to aggregate over previous results.
+     */
+    operator: "sum" | "min" | "max" | "count" | "count_uniq";
+}
+/**
+ * Sorting configuration for the given function
+ */
+export interface Sort {
+    /**
+     * The field to apply the sorting.
+     */
+    attribute: string;
+    /**
+     * The sort criteria to be used.
+     */
+    direction: "asc" | "desc";
+    [k: string]: unknown;
+}
+/**
+ * Restriction on how many resources will be affected by the action.
+ */
+export interface Limit {
+    /**
+     * The number of items to return based on the limit type.
+     */
+    value: number;
+    sort: Sort;
+}