@lowdefy/docs 4.0.0-alpha.7 → 4.0.0-alpha.8

package/blocks/input/DateRangeSelector.yaml

@@ -1,26 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: DateRangeSelector
-    value_type: date[]
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/DateRangeSelector/schema.json
-    filePath: blocks/input/DateRangeSelector.yaml
-    description_content: |
-      The `DateRangeSelector` block allows the user to choose a start date and an end date for a date range. The selected range is saved as an array with two date elements, the start and end dates.
-
-      > Other date type blocks are `DateSelector`, `DateTimeSelector`, `MonthSelector` and `WeekSelector`.

package/blocks/input/DateSelector.yaml

@@ -1,26 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: DateSelector
-    value_type: date
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/DateSelector/schema.json
-    filePath: blocks/input/DateSelector.yaml
-    description_content: |
-      The `DateSelector` block allows a user to select a date from a calender.
-
-      > Other date type blocks are `DateRangeSelector`, `DateTimeSelector`, `MonthSelector` and `WeekSelector`.

package/blocks/input/DateTimeSelector.yaml

@@ -1,28 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: DateTimeSelector
-    value_type: date
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/DateTimeSelector/schema.json
-    filePath: blocks/input/DateTimeSelector.yaml
-    description_content: |
-      The `DateTimeSelector` block allows a user to select a date and a time from a calender.
-
-      By default, the time selected by the user is converted to GMT time, based on the timezone of the user. The selector will also display the selected time in the correct timezone for that user. If the `selectGMT` property is set to true, the value of the selector will be the time selected by the user as GMT time, and not in the timezone of the user.
-
-      > Other date type blocks are `DateRangeSelector`, `DateTimeSelector`, `MonthSelector` and `WeekSelector`.

package/blocks/input/GithubColorSelector.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: GithubColorSelector
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-color-selectors/src/blocks/GithubColorSelector/schema.json
-    filePath: blocks/input/GithubColorSelector.yaml
-    description_content: |
-      A color selector component similar to the Github color selector.

package/blocks/input/MonthSelector.yaml

@@ -1,26 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: MonthSelector
-    value_type: date
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/MonthSelector/schema.json
-    filePath: blocks/input/MonthSelector.yaml
-    description_content: |
-      The `MonthSelector` block allows a user to select a month. The value is a date object, with day and time values of midnight on the first day of the month GMT.
-
-      > Other date type blocks are `DateRangeSelector`, `DateSelector`, `DateTimeSelector` and `WeekSelector`.

package/blocks/input/MultipleSelector.yaml

@@ -1,117 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: MultipleSelector
-    value_type: any[]
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/MultipleSelector/schema.json
-    filePath: blocks/input/MultipleSelector.yaml
-    init_state_values:
-      __type_block.properties.options: object[]
-      __object_arr_block.properties.options:
-        - label: First
-          value: '1'
-        - label: Second
-          value: '2'
-
-    description_content: |
-      The `MultipleSelector` block is a drop down selector that allows a user to select multiple values from a set of options.
-
-      The options for the selector can be provides as either an array of primitive values (Strings, numbers, booleans or dates), or as an array of label-value pairs, where the label is a string, and the value can be of any type, including objects like dates and arrays.
-
-      > Other selector blocks are `ButtonSelector`, `CheckboxSelector`, `RadioSelector` and `Selector`.
-
-    examples:
-      - title: Listing options from database search
-        block:
-          id: example_selector
-          type: MultipleSelector
-          requests:
-            - id: example_search
-              type: MongoDBAggregation
-              connectionId: companies
-              properties:
-                pipeline:
-                  - $search:
-                      compound:
-                        should:
-                          - wildcard:
-                              query:
-                                _string.concat:
-                                  - '*'
-                                  - _state: search_input
-                                  - '*'
-                              path: # field names to search in the companies collection
-                                - _id
-                                - company_name
-                              allowAnalyzedField: true
-                  - $addFields:
-                      score:
-                        $meta: searchScore
-                  - $sort:
-                      score: -1
-                  - $limit: 50
-                  - $project:
-                      _id: 0
-                      value: $_id
-                      label:
-                        $concat:
-                          - $_id
-                          - ' - '
-                          - $ifNull:
-                              - $company_name
-                              - ''
-          properties:
-            placeholder: Search
-            options: # search request results will be used as options
-              _array.concat:
-                - _if_none:
-                    - _state: example_options
-                    - []
-                - _if_none:
-                    - _request: example_search
-                    - []
-            label:
-              disabled: true
-          events:
-            onChange: # selector onChange actions - triggered when the value of the selector changes
-              - id: set_state
-                type: SetState
-                params:
-                  example_options:
-                    _mql.aggregate:
-                      on:
-                        _array.concat:
-                          - _state: example_options
-                          - _request: example_search
-                      pipeline:
-                        - $match:
-                            value:
-                              $in:
-                                _state: example_selector
-            onSearch: # selector onSearch actions - triggered when the user types in the search input
-              debounce:
-                ms: 500
-              try:
-                - id: set_state
-                  type: SetState
-                  params:
-                    search_input:
-                      _event: value
-                - id: perform_search
-                  type: Request
-                  params: example_search

