@foxtware/mineral 0.1.27 → 0.1.29

package/api/figma/figmaWebhookCreate.js

@@ -0,0 +1,47 @@
+// https://developers.figma.com/docs/rest-api/webhooks-endpoints/
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { figmaClient } = require('../figma/figma.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['webhookPayload', Boolean],
+]);
+
+const figmaWebhookCreate = async (
+  credsPayload,
+  webhookPayload,
+  {
+    params,
+    fetchClient = figmaClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    webhookPayload
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/v2/webhooks`,
+      body: webhookPayload,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  figmaWebhookCreate,
+  funcApiConfig,
+};

package/api/figma/figmaWebhookDelete.js

@@ -0,0 +1,48 @@
+// https://developers.figma.com/docs/rest-api/webhooks-endpoints/
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { figmaClient } = require('../figma/figma.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['webhookId'],
+]);
+
+const figmaWebhookDelete = async (
+  credsPayload,
+  webhookId,
+  {
+    params,
+    fetchClient = figmaClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    webhookId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'delete',
+      url: `/v2/webhooks/${ webhookId }`,
+      
+      
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  figmaWebhookDelete,
+  funcApiConfig,
+};

package/api/figma/figmaWebhookGet.js

@@ -0,0 +1,46 @@
+// https://developers.figma.com/docs/rest-api/webhooks-endpoints/
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { figmaClient } = require('../figma/figma.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['webhookId'],
+]);
+
+const figmaWebhookGet = async (
+  credsPayload,
+  webhookId,
+  {
+    params,
+    fetchClient = figmaClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    webhookId
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/v2/webhooks/${ webhookId }`,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  figmaWebhookGet,
+  funcApiConfig,
+};

package/api/figma/figmaWebhookRequestsGet.js

@@ -0,0 +1,47 @@
+// https://developers.figma.com/docs/rest-api/webhooks-endpoints/
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { figmaClient } = require('../figma/figma.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['webhookId'],
+]);
+
+const figmaWebhookRequestsGet = async (
+  credsPayload,
+  webhookId,
+  {
+    params,
+    fetchClient = figmaClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    webhookId
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/v2/webhooks/${ webhookId }/requests`,
+      params,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  figmaWebhookRequestsGet,
+  funcApiConfig,
+};

package/api/figma/figmaWebhookUpdate.js

@@ -0,0 +1,50 @@
+// https://developers.figma.com/docs/rest-api/webhooks-endpoints/
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { figmaClient } = require('../figma/figma.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['webhookId'],
+  ['webhookPayload', Boolean],
+]);
+
+const figmaWebhookUpdate = async (
+  credsPayload,
+  webhookId,
+  webhookPayload,
+  {
+    params,
+    fetchClient = figmaClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    webhookId,
+    webhookPayload
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'put',
+      url: `/v2/webhooks/${ webhookId }`,
+      body: webhookPayload,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  figmaWebhookUpdate,
+  funcApiConfig,
+};

package/api/figma/figmaWebhooksGet.js

@@ -0,0 +1,47 @@
+// https://developers.figma.com/docs/rest-api/webhooks-endpoints/
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { figmaClient } = require('../figma/figma.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const figmaWebhooksGet = async (
+  credsPayload,
+  
+  {
+    params,
+    fetchClient = figmaClient,
+  } = {},
+) => {
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/v2/webhooks`,
+      params,
+      
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  figmaWebhooksGet,
+  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/gorgias/gorgiasTicketCreate.js

@@ -6,7 +6,7 @@ const { gorgiasClient } = require('../gorgias/gorgias.utils');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
-  ['ticketBody', valueProvided],
+  ['ticketBody'],
 ]);
 
 const gorgiasTicketCreate = async (

package/api/gorgias/gorgiasTicketMessageCreate.js

@@ -7,7 +7,7 @@ const { gorgiasClient } = require('../gorgias/gorgias.utils');
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
   ['ticketId'],
-  ['messageBody', valueProvided],
+  ['messageBody'],
 ]);
 
 const gorgiasTicketMessageCreate = async (

package/api/gorgias/gorgiasTicketUpdate.js

@@ -7,7 +7,7 @@ const { gorgiasClient } = require('../gorgias/gorgias.utils');
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
   ['ticketId'],
-  ['ticketBody', valueProvided],
+  ['ticketBody'],
 ]);
 
 const gorgiasTicketUpdate = async (

package/api/linear/linearAttachmentCreate.js

@@ -6,7 +6,7 @@ const { linearClient } = require('../linear/linear.utils');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
-  ['input', valueProvided],
+  ['input'],
 ]);
 
 const linearAttachmentCreate = async (

package/api/linear/linearCommentCreate.js

@@ -6,7 +6,7 @@ const { linearClient } = require('../linear/linear.utils');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
-  ['input', valueProvided],
+  ['input'],
 ]);
 
 const linearCommentCreate = async (

package/api/linear/linearCommentUpdate.js

@@ -7,7 +7,7 @@ const { linearClient } = require('../linear/linear.utils');
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
   ['id'],
-  ['input', valueProvided],
+  ['input'],
 ]);
 
 const linearCommentUpdate = async (

package/api/linear/linearIssueLabelCreate.js

@@ -6,7 +6,7 @@ const { linearClient } = require('../linear/linear.utils');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
-  ['input', valueProvided],
+  ['input'],
 ]);
 
 const linearIssueLabelCreate = async (