@lowdefy/connection-google-sheets 0.0.0-experimental-20231123101256

package/dist/connections/GoogleSheet/GoogleSheetGetOne/GoogleSheetGetOne.js

@@ -0,0 +1,48 @@
+/*
+  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 cleanRows from '../cleanRows.js';
+import getSheet from '../getSheet.js';
+import { transformRead } from '../transformTypes.js';
+import mingoFilter from '../mingoFilter.js';
+import schema from './schema.js';
+async function GoogleSheetGetOne({ request, connection }) {
+    const { filter, options = {} } = request;
+    const { limit, skip } = options;
+    const sheet = await getSheet({
+        connection
+    });
+    let rows = await sheet.getRows({
+        limit,
+        offset: skip
+    });
+    rows = cleanRows(rows);
+    rows = transformRead({
+        input: rows,
+        types: connection.columnTypes
+    });
+    if (filter) {
+        rows = mingoFilter({
+            input: rows,
+            filter
+        });
+    }
+    return rows[0] ?? null;
+}
+GoogleSheetGetOne.schema = schema;
+GoogleSheetGetOne.meta = {
+    checkRead: true,
+    checkWrite: false
+};
+export default GoogleSheetGetOne;

package/dist/connections/GoogleSheet/GoogleSheetGetOne/schema.js

@@ -0,0 +1,50 @@
+/*
+  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.
+*/ export default {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Lowdefy Request Schema - GoogleSheetGetOne',
+    type: 'object',
+    properties: {
+        filter: {
+            type: 'object',
+            description: 'A MongoDB query expression to filter the data.',
+            errorMessage: {
+                type: 'GoogleSheetGetOne request property "filter" should be an object.'
+            }
+        },
+        options: {
+            type: 'object',
+            properties: {
+                limit: {
+                    type: 'number',
+                    description: 'The maximum number of rows to fetch.',
+                    errorMessage: {
+                        type: 'GoogleSheetGetOne request property "options.limit" should be a number.'
+                    }
+                },
+                skip: {
+                    type: 'number',
+                    description: 'The number of rows to skip from the top of the sheet.',
+                    errorMessage: {
+                        type: 'GoogleSheetGetOne request property "options.skip" should be a number.'
+                    }
+                }
+            }
+        }
+    },
+    errorMessage: {
+        type: 'GoogleSheetGetOne request properties should be an object.'
+    }
+};

package/dist/connections/GoogleSheet/GoogleSheetUpdateMany/GoogleSheetUpdateMany.js

@@ -0,0 +1,62 @@
+/*
+  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 getSheet from '../getSheet.js';
+import { transformRead, transformWrite } from '../transformTypes.js';
+import mingoFilter from '../mingoFilter.js';
+import schema from './schema.js';
+async function GoogleSheetUpdateMany({ request, connection }) {
+    const { filter, update, options = {} } = request;
+    const { limit, skip, raw } = options;
+    const sheet = await getSheet({
+        connection
+    });
+    let rows = await sheet.getRows({
+        limit,
+        offset: skip
+    });
+    rows = transformRead({
+        input: rows,
+        types: connection.columnTypes
+    });
+    rows = mingoFilter({
+        input: rows,
+        filter
+    });
+    const transformedUpdate = transformWrite({
+        input: update,
+        types: connection.columnTypes
+    });
+    if (rows.length === 0) {
+        return {
+            modifiedCount: 0
+        };
+    }
+    const promises = rows.map(async (row)=>{
+        Object.assign(row, transformedUpdate);
+        await row.save({
+            raw
+        });
+    });
+    await Promise.all(promises);
+    return {
+        modifiedCount: rows.length
+    };
+}
+GoogleSheetUpdateMany.schema = schema;
+GoogleSheetUpdateMany.meta = {
+    checkRead: false,
+    checkWrite: true
+};
+export default GoogleSheetUpdateMany;

package/dist/connections/GoogleSheet/GoogleSheetUpdateMany/schema.js

@@ -0,0 +1,72 @@
+/*
+  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.
+*/ export default {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Lowdefy Request Schema - GoogleSheetUpdateMany',
+    type: 'object',
+    required: [
+        'update',
+        'filter'
+    ],
+    properties: {
+        filter: {
+            type: 'object',
+            description: 'A MongoDB query expression to filter the data. All rows matched by the filter will be updated.',
+            errorMessage: {
+                type: 'GoogleSheetUpdateMany request property "filter" should be an object.'
+            }
+        },
+        update: {
+            type: 'object',
+            description: 'The update to apply to the row. An object where keys are the column names and values are the updated values.',
+            errorMessage: {
+                type: 'GoogleSheetUpdateMany request property "update" should be an object.'
+            }
+        },
+        options: {
+            type: 'object',
+            properties: {
+                limit: {
+                    type: 'number',
+                    description: 'The maximum number of rows to fetch.',
+                    errorMessage: {
+                        type: 'GoogleSheetUpdateMany request property "options.limit" should be a number.'
+                    }
+                },
+                raw: {
+                    type: 'boolean',
+                    description: 'Store raw values instead of converting as if typed into the sheets UI.',
+                    errorMessage: {
+                        type: 'GoogleSheetUpdateMany request property "options.raw" should be a boolean.'
+                    }
+                },
+                skip: {
+                    type: 'number',
+                    description: 'The number of rows to skip from the top of the sheet.',
+                    errorMessage: {
+                        type: 'GoogleSheetUpdateMany request property "options.skip" should be a number.'
+                    }
+                }
+            }
+        }
+    },
+    errorMessage: {
+        type: 'GoogleSheetUpdateMany request properties should be an object.',
+        required: {
+            filter: 'GoogleSheetUpdateMany request should have required property "filter".',
+            update: 'GoogleSheetUpdateMany request should have required property "update".'
+        }
+    }
+};