package/blocks/input/NumberInput.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: NumberInput
-    value_type: number
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/NumberInput/schema.json
-    filePath: blocks/input/NumberInput.yaml
-    description_content: |
-      The `NumberInput` allows a user to input a number.

package/blocks/input/Pagination.yaml

@@ -1,33 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Pagination
-    value_type: object
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Pagination/schema.json
-    filePath: blocks/input/Pagination.yaml
-    init_property_values:
-      pageSizeOptions: [10, 20, 30, 40]
-    init_state_values:
-      block_id:
-        current: 0
-        pageSize: 10
-        skip: 0
-    description_content: |
-      The `Pagination` controls user input for pagination purposes.
-
-      > This block does not paginate requests, it only manage pagination parameters which can be used to control pagination requests.

package/blocks/input/ParagraphInput.yaml

@@ -1,32 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: ParagraphInput
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/ParagraphInput/schema.json
-    filePath: blocks/input/ParagraphInput.yaml
-    init_state_values:
-      __type_block.properties.copyable: boolean
-      __type_block.properties.ellipsis: boolean
-      __type_block.properties.editable: boolean
-      __boolean_block.properties.copyable: false
-      __boolean_block.properties.ellipsis: false
-      __boolean_block.properties.editable: true
-      block_id: Click edit to change the paragraph content.
-    description_content: |
-      The `ParagraphInput` block can display a paragraph, yet allow the user to click a edit icon and change the paragraph content. This is useful when the UI renders an existing document with a paragraph, which a user must be able to edit.

package/blocks/input/PasswordInput.yaml

@@ -1,48 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: PasswordInput
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/PasswordInput/schema.json
-    filePath: blocks/input/PasswordInput.yaml
-    description_content: |
-      The `PasswordInput` block is a single line password input.
-
-    examples:
-      - title: Required password input
-        block:
-          id: required_example
-          type: PasswordInput
-          required: true
-          properties:
-            title: Required password input
-      - title: Placeholder
-        block:
-          id: placeholder_example
-          type: PasswordInput
-          properties:
-            placeholder: Placeholder
-      - title: Password
-        block:
-          id: password
-          type: PasswordInput
-          properties:
-            title: Password
-            placeholder: Your password
-            label:
-              span: 6

package/blocks/input/RadioSelector.yaml

@@ -1,36 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: RadioSelector
-    value_type: any
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/RadioSelector/schema.json
-    filePath: blocks/input/RadioSelector.yaml
-    init_state_values:
-      __type_block.properties.options: object[]
-      __object_arr_block.properties.options:
-        - label: First
-          value: '1'
-        - label: Second
-          value: '2'
-
-    description_content: |
-      The `RadioSelector` block is a set of radio buttons that allow a user to select a single value from a set of options.
-
-      The options for the selector can be provides as either an array of primitive values (Strings, numbers, booleans or dates), or as an array of label-value pairs, where the label is a string, and the value can be of any type, including objects like dates and arrays.
-
-      > Other selector blocks are `ButtonSelector`, `CheckboxSelector`, `MultipleSelector` and `Selector`.

