@foxtware/mineral 0.1.9 → 0.1.10

package/api/github/githubIssuesGet.js

@@ -0,0 +1,74 @@
+// https://docs.github.com/en/rest/issues/issues#list-repository-issues
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubGet } = require('../github/githubGet');
+const { MAX_PER_PAGE } = require('../github/github.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+]);
+
+const githubIssuesGet = async (
+  credsPayload,
+  owner,
+  repo,
+  {
+    state,
+    labels,
+    sort,
+    direction,
+    since,
+    perPage,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...state && { state },
+    ...labels && { labels },
+    ...sort && { sort },
+    ...direction && { direction },
+    ...since && { since },
+  };
+
+  return githubGet(credsPayload, `/repos/${ owner }/${ repo }/issues`, {
+    params,
+    perPage: perPage ?? MAX_PER_PAGE,
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubIssuesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubIssuesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "mineral",
+    "options": {
+      "state": "open",
+      "limit": 10
+    }
+  }'
+*/

package/api/github/githubPullRequestCreate.js

@@ -0,0 +1,74 @@
+// https://docs.github.com/en/rest/pulls/pulls#create-a-pull-request
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const pullRequestPayloadValidator = (pullRequestPayload) => {
+  return Boolean(pullRequestPayload?.head) && Boolean(pullRequestPayload?.base);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+  ['pullRequestPayload', pullRequestPayloadValidator],
+]);
+
+const githubPullRequestCreate = async (
+  credsPayload,
+  owner,
+  repo,
+  pullRequestPayload,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+    pullRequestPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return githubClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/repos/${ owner }/${ repo }/pulls`,
+      body: pullRequestPayload,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubPullRequestCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubPullRequestCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "mineral",
+    "pullRequestPayload": {
+      "title": "Amazing new feature",
+      "head": "feature-branch",
+      "base": "main",
+      "body": "Please review"
+    }
+  }'
+*/

package/api/github/githubPullRequestGet.js

@@ -0,0 +1,65 @@
+// https://docs.github.com/en/rest/pulls/pulls#get-a-pull-request
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+  ['pullNumber'],
+]);
+
+const githubPullRequestGet = async (
+  credsPayload,
+  owner,
+  repo,
+  pullNumber,
+  {
+    params,
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+    pullNumber,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return githubClient.fetch({
+    requestPayload: {
+      url: `/repos/${ owner }/${ repo }/pulls/${ pullNumber }`,
+      params,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubPullRequestGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubPullRequestGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "mineral",
+    "pullNumber": 1
+  }'
+*/

package/api/github/githubPullRequestMerge.js

@@ -0,0 +1,77 @@
+// https://docs.github.com/en/rest/pulls/pulls#merge-a-pull-request
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+  ['pullNumber'],
+]);
+
+const githubPullRequestMerge = async (
+  credsPayload,
+  owner,
+  repo,
+  pullNumber,
+  {
+    commitTitle,
+    commitMessage,
+    sha,
+    mergeMethod,
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+    pullNumber,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return githubClient.fetch({
+    requestPayload: {
+      method: 'put',
+      url: `/repos/${ owner }/${ repo }/pulls/${ pullNumber }/merge`,
+      body: {
+        ...commitTitle && { commit_title: commitTitle },
+        ...commitMessage && { commit_message: commitMessage },
+        ...sha && { sha },
+        ...mergeMethod && { merge_method: mergeMethod },
+      },
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubPullRequestMerge,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubPullRequestMerge" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "mineral",
+    "pullNumber": 1,
+    "options": {
+      "mergeMethod": "squash"
+    }
+  }'
+*/

package/api/github/githubPullRequestUpdate.js

@@ -0,0 +1,72 @@
+// https://docs.github.com/en/rest/pulls/pulls#update-a-pull-request
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+  ['pullNumber'],
+  ['updatePayload', Boolean],
+]);
+
+const githubPullRequestUpdate = async (
+  credsPayload,
+  owner,
+  repo,
+  pullNumber,
+  updatePayload,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+    pullNumber,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return githubClient.fetch({
+    requestPayload: {
+      method: 'patch',
+      url: `/repos/${ owner }/${ repo }/pulls/${ pullNumber }`,
+      body: updatePayload,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubPullRequestUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubPullRequestUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "mineral",
+    "pullNumber": 1,
+    "updatePayload": {
+      "title": "Updated title",
+      "state": "open"
+    }
+  }'
+*/

package/api/github/githubPullRequestsGet.js

@@ -0,0 +1,74 @@
+// https://docs.github.com/en/rest/pulls/pulls#list-pull-requests
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubGet } = require('../github/githubGet');
+const { MAX_PER_PAGE } = require('../github/github.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+]);
+
+const githubPullRequestsGet = async (
+  credsPayload,
+  owner,
+  repo,
+  {
+    state,
+    head,
+    base,
+    sort,
+    direction,
+    perPage,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...state && { state },
+    ...head && { head },
+    ...base && { base },
+    ...sort && { sort },
+    ...direction && { direction },
+  };
+
+  return githubGet(credsPayload, `/repos/${ owner }/${ repo }/pulls`, {
+    params,
+    perPage: perPage ?? MAX_PER_PAGE,
+    ...getterOptions,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubPullRequestsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubPullRequestsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "mineral",
+    "options": {
+      "state": "open",
+      "limit": 10
+    }
+  }'
+*/

package/api/github/githubRepoCreate.js

@@ -0,0 +1,80 @@
+// https://docs.github.com/en/rest/repos/repos#create-a-repository-for-the-authenticated-user
+// https://docs.github.com/en/rest/repos/repos#create-an-organization-repository
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const repoPayloadValidator = (repoPayload) => Boolean(repoPayload?.name);
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['repoPayload', repoPayloadValidator],
+]);
+
+const githubRepoCreate = async (
+  credsPayload,
+  repoPayload,
+  {
+    org,
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    repoPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const url = org ? `/orgs/${ org }/repos` : '/user/repos';
+
+  return githubClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url,
+      body: repoPayload,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubRepoCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubRepoCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "repoPayload": {
+      "name": "my-new-repo",
+      "private": true,
+      "auto_init": true
+    }
+  }'
+
+curl -X POST "http://localhost:8000/githubRepoCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "repoPayload": {
+      "name": "my-org-repo",
+      "private": false
+    },
+    "options": {
+      "org": "GorgonFreeman"
+    }
+  }'
+*/

package/api/github/githubRepoDelete.js

@@ -0,0 +1,60 @@
+// https://docs.github.com/en/rest/repos/repos#delete-a-repository
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+]);
+
+const githubRepoDelete = async (
+  credsPayload,
+  owner,
+  repo,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return githubClient.fetch({
+    requestPayload: {
+      method: 'delete',
+      url: `/repos/${ owner }/${ repo }`,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubRepoDelete,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubRepoDelete" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "my-old-repo"
+  }'
+*/

package/api/github/githubRepoGet.js

@@ -0,0 +1,61 @@
+// https://docs.github.com/en/rest/repos/repos#get-a-repository
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+]);
+
+const githubRepoGet = async (
+  credsPayload,
+  owner,
+  repo,
+  {
+    params,
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return githubClient.fetch({
+    requestPayload: {
+      url: `/repos/${ owner }/${ repo }`,
+      params,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubRepoGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubRepoGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "mineral"
+  }'
+*/

package/api/github/githubRepoUpdate.js

@@ -0,0 +1,68 @@
+// https://docs.github.com/en/rest/repos/repos#update-a-repository
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { githubClient } = require('../github/github.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['owner'],
+  ['repo'],
+  ['updatePayload', Boolean],
+]);
+
+const githubRepoUpdate = async (
+  credsPayload,
+  owner,
+  repo,
+  updatePayload,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    owner,
+    repo,
+    updatePayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return githubClient.fetch({
+    requestPayload: {
+      method: 'patch',
+      url: `/repos/${ owner }/${ repo }`,
+      body: updatePayload,
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  githubRepoUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/githubRepoUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "github" },
+    "owner": "GorgonFreeman",
+    "repo": "mineral",
+    "updatePayload": {
+      "description": "Updated description",
+      "private": true
+    }
+  }'
+*/