@lowdefy/api 0.0.0-experimental-20231123101256

package/dist/routes/request/callRequest.js

@@ -0,0 +1,92 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { serializer } from '@lowdefy/helpers';
+import authorizeRequest from './authorizeRequest.js';
+import callRequestResolver from './callRequestResolver.js';
+import checkConnectionRead from './checkConnectionRead.js';
+import checkConnectionWrite from './checkConnectionWrite.js';
+import evaluateOperators from './evaluateOperators.js';
+import getConnection from './getConnection.js';
+import getConnectionConfig from './getConnectionConfig.js';
+import getRequestConfig from './getRequestConfig.js';
+import getRequestResolver from './getRequestResolver.js';
+import validateSchemas from './validateSchemas.js';
+async function callRequest(context, { blockId, pageId, payload, requestId }) {
+    const { logger } = context;
+    logger.debug({
+        event: 'debug_request',
+        blockId,
+        pageId,
+        payload,
+        requestId
+    });
+    const requestConfig = await getRequestConfig(context, {
+        pageId,
+        requestId
+    });
+    const connectionConfig = await getConnectionConfig(context, {
+        requestConfig
+    });
+    authorizeRequest(context, {
+        requestConfig
+    });
+    const connection = getConnection(context, {
+        connectionConfig
+    });
+    const requestResolver = getRequestResolver(context, {
+        connection,
+        requestConfig
+    });
+    const deserializedPayload = serializer.deserialize(payload);
+    const { connectionProperties, requestProperties } = evaluateOperators(context, {
+        connectionConfig,
+        payload: deserializedPayload,
+        requestConfig
+    });
+    checkConnectionRead(context, {
+        connectionConfig,
+        connectionProperties,
+        requestConfig,
+        requestResolver
+    });
+    checkConnectionWrite(context, {
+        connectionConfig,
+        connectionProperties,
+        requestConfig,
+        requestResolver
+    });
+    validateSchemas(context, {
+        connection,
+        connectionProperties,
+        requestConfig,
+        requestResolver,
+        requestProperties
+    });
+    const response = await callRequestResolver(context, {
+        blockId,
+        connectionProperties,
+        payload: deserializedPayload,
+        requestConfig,
+        requestProperties,
+        requestResolver
+    });
+    return {
+        id: requestConfig.id,
+        success: true,
+        type: requestConfig.type,
+        response: serializer.serialize(response)
+    };
+}
+export default callRequest;

package/dist/routes/request/callRequestResolver.js

