@sparted/shared-library 1.0.8-alpha.6 → 1.0.9

package/src/fp/index.ts

@@ -1 +0,0 @@
-export * from './run-while';

package/src/fp/run-while.ts

@@ -1,54 +0,0 @@
-export type RunWhileConfig<T> = {
-  /**
-   * Return a boolean to keep running the callback or not.
-   */
-  predicate: (current: T) => boolean,
-  /**
-   * The function to run while `predicate` returns `true`
-   */
-  callback: (current: T, iteractionCount: number) => T,
-  /**
-   * `callback` will not be run again if `iterationCount` exceeds this value.
-   * Default to `Infinity`
-   */
-  iterationLimit?: number,
-  /**
-   * The first value passed to the callback.
-   */
-  initialValue: T,
-};
-
-export type RunWhileFn = <T>(config: RunWhileConfig<T>) => {
-  /**
-   * The callback last result.
-   */
-  result: T,
-  iterationCount: number,
-};
-
-/**
- * Run the callback while the predicate return true. Throws an
- * error if the iteration count exceeds the iteration limit.
- */
-export const runWhile: RunWhileFn = ({ predicate, callback, initialValue, iterationLimit = Infinity }) => {
-  let counter = 0;
-  let currentValue = initialValue;
-  let shouldRun = predicate(currentValue);
-
-  while (shouldRun) {
-    if (counter >= iterationLimit) {
-      break;
-    }
-
-    const nextValue = callback(currentValue, counter);
-
-    counter += 1;
-    shouldRun = predicate(nextValue);
-    currentValue = nextValue;
-  }
-
-  return {
-    result: currentValue,
-    iterationCount: counter,
-  };
-};

package/src/github/branch/create-branch.ts

@@ -1,36 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { z } from 'zod';
-
-import { handleError } from '../commit/utils';
-
-export type CreateBranchArgs = {
-  branchName: string;
-  shaLastCommitOfBranch: string;
-};
-
-export type CreateBranchResponse = {
-  ref: string;
-};
-
-const createBranchResponseSchema = z.object({
-  ref: z.string(),
-});
-
-export type CreateBranch = (args: CreateBranchArgs) => Promise<CreateBranchResponse>;
-
-export type CreateBranchFactory = (instance: AxiosInstance) => CreateBranch;
-
-export const createBranchFactory: CreateBranchFactory = (instance) => async (args) => {
-  const { branchName, shaLastCommitOfBranch } = args;
-
-  try {
-    const { data } = await instance.post<CreateBranchResponse>('/git/refs', {
-      ref: `refs/heads/${branchName}`,
-      sha: shaLastCommitOfBranch,
-    });
-
-    return createBranchResponseSchema.parse(data);
-  } catch (error) {
-    throw handleError(error);
-  }
-};

package/src/github/branch/index.ts

@@ -1,2 +0,0 @@
-export * from './create-branch';
-export * from './update-branch';

package/src/github/branch/update-branch.ts

@@ -1,35 +0,0 @@
-import { AxiosInstance } from 'axios';
-import { z } from 'zod';
-
-import { handleError } from '../commit/utils';
-
-export type UpdateBranchArgs = {
-  branchName: string;
-  shaTree: string;
-};
-
-export type UpdateBranchResponse = {
-  ref: string;
-};
-
-const updateBranchResponseSchema = z.object({
-  ref: z.string(),
-});
-
-export type UpdateBranch = (args: UpdateBranchArgs) => Promise<UpdateBranchResponse>;
-
-export type UpdateBranchFactory = (instance: AxiosInstance) => UpdateBranch;
-
-export const updateBranchFactory: UpdateBranchFactory = (instance) => async (args) => {
-  const { branchName, shaTree } = args;
-
-  try {
-    const { data } = await instance.patch<UpdateBranchResponse>(`/git/refs/heads/${branchName}`, {
-      sha: shaTree,
-    });
-
-    return updateBranchResponseSchema.parse(data);
-  } catch (error) {
-    throw handleError(error);
-  }
-};

package/src/github/commit/create-git-blob.ts

@@ -1,57 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import { z } from 'zod';
-
-import { handleError } from './utils';
-
-export type CreateGitBlobArgs = {
-  content: string;
-  encoding: 'utf-8' | 'base64';
-};
-
-export type CreateGitBlobResponse = {
-  sha: string;
-  url: string;
-};
-
-const createGitBlobResponseSchema = z.object({
-  sha: z.string(),
-  url: z.string(),
-});
-
-export type CreateGitBlob = (
-  args: CreateGitBlobArgs
-) => Promise<CreateGitBlobResponse>;
-
-export type CreateGitBlobFactory = (instance: AxiosInstance) => CreateGitBlob;
-
-/**
- * Create a git blob
- *
- * @param owner the owner of the repository
- * @param repo the name of the repository
- * @param token the github token
- * @param content the content of the file
- * @param encoding the encoding of the content. Default: utf-8
- * @returns CreateGitBlobResponse
- * @throws forbidden
- * @throws resource-not-found
- * @throws conflict
- * @throws validation-failed-or-the-endpoint-has-been-spammed
- */
-export const createGitBlobFactory: CreateGitBlobFactory = (instance) => async (args) => {
-  const { content, encoding = 'utf-8' } = args;
-
-  try {
-    const { data } = await instance.post<CreateGitBlobResponse>(
-      '/git/blobs',
-      {
-        content,
-        encoding,
-      },
-    );
-
-    return createGitBlobResponseSchema.parse(data);
-  } catch (error) {
-    throw handleError(error);
-  }
-};

package/src/github/commit/create-git-commit.ts

@@ -1,57 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import { z } from 'zod';
-
-import { handleError } from './utils';
-
-export type CreateGitCommitArgs = {
-  message: string;
-  treeSha: string;
-  parents: string[];
-};
-
-export type CreateGitCommitResponse = {
-  sha: string;
-  url: string;
-};
-
-const createGitCommitSchema = z.object({
-  sha: z.string(),
-  url: z.string(),
-});
-
-export type CreateGitCommit = (
-  args: CreateGitCommitArgs
-) => Promise<CreateGitCommitResponse>;
-
-export type CreateGitCommitFactory = (
-  instance: AxiosInstance
-) => CreateGitCommit;
-
-/**
- * Create a git commit
- * @param owner the owner of the repository
- * @param repo the name of the repository
- * @param token the github token
- * @param message the commit message
- * @param treeSha the sha of the tree
- * @param parents the parents of the commit
- * @returns CreateGitCommitResponse
- */
-export const createGitCommitFactory: CreateGitCommitFactory = (instance) => async (args) => {
-  const { message, treeSha, parents } = args;
-
-  try {
-    const { data } = await instance.post<CreateGitCommitResponse>(
-      '/git/commits',
-      {
-        message,
-        tree: treeSha,
-        parents,
-      },
-    );
-
-    return createGitCommitSchema.parse(data);
-  } catch (error) {
-    throw handleError(error);
-  }
-};

package/src/github/commit/create-git-tree.ts

@@ -1,68 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import { z } from 'zod';
-
-import { handleError } from './utils';
-
-export type Blob = {
-  path: string;
-  sha: string;
-};
-
-export type CreateGitTreeArgs = {
-  baseTreeSha: string;
-  blobs: Blob[];
-};
-
-export type CreateGitTreeResponse = {
-  sha: string;
-  url: string;
-};
-
-const createGitTreeSchema = z.object({
-  sha: z.string(),
-  url: z.string(),
-});
-
-export type CreateGitTree = (
-  args: CreateGitTreeArgs
-) => Promise<CreateGitTreeResponse>;
-
-export type CreateGitTreeFactory = (instance: AxiosInstance) => CreateGitTree;
-
-/**
- * Create a git tree
- *
- * @param owner the owner of the repository
- * @param repo the name of the repository
- * @param token the github token
- * @param baseTreeSha the sha of the base tree
- * @param blobs the blobs to add to the tree
- * @returns CreateGitTreeResponse
- * @throws forbidden
- * @throws resource-not-found
- * @throws validation-failed-or-the-endpoint-has-been-spammed
- */
-export const createGitTreeFactory: CreateGitTreeFactory = (instance) => async (args) => {
-  const { baseTreeSha, blobs } = args;
-
-  const tree = blobs.map((blob) => ({
-    path: blob.path,
-    mode: '100644',
-    type: 'blob',
-    sha: blob.sha,
-  }));
-
-  try {
-    const { data } = await instance.post<CreateGitTreeResponse>(
-      '/git/trees',
-      {
-        base_tree: baseTreeSha,
-        tree,
-      },
-    );
-
-    return createGitTreeSchema.parse(data);
-  } catch (error) {
-    throw handleError(error);
-  }
-};

package/src/github/commit/get-sha-last-commit-of-branch.ts

@@ -1,50 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import { z } from 'zod';
-
-import { handleError } from './utils';
-
-export type GetShaLastCommitOfBranchArgs = {
-  ref: `/heads/${string}`;
-};
-
-export type GetShaLastCommitOfBranchResponse = {
-  sha: string;
-  url: string;
-};
-
-const getShaLastCommitOfBranchSchema = z.object({
-  sha: z.string(),
-  url: z.string(),
-});
-
-export type GetShaLastCommitOfBranch = (
-  args: GetShaLastCommitOfBranchArgs
-) => Promise<GetShaLastCommitOfBranchResponse>;
-
-export type GetShaLastCommitOfBranchFactory = (
-  instance: AxiosInstance
-) => GetShaLastCommitOfBranch;
-
-/**
- * Get the sha of the last commit of a branch
- *
- * @param owner the owner of the repository
- * @param repo the name of the repository
- * @param ref the reference to a branch. Example: /heads/master
- * @param token the github token
- * @returns GetShaLastCommitOfBranchResponse
- * @throws ref-not-found
- */
-export const getShaLastCommitOfBranchFactory: GetShaLastCommitOfBranchFactory = (instance) => async (args) => {
-  const { ref } = args;
-
-  try {
-    const { data } = await instance.get<{
-      object: GetShaLastCommitOfBranchResponse;
-    }>(`/git/refs/${ref}`);
-
-    return getShaLastCommitOfBranchSchema.parse(data.object);
-  } catch (error) {
-    throw handleError(error);
-  }
-};

package/src/github/commit/get-tree-by-commit-sha.ts

@@ -1,52 +0,0 @@
-import type { AxiosInstance } from 'axios';
-import { z } from 'zod';
-
-import { handleError } from './utils';
-
-export type GetTreeShaFromCommitArgs = {
-  sha: string;
-};
-
-export type GetTreeShaFromCommitResponse = {
-  url: string;
-  sha: string;
-};
-
-const getTreeFromCommitShaSchema = z.object({
-  url: z.string(),
-  sha: z.string(),
-});
-
-export type GetTreeShaFromCommit = (
-  args: GetTreeShaFromCommitArgs
-) => Promise<GetTreeShaFromCommitResponse>;
-
-export type GetTreeShaFromCommitFactory = (
-  instance: AxiosInstance
-) => GetTreeShaFromCommit;
-
-/**
- * Get the tree of a commit
- *
- * @param owner the owner of the repository
- * @param repo the name of the repository
- * @param sha the sha of the commit
- * @param token the github token
- * @returns GetTreeShaFromCommitResponse
- * @throws sha-not-found
- * @throws validation-failed-or-the-endpoint-has-been-spammed
- * @throws internal-server-error
- */
-export const getTreeShaFromCommitFactory: GetTreeShaFromCommitFactory = (instance) => async (args) => {
-  const { sha } = args;
-
-  try {
-    const { data } = await instance.get<{
-      tree: GetTreeShaFromCommitResponse;
-    }>(`/git/commits/${sha}`);
-
-    return getTreeFromCommitShaSchema.parse(data.tree);
-  } catch (error) {
-    throw handleError(error);
-  }
-};

package/src/github/commit/index.ts

@@ -1,6 +0,0 @@
-export * from './create-git-blob';
-export * from './create-git-commit';
-export * from './create-git-tree';
-export * from './get-sha-last-commit-of-branch';
-export * from './get-tree-by-commit-sha';
-export * from './run-new-commit-process';

package/src/github/commit/run-new-commit-process.ts

