git-dlp 0.2.0

package/dist/src/commandLineParams.js

@@ -0,0 +1,172 @@
+import { outdent } from 'outdent';
+import * as CLIOptions from '@effect/cli/Options';
+import * as Path from '@effect/platform/Path';
+import * as Config from 'effect/Config';
+import * as Effect from 'effect/Effect';
+import * as EFunction from 'effect/Function';
+import * as ParseResult from 'effect/ParseResult';
+import * as Schema from 'effect/Schema';
+const isGitHubSlug = (s) => !!s.match(/^[a-z0-9.\-_]+$/gi);
+const invalidGitHubSlugMessage = 'GitHub handle should have only ASCII letters, digits, and the characters ".", "-", and "_"';
+// https://developer.mozilla.org/en-US/docs/Glossary/Slug
+const GitHubSlugStringSchema = Schema.NonEmptyString.pipe(Schema.filter(s => isGitHubSlug(s) || invalidGitHubSlugMessage));
+// TODO change approach to default values. Either remove defaults completely or
+// provided an easy way to set for people their own defaults instead of
+// comparing them to the hardcoded default value. Also document the helpers for
+// overriding defaults in TSDoc of exported CLIOptions objects
+const withGitHubSlugConfigValidation = Config.validate({
+    message: invalidGitHubSlugMessage,
+    validation: isGitHubSlug,
+});
+const pathToEntityInRepoDescription = 'Path to file or directory in repo';
+const repoOwnerDescription = outdent `
+  This is a username (login handle) of a person owning repo you
+  are trying to download from. For example, if the repository's URL is
+  \`https://github.com/apache/superset\`, the owner is \`apache\`
+`;
+const repoNameDescription = outdent `
+  This is the name handle of the repository you are trying to download
+  from. For example, if the repository's URL is
+  \`https://github.com/apache/superset\`, the name is \`superset\`
+`;
+const destinationPathDescription = outdent `
+  Local path of the downloaded file or directory. If
+  "pathToEntityInRepo" points to a file, then last element of the
+  destination path will be new file name. If "pathToEntityInRepo" points
+  to a directory then all files and directories inside directory at
+  "pathToEntityInRepo" will be put into a directory with name equal last
+  element of destination path. If the directory doesn't exist, it will
+  be automatically created.
+`;
+const gitRefDescription = outdent `
+  This is the commit's SHA hash, branch name, tag name, or any other ref
+  you want to download from. If you don't specify it, the default branch
+  in the repository will be used.
+`;
+const RepoNameConfig = EFunction.pipe(Config.nonEmptyString('REPO_NAME'), withGitHubSlugConfigValidation, Config.withDescription(repoNameDescription));
+const RepoOwnerConfig = EFunction.pipe(Config.nonEmptyString('REPO_OWNER'), withGitHubSlugConfigValidation, Config.withDescription(repoOwnerDescription));
+const DestinationPathConfig = EFunction.pipe(Config.nonEmptyString('DESTINATION_PATH'), Config.withDefault('./destination'), Config.withDescription(destinationPathDescription));
+const PathToEntityInRepoConfig = EFunction.pipe(Config.nonEmptyString('PATH_TO_ENTITY_IN_REPO'), Config.withDefault('.'), Config.withDescription(pathToEntityInRepoDescription));
+const GitRefConfig = EFunction.pipe(Config.nonEmptyString('GIT_REF'), Config.withDefault('HEAD'), Config.withDescription(gitRefDescription));
+const CleanRepoEntityPathString = Schema.transformOrFail(Schema.NonEmptyString, Schema.NonEmptyString, {
+    strict: true,
+    decode: (dirtyPathToEntityInRepo, _, ast) => Effect.flatMap(Path.Path, path => {
+        // dot can be there only when that's all there is. path.join(...)
+        // removes all './', so '.' will never be just left by themself. If it's
+        // there, it's very intentional and no other elements in the path exist.
+        const cleanPathToEntityInRepo = path
+            .join(dirtyPathToEntityInRepo)
+            .replaceAll(/\/?$/g, '');
+        if (cleanPathToEntityInRepo.startsWith('..'))
+            return ParseResult.fail(new ParseResult.Type(ast, dirtyPathToEntityInRepo, "Can't request contents that lie higher than the root of the repo"));
+        return ParseResult.succeed(cleanPathToEntityInRepo);
+    }),
+    encode: ParseResult.succeed,
+});
+/**
+ * Text parameter containing path to a directory or a file inside target repo.
+ *
+ * Can be passed in two ways:
+ * 1. As CLI option `gdl --pathToEntityInRepo nestedFolder/Readme.md`
+ * 2. As env variable `PATH_TO_ENTITY_IN_REPO="nestedFolder/Readme.md" gdl`
+ *
+ * Has default: `.`, which means that if not specified, script will download
+ * entire repository (download root directory of the repository)
+ *
+ * Parameter is automatically validated to not point higher than the root of the
+ * repository.
+ *
+ * @since 0.1.7
+ * @category CLI options
+ * @constant
+ */
+export const pathToEntityInRepoCLIOptionBackedByEnv = EFunction.pipe(CLIOptions.text(`pathToEntityInRepo`), CLIOptions.withDescription(pathToEntityInRepoDescription), CLIOptions.withFallbackConfig(PathToEntityInRepoConfig), CLIOptions.withSchema(CleanRepoEntityPathString));
+/**
+ * Text parameter containing URL slug of the user which owns the repo.
+ *
+ * Examples:
+ * 1. `apache`
+ * 2. `nikelborm`
+ *
+ * Can be passed in two ways:
+ * 1. As CLI option `gdl --repoOwner apache`
+ * 2. As env variable `REPO_OWNER="apache" gdl`
+ *
+ * Doesn`t have defaults and will fail if not specified.
+ *
+ * Parameter is automatically validated so it can consist of only ASCII letters,
+ * digits, and the characters `.`, `-`, and `_`.
+ *
+ * @since 0.1.7
+ * @category CLI options
+ * @constant
+ */
+export const repoOwnerCLIOptionBackedByEnv = EFunction.pipe(CLIOptions.text(`repoOwner`), CLIOptions.withDescription(repoOwnerDescription), CLIOptions.withFallbackConfig(RepoOwnerConfig), CLIOptions.withSchema(GitHubSlugStringSchema));
+/**
+ * Text parameter containing URL slug of the repo itself.
+ *
+ * Examples:
+ * 1. `superset`
+ * 2. `git-dl`
+ *
+ * Can be passed in two ways:
+ * 1. As CLI option `gdl --repoName superset`
+ * 2. As env variable `REPO_NAME="superset" gdl`
+ *
+ * Doesn`t have defaults and will fail if not specified.
+ *
+ * Parameter is automatically validated so it can consist of only ASCII letters,
+ * digits, and the characters `.`, `-`, and `_`.
+ *
+ * @since 0.1.7
+ * @category CLI options
+ * @constant
+ */
+export const repoNameCLIOptionBackedByEnv = EFunction.pipe(CLIOptions.text(`repoName`), CLIOptions.withDescription(repoNameDescription), CLIOptions.withFallbackConfig(RepoNameConfig), CLIOptions.withSchema(GitHubSlugStringSchema));
+/**
+ * Text parameter containing path inside your local file system, your new
+ * file/directory will be placed at. Last element of the path will be the name
+ * of the new file/directory.
+ *
+ * Examples:
+ * 1. `../docker`
+ * 2. `/tmp/Readme.md`
+ *
+ * Can be passed in two ways:
+ * 1. As CLI option `gdl --destinationPath docker`
+ * 2. As env variable `DESTINATION_PATH="docker" gdl`
+ *
+ * Has default: `./destination`, which means that if not specified, script will
+ * either create a file or a directory named `destination` inside your current PWD
+ * depending on the type of remote target.
+ *
+ * @since 0.1.7
+ * @category CLI options
+ * @constant
+ * @readonly
+ */
+export const destinationPathCLIOptionBackedByEnv = EFunction.pipe(CLIOptions.text(`destinationPath`), CLIOptions.withDescription(destinationPathDescription), CLIOptions.withFallbackConfig(DestinationPathConfig));
+/**
+ * Text parameter containing commit SHA hash, branch name, or tag name you want
+ * to download from.
+ *
+ * Examples:
+ * 1. `HEAD`
+ * 2. `main`
+ * 3. `4.1.1`
+ * 4. `dca3efb3dd2a2a75aea32e3561c4104a53f02808`
+ * 5. `dca3efb`
+ *
+ * Can be passed in two ways:
+ * 1. As CLI option `gdl --gitRef 4.1.1`
+ * 2. As env variable `GIT_REF="4.1.1" gdl`
+ *
+ * Has default: `HEAD`, which means that if not specified, the default branch in
+ * the repository will be used.
+ *
+ * @since 0.1.7
+ * @category CLI options
+ * @constant
+ */
+export const gitRefCLIOptionBackedByEnv = EFunction.pipe(CLIOptions.text(`gitRef`), CLIOptions.withDescription(gitRefDescription), CLIOptions.withFallbackConfig(GitRefConfig));
+//# sourceMappingURL=commandLineParams.js.map

