@foxtware/mineral 0.1.17 → 0.1.19

package/api/gorgias/gorgiasUsersGet.js

@@ -0,0 +1,52 @@
+// https://developers.gorgias.com/reference/list-users
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasGet, gorgiasGetter } = require('../gorgias/gorgiasGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const gorgiasUsersGet = async (
+  returnGetter,
+
+  credsPayload,
+  getterOptions = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    '/users',
+    getterOptions,
+  ];
+
+  return returnGetter
+    ? gorgiasGetter(...getterArgs)
+    : gorgiasGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasUsersGet: (...args) => gorgiasUsersGet(false, ...args),
+  gorgiasUsersGetter: (...args) => gorgiasUsersGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasUsersGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" }
+  }'
+*/

package/api/gorgias/gorgiasViewItemsGet.js

@@ -0,0 +1,57 @@
+// https://developers.gorgias.com/reference/list-view-items
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasGet, gorgiasGetter } = require('../gorgias/gorgiasGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['viewId'],
+]);
+
+const gorgiasViewItemsGet = async (
+  returnGetter,
+
+  credsPayload,
+  viewId,
+  getterOptions = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    viewId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    `/views/${ viewId }/items`,
+    getterOptions,
+  ];
+
+  return returnGetter
+    ? gorgiasGetter(...getterArgs)
+    : gorgiasGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasViewItemsGet: (...args) => gorgiasViewItemsGet(false, ...args),
+  gorgiasViewItemsGetter: (...args) => gorgiasViewItemsGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasViewItemsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "viewId": "2705014",
+    "options": { "limit": 10 }
+  }'
+*/

package/api/gorgias/gorgiasViewsGet.js

@@ -0,0 +1,72 @@
+// https://developers.gorgias.com/reference/list-views
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasClient } = require('../gorgias/gorgias.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const normalizeViewsList = (body) => {
+  if (Array.isArray(body)) {
+    return body;
+  }
+
+  if (Array.isArray(body?.data)) {
+    return body.data;
+  }
+
+  return [];
+};
+
+const gorgiasViewsGet = async (
+  credsPayload,
+  {
+    inspect = false,
+    fetchClient = gorgiasClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const response = await fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/views',
+    },
+    context: { credsPayload },
+    inspect,
+  });
+
+  if (!response.ok) {
+    return response;
+  }
+
+  return {
+    ok: true,
+    data: normalizeViewsList(response.data),
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasViewsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasViewsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" }
+  }'
+*/

package/api/linear/docs.md

@@ -0,0 +1,6 @@
+# Linear
+
+- [GraphQL API](https://linear.app/developers/graphql)
+- [Schema explorer](https://studio.apollographql.com/public/Linear-API/variant/current/home)
+
+Single GraphQL endpoint at `https://api.linear.app/graphql`. Authenticate with a personal API key (`Authorization: <API_KEY>`) or OAuth access token (`Authorization: Bearer <ACCESS_TOKEN>`). Pagination follows the Relay connection model (`first` / `after` / `pageInfo` / `nodes`).

package/api/linear/linear.constants.js

@@ -1,5 +1,8 @@
 const LINEAR_GRAPHQL_URL = 'https://api.linear.app/graphql';
 
+const MAX_PER_PAGE = 250;
+
 module.exports = {
   LINEAR_GRAPHQL_URL,
+  MAX_PER_PAGE,
 };

package/api/linear/linear.utils.js

@@ -3,6 +3,8 @@ const { resolveCreds } = require('../pipelineSteps');
 const {
   FetchClient,
   fetchClientCommonSteps,
+  pathAsArray,
+  objectDigNodeAtPath,
 } = require('../utils');
 
 const useAuthHeaders = async (state) => {
@@ -23,16 +25,73 @@ const useAuthHeaders = async (state) => {
   };
 };
 
+const movePageInfoToMeta = async (state) => {
+  const { response, context } = state;
+  const { resultPath } = context ?? {};
+
+  if (!response?.ok || !response?.data || !resultPath) {
+    return {};
+  }
+
+  const connection = objectDigNodeAtPath(response.data, pathAsArray(resultPath));
+
+  if (!connection?.pageInfo) {
+    return {};
+  }
+
+  return {
+    response: {
+      meta: {
+        pageInfo: connection.pageInfo,
+      },
+    },
+  };
+};
+
 const linearClient = new FetchClient({
   pipeline: [
     resolveCreds,
     useAuthHeaders,
     'fetch',
+    movePageInfoToMeta,
+    fetchClientCommonSteps.stripEdgesAndNodes,
     fetchClientCommonSteps.exitEarlyOnNotOk,
     fetchClientCommonSteps.exitEarlyOnGraphqlErrors,
+    fetchClientCommonSteps.digToPath,
   ],
 });
 
+const linearConnectionDigester = (response) => {
+  if (!response?.ok) {
+    return [];
+  }
+
+  return response?.data ?? [];
+};
+
+const linearConnectionPaginator = async (currentParams, response) => {
+  const { args, options } = currentParams;
+
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const pageInfo = response?.meta?.pageInfo;
+  if (!pageInfo?.hasNextPage || !pageInfo?.endCursor) {
+    return [true];
+  }
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      after: pageInfo.endCursor,
+    },
+  }];
+};
+
 module.exports = {
   linearClient,
+  linearConnectionDigester,
+  linearConnectionPaginator,
 };

