@uniformdev/mesh-sdk 18.34.1-alpha.57 → 18.35.1-alpha.26

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 (5) hide show
  1. package/dist/index.d.ts +7 -24
  2. package/dist/index.esm.js +1 -12
  3. package/dist/index.js +1 -12
  4. package/dist/index.mjs +1 -12
  5. package/package.json +4 -4
package/dist/index.d.ts CHANGED
@@ -29,7 +29,7 @@ interface paths$1 {
29
29
  logoIconUrl?: string;
30
30
  badgeIconUrl?: string;
31
31
  /** @enum {string} */
32
- category?: "analytics" | "cdn" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
32
+ category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
33
33
  public?: boolean;
34
34
  baseLocationUrl?: string;
35
35
  locations: {
@@ -117,7 +117,7 @@ interface paths$1 {
117
117
  logoIconUrl?: string;
118
118
  badgeIconUrl?: string;
119
119
  /** @enum {string} */
120
- category?: "analytics" | "cdn" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
120
+ category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
121
121
  public?: boolean;
122
122
  baseLocationUrl?: string;
123
123
  locations: {
@@ -205,7 +205,7 @@ interface paths$1 {
205
205
  logoIconUrl?: string;
206
206
  badgeIconUrl?: string;
207
207
  /** @enum {string} */
208
- category?: "analytics" | "cdn" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
208
+ category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown";
209
209
  baseLocationUrl?: string;
210
210
  locations: {
211
211
  install?: {
@@ -540,7 +540,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
540
540
  displayName: string;
541
541
  logoIconUrl?: string | undefined;
542
542
  badgeIconUrl?: string | undefined;
543
- category?: "analytics" | "cdn" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown" | undefined;
543
+ category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "unknown" | undefined;
544
544
  public?: boolean | undefined;
545
545
  baseLocationUrl?: string | undefined;
546
546
  locations: {
@@ -654,7 +654,7 @@ type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, undefined
654
654
  * Defines methods used for interacting with a Mesh location
655
655
  * To receive useful typings, check the `type` property of the location to narrow the typing.
656
656
  */
657
- type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | DataSourceLocation | DataTypeLocation | DataTypeInstanceLocation | DataResourceLocation;
657
+ type MeshLocation<TValue = unknown, TSetValue = TValue> = ParamTypeLocation<TValue, unknown, TSetValue> | ParamTypeConfigLocation<TValue> | SettingsLocation<TValue> | DataSourceLocation | DataTypeLocation | DataResourceLocation;
658
658
  interface MeshContextData {
659
659
  locationKey: string;
660
660
  locationType: MeshLocationTypes;
@@ -779,8 +779,6 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
779
779
  type: TType;
780
780
  /** If true, any editable fields on the current location should be disabled as the user does not have permission or otherwise cannot change them. */
781
781
  isReadOnly: boolean;
782
- /** @deprecated use value property instead */
783
- getValue: () => TValue;
784
782
  /** The current value of the location. Some locations have fixed types (i.e. dataType), and others have user-selected types (i.e. paramType) */
785
783
  value: TValue;
786
784
  /**
@@ -789,18 +787,11 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
789
787
  * The 'settings' location writes to the database each time its value is set, and it should be treated as a form with a submit button.
790
788
  */
791
789
  setValue: SetLocationFunction<TSetValue>;
792
- /** @deprecated use metadata property instead */
793
- getMetadata: () => TMetadata;
794
790
  /**
795
791
  * Gets the current location metadata, context data which is provided from the Uniform app to assist in rendering the Mesh UI
796
792
  * Each location has a specific type of metadata that it is provided, which is typed automatically when the location is known.
797
793
  */
798
794
  metadata: TMetadata;
799
- /**
800
- * Instructs Uniform to set the validity of the location in the parent app.
801
- * @deprecated - use setValue(value, validationResult) instead
802
- */
803
- setValidationResult: (value: ValidationResult) => Promise<void>;
804
795
  /**
805
796
  * Context of a location when it is rendering inside a dialog in the Uniform app.
806
797
  * This is set when:
@@ -821,9 +812,7 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
821
812
  /**
822
813
  * Known location types that can be passed to a mesh location
823
814
  */
824
- type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType'
825
- /** @deprecated use dataResource */
826
- | 'dataTypeInstance' | 'dataResource';
815
+ type MeshLocationTypes = 'paramType' | 'paramTypeConfig' | 'settings' | 'dataSource' | 'dataType' | 'dataResource';
827
816
  type SetValueOptions = ValidationResult;
828
817
  type SetValueMessage = {
829
818
  uniformMeshLocationValue: unknown;
@@ -854,8 +843,6 @@ type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
854
843
  };
855
844
  type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
856
845
 
857
- /** @deprecated use DataResourceLocationMetadata */
858
- type DataTypeInstanceLocationMetadata<TIntegrationConfiguration = unknown> = DataResourceLocationMetadata<TIntegrationConfiguration>;
859
846
  type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
860
847
  /** Settings defined at the integration level (arbitrary type used on settings location) */
861
848
  settings: TIntegrationConfiguration;
@@ -873,8 +860,6 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
873
860
  projectId: string;
874
861
  };
875
862
  type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
876
- /** @deprecated use DataResourceLocation */
877
- type DataTypeInstanceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataTypeInstance'>;
878
863
 
879
864
  type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
880
865
  /** Settings defined at the integration level (arbitrary type used on settings location) */
@@ -968,8 +953,6 @@ interface UniformMeshSDK {
968
953
  }>['setValue']>[0]> | undefined>;
969
954
  /** Explicitly close a location dialog. Called when rendering current location in the dialog. */
970
955
  closeCurrentLocationDialog(): Promise<void>;
971
- /** @deprecated prefer getCurrentLocation().dialogContext */
972
- dialogContext?: DialogContext;
973
956
  }
974
957
  declare global {
975
958
  interface Window {
@@ -984,4 +967,4 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
984
967
  autoResizingDisabled?: boolean;
985
968
  }): Promise<UniformMeshSDK | undefined>;
986
969
 
987
- export { CSSHeight, CloseDialogMessage, CloseLocationDialogOptions, DataConnectorInfo, DataResourceLocation, DataResourceLocationMetadata, DataSourceLocation, DataSourceLocationMetadata, DataSourceLocationValue, DataTypeInstanceLocation, DataTypeInstanceLocationMetadata, DataTypeLocation, DataTypeLocationMetadata, DataTypeLocationValue, DialogContext, DialogOptions, DialogParamValue, DialogParams, DialogResponseData, DialogResponseHandler, DialogResponseHandlers, DialogType, GetDataResourceLocation, GetDataResourceMessage, IntegrationDefinitionClient, IntegrationDefinitionDeleteParameters, IntegrationDefinitionGetParameters, IntegrationDefinitionGetResponse, IntegrationDefinitionPutParameters, IntegrationDefinitionPutResponse, IntegrationInstallationClient, IntegrationInstallationDeleteParameters, IntegrationInstallationGetParameters, IntegrationInstallationGetResponse, IntegrationInstallationPutParameters, LocationDialogResponse, MeshContextData, MeshLocation, MeshLocationCore, MeshLocationTypes, MeshSDKEventInterface, OpenConfirmationDialogOptions, OpenConfirmationDialogResult, OpenDialogMessage, OpenDialogResult, OpenLocationDialogOptions, ParamTypeConfigLocation, ParamTypeConfigLocationMetadata, ParamTypeLocation, ParamTypeLocationMetadata, SdkWindow, SetLocationFunction, SetValueMessage, SetValueOptions, SettingsLocation, UniformMeshSDK, UniformMeshSDKEvents, ValidationResult, initializeUniformMeshSDK };
970
+ export { CSSHeight, CloseDialogMessage, CloseLocationDialogOptions, DataConnectorInfo, DataResourceLocation, DataResourceLocationMetadata, DataSourceLocation, DataSourceLocationMetadata, DataSourceLocationValue, DataTypeLocation, DataTypeLocationMetadata, DataTypeLocationValue, DialogContext, DialogOptions, DialogParamValue, DialogParams, DialogResponseData, DialogResponseHandler, DialogResponseHandlers, DialogType, GetDataResourceLocation, GetDataResourceMessage, IntegrationDefinitionClient, IntegrationDefinitionDeleteParameters, IntegrationDefinitionGetParameters, IntegrationDefinitionGetResponse, IntegrationDefinitionPutParameters, IntegrationDefinitionPutResponse, IntegrationInstallationClient, IntegrationInstallationDeleteParameters, IntegrationInstallationGetParameters, IntegrationInstallationGetResponse, IntegrationInstallationPutParameters, LocationDialogResponse, MeshContextData, MeshLocation, MeshLocationCore, MeshLocationTypes, MeshSDKEventInterface, OpenConfirmationDialogOptions, OpenConfirmationDialogResult, OpenDialogMessage, OpenDialogResult, OpenLocationDialogOptions, ParamTypeConfigLocation, ParamTypeConfigLocationMetadata, ParamTypeLocation, ParamTypeLocationMetadata, SdkWindow, SetLocationFunction, SetValueMessage, SetValueOptions, SettingsLocation, UniformMeshSDK, UniformMeshSDKEvents, ValidationResult, initializeUniformMeshSDK };
package/dist/index.esm.js CHANGED
@@ -606,9 +606,6 @@ async function initializeUniformMeshSDK({
606
606
  getDataResource: parent.getDataResource,
607
607
  type: contextData.locationType,
608
608
  isReadOnly: contextData.isReadOnly,
609
- getValue: () => {
610
- return location.value;
611
- },
612
609
  value: contextData.locationValue,
613
610
  setValue: async (value, options) => {
614
611
  if (contextData.dialogContext) {
@@ -620,12 +617,7 @@ async function initializeUniformMeshSDK({
620
617
  sdk.events.emit("onValueChanged", { newValue: value });
621
618
  await parent.setValue({ uniformMeshLocationValue: value, options });
622
619
  },
623
- // DEPRECATED
624
- getMetadata: () => currentMetadata,
625
620
  metadata: currentMetadata,
626
- setValidationResult: async (value) => {
627
- await location.setValue(contextData.locationValue, value);
628
- },
629
621
  dialogContext: contextData.dialogContext ? {
630
622
  ...contextData.dialogContext,
631
623
  params: currentMetadata.dialogParams,
@@ -684,8 +676,6 @@ async function initializeUniformMeshSDK({
684
676
  return;
685
677
  }
686
678
  return {
687
- /** @deprecated don't use this */
688
- dialogId: result.dialogId,
689
679
  value: result.value,
690
680
  closeDialog: async () => {
691
681
  await parent.closeDialog({ dialogId: void 0, dialogType: "confirm" });
@@ -714,8 +704,7 @@ async function initializeUniformMeshSDK({
714
704
  },
715
705
  closeCurrentLocationDialog: async () => {
716
706
  await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
717
- },
718
- dialogContext: contextData.dialogContext
707
+ }
719
708
  };
720
709
  window.UniformMeshSDK = sdk;
721
710
  initializing = false;
package/dist/index.js CHANGED
@@ -643,9 +643,6 @@ async function initializeUniformMeshSDK({
643
643
  getDataResource: parent.getDataResource,
644
644
  type: contextData.locationType,
645
645
  isReadOnly: contextData.isReadOnly,
646
- getValue: () => {
647
- return location.value;
648
- },
649
646
  value: contextData.locationValue,
650
647
  setValue: async (value, options) => {
651
648
  if (contextData.dialogContext) {
@@ -657,12 +654,7 @@ async function initializeUniformMeshSDK({
657
654
  sdk.events.emit("onValueChanged", { newValue: value });
658
655
  await parent.setValue({ uniformMeshLocationValue: value, options });
659
656
  },
660
- // DEPRECATED
661
- getMetadata: () => currentMetadata,
662
657
  metadata: currentMetadata,
663
- setValidationResult: async (value) => {
664
- await location.setValue(contextData.locationValue, value);
665
- },
666
658
  dialogContext: contextData.dialogContext ? {
667
659
  ...contextData.dialogContext,
668
660
  params: currentMetadata.dialogParams,
@@ -721,8 +713,6 @@ async function initializeUniformMeshSDK({
721
713
  return;
722
714
  }
723
715
  return {
724
- /** @deprecated don't use this */
725
- dialogId: result.dialogId,
726
716
  value: result.value,
727
717
  closeDialog: async () => {
728
718
  await parent.closeDialog({ dialogId: void 0, dialogType: "confirm" });
@@ -751,8 +741,7 @@ async function initializeUniformMeshSDK({
751
741
  },
752
742
  closeCurrentLocationDialog: async () => {
753
743
  await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
754
- },
755
- dialogContext: contextData.dialogContext
744
+ }
756
745
  };
757
746
  window.UniformMeshSDK = sdk;
758
747
  initializing = false;
package/dist/index.mjs CHANGED
@@ -606,9 +606,6 @@ async function initializeUniformMeshSDK({
606
606
  getDataResource: parent.getDataResource,
607
607
  type: contextData.locationType,
608
608
  isReadOnly: contextData.isReadOnly,
609
- getValue: () => {
610
- return location.value;
611
- },
612
609
  value: contextData.locationValue,
613
610
  setValue: async (value, options) => {
614
611
  if (contextData.dialogContext) {
@@ -620,12 +617,7 @@ async function initializeUniformMeshSDK({
620
617
  sdk.events.emit("onValueChanged", { newValue: value });
621
618
  await parent.setValue({ uniformMeshLocationValue: value, options });
622
619
  },
623
- // DEPRECATED
624
- getMetadata: () => currentMetadata,
625
620
  metadata: currentMetadata,
626
- setValidationResult: async (value) => {
627
- await location.setValue(contextData.locationValue, value);
628
- },
629
621
  dialogContext: contextData.dialogContext ? {
630
622
  ...contextData.dialogContext,
631
623
  params: currentMetadata.dialogParams,
@@ -684,8 +676,6 @@ async function initializeUniformMeshSDK({
684
676
  return;
685
677
  }
686
678
  return {
687
- /** @deprecated don't use this */
688
- dialogId: result.dialogId,
689
679
  value: result.value,
690
680
  closeDialog: async () => {
691
681
  await parent.closeDialog({ dialogId: void 0, dialogType: "confirm" });
@@ -714,8 +704,7 @@ async function initializeUniformMeshSDK({
714
704
  },
715
705
  closeCurrentLocationDialog: async () => {
716
706
  await parent.closeDialog({ dialogId: void 0, dialogType: "location" });
717
- },
718
- dialogContext: contextData.dialogContext
707
+ }
719
708
  };
720
709
  window.UniformMeshSDK = sdk;
721
710
  initializing = false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/mesh-sdk",
3
- "version": "18.34.1-alpha.57+d06712d70",
3
+ "version": "18.35.1-alpha.26+277d77ae3",
4
4
  "description": "Uniform Mesh Framework SDK",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -32,9 +32,9 @@
32
32
  "access": "public"
33
33
  },
34
34
  "dependencies": {
35
- "@uniformdev/canvas": "18.34.1-alpha.57+d06712d70",
36
- "@uniformdev/context": "18.34.1-alpha.57+d06712d70",
35
+ "@uniformdev/canvas": "18.35.1-alpha.26+277d77ae3",
36
+ "@uniformdev/context": "18.35.1-alpha.26+277d77ae3",
37
37
  "mitt": "^3.0.0"
38
38
  },
39
- "gitHead": "d06712d70880e665966897d71c92444ea1dea80e"
39
+ "gitHead": "277d77ae3e30655fb8319c7f221757981e8e00af"
40
40
  }