@foxtware/mineral 0.1.15 → 0.1.16

package/api/etsy/etsyUserAddressGet.js

@@ -0,0 +1,62 @@
+// https://developers.etsy.com/documentation/reference/#operation/getUserAddress
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['addressId'],
+]);
+
+const etsyUserAddressGet = async (
+  credsPayload,
+  addressId,
+  {
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    addressId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/application/user/addresses/${ addressId }`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyUserAddressGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyUserAddressGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "addressId": "1296125024835"
+  }'
+*/

package/api/etsy/etsyUserAddressesGet.js

@@ -0,0 +1,70 @@
+// https://developers.etsy.com/documentation/reference/#operation/getUserAddresses
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyGet, etsyGetter } = require('./etsyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const etsyUserAddressesGet = async (
+  returnGetter,
+
+  credsPayload,
+  {
+    params: paramsOption,
+    perPage,
+
+    withAccessToken = true,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...paramsOption,
+
+  };
+
+  const getterArgs = [
+    credsPayload,
+    `/application/user/addresses`,
+    {
+      params,
+      perPage,
+      withAccessToken,
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? etsyGetter(...getterArgs)
+    : etsyGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyUserAddressesGet: (...args) => etsyUserAddressesGet(false, ...args),
+  etsyUserAddressesGetter: (...args) => etsyUserAddressesGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyUserAddressesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    }
+  }'
+*/

package/api/etsy/etsyUserGet.js

@@ -0,0 +1,62 @@
+// https://developers.etsy.com/documentation/reference/#operation/getUser
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['userId'],
+]);
+
+const etsyUserGet = async (
+  credsPayload,
+  userId,
+  {
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    userId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/application/users/${ userId }`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyUserGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyUserGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "userId": "123456789"
+  }'
+*/

package/api/etsy/etsyUserShopsGet.js

@@ -0,0 +1,62 @@
+// https://developers.etsy.com/documentation/reference/#operation/getShopByOwnerUserId
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['userId'],
+]);
+
+const etsyUserShopsGet = async (
+  credsPayload,
+  userId,
+  {
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    userId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/application/users/${ userId }/shops`,
+      ...(params && { params }),
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyUserShopsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyUserShopsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "userId": "123456789"
+  }'
+*/

package/api/etsy/etsyVariationImagesUpdate.js

@@ -0,0 +1,75 @@
+// https://developers.etsy.com/documentation/reference/#operation/updateVariationImages
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { etsyClient, resolveShopId } = require('./etsy.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['listingId'],
+  ['updatePayload'],
+]);
+
+const etsyVariationImagesUpdate = async (
+  credsPayload,
+  listingId,
+  updatePayload,
+  {
+    shopId,
+    params,
+    inspect = false,
+    fetchClient = etsyClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    listingId,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const shopIdResponse = await resolveShopId({ shopId, credsPayload });
+  if (!shopIdResponse.ok) {
+    return shopIdResponse;
+  }
+  ({ data: shopId } = shopIdResponse);
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/application/shops/${ shopId }/listings/${ listingId }/variation-images`,
+      body: updatePayload,
+    },
+    context: {
+      credsPayload,
+      withAccessToken: true,
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  etsyVariationImagesUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/etsyVariationImagesUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": {
+      "credsPath": "etsy"
+    },
+    "listingId": "1234567890",
+    "updatePayload": {
+      ...
+    }
+  }'
+*/

package/api/figma/docs.md