package/dist/src/commandLineParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commandLineParams.js","sourceRoot":"","sources":["../../src/commandLineParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEjC,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAA;AACjD,OAAO,KAAK,IAAI,MAAM,uBAAuB,CAAA;AAC7C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAA;AAC5C,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAA;AAElE,MAAM,wBAAwB,GAC5B,4FAA4F,CAAA;AAE9F,yDAAyD;AACzD,MAAM,sBAAsB,GAAG,MAAM,CAAC,cAAc,CAAC,IAAI,CACvD,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,wBAAwB,CAAC,CAEhE,CAAA;AAED,+EAA+E;AAC/E,uEAAuE;AACvE,+EAA+E;AAC/E,8DAA8D;AAE9D,MAAM,8BAA8B,GAAG,MAAM,CAAC,QAAQ,CAAC;IACrD,OAAO,EAAE,wBAAwB;IACjC,UAAU,EAAE,YAAY;CACzB,CAAC,CAAA;AAEF,MAAM,6BAA6B,GAAG,mCAAmC,CAAA;AAEzE,MAAM,oBAAoB,GAAG,OAAO,CAAA;;;;CAInC,CAAA;AAED,MAAM,mBAAmB,GAAG,OAAO,CAAA;;;;CAIlC,CAAA;AAED,MAAM,0BAA0B,GAAG,OAAO,CAAA;;;;;;;;CAQzC,CAAA;AAED,MAAM,iBAAiB,GAAG,OAAO,CAAA;;;;CAIhC,CAAA;AAED,MAAM,cAAc,GAAG,SAAS,CAAC,IAAI,CACnC,MAAM,CAAC,cAAc,CAAC,WAAW,CAAC,EAClC,8BAA8B,EAC9B,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAC5C,CAAA;AAED,MAAM,eAAe,GAAG,SAAS,CAAC,IAAI,CACpC,MAAM,CAAC,cAAc,CAAC,YAAY,CAAC,EACnC,8BAA8B,EAC9B,MAAM,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAC7C,CAAA;AAED,MAAM,qBAAqB,GAAG,SAAS,CAAC,IAAI,CAC1C,MAAM,CAAC,cAAc,CAAC,kBAAkB,CAAC,EACzC,MAAM,CAAC,WAAW,CAAC,eAAe,CAAC,EACnC,MAAM,CAAC,eAAe,CAAC,0BAA0B,CAAC,CACnD,CAAA;AAED,MAAM,wBAAwB,GAAG,SAAS,CAAC,IAAI,CAC7C,MAAM,CAAC,cAAc,CAAC,wBAAwB,CAAC,EAC/C,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,EACvB,MAAM,CAAC,eAAe,CAAC,6BAA6B,CAAC,CACtD,CAAA;AAED,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CACjC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,EAChC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAC1B,MAAM,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAC1C,CAAA;AAED,MAAM,yBAAyB,GAAG,MAAM,CAAC,eAAe,CACtD,MAAM,CAAC,cAAc,EACrB,MAAM,CAAC,cAAc,EACrB;IACE,MAAM,EAAE,IAAI;IACZ,MAAM,EAAE,CAAC,uBAAuB,EAAE,CAAC,EAAE,GAAG,EAAE,EAAE,CAC1C,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE;QAC/B,iEAAiE;QACjE,wEAAwE;QACxE,wEAAwE;QACxE,MAAM,uBAAuB,GAAG,IAAI;aACjC,IAAI,CAAC,uBAAuB,CAAC;aAC7B,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAA;QAE1B,IAAI,uBAAuB,CAAC,UAAU,CAAC,IAAI,CAAC;YAC1C,OAAO,WAAW,CAAC,IAAI,CACrB,IAAI,WAAW,CAAC,IAAI,CAClB,GAAG,EACH,uBAAuB,EACvB,kEAAkE,CACnE,CACF,CAAA;QACH,OAAO,WAAW,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACrD,CAAC,CAAC;IACJ,MAAM,EAAE,WAAW,CAAC,OAAO;CAC5B,CACF,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,sCAAsC,GACjD,SAAS,CAAC,IAAI,CACZ,UAAU,CAAC,IAAI,CAAC,oBAAoB,CAAC,EACrC,UAAU,CAAC,eAAe,CAAC,6BAA6B,CAAC,EACzD,UAAU,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,EACvD,UAAU,CAAC,UAAU,CAAC,yBAAyB,CAAC,CACjD,CAAA;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,6BAA6B,GACxC,SAAS,CAAC,IAAI,CACZ,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,EAC5B,UAAU,CAAC,eAAe,CAAC,oBAAoB,CAAC,EAChD,UAAU,CAAC,kBAAkB,CAAC,eAAe,CAAC,EAC9C,UAAU,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAC9C,CAAA;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,MAAM,4BAA4B,GACvC,SAAS,CAAC,IAAI,CACZ,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,EAC3B,UAAU,CAAC,eAAe,CAAC,mBAAmB,CAAC,EAC/C,UAAU,CAAC,kBAAkB,CAAC,cAAc,CAAC,EAC7C,UAAU,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAC9C,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAC9C,SAAS,CAAC,IAAI,CACZ,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAClC,UAAU,CAAC,eAAe,CAAC,0BAA0B,CAAC,EACtD,UAAU,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,CACrD,CAAA;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,0BAA0B,GACrC,SAAS,CAAC,IAAI,CACZ,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,EACzB,UAAU,CAAC,eAAe,CAAC,iBAAiB,CAAC,EAC7C,UAAU,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAC5C,CAAA"}