package/dist/connections/GoogleSheet/GoogleSheetUpdateOne/GoogleSheetUpdateOne.js

@@ -0,0 +1,74 @@
+/*
+  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 cleanRows from '../cleanRows.js';
+import getSheet from '../getSheet.js';
+import { transformRead, transformWrite } from '../transformTypes.js';
+import mingoFilter from '../mingoFilter.js';
+import schema from './schema.js';
+async function GoogleSheetUpdateOne({ request, connection }) {
+    const { filter, update, options = {} } = request;
+    const { limit, skip, upsert, raw } = options;
+    const sheet = await getSheet({
+        connection
+    });
+    let rows = await sheet.getRows({
+        limit,
+        offset: skip
+    });
+    rows = transformRead({
+        input: rows,
+        types: connection.columnTypes
+    });
+    rows = mingoFilter({
+        input: rows,
+        filter
+    });
+    const transformedUpdate = transformWrite({
+        input: update,
+        types: connection.columnTypes
+    });
+    if (rows.length === 0) {
+        if (upsert) {
+            const insertedRow = await sheet.addRow(transformedUpdate, {
+                raw
+            });
+            return {
+                modifiedCount: 1,
+                upserted: true,
+                row: cleanRows(insertedRow)
+            };
+        }
+        return {
+            modifiedCount: 0,
+            upserted: false
+        };
+    }
+    const row = rows[0];
+    Object.assign(row, transformedUpdate);
+    await row.save({
+        raw
+    });
+    return {
+        modifiedCount: 1,
+        upserted: false,
+        row: cleanRows(row)
+    };
+}
+GoogleSheetUpdateOne.schema = schema;
+GoogleSheetUpdateOne.meta = {
+    checkRead: false,
+    checkWrite: true
+};
+export default GoogleSheetUpdateOne;

package/dist/connections/GoogleSheet/GoogleSheetUpdateOne/schema.js

@@ -0,0 +1,79 @@
+/*
+  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.
+*/ export default {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Lowdefy Request Schema - GoogleSheetUpdateOne',
+    type: 'object',
+    required: [
+        'update',
+        'filter'
+    ],
+    properties: {
+        filter: {
+            type: 'object',
+            description: 'A MongoDB query expression to filter the data. The first row matched by the filter will be updated.',
+            errorMessage: {
+                type: 'GoogleSheetUpdateOne request property "filter" should be an object.'
+            }
+        },
+        update: {
+            type: 'object',
+            description: 'The update to apply to the row. An object where keys are the column names and values are the updated values.',
+            errorMessage: {
+                type: 'GoogleSheetUpdateOne request property "update" should be an object.'
+            }
+        },
+        options: {
+            type: 'object',
+            properties: {
+                limit: {
+                    type: 'number',
+                    description: 'The maximum number of rows to fetch.',
+                    errorMessage: {
+                        type: 'GoogleSheetUpdateOne request property "options.limit" should be a number.'
+                    }
+                },
+                raw: {
+                    type: 'boolean',
+                    description: 'Store raw values instead of converting as if typed into the sheets UI.',
+                    errorMessage: {
+                        type: 'GoogleSheetUpdateOne request property "options.raw" should be a boolean.'
+                    }
+                },
+                skip: {
+                    type: 'number',
+                    description: 'The number of rows to skip from the top of the sheet.',
+                    errorMessage: {
+                        type: 'GoogleSheetUpdateOne request property "options.skip" should be a number.'
+                    }
+                },
+                upsert: {
+                    type: 'boolean',
+                    description: 'Insert the row if no rows are matched by the filter.',
+                    errorMessage: {
+                        type: 'GoogleSheetUpdateOne request property "options.upsert" should be a boolean.'
+                    }
+                }
+            }
+        }
+    },
+    errorMessage: {
+        type: 'GoogleSheetUpdateOne request properties should be an object.',
+        required: {
+            filter: 'GoogleSheetUpdateOne request should have required property "filter".',
+            update: 'GoogleSheetUpdateOne request should have required property "update".'
+        }
+    }
+};

