@pipedream/google_slides 0.4.0 → 0.6.0

package/actions/format-table-cell/format-table-cell.mjs

@@ -0,0 +1,162 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleSlides from "../../google_slides.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "google_slides-format-table-cell",
+  name: "Format Table Cell",
+  description: "Set the background fill or content alignment of table cells in a Google Slides presentation. Applies to a single cell, or to a block of cells via **Row Span** and **Column Span**. Omit the cell location to format the whole table. Use **Get Presentation** to find the table's object ID. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#UpdateTableCellPropertiesRequest)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    googleSlides,
+    presentationId: {
+      propDefinition: [
+        googleSlides,
+        "staticPresentationId",
+      ],
+    },
+    objectId: {
+      propDefinition: [
+        googleSlides,
+        "pageElementId",
+      ],
+      description: "The object ID of the table to format. Use **Get Presentation** and read `slides[].pageElements[].objectId` for an element with a `table` field.",
+    },
+    rowIndex: {
+      propDefinition: [
+        googleSlides,
+        "rowIndex",
+      ],
+      description: "0-based row of the first cell to format. Omit (with **Column Index**) to format every cell in the table.",
+    },
+    columnIndex: {
+      propDefinition: [
+        googleSlides,
+        "columnIndex",
+      ],
+      description: "0-based column of the first cell to format. Omit (with **Row Index**) to format every cell in the table.",
+    },
+    rowSpan: {
+      type: "integer",
+      label: "Row Span",
+      description: "Number of rows to cover, starting at **Row Index**. Defaults to 1.",
+      min: 1,
+      optional: true,
+    },
+    columnSpan: {
+      type: "integer",
+      label: "Column Span",
+      description: "Number of columns to cover, starting at **Column Index**. Defaults to 1.",
+      min: 1,
+      optional: true,
+    },
+    backgroundColor: {
+      propDefinition: [
+        googleSlides,
+        "backgroundColor",
+      ],
+      description: "Cell fill as a hex code (e.g. `#EEEEEE`) or a theme color name (e.g. `ACCENT1`).",
+    },
+    backgroundOpacity: {
+      propDefinition: [
+        googleSlides,
+        "backgroundOpacity",
+      ],
+      description: "Opacity of the cell fill as a whole percentage, from `0` (fully transparent) to `100` (fully opaque). Can be set on its own to change an existing fill's opacity without restating its color.",
+    },
+    contentAlignment: {
+      propDefinition: [
+        googleSlides,
+        "contentAlignment",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      googleSlides,
+      presentationId,
+      objectId,
+      rowIndex,
+      columnIndex,
+      rowSpan,
+      columnSpan,
+      backgroundColor,
+      backgroundOpacity,
+      contentAlignment,
+    } = this;
+
+    const tableCellProperties = {};
+    const fields = [];
+
+    if (backgroundColor || backgroundOpacity != null) {
+      const solidFill = utils.toSolidFill(backgroundColor, backgroundOpacity);
+      if (!solidFill) {
+        throw new ConfigurationError(`Background Color "${backgroundColor}" is not a valid hex color or theme color name. Use a 6-digit hex code such as \`#EEEEEE\`, or a theme color such as \`ACCENT1\`.`);
+      }
+      tableCellProperties.tableCellBackgroundFill = {
+        solidFill,
+      };
+      // Colour and opacity are masked separately so either can be set alone.
+      if (solidFill.color) {
+        fields.push("tableCellBackgroundFill.solidFill.color");
+      }
+      if (solidFill.alpha != null) {
+        fields.push("tableCellBackgroundFill.solidFill.alpha");
+      }
+    }
+    if (contentAlignment) {
+      tableCellProperties.contentAlignment = contentAlignment;
+      fields.push("contentAlignment");
+    }
+
+    if (!fields.length) {
+      throw new ConfigurationError("Provide at least one formatting option (Background Color, Background Opacity, or Content Alignment).");
+    }
+    if ((rowIndex == null) !== (columnIndex == null)) {
+      throw new ConfigurationError("Row Index and Column Index must be provided together.");
+    }
+    if (rowIndex == null && (rowSpan != null || columnSpan != null)) {
+      throw new ConfigurationError("Row Span and Column Span need a starting cell. Provide Row Index and Column Index, or omit all four to format the whole table.");
+    }
+
+    // Omitting tableRange entirely is what the API treats as "every cell".
+    const tableRange = rowIndex == null
+      ? {}
+      : {
+        tableRange: {
+          location: {
+            rowIndex,
+            columnIndex,
+          },
+          rowSpan: rowSpan ?? 1,
+          columnSpan: columnSpan ?? 1,
+        },
+      };
+
+    await googleSlides.batchUpdate(googleSlides.getPresentationId(presentationId), [
+      {
+        updateTableCellProperties: {
+          objectId,
+          tableCellProperties,
+          fields: fields.join(","),
+          ...tableRange,
+        },
+      },
+    ]);
+
+    $.export("$summary", `Formatted table cells on ${objectId}`);
+
+    return {
+      presentationId,
+      objectId,
+      fieldsUpdated: fields,
+      ...tableRange,
+    };
+  },
+};