package/dist/src/commonErrors.js

@@ -0,0 +1,60 @@
+import { RequestError } from '@octokit/request-error';
+import { buildTaggedErrorClassVerifyingCause, } from "./TaggedErrorVerifyingCause.js";
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _1 = buildTaggedErrorClassVerifyingCause()('GitHubApiGeneralServerError', 'GitHub API Error: Bad server', RequestError);
+export class GitHubApiGeneralServerError extends _1 {
+}
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _2 = buildTaggedErrorClassVerifyingCause()('GitHubApiGeneralUserError', 'GitHub API Error: Bad user, invalid request', RequestError);
+export class GitHubApiGeneralUserError extends _2 {
+}
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _3 = buildTaggedErrorClassVerifyingCause()('GitHubApiThingNotExistsOrYouDontHaveAccessError', "GitHub API Error: Either repo, owner, path in repo, or specified ref don't exist or you don't have permissions to access it", RequestError);
+export class GitHubApiThingNotExistsOrYouDontHaveAccessError extends _3 {
+}
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _4 = buildTaggedErrorClassVerifyingCause()('GitHubApiRepoIsEmptyError', 'GitHub API Error: This Repo is empty', RequestError);
+export class GitHubApiRepoIsEmptyError extends _4 {
+}
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _5 = buildTaggedErrorClassVerifyingCause()('GitHubApiNoCommitFoundForGitRefError', 'GitHub API Error: No commit found for this git ref', RequestError);
+export class GitHubApiNoCommitFoundForGitRefError extends _5 {
+}
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _6 = buildTaggedErrorClassVerifyingCause()('GitHubApiBadCredentialsError', "GitHub API Error: Token you're using is invalid.", RequestError);
+export class GitHubApiBadCredentialsError extends _6 {
+}
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _7 = buildTaggedErrorClassVerifyingCause()('GitHubApiAuthRatelimitedError', 'GitHub API Error: Too many invalid auth attempts. Chillout pal', RequestError);
+export class GitHubApiAuthRatelimitedError extends _7 {
+}
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _8 = buildTaggedErrorClassVerifyingCause()('GitHubApiRatelimitedError', 'GitHub API Error: Too many requests. Chillout pal', RequestError);
+export class GitHubApiRatelimitedError extends _8 {
+}
+export const parseCommonGitHubApiErrors = (error) => {
+    if (error.status === 401)
+        return new GitHubApiBadCredentialsError(error);
+    // https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api?apiVersion=2022-11-28#failed-login-limit
+    if (error.status === 403)
+        return new GitHubApiAuthRatelimitedError(error);
+    // docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api?apiVersion=2022-11-28
+    if (error.status === 429)
+        return new GitHubApiRatelimitedError(error);
+    if (error.status === 404)
+        return new GitHubApiThingNotExistsOrYouDontHaveAccessError(error);
+    if (error.status >= 500)
+        return new GitHubApiGeneralServerError(error);
+    if (error.status >= 400)
+        return new GitHubApiGeneralUserError(error, {});
+    return error;
+};
+//# sourceMappingURL=commonErrors.js.map

package/dist/src/commonErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonErrors.js","sourceRoot":"","sources":["../../src/commonErrors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAErD,OAAO,EACL,mCAAmC,GAEpC,MAAM,gCAAgC,CAAA;AAEvC,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,EAAE,GAGH,mCAAmC,EAAE,CACxC,6BAA6B,EAC7B,8BAA8B,EAC9B,YAAY,CACb,CAAA;AAED,MAAM,OAAO,2BAA4B,SAAQ,EAAE;CAAG;AAEtD,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,EAAE,GAIH,mCAAmC,EAA+B,CACrE,2BAA2B,EAC3B,6CAA6C,EAC7C,YAAY,CACb,CAAA;AAED,MAAM,OAAO,yBAA0B,SAAQ,EAAE;CAAG;AAEpD,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,EAAE,GAGH,mCAAmC,EAAE,CACxC,iDAAiD,EACjD,6HAA6H,EAC7H,YAAY,CACb,CAAA;AAED,MAAM,OAAO,+CAAgD,SAAQ,EAAE;CAAG;AAE1E,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,EAAE,GAGH,mCAAmC,EAAE,CACxC,2BAA2B,EAC3B,sCAAsC,EACtC,YAAY,CACb,CAAA;AAED,MAAM,OAAO,yBAA0B,SAAQ,EAAE;CAAG;AAEpD,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,EAAE,GAIH,mCAAmC,EAAsB,CAC5D,sCAAsC,EACtC,oDAAoD,EACpD,YAAY,CACb,CAAA;AAED,MAAM,OAAO,oCAAqC,SAAQ,EAAE;CAAG;AAE/D,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,EAAE,GAGH,mCAAmC,EAAE,CACxC,8BAA8B,EAC9B,kDAAkD,EAClD,YAAY,CACb,CAAA;AAED,MAAM,OAAO,4BAA6B,SAAQ,EAAE;CAAG;AAEvD,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,EAAE,GAGH,mCAAmC,EAAE,CACxC,+BAA+B,EAC/B,gEAAgE,EAChE,YAAY,CACb,CAAA;AAED,MAAM,OAAO,6BAA8B,SAAQ,EAAE;CAAG;AAExD,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,EAAE,GAGH,mCAAmC,EAAE,CACxC,2BAA2B,EAC3B,mDAAmD,EACnD,YAAY,CACb,CAAA;AAED,MAAM,OAAO,yBAA0B,SAAQ,EAAE;CAAG;AAEpD,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,KAAmB,EAAE,EAAE;IAChE,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,4BAA4B,CAAC,KAAK,CAAC,CAAA;IAExE,yHAAyH;IACzH,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,6BAA6B,CAAC,KAAK,CAAC,CAAA;IAEzE,gGAAgG;IAChG,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG;QAAE,OAAO,IAAI,yBAAyB,CAAC,KAAK,CAAC,CAAA;IAErE,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG;QACtB,OAAO,IAAI,+CAA+C,CAAC,KAAK,CAAC,CAAA;IAEnE,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG;QAAE,OAAO,IAAI,2BAA2B,CAAC,KAAK,CAAC,CAAA;IAEtE,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG;QAAE,OAAO,IAAI,yBAAyB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IAExE,OAAO,KAAK,CAAA;AACd,CAAC,CAAA"}

