@lowdefy/build 4.0.0-alpha.1 → 4.0.0-alpha.12

package/dist/index.js

@@ -1,5 +1,5 @@
 /* eslint-disable no-console */ /*
-  Copyright 2020-2021 Lowdefy, Inc
+  Copyright 2020-2022 Lowdefy, Inc
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
@@ -12,24 +12,30 @@
   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.
-*/ import { readFile } from '@lowdefy/node-utils';
+*/ import { fileURLToPath } from 'url';
+import { mergeObjects } from '@lowdefy/helpers';
+import { readFile } from '@lowdefy/node-utils';
 import createCounter from './utils/createCounter.js';
-import createReadConfigFile from './utils/files/readConfigFile.js';
-import createWriteBuildArtifact from './utils/files/writeBuildArtifact.js';
+import createPluginTypesMap from './utils/createPluginTypesMap.js';
+import createReadConfigFile from './utils/readConfigFile.js';
+import createWriteBuildArtifact from './utils/writeBuildArtifact.js';
 import addDefaultPages from './build/addDefaultPages/addDefaultPages.js';
 import buildAuth from './build/buildAuth/buildAuth.js';
 import buildConnections from './build/buildConnections.js';
+import buildImports from './build/buildImports/buildImports.js';
 import buildMenu from './build/buildMenu.js';
 import buildPages from './build/buildPages/buildPages.js';
 import buildRefs from './build/buildRefs/buildRefs.js';
 import buildTypes from './build/buildTypes.js';
 import cleanBuildDirectory from './build/cleanBuildDirectory.js';
+import copyPublicFolder from './build/copyPublicFolder.js';
 import testSchema from './build/testSchema.js';
 import validateApp from './build/validateApp.js';
 import validateConfig from './build/validateConfig.js';
+import updateServerPackageJson from './build/updateServerPackageJson.js';
 import writeApp from './build/writeApp.js';
-import writeBlockImports from './build/writePluginImports/writeBlockImports.js';
-import writeConnectionImports from './build/writePluginImports/writeConnectionImports.js';
+import writeAuth from './build/writeAuth.js';
+import writePluginImports from './build/writePluginImports/writePluginImports.js';
 import writeConfig from './build/writeConfig.js';
 import writeConnections from './build/writeConnections.js';
 import writeGlobal from './build/writeGlobal.js';
@@ -37,17 +43,23 @@ import writeMenus from './build/writeMenus.js';
 import writePages from './build/writePages.js';
 import writeRequests from './build/writeRequests.js';
 import writeTypes from './build/writeTypes.js';
