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

package/templates/blocks/template.yaml.njk

@@ -1,495 +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.
-
-id: {{ block_type }}
-type: PageSiderMenu
-requests:
-  - id: post_telemetry
-    type: AxiosHttp
-    connectionId: lowdefy_api_telemetry
-    properties:
-      data:
-        session_id:
-          _global: session_id
-        page_id: {{ block_type }}
-        url_query:
-          _url_query: true
-        input:
-          _input: true
-
-events:
-  onInit:
-    - id: set_session_id
-      type: SetGlobal
-      skip:
-        _not:
-          _eq:
-            - _global: session_id
-            - null
-      params:
-        session_id:
-          _random:
-            type: string
-            length: 16
-    - id: init_default_properties
-      type: SetState
-      params:
-        block:
-          layout:
-            align: top
-            span: 24
-          visible: true
-          properties:
-            _ref:
-              path:
-                _var: schema
-              transformer: templates/blocks/defaultValueTransformer.js
-    - id: init_property_values
-      type: SetState
-      skip:
-        _eq:
-          - _var: init_property_values
-          - null
-      params:
-        block:
-          properties:
-            _var: init_property_values
-    - id: init_state_values
-      type: SetState
-      skip:
-        _eq:
-          - _var: init_state_values
-          - null
-      params:
-        _var: init_state_values
-
-  onEnterAsync:
-    {# - id: connect_docsearch
-      type: JsAction # TODO:
-      params:
-        name: connectDocsearch #}
-    - id: post_telemetry
-      type: Request
-      messages:
-        error: false
-      params: post_telemetry
-
-properties:
-  title: {{ block_type }}
-  header:
-    theme: light
-  menu:
-    forceSubMenuRender: true
-  sider:
-    width: 256px
-    initialCollapsed:
-      _or:
-        - _eq:
-            - _media: size
-            - md
-        - _eq:
-            - _media: size
-            - lg
-  layout:
-    style:
-      background: '#FFFFFF'
-  footer:
-    style:
-      background: '#FFFFFF'
-  breadcrumb:
-    list:
-      - _ref: version.yaml
-      - {{ category }}
-      - {{ block_type }}
-layout:
-  contentGutter: 16
-areas:
-  header:
-    blocks:
-      _ref: templates/header.yaml
-  footer:
-    blocks:
-      _ref:
-        path: templates/footer.yaml.njk
-        vars:
-          hideFeedback:
-            _var: hideFeedback
-          filePath:
-            _var: filePath
-          pageId:
-            _var: block_type
-  content:
-    blocks:
-      - id: title
-        type: Title
-        properties:
-          level: 2
-          content:
-            _var: block_type
-      {% if value_type %}
-      - id: value_type
-        type: Markdown
-        properties:
-          content: |
-            ```
-            value type: {{ value_type }}
-            ```
-      {% endif %}
-      {% if areas %}
-      - id: areas_list
-        type: Markdown
-        properties:
-          content: |
-            {% if user_defined_areas -%}
-            ```
-            areas: [key]
-            ```
-            {% else %}
-            ```
-            areas: {{ areas | join(', ') }}
-            ```
-            {% endif %}
-      {% endif %}
-      - id: description
-        type: Markdown
-        properties:
-          content:
-            _var: description_content
-      - id: left_column
-        type: Box
-        layout:
-          span: 12
-        blocks:
-          - id: block_divider
-            type: Divider
-            properties:
-              title: Block
-          - id: block_id
-            type:
-              _var: block_type
-            layout:
-              _state: block.layout
-            style:
-              _yaml.parse:
-                _if_none:
-                  - _state: style_block_input
-                  - ''
-            {% if category != "context" %}
-            visible:
-              _state: block.visible
-            {% endif %}
-            required:
-              _state: block.required
-            properties:
-              _js.filterDefaultValue:
-                - _ref:
-                        path:
-                          _var: schema
-                        vars:
-                          block_type: {{ block_type }}
-                        transformer: templates/blocks/propertiesGetterTransformer.js
-                - _ref:
-                    path:
-                      _var: schema
-                    transformer: templates/blocks/defaultValueTransformer.js
-
-            {% if areas %}
-            areas:
-              {% for area in areas %}
-              {{ area }}:
-                gutter: 0
-                style:
-                  border: 1px dashed red
-                blocks:
-                  - id: block_area_{{ area }}
-                    type: Html
-                    style:
-                      background: '#f0f2f5'
-                      textAlign: center
-                      padding: 2px 5px
-                      color: red
-                    properties:
-                      html: {{ area }}
-              {% endfor %}
-            {% endif %}
-          {% if methods %}
-          - id: method_divider
-            type: Divider
-            properties:
-              title: Methods
-          {% for method in methods %}
-          - id: method_button_{{ method.name }}
-            type: Button
-            layout:
-              span: 12
-              md:
-                span: 24
-            properties:
-              title: {{ method.name }}
-            events:
-              onClick:
-                _var: methods.{{ loop.index0 }}.onClick
-          - id: method_args_{{ method.name }}
-            type: MarkdownWithCode
-            layout:
-              span: 12
-              md:
-                span: 24
-            properties:
-              content:
-                _nunjucks:
-                  template: |
-                    {% raw %}
-                    ```yaml
-                    onClick:
-                    {{ value | safe }}
-                    ```
-                    {% endraw %}
-                  on:
-                    value:
-                      _yaml.stringify:
-                        on:
-                          _var: methods.{{ loop.index0 }}.onClick
-                        options:
-                          sortKeys: false
-
-          {% endfor %}
-          {% endif %}
-          {% if category == 'input' %}
-          - id: state_divider
-            type: Divider
-            properties:
-              title: State
-          - id: state_markdown
-            type: MarkdownWithCode
-            properties:
-              content:
-                _nunjucks:
-                  template: |
-                    {% raw %}
-                    ```yaml
-                    {{ value | safe }}
-                    ```
-                    {% endraw %}
-                  on:
-                    value:
-                      _yaml.stringify:
-                        - block_id:
-                            _state: block_id
-          {% endif %}
-          - id: setup_divider
-            type: Divider
-            properties:
-              title: Block Setup
-          - id: setup_markdown
-            type: MarkdownWithCode
-            properties:
-              content:
-                _nunjucks:
-                  template: |
-                    {% raw %}
-                    ```yaml
-                    {{ value | safe }}
-                    ```
-                    {% endraw %}
-                  on:
-                    value:
-                      _yaml.stringify:
-                        options:
-                          sortKeys: false
-                        on:
-                          _js.filterDefaultValue:
-                            - id: block_id
-                              type: {{ block_type }}
-                              required:
-                                _state: block.required
-                              visible:
-                                _state: block.visible
-                              layout:
-                                _state: block.layout
-                              style:
-                                _yaml.parse:
-                                  _if_none:
-                                    - _state: style_block_input
-                                    - ''
-                              properties:
-                                _ref:
-                                  path:
-                                    _var: schema
-                                  vars:
-                                    block_type: {{ block_type }}
-                                  transformer: templates/blocks/propertiesGetterTransformer.js
-                            - required: false
-                              visible: true
-                              layout:
-                                align: top
-                                span: 24
-                              properties:
-                                _ref:
-                                  path:
-                                    _var: schema
-                                  transformer: templates/blocks/defaultValueTransformer.js
-
-      - id: right_column
-        type: Box
-        layout:
-          span: 12
-        blocks:
-          - id: settings_divider
-            type: Divider
-            properties:
-              title: Settings
-          - id: settings_collapse
-            type: Collapse
-            properties:
-              defaultActiveKey: properties
-              panels:
-                - key: properties
-                  title: 'properties:'
-                - key: layout
-                  title: 'layout:'
-                - key: style
-                  title: 'style:'
-                - key: events
-                  title: 'events:'
-                  disabled:
-                    _not:
-                      _get:
-                        key: '0.events'
-                        from:
-                          _mql.aggregate:
-                            on:
-                              - events:
-                                  _get:
-                                    key: schema.events.properties
-                                    default: {}
-                                    from:
-                                      _ref:
-                                        path:
-                                          _var: schema
-                            pipeline:
-                              - $project:
-                                  events:
-                                    $objectToArray: $events
-                - key: required
-                  title: 'required:'
-                  disabled:
-                    _not:
-                      _eq:
-                        - _var: category
-                        - input
-                - key: visible
-                  title: 'visible:'
-                  disabled:
-                    _eq:
-                      - _var: category
-                      - context
-            areas:
-              properties:
-                blocks:
-                  _ref:
-                    path:
-                      _var: schema
-                    transformer: templates/blocks/propertiesFormTransformer.js
-              layout:
-                blocks:
-                  _ref: templates/blocks/layout.yaml
-              style:
-                blocks:
-                  _ref: templates/blocks/style.yaml
-              events:
-                blocks:
-                  - id: event_description
-                    type: Markdown
-                    properties:
-                      style:
-                        '& > .markdown-body':
-                          fontSize: 14
-                      content:
-                        _nunjucks:
-                          template: |
-                            {% raw %}
-                            {% for event in events %}
-                                {{ event.k }}:
-
-                              {{ event.v.description }}
-
-                            {% endfor %}
-                            {% endraw %}
-                          on:
-                            _get:
-                              key: '0'
-                              from:
-                                _mql.aggregate:
-                                  on:
-                                    - events:
-                                        _get:
-                                          key: schema.events.properties
-                                          default: {}
-                                          from:
-                                            _ref:
-                                              path:
-                                                _var: schema
-                                  pipeline:
-                                    - $project:
-                                        events:
-                                          $objectToArray: $events
-
-
-              required:
-                blocks:
-                  - id: block.required
-                    type: Switch
-                    properties:
-                      title: required
-                      label:
-                        extra: Toggle if the field is indicated as compulsory and required when the Validate action is called.
-                        align: right
-                        span: 8
-                      size: small
-              {% if category != "context" %}
-              visible:
-                blocks:
-                  - id: block.visible
-                    type: Switch
-                    properties:
-                      title: visible
-                      label:
-                        extra: Toggle if block is visible and has a value in state.
-                        align: right
-                        span: 8
-                      size: small
-              {% endif %}
-      {% if examples %}
-      - id: examples_divider
-        type: Divider
-        properties:
-          title: Examples
-      - _ref:
-          path: README.md
-          transformer: templates/blocks/exampleTransformer.js
-          vars:
-            block_type: {{ block_type }}
-            examples:
-              _var: examples
-      {% endif %}
-      - _ref:
-          path: templates/blocks/schema.yaml.njk
-          vars:
-            block_type: {{ block_type }}
-            schema_definition:
-              _ref:
-                path:
-                  _var: schema
-                transformer: templates/blocks/schemaTransformer.js

package/templates/blog.yaml.njk

@@ -1,221 +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.
-
-id: "{{ pageId }}"
-type: PageHeaderMenu
-requests:
-  - id: post_telemetry
-    type: AxiosHttp
-    connectionId: lowdefy_api_telemetry
-    properties:
-      data:
-        session_id:
-          _global: session_id
-        page_id:
-          _var: pageId
-        url_query:
-          _url_query: true
-        input:
-          _input: true
-
-events:
-  onInit:
-    - id: set_session_id
-      type: SetGlobal
-      skip:
-        _not:
-          _eq:
-            - _global: session_id
-            - null
-      params:
-        session_id:
-          _random:
-            type: string
-            length: 16
-  onEnterAsync:
-    {# - id: connect_docsearch
-      type: JsAction # TODO:
-      params:
-        name: connectDocsearch #}
-    - id: post_telemetry
-      type: Request
-      messages:
-        error: false
-      params: post_telemetry
-
-properties:
-  title: {{ pageTitle }}
-  header:
-    theme: light
-  menu:
-    forceSubMenuRender: true
-    links: []
-  sider:
-    width: 256px
-    initialCollapsed:
-      _or:
-        - _eq:
-            - _media: size
-            - md
-        - _eq:
-            - _media: size
-            - lg
-  content:
-    style:
-      background: '#FFFFFF'
-  footer:
-    style:
-      background: '#FFFFFF'
-      padding: 16px 0px 0px 0px
-areas:
-  header:
-    blocks:
-      _ref: templates/header.yaml
-  footer:
-    blocks:
-      _ref:
-        path: templates/footer.yaml.njk
-        vars:
-          hideFeedback:
-            _var: hideFeedback
-          filePath:
-            _var: filePath
-          pageId:
-            _var: pageId
-          padding: 40
-
-  content:
-    justify: center
-    blocks:
-      - id: affix_breadcrumb
-        type: Affix
-        style:
-          background: '#FFFFFF'
-        blocks:
-          - id: breadcrumb
-            type: Breadcrumb
-            style:
-              background: '#FFFFFF'
-              margin: 0px -32px 0px -32px
-              padding: 8px 32px 8px 32px
-            properties:
-              list:
-                - label:
-                    _ref: version.yaml
-                  pageId: introduction
-                - label: Lowdefy Docs
-                  pageId: introduction
-            {% if section %}
-                - {{ section }}
-                - {{ pageTitle }}
-            {% endif %}
-      {% if pageImage %}
-      - id: page_image
-        type: Img
-        style:
-          marginLeft: -50
-        properties:
-          src:
-            _var: pageImage
-          alt:
-            _var: pageTitle
-          width: 105%
-      {% endif %}
-      - id: max_width
-        type: Box
-        layout:
-          flex: 0 1 800px
-          contentGutter: 16
-        style:
-          marginTop: 32
-        blocks:
-          {% if pageTitle %}
-          - id: page_title
-            type: Title
-            properties:
-              content:
-                _var: pageTitle
-          {% endif %}
-          - id: content
-            type: Box
-            layout:
-              contentGutter: 16
-            blocks:
-              _var: content
-          {% if discussionsLink %}
-          - id: md5
-            type: MarkdownWithCode
-            properties:
-              content: |
-                -----
-                ###### Comments and questions regarding this how-to are availible on [this GitHub Discussions Thread]({{ discussionsLink }})
-
-          {% endif %}
-          - id: footer_links
-            type: MarkdownWithCode
-            properties:
-              content: |
-                -----
-          - id: links_box
-            type: Box
-            layout:
-              span: 12
-              contentGutter: 16
-            blocks:
-              - id: md_author
-                type: MarkdownWithCode
-                properties:
-                  content: |
-                    ###### Other interesting how-to guides:
-              {% for item in articleLinks %}
-              - id: links-{{ item.pageId }}
-                type: Anchor
-                properties:
-                  icon: AiOutlinedLink
-                  pageId: {{ item.pageId }}
-                  title: {{ item.title }}
-              {% endfor %}
-
-          {% if authorName %}
-          - id: author_box
-            type: Box
-            layout:
-              span: 12
-              contentGutter: 16
-            blocks:
-              - id: md_author
-                type: MarkdownWithCode
-                properties:
-                  content: |
-                    ###### This how-to article was written by:
-              {% if authorProfile %}
-              - id: author
-                type: Avatar
-                layout:
-                  flex: 0 1 auto
-                properties:
-                  src:
-                    _var: authorProfile
-                  size: large
-              {% endif %}
-              - id: author_name
-                type: Html
-                style:
-                  marginTop: -3
-                layout:
-                  flex: 1 0 auto
-                properties:
-                  html:
-                    _var: authorName
-          {% endif %}