@uniformdev/assets 19.178.2-alpha.25 → 19.179.2-alpha.22

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +118 -0
  2. package/dist/index.d.ts +118 -0
  3. 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: {
@@ -789,6 +863,35 @@ interface external {
789
863
  * @enum {string}
790
864
  */
791
865
  OverrideOptions: "yes" | "no";
866
+ /** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
867
+ AlternativeDataSourceData: {
868
+ /** @description Base resource URL of the data source. No trailing slash */
869
+ baseUrl: string;
870
+ /** @description HTTP headers to pass with requests to the data source */
871
+ headers?: {
872
+ key: string;
873
+ value: string;
874
+ omitIfEmpty?: boolean;
875
+ }[];
876
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
877
+ parameters?: {
878
+ key: string;
879
+ value: string;
880
+ omitIfEmpty?: boolean;
881
+ }[];
882
+ /** @description Variables needed to make calls to the data source */
883
+ variables?: {
884
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
885
+ };
886
+ /** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
887
+ customPublic?: {
888
+ [key: string]: unknown;
889
+ };
890
+ /** @description Custom configuration accessible to the data source editor UI and custom edgehancer that may contain secrets. This cannot be read by the data type or data resource editors */
891
+ custom?: {
892
+ [key: string]: unknown;
893
+ };
894
+ };
792
895
  /**
793
896
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
794
897
  * These are created in the UI and shared across a whole project.
@@ -825,6 +928,11 @@ interface external {
825
928
  localeMapping?: {
826
929
  [key: string]: string;
827
930
  };
931
+ /**
932
+ * @description If true, data source will require additional credentials to access unpublished data.
933
+ * If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
934
+ */
935
+ enableUnpublishedMode?: boolean;
828
936
  /** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
829
937
  customPublic?: {
830
938
  [key: string]: unknown;
@@ -833,6 +941,10 @@ interface external {
833
941
  custom?: {
834
942
  [key: string]: unknown;
835
943
  };
944
+ /** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
945
+ variants?: {
946
+ unpublished?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["AlternativeDataSourceData"];
947
+ };
836
948
  };
837
949
  /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project */
838
950
  DataType: {
@@ -931,6 +1043,12 @@ interface external {
931
1043
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
932
1044
  */
933
1045
  optionalPatternParameter?: boolean;
1046
+ /**
1047
+ * @description Resolve this data resource with draft mode content. TBD
1048
+ *
1049
+ * @enum {string}
1050
+ */
1051
+ dataSourceVariant?: "unpublished";
934
1052
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
935
1053
  };
936
1054
  /** @description Variable values for a data resource */
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: {
@@ -789,6 +863,35 @@ interface external {
789
863
  * @enum {string}
790
864
  */
791
865
  OverrideOptions: "yes" | "no";
866
+ /** @description Additional set of headers, parameters, variables, etc to be used for data resolving in the context like e.g. Unpublished Data. */
867
+ AlternativeDataSourceData: {
868
+ /** @description Base resource URL of the data source. No trailing slash */
869
+ baseUrl: string;
870
+ /** @description HTTP headers to pass with requests to the data source */
871
+ headers?: {
872
+ key: string;
873
+ value: string;
874
+ omitIfEmpty?: boolean;
875
+ }[];
876
+ /** @description Query String parameters to pass with requests to the data type. Merged with parameters from the data source, overriding identical keys */
877
+ parameters?: {
878
+ key: string;
879
+ value: string;
880
+ omitIfEmpty?: boolean;
881
+ }[];
882
+ /** @description Variables needed to make calls to the data source */
883
+ variables?: {
884
+ [key: string]: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataVariableDefinition"];
885
+ };
886
+ /** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
887
+ customPublic?: {
888
+ [key: string]: unknown;
889
+ };
890
+ /** @description Custom configuration accessible to the data source editor UI and custom edgehancer that may contain secrets. This cannot be read by the data type or data resource editors */
891
+ custom?: {
892
+ [key: string]: unknown;
893
+ };
894
+ };
792
895
  /**
793
896
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
794
897
  * These are created in the UI and shared across a whole project.
@@ -825,6 +928,11 @@ interface external {
825
928
  localeMapping?: {
826
929
  [key: string]: string;
827
930
  };
931
+ /**
932
+ * @description If true, data source will require additional credentials to access unpublished data.
933
+ * If false, no additional data source credentials are required and data resources of this data source won't be able to access unpublished data.
934
+ */
935
+ enableUnpublishedMode?: boolean;
828
936
  /** @description Custom configuration accessible to all data connector UIs (data source, data type, and data resource editors) and custom edgehancers. This data should not contain secrets */
829
937
  customPublic?: {
830
938
  [key: string]: unknown;
@@ -833,6 +941,10 @@ interface external {
833
941
  custom?: {
834
942
  [key: string]: unknown;
835
943
  };
944
+ /** @description Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
945
+ variants?: {
946
+ unpublished?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["AlternativeDataSourceData"];
947
+ };
836
948
  };
837
949
  /** @description A specific type of data that a Data Source can provide (i.e. "Recipe", "Recipes List by Tag", "Yelp Reviews of My Restaurant"). These are created in the UI and shared a whole project */
838
950
  DataType: {
@@ -931,6 +1043,12 @@ interface external {
931
1043
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
932
1044
  */
933
1045
  optionalPatternParameter?: boolean;
1046
+ /**
1047
+ * @description Resolve this data resource with draft mode content. TBD
1048
+ *
1049
+ * @enum {string}
1050
+ */
1051
+ dataSourceVariant?: "unpublished";
934
1052
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
935
1053
  };
936
1054
  /** @description Variable values for a data resource */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/assets",
3
- "version": "19.178.2-alpha.25+0f7f53f560",
3
+ "version": "19.179.2-alpha.22+79878be48f",
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.178.2-alpha.25+0f7f53f560"
39
+ "@uniformdev/context": "19.179.2-alpha.22+79878be48f"
40
40
  },
41
- "gitHead": "0f7f53f56071a59cee38bf83c9f3bae541846de2"
41
+ "gitHead": "79878be48f2d4b1c6158026aa632e71c91473ac6"
42
42
  }