@uniformdev/mesh-sdk 19.114.0 → 19.114.1-alpha.7

package/dist/index.d.mts

@@ -32,6 +32,7 @@ interface paths$1 {
                                 /** @enum {string} */
                                 category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "ai" | "unknown";
                                 public?: boolean;
+                                scopes?: string[];
                                 baseLocationUrl?: string;
                                 locations: {
                                     install?: {
@@ -183,6 +184,7 @@ interface paths$1 {
                             /** @enum {string} */
                             category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "ai" | "unknown";
                             public?: boolean;
+                            scopes?: string[];
                             baseLocationUrl?: string;
                             locations: {
                                 install?: {
@@ -333,6 +335,7 @@ interface paths$1 {
                             badgeIconUrl?: string;
                             /** @enum {string} */
                             category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "ai" | "unknown";
+                            scopes?: string[];
                             baseLocationUrl?: string;
                             locations: {
                                 install?: {
@@ -732,6 +735,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
         badgeIconUrl?: string | undefined;
         category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "ai" | "unknown" | undefined;
         public?: boolean | undefined;
+        scopes?: string[] | undefined;
         baseLocationUrl?: string | undefined;
         locations: {
             install?: {
@@ -876,19 +880,11 @@ declare class IntegrationInstallationClient extends ApiClient {
     remove(body: ExceptProject<IntegrationInstallationDeleteParameters>): Promise<void>;
 }
 
-type AssetLibraryLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
+type AssetLibraryLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /** The current Uniform integration source ID */
     sourceId: string;
-};
-type AssetParameterLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
+}, TIntegrationConfiguration>;
+type AssetParameterLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /** The current Uniform integration source ID */
     sourceId: string;
     /** The resolved data if this source is connected to a data resource */
@@ -899,7 +895,7 @@ type AssetParameterLocationMetadata<TIntegrationConfiguration = unknown> = {
      * Default: 1
      */
     maxAssets?: number;
-};
+}, TIntegrationConfiguration>;
 type AssetLibraryLocation = MeshLocationCore<unknown, AssetLibraryLocationMetadata, unknown, 'assetLibrary'> & GetDataResourceLocation;
 type AssetParameterLocation = MeshLocationCore<AssetParamValue, AssetParameterLocationMetadata, AssetParamValue, 'assetParameter'> & GetDataResourceLocation;
 
@@ -908,11 +904,7 @@ type DataConnectorInfo = {
     type: string;
     displayName: string;
 };
-type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
+type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /**
      * The current data type's data source. NOTE: param and header values are not available in this context.
      */
@@ -921,13 +913,10 @@ type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
     dataConnector: DataConnectorInfo;
     /** The data type's archetype value. */
     archetype: string;
-};
+}, TIntegrationConfiguration>;
 type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
 
-type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The current data resource's data type */
+type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     dataType: DataType;
     /** The data type's archetype value. */
     archetype: string;
@@ -937,32 +926,21 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
     dataSource: DataSource;
     /** The data connector type of the current data resource's data source */
     dataConnector: DataConnectorInfo;
-    /** The Uniform project ID */
-    projectId: string;
     /** Current dynamic inputs that are configured on the composition (if any). */
     dynamicInputs: DynamicInputs;
-};
+}, TIntegrationConfiguration>;
 type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
 
 type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables'>;
-type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
-};
+type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
 type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
 
-type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
+type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
     rootNode: Omit<RootComponentInstance, 'slots' | '_data'>;
     parameterConfiguration: TParamConfiguration;
     component: Omit<ComponentInstance, 'slots'>;
     componentDefinitions: Record<string, ComponentDefinition | undefined>;
     parameterDefinition: ComponentDefinitionParameter;
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
     /**
      * Current dynamic inputs that are configured on the composition (if any).
      * Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
@@ -984,7 +962,7 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
      * Note that setValue() always sets the target language automatically.
      */
     targetLocale: string | undefined;
-};
+}, TIntegrationConfiguration>;
 type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'> & {
     /**
      * Opens a dialog on the Uniform platform to edit or select a dynamic token to connect to.
@@ -993,9 +971,7 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
     editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
 };
 
-type SettingsLocationMetadata = {
-    projectId: string;
-};
+type SettingsLocationMetadata = CommonMetadata;
 type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
 
 /**
@@ -1126,6 +1102,22 @@ type EditConnectedDataResponse = {
     canceled: true;
     editorCancelledContext: EditConnectedDataResponseCancellationContext;
 };
+type UniformUser = {
+    /** Permissions the user has as per Team Admin assigned, can be used to do conditional rendering */
+    permissions: MeshLocationUserPermissions[];
+    /** Permissions the user has as per Team Admin created and assigned, can be used to do conditional rendering */
+    roles: {
+        id: string;
+        name: string;
+    }[];
+    /** Name of the user assigned by Team Admin. Unless your Mesh integration was given permissions to expose User Name - it is not available */
+    name?: string;
+    /** Email of the user used to sign in. Unless your Mesh integration was given permissions to expose User Name - it is not available */
+    email?: string;
+    /** Unique ID of the user */
+    id: string;
+    isAdmin: boolean;
+};
 
 type MeshSDKEventInterface = Awaited<ReturnType<typeof connectToParent>>['parent'] & {
     initialize: () => Promise<MeshContextData>;
@@ -1188,6 +1180,84 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
         returnDialogValue: (value: unknown) => Promise<void>;
     };
 }