-async function createContext(options) {
-    const { blocksServerUrl , buildDirectory , cacheDirectory , configDirectory , logger , refResolver  } = options;
-    const defaultTypes = JSON.parse(await readFile(new URL('./defaultTypes.json', import.meta.url).pathname));
-    // TODO: resolve custom plugin types
+async function createContext({ customTypesMap , directories , logger , refResolver , stage ='prod'  }) {
+    const defaultTypesMap = JSON.parse(await readFile(fileURLToPath(new URL('./defaultTypesMap.json', import.meta.url))));
     const context = {
-        blocksServerUrl,
-        buildDirectory,
-        cacheDirectory,
-        configDirectory,
+        directories,
+        logger,
+        readConfigFile: createReadConfigFile({
+            directories
+        }),
+        refResolver,
+        stage,
         typeCounters: {
             actions: createCounter(),
+            auth: {
+                callbacks: createCounter(),
+                events: createCounter(),
+                providers: createCounter()
+            },
             blocks: createCounter(),
             connections: createCounter(),
             requests: createCounter(),
@@ -56,110 +68,112 @@ async function createContext(options) {
                 server: createCounter()
             }
         },
-        logger,
-        readConfigFile: createReadConfigFile({
-            configDirectory
-        }),
-        refResolver,
-        types: defaultTypes,
+        typesMap: mergeObjects([
+            defaultTypesMap,
+            customTypesMap
+        ]),
         writeBuildArtifact: createWriteBuildArtifact({
-            buildDirectory
+            directories
         })
     };
     return context;
 }
 async function build(options) {
     const context = await createContext(options);
-    try {
-        const components = await buildRefs({
-            context
-        });
-        await testSchema({
-            components,
-            context
-        });
-        await validateApp({
-            components,
-            context
-        });
-        await validateConfig({
-            components,
-            context
-        });
-        await addDefaultPages({
-            components,
-            context
-        });
-        await buildAuth({
-            components,
-            context
-        });
-        await buildConnections({
-            components,
-            context
-        });
-        await buildPages({
-            components,
-            context
-        });
-        await buildMenu({
-            components,
-            context
-        });
-        await buildTypes({
-            components,
-            context
-        });
-        await cleanBuildDirectory({
-            context
-        });
-        await writeApp({
-            components,
-            context
-        });
-        await writeConnections({
-            components,
-            context
-        });
-        await writeRequests({
-            components,
-            context
-        });
-        await writePages({
-            components,
-            context
-        });
-        await writeConfig({
-            components,
-            context
-        });
-        await writeGlobal({
-            components,
-            context
-        });
-        await writeMenus({
-            components,
-            context
-        });
-        await writeTypes({
-            components,
-            context
-        });
-        await writeBlockImports({
-            components,
-            context
-        });
-        await writeConnectionImports({
-            components,
-            context
-        });
-    // TODO: write style file
-    // TODO: write icons file
-    // TODO: add plugins to package.json
-    } catch (error) {
-        context.logger.error(error);
-        throw error;
-    }
+    const components = await buildRefs({
+        context
+    });
+    await testSchema({
+        components,
+        context
+    });
+    await validateApp({
+        components,
+        context
+    });
+    await validateConfig({
+        components,
+        context
+    });
+    await addDefaultPages({
+        components,
+        context
+    });
+    await buildAuth({
+        components,
+        context
+    });
+    await buildConnections({
+        components,
+        context
+    });
+    await buildPages({
+        components,
+        context
+    });
+    await buildMenu({
+        components,
+        context
+    });
+    await buildTypes({
+        components,
+        context
+    });
+    await buildImports({
+        components,
+        context
+    });
+    await cleanBuildDirectory({
+        context
+    });
+    await writeApp({
+        components,
+        context
+    });
+    await writeAuth({
+        components,
+        context
+    });
+    await writeConnections({
+        components,
+        context
+    });
+    await writeRequests({
+        components,
+        context
+    });
+    await writePages({
+        components,
+        context
+    });
+    await writeConfig({
+        components,
+        context
+    });
+    await writeGlobal({
+        components,
+        context
+    });
+    await writeMenus({
+        components,
+        context
+    });
+    await writeTypes({
+        components,
+        context
+    });
+    await writePluginImports({
+        components,
+        context
+    });
+    await updateServerPackageJson({
+        components,
+        context
+    });
+    await copyPublicFolder({
+        components,
+        context
+    });
 }
-export { createContext };
+export { createContext, createPluginTypesMap };
 export default build;

package/dist/lowdefySchema.js

@@ -24,12 +24,9 @@ export default {
                         type: 'Action "id" should be a string.'
                     }
                 },
