@foxtware/mineral 0.1.0

package/api/yotpo/yotpoCustomerUpsert.js

@@ -0,0 +1,91 @@
+// https://loyaltyapi.yotpo.com/reference/createupdate-customer-records
+
+const { credsFromPayload, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['email'],
+]);
+
+const yotpoCustomerUpsert = async (
+  credsPayload,
+  email,
+  {
+    apiVersion,
+   
+    id,
+    firstName,
+    lastName,
+    phoneNumber,
+    countryIsoCode,
+    hasAccount,
+    platformAccountCreatedAt,
+    optedIn,
+    posAccountId,
+    tags,
+    optedInAt,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    email,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const body = {
+    email,
+    ...(id && { id }),
+    ...(firstName && { first_name: firstName }),
+    ...(lastName && { last_name: lastName }),
+    ...(phoneNumber && { phone_number: phoneNumber }),
+    ...(countryIsoCode && { country_iso_code: countryIsoCode }),
+    ...(hasAccount !== undefined && { has_account: hasAccount }),
+    ...(platformAccountCreatedAt && { platform_account_created_at: platformAccountCreatedAt }),
+    ...(optedIn !== undefined && { opted_in: optedIn }),
+    ...(posAccountId && { pos_account_id: posAccountId }),
+    ...(tags && { tags }),
+    ...(optedInAt && { opted_in_at: optedInAt }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/customers',
+    method: 'post',
+    body,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCustomerUpsert,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCustomerUpsert" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.johto" },
+    "email": "ash@pokemail.com",
+    "options": {
+      "id": "1",
+      "firstName": "Ash",
+      "lastName": "Ketchum"
+    }
+  }'
+*/

package/api/yotpo/yotpoCustomersRecentGet.js

@@ -0,0 +1,62 @@
+// https://loyaltyapi.yotpo.com/reference/fetch-all-recently-updated-customers
+
+const { credsFromPayload, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const yotpoCustomersRecentGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    pageInfo,
+    perPage,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const params = {
+    ...(pageInfo && { page_info: pageInfo }),
+    ...(perPage !== undefined && { per_page: perPage }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/customers/recent',
+    params,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoCustomersRecentGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoCustomersRecentGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "options": {
+      "perPage": 10
+    }
+  }'
+*/

package/api/yotpo/yotpoRedemptionCreate.js

@@ -0,0 +1,96 @@
+// https://loyaltyapi.yotpo.com/reference/create-redemption
+
+const { credsFromPayload, objHasAny, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const customerIdentifierValidator = (customerIdentifier) => {
+  return objHasAny(customerIdentifier, [
+    'customerId',
+    'customerEmail',
+    'phoneNumber',
+    'posAccountId',
+  ]);
+};
+
+const redemptionOptionIdValidator = Number;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['customerIdentifier', customerIdentifierValidator],
+  ['redemptionOptionId', redemptionOptionIdValidator],
+]);
+
+const yotpoRedemptionCreate = async (
+  credsPayload,
+  customerIdentifier,
+  // redemptionOptionId must come from yotpoRedemptionOptionsGet
+  redemptionOptionId,
+  {
+    apiVersion,
+    delayPointsDeduction,
+    currency,
+    pointsToRedeem,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    customerIdentifier,
+    redemptionOptionId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const {
+    customerId,
+    customerEmail,
+    phoneNumber,
+    posAccountId,
+  } = customerIdentifier;
+
+  const body = {
+    redemption_option_id: Number(redemptionOptionId),
+    ...(customerId && { customer_id: customerId }),
+    ...(customerEmail && { customer_email: customerEmail }),
+    ...(phoneNumber && { phone_number: phoneNumber }),
+    ...(posAccountId && { pos_account_id: posAccountId }),
+    ...(delayPointsDeduction !== undefined && { delay_points_deduction: delayPointsDeduction }),
+    ...(currency && { currency }),
+    ...(pointsToRedeem !== undefined && { points_to_redeem: Number(pointsToRedeem) }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/redemptions',
+    method: 'post',
+    body,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoRedemptionCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoRedemptionCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "customerIdentifier": { "customerEmail": "john@whitefoxboutique.com" },
+    "redemptionOptionId": 111111
+  }'
+*/

package/api/yotpo/yotpoRedemptionOptionsGet.js

@@ -0,0 +1,78 @@
+// https://loyaltyapi.yotpo.com/reference/fetch-active-redemption-options
+
+const { credsFromPayload, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const yotpoRedemptionOptionsGet = async (
+  credsPayload,
+  {
+    apiVersion,
+    isOffline,
+    discountType,
+    customerIdentifier,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const {
+    customerId,
+    customerEmail,
+    phoneNumber,
+  } = customerIdentifier ?? {};
+
+  const params = {
+    ...(isOffline !== undefined && { is_offline: isOffline }),
+    ...(discountType && { discount_type: discountType }),
+    ...(customerId && { customer_id: customerId }),
+    ...(customerEmail && { customer_email: customerEmail }),
+    ...(phoneNumber && { phone_number: phoneNumber }),
+  };
+
+  const response = await yotpoClient.fetch({
+    url: '/redemption_options',
+    params,
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoRedemptionOptionsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoRedemptionOptionsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" }
+  }'
+
+curl -X POST "http://localhost:8000/yotpoRedemptionOptionsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" },
+    "options": {
+      "customerIdentifier": { "customerEmail": "john@whitefoxboutique.com" }
+    }
+  }'
+*/

package/api/yotpo/yotpoVipTiersGet.js

@@ -0,0 +1,51 @@
+// https://loyaltyapi.yotpo.com/reference/fetch-vip-tiers
+
+const { credsFromPayload, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { yotpoClient } = require('../yotpo/yotpo.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const yotpoVipTiersGet = async (
+  credsPayload,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+
+  const response = await yotpoClient.fetch({
+    url: '/vip_tiers',
+    context: {
+      creds,
+      apiVersion,
+    },
+  });
+
+  return response;
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  yotpoVipTiersGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/yotpoVipTiersGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "yotpo.au" }
+  }'
+*/

package/api/youtube/youtubeChannelVideosGet.js

@@ -0,0 +1,249 @@
+// https://developers.google.com/youtube/v3/guides/implementation/videos
+
+const { FetchClient, credsFromPayload, ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+
+const YOUTUBE_API_BASE = 'https://www.googleapis.com/youtube/v3';
+
+const parseChannelHandle = (channelHandle) => {
+  const trimmed = channelHandle.trim();
+
+  if (trimmed.startsWith('@')) {
+    return trimmed.slice(1);
+  }
+
+  return trimmed;
+};
+
+const youtubeClient = new FetchClient({
+  requestPreparer: async (requestPayload, context) => {
+    const { creds } = context;
+    const { API_KEY } = creds;
+
+    return {
+      ...requestPayload,
+      params: {
+        key: API_KEY,
+        ...requestPayload.params,
+      },
+    };
+  },
+  responseInterpreter: async (response) => {
+    if (!response.ok) {
+      const youtubeError = response.error?.details?.error;
+
+      if (youtubeError) {
+        return {
+          ok: false,
+          error: {
+            code: youtubeError.code,
+            message: youtubeError.message,
+            details: youtubeError,
+          },
+        };
+      }
+
+      return response;
+    }
+
+    const { data } = response;
+
+    if (data?.error) {
+      return {
+        ok: false,
+        error: {
+          code: data.error.code,
+          message: data.error.message,
+          details: data.error,
+        },
+      };
+    }
+
+    return response;
+  },
+});
+
+const formatVideo = (video) => {
+  const {
+    id,
+    snippet = {},
+    statistics = {},
+    contentDetails = {},
+  } = video;
+
+  return {
+    id,
+    title: snippet.title,
+    description: snippet.description,
+    publishedAt: snippet.publishedAt,
+    thumbnails: snippet.thumbnails,
+    viewCount: statistics.viewCount,
+    likeCount: statistics.likeCount,
+    commentCount: statistics.commentCount,
+    duration: contentDetails.duration,
+  };
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['channelHandle'],
+]);
+
+const youtubeChannelVideosGet = async (
+  credsPayload,
+  channelHandle,
+  {
+    maxVideos,
+    inspect = false,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    channelHandle,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const creds = await credsFromPayload(credsPayload);
+  const fetchContext = { creds };
+  const handle = parseChannelHandle(channelHandle);
+
+  const channelResponse = await youtubeClient.fetch({
+    url: `${ YOUTUBE_API_BASE }/channels`,
+    params: {
+      part: 'contentDetails',
+      forHandle: handle,
+    },
+    context: fetchContext,
+    inspect,
+  });
+
+  if (!channelResponse.ok) {
+    return channelResponse;
+  }
+
+  const channel = channelResponse.data?.items?.[0];
+  const channelId = channel?.id;
+  const uploadsPlaylistId = channel?.contentDetails?.relatedPlaylists?.uploads;
+
+  if (!channelId) {
+    return {
+      ok: false,
+      error: {
+        code: 'CHANNEL_NOT_FOUND',
+        message: `No channel found for handle @${ handle }`,
+      },
+    };
+  }
+
+  if (!uploadsPlaylistId) {
+    return {
+      ok: false,
+      error: {
+        code: 'UPLOADS_PLAYLIST_NOT_FOUND',
+        message: `No uploads playlist found for channel ${ channelId }`,
+      },
+    };
+  }
+
+  const videoIds = [];
+  let nextPageToken;
+
+  while (true) {
+    const playlistResponse = await youtubeClient.fetch({
+      url: `${ YOUTUBE_API_BASE }/playlistItems`,
+      params: {
+        part: 'contentDetails',
+        playlistId: uploadsPlaylistId,
+        maxResults: 50,
+        ...(nextPageToken ? { pageToken: nextPageToken } : {}),
+      },
+      context: fetchContext,
+      inspect,
+    });
+
+    if (!playlistResponse.ok) {
+      return playlistResponse;
+    }
+
+    const pageVideoIds = (playlistResponse.data?.items ?? [])
+      .map((item) => item.contentDetails?.videoId)
+      .filter(Boolean);
+
+    videoIds.push(...pageVideoIds);
+
+    if (maxVideos && videoIds.length >= maxVideos) {
+      videoIds.splice(maxVideos);
+      break;
+    }
+
+    nextPageToken = playlistResponse.data?.nextPageToken;
+
+    if (!nextPageToken) {
+      break;
+    }
+  }
+
+  if (!videoIds.length) {
+    return {
+      ok: true,
+      data: {
+        channelId,
+        videos: [],
+      },
+    };
+  }
+
+  const videos = [];
+
+  for (let index = 0; index < videoIds.length; index += 50) {
+    const batchIds = videoIds.slice(index, index + 50).join(',');
+
+    const videosResponse = await youtubeClient.fetch({
+      url: `${ YOUTUBE_API_BASE }/videos`,
+      params: {
+        part: 'snippet,statistics,contentDetails',
+        id: batchIds,
+      },
+      context: fetchContext,
+      inspect,
+    });
+
+    if (!videosResponse.ok) {
+      return videosResponse;
+    }
+
+    videos.push(
+      ...(videosResponse.data?.items ?? []).map(formatVideo),
+    );
+  }
+
+  return {
+    ok: true,
+    data: {
+      channelId,
+      videos,
+    },
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  youtubeChannelVideosGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/youtubeChannelVideosGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "youtube" },
+    "channelHandle": "garyseconomics",
+    "options": { "maxVideos": 5 }
+  }'
+*/

package/bin/mineral.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const { startServer } = require('../server');
+
+startServer();

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@foxtware/mineral",
+  "version": "0.1.0",
+  "bin": { "mineral": "bin/mineral.js" },
+  "main": "server.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "creds_to_env": "node _build_scripts/copyCredsToEnv.js",
+    "dev": "node --watch --watch-path=./api --watch-path=./server.js --watch-path=./server.utils.js --watch-path=./.creds.yml server.js",
+    "new": "node _build_scripts/createNewFunction.js",
+    "serve": "PORT=8100 node server.js",
+    "start": "node server.js",
+    "npm:publish": "npm publish"
+  },
+  "dependencies": {
+    "csvtojson": "^2.0.14",
+    "dotenv": "^17.2.0",
+    "json-2-csv": "^5.5.9",
+    "xml2js": "^0.6.2",
+    "yaml": "^2.9.0"
+  }
+}