+/** Common metadata for all mesh locations */
+type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unknown> = {
+    /** The current Uniform user context. Contains name, email and context to check for permissions */
+    user: UniformUser;
+    /** Current Uniform Project ID */
+    projectId: string;
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
+    settings: TIntegrationConfiguration;
+} & ExtendedMetadata;
+type MeshLocationUserPermissions = 
+/** Uniform Context:Enrichments:Create */
+'ENRICHMENTS_CREATE'
+/** Uniform Context:Enrichments:Update */
+ | 'ENRICHMENTS_UPDATE'
+/** Uniform Context:Enrichments:Delete */
+ | 'ENRICHMENTS_DELETE'
+/** Uniform Context:Intents & Audiences:Create */
+ | 'INTENTS_CREATE'
+/** Uniform Context:Intents & Audiences:Update */
+ | 'INTENTS_UPDATE'
+/** Uniform Context:Intents & Audiences:Delete */
+ | 'INTENTS_DELETE'
+/** Uniform Context:Quirks:Create */
+ | 'QUIRKS_CREATE'
+/** Uniform Context:Quirks:Update| */
+ | 'QUIRKS_UPDATE'
+/** Uniform Context:Quirks:Delete */
+ | 'QUIRKS_DELETE'
+/** Uniform Context:Signals:Create */
+ | 'SIGNALS_CREATE'
+/** Uniform Context:Signals:Update */
+ | 'SIGNALS_UPDATE'
+/** Uniform Context:Signals:Delete */
+ | 'SIGNALS_DELETE'
+/** Uniform Context:Tests:Create */
+ | 'TESTS_CREATE'
+/** Uniform Context:Tests:Update|Declare winners and close existing tests. */
+ | 'TESTS_UPDATE'
+/** Uniform Context:Tests:Delete */
+ | 'TESTS_DELETE'
+/** Uniform Context:Manifest:Read|Read the published manifest */
+ | 'MANIFEST_READ'
+/** Uniform Context:Manifest:Publish|Publish the manifest */
+ | 'MANIFEST_PUBLISH'
+/** Uniform Context:Read Drafts|Read all drafts and preview manifest */
+ | 'MANIFEST_READ_DRAFT'
+/** Uniform Canvas:Project Map:Manage|Create, update, and delete Project Maps and nodes in Project Map trees. */
+ | 'PROJECT_MAP_MANAGE'
+/** General:Read Project|See the project in the team dashboard. */
+ | 'PROJECT_READ'
+/** Uniform Canvas:Redirects:Advanced|Grants access to advanced redirect features and options. */
+ | 'REDIRECTS_ADVANCED'
+/** Uniform Canvas:Redirects:Create */
+ | 'REDIRECTS_CREATE'
+/** Uniform Canvas:Redirects:Update */
+ | 'REDIRECTS_UPDATE'
+/** Uniform Canvas:Redirects:Delete */
+ | 'REDIRECTS_DELETE'
+/** Uniform Canvas:Data Sources:Manage|Create, update, and delete data sources. */
+ | 'DATA_SOURCES_MANAGE'
+/** Uniform Canvas:Data Types:Manage|Create, update, and delete data types. */
+ | 'DATA_TYPES_MANAGE'
+/** Uniform Canvas:Compositions:Create */
+ | 'COMPOSITIONS_CREATE'
+/** Uniform Canvas:Compositions:Update */
+ | 'COMPOSITIONS_WRITE'
+/** Uniform Canvas:Compositions:Delete */
+ | 'COMPOSITIONS_DELETE'
+/** Uniform Canvas:Compositions:Read Published */
+ | 'COMPOSITIONS_READ'
+/** Uniform Canvas:Compositions:Publish */
+ | 'COMPOSITIONS_PUBLISH'
+/** Uniform Canvas::Read|Includes read access to all canvas assets */
+ | 'COMPOSITIONS_READ_DRAFT'
+/** Uniform Canvas:Component Library:Manage|Create, update, and delete component library data */
+ | 'COMPOSITIONS_MANAGE_SCHEMA'
+/** UTM Mapper:Read|Read UTM mapper configuration */
+ | 'UTM_MAPPER_READ';
 /**
  * Known location types that can be passed to a mesh location
  */