-                messages: {
-                },
-                params: {
-                },
-                skip: {
-                },
+                messages: {},
+                params: {},
+                skip: {},
                 type: {
                     type: 'string',
                     errorMessage: {
@@ -75,36 +72,73 @@ export default {
             type: 'object',
             additionalProperties: false,
             errorMessage: {
-                type: 'App "config.auth" should be an object.'
+                type: 'App "auth" should be an object.'
             },
             properties: {
-                openId: {
-                    type: 'object',
-                    additionalProperties: false,
-                    errorMessage: {
-                        type: 'App "config.auth.openId" should be an object.'
-                    },
-                    properties: {
-                        rolesField: {
-                            type: 'string',
-                            description: '.',
-                            errorMessage: {
-                                type: 'App "config.auth.openId.rolesField" should be a string.'
+                callbacks: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: [
+                            'id',
+                            'type'
+                        ],
+                        properties: {
+                            id: {
+                                type: 'string',
+                                errorMessage: {
+                                    type: 'Auth callback "id" should be a string.'
+                                }
+                            },
+                            type: {
+                                type: 'string',
+                                errorMessage: {
+                                    type: 'Auth callback "type" should be a string.'
+                                }
+                            },
+                            properties: {
+                                type: 'object'
                             }
                         },
-                        logoutRedirectUri: {
-                            type: 'string',
-                            description: 'The URI to redirect the user to after logout. Can be a Nunjucks template string with client_id, host, id_token_hint, and openid_domain as template data.',
-                            errorMessage: {
-                                type: 'App "config.auth.openId.logoutRedirectUri" should be a string.'
+                        errorMessage: {
+                            type: 'Auth callback should be an object.',
+                            required: {
+                                id: 'Auth callback should have required property "id".',
+                                type: 'Auth callback should have required property "type".'
+                            }
+                        }
+                    }
+                },
+                events: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: [
+                            'id',
+                            'type'
+                        ],
+                        properties: {
+                            id: {
+                                type: 'string',
+                                errorMessage: {
+                                    type: 'Auth event "id" should be a string.'
+                                }
+                            },
+                            type: {
+                                type: 'string',
+                                errorMessage: {
+                                    type: 'Auth event "type" should be a string.'
+                                }
+                            },
+                            properties: {
+                                type: 'object'
                             }
                         },
-                        scope: {
-                            type: 'string',
-                            description: 'The OpenID Connect scope to request.',
-                            default: 'openid profile email',
-                            errorMessage: {
-                                type: 'App "config.auth.openId.scope" should be a string.'
+                        errorMessage: {
+                            type: 'Auth event should be an object.',
+                            required: {
+                                id: 'Auth event should have required property "id".',
+                                type: 'Auth event should have required property "type".'
                             }
                         }
                     }
@@ -122,13 +156,13 @@ export default {
                                 'boolean'
                             ],
                             errorMessage: {
-                                type: 'App "config.auth.pages.protected.$" should be an array of strings.'
+                                type: 'App "auth.pages.protected.$" should be an array of strings.'
                             },
                             items: {
                                 type: 'string',
                                 description: 'Page ids for which authentication is required. When specified, all unspecified pages will be public.',
                                 errorMessage: {
-                                    type: 'App "config.auth.pages.protected.$" should be an array of strings.'
+                                    type: 'App "auth.pages.protected.$" should be an array of strings.'
                                 }
                             }
                         },
@@ -138,13 +172,13 @@ export default {
                                 'boolean'
                             ],
                             errorMessage: {
-                                type: 'App "config.auth.pages.public.$" should be an array of strings.'
+                                type: 'App "auth.pages.public.$" should be an array of strings.'
                             },
                             items: {
                                 type: 'string',
                                 description: 'Page ids for which authentication is not required. When specified, all unspecified pages will be protected.',
                                 errorMessage: {
-                                    type: 'App "config.auth.pages.public.$" should be an array of strings.'
+                                    type: 'App "auth.pages.public.$" should be an array of strings.'
                                 }
                             }
                         },
@@ -157,46 +191,55 @@ export default {
                                         type: 'string'
                                     },
                                     errorMessage: {
-                                        type: 'App "config.auth.pages.roles.[role]" should be an array of strings.'
+                                        type: 'App "auth.pages.roles.[role]" should be an array of strings.'
                                     }
                                 }
                             },
                             errorMessage: {
-                                type: 'App "config.auth.pages.roles" should be an object.'
+                                type: 'App "auth.pages.roles" should be an object.'
                             }
                         }
                     }
                 },
-                jwt: {
-                    type: 'object',
-                    additionalProperties: false,
-                    errorMessage: {
-                        type: 'App "config.auth.jwt" should be an object.'
-                    },
-                    properties: {
-                        expiresIn: {
-                            type: [
-                                'string',
-                                'number'
-                            ],
-                            default: '4h',
-                            description: 'The length of time a user token should be valid. Can be expressed as a number in seconds, or a vercel/ms string (https://github.com/vercel/ms)',
-                            errorMessage: {
-                                type: 'App "config.auth.jwt.expiresIn" should be a string or number.'
+                providers: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        required: [
+                            'id',
+                            'type'
+                        ],
+                        properties: {
+                            id: {
+                                type: 'string',
+                                errorMessage: {
+                                    type: 'Auth provider "id" should be a string.'
+                                }
+                            },
+                            type: {
+                                type: 'string',
+                                errorMessage: {
+                                    type: 'Auth provider "type" should be a string.'
+                                }
+                            },
+                            properties: {
+                                type: 'object'
                             }
                         },
-                        loginStateExpiresIn: {
-                            type: [
-                                'string',
-                                'number'
-                            ],
-                            default: '5min',
-                            description: 'The length of time an authorization request token should be valid. Can be expressed as a number in seconds, or a vercel/ms string (https://github.com/vercel/ms)',
-                            errorMessage: {
-                                type: 'App "config.auth.jwt.loginStateExpiresIn" should be a string or number.'
+                        errorMessage: {
+                            type: 'Auth provider should be an object.',
+                            required: {
+                                id: 'Auth provider should have required property "id".',
+                                type: 'Auth provider should have required property "type".'
                             }
                         }
                     }
+                },
+                session: {
+                    type: 'object'
+                },
+                theme: {
+                    type: 'object'
                 }
             }
         },
@@ -235,10 +278,10 @@ export default {
                         type: 'Block "layout" should be an object.'
                     }
                 },
-                loading: {
+                skeleton: {
                     type: 'object',
                     errorMessage: {
-                        type: 'Block "loading" should be an object.'
+                        type: 'Block "skeleton" should be an object.'
                     }
                 },
                 style: {
@@ -247,8 +290,8 @@ export default {
                         type: 'Block "style" should be an object.'
                     }
                 },
-                visible: {
-                },
+                visible: {},
+                loading: {},
                 blocks: {
                     type: 'array',
                     items: {
@@ -267,8 +310,7 @@ export default {
                         type: 'Block "requests" should be an array.'
                     }
                 },
-                required: {
-                },
+                required: {},
                 validate: {
                     type: 'array',
                     items: {
@@ -541,6 +583,41 @@ export default {
                 }
             }
         },
+        plugin: {
+            type: 'object',
+            additionalProperties: false,
+            required: [
+                'name',
+                'version'
+            ],
+            properties: {
+                name: {
+                    type: 'string',
+                    errorMessage: {
+                        type: 'Plugin "name" should be a string.'
+                    }
+                },
+                version: {
+                    type: 'string',
+                    errorMessage: {
+                        type: 'Plugin "version" should be a string.'
+                    }
+                },
+                typePrefix: {
+                    type: 'string',
+                    errorMessage: {
+                        type: 'Plugin "typePrefix" should be a string.'
+                    }
+                }
+            },
+            errorMessage: {
+                type: 'Plugin should be an object.',
+                required: {
+                    name: 'Plugin should have required property "name".',
+                    version: 'Plugin should have required property "version".'
+                }
+            }
+        },
         request: {
             type: 'object',
             additionalProperties: false,
@@ -617,6 +694,9 @@ export default {
         app: {
             $ref: '#/definitions/app'
         },
+        auth: {
+            $ref: '#/definitions/authConfig'
+        },
         cli: {
             type: 'object',
             errorMessage: {
@@ -630,6 +710,13 @@ export default {
             },
             additionalProperties: false,
             properties: {
+                basePath: {
+                    type: 'string',
+                    description: 'App base path to apply to all routes. Base path must start with "/".',
+                    errorMessage: {
+                        type: 'App "config.basePath" should be a string.'
+                    }
+                },
                 homePageId: {
                     type: 'string',
                     description: 'Page id to use as homepage. When visiting home route "/", the router will redirect to this page. If not provided, the first page in default or first menu will be used as the homePageId.',
@@ -637,23 +724,30 @@ export default {
                         type: 'App "config.homePageId" should be a string.'
                     }
                 },
-                auth: {
-                    $ref: '#/definitions/authConfig'
-                }
-            }
-        },
-        types: {
-            type: 'object',
-            patternProperties: {
-                '^.*$': {
-                    url: 'string',
+                theme: {
+                    type: 'object',
                     errorMessage: {
-                        enum: 'Type "url" should be a string.'
+                        type: 'App "config.theme" should be an object.'
+                    },
+                    properties: {
+                        lessVariables: {
+                            type: 'object',
+                            description: 'App theme less variables.',
+                            errorMessage: {
+                                type: 'App "config.theme.lessVariables" should be an object.'
+                            }
+                        }
                     }
                 }
+            }
+        },
+        plugins: {
+            type: 'array',
+            items: {
+                $ref: '#/definitions/plugin'
             },
             errorMessage: {
-                type: 'App "types" should be an object.'
+                type: 'App "plugins" should be an array.'
             }
         },
         global: {