@pipedream/google_slides 0.5.0 → 0.6.1

package/actions/create-image/create-image.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-create-image",
   name: "Create Image",
   description: "Creates an image in a slide. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#CreateImageRequest)",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-page-element/create-page-element.mjs

@@ -5,7 +5,7 @@ export default {
   key: "google_slides-create-page-element",
   name: "Create Page Element",
   description: "Create a new page element in a slide. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#CreateShapeRequest)",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-presentation/create-presentation.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-create-presentation",
   name: "Create Presentation",
   description: "Create a blank presentation or duplicate an existing presentation. [See the docs here](https://developers.google.com/slides/api/guides/presentations#copy_an_existing_presentation)",
-  version: "0.0.8",
+  version: "0.0.9",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-slide/create-slide.mjs

@@ -5,7 +5,7 @@ export default {
   key: "google_slides-create-slide",
   name: "Create Slide",
   description: "Create a new slide in a presentation. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#CreateSlideRequest)",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/create-table/create-table.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-create-table",
   name: "Create Table",
   description: "Create a new table in a slide. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#CreateTableRequest)",
-  version: "0.0.4",
+  version: "0.0.5",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/delete-page-element/delete-page-element.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-delete-page-element",
   name: "Delete Page Element",
   description: "Deletes a page element from a slide. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#DeleteObjectRequest)",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/actions/delete-slide/delete-slide.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-delete-slide",
   name: "Delete Slide",
   description: "Deletes a slide from a presentation. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#DeleteObjectRequest)",
-  version: "0.0.5",
+  version: "0.0.6",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/actions/delete-table-column/delete-table-column.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-delete-table-column",
   name: "Delete Table Column",
   description: "Delete column from a table. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#DeleteTableColumnRequest)",
-  version: "0.0.4",
+  version: "0.0.5",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/actions/delete-table-row/delete-table-row.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-delete-table-row",
   name: "Delete Table Row",
   description: "Delete row from a table. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#DeleteTableRowRequest)",
-  version: "0.0.4",
+  version: "0.0.5",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,

package/actions/find-presentation/find-presentation.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_slides-find-presentation",
   name: "Find a Presentation",
   description: "Find a presentation on Google Drive. [See the docs here](https://developers.google.com/slides/api/samples/presentation#list_existing_presentation_files)",
-  version: "0.0.8",
+  version: "0.0.9",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,

package/actions/format-paragraph/format-paragraph.mjs

@@ -0,0 +1,236 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleSlides from "../../google_slides.app.mjs";
+import utils from "../../common/utils.mjs";
+import {
+  ALIGNMENTS, BULLETS_NONE, BULLET_PRESETS, SPACING_MODES, TEXT_DIRECTIONS,
+} from "../../common/constants.mjs";
+
+export default {
+  key: "google_slides-format-paragraph",
+  name: "Format Paragraph",
+  description: "Apply paragraph formatting (alignment, line spacing, indentation, bullets) 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#UpdateParagraphStyleRequest)",
+  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 paragraphs 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.",
+    },
+    alignment: {
+      type: "string",
+      label: "Alignment",
+      description: "Paragraph alignment. `START` is left-aligned in a left-to-right deck.",
+      options: ALIGNMENTS,
+      optional: true,
+    },
+    lineSpacing: {
+      type: "integer",
+      label: "Line Spacing",
+      description: "Line spacing as a percentage of normal (100 = single, 150 = 1.5x). Range 1-1000.",
+      min: 1,
+      max: 1000,
+      optional: true,
+    },
+    spaceAbove: {
+      type: "integer",
+      label: "Space Above",
+      description: "Space above each paragraph, in points (0-500).",
+      min: 0,
+      max: 500,
+      optional: true,
+    },
+    spaceBelow: {
+      type: "integer",
+      label: "Space Below",
+      description: "Space below each paragraph, in points (0-500).",
+      min: 0,
+      max: 500,
+      optional: true,
+    },
+    indentStart: {
+      type: "integer",
+      label: "Indent Start",
+      description: "Indentation from the start side, in points (0-500).",
+      min: 0,
+      max: 500,
+      optional: true,
+    },
+    indentEnd: {
+      type: "integer",
+      label: "Indent End",
+      description: "Indentation from the end side, in points (0-500).",
+      min: 0,
+      max: 500,
+      optional: true,
+    },
+    indentFirstLine: {
+      type: "integer",
+      label: "First Line Indent",
+      description: "Indentation of each paragraph's first line, in points (0-500).",
+      min: 0,
+      max: 500,
+      optional: true,
+    },
+    direction: {
+      type: "string",
+      label: "Text Direction",
+      description: "Reading direction of the paragraph. Unlike the other options this is not inherited, and defaults to `LEFT_TO_RIGHT` when unset.",
+      options: TEXT_DIRECTIONS,
+      optional: true,
+    },
+    spacingMode: {
+      type: "string",
+      label: "Spacing Mode",
+      description: "How paragraph spacing is rendered. `NEVER_COLLAPSE` always renders it; `COLLAPSE_LISTS` skips it between list items.",
+      options: SPACING_MODES,
+      optional: true,
+    },
+    bullets: {
+      type: "string",
+      label: "Bullets",
+      description: "Apply a bullet or numbering preset to the paragraphs, or `NONE` to strip existing bullets. `BULLET_*` presets are unordered, `NUMBERED_*` are ordered.",
+      options: [
+        BULLETS_NONE,
+        ...BULLET_PRESETS,
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      googleSlides,
+      presentationId,
+      objectId,
+      rowIndex,
+      columnIndex,
+      startIndex,
+      endIndex,
+      alignment,
+      lineSpacing,
+      spaceAbove,
+      spaceBelow,
+      indentStart,
+      indentEnd,
+      indentFirstLine,
+      direction,
+      spacingMode,
+      bullets,
+    } = this;
+
+    const builder = utils.styleBuilder();
+
+    builder.set("alignment", alignment);
+    builder.set("lineSpacing", lineSpacing);
+    builder.setDimension("spaceAbove", spaceAbove);
+    builder.setDimension("spaceBelow", spaceBelow);
+    builder.setDimension("indentStart", indentStart);
+    builder.setDimension("indentEnd", indentEnd);
+    builder.setDimension("indentFirstLine", indentFirstLine);
+    builder.set("direction", direction);
+    builder.set("spacingMode", spacingMode);
+
+    if (builder.isEmpty && !bullets) {
+      throw new ConfigurationError("Provide at least one formatting option (for example Alignment, Line Spacing, or Bullets).");
+    }
+    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 cellLocation = rowIndex != null
+      ? {
+        cellLocation: {
+          rowIndex,
+          columnIndex,
+        },
+      }
+      : {};
+
+    const requests = [];
+    if (builder.fields.length) {
+      requests.push({
+        updateParagraphStyle: {
+          objectId,
+          style: builder.style,
+          textRange,
+          fields: builder.mask,
+          ...cellLocation,
+        },
+      });
+    }
+    if (bullets === BULLETS_NONE) {
+      requests.push({
+        deleteParagraphBullets: {
+          objectId,
+          textRange,
+          ...cellLocation,
+        },
+      });
+    } else if (bullets) {
+      requests.push({
+        createParagraphBullets: {
+          objectId,
+          textRange,
+          bulletPreset: bullets,
+          ...cellLocation,
+        },
+      });
+    }
+
+    await googleSlides.batchUpdate(googleSlides.getPresentationId(presentationId), requests);
+
+    $.export("$summary", `Formatted paragraphs on element ${objectId}`);
+
+    return {
+      presentationId,
+      objectId,
+      fieldsUpdated: builder.fields,
+      requestsApplied: requests.map((request) => Object.keys(request)[0]),
+    };
+  },
+};

package/actions/format-shape/format-shape.mjs

@@ -0,0 +1,193 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleSlides from "../../google_slides.app.mjs";
+import utils from "../../common/utils.mjs";
+import {
+  DASH_STYLES, POINTS,
+} from "../../common/constants.mjs";
+
+export default {
+  key: "google_slides-format-shape",
+  name: "Format Shape",
+  description: "Set the background fill, outline, content alignment, or link of a shape in a Google Slides presentation. Use **Get Presentation** to find the shape's object ID. Shadow is not settable. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#UpdateShapePropertiesRequest)",
+  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 to format. Use **Get Presentation** and read `slides[].pageElements[].objectId`.",
+    },
+    backgroundColor: {
+      propDefinition: [
+        googleSlides,
+        "backgroundColor",
+      ],
+      description: "Fill color as a hex code (e.g. `#FF0000`) or a theme color name (e.g. `ACCENT1`).",
+    },
+    backgroundOpacity: {
+      propDefinition: [
+        googleSlides,
+        "backgroundOpacity",
+      ],
+      description: "Opacity of the 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.",
+    },
+    outlineColor: {
+      type: "string",
+      label: "Outline Color",
+      description: "Outline color as a 6-digit hex code (e.g. `#FF0000`) or one of the deck's theme colors (e.g. `ACCENT1`, `DARK1`).",
+      optional: true,
+    },
+    outlineOpacity: {
+      type: "integer",
+      label: "Outline Opacity",
+      description: "Opacity of the outline as a whole percentage, from `0` (fully transparent) to `100` (fully opaque).",
+      min: 0,
+      max: 100,
+      optional: true,
+    },
+    outlineWeight: {
+      type: "integer",
+      label: "Outline Weight",
+      description: "Outline thickness in points (1-100).",
+      min: 1,
+      max: 100,
+      optional: true,
+    },
+    outlineDashStyle: {
+      type: "string",
+      label: "Outline Dash Style",
+      description: "Dash pattern for the outline. One of `SOLID`, `DOT`, `DASH`, `DASH_DOT`, `LONG_DASH` or `LONG_DASH_DOT` - e.g. `DASH`.",
+      options: DASH_STYLES,
+      optional: true,
+    },
+    contentAlignment: {
+      propDefinition: [
+        googleSlides,
+        "contentAlignment",
+      ],
+    },
+    link: {
+      type: "string",
+      label: "Link URL",
+      description: "Make the shape link to this absolute URL, e.g. `https://example.com/report`.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      googleSlides,
+      presentationId,
+      objectId,
+      backgroundColor,
+      backgroundOpacity,
+      outlineColor,
+      outlineOpacity,
+      outlineWeight,
+      outlineDashStyle,
+      contentAlignment,
+      link,
+    } = this;
+
+    const shapeProperties = {};
+    const fields = [];
+
+    // Colour and opacity are independent: a mask can scope to `...solidFill.alpha`,
+    // so either can be set without disturbing the other.
+    const buildFill = (color, opacityPercent, label, maskPrefix) => {
+      if (!color && opacityPercent == null) {
+        return null;
+      }
+      const solidFill = utils.toSolidFill(color, opacityPercent);
+      if (!solidFill) {
+        throw new ConfigurationError(`${label} "${color}" 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\`.`);
+      }
+      if (solidFill.color) {
+        fields.push(`${maskPrefix}.color`);
+      }
+      if (solidFill.alpha != null) {
+        fields.push(`${maskPrefix}.alpha`);
+      }
+      return solidFill;
+    };
+
+    const backgroundFill = buildFill(
+      backgroundColor, backgroundOpacity, "Background Color", "shapeBackgroundFill.solidFill",
+    );
+    if (backgroundFill) {
+      shapeProperties.shapeBackgroundFill = {
+        solidFill: backgroundFill,
+      };
+    }
+
+    const outlineFill = buildFill(
+      outlineColor, outlineOpacity, "Outline Color", "outline.outlineFill.solidFill",
+    );
+    if (outlineFill || outlineWeight != null || outlineDashStyle) {
+      shapeProperties.outline = {};
+      if (outlineFill) {
+        shapeProperties.outline.outlineFill = {
+          solidFill: outlineFill,
+        };
+      }
+      if (outlineWeight != null) {
+        shapeProperties.outline.weight = {
+          magnitude: outlineWeight,
+          unit: POINTS,
+        };
+        fields.push("outline.weight");
+      }
+      if (outlineDashStyle) {
+        shapeProperties.outline.dashStyle = outlineDashStyle;
+        fields.push("outline.dashStyle");
+      }
+    }
+
+    if (contentAlignment) {
+      shapeProperties.contentAlignment = contentAlignment;
+      fields.push("contentAlignment");
+    }
+
+    if (link) {
+      shapeProperties.link = {
+        url: link,
+      };
+      fields.push("link");
+    }
+
+    if (!fields.length) {
+      throw new ConfigurationError("Provide at least one formatting option (for example Background Color, Background Opacity, Outline Color, or Content Alignment).");
+    }
+
+    await googleSlides.batchUpdate(googleSlides.getPresentationId(presentationId), [
+      {
+        updateShapeProperties: {
+          objectId,
+          shapeProperties,
+          fields: fields.join(","),
+        },
+      },
+    ]);
+
+    $.export("$summary", `Formatted shape ${objectId}`);
+
+    return {
+      presentationId,
+      objectId,
+      fieldsUpdated: fields,
+    };
+  },
+};