package/actions/format-text/format-text.mjs

@@ -0,0 +1,248 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleSlides from "../../google_slides.app.mjs";
+import utils from "../../common/utils.mjs";
+import {
+  BASELINE_OFFSETS, POINTS,
+} from "../../common/constants.mjs";
+
+export default {
+  key: "google_slides-format-text",
+  name: "Format Text",
+  description: "Apply character formatting (bold, italic, underline, strikethrough, font, size, color, link) to the text of a shape or table cell in a Google Slides presentation. Use **Get Presentation** to find the page element's object ID. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#UpdateTextStyleRequest)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    googleSlides,
+    presentationId: {
+      propDefinition: [
+        googleSlides,
+        "staticPresentationId",
+      ],
+    },
+    objectId: {
+      propDefinition: [
+        googleSlides,
+        "pageElementId",
+      ],
+      description: "The object ID of the shape or table whose text should be styled. Use **Get Presentation** and read `slides[].pageElements[].objectId`.",
+    },
+    rowIndex: {
+      propDefinition: [
+        googleSlides,
+        "rowIndex",
+      ],
+      label: "Table Row Index",
+      description: "Required only when **Page Element ID** refers to a table: the 0-based row of the cell to style.",
+    },
+    columnIndex: {
+      propDefinition: [
+        googleSlides,
+        "columnIndex",
+      ],
+      label: "Table Column Index",
+      description: "Required only when **Page Element ID** refers to a table: the 0-based column of the cell to style.",
+    },
+    startIndex: {
+      propDefinition: [
+        googleSlides,
+        "startIndex",
+      ],
+      description: "Character index to style from, inclusive. On its own, styles from here to the end of the text. Omit both indices to style all of it.",
+    },
+    endIndex: {
+      propDefinition: [
+        googleSlides,
+        "endIndex",
+      ],
+      description: "Character index to style up to, exclusive. Requires **Start Index**, and must be greater than it.",
+    },
+    bold: {
+      type: "boolean",
+      label: "Bold",
+      description: "Set `true` to bold the text, `false` to remove bold. Leave unset to keep it unchanged.",
+      optional: true,
+    },
+    italic: {
+      type: "boolean",
+      label: "Italic",
+      description: "Set `true` to italicize the text, `false` to remove italics. Leave unset to keep it unchanged.",
+      optional: true,
+    },
+    underline: {
+      type: "boolean",
+      label: "Underline",
+      description: "Set `true` to underline the text, `false` to remove the underline. Leave unset to keep it unchanged.",
+      optional: true,
+    },
+    strikethrough: {
+      type: "boolean",
+      label: "Strikethrough",
+      description: "Set `true` to strike through the text, `false` to remove it. Leave unset to keep it unchanged.",
+      optional: true,
+    },
+    smallCaps: {
+      type: "boolean",
+      label: "Small Caps",
+      description: "Set `true` to render the text in small capitals, `false` to return it to normal casing. Leave unset to keep it unchanged.",
+      optional: true,
+    },
+    baselineOffset: {
+      type: "string",
+      label: "Baseline Offset",
+      description: "Vertical offset from the normal baseline. `SUPERSCRIPT` and `SUBSCRIPT` are also rendered in a smaller font, computed from the current size.",
+      options: BASELINE_OFFSETS,
+      optional: true,
+    },
+    fontSize: {
+      type: "integer",
+      label: "Font Size",
+      description: "Font size in points (1-400).",
+      min: 1,
+      max: 400,
+      optional: true,
+    },
+    fontFamily: {
+      type: "string",
+      label: "Font Family",
+      description: "Font family name as it appears in the Slides font menu, e.g. `Roboto`.",
+      optional: true,
+    },
+    foregroundColor: {
+      type: "string",
+      label: "Text Color",
+      description: "Hex code (e.g. `#FF0000`) or one of the deck's theme colors (e.g. `ACCENT1`, `DARK1`).",
+      optional: true,
+    },
+    backgroundColor: {
+      propDefinition: [
+        googleSlides,
+        "backgroundColor",
+      ],
+      label: "Highlight Color",
+      description: "Hex code (e.g. `#FFFF00`) or one of the deck's theme colors (e.g. `ACCENT2`).",
+    },
+    link: {
+      type: "string",
+      label: "Link URL",
+      description: "Turn the text into a hyperlink pointing at this URL.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      googleSlides,
+      presentationId,
+      objectId,
+      rowIndex,
+      columnIndex,
+      startIndex,
+      endIndex,
+      bold,
+      italic,
+      underline,
+      strikethrough,
+      smallCaps,
+      baselineOffset,
+      fontSize,
+      fontFamily,
+      foregroundColor,
+      backgroundColor,
+      link,
+    } = this;
+
+    const builder = utils.styleBuilder();
+
+    builder.set("bold", bold);
+    builder.set("italic", italic);
+    builder.set("underline", underline);
+    builder.set("strikethrough", strikethrough);
+    builder.set("smallCaps", smallCaps);
+    builder.set("baselineOffset", baselineOffset);
+
+    if (fontSize != null) {
+      builder.set("fontSize", {
+        magnitude: fontSize,
+        unit: POINTS,
+      });
+    }
+    if (fontFamily) {
+      builder.set("fontFamily", fontFamily);
+    }
+    if (link) {
+      builder.set("link", {
+        url: link,
+      });
+    }
+
+    [
+      [
+        "foregroundColor",
+        foregroundColor,
+        "Text Color",
+      ],
+      [
+        "backgroundColor",
+        backgroundColor,
+        "Highlight Color",
+      ],
+    ].forEach(([
+      name,
+      value,
+      label,
+    ]) => {
+      if (!value) {
+        return;
+      }
+      const solidFill = utils.toSolidFill(value);
+      if (!solidFill) {
+        throw new ConfigurationError(`${label} "${value}" is not a valid hex color or theme color name. Use a 6-digit hex code such as \`#FF0000\`, or a theme color such as \`ACCENT1\`.`);
+      }
+      builder.set(name, {
+        opaqueColor: solidFill.color,
+      });
+    });
+
+    if (builder.isEmpty) {
+      throw new ConfigurationError("Provide at least one formatting option (for example Bold, Font Size, or Text Color).");
+    }
+
+    if ((rowIndex == null) !== (columnIndex == null)) {
+      throw new ConfigurationError("Table Row Index and Table Column Index must be provided together.");
+    }
+
+    const textRange = utils.buildTextRange(startIndex, endIndex);
+
+    const request = {
+      objectId,
+      style: builder.style,
+      textRange,
+      fields: builder.mask,
+      ...(rowIndex != null && {
+        cellLocation: {
+          rowIndex,
+          columnIndex,
+        },
+      }),
+    };
+
+    await googleSlides.batchUpdate(googleSlides.getPresentationId(presentationId), [
+      {
+        updateTextStyle: request,
+      },
+    ]);
+
+    $.export("$summary", `Formatted text on element ${objectId}`);
+
+    return {
+      presentationId,
+      objectId,
+      fieldsUpdated: builder.fields,
+      textRange,
+    };
+  },
+};

