[Components] google_appsheet #15159

Actions
 - Add Row
 - Update Row
 - Delete Row

Author: luancazarine

components/google_appsheet/.gitignore

@@ -1,23 +1,18 @@
-import appsheet from "../../appsheet.app.mjs";
-import { axios } from "@pipedream/platform";
+import common from "../common/base.mjs";
 
 export default {
-  key: "appsheet-add-row",
+  ...common,
+  key: "google_appsheet-add-row",
   name: "Add Row",
-  description: "Adds a new row to a specific table in an AppSheet app. [See the documentation]()",
-  version: "0.0.{{ts}}",
+  description: "Adds a new row to a specific table in an AppSheet app. [See the documentation](https://support.google.com/appsheet/answer/10104797?hl=en&ref_topic=10105767&sjid=1665780.0.1444403316-SA#)",
+  version: "0.0.1",
   type: "action",
-  props: {
-    appsheet,
-    rowData: {
-      type: "object",
-      label: "Row Data",
-      description: "JSON object representing the new row data",
+  methods: {
+    getAction() {
+      return "Add";
+    },
+    getSummary() {
+      return "Added a new row successfully";
     },
-  },
-  async run({ $ }) {
-    const response = await this.appsheet.addRow(this.rowData);
-    $.export("$summary", "Added a new row successfully");
-    return response;
   },
 };

components/google_appsheet/actions/add-row/add-row.mjs

@@ -0,0 +1,34 @@
+import { parseObject } from "../../common/utils.mjs";
+import appsheet from "../../google_appsheet.app.mjs";
+
+export default {
+  props: {
+    appsheet,
+    tableName: {
+      propDefinition: [
+        appsheet,
+        "tableName",
+      ],
+    },
+    row: {
+      propDefinition: [
+        appsheet,
+        "row",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.appsheet.post({
+      $,
+      tableName: this.tableName,
+      data: {
+        Action: this.getAction(),
+        Rows: [
+          parseObject(this.row),
+        ],
+      },
+    });
+    $.export("$summary", this.getSummary(response));
+    return response;
+  },
+};

components/google_appsheet/actions/common/base.mjs

@@ -1,26 +1,26 @@
-import google_appsheet from "../../google_appsheet.app.mjs";
-import { axios } from "@pipedream/platform";
+import common from "../common/base.mjs";
 
 export default {
+  ...common,
   key: "google_appsheet-delete-row",
   name: "Delete Row",
-  description: "Deletes a specific row from a table in an AppSheet app. [See the documentation]()",
-  version: "0.0.{{ts}}",
+  description: "Deletes a specific row from a table in an AppSheet app. [See the documentation](https://support.google.com/appsheet/answer/10105399?hl=en&ref_topic=10105767&sjid=1665780.0.1444403316-SA)",
+  version: "0.0.1",
   type: "action",
   props: {
-    google_appsheet: {
-      type: "app",
-      app: "google_appsheet",
-    },
-    rowId: {
-      type: "string",
-      label: "Row ID",
-      description: "The ID of the row to delete",
+    ...common.props,
+    alert: {
+      type: "alert",
+      alertType: "info",
+      content: "The `Row` value may contain field values of the key field values of the record to be deleted.",
     },
   },
-  async run({ $ }) {
-    const response = await this.google_appsheet.deleteRow(this.rowId);
-    $.export("$summary", `Deleted row with ID ${this.rowId}`);
-    return response;
+  methods: {
+    getAction() {
+      return "Delete";
+    },
+    getSummary(response) {
+      return `${response.Rows.length} successfully delete!`;
+    },
   },
 };

components/google_appsheet/actions/delete-row/delete-row.mjs

@@ -1,27 +1,28 @@
-import google_appsheet from "../../google_appsheet.app.mjs";
+import common from "../common/base.mjs";
 
 export default {
+  ...common,
   key: "google_appsheet-update-row",
   name: "Update Row",
-  description: "Updates an existing row in a specific table in an AppSheet app. [See the documentation]()",
-  version: "0.0.{{ts}}",
+  description: "Updates an existing row in a specific table in an AppSheet app. [See the documentation](https://support.google.com/appsheet/answer/10105002?hl=en&ref_topic=10105767&sjid=1665780.0.1444403316-SA)",
+  version: "0.0.1",
   type: "action",
   props: {
-    google_appsheet,
-    rowId: {
-      type: "string",
-      label: "Row ID",
-      description: "The ID of the row to update",
-    },
-    fieldsToUpdate: {
-      type: "object",
-      label: "Fields to Update",
-      description: "Key-value pairs of fields to update",
+    ...common.props,
+    alert: {
+      type: "alert",
+      alertType: "info",
+      content: `The \`Row\` value must include the key field values of the record to be updated.
+      \nThe \`Row\` value may contain one or more field values of other fields to be updated in the record.
+      \nIf a field's name is omitted, that field's value is not changed. If the field can be assigned a string value and the field value you specify is "" then the field's value will be cleared.`,
     },
   },
-  async run({ $ }) {
-    const response = await this.google_appsheet.updateRow(this.rowId, this.fieldsToUpdate);
-    $.export("$summary", `Updated row with ID ${this.rowId}`);
-    return response;
+  methods: {
+    getAction() {
+      return "Edit";
+    },
+    getSummary(response) {
+      return `${response.Rows.length} successfully updated!`;
+    },
   },
 };

components/google_appsheet/actions/update-row/update-row.mjs

@@ -0,0 +1,24 @@
+export const parseObject = (obj) => {
+  if (!obj) return undefined;
+
+  if (Array.isArray(obj)) {
+    return obj.map((item) => {
+      if (typeof item === "string") {
+        try {
+          return JSON.parse(item);
+        } catch (e) {
+          return item;
+        }
+      }
+      return item;
+    });
+  }
+  if (typeof obj === "string") {
+    try {
+      return JSON.parse(obj);
+    } catch (e) {
+      return obj;
+    }
+  }
+  return obj;
+};

components/google_appsheet/app/google_appsheet.app.ts

@@ -2,105 +2,41 @@ import { axios } from "@pipedream/platform";
 
 export default {
   type: "app",
-  app: "appsheet",
-  version: "0.0.{{ts}}",
+  app: "google_appsheet",
   propDefinitions: {
-    appsheetRegion: {
-      type: "string",
-      label: "AppSheet Region",
-      description: "Domain used to invoke the API based on data residency regions",
-      options: [
-        {
-          label: "Global (www.appsheet.com)",
-          value: "www.appsheet.com",
-        },
-        {
-          label: "EU (eu.appsheet.com)",
-          value: "eu.appsheet.com",
-        },
-      ],
-    },
-    appId: {
-      type: "string",
-      label: "App ID",
-      description: "ID of the AppSheet app",
-    },
     tableName: {
       type: "string",
       label: "Table Name",
-      description: "Name of the table",
+      description: "Name of the table. **Select Data > Tables** and expand the table details to view the table name.",
     },
-    applicationAccessKey: {
-      type: "string",
-      label: "Application Access Key",
-      description: "Access key for the AppSheet API",
-      secret: true,
+    row: {
+      type: "object",
+      label: "Row",
+      description: "JSON object representing the new row data",
     },
   },
   methods: {
-    _baseUrl() {
-      return `https://${this.appsheetRegion}/api/v2/apps/${this.appId}/tables/${encodeURIComponent(this.tableName)}/Action`;
-    },
-    async _makeRequest(opts = {}) {
-      const {
-        $, method = "POST", data, headers = {}, ...otherOpts
-      } = opts;
-      return axios($, {
-        method,
-        url: `${this._baseUrl()}?applicationAccessKey=${this.applicationAccessKey}`,
-        data,
-        headers: {
-          ...headers,
-          "Content-Type": "application/json",
-        },
-        ...otherOpts,
-      });
+    _baseUrl(tableName) {
+      return `https://api.appsheet.com/api/v2/apps/${this.$auth.app_id}/tables/${encodeURIComponent(tableName)}/Action`;
     },
-    async addRow(rowData) {
-      const requestBody = {
-        Action: "Add",
-        Properties: {
-          Locale: "en-US",
-        },
-        Rows: [
-          rowData,
-        ],
+    _headers() {
+      return {
+        "ApplicationAccessKey": `${this.$auth.api_key}`,
       };
-      return this._makeRequest({
-        data: requestBody,
-      });
     },
-    async updateRow(rowId, fieldsToUpdate) {
-      const requestBody = {
-        Action: "Edit",
-        Properties: {
-          Locale: "en-US",
-        },
-        Rows: [
-          {
-            RowId: rowId,
-            ...fieldsToUpdate,
-          },
-        ],
-      };
-      return this._makeRequest({
-        data: requestBody,
+    _makeRequest({
+      $ = this, tableName, ...opts
+    }) {
+      return axios($, {
+        url: this._baseUrl(tableName),
+        headers: this._headers(),
+        ...opts,
       });
     },
-    async deleteRow(rowId) {
-      const requestBody = {
-        Action: "Delete",
-        Properties: {
-          Locale: "en-US",
-        },
-        Rows: [
-          {
-            RowId: rowId,
-          },
-        ],
-      };
+    post(opts = {}) {
       return this._makeRequest({
-        data: requestBody,
+        method: "POST",
+        ...opts,
       });
     },
   },

components/google_appsheet/common/utils.mjs

@@ -1,18 +1,18 @@
 {
   "name": "@pipedream/google_appsheet",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "Pipedream Google Appsheet Components",
-  "main": "dist/app/google_appsheet.app.mjs",
+  "main": "google_appsheet.app.mjs",
   "keywords": [
     "pipedream",
     "google_appsheet"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/google_appsheet",
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }