Add comments to some data binding functions

This commit is contained in:
Andrew Kingston 2023-09-15 08:52:46 +01:00
parent 0d0d96f5da
commit 429f2e0c5f
1 changed files with 14 additions and 5 deletions

View File

@ -97,6 +97,9 @@ export const getAuthBindings = () => {
return bindings return bindings
} }
/**
* Gets all bindings for environment variables
*/
export const getEnvironmentBindings = () => { export const getEnvironmentBindings = () => {
let envVars = get(environment).variables let envVars = get(environment).variables
return envVars.map(variable => { return envVars.map(variable => {
@ -125,26 +128,22 @@ export const toBindingsArray = (valueMap, prefix, category) => {
if (!binding) { if (!binding) {
return acc return acc
} }
let config = { let config = {
type: "context", type: "context",
runtimeBinding: binding, runtimeBinding: binding,
readableBinding: `${prefix}.${binding}`, readableBinding: `${prefix}.${binding}`,
icon: "Brackets", icon: "Brackets",
} }
if (category) { if (category) {
config.category = category config.category = category
} }
acc.push(config) acc.push(config)
return acc return acc
}, []) }, [])
} }
/** /**
* Utility - coverting a map of readable bindings to runtime * Utility to covert a map of readable bindings to runtime
*/ */
export const readableToRuntimeMap = (bindings, ctx) => { export const readableToRuntimeMap = (bindings, ctx) => {
if (!bindings || !ctx) { if (!bindings || !ctx) {
@ -333,6 +332,9 @@ const getContextBindings = (asset, componentId) => {
.flat() .flat()
} }
/**
* Generates a set of bindings for a given component context
*/
const generateComponentContextBindings = (asset, componentContext) => { const generateComponentContextBindings = (asset, componentContext) => {
const { component, definition, contexts } = componentContext const { component, definition, contexts } = componentContext
if (!component || !definition || !contexts?.length) { if (!component || !definition || !contexts?.length) {
@ -577,6 +579,7 @@ const getDeviceBindings = () => {
/** /**
* Gets all selected rows bindings for tables in the current asset. * Gets all selected rows bindings for tables in the current asset.
* TODO: remove in future because we don't need a separate store for this
*/ */
const getSelectedRowsBindings = asset => { const getSelectedRowsBindings = asset => {
let bindings = [] let bindings = []
@ -619,6 +622,9 @@ const getSelectedRowsBindings = asset => {
return bindings return bindings
} }
/**
* Generates a state binding for a certain key name
*/
export const makeStateBinding = key => { export const makeStateBinding = key => {
return { return {
type: "context", type: "context",
@ -673,6 +679,9 @@ const getUrlBindings = asset => {
return urlParamBindings.concat([queryParamsBinding]) return urlParamBindings.concat([queryParamsBinding])
} }
/**
* Generates all bindings for role IDs
*/
const getRoleBindings = () => { const getRoleBindings = () => {
return (get(rolesStore) || []).map(role => { return (get(rolesStore) || []).map(role => {
return { return {