package/dist/src/configContext.js

@@ -0,0 +1,12 @@
+import * as Context from 'effect/Context';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+export const InputConfigTag = Context.GenericTag('InputConfig');
+export const OutputConfigTag = Context.GenericTag('OutputConfig');
+const InputConfigLive = (inputConfig) => Layer.succeed(InputConfigTag, InputConfigTag.of(inputConfig));
+export const provideInputConfig = (inputConfig) => Effect.provide(InputConfigLive(inputConfig));
+const OutputConfigLive = (outputConfig) => Layer.succeed(OutputConfigTag, OutputConfigTag.of(outputConfig));
+export const provideSingleDownloadTargetConfig = ({ localPathAtWhichEntityFromRepoWillBeAvailable, ...inputConfig }) => Effect.provide(Layer.merge(InputConfigLive(inputConfig), OutputConfigLive({
+    localPathAtWhichEntityFromRepoWillBeAvailable,
+})));
+//# sourceMappingURL=configContext.js.map

package/dist/src/configContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configContext.js","sourceRoot":"","sources":["../../src/configContext.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAWrC,MAAM,CAAC,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,CAAc,aAAa,CAAC,CAAA;AAM5E,MAAM,CAAC,MAAM,eAAe,GAAG,OAAO,CAAC,UAAU,CAAe,cAAc,CAAC,CAAA;AAE/E,MAAM,eAAe,GAAG,CAAC,WAAwB,EAAE,EAAE,CACnD,KAAK,CAAC,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAA;AAE/D,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,WAAwB,EAAE,EAAE,CAC7D,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAA;AAE9C,MAAM,gBAAgB,GAAG,CAAC,YAA0B,EAAE,EAAE,CACtD,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,eAAe,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAA;AAIlE,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,EAChD,6CAA6C,EAC7C,GAAG,WAAW,EACK,EAE6C,EAAE,CAClE,MAAM,CAAC,OAAO,CACZ,KAAK,CAAC,KAAK,CACT,eAAe,CAAC,WAAW,CAAC,EAC5B,gBAAgB,CAAC;IACf,6CAA6C;CAC9C,CAAC,CACH,CACF,CAAA"}

package/dist/src/downloadEntityFromRepo.js

@@ -0,0 +1,21 @@
+import * as Effect from 'effect/Effect';
+import { provideSingleDownloadTargetConfig, } from "./configContext.js";
+import { PathContentsMetaInfo, RawStreamOfRepoPathContentsFromGitHubAPI, } from "./getPathContents/index.js";
+import { getReadableTarGzStreamOfRepoDirectory } from "./getReadableTarGzStreamOfRepoDirectory.js";
+import { unpackRepoFolderTarGzStreamToFs, } from "./unpackRepoFolderTarGzStreamToFs.js";
+import { writeFileStreamToDestinationPath, } from "./writeFileStreamToDestinationPath.js";
+const downloadEntityFromRepoWithoutContext = Effect.gen(function* () {
+    const pathContentsMetaInfo = yield* PathContentsMetaInfo;
+    if (pathContentsMetaInfo.type === 'dir')
+        return yield* unpackRepoFolderTarGzStreamToFs(getReadableTarGzStreamOfRepoDirectory(pathContentsMetaInfo.treeSha));
+    if (pathContentsMetaInfo.meta ===
+        'This file is small enough that GitHub API decided to inline it')
+        return yield* writeFileStreamToDestinationPath(pathContentsMetaInfo.contentStream);
+    if (pathContentsMetaInfo.meta === 'This file can be downloaded as a blob')
+        return yield* writeFileStreamToDestinationPath(RawStreamOfRepoPathContentsFromGitHubAPI);
+    yield* Effect.dieMessage('LFS files are not yet supported');
+});
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+export const downloadEntityFromRepo = (target) => downloadEntityFromRepoWithoutContext.pipe(provideSingleDownloadTargetConfig(target));
+//# sourceMappingURL=downloadEntityFromRepo.js.map

package/dist/src/downloadEntityFromRepo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"downloadEntityFromRepo.js","sourceRoot":"","sources":["../../src/downloadEntityFromRepo.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAavC,OAAO,EACL,iCAAiC,GAElC,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAGL,oBAAoB,EACpB,wCAAwC,GACzC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,qCAAqC,EAAE,MAAM,4CAA4C,CAAA;AAClG,OAAO,EAEL,+BAA+B,GAChC,MAAM,sCAAsC,CAAA;AAC7C,OAAO,EAEL,gCAAgC,GACjC,MAAM,uCAAuC,CAAA;AAE9C,MAAM,oCAAoC,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAC/D,MAAM,oBAAoB,GAAG,KAAK,CAAC,CAAC,oBAAoB,CAAA;IAExD,IAAI,oBAAoB,CAAC,IAAI,KAAK,KAAK;QACrC,OAAO,KAAK,CAAC,CAAC,+BAA+B,CAC3C,qCAAqC,CAAC,oBAAoB,CAAC,OAAO,CAAC,CACpE,CAAA;IAEH,IACE,oBAAoB,CAAC,IAAI;QACzB,gEAAgE;QAEhE,OAAO,KAAK,CAAC,CAAC,gCAAgC,CAC5C,oBAAoB,CAAC,aAAa,CACnC,CAAA;IAEH,IAAI,oBAAoB,CAAC,IAAI,KAAK,uCAAuC;QACvE,OAAO,KAAK,CAAC,CAAC,gCAAgC,CAC5C,wCAAwC,CACzC,CAAA;IAEH,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,iCAAiC,CAAC,CAAA;AAC7D,CAAC,CAAC,CAAA;AAEF,6EAA6E;AAC7E,+CAA+C;AAC/C,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,MAA0B,EAmB1B,EAAE,CACF,oCAAoC,CAAC,IAAI,CACvC,iCAAiC,CAAC,MAAM,CAAC,CAC1C,CAAA"}

package/dist/src/errors.js

@@ -0,0 +1,10 @@
+/**
+ * @module
+ */
+export { FailedToCastDataToReadableStreamError } from "./castToReadableStream.js";
+export { GitHubApiAuthRatelimitedError, GitHubApiBadCredentialsError, GitHubApiGeneralServerError, GitHubApiGeneralUserError, GitHubApiNoCommitFoundForGitRefError, GitHubApiRatelimitedError, GitHubApiRepoIsEmptyError, GitHubApiThingNotExistsOrYouDontHaveAccessError, } from "./commonErrors.js";
+export { FailedToParseGitLFSInfoError, FailedToParseResponseFromRepoPathContentsMetaInfoAPIError, InconsistentExpectedAndRealContentSizeError, } from "./getPathContents/index.js";
+export * from "./TaggedErrorVerifyingCause.js";
+export { FailedToUnpackRepoFolderTarGzStreamToFsError } from "./unpackRepoFolderTarGzStreamToFs.js";
+export { FailedToWriteFileStreamToDestinationPathError } from "./writeFileStreamToDestinationPath.js";
+//# sourceMappingURL=errors.js.map