@@ -1217,31 +1287,23 @@ type DynamicInput = {
 /** Record of dynamic inputs keyed by the input name */
 type DynamicInputs = Record<string, DynamicInput>;
 
-type AIGenerateLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
+type AIGenerateLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     prompt: string;
     promptMetadata: Record<string, unknown>;
     /** Useful to differentiate AI Generate UI between text and image */
     promptOutputType: 'text' | 'image';
-};
-type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = {
-    settings: TIntegrationConfiguration;
+}, TIntegrationConfiguration>;
+type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /** Useful to differentiate metadata settings between text and image generation */
     promptOutputType: 'text' | 'image';
-};
+}, TIntegrationConfiguration>;
 type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
 type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
 
-type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
+type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /** The Uniform project ID */
-    projectId: string;
     componentDefinition: ComponentDefinition;
-};
+}, TIntegrationConfiguration>;
 type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeConfigLocationMetadata<TIntegrationConfiguration>, TParamValue, 'paramTypeConfig'>;
 
 interface SdkWindow {
@@ -1341,4 +1403,10 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
     autoResizingDisabled?: boolean;
 }): Promise<UniformMeshSDK | undefined>;
 
-export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CloseDialogMessage, type CloseLocationDialogOptions, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type ValidationResult, initializeUniformMeshSDK };
+declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLocationUserPermissions[], user: UniformUser) => boolean;
+/**
+ * Check if user has a role by both name and id
+ */
+declare const hasRole: (role: string, user: UniformUser) => boolean;
+
+export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, hasPermissions, hasRole, initializeUniformMeshSDK };

package/dist/index.d.ts