@@ -1,88 +0,0 @@
-import type { CreateGitBlob } from './create-git-blob';
-import type { CreateGitCommit } from './create-git-commit';
-import type { CreateGitTree } from './create-git-tree';
-import type { GetShaLastCommitOfBranch } from './get-sha-last-commit-of-branch';
-import type { GetTreeShaFromCommit } from './get-tree-by-commit-sha';
-
-export type VersionedFile = {
-  path: string;
-  content: string;
-};
-
-export type RunNewCommitProcessArgs = {
-  message: string;
-  ref: `/heads/${string}`;
-  files: VersionedFile[];
-};
-
-export type RunNewCommitProcessResponse = {
-  sha: string;
-  url: string;
-};
-
-export type RunNewCommitProcess = (
-  args: RunNewCommitProcessArgs,
-  updateState?: (state: string) => void
-) => Promise<RunNewCommitProcessResponse>;
-
-export type RunNewCommitProcessFactory = (args: {
-  createGitBlob: CreateGitBlob;
-  createGitCommit: CreateGitCommit;
-  createGitTree: CreateGitTree;
-  getShaLastCommitOfBranch: GetShaLastCommitOfBranch;
-  getTreeShaFromCommit: GetTreeShaFromCommit;
-}) => RunNewCommitProcess;
-
-export const runNewCommitProcessFactory: RunNewCommitProcessFactory = (args) => async (
-  runNewCommitProcessArgs,
-  updateState = () => {},
-) => {
-  const { createGitBlob, createGitCommit, createGitTree, getShaLastCommitOfBranch, getTreeShaFromCommit } = args;
-
-  const { message, ref, files } = runNewCommitProcessArgs;
-
-  updateState('retrieving-sha-last-commit-of-branch');
-  const { sha: shaLastCommit } = await getShaLastCommitOfBranch({
-    ref,
-  });
-  updateState('retrieved-sha-last-commit-of-branch');
-
-  updateState('creating-blobs-from-file');
-  const blobs = await Promise.all(
-    files.map(async (file) => {
-      const blob = await createGitBlob({
-        content: file.content,
-        encoding: 'utf-8',
-      });
-
-      return {
-        path: file.path,
-        sha: blob.sha,
-      };
-    }),
-  );
-  updateState('created-blobs-from-file');
-
-  updateState('retrieving-branch-current-tree');
-  const { sha: lastCommitTreeSha } = await getTreeShaFromCommit({
-    sha: shaLastCommit,
-  });
-  updateState('retrieved-branch-current-tree');
-
-  updateState('creating-new-tree-with-changes');
-  const tree = await createGitTree({
-    baseTreeSha: lastCommitTreeSha,
-    blobs,
-  });
-  updateState('created-new-tree-with-changes');
-
-  updateState('creating-new-commit');
-  const commit = await createGitCommit({
-    message,
-    treeSha: tree.sha,
-    parents: [shaLastCommit],
-  });
-  updateState('created-new-commit');
-
-  return commit;
-};

package/src/github/commit/utils.ts

@@ -1,31 +0,0 @@
-import type { AxiosResponse } from 'axios';
-
-export const handleError = (error: unknown): Error => {
-  const { response } = error as any;
-
-  if (response) {
-    const { status } = response as AxiosResponse;
-
-    if (status === 403) {
-      return new Error('forbidden');
-    }
-
-    if (status === 404) {
-      return new Error('resource-not-found');
-    }
-
-    if (status === 409) {
-      return new Error('conflict');
-    }
-
-    if (status === 422) {
-      return new Error('validation-failed-or-the-endpoint-has-been-spammed');
-    }
-
-    if (status === 500) {
-      return new Error('internal-server-error');
-    }
-  }
-
-  return error as Error;
-};

package/src/github/content/get-file-content.ts