package/dist/src/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,qCAAqC,EAAE,MAAM,2BAA2B,CAAA;AACjF,OAAO,EACL,6BAA6B,EAC7B,4BAA4B,EAE5B,2BAA2B,EAC3B,yBAAyB,EACzB,oCAAoC,EACpC,yBAAyB,EACzB,yBAAyB,EACzB,+CAA+C,GAChD,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACL,4BAA4B,EAC5B,yDAAyD,EACzD,2CAA2C,GAC5C,MAAM,4BAA4B,CAAA;AACnC,cAAc,gCAAgC,CAAA;AAC9C,OAAO,EAAE,4CAA4C,EAAE,MAAM,sCAAsC,CAAA;AACnG,OAAO,EAAE,6CAA6C,EAAE,MAAM,uCAAuC,CAAA"}

package/dist/src/getPathContents/ParsedMetaInfoAboutPathContentsFromGitHubAPI.js

@@ -0,0 +1,43 @@
+import * as Effect from 'effect/Effect';
+import * as Either from 'effect/Either';
+import * as ParseResult from 'effect/ParseResult';
+import * as Schema from 'effect/Schema';
+import { buildTaggedErrorClassVerifyingCause, } from "../TaggedErrorVerifyingCause.js";
+import { RepoPathContentsFromGitHubAPI } from "./RepoPathContentsFromGitHubAPI.js";
+export const UnparsedMetaInfoAboutPathContentsFromGitHubAPI = RepoPathContentsFromGitHubAPI('object');
+export const ParsedMetaInfoAboutPathContentsFromGitHubAPI = Effect.gen(function* () {
+    const response = yield* UnparsedMetaInfoAboutPathContentsFromGitHubAPI;
+    return yield* Either.mapLeft(decodeResponse(response.data), parseError => new FailedToParseResponseFromRepoPathContentsMetaInfoAPIError(parseError, {
+        response,
+    }));
+});
+const GitSomethingFields = {
+    size: Schema.Number,
+    name: Schema.String,
+    path: Schema.String,
+    sha: Schema.String,
+};
+const dirLiteral = Schema.Literal('dir');
+const nonDirLiterals = Schema.Literal('file', 'submodule', 'symlink');
+export const ResponseSchema = Schema.Union(Schema.Struct({
+    type: Schema.Literal('dir'),
+    entries: Schema.Struct({
+        type: Schema.Union(dirLiteral, nonDirLiterals),
+        ...GitSomethingFields,
+    }).pipe(Schema.Array),
+    ...GitSomethingFields,
+}), Schema.Struct({
+    type: Schema.Literal('file'),
+    encoding: Schema.Literal('base64', 'none'),
+    content: Schema.String,
+    ...GitSomethingFields,
+}));
+const decodeResponse = Schema.decodeUnknownEither(ResponseSchema, {
+    exact: true,
+});
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _1 = buildTaggedErrorClassVerifyingCause()('FailedToParseResponseFromRepoPathContentsMetaInfoAPI', `Failed to parse response from repo path contents meta info API`, ParseResult.ParseError);
+export class FailedToParseResponseFromRepoPathContentsMetaInfoAPIError extends _1 {
+}
+//# sourceMappingURL=ParsedMetaInfoAboutPathContentsFromGitHubAPI.js.map

package/dist/src/getPathContents/ParsedMetaInfoAboutPathContentsFromGitHubAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ParsedMetaInfoAboutPathContentsFromGitHubAPI.js","sourceRoot":"","sources":["../../../src/getPathContents/ParsedMetaInfoAboutPathContentsFromGitHubAPI.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,EACL,mCAAmC,GAEpC,MAAM,iCAAiC,CAAA;AACxC,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAA;AAElF,MAAM,CAAC,MAAM,8CAA8C,GACzD,6BAA6B,CAAC,QAAQ,CAAC,CAAA;AAEzC,MAAM,CAAC,MAAM,4CAA4C,GAAG,MAAM,CAAC,GAAG,CACpE,QAAQ,CAAC;IACP,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,8CAA8C,CAAA;IAEtE,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAC1B,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,EAC7B,UAAU,CAAC,EAAE,CACX,IAAI,yDAAyD,CAC3D,UAAU,EACV;QACE,QAAQ;KACT,CACF,CACJ,CAAA;AACH,CAAC,CACF,CAAA;AAED,MAAM,kBAAkB,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM;IACnB,GAAG,EAAE,MAAM,CAAC,MAAM;CACnB,CAAA;AAED,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;AACxC,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,SAAS,CAAC,CAAA;AAErE,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAC,KAAK,CACxC,MAAM,CAAC,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;IAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,cAAc,CAAC;QAC9C,GAAG,kBAAkB;KACtB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IACrB,GAAG,kBAAkB;CACtB,CAAC,EACF,MAAM,CAAC,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1C,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,GAAG,kBAAkB;CACtB,CAAC,CACH,CAAA;AAED,MAAM,cAAc,GAAG,MAAM,CAAC,mBAAmB,CAAC,cAAc,EAAE;IAChE,KAAK,EAAE,IAAI;CACZ,CAAC,CAAA;AAEF,6EAA6E;AAC7E,+CAA+C;AAE/C,MAAM,EAAE,GAIH,mCAAmC,EAAyB,CAC/D,sDAAsD,EACtD,gEAAgE,EAChE,WAAW,CAAC,UAAU,CACvB,CAAA;AAED,MAAM,OAAO,yDAA0D,SAAQ,EAAE;CAAG"}

package/dist/src/getPathContents/PathContentsMetaInfo.js

