@foxtware/mineral 0.1.9 → 0.1.10

package/api/stripe/stripeRefundCreate.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/refunds/create
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -26,17 +26,17 @@ const stripeRefundCreate = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/refunds',
-    method: 'post',
-    body: {
-      charge: chargeId,
-      ...amountCents && { amount: amountCents },
-      ...reason && { reason },
+    requestPayload: {
+      url: '/refunds',
+      method: 'post',
+      body: {
+        charge: chargeId,
+        ...amountCents && { amount: amountCents },
+        ...reason && { reason },
+      },
     },
-    context: { creds },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeRefundGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/refunds/retrieve
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -22,11 +22,11 @@ const stripeRefundGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: `/refunds/${ refundId }`,
-    context: { creds },
+    requestPayload: {
+      url: `/refunds/${ refundId }`,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeRefundsGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/refunds/list
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -20,12 +20,12 @@ const stripeRefundsGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: '/refunds',
-    params,
-    context: { creds },
+    requestPayload: {
+      url: '/refunds',
+      params,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stripe/stripeTokenGet.js

@@ -1,6 +1,6 @@
 // https://docs.stripe.com/api/tokens/retrieve
 
-const { credsFromPayload, ArgsWarden } = require('../utils');
+const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
 const { stripeClient } = require('../stripe/stripe.utils');
 
@@ -22,11 +22,11 @@ const stripeTokenGet = async (
     return rejectResponse;
   }
 
-  const creds = await credsFromPayload(credsPayload);
-
   const response = await stripeClient.fetch({
-    url: `/tokens/${ tokenId }`,
-    context: { creds },
+    requestPayload: {
+      url: `/tokens/${ tokenId }`,
+    },
+    context: { credsPayload },
   });
 
   return response;

package/api/stylearcade/stylearcade.constants.js

@@ -0,0 +1,5 @@
+const MAX_PER_PAGE = 100;
+
+module.exports = {
+  MAX_PER_PAGE,
+};

package/api/stylearcade/stylearcade.utils.js

@@ -0,0 +1,40 @@
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const useStylearcadeBaseUrl = async (state) => {
+  const { creds } = state.context;
+  return useBaseUrl(creds.BASE_URL)(state);
+};
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const { API_KEY } = creds;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        'Api-Key': API_KEY,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const stylearcadeClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useStylearcadeBaseUrl,
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
+});
+
+module.exports = {
+  stylearcadeClient,
+};

package/api/stylearcade/stylearcadeDataGet.js

@@ -0,0 +1,62 @@
+// https://stylearcade.gitlab.io/api-docs/range-plan
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stylearcadeGet, stylearcadeGetter } = require('../stylearcade/stylearcadeGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const stylearcadeDataGet = async (
+  credsPayload,
+  options = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return stylearcadeGet(credsPayload, {
+    nodeName: 'records',
+    ...options,
+  });
+};
+
+const stylearcadeDataGetter = async (
+  credsPayload,
+  options = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return stylearcadeGetter(credsPayload, {
+    nodeName: 'records',
+    ...options,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stylearcadeDataGet,
+  stylearcadeDataGetter,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stylearcadeDataGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stylearcade" },
+    "options": {
+      "limit": 2000
+    }
+  }'
+*/

package/api/stylearcade/stylearcadeGet.js

@@ -0,0 +1,133 @@
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stylearcadeClient } = require('../stylearcade/stylearcade.utils');
+const { MAX_PER_PAGE } = require('../stylearcade/stylearcade.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const stylearcadeGetPacket = async (
+  credsPayload,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    url = '/export',
+  } = {},
+) => {
+  return stylearcadeClient.fetch({
+    requestPayload: {
+      url,
+      params: {
+        limit: perPage,
+        ...params,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const stylearcadeGetPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const { nextCursor } = response.data || {};
+
+  if (!nextCursor) {
+    return [true];
+  }
+
+  const { args, options } = currentParams;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      params: {
+        ...options.params,
+        cursor: nextCursor,
+      },
+    },
+  }];
+};
+
+const stylearcadeGetDigester = (response, nodeName) => {
+  if (!response?.ok) {
+    return [];
+  }
+
+  return response?.data?.[nodeName] ?? [];
+};
+
+const stylearcadeGet = async (
+  returnGetter,
+
+  credsPayload,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    nodeName = 'records',
+    url = '/export',
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload],
+      options: {
+        params,
+        perPage,
+        url,
+      },
+    },
+    {
+      func: stylearcadeGetPacket,
+      digester: (response) => stylearcadeGetDigester(response, nodeName),
+      paginator: stylearcadeGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stylearcadeGet: (...args) => stylearcadeGet(false, ...args),
+  stylearcadeGetter: (...args) => stylearcadeGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stylearcadeGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stylearcade" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/stylearcade/stylearcadeMetadataGet.js

@@ -0,0 +1,47 @@
+// https://stylearcade.gitlab.io/api-docs/range-plan
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { stylearcadeClient } = require('../stylearcade/stylearcade.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const stylearcadeMetadataGet = async (
+  credsPayload,
+  options = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return stylearcadeClient.fetch({
+    requestPayload: {
+      url: '/metadata',
+      ...options.params && { params: options.params },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  stylearcadeMetadataGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/stylearcadeMetadataGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "stylearcade" }
+  }'
+*/

package/api/threeclicks/threeclicks.constants.js

@@ -0,0 +1,8 @@
+const API_BASE_PATH = '/api-user/v1';
+
+const API_REFERENCE_URL = 'https://g40-server.instance.3clickscloud.com/swagger-ui/index.html';
+
+module.exports = {
+  API_BASE_PATH,
+  API_REFERENCE_URL,
+};

package/api/threeclicks/threeclicks.utils.js

@@ -0,0 +1,119 @@
+const crypto = require('crypto');
+const { API_BASE_PATH } = require('../threeclicks/threeclicks.constants');
+const { resolveCreds } = require('../pipelineSteps');
+const {
+  FetchClient,
+  appendUrlToBase,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const nowAsUnixTimestamp = () => Math.floor(Date.now() / 1000);
+
+const threeclicksSignatureCalculate = ({
+  creds,
+  method,
+  data,
+}) => {
+  const {
+    API_KEY,
+    API_SECRET,
+  } = creds;
+
+  const timestamp = nowAsUnixTimestamp();
+  const stitchedString = `${ API_KEY }${ API_SECRET }${ method }${
+    data ? JSON.stringify(data) : ''
+  }${ timestamp }`;
+
+  const signature = crypto
+    .createHmac('sha256', API_SECRET)
+    .update(stitchedString)
+    .digest('hex');
+
+  return {
+    signature,
+    timestamp,
+  };
+};
+
+const getSignatureData = (requestPayload) => {
+  const method = (requestPayload.method || 'get').toLowerCase();
+
+  if (method === 'get') {
+    return requestPayload.params ?? {};
+  }
+
+  return requestPayload.body ?? {};
+};
+
+const useThreeclicksUrlAndAuth = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const {
+    API_KEY,
+    API_DOMAIN,
+  } = creds;
+
+  const method = (requestPayload.method || 'get').toLowerCase();
+  const signatureData = getSignatureData({
+    ...requestPayload,
+    method,
+  });
+
+  const { signature, timestamp } = threeclicksSignatureCalculate({
+    creds,
+    method,
+    data: signatureData,
+  });
+
+  const baseUrl = `https://${ API_DOMAIN }${ API_BASE_PATH }`;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      method,
+      url: appendUrlToBase(baseUrl, requestPayload.url),
+      headers: {
+        'X-Api-Key': API_KEY,
+        'X-Api-Signature': signature,
+        'X-Api-Timestamp': String(timestamp),
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const interpretThreeclicksResponse = async (state) => {
+  const { response } = state;
+  const { success, message } = response?.data?.result ?? {};
+
+  if (response?.ok && success === false) {
+    return {
+      response: {
+        ok: false,
+        error: {
+          message,
+          details: response.data?.result,
+        },
+      },
+      breakChain: true,
+    };
+  }
+
+  return {};
+};
+
+const threeclicksClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useThreeclicksUrlAndAuth,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+    interpretThreeclicksResponse,
+  ],
+});
+
+module.exports = {
+  threeclicksClient,
+  threeclicksSignatureCalculate,
+  getSignatureData,
+};

package/api/threeclicks/threeclicksCollectionsGet.js

@@ -0,0 +1,40 @@
+// https://g40-server.instance.3clickscloud.com/swagger-ui/index.html#operations-v1_-_Site_Settings_>_Style-list_5
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { threeclicksClient } = require('../threeclicks/threeclicks.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const threeclicksCollectionsGet = async (credsPayload) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) return rejectResponse;
+  return threeclicksClient.fetch({
+    requestPayload: {
+      url: '/site-settings/style/collection',
+      method: 'get',
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  threeclicksCollectionsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/threeclicksCollectionsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "threeclicks" }
+  }'
+*/

package/api/threeclicks/threeclicksGet.js

@@ -0,0 +1,138 @@
+// https://g40-server.instance.3clickscloud.com/swagger-ui/index.html#operations-tag-v1_-_Search_>_Advanced
+
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { threeclicksClient } = require('../threeclicks/threeclicks.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+]);
+
+const threeclicksGetPacket = async (
+  credsPayload,
+  url,
+  {
+    params,
+    page = '1',
+  } = {},
+) => {
+  const paramsWithPage = {
+    ...params,
+    page: String(page),
+  };
+
+  return threeclicksClient.fetch({
+    requestPayload: {
+      url,
+      method: 'get',
+      params: paramsWithPage,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const threeclicksGetPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const pageCount = response?.data?.content?.pagination_data?.page_count;
+  const currentPage = parseInt(currentParams.options.page, 10);
+
+  if (!pageCount || currentPage >= pageCount) {
+    return [true];
+  }
+
+  const { args, options } = currentParams;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      page: String(currentPage + 1),
+    },
+  }];
+};
+
+const threeclicksGetDigester = (response) => {
+  if (!response?.ok) {
+    return [];
+  }
+
+  return response?.data?.content?.pagination_data?.result_data ?? [];
+};
+
+const threeclicksGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    params,
+    page = '1',
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url],
+      options: {
+        params,
+        page,
+      },
+    },
+    {
+      func: threeclicksGetPacket,
+      digester: threeclicksGetDigester,
+      paginator: threeclicksGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  threeclicksGet: (...args) => threeclicksGet(false, ...args),
+  threeclicksGetter: (...args) => threeclicksGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/threeclicksGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "threeclicks" },
+    "url": "/search/advanced/style",
+    "options": {
+      "params": {
+        "mode": "all"
+      }
+    }
+  }'
+*/