@uniformdev/assets 19.184.0 → 19.184.1-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 +44 -0
  2. package/dist/index.d.ts +44 -0
  3. package/package.json +3 -3
package/dist/index.d.mts CHANGED
@@ -863,6 +863,35 @@ interface external {
863
863
  * @enum {string}
864
864
  */
865
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
+ };
866
895
  /**
867
896
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
868
897
  * These are created in the UI and shared across a whole project.
@@ -899,6 +928,11 @@ interface external {
899
928
  localeMapping?: {
900
929
  [key: string]: string;
901
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;
902
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 */
903
937
  customPublic?: {
904
938
  [key: string]: unknown;
@@ -907,6 +941,10 @@ interface external {
907
941
  custom?: {
908
942
  [key: string]: unknown;
909
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
+ };
910
948
  };
911
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 */
912
950
  DataType: {
@@ -1005,6 +1043,12 @@ interface external {
1005
1043
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
1006
1044
  */
1007
1045
  optionalPatternParameter?: boolean;
1046
+ /**
1047
+ * @description Resolve this data resource with draft mode content. TBD
1048
+ *
1049
+ * @enum {string}
1050
+ */
1051
+ dataSourceVariant?: "unpublished";
1008
1052
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1009
1053
  };
1010
1054
  /** @description Variable values for a data resource */
package/dist/index.d.ts CHANGED
@@ -863,6 +863,35 @@ interface external {
863
863
  * @enum {string}
864
864
  */
865
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
+ };
866
895
  /**
867
896
  * @description An instance of a data source (i.e. "Master environment of the stable space", "Yelp API", "Sanity dev dataset").
868
897
  * These are created in the UI and shared across a whole project.
@@ -899,6 +928,11 @@ interface external {
899
928
  localeMapping?: {
900
929
  [key: string]: string;
901
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;
902
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 */
903
937
  customPublic?: {
904
938
  [key: string]: unknown;
@@ -907,6 +941,10 @@ interface external {
907
941
  custom?: {
908
942
  [key: string]: unknown;
909
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
+ };
910
948
  };
911
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 */
912
950
  DataType: {
@@ -1005,6 +1043,12 @@ interface external {
1005
1043
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
1006
1044
  */
1007
1045
  optionalPatternParameter?: boolean;
1046
+ /**
1047
+ * @description Resolve this data resource with draft mode content. TBD
1048
+ *
1049
+ * @enum {string}
1050
+ */
1051
+ dataSourceVariant?: "unpublished";
1008
1052
  variables?: external["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceVariables"];
1009
1053
  };
1010
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.184.0",
3
+ "version": "19.184.1-alpha.22+a7fd564cd5",
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.184.0"
39
+ "@uniformdev/context": "19.184.1-alpha.22+a7fd564cd5"
40
40
  },
41
- "gitHead": "b3615184222587b4de8955ea9c5339efa5d06c0e"
41
+ "gitHead": "a7fd564cd599786d0a9504495b7330cd77072039"
42
42
  }