@@ -0,0 +1,71 @@
+import * as Effect from 'effect/Effect';
+import { CastToReadableStream } from "../castToReadableStream.js";
+import { ParsedMetaInfoAboutPathContentsFromGitHubAPI } from "./ParsedMetaInfoAboutPathContentsFromGitHubAPI.js";
+import { parseGitLFSObjectEither } from "./parseGitLFSObjectEither.js";
+export const PathContentsMetaInfo = Effect.gen(function* () {
+    const response = yield* ParsedMetaInfoAboutPathContentsFromGitHubAPI;
+    const { type, name, path, size } = response;
+    if (type === 'dir') {
+        const { entries, sha: treeSha } = response;
+        if (name && path)
+            return {
+                type,
+                name,
+                path,
+                treeSha,
+                entries,
+                meta: 'This nested directory can be downloaded as a git tree',
+            };
+        return {
+            type,
+            treeSha,
+            entries,
+            meta: 'This root directory of the repo can be downloaded as a git tree',
+        };
+    }
+    // This is quite forgiving implementation. I had the choice to throw
+    // errors whenever GitHub's API didn't follow its documentation. I even
+    // did that initially, but when I looked at the resulting mess, I changed
+    // my mind not to. For example, I could throw errors in the following
+    // cases:
+    // 1. When the size is between 1 MB and 100 MB per documentation, I
+    //    should never receive data. Instead, I should receive an empty
+    //    "content" field and an "encoding" field equal to "none." If this
+    //    promise was broken, I could have thrown an error. Instead, if I
+    //    receive a 50 MB file with the correct encoding, I will parse and
+    //    return it.
+    // 2. Per the documentation, all files larger than 100 MB should be put
+    //    into Git LFS storage. If I receive a 110 MB file inlined, I'll not
+    //    fail; I'll parse and return it.
+    // 3. Per documentation when size less than 1MB it MUST be inlined. If it
+    //    wasn't inlined I could have thrown an error, but instead, I just
+    //    returned an object representing the message "It's a blob, download
+    //    it elsewhere"
+    // 4. Per documentation files larger than 100 mb must be in a git LFS
+    //    storage and it's assumed that git LFS annotation will be provided.
+    //    But if it's not provided, instead of throwing an error, I returned
+    //    an object representing the message "It's a blob, download it
+    //    elsewhere"
+    // In the end it leads to much lower complexity with a ton of IFs removed
+    const { content, encoding, sha: blobSha, ...restFileObjectFields } = response;
+    const base = { ...restFileObjectFields, blobSha };
+    if (encoding === 'none')
+        return { ...base, meta: 'This file can be downloaded as a blob' };
+    const contentAsBuffer = Buffer.from(content, encoding);
+    const potentialGitLFSObject = yield* parseGitLFSObjectEither({
+        contentAsBuffer,
+        expectedContentSize: size,
+    });
+    if (typeof potentialGitLFSObject === 'object')
+        return {
+            ...base,
+            ...potentialGitLFSObject,
+            meta: 'This file can be downloaded as a git-LFS object',
+        };
+    return {
+        ...base,
+        contentStream: CastToReadableStream(Effect.succeed(contentAsBuffer)),
+        meta: 'This file is small enough that GitHub API decided to inline it',
+    };
+});
+//# sourceMappingURL=PathContentsMetaInfo.js.map

package/dist/src/getPathContents/PathContentsMetaInfo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PathContentsMetaInfo.js","sourceRoot":"","sources":["../../../src/getPathContents/PathContentsMetaInfo.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,EAAE,4CAA4C,EAAE,MAAM,mDAAmD,CAAA;AAChH,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAA;AAEtE,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IACtD,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,4CAA4C,CAAA;IAEpE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,QAAQ,CAAA;IAE3C,IAAI,IAAI,KAAK,KAAK,EAAE,CAAC;QACnB,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAA;QAE1C,IAAI,IAAI,IAAI,IAAI;YACd,OAAO;gBACL,IAAI;gBACJ,IAAI;gBACJ,IAAI;gBACJ,OAAO;gBACP,OAAO;gBACP,IAAI,EAAE,uDAAuD;aACrD,CAAA;QAEZ,OAAO;YACL,IAAI;YACJ,OAAO;YACP,OAAO;YACP,IAAI,EAAE,iEAAiE;SAC/D,CAAA;IACZ,CAAC;IAED,oEAAoE;IACpE,uEAAuE;IACvE,yEAAyE;IACzE,qEAAqE;IACrE,SAAS;IAET,mEAAmE;IACnE,mEAAmE;IACnE,sEAAsE;IACtE,qEAAqE;IACrE,sEAAsE;IACtE,gBAAgB;IAChB,uEAAuE;IACvE,wEAAwE;IACxE,qCAAqC;IACrC,yEAAyE;IACzE,sEAAsE;IACtE,wEAAwE;IACxE,mBAAmB;IACnB,qEAAqE;IACrE,wEAAwE;IACxE,wEAAwE;IACxE,kEAAkE;IAClE,gBAAgB;IAEhB,yEAAyE;IAEzE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,oBAAoB,EAAE,GAAG,QAAQ,CAAA;IAC7E,MAAM,IAAI,GAAG,EAAE,GAAG,oBAAoB,EAAE,OAAO,EAAE,CAAA;IAEjD,IAAI,QAAQ,KAAK,MAAM;QACrB,OAAO,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,uCAAuC,EAAW,CAAA;IAE5E,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAEtD,MAAM,qBAAqB,GAAG,KAAK,CAAC,CAAC,uBAAuB,CAAC;QAC3D,eAAe;QACf,mBAAmB,EAAE,IAAI;KAC1B,CAAC,CAAA;IAEF,IAAI,OAAO,qBAAqB,KAAK,QAAQ;QAC3C,OAAO;YACL,GAAG,IAAI;YACP,GAAG,qBAAqB;YACxB,IAAI,EAAE,iDAAiD;SAC/C,CAAA;IAEZ,OAAO;QACL,GAAG,IAAI;QACP,aAAa,EAAE,oBAAoB,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;QACpE,IAAI,EAAE,gEAAgE;KAC9D,CAAA;AACZ,CAAC,CAAC,CAAA"}

package/dist/src/getPathContents/RawStreamOfRepoPathContentsFromGitHubAPI.js

@@ -0,0 +1,4 @@
+import { CastToReadableStream } from "../castToReadableStream.js";
+import { RepoPathContentsFromGitHubAPI } from "./RepoPathContentsFromGitHubAPI.js";
+export const RawStreamOfRepoPathContentsFromGitHubAPI = CastToReadableStream(RepoPathContentsFromGitHubAPI('raw', true));
+//# sourceMappingURL=RawStreamOfRepoPathContentsFromGitHubAPI.js.map

package/dist/src/getPathContents/RawStreamOfRepoPathContentsFromGitHubAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RawStreamOfRepoPathContentsFromGitHubAPI.js","sourceRoot":"","sources":["../../../src/getPathContents/RawStreamOfRepoPathContentsFromGitHubAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAA;AAElF,MAAM,CAAC,MAAM,wCAAwC,GAAG,oBAAoB,CAC1E,6BAA6B,CAAC,KAAK,EAAE,IAAI,CAAC,CAC3C,CAAA"}

package/dist/src/getPathContents/RepoPathContentsFromGitHubAPI.js