package/actions/get-presentation/get-presentation.mjs

@@ -0,0 +1,34 @@
+import app from "../../google_slides.app.mjs";
+
+export default {
+  key: "google_slides-get-presentation",
+  name: "Get Presentation",
+  description: "Get a Google Slides presentation by its ID. Returns the presentation's metadata and structure (title, slides, masters, layouts, page size, etc.) according to requested `fields`. Use **Find a Presentation** first to resolve a presentation's name to its ID. [See the documentation](https://developers.google.com/slides/api/reference/rest/v1/presentations/get)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    app,
+    presentationId: {
+      type: "string",
+      label: "Presentation ID",
+      description: "The ID of the presentation to retrieve. This is the long string in the presentation's URL: `https://docs.google.com/presentation/d/{PRESENTATION_ID}/edit`. You can also paste the full URL. Use **Find a Presentation** to resolve a presentation's name to its ID.",
+    },
+    fields: {
+      type: "string",
+      label: "Fields",
+      description: "Optional partial-response [field mask](https://developers.google.com/slides/api/guides/field-masks) to limit the response to specific fields. Comma-separated, e.g. `presentationId,title` for just basic metadata, or `slides.objectId,title` to also list slide IDs. Omit to return the full presentation.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const presentationId = this.app.getPresentationId(this.presentationId);
+    const presentation = await this.app.getPresentation(presentationId, this.fields);
+    $.export("$summary", `Successfully retrieved presentation with ID: ${presentationId}`);
+    return presentation;
+  },
+};

package/actions/insert-table-columns/insert-table-columns.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-insert-table-columns",
   name: "Insert Table Columns",
   description: "Insert new columns into a table. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#InsertTableColumnsRequest)",
-  version: "0.0.3",
+  version: "0.0.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/insert-table-rows/insert-table-rows.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-insert-table-rows",
   name: "Insert Table Rows",
   description: "Insert new rows into a table. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#InsertTableRowsRequest)",
-  version: "0.0.3",
+  version: "0.0.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/insert-text/insert-text.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-insert-text",
   name: "Insert Text",
   description: "Insert text into a shape. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#InsertTextRequest)",
-  version: "0.0.4",
+  version: "0.0.6",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/insert-text-into-table/insert-text-into-table.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-insert-text-into-table",
   name: "Insert Text into Table",
   description: "Insert text into a table cell. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#InsertTextRequest)",
-  version: "0.0.3",
+  version: "0.0.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/merge-data/merge-data.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-merge-data",
   name: "Merge Data",
   description: "Merge data into a presentation. [See the docs here](https://developers.google.com/slides/api/guides/merge)",
-  version: "0.0.6",
+  version: "0.0.8",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,