package/dist/connections/GoogleSheet/cleanRows.js

@@ -0,0 +1,32 @@
+/*
+  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 { type } from '@lowdefy/helpers';
+function cleanRow(row) {
+    // eslint-disable-next-line no-unused-vars
+    const { _sheet, ...rest } = row;
+    return {
+        ...rest
+    };
+}
+function cleanRows(input) {
+    if (type.isObject(input)) {
+        return cleanRow(input);
+    }
+    if (type.isArray(input)) {
+        return input.map((row)=>cleanRow(row));
+    }
+    throw new Error(`cleanRows received invalid input type ${type.typeOf(input)}.`);
+}
+export default cleanRows;

package/dist/connections/GoogleSheet/getSheet.js

@@ -0,0 +1,57 @@
+/*
+  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 { GoogleSpreadsheet } from 'google-spreadsheet';
+async function authenticate({ doc, apiKey, client_email, private_key }) {
+    if (apiKey) {
+        doc.useApiKey(apiKey);
+    } else {
+        await doc.useServiceAccountAuth({
+            client_email,
+            private_key
+        });
+    }
+}
+function getSheetFromDoc({ doc, sheetId, sheetIndex }) {
+    let sheet;
+    if (sheetId) {
+        sheet = doc.sheetsById[sheetId];
+        if (!sheet) {
+            throw new Error(`Could not find sheet with sheetId "${sheetId}"`);
+        }
+    } else {
+        sheet = doc.sheetsByIndex[sheetIndex];
+        if (!sheet) {
+            throw new Error(`Could not find sheet with sheetIndex ${sheetIndex}`);
+        }
+    }
+    return sheet;
+}
+async function getSheet({ connection }) {
+    const { apiKey, client_email, private_key, sheetId, sheetIndex, spreadsheetId } = connection;
+    const doc = new GoogleSpreadsheet(spreadsheetId);
+    await authenticate({
+        doc,
+        apiKey,
+        client_email,
+        private_key
+    });
+    await doc.loadInfo();
+    return getSheetFromDoc({
+        doc,
+        sheetId,
+        sheetIndex
+    });
+}
+export default getSheet;

package/dist/connections/GoogleSheet/mingoAggregation.js

@@ -0,0 +1,44 @@
+/*
+  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 { type } from '@lowdefy/helpers';
+import mingo from 'mingo';
+// TODO: fix build to work with:
+import 'mingo/init/system';
+// import { useOperators, OperatorType } from 'mingo/core.js';
+// import * as accumulatorOperators from 'mingo/operators/accumulator/index.js';
+// import * as expressionOperators from 'mingo/operators/expression/index.js';
+// import * as pipelineOperators from 'mingo/operators/pipeline/index.js';
+// import * as queryOperators from 'mingo/operators/query/index.js';
+// import * as projectionOperators from 'mingo/operators/projection/index.js';
+// // "import * as" is returning different object structures when the connection is being
+// // imported in the build or when running the tests.
+// // So we check for the a default object with all the named exports, otherwise the
+// // returned object has all the named exports.
+// useOperators(OperatorType.ACCUMULATOR, accumulatorOperators.default || accumulatorOperators);
+// useOperators(OperatorType.EXPRESSION, expressionOperators.default || expressionOperators);
+// useOperators(OperatorType.PIPELINE, pipelineOperators.default || pipelineOperators);
+// useOperators(OperatorType.QUERY, queryOperators.default || queryOperators);
+// useOperators(OperatorType.PROJECTION, projectionOperators.default || projectionOperators);
+function mingoAggregation({ input = [], pipeline = [] }) {
+    if (!type.isArray(input)) {
+        throw new Error('Mingo aggregation error. Argument "input" should be an array.');
+    }
+    if (!type.isArray(pipeline)) {
+        throw new Error('Mingo aggregation error. Argument "pipeline" should be an array.');
+    }
+    const aggregator = new mingo.Aggregator(pipeline);
+    return aggregator.run(input);
+}
+export default mingoAggregation;

package/dist/connections/GoogleSheet/mingoFilter.js

@@ -0,0 +1,34 @@
+/*
+  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 { type } from '@lowdefy/helpers';
+import mingoAggregation from './mingoAggregation.js';
+function mingoFilter({ input = [], filter = {} }) {
+    if (!type.isObject(filter)) {
+        throw new Error('Mingo filter error. Argument "filter" should be an object.');
+    }
+    if (!type.isArray(input)) {
+        throw new Error('Mingo filter error. Argument "input" should be an array.');
+    }
+    const pipeline = [
+        {
+            $match: filter
+        }
+    ];
+    return mingoAggregation({
+        input,
+        pipeline
+    });
+}
+export default mingoFilter;

package/dist/connections/GoogleSheet/schema.js

@@ -0,0 +1,110 @@
+/*
+  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.
+*/ export default {
+    $schema: 'http://json-schema.org/draft-07/schema#',
+    title: 'Lowdefy Connection Schema - GoogleSheet',
+    type: 'object',
+    required: [
+        'spreadsheetId'
+    ],
+    properties: {
+        apiKey: {
+            type: 'string',
+            description: 'API key for your google project.',
+            errorMessage: {
+                type: 'GoogleSheet connection property "apiKey" should be a string.'
+            }
+        },
+        client_email: {
+            type: 'string',
+            description: 'The email of your service account.',
+            errorMessage: {
+                type: 'GoogleSheet connection property "client_email" should be a string.'
+            }
+        },
+        private_key: {
+            type: 'string',
+            description: 'The private key for your service account.',
+            errorMessage: {
+                type: 'GoogleSheet connection property "private_key" should be a string.'
+            }
+        },
+        sheetId: {
+            type: 'string',
+            description: 'The ID of the worksheet. Can be found in the URL as the "gid" parameter. One of "sheetId" or "sheetIndex" is required.',
+            errorMessage: {
+                type: 'GoogleSheet connection property "sheetId" should be a string.'
+            }
+        },
+        sheetIndex: {
+            type: 'number',
+            description: 'The position of the worksheet as they appear in the Google sheets UI. Starts from 0. One of "sheetId" or "sheetIndex" is required.',
+            errorMessage: {
+                type: 'GoogleSheet connection property "sheetIndex" should be a number.'
+            }
+        },
+        spreadsheetId: {
+            type: 'string',
+            description: 'document ID from the URL of the spreadsheet.',
+            errorMessage: {
+                type: 'GoogleSheet connection property "spreadsheetId" should be a string.'
+            }
+        },
+        columnTypes: {
+            type: 'object',
+            description: 'Define types for columns in the spreadsheet.',
+            patternProperties: {
+                '^.*$': {
+                    type: 'string',
+                    enum: [
+                        'string',
+                        'number',
+                        'boolean',
+                        'date',
+                        'json'
+                    ],
+                    errorMessage: {
+                        enum: 'GoogleSheet connection property "{{ instancePath }}" should be one of "string", "number", "boolean", "date", or "json".'
+                    }
+                }
+            },
+            errorMessage: {
+                type: 'GoogleSheet connection property "columnTypes" should be an object.'
+            }
+        },
+        read: {
+            type: 'boolean',
+            default: true,
+            description: 'Allow reads from the spreadsheet.',
+            errorMessage: {
+                type: 'GoogleSheet connection property "read" should be a boolean.'
+            }
+        },
+        write: {
+            type: 'boolean',
+            default: false,
+            description: 'Allow writes to the spreadsheet.',
+            errorMessage: {
+                type: 'GoogleSheet connection property "write" should be a boolean.'
+            }
+        }
+    },
+    errorMessage: {
+        type: 'GoogleSheet connection properties should be an object.',
+        required: {
+            spreadsheetId: 'GoogleSheet connection should have required property "spreadsheetId".'
+        }
+    }
+};