@@ -0,0 +1,51 @@
+import { RequestError } from '@octokit/request-error';
+import * as Cause from 'effect/Cause';
+import * as Effect from 'effect/Effect';
+import { GitHubApiNoCommitFoundForGitRefError, GitHubApiRepoIsEmptyError, GitHubApiThingNotExistsOrYouDontHaveAccessError, parseCommonGitHubApiErrors, } from "../commonErrors.js";
+import { InputConfigTag } from "../configContext.js";
+import { OctokitTag } from "../octokit.js";
+// TODO make better typesignature so that it actually reflects what's returned:
+// stream or parsed body use params as a generic. (but generally fuck github API
+// and their fucking octokit)
+export const RepoPathContentsFromGitHubAPI = Effect.fn('getRepoPathContentsFromGitHubAPI')(function* (format, streamBody) {
+    const octokit = yield* OctokitTag;
+    const { gitRef, pathToEntityInRepo, repo } = yield* InputConfigTag;
+    // TODO: improve sitation on what's default with git ref. Better set null
+    // instead of empty string? to signify it's not present actually. Also should
+    // note that HEAD could mean something different when ref is not specified.
+    // Should consider if we should fallback to HEAD or just not specifiying the
+    // property at all.
+    return yield* Effect.tryPromise({
+        try: signal => octokit.request('GET /repos/{owner}/{repo}/contents/{path}', {
+            owner: repo.owner,
+            repo: repo.name,
+            path: pathToEntityInRepo,
+            ...(gitRef && { ref: gitRef }),
+            request: {
+                signal,
+                parseSuccessResponseBody: !streamBody,
+            },
+            mediaType: { format },
+            headers: {
+                'X-GitHub-Api-Version': '2022-11-28',
+            },
+        }),
+        catch: error => {
+            if (!(error instanceof RequestError))
+                return new Cause.UnknownException(error, 'Failed to request contents at the path inside GitHub repo');
+            const potentialErrorMessage = error.response?.data
+                ?.message;
+            if (error.status === 404 && potentialErrorMessage)
+                return parseNotFoundErrors(potentialErrorMessage, error, gitRef);
+            return parseCommonGitHubApiErrors(error);
+        },
+    });
+});
+const parseNotFoundErrors = (potentialErrorMessage, error, gitRef) => {
+    if (potentialErrorMessage === 'This repository is empty.')
+        return new GitHubApiRepoIsEmptyError(error);
+    if (gitRef && potentialErrorMessage.startsWith('No commit found for the ref'))
+        return new GitHubApiNoCommitFoundForGitRefError(error, { gitRef });
+    return new GitHubApiThingNotExistsOrYouDontHaveAccessError(error);
+};
+//# sourceMappingURL=RepoPathContentsFromGitHubAPI.js.map

package/dist/src/getPathContents/RepoPathContentsFromGitHubAPI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RepoPathContentsFromGitHubAPI.js","sourceRoot":"","sources":["../../../src/getPathContents/RepoPathContentsFromGitHubAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAGrD,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,EACL,oCAAoC,EACpC,yBAAyB,EACzB,+CAA+C,EAC/C,0BAA0B,GAC3B,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE1C,+EAA+E;AAC/E,gFAAgF;AAChF,6BAA6B;AAC7B,MAAM,CAAC,MAAM,6BAA6B,GAAG,MAAM,CAAC,EAAE,CACpD,kCAAkC,CACnC,CAAC,QAAQ,CAAC,EAAE,MAAwB,EAAE,UAAoB;IACzD,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,UAAU,CAAA;IAEjC,MAAM,EAAE,MAAM,EAAE,kBAAkB,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,cAAc,CAAA;IAClE,yEAAyE;IACzE,6EAA6E;IAC7E,2EAA2E;IAC3E,4EAA4E;IAC5E,mBAAmB;IAEnB,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;QAC9B,GAAG,EAAE,MAAM,CAAC,EAAE,CACZ,OAAO,CAAC,OAAO,CAAC,2CAA2C,EAAE;YAC3D,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,kBAAkB;YACxB,GAAG,CAAC,MAAM,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;YAC9B,OAAO,EAAE;gBACP,MAAM;gBACN,wBAAwB,EAAE,CAAC,UAAU;aACtC;YACD,SAAS,EAAE,EAAE,MAAM,EAAE;YACrB,OAAO,EAAE;gBACP,sBAAsB,EAAE,YAAY;aACrC;SACF,CAAC;QACJ,KAAK,EAAE,KAAK,CAAC,EAAE;YACb,IAAI,CAAC,CAAC,KAAK,YAAY,YAAY,CAAC;gBAClC,OAAO,IAAI,KAAK,CAAC,gBAAgB,CAC/B,KAAK,EACL,2DAA2D,CAC5D,CAAA;YAEH,MAAM,qBAAqB,GAAI,KAAK,CAAC,QAA8B,EAAE,IAAI;gBACvE,EAAE,OAAO,CAAA;YAEX,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,IAAI,qBAAqB;gBAC/C,OAAO,mBAAmB,CAAC,qBAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;YAElE,OAAO,0BAA0B,CAAC,KAAK,CAAC,CAAA;QAC1C,CAAC;KACF,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEF,MAAM,mBAAmB,GAAG,CAC1B,qBAA6B,EAC7B,KAAmB,EACnB,MAAc,EACd,EAAE;IACF,IAAI,qBAAqB,KAAK,2BAA2B;QACvD,OAAO,IAAI,yBAAyB,CAAC,KAAK,CAAC,CAAA;IAE7C,IAAI,MAAM,IAAI,qBAAqB,CAAC,UAAU,CAAC,6BAA6B,CAAC;QAC3E,OAAO,IAAI,oCAAoC,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,CAAC,CAAA;IAEpE,OAAO,IAAI,+CAA+C,CAAC,KAAK,CAAC,CAAA;AACnE,CAAC,CAAA"}

package/dist/src/getPathContents/index.js

@@ -0,0 +1,5 @@
+export { FailedToParseResponseFromRepoPathContentsMetaInfoAPIError } from "./ParsedMetaInfoAboutPathContentsFromGitHubAPI.js";
+export { PathContentsMetaInfo } from "./PathContentsMetaInfo.js";
+export { FailedToParseGitLFSInfoError, InconsistentExpectedAndRealContentSizeError, } from "./parseGitLFSObjectEither.js";
+export { RawStreamOfRepoPathContentsFromGitHubAPI } from "./RawStreamOfRepoPathContentsFromGitHubAPI.js";
+//# sourceMappingURL=index.js.map

package/dist/src/getPathContents/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/getPathContents/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yDAAyD,EAAE,MAAM,mDAAmD,CAAA;AAC7H,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EACL,4BAA4B,EAC5B,2CAA2C,GAC5C,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,wCAAwC,EAAE,MAAM,+CAA+C,CAAA"}

package/dist/src/getPathContents/parseGitLFSObjectEither.js

