Home > @uniformdev/mesh-sdk

mesh-sdk package

Classes

ClassDescription
IntegrationDefinitionClientAPI Client to manage the registration of custom Mesh applications
IntegrationInstallationClientAPI Client to manage the registration of custom Mesh applications

Functions

FunctionDescription
hasPermissions(permissions, user)
hasRole(role, user)Check if user has a role by both name and id
initializeUniformMeshSDK({ autoResizingDisabled, })Initializes the Uniform Mesh SDK. Intended to be called (and awaited) prior to any attempted interaction with the Uniform Mesh SDK.
parseFunctionCall(request)

Interfaces

InterfaceDescription
DialogContext
DialogOptions
DialogResponseData
DialogResponseHandler
DialogResponseHandlers
EditorStateApi<p>Imperative API for interacting with the composition/entry editor state. Available on <code>canvasEditorTools</code> and <code>paramType</code> locations.</p><p>All methods use object parameters for consistency across client, wire format, and server.</p>
LocationDialogResponse
MeshContextData
MeshLocationCoreCore shared generic for a mesh location context
SdkWindow
SetPropertyLocalizabilityCommonParamsCommon fields for EditorStateApi.setPropertyLocalizability().
UniformMeshSDK

Variables

VariableDescription
functionCallSystemParameters

Type Aliases

Type AliasDescription
AIGenerateLocation
AIGenerateLocationMetadata
AIPromptMetadataLocation
AssetLibraryLocation
AssetLibraryLocationMetadata
AssetParameterLocation
AssetParameterLocationMetadata
BindableTypesPrimitive data types that a parameter type accepts to be bound to composition data
CanvasEditorEntityType
CanvasEditorToolsData
CanvasEditorToolsLocation
CanvasEditorToolsLocationMetadata
CloseDialogMessage
CloseLocationDialogOptions
CommonMetadataCommon metadata for all mesh locations
CSSHeight
DashboardToolLocation
DashboardToolLocationMetadata
DataConnectorInfo
DataResourceLocation
DataResourceLocationMetadata
DataResourceSelectorLocation<p>Location for custom data resource selector UI. Replaces the default JSON tree viewer when selecting dynamic tokens from a data resource.</p><p>Value: The selected JSON pointer string (e.g., "/moves/0/move/name") setValue: Call with a valid JSON pointer to select that path getDataResource: Fetch data from the data connector using the current data source editorState: Imperative API for inspecting/mutating the underlying composition / entry tree</p>
DataResourceSelectorLocationMetadataMetadata for the dataResourceSelector location. This location type allows custom UI for selecting JSON pointers within a data resource, replacing the default JSON tree viewer in the dynamic token picker.
DataSourceLocation
DataSourceLocationMetadata
DataSourceLocationValue
DataTypeLocation
DataTypeLocationMetadata
DataTypeLocationValue
DeleteNodeOptionsOptions for deleteNode
DialogParams
DialogParamValue
DialogType
DynamicInput<p>Dynamic inputs come from project map and represent path or query based dynamic values These can be connected to from within a Mesh location by setting a data resource variable to contain ex: $} expression(s).</p><p>Dynamic inputs only work at runtime when using the route endpoint to fetch data.</p>
DynamicInputsRecord of dynamic inputs keyed by the input name
EditConnectedDataMessageMessage to parent to create a data connection expression to insert in a param type
EditConnectedDataResponseResponse from parent when creating a dynamic token expression
EditConnectedDataResponseCancellationContext
EditorComponentInstanceA component instance without slots/params (indexed separately)
EditorComponentParameterA component parameter value
EditorExportOptionsOptions for exporting the tree
EditorNodeAn indexed node within the editor state
EditorNodeChildrenChild node IDs indexed by slot name
EditorNodeParentInfoParent info for a node
EditorRootMetadataMetadata about the composition (description, category, workflow, etc.)
EditorRootNodeMetadataRoot node metadata (name and slug)
EmbeddedEditorLocation
EmbeddedEditorLocationMetadata
EmbeddedEditorLocationSetValue
EmbeddedEditorLocationValue
FunctionCallResponse
FunctionCallSystemParameter
GetDataResourceLocation
GetDataResourceMessage
InsertNodeOptionsOptions for insertNode
InsertPatternOptionsOptions for insertPattern
IntegrationDefinitionDeleteParametersThe DELETE body for /api/v1/integration-definitions
IntegrationDefinitionGetParametersQuery parameter options for GET /api/v1/integration-definitions
IntegrationDefinitionGetResponseThe GET response from /api/v1/integration-definitions
IntegrationDefinitionPutParametersThe PUT body for /api/v1/integration-definitions
IntegrationDefinitionPutResponseThe PUT response body for /api/v1/integration-definitions (has team-specific integration type)
IntegrationInstallationDeleteParametersThe DELETE body for /api/v1/integration-installations
IntegrationInstallationGetParametersQuery parameter options for GET /api/v1/integration-installations
IntegrationInstallationGetResponseThe GET response from /api/v1/integration-installations
IntegrationInstallationPutParametersThe PUT body for /api/v1/integration-installations
MeshLocationDefines methods used for interacting with a Mesh location To receive useful typings, check the <code>type</code> property of the location to narrow the typing.
MeshLocationTypesKnown location types that can be passed to a mesh location
MeshLocationUserPermissions
MeshRouter
MeshSDKEventInterface
MoveNodeOptionsOptions for moveNode
NavigateMessage
OpenConfirmationDialogOptions
OpenConfirmationDialogResult
OpenDialogMessage
OpenDialogResult
OpenLocationDialogOptions
ParamTypeConfigLocation
ParamTypeConfigLocationMetadata
ParamTypeLocation
ParamTypeLocationMetadata
PersonalizationCriteriaLocation
PersonalizationCriteriaLocationMetadata
ProjectToolLocation
ProjectToolLocationMetadata
PromptSettingsLocationMetadata
SetLocationFunction
SetPropertyLocalizabilityParams<p>Discriminated-union params for EditorStateApi.setPropertyLocalizability().</p><p>- <code>isLocalized: true</code> (toggle ON): per-locale values are written to every enabled locale of the composition. - <code>isLocalized: false</code> (toggle OFF): per-locale values are collapsed back into a single invariant value, copying from <code>copyFromLocale</code> (or the first defined locale).</p>
SettingsLocation
SettingsLocationMetadata
SetValueMessage
SetValueOptions
UniformMeshSDKEventsEvents that can be emitted from the Mesh SDK
UniformUser
UpdateNodePropertyOptionsOptions for updateNodeProperty
UpdateRootNodeOptionsOptions for updateRootNode
ValidationResult