New Components - klipy (#15683)

* klipy init

* Klipy #15496
Actions
 - Search Clips
 - Search GIFs
 - Search Stickers
 - Get Clip By Slug
 - Get GIF By Slug
 - Get Sticker By Slug

* pnpm update

* fix actions key name and description

Author: luancazarine

components/klipy/actions/common/base-get-by-slug.mjs

@@ -0,0 +1,27 @@
+import klipy from "../../klipy.app.mjs";
+
+export default {
+  props: {
+    klipy,
+    customerId: {
+      propDefinition: [
+        klipy,
+        "customerId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const model = this.getModel();
+    const response = await this.klipy.search({
+      $,
+      model,
+      slug: this.slug,
+      data: {
+        customer_id: this.customerId,
+      },
+    });
+
+    $.export("$summary", `Successfully fetched ${model}.`);
+    return response;
+  },
+};

components/klipy/actions/common/base-search.mjs

@@ -0,0 +1,37 @@
+import { LIMIT } from "../../common/constants.mjs";
+import klipy from "../../klipy.app.mjs";
+
+export default {
+  props: {
+    klipy,
+    locale: {
+      propDefinition: [
+        klipy,
+        "locale",
+      ],
+      optional: true,
+    },
+    page: {
+      propDefinition: [
+        klipy,
+        "page",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const model = this.getModel();
+    const response = await this.klipy.search({
+      $,
+      model,
+      data: {
+        q: this.q,
+        customer_id: this.customer_id,
+        locale: this.locale,
+        page: this.page,
+        per_page: LIMIT,
+      },
+    });
+    $.export("$summary", `Retrieved ${response.data.data.length} ${model}`);
+    return response;
+  },
+};

components/klipy/actions/get-clip-by-slug/get-clip-by-slug.mjs

@@ -0,0 +1,24 @@
+import common from "../common/base-get-by-slug.mjs";
+
+export default {
+  ...common,
+  key: "klipy-get-clip-by-slug",
+  name: "Get Clip by Slug",
+  description: "Get a specific Clip idendified by its slug. [See the documentation](https://docs.klipy.com/clips-api/clips-search-api)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    slug: {
+      propDefinition: [
+        common.props.klipy,
+        "slug",
+      ],
+    },
+  },
+  methods: {
+    getModel() {
+      return "clips";
+    },
+  },
+};

components/klipy/actions/get-gif-by-slug/get-gif-by-slug.mjs

@@ -0,0 +1,25 @@
+import common from "../common/base-get-by-slug.mjs";
+
+export default {
+  ...common,
+  key: "klipy-get-gif-by-slug",
+  name: "Get GIF by Slug",
+  description: "Get a specific GIF idendified by its slug. [See the documentation](https://docs.klipy.com/gifs-api/gifs-search-api)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    slug: {
+      propDefinition: [
+        common.props.klipy,
+        "slug",
+      ],
+      description: "The slug of the GIF.",
+    },
+  },
+  methods: {
+    getModel() {
+      return "gifs";
+    },
+  },
+};

components/klipy/actions/get-sticker-by-slug/get-sticker-by-slug.mjs

@@ -0,0 +1,25 @@
+import common from "../common/base-get-by-slug.mjs";
+
+export default {
+  ...common,
+  key: "klipy-get-sticker-by-slug",
+  name: "Get Sticker By Slug",
+  description: "Get a specific Sticker idendified by its slug. [See the documentation](https://docs.klipy.com/stickers-api/stickers-search-api).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    slug: {
+      propDefinition: [
+        common.props.klipy,
+        "slug",
+      ],
+      description: "The slug of the sticker.",
+    },
+  },
+  methods: {
+    getModel() {
+      return "stickers";
+    },
+  },
+};

components/klipy/actions/search-clips/search-clips.mjs

@@ -0,0 +1,30 @@
+import common from "../common/base-search.mjs";
+
+export default {
+  ...common,
+  key: "klipy-search-clips",
+  name: "Search Clips",
+  description: "Search and retrieve clips from Klipy's database. [See the documentation](https://docs.klipy.com/clips-api/clips-search-api)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    q: {
+      propDefinition: [
+        common.props.klipy,
+        "q",
+      ],
+    },
+    customer_id: {
+      propDefinition: [
+        common.props.klipy,
+        "customerId",
+      ],
+    },
+  },
+  methods: {
+    getModel() {
+      return "clips";
+    },
+  },
+};

components/klipy/actions/search-gifs/search-gifs.mjs

@@ -0,0 +1,32 @@
+import common from "../common/base-search.mjs";
+
+export default {
+  ...common,
+  key: "klipy-search-gifs",
+  name: "Search GIFs",
+  description: "Search and retrieve GIFs from Klipy's database. [See the documentation](https://docs.klipy.com/gifs-api/gifs-search-api)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    q: {
+      propDefinition: [
+        common.props.klipy,
+        "q",
+      ],
+      description: "The search keyword for finding relevant GIFs.",
+    },
+    customer_id: {
+      propDefinition: [
+        common.props.klipy,
+        "customerId",
+      ],
+      description: "A unique user identifier in your system for GIFs.",
+    },
+  },
+  methods: {
+    getModel() {
+      return "gifs";
+    },
+  },
+};

components/klipy/actions/search-stickers/search-stickers.mjs

@@ -0,0 +1,32 @@
+import common from "../common/base-search.mjs";
+
+export default {
+  ...common,
+  key: "klipy-search-stickers",
+  name: "Search Stickers",
+  description: "Search and retrieve stickers from Klipy's database. [See the documentation](https://docs.klipy.com/stickers-api/stickers-search-api).",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    ...common.props,
+    q: {
+      propDefinition: [
+        common.props.klipy,
+        "q",
+      ],
+      description: "The search keyword for finding relevant stickers.",
+    },
+    customer_id: {
+      propDefinition: [
+        common.props.klipy,
+        "customerId",
+      ],
+      description: "A unique user identifier in your system for stickers.",
+    },
+  },
+  methods: {
+    getModel() {
+      return "stickers";
+    },
+  },
+};

components/klipy/common/constants.mjs

@@ -0,0 +1 @@
+export const LIMIT = 50;

components/klipy/klipy.app.mjs

@@ -1,11 +1,56 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "klipy",
-  propDefinitions: {},
+  propDefinitions: {
+    q: {
+      type: "string",
+      label: "Search Query",
+      description: "The search keyword for finding relevant clips.",
+    },
+    customerId: {
+      type: "string",
+      label: "Customer ID",
+      description: "A unique user identifier in your system for clips.",
+    },
+    locale: {
+      type: "string",
+      label: "Locale",
+      description: "Country code / language of the customer (ISO 3166 Alpha-2)",
+      optional: true,
+    },
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The requested page number.",
+      default: 1,
+    },
+    slug: {
+      type: "string",
+      label: "Slug",
+      description: "The slug of the clip.",
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return `https://api.klipy.co/api/v1/${this.$auth.app_key}`;
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: this._baseUrl() + path,
+        ...opts,
+      });
+    },
+    search({
+      model, slug = "search", ...opts
+    }) {
+      return this._makeRequest({
+        path: `/${model}/${slug}`,
+        ...opts,
+      });
     },
   },
 };