@@ -0,0 +1,70 @@
+import { outdent } from 'outdent';
+import * as Either from 'effect/Either';
+import * as ParseResult from 'effect/ParseResult';
+import * as Schema from 'effect/Schema';
+import { buildTaggedErrorClassVerifyingCause, } from "../TaggedErrorVerifyingCause.js";
+export const parseGitLFSObjectEither = ({ contentAsBuffer, expectedContentSize, }) => Either.gen(function* () {
+    // gitLFS info usually is no longer than MAX_GIT_LFS_INFO_SIZE bytes
+    const contentAsString = contentAsBuffer
+        .subarray(0, MAX_GIT_LFS_INFO_SIZE)
+        .toString('utf8');
+    const parsingResult = Either.mapLeft(decodeGitLFSInfoSchema(contentAsString.match(gitLFSInfoRegexp)?.groups), cause => new FailedToParseGitLFSInfoError(cause, {
+        partOfContentThatCouldBeGitLFSInfo: contentAsString,
+    }));
+    const matchedByRegexpAndParsedByEffectSchema = Either.isRight(parsingResult);
+    const doesSizeFromGitLFSInfoAlignWithExpectedContentSize = Either.isRight(parsingResult) &&
+        parsingResult.right.size === expectedContentSize;
+    const shouldFailIfItIsNotGitLFS = contentAsBuffer.byteLength !== expectedContentSize;
+    const isThisAGitLFSObject = matchedByRegexpAndParsedByEffectSchema &&
+        doesSizeFromGitLFSInfoAlignWithExpectedContentSize;
+    if (isThisAGitLFSObject)
+        return {
+            gitLFSObjectIdSha256: parsingResult.right.oidSha256,
+            gitLFSVersion: parsingResult.right.version,
+        };
+    if (shouldFailIfItIsNotGitLFS)
+        return yield* Either.left(new InconsistentExpectedAndRealContentSizeError({
+            actual: contentAsBuffer.byteLength,
+            expected: expectedContentSize,
+            gitLFSInfo: parsingResult,
+        }));
+    return 'This is not a git LFS object';
+});
+// there are some responses that look like
+// `version https://git-lfs.github.com/spec/v1
+// oid sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+// size 128
+// `
+// and the only variable thing in it is the size at the end, and I assume
+// that supported file size is not greater than 100 GB
+const MAX_GIT_LFS_INFO_SIZE = 137;
+// Don't add regexp /g modifier, it breaks match groups
+const gitLFSInfoRegexp = /^version (?<version>https:\/\/git-lfs\.github\.com\/spec\/v1)\noid sha256:(?<oidSha256>[0-9a-f]{64})\nsize (?<size>[1-9]\d{0,11})\n$/m;
+const GitLFSInfoSchema = Schema.Struct({
+    version: Schema.NonEmptyTrimmedString,
+    oidSha256: Schema.NonEmptyTrimmedString,
+    size: Schema.NumberFromString,
+});
+const decodeGitLFSInfoSchema = Schema.decodeUnknownEither(GitLFSInfoSchema, {
+    exact: true,
+});
+const _1 = buildTaggedErrorClassVerifyingCause()('FailedToParseGitLFSInfoError', `Failed to parse git LFS announcement`, ParseResult.ParseError);
+export class FailedToParseGitLFSInfoError extends _1 {
+}
+// Extracting to a separate type is required by JSR, so that consumers of the
+// library will have much faster type inference
+const _2 = buildTaggedErrorClassVerifyingCause()('InconsistentExpectedAndRealContentSizeError', ctx => `Got file with size ${ctx.actual} bytes while expecting ${ctx.expected} bytes`, void 0, {
+    comment: outdent({ newline: ' ' }) `
+      If we weren't successful in parsing it as git LFS object
+      announcement using RegExp and Effect.Schema, we just do a basic size
+      consistency check. The check implements the second marker of it
+      being a Git LFS object as a backup to checking does "content" look
+      like a Git LFS object. If GitHub API's "size" field is different
+      from actual size of "content" field, it means either our schema with
+      regexp fucked up, or GitHub API did. If it doesn't throw, it means
+      there's no reason to assume it's a Git LFS object.
+    `,
+});
+export class InconsistentExpectedAndRealContentSizeError extends _2 {
+}
+//# sourceMappingURL=parseGitLFSObjectEither.js.map

package/dist/src/getPathContents/parseGitLFSObjectEither.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parseGitLFSObjectEither.js","sourceRoot":"","sources":["../../../src/getPathContents/parseGitLFSObjectEither.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEjC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAA;AACjD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,EACL,mCAAmC,GAEpC,MAAM,iCAAiC,CAAA;AAExC,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,EACtC,eAAe,EACf,mBAAmB,GAIpB,EAAE,EAAE,CACH,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,oEAAoE;IACpE,MAAM,eAAe,GAAG,eAAe;SACpC,QAAQ,CAAC,CAAC,EAAE,qBAAqB,CAAC;SAClC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAEnB,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAClC,sBAAsB,CAAC,eAAe,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC,EACvE,KAAK,CAAC,EAAE,CACN,IAAI,4BAA4B,CAAC,KAAK,EAAE;QACtC,kCAAkC,EAAE,eAAe;KACpD,CAAC,CACL,CAAA;IAED,MAAM,sCAAsC,GAAG,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;IAC5E,MAAM,kDAAkD,GACtD,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC;QAC7B,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,mBAAmB,CAAA;IAElD,MAAM,yBAAyB,GAC7B,eAAe,CAAC,UAAU,KAAK,mBAAmB,CAAA;IAEpD,MAAM,mBAAmB,GACvB,sCAAsC;QACtC,kDAAkD,CAAA;IAEpD,IAAI,mBAAmB;QACrB,OAAO;YACL,oBAAoB,EAAE,aAAa,CAAC,KAAK,CAAC,SAAS;YACnD,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,OAAO;SAClC,CAAA;IAEZ,IAAI,yBAAyB;QAC3B,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CACvB,IAAI,2CAA2C,CAAC;YAC9C,MAAM,EAAE,eAAe,CAAC,UAAU;YAClC,QAAQ,EAAE,mBAAmB;YAC7B,UAAU,EAAE,aAAa;SAC1B,CAAC,CACH,CAAA;IAEH,OAAO,8BAAuC,CAAA;AAChD,CAAC,CAAC,CAAA;AAEJ,0CAA0C;AAC1C,8CAA8C;AAC9C,8EAA8E;AAC9E,WAAW;AACX,IAAI;AACJ,yEAAyE;AACzE,sDAAsD;AACtD,MAAM,qBAAqB,GAAG,GAAG,CAAA;AACjC,uDAAuD;AACvD,MAAM,gBAAgB,GACpB,uIAAuI,CAAA;AAEzI,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC;IACrC,OAAO,EAAE,MAAM,CAAC,qBAAqB;IACrC,SAAS,EAAE,MAAM,CAAC,qBAAqB;IACvC,IAAI,EAAE,MAAM,CAAC,gBAAgB;CAC9B,CAAC,CAAA;AAEF,MAAM,sBAAsB,GAAG,MAAM,CAAC,mBAAmB,CAAC,gBAAgB,EAAE;IAC1E,KAAK,EAAE,IAAI;CACZ,CAAC,CAAA;AAUF,MAAM,EAAE,GACN,mCAAmC,EAE/B,CACF,8BAA8B,EAC9B,sCAAsC,EACtC,WAAW,CAAC,UAAU,CACvB,CAAA;AAEH,MAAM,OAAO,4BAA6B,SAAQ,EAAE;CAAG;AAevD,6EAA6E;AAC7E,+CAA+C;AAE/C,MAAM,EAAE,GAIH,mCAAmC,EAAmC,CACzE,6CAA6C,EAC7C,GAAG,CAAC,EAAE,CACJ,sBAAsB,GAAG,CAAC,MAAM,0BAA0B,GAAG,CAAC,QAAQ,QAAQ,EAChF,KAAK,CAAC,EACN;IACE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAA;;;;;;;;;KASjC;CACF,CACF,CAAA;AAED,MAAM,OAAO,2CAA4C,SAAQ,EAAE;CAAG"}