@@ -1,50 +0,0 @@
-import type { AxiosInstance } from 'axios';
-
-import { handleError } from '../commit/utils';
-
-export type GetFileContentArgs = {
-  path: string;
-  branch: string;
-};
-
-type ApiResponse = {
-  encoding: 'base64' | 'utf-8';
-  content: string;
-};
-
-export type GetFileContentResponse = string;
-
-export type GetFileContent = (args: GetFileContentArgs) => Promise<GetFileContentResponse>;
-
-export type GetFileContentFactory = (instance: AxiosInstance) => GetFileContent;
-
-/**
- * Get the content of a file
- *
- * @param path the path of the file
- * @param branch the branch of the file
- * @returns GetFileContentResponse
- * @throws validation-failed-or-the-endpoint-has-been-spammed
- * @throws internal-server-error
- * @throws forbidden
- * @throws resource-not-found
- */
-export const getFileContentFactory: GetFileContentFactory = (instance) => async (args) => {
-  const { path, branch } = args;
-
-  try {
-    const { data } = await instance.get<ApiResponse>(`/contents/${path}`, {
-      params: {
-        ref: branch,
-      },
-    });
-
-    if (data.encoding === 'base64') {
-      return Buffer.from(data.content, 'base64').toString('utf-8');
-    }
-
-    return data.content;
-  } catch (error) {
-    throw handleError(error);
-  }
-};

package/src/github/github.ts

@@ -1,93 +0,0 @@
-import axios from 'axios';
-
-import {
-  createGitBlobFactory,
-  createGitCommitFactory,
-  createGitTreeFactory,
-  getShaLastCommitOfBranchFactory,
-  getTreeShaFromCommitFactory,
-  runNewCommitProcessFactory,
-} from './commit';
-import type {
-  CreateGitTree,
-  CreateGitBlob,
-  CreateGitCommit,
-  GetTreeShaFromCommit,
-  GetShaLastCommitOfBranch,
-  RunNewCommitProcess,
-} from './commit';
-import { GetFileContent, getFileContentFactory } from './content/get-file-content';
-import { CreateBranch, UpdateBranch, createBranchFactory, updateBranchFactory } from './branch';
-import { CreatePullRequest, createPullRequestFactory } from './merge';
-import { MergePullRequest, mergePullRequestFactory } from './merge/merge-pull-request';
-
-export type GithubSdkArgs = {
-  owner: string;
-  repo: string;
-  token: string;
-};
-
-export type GithubSdkInstance = {
-  createGitBlob: CreateGitBlob;
-  createGitCommit: CreateGitCommit;
-  createGitTree: CreateGitTree;
-  getShaLastCommitOfBranch: GetShaLastCommitOfBranch;
-  getTreeShaFromCommit: GetTreeShaFromCommit;
-  runNewCommitProcess: RunNewCommitProcess;
-  getFileContent: GetFileContent;
-  createBranch: CreateBranch;
-  updateBranch: UpdateBranch;
-  createPullRequest: CreatePullRequest;
-  mergePullRequest: MergePullRequest;
-};
-
-export type GithubSdk = (args: GithubSdkArgs) => GithubSdkInstance;
-
-export const githubSdk: GithubSdk = (args) => {
-  const { owner, repo, token } = args;
-
-  const instance = axios.create({
-    baseURL: `https://api.github.com/repos/${owner}/${repo}`,
-    headers: {
-      Accept: 'application/vnd.github+json',
-      Authorization: `Bearer ${token}`,
-      'X-GitHub-Api-Version': '2022-11-28',
-    },
-  });
-
-  const createGitBlob = createGitBlobFactory(instance);
-  const createGitCommit = createGitCommitFactory(instance);
-  const createGitTree = createGitTreeFactory(instance);
-  const getShaLastCommitOfBranch = getShaLastCommitOfBranchFactory(instance);
-  const getTreeShaFromCommit = getTreeShaFromCommitFactory(instance);
-
-  const getFileContent = getFileContentFactory(instance);
-
-  const runNewCommitProcess = runNewCommitProcessFactory({
-    createGitBlob,
-    createGitCommit,
-    createGitTree,
-    getShaLastCommitOfBranch,
-    getTreeShaFromCommit,
-  });
-
-  const createBranch = createBranchFactory(instance);
-  const updateBranch = updateBranchFactory(instance);
-
-  const createPullRequest = createPullRequestFactory(instance);
-  const mergePullRequest = mergePullRequestFactory(instance);
-
-  return {
-    createGitBlob,
-    createGitCommit,
-    createGitTree,
-    getShaLastCommitOfBranch,
-    getTreeShaFromCommit,
-    runNewCommitProcess,
-    getFileContent,
-    createBranch,
-    updateBranch,
-    createPullRequest,
-    mergePullRequest,
-  };
-};

package/src/github/index.ts

@@ -1 +0,0 @@
-export * from './github';