package/blocks/input/RatingSlider.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: RatingSlider
-    value_type: number
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/RatingSlider/schema.json
-    filePath: blocks/input/RatingSlider.yaml
-    description_content: |
-      The `RatingSlider` block allows a user to choose a numerical value on a slider input. It is typically used for scores or ratings. It has the option to have a "Not Applicable" checkbox, which leaves the value as null.

package/blocks/input/S3UploadButton.yaml

@@ -1,28 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: S3UploadButton
-    value_type: object
-    category: input
-    schema: ../plugins/plugins/plugin-aws/src/blocks/S3UploadButton/schema.json
-    filePath: blocks/input/S3UploadButton.yaml
-    description_content: |
-      The `S3UploadButton` block allows a user to to upload a file to AWS S3.
-
-      The `s3PostPolicyRequestId` property is required, and should be the `id` of a [`AwsS3PresignedPostPolicy`](/AWSS3) request. This request is called by the block when the user uploads a file, to create a policy that allows a file to be uploaded to AWS S3.
-
-      The block has an object value in state, with a `file` key, which has an object corresponding to the last uploaded file, and a `fileList` array with objects for each the files.

package/blocks/input/Selector.yaml

@@ -1,98 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Selector
-    value_type: any
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Selector/schema.json
-    filePath: blocks/input/Selector.yaml
-    init_state_values:
-      __type_block.properties.options: object[]
-      __object_arr_block.properties.options:
-        - label: First
-          value: '1'
-        - label: Second
-          value: '2'
-
-    description_content: |
-      The `Selector` block is a drop down selector that allows a user to select a single value from a set of options.
-
-      The options for the selector can be provides as either an array of primitive values (Strings, numbers, booleans or dates), or as an array of label-value pairs, where the label is a string, and the value can be of any type, including objects like dates and arrays.
-
-      > Other selector blocks are `ButtonSelector`, `CheckboxSelector`, `MultipleSelector` and `RadioSelector`.
-
-    examples:
-      - title: Listing options from database search
-        block:
-          id: example_selector
-          type: Selector
-          requests:
-            - id: example_search
-              type: MongoDBAggregation
-              connectionId: companies
-              properties:
-                pipeline:
-                  - $search:
-                      compound:
-                        should:
-                          - wildcard:
-                              query:
-                                _string.concat:
-                                  - '*'
-                                  - _state: search_input
-                                  - '*'
-                              path: # field names to search in the companies collection
-                                - _id
-                                - company_name
-                              allowAnalyzedField: true
-                  - $addFields:
-                      score:
-                        $meta: searchScore
-                  - $sort:
-                      score: -1
-                  - $limit: 50
-                  - $project: # selector options value, label pairs
-                      _id: 0
-                      value: $_id
-                      label:
-                        $concat:
-                          - $_id
-                          - ' - '
-                          - $ifNull:
-                              - $company_name
-                              - ''
-          properties:
-            placeholder: Search
-            options:
-              _if_none: # search request results will be used as options
-                - _request: example_search
-                - []
-            label:
-              disabled: true
-          events:
-            onSearch: # selector onSearch actions
-              debounce:
-                ms: 500
-              try:
-                - id: set_state
-                  type: SetState
-                  params:
-                    search_input:
-                      _event: value
-                - id: perform_search
-                  type: Request
-                  params: example_search

package/blocks/input/SliderColorSelector.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: SliderColorSelector
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-color-selectors/src/blocks/SliderColorSelector/schema.json
-    filePath: blocks/input/SliderColorSelector.yaml
-    description_content: |
-      A slider color selector component.

package/blocks/input/SwatchesColorSelector.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: SwatchesColorSelector
-    value_type: string
-    category: input
-    schema: ../plugins/blocks/blocks-color-selectors/src/blocks/SwatchesColorSelector/schema.json
-    filePath: blocks/input/SwatchesColorSelector.yaml
-    description_content: |
-      A swatches color selector component.

package/blocks/input/Switch.yaml

@@ -1,24 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/blocks/template.yaml.njk
-  vars:
-    block_type: Switch
-    value_type: boolean
-    category: input
-    schema: ../plugins/blocks/blocks-antd/src/blocks/Switch/schema.json
-    filePath: blocks/input/Switch.yaml
-    description_content: |
-      The `Switch` block is an on/off input. It has a boolean value (true/false).