@@ -32,6 +32,7 @@ interface paths$1 {
                                 /** @enum {string} */
                                 category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "ai" | "unknown";
                                 public?: boolean;
+                                scopes?: string[];
                                 baseLocationUrl?: string;
                                 locations: {
                                     install?: {
@@ -183,6 +184,7 @@ interface paths$1 {
                             /** @enum {string} */
                             category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "ai" | "unknown";
                             public?: boolean;
+                            scopes?: string[];
                             baseLocationUrl?: string;
                             locations: {
                                 install?: {
@@ -333,6 +335,7 @@ interface paths$1 {
                             badgeIconUrl?: string;
                             /** @enum {string} */
                             category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "ai" | "unknown";
+                            scopes?: string[];
                             baseLocationUrl?: string;
                             locations: {
                                 install?: {
@@ -732,6 +735,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
         badgeIconUrl?: string | undefined;
         category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "uniform" | "ai" | "unknown" | undefined;
         public?: boolean | undefined;
+        scopes?: string[] | undefined;
         baseLocationUrl?: string | undefined;
         locations: {
             install?: {
@@ -876,19 +880,11 @@ declare class IntegrationInstallationClient extends ApiClient {
     remove(body: ExceptProject<IntegrationInstallationDeleteParameters>): Promise<void>;
 }
 
-type AssetLibraryLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
+type AssetLibraryLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /** The current Uniform integration source ID */
     sourceId: string;
-};
-type AssetParameterLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
+}, TIntegrationConfiguration>;
+type AssetParameterLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /** The current Uniform integration source ID */
     sourceId: string;
     /** The resolved data if this source is connected to a data resource */
@@ -899,7 +895,7 @@ type AssetParameterLocationMetadata<TIntegrationConfiguration = unknown> = {
      * Default: 1
      */
     maxAssets?: number;
-};
+}, TIntegrationConfiguration>;
 type AssetLibraryLocation = MeshLocationCore<unknown, AssetLibraryLocationMetadata, unknown, 'assetLibrary'> & GetDataResourceLocation;
 type AssetParameterLocation = MeshLocationCore<AssetParamValue, AssetParameterLocationMetadata, AssetParamValue, 'assetParameter'> & GetDataResourceLocation;
 
@@ -908,11 +904,7 @@ type DataConnectorInfo = {
     type: string;
     displayName: string;
 };
-type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
+type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /**
      * The current data type's data source. NOTE: param and header values are not available in this context.
      */
@@ -921,13 +913,10 @@ type DataTypeLocationMetadata<TIntegrationConfiguration = unknown> = {
     dataConnector: DataConnectorInfo;
     /** The data type's archetype value. */
     archetype: string;
-};
+}, TIntegrationConfiguration>;
 type DataTypeLocation = MeshLocationCore<DataTypeLocationValue, DataTypeLocationMetadata, DataTypeLocationValue, 'dataType'> & GetDataResourceLocation;
 
-type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The current data resource's data type */
+type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     dataType: DataType;
     /** The data type's archetype value. */
     archetype: string;
@@ -937,32 +926,21 @@ type DataResourceLocationMetadata<TIntegrationConfiguration = unknown> = {
     dataSource: DataSource;
     /** The data connector type of the current data resource's data source */
     dataConnector: DataConnectorInfo;
-    /** The Uniform project ID */
-    projectId: string;
     /** Current dynamic inputs that are configured on the composition (if any). */
     dynamicInputs: DynamicInputs;
-};
+}, TIntegrationConfiguration>;
 type DataResourceLocation = MeshLocationCore<DataResourceVariables, DataResourceLocationMetadata, DataResourceVariables, 'dataResource'> & GetDataResourceLocation;
 
 type DataSourceLocationValue = Pick<DataSource, 'baseUrl' | 'custom' | 'customPublic' | 'headers' | 'parameters' | 'variables'>;
-type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
-};
+type DataSourceLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<unknown, TIntegrationConfiguration>;
 type DataSourceLocation = MeshLocationCore<DataSourceLocationValue, DataSourceLocationMetadata, DataSourceLocationValue, 'dataSource'>;
 
-type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = {
+type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfiguration = unknown> = CommonMetadata<{
     rootNode: Omit<RootComponentInstance, 'slots' | '_data'>;
     parameterConfiguration: TParamConfiguration;
     component: Omit<ComponentInstance, 'slots'>;
     componentDefinitions: Record<string, ComponentDefinition | undefined>;
     parameterDefinition: ComponentDefinitionParameter;
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
     /**
      * Current dynamic inputs that are configured on the composition (if any).
      * Use the <ParamTypeDynamicDataProvider> to wire up dynamic data in your parameter.
@@ -984,7 +962,7 @@ type ParamTypeLocationMetadata<TParamConfiguration = unknown, TIntegrationConfig
      * Note that setValue() always sets the target language automatically.
      */
     targetLocale: string | undefined;
-};
+}, TIntegrationConfiguration>;
 type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TParamSetValue = TParamValue, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeLocationMetadata<TParamConfiguration, TIntegrationConfiguration>, TParamSetValue, 'paramType'> & {
     /**
      * Opens a dialog on the Uniform platform to edit or select a dynamic token to connect to.
@@ -993,9 +971,7 @@ type ParamTypeLocation<TParamValue = unknown, TParamConfiguration = unknown, TPa
     editConnectedData: Awaited<ReturnType<typeof connectToParent>>['parent']['editConnectedData'];
 };
 
-type SettingsLocationMetadata = {
-    projectId: string;
-};
+type SettingsLocationMetadata = CommonMetadata;
 type SettingsLocation<TSettingsType> = MeshLocationCore<TSettingsType, SettingsLocationMetadata, TSettingsType, 'settings'>;
 
 /**
@@ -1126,6 +1102,22 @@ type EditConnectedDataResponse = {
     canceled: true;
     editorCancelledContext: EditConnectedDataResponseCancellationContext;
 };
+type UniformUser = {
+    /** Permissions the user has as per Team Admin assigned, can be used to do conditional rendering */
+    permissions: MeshLocationUserPermissions[];
+    /** Permissions the user has as per Team Admin created and assigned, can be used to do conditional rendering */
+    roles: {
+        id: string;
+        name: string;
+    }[];
+    /** Name of the user assigned by Team Admin. Unless your Mesh integration was given permissions to expose User Name - it is not available */
+    name?: string;
+    /** Email of the user used to sign in. Unless your Mesh integration was given permissions to expose User Name - it is not available */
+    email?: string;
+    /** Unique ID of the user */
+    id: string;
+    isAdmin: boolean;
+};
 
 type MeshSDKEventInterface = Awaited<ReturnType<typeof connectToParent>>['parent'] & {
     initialize: () => Promise<MeshContextData>;
@@ -1188,6 +1180,84 @@ interface MeshLocationCore<TValue = unknown, TMetadata = unknown, TSetValue = TV
         returnDialogValue: (value: unknown) => Promise<void>;
     };
 }
+/** Common metadata for all mesh locations */
+type CommonMetadata<ExtendedMetadata = unknown, TIntegrationConfiguration = unknown> = {
+    /** The current Uniform user context. Contains name, email and context to check for permissions */
+    user: UniformUser;
+    /** Current Uniform Project ID */
+    projectId: string;
+    /** Settings defined at the integration level (arbitrary type used on settings location) */
+    settings: TIntegrationConfiguration;
+} & ExtendedMetadata;
+type MeshLocationUserPermissions = 
+/** Uniform Context:Enrichments:Create */
+'ENRICHMENTS_CREATE'
+/** Uniform Context:Enrichments:Update */
+ | 'ENRICHMENTS_UPDATE'
+/** Uniform Context:Enrichments:Delete */
+ | 'ENRICHMENTS_DELETE'
+/** Uniform Context:Intents & Audiences:Create */
+ | 'INTENTS_CREATE'
+/** Uniform Context:Intents & Audiences:Update */
+ | 'INTENTS_UPDATE'
+/** Uniform Context:Intents & Audiences:Delete */
+ | 'INTENTS_DELETE'
+/** Uniform Context:Quirks:Create */
+ | 'QUIRKS_CREATE'
+/** Uniform Context:Quirks:Update| */
+ | 'QUIRKS_UPDATE'
+/** Uniform Context:Quirks:Delete */
+ | 'QUIRKS_DELETE'
+/** Uniform Context:Signals:Create */
+ | 'SIGNALS_CREATE'
+/** Uniform Context:Signals:Update */
+ | 'SIGNALS_UPDATE'
+/** Uniform Context:Signals:Delete */
+ | 'SIGNALS_DELETE'
+/** Uniform Context:Tests:Create */
+ | 'TESTS_CREATE'
+/** Uniform Context:Tests:Update|Declare winners and close existing tests. */
+ | 'TESTS_UPDATE'
+/** Uniform Context:Tests:Delete */
+ | 'TESTS_DELETE'
+/** Uniform Context:Manifest:Read|Read the published manifest */
+ | 'MANIFEST_READ'
+/** Uniform Context:Manifest:Publish|Publish the manifest */
+ | 'MANIFEST_PUBLISH'
+/** Uniform Context:Read Drafts|Read all drafts and preview manifest */
+ | 'MANIFEST_READ_DRAFT'
+/** Uniform Canvas:Project Map:Manage|Create, update, and delete Project Maps and nodes in Project Map trees. */
+ | 'PROJECT_MAP_MANAGE'
+/** General:Read Project|See the project in the team dashboard. */
+ | 'PROJECT_READ'
+/** Uniform Canvas:Redirects:Advanced|Grants access to advanced redirect features and options. */
+ | 'REDIRECTS_ADVANCED'
+/** Uniform Canvas:Redirects:Create */
+ | 'REDIRECTS_CREATE'
+/** Uniform Canvas:Redirects:Update */
+ | 'REDIRECTS_UPDATE'
+/** Uniform Canvas:Redirects:Delete */
+ | 'REDIRECTS_DELETE'
+/** Uniform Canvas:Data Sources:Manage|Create, update, and delete data sources. */
+ | 'DATA_SOURCES_MANAGE'
+/** Uniform Canvas:Data Types:Manage|Create, update, and delete data types. */
+ | 'DATA_TYPES_MANAGE'
+/** Uniform Canvas:Compositions:Create */
+ | 'COMPOSITIONS_CREATE'
+/** Uniform Canvas:Compositions:Update */
+ | 'COMPOSITIONS_WRITE'
+/** Uniform Canvas:Compositions:Delete */
+ | 'COMPOSITIONS_DELETE'
+/** Uniform Canvas:Compositions:Read Published */
+ | 'COMPOSITIONS_READ'
+/** Uniform Canvas:Compositions:Publish */
+ | 'COMPOSITIONS_PUBLISH'
+/** Uniform Canvas::Read|Includes read access to all canvas assets */
+ | 'COMPOSITIONS_READ_DRAFT'
+/** Uniform Canvas:Component Library:Manage|Create, update, and delete component library data */
+ | 'COMPOSITIONS_MANAGE_SCHEMA'
+/** UTM Mapper:Read|Read UTM mapper configuration */
+ | 'UTM_MAPPER_READ';
 /**
  * Known location types that can be passed to a mesh location
  */
@@ -1217,31 +1287,23 @@ type DynamicInput = {
 /** Record of dynamic inputs keyed by the input name */
 type DynamicInputs = Record<string, DynamicInput>;
 
-type AIGenerateLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
-    /** The Uniform project ID */
-    projectId: string;
+type AIGenerateLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     prompt: string;
     promptMetadata: Record<string, unknown>;
     /** Useful to differentiate AI Generate UI between text and image */
     promptOutputType: 'text' | 'image';
-};
-type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = {
-    settings: TIntegrationConfiguration;
+}, TIntegrationConfiguration>;
+type PromptSettingsLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /** Useful to differentiate metadata settings between text and image generation */
     promptOutputType: 'text' | 'image';
-};
+}, TIntegrationConfiguration>;
 type AIGenerateLocation<TType> = MeshLocationCore<TType, AIGenerateLocationMetadata, TType, 'aiGenerate'>;
 type AIPromptMetadataLocation = MeshLocationCore<Record<string, unknown>, PromptSettingsLocationMetadata, Record<string, unknown>, 'aiMetadata'>;
 
-type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = {
-    /** Settings defined at the integration level (arbitrary type used on settings location) */
-    settings: TIntegrationConfiguration;
+type ParamTypeConfigLocationMetadata<TIntegrationConfiguration = unknown> = CommonMetadata<{
     /** The Uniform project ID */
-    projectId: string;
     componentDefinition: ComponentDefinition;
-};
+}, TIntegrationConfiguration>;
 type ParamTypeConfigLocation<TParamValue = unknown, TIntegrationConfiguration = unknown> = MeshLocationCore<TParamValue | undefined, ParamTypeConfigLocationMetadata<TIntegrationConfiguration>, TParamValue, 'paramTypeConfig'>;
 
 interface SdkWindow {
@@ -1341,4 +1403,10 @@ declare function initializeUniformMeshSDK({ autoResizingDisabled, }?: {
     autoResizingDisabled?: boolean;
 }): Promise<UniformMeshSDK | undefined>;
 
-export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CloseDialogMessage, type CloseLocationDialogOptions, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type ValidationResult, initializeUniformMeshSDK };
+declare const hasPermissions: (permissions: MeshLocationUserPermissions | MeshLocationUserPermissions[], user: UniformUser) => boolean;
+/**
+ * Check if user has a role by both name and id
+ */
+declare const hasRole: (role: string, user: UniformUser) => boolean;
+
+export { type AIGenerateLocation, type AIGenerateLocationMetadata, type AIPromptMetadataLocation, type AssetLibraryLocation, type AssetLibraryLocationMetadata, type AssetParameterLocation, type AssetParameterLocationMetadata, type BindableTypes, type CSSHeight, type CloseDialogMessage, type CloseLocationDialogOptions, type CommonMetadata, type DataConnectorInfo, type DataResourceLocation, type DataResourceLocationMetadata, type DataSourceLocation, type DataSourceLocationMetadata, type DataSourceLocationValue, type DataTypeLocation, type DataTypeLocationMetadata, type DataTypeLocationValue, type DialogContext, type DialogOptions, type DialogParamValue, type DialogParams, type DialogResponseData, type DialogResponseHandler, type DialogResponseHandlers, type DialogType, type DynamicInput, type DynamicInputs, type EditConnectedDataMessage, type EditConnectedDataResponse, type EditConnectedDataResponseCancellationContext, type GetDataResourceLocation, type GetDataResourceMessage, IntegrationDefinitionClient, type IntegrationDefinitionDeleteParameters, type IntegrationDefinitionGetParameters, type IntegrationDefinitionGetResponse, type IntegrationDefinitionPutParameters, type IntegrationDefinitionPutResponse, IntegrationInstallationClient, type IntegrationInstallationDeleteParameters, type IntegrationInstallationGetParameters, type IntegrationInstallationGetResponse, type IntegrationInstallationPutParameters, type LocationDialogResponse, type MeshContextData, type MeshLocation, type MeshLocationCore, type MeshLocationTypes, type MeshLocationUserPermissions, type MeshSDKEventInterface, type OpenConfirmationDialogOptions, type OpenConfirmationDialogResult, type OpenDialogMessage, type OpenDialogResult, type OpenLocationDialogOptions, type ParamTypeConfigLocation, type ParamTypeConfigLocationMetadata, type ParamTypeLocation, type ParamTypeLocationMetadata, type PromptSettingsLocationMetadata, type SdkWindow, type SetLocationFunction, type SetValueMessage, type SetValueOptions, type SettingsLocation, type SettingsLocationMetadata, type UniformMeshSDK, type UniformMeshSDKEvents, type UniformUser, type ValidationResult, hasPermissions, hasRole, initializeUniformMeshSDK };

package/dist/index.esm.js

@@ -801,8 +801,26 @@ async function initializeUniformMeshSDK({
     return sdk;
   }
 }
+
+// src/user.ts
+var hasPermissions = (permissions, user) => {
+  if (user.isAdmin)
+    return true;
+  if (Array.isArray(permissions)) {
+    return permissions.every((permission) => user.permissions.includes(permission));
+  } else {
+    return user.permissions.includes(permissions);
+  }
+};
+var hasRole = (role, user) => {
+  if (user.isAdmin)
+    return true;
+  return user.roles.some((userRole) => userRole.name === role || userRole.id === role);
+};
 export {
   IntegrationDefinitionClient,
   IntegrationInstallationClient,
+  hasPermissions,
+  hasRole,
   initializeUniformMeshSDK
 };

package/dist/index.js

@@ -45,6 +45,8 @@ var src_exports = {};
 __export(src_exports, {
   IntegrationDefinitionClient: () => IntegrationDefinitionClient,
   IntegrationInstallationClient: () => IntegrationInstallationClient,
+  hasPermissions: () => hasPermissions,
+  hasRole: () => hasRole,
   initializeUniformMeshSDK: () => initializeUniformMeshSDK
 });
 module.exports = __toCommonJS(src_exports);
@@ -838,9 +840,27 @@ async function initializeUniformMeshSDK({
     return sdk;
   }
 }
+
+// src/user.ts
+var hasPermissions = (permissions, user) => {
+  if (user.isAdmin)
+    return true;
+  if (Array.isArray(permissions)) {
+    return permissions.every((permission) => user.permissions.includes(permission));
+  } else {
+    return user.permissions.includes(permissions);
+  }
+};
+var hasRole = (role, user) => {
+  if (user.isAdmin)
+    return true;
+  return user.roles.some((userRole) => userRole.name === role || userRole.id === role);
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   IntegrationDefinitionClient,
   IntegrationInstallationClient,
+  hasPermissions,
+  hasRole,
   initializeUniformMeshSDK
 });

package/dist/index.mjs

@@ -801,8 +801,26 @@ async function initializeUniformMeshSDK({
     return sdk;
   }
 }
+
+// src/user.ts
+var hasPermissions = (permissions, user) => {
+  if (user.isAdmin)
+    return true;
+  if (Array.isArray(permissions)) {
+    return permissions.every((permission) => user.permissions.includes(permission));
+  } else {
+    return user.permissions.includes(permissions);
+  }
+};
+var hasRole = (role, user) => {
+  if (user.isAdmin)
+    return true;
+  return user.roles.some((userRole) => userRole.name === role || userRole.id === role);
+};
 export {
   IntegrationDefinitionClient,
   IntegrationInstallationClient,
+  hasPermissions,
+  hasRole,
   initializeUniformMeshSDK
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/mesh-sdk",
-  "version": "19.114.0",
+  "version": "19.114.1-alpha.7+205e9240f9",
   "description": "Uniform Mesh Framework SDK",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -33,14 +33,14 @@
     "access": "public"
   },
   "dependencies": {
-    "@uniformdev/canvas": "19.114.0",
-    "@uniformdev/context": "19.114.0",
-    "@uniformdev/project-map": "19.114.0",
+    "@uniformdev/canvas": "19.114.1-alpha.7+205e9240f9",
+    "@uniformdev/context": "19.114.1-alpha.7+205e9240f9",
+    "@uniformdev/project-map": "19.114.1-alpha.7+205e9240f9",
     "imagesloaded": "^5.0.0",
     "mitt": "^3.0.0"
   },
   "devDependencies": {
     "@types/imagesloaded": "^4.1.2"
   },
-  "gitHead": "c9d4260a191785215cdca52c78f869be809f6e06"
+  "gitHead": "205e9240f95b7c75d2cdaefb5588c56b8c1e9368"
 }