@foxtware/mineral 0.1.28 → 0.1.29

package/api/dropbox/dropboxSpaceUsageGet.js

@@ -0,0 +1,55 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#users-get_space_usage
+
+const { ArgsWarden, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxClient } = require('../dropbox/dropbox.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const dropboxSpaceUsageGet = async (
+  credsPayload,
+  {
+    fetchClient = dropboxClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: '/users/get_space_usage',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: 'null',
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxSpaceUsageGet,
+  funcApiConfig,
+};

package/api/dropbox/dropboxTemporaryLinkGet.js

@@ -0,0 +1,75 @@
+// https://www.dropbox.com/developers/documentation/http/documentation#files-get_temporary_link
+
+const { ArgsWarden, actionSingleOrMultiple, logDeep } = require('../utils');
+const { credsValidator } = require('../validators');
+const { dropboxClient } = require('../dropbox/dropbox.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['path'],
+]);
+
+const dropboxTemporaryLinkGetSingle = async (
+  credsPayload,
+  path,
+  {
+    fetchClient = dropboxClient,
+  } = {},
+) => {
+  const response = await fetchClient.fetch({
+    context: { credsPayload },
+    requestPayload: {
+      method: 'post',
+      url: '/files/get_temporary_link',
+      body: { path },
+    },
+  });
+
+  const { ok, data, error } = response;
+  if (!ok) {
+    logDeep({ error });
+    return { ok: false, error };
+  }
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const dropboxTemporaryLinkGet = async (
+  credsPayload,
+  path,
+  {
+    queueRunOptions,
+    fetchClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    path,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    path,
+    dropboxTemporaryLinkGetSingle,
+    (pathItem) => ({
+      args: [credsPayload, pathItem, { fetchClient }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  dropboxTemporaryLinkGet,
+  funcApiConfig,
+};

package/api/google/docs.md

@@ -5,3 +5,4 @@ Service account auth via `SERVICE_ACCOUNT_JSON` on the `google` creds path. Uses
 - [Sheets API](https://developers.google.com/workspace/sheets/api/reference/rest)
 - [Drive API](https://developers.google.com/workspace/drive/api/reference/rest/v3)
 - [Calendar API](https://developers.google.com/workspace/calendar/api/v3/reference)
+- [Analytics Data API](https://developers.google.com/analytics/devguides/reporting/data/v1/rest)

package/api/google/google.constants.js

@@ -2,6 +2,7 @@ const GOOGLE_SCOPES = {
   sheets: ['https://www.googleapis.com/auth/spreadsheets'],
   drive: ['https://www.googleapis.com/auth/drive'],
   calendar: ['https://www.googleapis.com/auth/calendar'],
+  analytics: ['https://www.googleapis.com/auth/analytics'],
 };
 
 module.exports = {

package/api/google/google.utils.js

@@ -108,6 +108,26 @@ const getGoogleCalendar = async (
   };
 };
 
+const getGoogleAnalyticsData = async (
+  credsPayload,
+  {
+    subject,
+  } = {},
+) => {
+  const { auth, error } = await getGoogleAuth(credsPayload, {
+    scopes: GOOGLE_SCOPES.analytics,
+    subject,
+  });
+
+  if (error) {
+    return { error };
+  }
+
+  return {
+    client: google.analyticsdata({ version: 'v1beta', auth }),
+  };
+};
+
 const googleApiCall = async (promiseFn) => {
   try {
     const response = await promiseFn();
@@ -132,6 +152,7 @@ module.exports = {
   getGoogleSheets,
   getGoogleDrive,
   getGoogleCalendar,
+  getGoogleAnalyticsData,
   googleApiCall,
   invalidCredsResponse,
 };

package/api/google/googleanalyticsMetadataGet.js

@@ -0,0 +1,62 @@
+// https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/getMetadata
+
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { getGoogleAnalyticsData, googleApiCall } = require('../google/google.utils');
+
+const propertyIdentifierValidator = (propertyIdentifier) => {
+  return objHasAny(propertyIdentifier, ['propertyId', 'property']);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['propertyIdentifier', propertyIdentifierValidator],
+]);
+
+const googleanalyticsMetadataGet = async (
+  credsPayload,
+  propertyIdentifier,
+  {
+    subject,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    propertyIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { propertyId, property } = propertyIdentifier;
+  const propertyName = property ?? `properties/${ propertyId }`;
+
+  const { client, error } = await getGoogleAnalyticsData(credsPayload, { subject });
+
+  if (error) {
+    return error;
+  }
+
+  return googleApiCall(() => client.properties.getMetadata({
+    name: `${ propertyName }/metadata`,
+  }));
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  googleanalyticsMetadataGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/googleanalyticsMetadataGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "google" },
+    "propertyIdentifier": { "propertyId": "402247571" }
+  }'
+*/

package/api/google/googleanalyticsRealtimeReportRun.js

@@ -0,0 +1,103 @@
+// https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runRealtimeReport
+
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { getGoogleAnalyticsData, googleApiCall } = require('../google/google.utils');
+
+const propertyIdentifierValidator = (propertyIdentifier) => {
+  return objHasAny(propertyIdentifier, ['propertyId', 'property']);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['propertyIdentifier', propertyIdentifierValidator],
+]);
+
+const formatDimensions = (dimensions) => {
+  if (!dimensions) {
+    return undefined;
+  }
+  return dimensions.map((dim) => (typeof dim === 'string' ? { name: dim } : dim));
+};
+
+const formatMetrics = (metrics) => {
+  if (!metrics) {
+    return undefined;
+  }
+  return metrics.map((metric) => (typeof metric === 'string' ? { name: metric } : metric));
+};
+
+const googleanalyticsRealtimeReportRun = async (
+  credsPayload,
+  propertyIdentifier,
+  {
+    subject,
+    dimensions,
+    metrics,
+    dimensionFilter,
+    metricFilter,
+    limit,
+    metricAggregations,
+    orderBys,
+    returnPropertyQuota,
+    minuteRanges,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    propertyIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { propertyId, property } = propertyIdentifier;
+  const propertyName = property ?? `properties/${ propertyId }`;
+
+  const { client, error } = await getGoogleAnalyticsData(credsPayload, { subject });
+
+  if (error) {
+    return error;
+  }
+
+  const formattedDimensions = formatDimensions(dimensions);
+  const formattedMetrics = formatMetrics(metrics);
+
+  return googleApiCall(() => client.properties.runRealtimeReport({
+    property: propertyName,
+    requestBody: {
+      ...formattedDimensions && { dimensions: formattedDimensions },
+      ...formattedMetrics && { metrics: formattedMetrics },
+      ...dimensionFilter && { dimensionFilter },
+      ...metricFilter && { metricFilter },
+      ...limit !== undefined && { limit },
+      ...metricAggregations && { metricAggregations },
+      ...orderBys && { orderBys },
+      ...returnPropertyQuota !== undefined && { returnPropertyQuota },
+      ...minuteRanges && { minuteRanges },
+    },
+  }));
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  googleanalyticsRealtimeReportRun,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/googleanalyticsRealtimeReportRun" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "google" },
+    "propertyIdentifier": { "propertyId": "402247571" },
+    "options": {
+      "dimensions": ["country"],
+      "metrics": ["activeUsers"]
+    }
+  }'
+*/

package/api/google/googleanalyticsReportRun.js

@@ -0,0 +1,114 @@
+// https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport
+
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { getGoogleAnalyticsData, googleApiCall } = require('../google/google.utils');
+
+const propertyIdentifierValidator = (propertyIdentifier) => {
+  return objHasAny(propertyIdentifier, ['propertyId', 'property']);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['propertyIdentifier', propertyIdentifierValidator],
+]);
+
+const formatDimensions = (dimensions) => {
+  if (!dimensions) {
+    return undefined;
+  }
+  return dimensions.map((dim) => (typeof dim === 'string' ? { name: dim } : dim));
+};
+
+const formatMetrics = (metrics) => {
+  if (!metrics) {
+    return undefined;
+  }
+  return metrics.map((metric) => (typeof metric === 'string' ? { name: metric } : metric));
+};
+
+const googleanalyticsReportRun = async (
+  credsPayload,
+  propertyIdentifier,
+  {
+    subject,
+    dateRanges,
+    dimensions,
+    metrics,
+    dimensionFilter,
+    metricFilter,
+    offset,
+    limit,
+    metricAggregations,
+    orderBys,
+    currencyCode,
+    cohortSpec,
+    keepEmptyRows,
+    returnPropertyQuota,
+    comparisons,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    propertyIdentifier,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const { propertyId, property } = propertyIdentifier;
+  const propertyName = property ?? `properties/${ propertyId }`;
+
+  const { client, error } = await getGoogleAnalyticsData(credsPayload, { subject });
+
+  if (error) {
+    return error;
+  }
+
+  const formattedDimensions = formatDimensions(dimensions);
+  const formattedMetrics = formatMetrics(metrics);
+
+  return googleApiCall(() => client.properties.runReport({
+    property: propertyName,
+    requestBody: {
+      ...dateRanges && { dateRanges },
+      ...formattedDimensions && { dimensions: formattedDimensions },
+      ...formattedMetrics && { metrics: formattedMetrics },
+      ...dimensionFilter && { dimensionFilter },
+      ...metricFilter && { metricFilter },
+      ...offset !== undefined && { offset },
+      ...limit !== undefined && { limit },
+      ...metricAggregations && { metricAggregations },
+      ...orderBys && { orderBys },
+      ...currencyCode && { currencyCode },
+      ...cohortSpec && { cohortSpec },
+      ...keepEmptyRows !== undefined && { keepEmptyRows },
+      ...returnPropertyQuota !== undefined && { returnPropertyQuota },
+      ...comparisons && { comparisons },
+    },
+  }));
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  googleanalyticsReportRun,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/googleanalyticsReportRun" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "google" },
+    "propertyIdentifier": { "propertyId": "402247571" },
+    "options": {
+      "dateRanges": [{ "startDate": "30daysAgo", "endDate": "today" }],
+      "dimensions": ["date"],
+      "metrics": ["activeUsers", "sessions"]
+    }
+  }'
+*/

package/api/shopify/shopify.utils.js

@@ -76,6 +76,31 @@ const useUrlAndAuthHeaders = async (state) => {
   };
 };
 
+const useStorefrontUrlAndAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const {
+    apiVersion = DEFAULT_API_VERSION,
+    creds,
+  } = context;
+  const {
+    STORE_HANDLE,
+    STOREFRONT_API_KEY,
+  } = creds;
+
+  const baseUrl = `https://${ STORE_HANDLE }.myshopify.com/api/${ apiVersion }/graphql.json`;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      url: appendUrlToBase(baseUrl, requestPayload.url),
+      headers: {
+        'X-Shopify-Storefront-Access-Token': STOREFRONT_API_KEY,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
 const movePageInfoToMeta = async (state) => {
   const { response, context } = state;
   const { resultPath } = context ?? {};
@@ -86,15 +111,23 @@ const movePageInfoToMeta = async (state) => {
 
   const connection = objectDigNodeAtPath(response.data, pathAsArray(resultPath));
 
-  if (!connection?.pageInfo) {
+  if (!connection || typeof connection !== 'object') {
+    return {};
+  }
+
+  const meta = {
+    ...connection.pageInfo ? { pageInfo: connection.pageInfo } : {},
+    ...connection.totalCount !== undefined ? { totalCount: connection.totalCount } : {},
+    ...connection.productFilters !== undefined ? { productFilters: connection.productFilters } : {},
+  };
+
+  if (!Object.keys(meta).length) {
     return {};
   }
 
   return {
     response: {
-      meta: {
-        pageInfo: connection.pageInfo,
-      },
+      meta,
     },
   };
 };
@@ -188,7 +221,23 @@ const shopifyClient = new FetchClient({
   ],
 });
 
+const shopifyStorefrontClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useStorefrontUrlAndAuthHeaders,
+    'fetch',
+    movePageInfoToMeta,
+    fetchClientCommonSteps.stripEdgesAndNodes,
+    fetchClientCommonSteps.collapseDataWithOneValue,
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+    fetchClientCommonSteps.exitEarlyOnGraphqlErrors,
+    fetchClientCommonSteps.digToPath,
+    handleMutationUserErrors,
+  ],
+});
+
 module.exports = {
   parseShopifyJsonl,
   shopifyClient,
+  shopifyStorefrontClient,
 };

package/api/shopify/shopifyMetaobjectCreate.js

@@ -11,7 +11,7 @@ const argsWarden = new ArgsWarden([
   ['metaobjectInput', metaobjectInputValidator],
 ]);
 
-const defaultReturnMetaobjectAttrs = 'id handle type updatedAt';
+const defaultReturnMetaobjectAttrs = 'id handle type updatedAt capabilities { publishable { status } }';
 
 const shopifyMetaobjectCreate = async (
   credsPayload,
@@ -59,13 +59,20 @@ module.exports = {
 curl -X POST "http://localhost:8000/shopifyMetaobjectCreate" \
   -H "Content-Type: application/json" \
   -d '{
-    "credsPayload": { "credsPath": "shopify.white-fox-us-dev-radial" },
+    "credsPayload": { "credsPath": "shopify.au" },
     "metaobjectInput": {
-      "type": "your_metaobject_type",
-      "handle": "optional-unique-handle",
+      "type": "catalog_filter_blacklist",
+      "handle": "collection-blacklist-example",
+      "capabilities": {
+        "publishable": {
+          "status": "ACTIVE"
+        }
+      },
       "fields": [
-        { "key": "title", "value": "Example" },
-        { "key": "body", "value": "Some content" }
+        { "key": "internal_name", "value": "Blacklist Category > \"Example\"" },
+        { "key": "source_filter", "value": "Category" },
+        { "key": "values", "value": "[\"Example\"]" },
+        { "key": "enabled", "value": "true" }
       ]
     }
   }'

package/api/shopify/shopifyMetaobjectDelete.js

@@ -0,0 +1,90 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/metaobjectDelete
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['metaobjectId'],
+]);
+
+const shopifyMetaobjectDeleteSingle = async (
+  credsPayload,
+  metaobjectId,
+  {
+    apiVersion,
+    returnSchema = 'deletedId',
+  } = {},
+) => {
+
+  return shopifyMutationDo(
+    credsPayload,
+    'metaobjectDelete',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: `gid://shopify/Metaobject/${ metaobjectId }`,
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyMetaobjectDelete = async (
+  credsPayload,
+  metaobjectId,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnSchema = 'deletedId',
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    metaobjectId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    metaobjectId,
+    shopifyMetaobjectDeleteSingle,
+    (metaobjectIdItem) => ({
+      args: [credsPayload, metaobjectIdItem, { apiVersion, returnSchema }],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyMetaobjectDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyMetaobjectDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metaobjectId": "215094820924"
+  }'
+
+curl -X POST "http://localhost:8000/shopifyMetaobjectDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "metaobjectId": ["215094820924", "215094820925"]
+  }'
+*/