@lowdefy/docs 3.22.0 → 3.23.2

package/lowdefy.yaml

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 name: '@lowdefy/docs'
-lowdefy: 3.22.0
+lowdefy: 3.23.2
 licence: Apache-2.0
 
 cli:

package/menus.yaml

@@ -47,6 +47,22 @@
           pageId: next-steps
           properties:
             title: Next steps
+    - id: howto
+      type: MenuGroup
+      properties:
+        title: How To
+        icon: QuestionOutlined
+      links:
+        - id: generate-csv
+          type: MenuLink
+          pageId: generate-csv-files-from-data
+          properties:
+            title: Generate CSVs
+        - id: generate-pdf
+          type: MenuLink
+          pageId: generate-pdf-document-from-data
+          properties:
+            title: Generate PDFs
     - id: concepts
       type: MenuGroup
       properties:
@@ -733,6 +749,9 @@
         - id: _sum
           type: MenuLink
           pageId: _sum
+        - id: _switch
+          type: MenuLink
+          pageId: _switch
         - id: _type
           type: MenuLink
           pageId: _type
@@ -760,9 +779,14 @@
         title: Lowdefy Versions
         icon: BranchesOutlined
       links:
-        - id: v3.22.0
+        - id: v3.23.2
           type: MenuLink
           url: https://docs.lowdefy.com
+          properties:
+            title: v3.23.2
+        - id: v3.22.0
+          type: MenuLink
+          url: https://61519bcb8b8ed4412aae3057--lowdefy-docs.netlify.app
           properties:
             title: v3.22.0
         - id: v3.21.2

package/operators/_actions.yaml

@@ -77,7 +77,7 @@ _ref:
       First register a custom JavaScript action: `getNormalizedEigenvector`
       ```yaml
       # file: lowdefy.yaml
-      lowdefy: '3.22.0'
+      lowdefy: '3.23.2'
       app:
         html:
           appendHead: |

package/operators/_change_case.yaml

@@ -72,8 +72,8 @@ _ref:
       _change_case.capitalCase:
         on:
           foo: 'bar'
-          options:
-            convertKeys: true
+        options:
+          convertKeys: true
       ```
       Returns: `{ "Foo": "Bar" }`
 
@@ -82,8 +82,8 @@ _ref:
       _change_case.capitalCase:
         on:
           foo: 'bar'
-          options:
-            convertValues: false
+        options:
+          convertValues: false
       ```
       Returns: `{ "foo": "bar" }`
 

package/operators/_js.yaml

@@ -51,7 +51,7 @@ _ref:
           ```yaml
           # lowdefy.yaml
           name: make-me-primes
-          lowdefy: '3.22.0'
+          lowdefy: '3.23.2'
           app:
             html:
               # This HTML will be appended to the head HTML tag in the Lowdefy app
@@ -119,7 +119,7 @@ _ref:
           ```yaml
           # file: lowdefy.yaml
           name: my-chart
-          lowdefy: '3.22.0'
+          lowdefy: '3.23.2'
           app:
             html:
               appendHead:

package/operators/_ref.yaml

@@ -73,7 +73,7 @@ _ref:
       ###### Reference pages:
       ```yaml
       # lowdefy.yaml
-      lowdefy: '3.22.0'
+      lowdefy: '3.23.2'
       pages:
         - _ref: pages/page1.yaml
         - _ref: pages/page2.yaml
@@ -94,7 +94,7 @@ _ref:
       ```
       Returns:
       ```
-      lowdefy: '3.22.0'
+      lowdefy: '3.23.2'
       pages:
         - id: page1
           type: PageHeaderMenu
@@ -176,12 +176,20 @@ _ref:
 
       const readFilePromise = promisify(fs.readFile);
 
