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

package/actions/CallMethod.yaml

@@ -1,57 +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/actions.yaml.njk
-  vars:
-    pageId: CallMethod
-    pageTitle: CallMethod
-    filePath: actions/CallMethod.yaml
-    types: |
-      ```
-      (params: {
-        blockId: string,
-        method: string,
-        args?: any[]
-      }): void
-      ```
-    description: |
-      The `CallMethod` action is used to call a method defined by another block.
-    params: |
-      ###### object
-        - `blockId: string`: __Required__ - The id of the block.
-        - `method: string`: __Required__ - The name of the method that should be called.
-        - `args: any[]`: The array of positional arguments with which the method should be called.
-
-    examples: |
-      ###### Open a modal:
-      ```yaml
-      - id: toggle_modal
-        type: CallMethod
-        params:
-          blockId: my_modal
-          method: toggleOpen
-      ```
-
-      ###### Display a message with args:
-      ```yaml
-      - id: display_message
-        type: CallMethod
-        params:
-          blockId: my_message
-          method: open
-          args:
-            - content: Hello
-              duration: 4
-      ```

package/actions/JsAction.yaml

@@ -1,281 +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/actions.yaml.njk
-  vars:
-    pageId: JsAction
-    pageTitle: JsAction
-    filePath: actions/JsAction.yaml
-    warning: |
-      SECURITY WARNING: The JsAction executes JavaScript inside your Lowdefy app. Insecure code can expose your app or data. Since Lowdefy doesn't validate your JavaScript, make sure that you only load trusted code.
-    types: |
-      ```
-      (params: {
-        name: string,
-        args?: any[]
-      }): void
-      ```
-    description: |
-      The `JsAction` action is used to call a custom JavaScript function which was loaded onto the page using the `window.lowdefy.registerJsAction()` method. This JavaScript function can be asynchronous. See [Custom Code](/custom-code) for more details on how to register a new JavaScript action.
-
-      The returned result of the JavaScript function is accessible through the [`_actions`](/_actions) operator for subsequent actions in the event action list.
-
-      #### JsAction function parameters
-
-      A `JsAction` function is called with a context object which includes all [`context` data objects](/context-and-state) as well as the list of `args` passed to the action.
-
-      ```text
-      (context: {
-        actions: object,
-        contextId: string,
-        global: object,
-        input: object,
-        pageId: string,
-        requests: object,
-        state: object,
-        urlQuery: object,
-        user: object,
-      },
-      ...args?: any[]): any
-      ```
-
-      #### Using Lowdefy actions in a JsAction
-
-      The context passed to the custom JsAction function contains an object called `actions`. This object contains all the Lowdefy action functions like `SetState`, `Request`, and `CallMethod`. The functions can be called using the same parameters as when they are used directly in the Lowdefy configuration. Operators in these parameters are not evaluated.
-
-    params: |
-      ###### object
-        - `name: string`: __Required__ - The registered name of the JavaScript function to call when the action is triggered.
-        - `args: any[]`: The array of positional arguments with which the JavaScript function should be called.
-
-    examples: |
-      ##### Set a [Intercom](https://www.intercom.com/) user when a page is initialized:
-
-      ```yaml
-      # lowdefy.yaml
-      name: intercom-example
-      lowdefy: '3.23.2'
-      app:
-        html:
-          appendBody: |
-            <script>
-              function setIntercomUser(context) {
-                window.intercomSettings = {
-                  app_id: "{{ your_intercom_app_id }}",
-                  name: context.user.name,
-                  email: context.user.email,
-                };
-              }
-              window.lowdefy.registerJsAction('setIntercomUser', setIntercomUser);
-            </script>
-            <script>
-              (function(){var w=window;var ic=w.Intercom;if(typeof ic==="function"){ic('reattach_activator');
-              ic('update',w.intercomSettings);}else{var d=document;var i=function(){i.c(arguments);};i.q=[];
-              i.c=function(args){i.q.push(args);};w.Intercom=i;var l=function(){var s=d.createElement('script');
-              s.type='text/javascript';s.async=true;s.src='https://widget.intercom.io/widget/{{ your_intercom_app_id }}';
-              var x=d.getElementsByTagName('script')[0];x.parentNode.insertBefore(s,x);};
-              if(w.attachEvent){w.attachEvent('onload',l);}else{w.addEventListener('load',l,false);}}})();
-            </script>
-      pages:
-        - id: home
-          type: PageHeaderMenu
-          events:
-            onInitAsync:
-              - id: set_intercom_user
-                type: JsAction # TODO:
-                params:
-                  name: setIntercomUser
-          blocks:
-            # ...
-      ```
-
-      ##### Highlight search term returned by [MongoDB Search Highlight](https://docs.atlas.mongodb.com/reference/atlas-search/highlighting/):
-      Add a JavaScript file to highlight the search text by wapping the highlighted text with `<span style="background: yellow;">{{ value }}</span>`:
-      ```js
-      // file: /public/highlightText.js
-        function highlightText(context, data) {
-          return data.map((item) => {
-            item.highlights.forEach((light) => {
-              const paths = light.path.split('.');
-              const key = paths[paths.length - 1];
-              paths.pop();
-              let res = item;
-              paths.forEach((key) => {
-                res = res[key];
-              });
-              res[key] = light.texts.reduce((acc, obj) => {
-                if (obj.type === 'hit') {
-                  return acc.concat('<span style="background: yellow;">', obj.value, '</span>');
-                }
-                return acc.concat(obj.value);
-              }, '');
-            });
-            return item;
-          });
-        }
-        export default highlightText;
-      ```
-      Import custom JavaScript modules:
-      ```js
-      // file: /public/modules.js
-      import highlightText from './highlightText.js';
-      window.lowdefy.registerJsAction('highlightText', highlightText);
-      ````
-      Lowdefy setup:
-      ```yaml
-      # file: lowdefy.yaml
-      name: text-highlight-example
-      lowdefy: '3.23.2'
-      app:
-        html:
-          # Load the custom modules into the index.html head tag.
-          appendHead: |
-            <script type="module" src="/public/modules.js"></script>
-      connections:
-        - id: products
-          type: MongoDBCollection
-          properties:
-            collection: products
-            databaseUri:
-              _secret: MDB_URI
-      pages:
-        - id: home
-          type: PageHeaderMenu
-          requests:
-            - id: search_products
-              type: MongoDBAggregation
-              connectionId: products
-              properties:
-                pipeline:
-                  _array.concat:
-                    - - $search:
-                          compound:
-                            should:
-                              - text:
-                                  query:
-                                    _string.concat:
-                                      - '*'
-                                      - _state: search.input
-                                      - '*'
-                                  path:
-                                    - title
-                                    - description
-                              - wildcard:
-                                  query:
-                                    _string.concat:
-                                      - '*'
-                                      - _state: search.input
-                                      - '*'
-                                  path:
-                                    - title
-                                    - description
-                                  allowAnalyzedField: true
-                          highlight:
-                            path:
-                              - title
-                              - description
-                      - $addFields:
-                          score:
-                            $meta: searchScore
-                          highlights:
-                            $meta: searchHighlights
-          blocks:
-            - id: search.input
-              type: TextInput
-              properties:
-                title: Type to search products
-                prefix: AiOutlinedSearch
-              events:
-                onChange:
-                  - id: get_search # get search_products query for search.input
-                    type: Request
-                    params: search_products
-                  - id: apply_highlight # apply the highlight transformation to the request data.
-                    type: JsAction # TODO:
-                    params:
-                      name: highlightText
-                      args:
-                        - _request: search_products
-                  - id: set_state # set the response of the apply_highlight action to state
-                    type: SetState
-                    params:
-                      found_products:
-                        _actions: apply_highlight.response
-            - id: product_results
-              type: Html
-              properties:
-                html:
-                  _nunjucks:
-                    template: |
-                      <ul>
-                        {% for item in found_products %}
-                          <li>{{ item.title | safe }} - {{ item.description | safe}}</li>
-                        {% endfor %}
-                      </ul>
-                    on:
-                      found_products:
-                        _state: found_products
-      ```
-      NOTE: For this example to work, you will need a `products` collection in your MongoDB database, populated with `{title: '...', description: '...'}` data objects including the following search index on the `products` collection:
-      ```json
-      {
-        "mappings": {
-          "dynamic": true,
-          "fields": {
-            "title": {
-              "type": "string"
-            },
-            "description": {
-              "type": "string"
-            }
-          }
-        }
-      }
-      ```
-
-      ##### Use Lowdefy SetState action:
-
-      ```js
-      // file: /public/theAnswer.js
-      function theAnswer({actions}) {
-        // Think for a while...
-        return actions.SetState({ answer: 42 })
-      }
-      export default theAnswer;
-      ```
-
-      ##### Use Lowdefy Request action to loop over a list of requests:
-      ```js
-      // file: /public/loopRequests.js
-      function loopRequests({ actions }, ...requestIds) {
-        return Promise.all(requestIds.map((id) => actions.Request(id)));
-      }
-      export default loopRequests;
-      ```
-
-      ```yaml
-      id: call_all_requests
-      type: Button
-      events:
-        onClick:
-          - id: loop_requests
-            type: JsAction # TODO:
-            params:
-              name: loopRequests
-              args:
-                - request_1
-                - request_2
-                - request_3
-      ```

package/actions/Link.yaml

@@ -1,120 +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/actions.yaml.njk
-  vars:
-    pageId: Link
-    pageTitle: Link
-    filePath: actions/Link.yaml
-    types: |
-      ```
-      (pageId: string): void
-      (params: {
-        back?: boolean,
-        home?: boolean,
-        input?: object,
-        newTab?:boolean,
-        pageId?: string,
-        url?: string,
-        urlQuery? object
-      }): void
-      ```
-    description: |
-      The `Link` action is used to link a user to another page. An input can be passed to the next page using either the
-      `urlQuery`, which is visible to the user, but persists if the browser is refreshed, or by using the `input` object, which is not
-      visible to the user.
-    params: |
-      ###### string
-      The pageId of a page in the app to link to.
-
-      ###### object
-      - `back: boolean`: Go to the previous page if true (has the same effect as using the browser back button).
-      - `home: boolean`: Link to the home page. This is either the configured public or authenticated homepage, or the first page in the default menu visible to the user.
-      - `input: object`: Object to set as the input for the linked page.
-      - `newTab: boolean`: Open the link in a new tab.
-      - `pageId: string`: The pageId of a page in the app to link to.
-      - `url: string`: Link to an external url.
-      - `urlQuery: object`: Object to set as the urlQuery for the linked page.
-
-    examples: |
-      ###### Shorthand, only specify pageId as string:
-      ```yaml
-      - id: shorthand
-        type: Link
-        params: my_page_id
-      ```
-
-      ###### Specify pageId:
-      ```yaml
-      - id: link_page_id
-        type: Link
-        params:
-          pageId: myPageId
-      ```
-
-      ###### Link to home page:
-      ```yaml
-      - id: link_home
-        type: Link
-        params:
-          home: true
-      ```
-
-      ###### Link to an external url:
-      ```yaml
-      - id: link_url
-        type: Link
-        params:
-          url: www.lowdefy.com
-      ```
-
-      ###### Open a link in a new tab:
-      ```yaml
-      - id: link_new_tab
-        type: Link
-        params:
-          pageId: my_page_id
-          newTab: true
-      ```
-
-      ###### Set the urlQuery of the page that is linked to:
-      ```yaml
-      - id: link_url_query
-        type: Link
-        params:
-          pageId: my_page_id
-          urlQuery:
-            id:
-              _state: id
-      ```
-
-      ###### Set the input of the page that is linked to:
-      ```yaml
-      - id: link_input
-        type: Link
-        params:
-          pageId: my_page_id
-          input:
-            id:
-              _args: row.id
-      ```
-
-      ###### Go to the previous page:
-      ```yaml
-      - id: link_back
-        type: Link
-        params:
-          back: true
-      ```

package/actions/Login.yaml

@@ -1,123 +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/actions.yaml.njk
-  vars:
-    pageId: Login
-    pageTitle: Login
-    filePath: actions/Login.yaml
-    types: |
-      ```
-      (pageId: string): void
-      (params: {
-        authUrlQueryParams?: object
-        pageId?: string,
-        input?: object,
-        urlQuery? object
-      }): void
-      ```
-    description: |
-      The `Login` action requests the OpenID provider's authorization URL from the Lowdefy server. The user is redirected to this URL, which normally hosts a login page. If the user is already logged in at the provider, the provider might redirect the user back without requiring a password again.
-
-      The `Login` action can be used to update the `user` object, for example to update the user profile after it has been edited, or to make sure the user token is still valid before editing or creating a record in a database.
-
-      See [here](/login-and-logout) for information on logging in.
-    params: |
-      ###### object
-      - `authUrlQueryParams: object`: Query parameters to set for the authorization URL.
-      - `pageId: string`: The pageId of the page to redirect to after the login flow is complete
-      - `input: object`: The input to set for the page the user is redirected to after login.
-      - `urlQuery: object`: The urlQuery to set for the page the user is redirected to after login.
-
-    examples: |
-      ###### Login and redirect to home:
-      ```yaml
-      - id: login
-        type: Login
-      ```
-
-      ###### Login, with input, pageId and urlQuery:
-      ```yaml
-      - id: login
-        type: Login
-        params:
-          input:
-            input1: value
-          pageId: page1
-          urlQuery:
-            url1: value
-      ```
-
-      ###### Only login if user is not logged in:
-      ```yaml
-      - id: login
-        type: Login
-        skip:
-          _ne:
-            - _user: sub
-            - null
-      ```
-
-      ###### Request the signup page from the provider:
-      ```yaml
-      - id: Signup
-        type: Button
-        events:
-          onClick:
-            - id: login
-              type: Login
-              params:
-                authUrlQueryParams:
-                  screen_hint: signup
-      ```
-
-      ###### Link to an external url:
-      ```yaml
-      - id: link_url
-        type: Link
-        params:
-          url: www.lowdefy.com
-      ```
-
-      ###### Open a link in a new tab:
-      ```yaml
-      - id: link_new_tab
-        type: Link
-        params:
-          pageId: my_page_id
-          newTab: true
-      ```
-
-      ###### Set the urlQuery of the page that is linked to:
-      ```yaml
-      - id: link_url_query
-        type: Link
-        params:
-          pageId: my_page_id
-          urlQuery:
-            id:
-              _state: id
-      ```
-
-      ###### Set the input of the page that is linked to:
-      ```yaml
-      - id: link_input
-        type: Link
-        params:
-          pageId: my_page_id
-          input:
-            id:
-              _args: row.id
-      ```

package/actions/Logout.yaml

@@ -1,44 +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/actions.yaml.njk
-  vars:
-    pageId: Logout
-    pageTitle: Logout
-    filePath: actions/Logout.yaml
-    types: |
-      ```
-      (void): void
-      ```
-    description: |
-      When the `Logout` action is called, the user data and authorization cookie are cleared by the app. The `Logout` action does not take any parameters. The user is then redirected to the URL configured in `logoutRedirectUri`, or the app homepage if this is not configured.
-
-      Some OpenID Connect providers provide a URL that the user can be directed to to logout the user from the the provider. These urls normally have a query parameter that specifies where the provider should redirect the user after they have logged out the user. These redirect URLs are normally configured with the provider.
-
-      See [here](/login-and-logout) for information on how to configure the logout url.
-    params: |
-      The `Logout` action does not take any parameters.
-    examples: |
-      ###### A logout button:
-      ```yaml
-      - id: logout_button
-        type: Logout
-        properties:
-          title: Logout
-        events:
-          onClick:
-            - id: logout
-              type: Logout
-      ```

package/actions/Message.yaml

@@ -1,68 +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/actions.yaml.njk
-  vars:
-    pageId: MessageAction
-    pageTitle: Message
-    filePath: actions/Message.yaml
-    types: |
-      ```
-      (params: {
-        status?: enum,
-        duration?: number,
-        content?: string,
-      }): void
-      ```
-    description: |
-      The `Message` action is used to display a message to a user.
-    params: |
-      ###### object
-        - `status: enum`: Message status type. Defaults to `success`. One of:
-          - `success`
-          - `error`
-          - `info`
-          - `warning`
-          - `loading`.
-        - `duration: number`: Time in seconds before message disappears. The default is 5.
-        - `content: string`: The content of the message.
-    examples: |
-      ###### Display a success message:
-      ```yaml
-      - id: success_message
-        type: Message
-        params:
-          content: Success
-      ```
-
-      ###### Display an info message that remains visible for 10 seconds:
-      ```yaml
-      - id: info_message
-        type: Message
-        params:
-          content: Something happened
-          status: info
-          duration: 10
-      ```
-
-      ###### Display an error message that never disappears:
-      ```yaml
-      - id: error_message
-        type: Message
-        params:
-          content: Something bad happened
-          status: error
-          duration: 0
-      ```