@lowdefy/connection-google-sheets 0.0.0-experimental-20250926130521 → 0.0.0-experimental-20251010122007

package/dist/connections/GoogleSheet/GoogleSheetAppendMany/documentation.md

@@ -0,0 +1,93 @@
+<TITLE>
+GoogleSheetAppendMany
+</TITLE>
+
+<DESCRIPTION>
+
+The `GoogleSheetAppendMany` request inserts an array of documents as rows in a Google Sheet.
+
+### Properties
+
+- `rows: object[]`: __Required__ - The rows to insert into the sheet. An an array of objects where keys are the column names and values are the values to insert.
+- `options: object`: Optional settings. Supported settings are:
+  - `raw: boolean`: Store raw values instead of converting as if typed into the sheets UI.
+
+</DESCRIPTION>
+
+<CONNECTION>
+GoogleSheet
+</CONNECTION>
+
+<SCHEMA>
+
+```js
+export default {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Lowdefy Request Schema - GoogleSheetAppendMany',
+  type: 'object',
+  required: ['rows'],
+  properties: {
+    rows: {
+      type: 'array',
+      description:
+        'The rows to insert into the sheet. An an array of objects where keys are the column names and values are the values to insert.',
+      errorMessage: {
+        type: 'GoogleSheetAppendMany request property "rows" should be an array.',
+      },
+      items: {
+        type: 'object',
+        description:
+          'The row to insert into the sheet. An object where keys are the column names and values are the values to insert.',
+        errorMessage: {
+          type: 'GoogleSheetAppendMany request property "rows" should be an array of objects.',
+        },
+      },
+    },
+    options: {
+      type: 'object',
+      properties: {
+        raw: {
+          type: 'boolean',
+          description: 'Store raw values instead of converting as if typed into the sheets UI.',
+          errorMessage: {
+            type: 'GoogleSheetAppendMany request property "options.raw" should be a boolean.',
+          },
+        },
+      },
+    },
+  },
+  errorMessage: {
+    type: 'GoogleSheetAppendMany request properties should be an object.',
+    required: {
+      rows: 'GoogleSheetAppendMany request should have required property "rows".',
+    },
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+### Insert a list of rows
+
+```yaml
+requests:
+  - id: append_rows
+    type:  GoogleSheetAppendMany
+    connectionId: google_sheets
+    properties:
+      rows:
+        - name: D.Va
+          role: Tank
+        - name: Tracer
+          role: Damage
+        - name: Genji
+          role: Damage
+        - name: Reinhart
+          role: Tank
+        - name: Mercy
+          role: Support
+```
+
+</EXAMPLES>

package/dist/connections/GoogleSheet/GoogleSheetAppendOne/documentation.md

@@ -0,0 +1,79 @@
+<TITLE>
+GoogleSheetAppendOne
+</TITLE>
+
+<DESCRIPTION>
+
+The `GoogleSheetAppendOne` request inserts a documents as a row in a Google Sheet.
+
+### Properties
+
+- `row: object`: __Required__ - The row to insert into the sheet. An object where keys are the column names and values are the values to insert.
+- `options: object`: Optional settings. Supported settings are:
+  - `raw: boolean`: Store raw values instead of converting as if typed into the sheets UI.
+
+</DESCRIPTION>
+
+<CONNECTION>
+GoogleSheet
+</CONNECTION>
+
+<SCHEMA>
+
+```js
+export default {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Lowdefy Request Schema - GoogleSheetAppendOne',
+  type: 'object',
+  required: ['row'],
+  properties: {
+    row: {
+      type: 'object',
+      description:
+        'The row to insert into the sheet. An object where keys are the column names and values are the values to insert.',
+      errorMessage: {
+        type: 'GoogleSheetAppendOne request property "row" should be an object.',
+      },
+    },
+    options: {
+      type: 'object',
+      properties: {
+        raw: {
+          type: 'boolean',
+          description: 'Store raw values instead of converting as if typed into the sheets UI.',
+          errorMessage: {
+            type: 'GoogleSheetAppendOne request property "options.raw" should be a boolean.',
+          },
+        },
+      },
+    },
+  },
+  errorMessage: {
+    type: 'GoogleSheetAppendOne request properties should be an object.',
+    required: {
+      row: 'GoogleSheetAppendOne request should have required property "row".',
+    },
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+### Insert a single row
+
+```yaml
+requests:
+  - id: insert_dva
+    type:  GoogleSheetAppendOne
+    connectionId: google_sheets
+    properties:
+      row:
+        name: D.Va
+        role: Tank
+        real_name: Hana Song
+        age: 19
+```
+
+</EXAMPLES>

package/dist/connections/GoogleSheet/GoogleSheetDeleteOne/documentation.md

@@ -0,0 +1,85 @@
+<TITLE>
+GoogleSheetDeleteOne
+</TITLE>
+
+<DESCRIPTION>
+
+The `GoogleSheetDeleteOne` request deletes a row from a Google Sheet. It deletes the first row matched by the filter, written as a MongoDB query expression.
+
+### Properties
+
+- `filter: object`: __Required__ - A MongoDB query expression to filter the data. The first row matched by the filter will be deleted.
+- `options: object`: Optional settings. Supported settings are:
+  - `limit: number`: The maximum number of rows to fetch.
+  - `skip: number`: The number of rows to skip from the top of the sheet.
+
+</DESCRIPTION>
+
+<CONNECTION>
+GoogleSheet
+</CONNECTION>
+
+<SCHEMA>
+
+```js
+export default {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Lowdefy Request Schema - GoogleSheetDeleteOne',
+  type: 'object',
+  required: ['filter'],
+  properties: {
+    filter: {
+      type: 'object',
+      description:
+        'A MongoDB query expression to filter the data. The first row matched by the filter will be deleted.',
+      errorMessage: {
+        type: 'GoogleSheetDeleteOne request property "filter" should be an object.',
+      },
+    },
+    options: {
+      type: 'object',
+      properties: {
+        limit: {
+          type: 'number',
+          description: 'The maximum number of rows to fetch.',
+          errorMessage: {
+            type: 'GoogleSheetDeleteOne 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: 'GoogleSheetDeleteOne request property "options.skip" should be a number.',
+          },
+        },
+      },
+    },
+  },
+  errorMessage: {
+    type: 'GoogleSheetDeleteOne request properties should be an object.',
+    required: {
+      filter: 'GoogleSheetDeleteOne request should have required property "filter".',
+    },
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+### Delete the row where name is "Hanzo"
+
+```yaml
+requests:
+  - id: delete_hanzo
+    type:  GoogleSheetDeleteOne
+    connectionId: google_sheets
+    properties:
+      filter:
+        name:
+          $eq: Hanzo
+```
+
+</EXAMPLES>

package/dist/connections/GoogleSheet/GoogleSheetGetMany/documentation.md

@@ -0,0 +1,145 @@
+<TITLE>
+GoogleSheetGetMany
+</TITLE>
+
+<DESCRIPTION>
+
+The `GoogleSheetGetMany` request fetches a number of rows from the spreadsheet. The `limit` and `skip` options can be used to control which documents are read from the spreadsheet. The filter or pipeline options can then be used to filter or transform the fetched data.
+
+### Properties
+
+- `filter: object`: A MongoDB query expression to filter the data.
+- `pipeline: object[]`: A MongoDB aggregation pipeline to transform the data.
+- `options: object`: Optional settings. Supported settings are:
+  - `limit: number`: The maximum number of rows to fetch.
+  - `skip: number`: The number of rows to skip from the top of the sheet.
+
+</DESCRIPTION>
+
+<CONNECTION>
+GoogleSheet
+</CONNECTION>
+
+<SCHEMA>
+
+```js
+export default {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  title: 'Lowdefy Request Schema - GoogleSheetGetMany',
+  type: 'object',
+  properties: {
+    filter: {
+      type: 'object',
+      description: 'A MongoDB query expression to filter the data.',
+      errorMessage: {
+        type: 'GoogleSheetGetMany request property "filter" should be an object.',
+      },
+    },
+    pipeline: {
+      type: 'array',
+      description: 'A MongoDB aggregation pipeline to transform the data.',
+      errorMessage: {
+        type: 'GoogleSheetGetMany request property "pipeline" should be an array.',
+      },
+    },
+    options: {
+      type: 'object',
+      properties: {
+        limit: {
+          type: 'number',
+          description: 'The maximum number of rows to fetch.',
+          errorMessage: {
+            type: 'GoogleSheetGetMany 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: 'GoogleSheetGetMany request property "options.skip" should be a number.',
+          },
+        },
+      },
+    },
+  },
+  errorMessage: {
+    type: 'GoogleSheetGetMany request properties should be an object.',
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+### Get the first 10 rows
+
+```yaml
+requests:
+  - id: get_10_rows
+    type:  GoogleSheetGetMany
+    connectionId: google_sheets
+    properties:
+      options:
+        limit: 10
+```
+
+### Pagination using limit and skip
+
+```yaml
+requests:
+  - id: get_10_rows
+    type:  GoogleSheetGetMany
+    connectionId: google_sheets
+    payload:
+      page_size:
+        _state: page_size
+      page_number:
+        _state: page_number
+    properties:
+      options:
+        skip:
+          _product:
+            - _payload: page_size
+            - _subtract:
+                - _payload: page_number
+                - 1
+        limit:
+          _payload: page_size
+```
+
+### Get all records where age is greater than 25
+
+```yaml
+requests:
+  - id: get_10_rows
+    type:  GoogleSheetGetMany
+    connectionId: google_sheets
+    properties:
+      filter:
+        age:
+          $gt: 25
+```
+
+### Use an aggregation pipeline to aggregate data
+
+```yaml
+requests:
+  - id: get_10_rows
+    type:  GoogleSheetGetMany
+    connectionId: google_sheets
+    properties:
+      pipeline:
+        - $group:
+            _id: $region
+            score:
+              $avg: $score
+        - $project:
+            _id: 0
+            region: $_id
+            score: 1
+        - $sort:
+            score: 1
+```
+
+</EXAMPLES>

package/dist/connections/GoogleSheet/GoogleSheetGetOne/documentation.md

@@ -0,0 +1,80 @@
+<TITLE>
+GoogleSheetGetOne
+</TITLE>
+
+<DESCRIPTION>
+
+The `GoogleSheetGetOne` request fetches a single rows from the spreadsheet. The `limit` and `skip` options can be used to control which documents are read from the spreadsheet. The filter option can then be used to filter or select which row is returned.
+
+### Properties
+
+- `filter: object`: A MongoDB query expression to filter the data.
+- `options: object`: Optional settings. Supported settings are:
+  - `limit: number`: The maximum number of rows to fetch.
+  - `skip: number`: The number of rows to skip from the top of the sheet.
+
+</DESCRIPTION>
+
+<CONNECTION>
+GoogleSheet
+</CONNECTION>
+
+<SCHEMA>
+
+```js
+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.',
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+### Get row where name is "Zarya"
+
+```yaml
+requests:
+  - id: get_10_rows
+    type:  GoogleSheetGetOne
+    connectionId: google_sheets
+    properties:
+      filter:
+        name:
+          $eq: Zarya
+```
+
+</EXAMPLES>

package/dist/connections/GoogleSheet/GoogleSheetUpdateMany/documentation.md

@@ -0,0 +1,105 @@
+<TITLE>
+GoogleSheetUpdateMany
+</TITLE>
+
+<DESCRIPTION>
+
+The `GoogleSheetUpdateMany` request updates all the rows matched by the filter.
+
+### Properties
+
+- `filter: object`: A MongoDB query expression to filter the data. . All rows matched by the filter will be updated.
+- `update: object`: The update to apply to the row. An object where keys are the column names and values are the updated values.
+- `options: object`: Optional settings. Supported settings are:
+  - `limit: number`: The maximum number of rows to fetch.
+  - `raw: boolean`: Store raw values instead of converting as if typed into the sheets UI.
+  - `skip: number`: The number of rows to skip from the top of the sheet.
+
+</DESCRIPTION>
+
+<CONNECTION>
+GoogleSheet
+</CONNECTION>
+
+<SCHEMA>
+
+```js
+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".',
+    },
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+### Update all rows where age is less than 18
+
+```yaml
+requests:
+  - id: get_10_rows
+    type:  GoogleSheetUpdateMany
+    connectionId: google_sheets
+    properties:
+      filter:
+        age:
+          $lt: 18
+      update:
+        minor: true
+```
+
+</EXAMPLES>

package/dist/connections/GoogleSheet/GoogleSheetUpdateOne/documentation.md

@@ -0,0 +1,113 @@
+<TITLE>
+GoogleSheetUpdateOne
+</TITLE>
+
+<DESCRIPTION>
+
+The `GoogleSheetUpdateOne` request updates the first row matched by the filter.
+
+### Properties
+
+- `filter: object`: A MongoDB query expression to filter the data. . The first row matched by the filter will be updated.
+- `update: object`: The update to apply to the row. An object where keys are the column names and values are the updated values.
+- `options: object`: Optional settings. Supported settings are:
+  - `limit: number`: The maximum number of rows to fetch.
+  - `raw: boolean`: Store raw values instead of converting as if typed into the sheets UI.
+  - `skip: number`: The number of rows to skip from the top of the sheet.
+  - `upsert: boolean`: Insert the row if no rows are matched by the filter.
+
+</DESCRIPTION>
+
+<CONNECTION>
+GoogleSheet
+</CONNECTION>
+
+<SCHEMA>
+
+```js
+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".',
+    },
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+### Update the row for "Doomfist"
+
+```yaml
+requests:
+  - id: get_10_rows
+    type:  GoogleSheetUpdateOne
+    connectionId: google_sheets
+    properties:
+      filter:
+        name:
+          $eq: Doomfist
+      update:
+        overpowered: true
+```
+
+</EXAMPLES>

package/dist/connections/GoogleSheet/documentation.md

@@ -0,0 +1,176 @@
+<TITLE>
+GoogleSheet
+</TITLE>
+
+<DESCRIPTION>
+
+The `GoogleSheet` connection offers the flexibility to connect to Google Sheets using either an API key or a service account. While an API key is suitable for read-only access to public sheets, most applications will benefit more from using a service account, which offers broader capabilities. For detailed instructions on creating a service account, you can refer to the [Google Sheets API Quickstart Guide](https://developers.google.com/sheets/api/quickstart/js) and the [Google Workspace Guide on Creating a Project](https://developers.google.com/workspace/guides/create-project).
+
+This connection refers to the entire document as the `spreadsheet`, and the individual sheets in the document as `sheets`. The spreadsheet is identified by it's `spreadsheetId`, and sheets can either be identified by their `sheetId` or their `index` (position in the document starting from 0).
+
+When a sheet is accessed in a browser the url either looks like:
+`https://docs.google.com/spreadsheets/d/{spreadsheetId}/edit#gid={sheetId}`
+
+The `GoogleSheet` connection works with sheets as a row based data store. Each row is a data record, and a header row needs to be present to define the column names. This header needs to be created in the Google Sheets web interface. Types can be specified for any of the columns in the sheet. If a type is not specified, the value will be read as a string. The `json` type will stringify a object as JSON before saving it, and parse it again when reading.
+
+### Properties
+
+- `apiKey: string`: API key for your google project.
+- `client_email: string`: The email address of your service account.
+- `private_key: string`: The private key for your service account. Base64 encode the string if you have issues with the newline characters in the string.
+- `sheetId: string`: The ID of the worksheet. Can be found in the URL as the "gid" parameter. One of `sheetId` or `sheetIndex` is required.
+- `sheetIndex: number`: The position of the worksheet as they appear in the Google sheets UI. Starts from 0. One of `sheetId` or `sheetIndex` is required.
+- `spreadsheetId: string`: __Required__ - The document ID from the URL of the spreadsheet.
+- `columnTypes: object`: An object that defines the data types for each column. Each key should be the column name, and the value should be one of: `string`, `number`, `boolean`, `date`, or `json`.
+- `read: boolean`: Default: `true` - Allow read operations like find on the sheet.
+- `write: boolean`: Default: `false` - Allow write operations like update on the sheet.
+
+</DESCRIPTION>
+
+<REQUESTS>
+
+- GoogleSheetAppendMany
+- GoogleSheetAppendOne
+- GoogleSheetDeleteOne
+- GoogleSheetGetMany
+- GoogleSheetGetOne
+- GoogleSheetUpdateMany
+- GoogleSheetUpdateOne
+
+</REQUESTS>
+
+<SCHEMA>
+
+```js
+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".',
+    },
+  },
+};
+```
+
+</SCHEMA>
+
+<EXAMPLES>
+
+### Read only access to first sheet in a public spreadsheet
+
+```yaml
+connections:
+  - id: public_sheet
+    type: GoogleSheet
+    properties:
+      apiKey:
+        _secret: GOOGLE_SHEETS_API_KEY
+      sheetIndex: 0
+      spreadsheetId: ubQsWYNGRUq0gFB1sAp2r9oYE19lZ8yGA1T6y0yBoLPW
+```
+
+### Access with a service account, with defined types
+
+```yaml
+connections:
+  - id: my_sheet
+    type: GoogleSheet
+    properties:
+      client_email:
+        _secret: GOOGLE_SHEETS_CLIENT_EMAIL
+      private_key:
+        _base64.decode:
+          _secret: GOOGLE_SHEETS_PRIVATE_KEY
+      sheetId: '1199545345'
+      spreadsheetId: ubQsWYNGRUq0gFB1sAp2r9oYE19lZ8yGA1T6y0yBoLPW
+      columnTypes:
+        name: string
+        age: number
+        birthday: date
+        subscribed: boolean
+        address: json
+```
+
+</EXAMPLES>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lowdefy/connection-google-sheets",
-  "version": "0.0.0-experimental-20250926130521",
+  "version": "0.0.0-experimental-20251010122007",
   "license": "Apache-2.0",
   "description": "",
   "homepage": "https://lowdefy.com",
@@ -35,14 +35,14 @@
     "dist/*"
   ],
   "dependencies": {
-    "@lowdefy/helpers": "0.0.0-experimental-20250926130521",
+    "@lowdefy/helpers": "0.0.0-experimental-20251010122007",
     "google-spreadsheet": "3.3.0",
     "mingo": "6.4.9",
     "moment": "2.29.4"
   },
   "devDependencies": {
     "@jest/globals": "28.1.3",
-    "@lowdefy/ajv": "0.0.0-experimental-20250926130521",
+    "@lowdefy/ajv": "0.0.0-experimental-20251010122007",
     "@swc/cli": "0.1.63",
     "@swc/core": "1.3.99",
     "@swc/jest": "0.2.29",