package/actions/format-slide-background/format-slide-background.mjs

@@ -0,0 +1,74 @@
+import { ConfigurationError } from "@pipedream/platform";
+import googleSlides from "../../google_slides.app.mjs";
+import utils from "../../common/utils.mjs";
+
+export default {
+  key: "google_slides-format-slide-background",
+  name: "Format Slide Background",
+  description: "Set the background fill of a single slide in a Google Slides presentation. Use **Get Presentation** to find the slide's object ID. [See the documentation](https://developers.google.com/workspace/slides/api/reference/rest/v1/presentations/request#UpdatePagePropertiesRequest)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    googleSlides,
+    presentationId: {
+      propDefinition: [
+        googleSlides,
+        "staticPresentationId",
+      ],
+    },
+    slideId: {
+      propDefinition: [
+        googleSlides,
+        "staticSlideId",
+      ],
+    },
+    backgroundColor: {
+      propDefinition: [
+        googleSlides,
+        "backgroundColor",
+      ],
+      description: "Slide background as a hex code (e.g. `#102A43`) or a theme color name (e.g. `DARK1`).",
+      optional: false,
+    },
+  },
+  async run({ $ }) {
+    const {
+      googleSlides,
+      presentationId,
+      slideId,
+      backgroundColor,
+    } = this;
+
+    const solidFill = utils.toSolidFill(backgroundColor);
+    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 \`#102A43\`, or a theme color such as \`DARK1\`.`);
+    }
+
+    await googleSlides.batchUpdate(googleSlides.getPresentationId(presentationId), [
+      {
+        updatePageProperties: {
+          objectId: slideId,
+          pageProperties: {
+            pageBackgroundFill: {
+              solidFill,
+            },
+          },
+          fields: "pageBackgroundFill.solidFill.color",
+        },
+      },
+    ]);
+
+    $.export("$summary", `Set background of slide ${slideId}`);
+
+    return {
+      presentationId,
+      slideId,
+      backgroundColor,
+    };
+  },
+};