budibase/packages/builder/src/components/integration/QueryBindingBuilder.svelte

<script>
  import { Body, Button, Heading, Icon, Input, Layout } from "@budibase/bbui"
  import {
    readableToRuntimeBinding,
    runtimeToReadableBinding,
  } from "builderStore/dataBinding"
  import DrawerBindableInput from "components/common/bindings/DrawerBindableInput.svelte"

  export let bindable = true
  export let queryBindings = []
  export let bindings = []
  export let customParams = {}

  function newQueryBinding() {
    queryBindings = [...queryBindings, {}]
  }

  function deleteQueryBinding(idx) {
    queryBindings.splice(idx, 1)
    queryBindings = queryBindings
  }

  // This is necessary due to the way readable and writable bindings are stored.
  // The readable binding in the UI gets converted to a UUID value that the client understands
  // for parsing, then converted back so we can display it the readable form in the UI
  function onBindingChange(param, valueToParse) {
    customParams[param] = readableToRuntimeBinding(bindings, valueToParse)
  }
</script>

<Layout noPadding={bindable} gap="S">
  <div class="controls" class:height={!bindable}>
    <Heading size="XS">Bindings</Heading>
    {#if !bindable}
      <Button secondary on:click={newQueryBinding}>Add Binding</Button>
    {/if}
  </div>
  <Body size="S">
    {#if !bindable}
      Bindings come in two parts: the binding name, and a default/fallback
      value. These bindings can be used as Handlebars expressions throughout the
      query.
    {:else}
      Enter a value for each binding. The default values will be used for any
      values left blank.
    {/if}
  </Body>
  <div class="bindings" class:bindable>
    {#each queryBindings as binding, idx}
      <Input
        placeholder="Binding Name"
        thin
        disabled={bindable}
        bind:value={binding.name}
      />
      <Input
        placeholder="Default"
        thin
        disabled={bindable}
        on:change={evt => onBindingChange(binding.name, evt.detail)}
        bind:value={binding.default}
      />
      {#if bindable}
        <DrawerBindableInput
          title={`Query binding "${binding.name}"`}
          placeholder="Value"
          thin
          on:change={evt => onBindingChange(binding.name, evt.detail)}
          value={runtimeToReadableBinding(
            bindings,
            customParams?.[binding.name]
          )}
          {bindings}
        />
      {:else}
        <Icon hoverable name="Close" on:click={() => deleteQueryBinding(idx)} />
      {/if}
    {/each}
  </div>
</Layout>

<style>
  .bindings.bindable {
    grid-template-columns: 1fr 1fr 1fr;
  }

  .controls {
    display: flex;
    align-items: center;
    justify-content: space-between;
  }

  .bindings {
    display: grid;
    grid-template-columns: 1fr 1fr 5%;
    grid-gap: 10px;
    align-items: center;
  }

  .height {
    height: 40px;
  }
</style>
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00			`<script>`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`import { Body, Button, Heading, Icon, Input, Layout } from "@budibase/bbui"`
readable to writable bindings 2021-01-12 11:28:41 +01:00			`import {`
			`readableToRuntimeBinding,`
			`runtimeToReadableBinding,`
Fix incorrect paths after merge 2021-01-20 14:20:08 +01:00			`} from "builderStore/dataBinding"`
Moving drawers around to be a common component as they are utilised in a few places, keep all the binding work together, as well as some fixing for readable/runtime binding detection and conversion. 2021-04-30 17:17:57 +02:00			`import DrawerBindableInput from "components/common/bindings/DrawerBindableInput.svelte"`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00
styling, async data fetching 2021-01-11 21:17:56 +01:00			`export let bindable = true`
Renaming bindableOptions to bindings and replacing the query bindings variable with queryBindings. 2022-01-20 17:12:32 +01:00			`export let queryBindings = []`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00			`export let bindings = []`
			`export let customParams = {}`

Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`function newQueryBinding() {`
Renaming bindableOptions to bindings and replacing the query bindings variable with queryBindings. 2022-01-20 17:12:32 +01:00			`queryBindings = [...queryBindings, {}]`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00			`}`

Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`function deleteQueryBinding(idx) {`
Renaming bindableOptions to bindings and replacing the query bindings variable with queryBindings. 2022-01-20 17:12:32 +01:00			`queryBindings.splice(idx, 1)`
			`queryBindings = queryBindings`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00			`}`
readable to writable bindings 2021-01-12 11:28:41 +01:00
further syntax highlighting updates 2021-01-12 17:49:11 +01:00			`// This is necessary due to the way readable and writable bindings are stored.`
			`// The readable binding in the UI gets converted to a UUID value that the client understands`
			`// for parsing, then converted back so we can display it the readable form in the UI`
readable to writable bindings 2021-01-12 11:28:41 +01:00			`function onBindingChange(param, valueToParse) {`
Renaming bindableOptions to bindings and replacing the query bindings variable with queryBindings. 2022-01-20 17:12:32 +01:00			`customParams[param] = readableToRuntimeBinding(bindings, valueToParse)`
readable to writable bindings 2021-01-12 11:28:41 +01:00			`}`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00			`</script>`

Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`<Layout noPadding={bindable} gap="S">`
			`<div class="controls" class:height={!bindable}>`
			`<Heading size="XS">Bindings</Heading>`
design updates, changing query verb names to HTTP verbs 2021-02-18 17:58:10 +01:00			`{#if !bindable}`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`<Button secondary on:click={newQueryBinding}>Add Binding</Button>`
design updates, changing query verb names to HTTP verbs 2021-02-18 17:58:10 +01:00			`{/if}`
			`</div>`
Convert Body component to use size="" prop 2021-04-30 13:31:45 +02:00			`<Body size="S">`
Merge branch 'develop' of github.com:Budibase/budibase into repeater-filtering 2021-02-22 13:23:46 +01:00			`{#if !bindable}`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`Bindings come in two parts: the binding name, and a default/fallback`
			`value. These bindings can be used as Handlebars expressions throughout the`
			`query.`
Merge branch 'develop' of github.com:Budibase/budibase into repeater-filtering 2021-02-22 13:23:46 +01:00			`{:else}`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`Enter a value for each binding. The default values will be used for any`
Merge branch 'develop' of github.com:Budibase/budibase into repeater-filtering 2021-02-22 13:23:46 +01:00			`values left blank.`
			`{/if}`
design updates, changing query verb names to HTTP verbs 2021-02-18 17:58:10 +01:00			`</Body>`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`<div class="bindings" class:bindable>`
Renaming bindableOptions to bindings and replacing the query bindings variable with queryBindings. 2022-01-20 17:12:32 +01:00			`{#each queryBindings as binding, idx}`
Query page tidy up Props aligned in a row within the header. Add params popover UI tidied (labels removed, etc) Query name made an input, and the old query name input removed. Query type is not an input anymore. Provided a height for the query editor Aligned run/save query buttons with the preview panel. 2021-01-22 17:49:22 +01:00			`<Input`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`placeholder="Binding Name"`
Query page tidy up Props aligned in a row within the header. Add params popover UI tidied (labels removed, etc) Query name made an input, and the old query name input removed. Query type is not an input anymore. Provided a height for the query editor Aligned run/save query buttons with the preview panel. 2021-01-22 17:49:22 +01:00			`thin`
			`disabled={bindable}`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`bind:value={binding.name}`
converts QueryViewer to use new Layout component 2021-04-27 15:26:03 +02:00			`/>`
Query page tidy up Props aligned in a row within the header. Add params popover UI tidied (labels removed, etc) Query name made an input, and the old query name input removed. Query type is not an input anymore. Provided a height for the query editor Aligned run/save query buttons with the preview panel. 2021-01-22 17:49:22 +01:00			`<Input`
			`placeholder="Default"`
			`thin`
			`disabled={bindable}`
Context binding for authenticated user in REST API querys. Includes fix for REST datasource UI 2022-06-14 11:14:05 +02:00			`on:change={evt => onBindingChange(binding.name, evt.detail)}`
Fix to the default input binding to ensure new bindings are set correctly 2022-07-18 16:58:17 +02:00			`bind:value={binding.default}`
converts QueryViewer to use new Layout component 2021-04-27 15:26:03 +02:00			`/>`
styling, async data fetching 2021-01-11 21:17:56 +01:00			`{#if bindable}`
Fix and tidy up all button actions and drawers 2021-02-18 18:44:56 +01:00			`<DrawerBindableInput`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			title={`Query binding "${binding.name}"`}
Query page tidy up Props aligned in a row within the header. Add params popover UI tidied (labels removed, etc) Query name made an input, and the old query name input removed. Query type is not an input anymore. Provided a height for the query editor Aligned run/save query buttons with the preview panel. 2021-01-22 17:49:22 +01:00			`placeholder="Value"`
styling, async data fetching 2021-01-11 21:17:56 +01:00			`thin`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`on:change={evt => onBindingChange(binding.name, evt.detail)}`
converts QueryViewer to use new Layout component 2021-04-27 15:26:03 +02:00			`value={runtimeToReadableBinding(`
Renaming bindableOptions to bindings and replacing the query bindings variable with queryBindings. 2022-01-20 17:12:32 +01:00			`bindings,`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`customParams?.[binding.name]`
converts QueryViewer to use new Layout component 2021-04-27 15:26:03 +02:00			`)}`
Renaming bindableOptions to bindings and replacing the query bindings variable with queryBindings. 2022-01-20 17:12:32 +01:00			`{bindings}`
converts QueryViewer to use new Layout component 2021-04-27 15:26:03 +02:00			`/>`
further syntax highlighting updates 2021-01-12 17:49:11 +01:00			`{:else}`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`<Icon hoverable name="Close" on:click={() => deleteQueryBinding(idx)} />`
styling, async data fetching 2021-01-11 21:17:56 +01:00			`{/if}`
binding data context in component 2021-01-08 19:22:03 +01:00			`{/each}`
			`</div>`
Remove spacer and use Layout 2021-04-28 15:40:15 +02:00			`</Layout>`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00
			`<style>`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`.bindings.bindable {`
further syntax highlighting updates 2021-01-12 17:49:11 +01:00			`grid-template-columns: 1fr 1fr 1fr;`
styling, async data fetching 2021-01-11 21:17:56 +01:00			`}`

design updates, changing query verb names to HTTP verbs 2021-02-18 17:58:10 +01:00			`.controls {`
			`display: flex;`
more design updates 2021-02-18 19:55:08 +01:00			`align-items: center;`
design updates, changing query verb names to HTTP verbs 2021-02-18 17:58:10 +01:00			`justify-content: space-between;`
			`}`

Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00			`.bindings {`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00			`display: grid;`
styling, async data fetching 2021-01-11 21:17:56 +01:00			`grid-template-columns: 1fr 1fr 5%;`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00			`grid-gap: 10px;`
			`align-items: center;`
further syntax highlighting updates 2021-01-12 17:49:11 +01:00			`}`
Adding bindings to rest API, adding in spaceship placeholder, updating the look of some other components, cleaning up some whitespace. 2021-12-08 18:58:30 +01:00
			`.height {`
			`height: 40px;`
			`}`
Allow dynamic query execution from front end components 2021-01-08 13:06:37 +01:00			`</style>`