@@ -0,0 +1,6 @@
+# Figma
+
+- [Developer documentation](https://www.figma.com/developers/api)
+- [Authentication](https://www.figma.com/developers/api#authentication)
+
+REST JSON at `https://api.figma.com/v1` for files, comments, and variables, authenticated with a personal access token in the `X-Figma-Token` header.

package/api/figma/figma.constants.js

@@ -0,0 +1,7 @@
+const FIGMA_API_BASE_URL = 'https://api.figma.com/v1';
+const MAX_PER_PAGE = 100;
+
+module.exports = {
+  FIGMA_API_BASE_URL,
+  MAX_PER_PAGE,
+};

package/api/figma/figma.utils.js

@@ -0,0 +1,36 @@
+const { FIGMA_API_BASE_URL } = require('../figma/figma.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const { API_KEY } = creds;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        'X-Figma-Token': API_KEY,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const figmaClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(FIGMA_API_BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
+});
+
+module.exports = {
+  figmaClient,
+};

package/api/figma/figmaGet.js

@@ -0,0 +1,107 @@
+// https://www.figma.com/developers/api#get-me-endpoint
+
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { figmaClient } = require('../figma/figma.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+]);
+
+const figmaGetPacket = async (
+  credsPayload,
+  url,
+  {
+    params,
+  } = {},
+) => {
+  return figmaClient.fetch({
+    requestPayload: {
+      url,
+      params,
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const figmaGetPaginator = async (currentParams, response) => {
+  if (!response?.ok) {
+    return [true];
+  }
+
+  return [true];
+};
+
+const figmaGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    params,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url],
+      options: {
+        params,
+      },
+    },
+    {
+      func: figmaGetPacket,
+      digester: (response) => {
+        if (!response?.ok) {
+          return [];
+        }
+
+        return Array.isArray(response.data) ? response.data : [];
+      },
+      paginator: figmaGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  figmaGet: (...args) => figmaGet(false, ...args),
+  figmaGetter: (...args) => figmaGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/figmaGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "figma" },
+    "url": "/me"
+  }'
+*/

package/api/github/githubReposGet.js

@@ -21,7 +21,9 @@ const githubReposGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/github/githubUserGet.js

@@ -18,7 +18,9 @@ const githubUserGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/google/docs.md

@@ -0,0 +1,7 @@
+# Google (Workspace APIs)
+
+Service account auth via `SERVICE_ACCOUNT_JSON` on the `google` creds path. Uses [`googleapis`](https://github.com/googleapis/google-api-nodejs-client).
+
+- [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)

package/api/google/google.constants.js

@@ -0,0 +1,9 @@
+const GOOGLE_SCOPES = {
+  sheets: ['https://www.googleapis.com/auth/spreadsheets'],
+  drive: ['https://www.googleapis.com/auth/drive'],
+  calendar: ['https://www.googleapis.com/auth/calendar'],
+};
+
+module.exports = {
+  GOOGLE_SCOPES,
+};

package/api/google/google.utils.js

@@ -0,0 +1,137 @@
+const { google } = require('googleapis');
+const { credsFromPayload } = require('../utils');
+const { GOOGLE_SCOPES } = require('../google/google.constants');
+
+const invalidCredsResponse = () => ({
+  ok: false,
+  error: {
+    code: 'INVALID_CREDS',
+    message: 'SERVICE_ACCOUNT_JSON is required on google creds.',
+  },
+});
+
+const resolveServiceAccountJson = async (credsPayload) => {
+  const creds = await credsFromPayload(credsPayload);
+
+  if (!creds?.SERVICE_ACCOUNT_JSON) {
+    return null;
+  }
+
+  return creds.SERVICE_ACCOUNT_JSON;
+};
+
+const buildGoogleAuth = (
+  serviceAccountJson,
+  {
+    scopes,
+    subject,
+  },
+) => {
+  if (subject) {
+    return new google.auth.JWT({
+      email: serviceAccountJson.client_email,
+      key: serviceAccountJson.private_key,
+      scopes,
+      subject,
+    });
+  }
+
+  return new google.auth.GoogleAuth({
+    credentials: serviceAccountJson,
+    scopes,
+  });
+};
+
+const getGoogleAuth = async (
+  credsPayload,
+  {
+    scopes,
+    subject,
+  },
+) => {
+  const serviceAccountJson = await resolveServiceAccountJson(credsPayload);
+
+  if (!serviceAccountJson) {
+    return { error: invalidCredsResponse() };
+  }
+
+  return {
+    auth: buildGoogleAuth(serviceAccountJson, { scopes, subject }),
+  };
+};
+
+const getGoogleSheets = async (credsPayload) => {
+  const { auth, error } = await getGoogleAuth(credsPayload, {
+    scopes: GOOGLE_SCOPES.sheets,
+  });
+
+  if (error) {
+    return { error };
+  }
+
+  return {
+    client: google.sheets({ version: 'v4', auth }),
+  };
+};
+
+const getGoogleDrive = async (credsPayload) => {
+  const { auth, error } = await getGoogleAuth(credsPayload, {
+    scopes: GOOGLE_SCOPES.drive,
+  });
+
+  if (error) {
+    return { error };
+  }
+
+  return {
+    client: google.drive({ version: 'v3', auth }),
+  };
+};
+
+const getGoogleCalendar = async (
+  credsPayload,
+  {
+    subject,
+  } = {},
+) => {
+  const { auth, error } = await getGoogleAuth(credsPayload, {
+    scopes: GOOGLE_SCOPES.calendar,
+    subject,
+  });
+
+  if (error) {
+    return { error };
+  }
+
+  return {
+    client: google.calendar({ version: 'v3', auth }),
+  };
+};
+
+const googleApiCall = async (promiseFn) => {
+  try {
+    const response = await promiseFn();
+    return {
+      ok: true,
+      data: response?.data ?? response,
+    };
+  } catch (error) {
+    return {
+      ok: false,
+      error: {
+        code: 'GOOGLE_API_ERROR',
+        message: error.message,
+        details: error.response?.data ?? error.errors ?? error,
+      },
+    };
+  }
+};
+
+module.exports = {
+  resolveServiceAccountJson,
+  getGoogleSheets,
+  getGoogleDrive,
+  getGoogleCalendar,
+  googleApiCall,
+  invalidCredsResponse,
+};