-      async function useLocalOrSharedConfig(path, vars, context) {
-        const localFile =  await readFilePromise(path.resolve(path), 'utf8');
+      async function useLocalOrSharedConfig(refPath, vars, context) {
+        let fileContent
+        try {
+          fileContent =  await readFilePromise(path.resolve(refPath), 'utf8');
+          return fileContent;
+        } catch (error) {
+          if (error.code === 'ENOENT') {
+            fileContent = readFilePromise(path.resolve('../shared', refPath), 'utf8');
+            return fileContent;
+          }
+          throw error;
+        }
 
-        if (localFile) return localFile;
 
-        return readFilePromise(path.resolve('../shared', path), 'utf8');
       }
 
       module.exports = useLocalOrSharedConfig;
@@ -189,7 +197,7 @@ _ref:
 
       ```yaml
       // lowdefy.yaml
-      lowdefy: 3.22.0
+      lowdefy: 3.23.2
 
       cli:
         refResolver: resolvers/useLocalOrSharedConfig.js
@@ -215,7 +223,7 @@ _ref:
       ```
       ```yaml
       // lowdefy.yaml
-      lowdefy: 3.22.0
+      lowdefy: 3.23.2
 
       pages:
         - _ref:

package/operators/_switch.yaml

@@ -0,0 +1,51 @@
+# 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/operators.yaml.njk
+  transformer: templates/operatorsMethodTransformer.js
+  vars:
+    pageId: _switch
+    pageTitle: _switch
+    filePath: operators/_switch.yaml
+    types: |
+      ```
+      (arguments: {branches: {if: boolean, then: any}[], default: any}): any
+      ```
+    description: |
+      The `_switch` operator evaluates an array of conditions and returns the `then` argument of the first item for which the `if` argument evaluates to `true`. If no condition evaluates to `true`, the value of the `default` argument is returned.
+    arguments: |
+      ###### object
+        - `branches:`
+            `if: boolean`: The boolean result of a test.
+            `then: any`: The value to return if the test is `true`.
+        - `default: any`: The value to return if all the `if` tests are `false`.
+    examples: |
+      ###### Return a value based on a series of conditions:
+      ```yaml
+      _switch:
+        branches:
+          - if:
+              _eq:
+                - x
+                - y
+            then: A
+          - if:
+              _eq:
+                - x
+                - z
+            then: B
+        default: C
+      ```
+      Returns: `"C"` since both of the `if` tests are `false`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowdefy/docs",
-  "version": "3.22.0",
+  "version": "3.23.2",
   "license": "Apache-2.0",
   "description": "",
   "homepage": "https://lowdefy.com",
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "af37daa86e1ba73397eb65f65cacbcbb5461ec79"
+  "gitHead": "4c30d3cdfa99ae4e90fc891825938c28bad45760"
 }

package/pages.yaml

@@ -11,6 +11,17 @@
 - _ref: tutorial/tutorial-deploy.yaml
 - _ref: tutorial/next-steps.yaml
 
+- _ref:
+    path: howto/generate-csv.yaml.njk
+    vars:
+      version:
+        _ref: version.yaml
+- _ref:
+    path: howto/generate-pdf.yaml.njk
+    vars:
+      version:
+        _ref: version.yaml
+
 - _ref: concepts/overview.yaml
 - _ref: concepts/cli.yaml
 - _ref: concepts/lowdefy-schema.yaml
@@ -205,6 +216,7 @@
 - _ref: operators/_string.yaml
 - _ref: operators/_subtract.yaml
 - _ref: operators/_sum.yaml
+- _ref: operators/_switch.yaml
 - _ref: operators/_type.yaml
 - _ref: operators/_uri.yaml
 - _ref: operators/_url_query.yaml

package/public/modules/csvMake.js

@@ -0,0 +1,27 @@
+const csvMakeFn = async (context, filename, data, fields) => {
+  if (!Array.isArray(data) || typeof data[0] !== 'object') {
+    throw new Error('csvMake data takes an array of objects');
+  }
+  if (!fields) {
+    fields = Object.keys(data[0]);
+  }
+  const arrays = [fields];
+  data.forEach((obj) => arrays.push(fields.map((field) => obj[field])));
+  const csv = arrays
+    .map((row) =>
+      row
+        .map((cell) => (typeof cell === 'undefined' || cell === null ? '' : cell))
+        .map(String)
+        .map((v) => v.replaceAll('"', '""'))
+        .map((v) => `"${v}"`)
+        .join(',')
+    )
+    .join('\r\n');
+  const blob = new Blob([csv], { type: 'text/csv;charset=utf-8;' });
+  const url = URL.createObjectURL(blob);
+  const el = document.createElement('a');
+  el.href = url;
+  el.setAttribute('download', filename);
+  el.click();
+};
+window.lowdefy.registerJsAction('csvMake', csvMakeFn);

package/public/modules/importUmd.js

@@ -0,0 +1,7 @@
+export default async (url, module = { exports: {} }) =>
+  (Function('module', 'exports', await (await fetch(url)).text()).call(
+    module,
+    module,
+    module.exports
+  ),
+  module).exports;

package/public/modules/pdfMake.js

@@ -0,0 +1,7 @@
+import importUmd from './importUmd.js';
+import vfs from './vfs_fonts.js';
+const pdfMake = await importUmd(`https://unpkg.com/pdfmake@0.1.71/build/pdfmake.min.js`);
+const pdfMakeFn = async (context, filename, docDefinition, tableLayouts, fonts) => {
+  await pdfMake.createPdf(docDefinition, tableLayouts, fonts, vfs).download(filename);
+};
+window.lowdefy.registerJsAction('pdfMake', pdfMakeFn);