@uniformdev/assets 19.179.1-alpha.1 → 19.180.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +74 -0
- package/dist/index.d.ts +74 -0
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -371,6 +371,21 @@ interface external {
|
|
|
371
371
|
* this property will have a single value that is shared for all locales
|
|
372
372
|
*/
|
|
373
373
|
localizable?: boolean;
|
|
374
|
+
/**
|
|
375
|
+
* @description When `localizable` is true, this property controls the default localizability of the property.
|
|
376
|
+
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
|
377
|
+
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
|
378
|
+
*
|
|
379
|
+
* If `localized` is false, this has no effect.
|
|
380
|
+
*/
|
|
381
|
+
notLocalizedByDefault?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
|
384
|
+
* When combined with a localized value, each locale has independent conditional values.
|
|
385
|
+
*
|
|
386
|
+
* When not defined, conditional values are not allowed.
|
|
387
|
+
*/
|
|
388
|
+
allowConditionalValues?: boolean;
|
|
374
389
|
/** @description The configuration object for the type (type-specific) */
|
|
375
390
|
typeConfig?: unknown;
|
|
376
391
|
};
|
|
@@ -579,6 +594,65 @@ interface external {
|
|
|
579
594
|
locales?: {
|
|
580
595
|
[key: string]: unknown;
|
|
581
596
|
};
|
|
597
|
+
conditions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
|
598
|
+
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
599
|
+
localesConditions?: {
|
|
600
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* @description Array of alternate values which are based on conditions.
|
|
605
|
+
*
|
|
606
|
+
* When requested with an explicit locale parameter, or via the route API:
|
|
607
|
+
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
608
|
+
* * If no conditions match, the `value` property is used.
|
|
609
|
+
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
610
|
+
*
|
|
611
|
+
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
612
|
+
*/
|
|
613
|
+
ComponentParameterConditions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
|
614
|
+
/** @description Defines a conditional value for a component parameter */
|
|
615
|
+
ComponentParameterConditionalValue: {
|
|
616
|
+
when: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
|
617
|
+
/**
|
|
618
|
+
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
619
|
+
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
620
|
+
*/
|
|
621
|
+
value: unknown;
|
|
622
|
+
/**
|
|
623
|
+
* @description Unique sequence identifier of the conditional value within the component parameter.
|
|
624
|
+
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
625
|
+
*/
|
|
626
|
+
id: number;
|
|
627
|
+
};
|
|
628
|
+
/**
|
|
629
|
+
* @deprecated
|
|
630
|
+
* @description beta functionality subject to change
|
|
631
|
+
*/
|
|
632
|
+
VisibilityCriteriaGroup: {
|
|
633
|
+
/**
|
|
634
|
+
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
635
|
+
* @enum {string}
|
|
636
|
+
*/
|
|
637
|
+
op?: "&" | "|";
|
|
638
|
+
clauses: (external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
|
639
|
+
};
|
|
640
|
+
/**
|
|
641
|
+
* @deprecated
|
|
642
|
+
* @description beta functionality subject to change
|
|
643
|
+
*/
|
|
644
|
+
VisibilityCriteria: {
|
|
645
|
+
/** @description The rule type to execute */
|
|
646
|
+
rule: string;
|
|
647
|
+
/**
|
|
648
|
+
* @description The source value of the rule.
|
|
649
|
+
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
|
650
|
+
*/
|
|
651
|
+
source?: string;
|
|
652
|
+
/** @description The rule-definition-specific operator to test against */
|
|
653
|
+
op: string;
|
|
654
|
+
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
655
|
+
value: string | string[];
|
|
582
656
|
};
|
|
583
657
|
/** @description Defines a connection to a dynamic token on a data resource */
|
|
584
658
|
DataElementConnectionDefinition: {
|
package/dist/index.d.ts
CHANGED
|
@@ -371,6 +371,21 @@ interface external {
|
|
|
371
371
|
* this property will have a single value that is shared for all locales
|
|
372
372
|
*/
|
|
373
373
|
localizable?: boolean;
|
|
374
|
+
/**
|
|
375
|
+
* @description When `localizable` is true, this property controls the default localizability of the property.
|
|
376
|
+
* true - when the property has no existing value, it will be in 'single value' mode and not store locale specific values
|
|
377
|
+
* false/undefined - when the property has no existing value, it will store separate values for each enabled locale
|
|
378
|
+
*
|
|
379
|
+
* If `localized` is false, this has no effect.
|
|
380
|
+
*/
|
|
381
|
+
notLocalizedByDefault?: boolean;
|
|
382
|
+
/**
|
|
383
|
+
* @description Enables creating additional conditional values for the parameter based on criteria such as dynamic inputs.
|
|
384
|
+
* When combined with a localized value, each locale has independent conditional values.
|
|
385
|
+
*
|
|
386
|
+
* When not defined, conditional values are not allowed.
|
|
387
|
+
*/
|
|
388
|
+
allowConditionalValues?: boolean;
|
|
374
389
|
/** @description The configuration object for the type (type-specific) */
|
|
375
390
|
typeConfig?: unknown;
|
|
376
391
|
};
|
|
@@ -579,6 +594,65 @@ interface external {
|
|
|
579
594
|
locales?: {
|
|
580
595
|
[key: string]: unknown;
|
|
581
596
|
};
|
|
597
|
+
conditions?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
|
598
|
+
/** @description Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
|
|
599
|
+
localesConditions?: {
|
|
600
|
+
[key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditions"];
|
|
601
|
+
};
|
|
602
|
+
};
|
|
603
|
+
/**
|
|
604
|
+
* @description Array of alternate values which are based on conditions.
|
|
605
|
+
*
|
|
606
|
+
* When requested with an explicit locale parameter, or via the route API:
|
|
607
|
+
* * Conditions are evaluated sequentially and the first match is used. If a match is found, the conditions are eliminated.
|
|
608
|
+
* * If no conditions match, the `value` property is used.
|
|
609
|
+
* * If a condition cannot be evaluated yet (i.e. a client-side criteria), it is left alone.
|
|
610
|
+
*
|
|
611
|
+
* When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
|
|
612
|
+
*/
|
|
613
|
+
ComponentParameterConditions: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameterConditionalValue"][];
|
|
614
|
+
/** @description Defines a conditional value for a component parameter */
|
|
615
|
+
ComponentParameterConditionalValue: {
|
|
616
|
+
when: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"];
|
|
617
|
+
/**
|
|
618
|
+
* @description The value of the parameter. Any JSON-serializable value is acceptable.
|
|
619
|
+
* A value of `null` will cause the parameter value to be removed, if it matches.
|
|
620
|
+
*/
|
|
621
|
+
value: unknown;
|
|
622
|
+
/**
|
|
623
|
+
* @description Unique sequence identifier of the conditional value within the component parameter.
|
|
624
|
+
* This value must be unique within the conditional values array, and it should not change after a condition is created.
|
|
625
|
+
*/
|
|
626
|
+
id: number;
|
|
627
|
+
};
|
|
628
|
+
/**
|
|
629
|
+
* @deprecated
|
|
630
|
+
* @description beta functionality subject to change
|
|
631
|
+
*/
|
|
632
|
+
VisibilityCriteriaGroup: {
|
|
633
|
+
/**
|
|
634
|
+
* @description The boolean operator to join the clauses with. Defaults to & if not specified.
|
|
635
|
+
* @enum {string}
|
|
636
|
+
*/
|
|
637
|
+
op?: "&" | "|";
|
|
638
|
+
clauses: (external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteria"] | external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["VisibilityCriteriaGroup"])[];
|
|
639
|
+
};
|
|
640
|
+
/**
|
|
641
|
+
* @deprecated
|
|
642
|
+
* @description beta functionality subject to change
|
|
643
|
+
*/
|
|
644
|
+
VisibilityCriteria: {
|
|
645
|
+
/** @description The rule type to execute */
|
|
646
|
+
rule: string;
|
|
647
|
+
/**
|
|
648
|
+
* @description The source value of the rule.
|
|
649
|
+
* For rules which have multiple classes of match, for example a dynamic input matches on a named DI, the rule is dynamic input and the DI name is the source.
|
|
650
|
+
*/
|
|
651
|
+
source?: string;
|
|
652
|
+
/** @description The rule-definition-specific operator to test against */
|
|
653
|
+
op: string;
|
|
654
|
+
/** @description The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
|
|
655
|
+
value: string | string[];
|
|
582
656
|
};
|
|
583
657
|
/** @description Defines a connection to a dynamic token on a data resource */
|
|
584
658
|
DataElementConnectionDefinition: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@uniformdev/assets",
|
|
3
|
-
"version": "19.
|
|
3
|
+
"version": "19.180.0",
|
|
4
4
|
"description": "Uniform Assets",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"access": "public"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@uniformdev/context": "19.
|
|
39
|
+
"@uniformdev/context": "19.180.0"
|
|
40
40
|
},
|
|
41
|
-
"gitHead": "
|
|
41
|
+
"gitHead": "309600b88571d0ffb2b80d7d2c27b7aa3e5ae72b"
|
|
42
42
|
}
|