@@ -0,0 +1,40 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { RequestError } from '../../context/errors.js';
+async function callRequestResolver({ logger }, { blockId, connectionProperties, payload, requestConfig, requestProperties, requestResolver }) {
+    try {
+        const response = await requestResolver({
+            blockId,
+            connection: connectionProperties,
+            connectionId: requestConfig.connectionId,
+            pageId: requestConfig.pageId,
+            payload,
+            request: requestProperties,
+            requestId: requestConfig.requestId
+        });
+        return response;
+    } catch (error) {
+        const err = new RequestError(error.message);
+        logger.debug({
+            params: {
+                id: requestConfig.requestId,
+                type: requestConfig.type
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+}
+export default callRequestResolver;

package/dist/routes/request/checkConnectionRead.js

@@ -0,0 +1,29 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { ConfigurationError } from '../../context/errors.js';
+function checkConnectionRead({ logger }, { connectionConfig, connectionProperties, requestConfig, requestResolver }) {
+    if (requestResolver.meta.checkRead && connectionProperties.read === false) {
+        const err = new ConfigurationError(`Connection "${connectionConfig.connectionId}" does not allow reads.`);
+        logger.debug({
+            params: {
+                connectionId: connectionConfig.connectionId,
+                requestId: requestConfig.requestId
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+}
+export default checkConnectionRead;

package/dist/routes/request/checkConnectionWrite.js

@@ -0,0 +1,29 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { ConfigurationError } from '../../context/errors.js';
+function checkConnectionWrite({ logger }, { connectionConfig, connectionProperties, requestConfig, requestResolver }) {
+    if (requestResolver.meta.checkWrite && connectionProperties.write !== true) {
+        const err = new ConfigurationError(`Connection "${connectionConfig.connectionId}" does not allow writes.`);
+        logger.debug({
+            params: {
+                connectionId: connectionConfig.connectionId,
+                requestId: requestConfig.requestId
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+}
+export default checkConnectionWrite;

package/dist/routes/request/evaluateOperators.js

@@ -0,0 +1,43 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { ServerParser } from '@lowdefy/operators';
+import { RequestError } from '../../context/errors.js';
+function evaluateOperators({ operators, secrets, session }, { connectionConfig, payload, requestConfig }) {
+    const operatorsParser = new ServerParser({
+        operators,
+        payload,
+        secrets,
+        user: session?.user
+    });
+    const { output: connectionProperties, errors: connectionErrors } = operatorsParser.parse({
+        input: connectionConfig.properties || {},
+        location: connectionConfig.connectionId
+    });
+    if (connectionErrors.length > 0) {
+        throw new RequestError(connectionErrors[0]);
+    }
+    const { output: requestProperties, errors: requestErrors } = operatorsParser.parse({
+        input: requestConfig.properties || {},
+        location: requestConfig.requestId
+    });
+    if (requestErrors.length > 0) {
+        throw new RequestError(requestErrors[0]);
+    }
+    return {
+        connectionProperties,
+        requestProperties
+    };
+}
+export default evaluateOperators;

package/dist/routes/request/getConnection.js

@@ -0,0 +1,31 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { ConfigurationError } from '../../context/errors.js';
+function getConnection({ connections, logger }, { connectionConfig }) {
+    const connection = connections[connectionConfig.type];
+    if (!connection) {
+        const err = new ConfigurationError(`Connection type "${connectionConfig.type}" can not be found.`);
+        logger.debug({
+            params: {
+                id: connectionConfig.connectionId,
+                type: connectionConfig.type
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+    return connection;
+}
+export default getConnection;

package/dist/routes/request/getConnectionConfig.js

@@ -0,0 +1,42 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { ConfigurationError } from '../../context/errors.js';
+async function getConnectionConfig({ logger, readConfigFile }, { requestConfig }) {
+    const { connectionId, requestId } = requestConfig;
+    let err;
+    if (!connectionId) {
+        err = new ConfigurationError(`Request "${requestId}" does not specify a connection.`);
+        logger.debug({
+            params: {
+                requestId
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+    const connection = await readConfigFile(`connections/${connectionId}.json`);
+    if (!connection) {
+        err = new ConfigurationError(`Connection "${connectionId}" does not exist.`);
+        logger.debug({
+            params: {
+                requestId
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+    return connection;
+}
+export default getConnectionConfig;

package/dist/routes/request/getRequestConfig.js

@@ -0,0 +1,31 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { ConfigurationError } from '../../context/errors.js';
+async function getRequestConfig({ logger, readConfigFile }, { pageId, requestId }) {
+    const request = await readConfigFile(`pages/${pageId}/requests/${requestId}.json`);
+    if (!request) {
+        const err = new ConfigurationError(`Request "${requestId}" does not exist.`);
+        logger.debug({
+            params: {
+                pageId,
+                requestId
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+    return request;
+}
+export default getRequestConfig;

package/dist/routes/request/getRequestResolver.js

@@ -0,0 +1,31 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { ConfigurationError } from '../../context/errors.js';
+function getRequestResolver({ logger }, { connection, requestConfig }) {
+    const requestResolver = connection.requests[requestConfig.type];
+    if (!requestResolver) {
+        const err = new ConfigurationError(`Request type "${requestConfig.type}" can not be found.`);
+        logger.debug({
+            params: {
+                id: requestConfig.requestId,
+                type: requestConfig.type
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+    return requestResolver;
+}
+export default getRequestResolver;

package/dist/routes/request/validateSchemas.js

@@ -0,0 +1,39 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { validate } from '@lowdefy/ajv';
+import { ConfigurationError } from '../../context/errors.js';
+function validateSchemas({ logger }, { connection, connectionProperties, requestConfig, requestResolver, requestProperties }) {
+    try {
+        validate({
+            schema: connection.schema,
+            data: connectionProperties
+        });
+        validate({
+            schema: requestResolver.schema,
+            data: requestProperties
+        });
+    } catch (error) {
+        const err = new ConfigurationError(error.message);
+        logger.debug({
+            params: {
+                id: requestConfig.requestId,
+                type: requestConfig.type
+            },
+            err
+        }, err.message);
+        throw err;
+    }
+}
+export default validateSchemas;

package/dist/routes/rootConfig/getHomeAndMenus.js

@@ -0,0 +1,56 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { get } from '@lowdefy/helpers';
+import getMenus from './menus/getMenus.js';
+async function getHomeAndMenus(context) {
+    const menus = await getMenus(context);
+    const homePageId = get(context.config, 'homePageId');
+    if (homePageId) {
+        return {
+            home: {
+                configured: true,
+                pageId: homePageId
+            },
+            menus
+        };
+    }
+    let defaultMenu = menus.find((menu)=>menu.menuId === 'default');
+    if (!defaultMenu) {
+        // eslint-disable-next-line prefer-destructuring
+        defaultMenu = menus[0];
+    }
+    let pageId = null;
+    pageId = get(defaultMenu, 'links.0.pageId', {
+        default: null
+    });
+    if (!pageId) {
+        pageId = get(defaultMenu, 'links.0.links.0.pageId', {
+            default: null
+        });
+    }
+    if (!pageId) {
+        pageId = get(defaultMenu, 'links.0.links.0.links.0.pageId', {
+            default: null
+        });
+    }
+    return {
+        home: {
+            configured: false,
+            pageId
+        },
+        menus
+    };
+}
+export default getHomeAndMenus;

package/dist/routes/rootConfig/getLowdefyGlobal.js

@@ -0,0 +1,19 @@
+/*
+  Copyright 2020-2023 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.
+*/ async function getLowdefyGlobal({ readConfigFile }) {
+    const lowdefyGlobal = await readConfigFile('global.json');
+    return lowdefyGlobal || {};
+}
+export default getLowdefyGlobal;

package/dist/routes/rootConfig/getRootConfig.js

@@ -0,0 +1,28 @@
+/*
+  Copyright 2020-2023 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.
+*/ import getHomeAndMenus from './getHomeAndMenus.js';
+import getLowdefyGlobal from './getLowdefyGlobal.js';
+async function getRootConfig(context) {
+    const [lowdefyGlobal, { home, menus }] = await Promise.all([
+        getLowdefyGlobal(context),
+        getHomeAndMenus(context)
+    ]);
+    return {
+        home,
+        lowdefyGlobal,
+        menus
+    };
+}
+export default getRootConfig;

package/dist/routes/rootConfig/menus/filterMenuList.js

@@ -0,0 +1,41 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { get } from '@lowdefy/helpers';
+function filterMenuList(context, { menuList }) {
+    const { authorize } = context;
+    return menuList.map((item)=>{
+        if (item.type === 'MenuLink') {
+            if (authorize(item)) {
+                return item;
+            }
+            return null;
+        }
+        if (item.type === 'MenuGroup') {
+            const filteredSubItems = filterMenuList(context, {
+                menuList: get(item, 'links', {
+                    default: []
+                })
+            });
+            if (filteredSubItems.length > 0) {
+                return {
+                    ...item,
+                    links: filteredSubItems
+                };
+            }
+        }
+        return null;
+    }).filter((item)=>item !== null);
+}
+export default filterMenuList;

package/dist/routes/rootConfig/menus/filterMenus.js

@@ -0,0 +1,29 @@
+/*
+  Copyright 2020-2023 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.
+*/ import { get } from '@lowdefy/helpers';
+import filterMenuList from './filterMenuList.js';
+function filterMenus(context, { menus }) {
+    return menus.map((menu)=>{
+        return {
+            ...menu,
+            links: filterMenuList(context, {
+                menuList: get(menu, 'links', {
+                    default: []
+                })
+            })
+        };
+    });
+}
+export default filterMenus;

package/dist/routes/rootConfig/menus/getMenus.js

@@ -0,0 +1,22 @@
+/*
+  Copyright 2020-2023 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.
+*/ import filterMenus from './filterMenus.js';
+async function getMenus(context) {
+    const unfilteredMenus = await context.readConfigFile('menus.json');
+    return filterMenus(context, {
+        menus: unfilteredMenus || []
+    });
+}
+export default getMenus;

package/dist/test/testContext.js

@@ -0,0 +1,38 @@
+/*
+  Copyright 2020-2023 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.
+*/ import createAuthorize from '../context/createAuthorize.js';
+function testContext({ config = {}, connections = {}, headers = {}, logger = {
+    debug: ()=>{},
+    error: ()=>{},
+    info: ()=>{},
+    warn: ()=>{}
+}, operators = {
+    _test: ()=>'test'
+}, readConfigFile, secrets = {}, session } = {}) {
+    return {
+        authorize: createAuthorize({
+            session
+        }),
+        config,
+        connections,
+        headers,
+        logger,
+        operators,
+        readConfigFile,
+        secrets,
+        session
+    };
+}
+export default testContext;