package/api/linear/linearAttachmentCreate.js

@@ -0,0 +1,77 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearClient } = require('../linear/linear.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['input', valueProvided],
+]);
+
+const linearAttachmentCreate = async (
+  credsPayload,
+  input,
+  {
+    inspect = false,
+    fetchClient = linearClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    input,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      body: {
+        query: `
+          mutation AttachmentCreate($input: AttachmentCreateInput!) {
+            attachmentCreate(input: $input) {
+              success
+              attachment {
+                id
+                title
+                url
+              }
+            }
+          }
+        `,
+        variables: {
+          input,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      resultPath: 'data.attachmentCreate',
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearAttachmentCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearAttachmentCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "input": {
+      "issueId": "WHI-267",
+      "url": "https://example.com/file.pdf",
+      "title": "File"
+    }
+  }'
+*/

package/api/linear/linearAttachmentDelete.js

@@ -0,0 +1,68 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearClient } = require('../linear/linear.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['id'],
+]);
+
+const linearAttachmentDelete = async (
+  credsPayload,
+  id,
+  {
+    inspect = false,
+    fetchClient = linearClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    id,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      body: {
+        query: `
+          mutation AttachmentDelete($id: String!) {
+            attachmentDelete(id: $id) {
+              success
+            }
+          }
+        `,
+        variables: {
+          id,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      resultPath: 'data.attachmentDelete',
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearAttachmentDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearAttachmentDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "id": "ATTACHMENT_ID"
+  }'
+*/

package/api/linear/linearCommentCreate.js

@@ -0,0 +1,77 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearClient } = require('../linear/linear.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['input', valueProvided],
+]);
+
+const linearCommentCreate = async (
+  credsPayload,
+  input,
+  {
+    inspect = false,
+    fetchClient = linearClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    input,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      body: {
+        query: `
+          mutation CommentCreate($input: CommentCreateInput!) {
+            commentCreate(input: $input) {
+              success
+              comment {
+                id
+                body
+                createdAt
+                updatedAt
+              }
+            }
+          }
+        `,
+        variables: {
+          input,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      resultPath: 'data.commentCreate',
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearCommentCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearCommentCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "input": {
+      "issueId": "WHI-267",
+      "body": "Hello"
+    }
+  }'
+*/

package/api/linear/linearCommentDelete.js

@@ -0,0 +1,68 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearClient } = require('../linear/linear.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['id'],
+]);
+
+const linearCommentDelete = async (
+  credsPayload,
+  id,
+  {
+    inspect = false,
+    fetchClient = linearClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    id,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      body: {
+        query: `
+          mutation CommentDelete($id: String!) {
+            commentDelete(id: $id) {
+              success
+            }
+          }
+        `,
+        variables: {
+          id,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      resultPath: 'data.commentDelete',
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearCommentDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearCommentDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "id": "COMMENT_ID"
+  }'
+*/

package/api/linear/linearCommentGet.js

@@ -0,0 +1,77 @@
+// https://linear.app/developers/graphql
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { linearClient } = require('../linear/linear.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['id'],
+]);
+
+const linearCommentGet = async (
+  credsPayload,
+  id,
+  {
+    hash,
+    inspect = false,
+    fetchClient = linearClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    id,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      body: {
+        query: `
+          query CommentGet($id: String!, $hash: String) {
+            comment(id: $id, hash: $hash) {
+              id
+              body
+              createdAt
+              updatedAt
+              user {
+                id
+                name
+              }
+            }
+          }
+        `,
+        variables: {
+          id,
+          hash,
+        },
+      },
+    },
+    context: {
+      credsPayload,
+      resultPath: 'data.comment',
+    },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  linearCommentGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/linearCommentGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "linear" },
+    "id": "COMMENT_ID"
+  }'
+*/