@sourceaxis/provider-github 0.1.0

package/README.md

@@ -0,0 +1,68 @@
+# @sourceaxis/provider-github
+
+GitHub provider and GitHub-first convenience helpers for SourceAxis.
+
+## Install
+
+For GitHub-only alpha releases before npm publishing, install commands are shown as the intended npm
+usage. Until packages are published, use the repository source/tag directly.
+
+```sh
+pnpm add @sourceaxis/provider-github
+```
+
+## Quick Start
+
+```ts
+import { createGitHubClient } from "@sourceaxis/provider-github";
+
+const client = createGitHubClient();
+const repository = await client.open("https://github.com/microsoft/TypeScript");
+
+console.log(await repository.readText("README.md"));
+```
+
+## Authenticated Access
+
+```ts
+import { createGitHubClient } from "@sourceaxis/provider-github";
+
+const token = process.env.SOURCEAXIS_GITHUB_TOKEN;
+const client = createGitHubClient(token === undefined ? {} : { token });
+```
+
+## Public Helpers
+
+- `createGitHubClient(config?)` creates a SourceAxis client with the GitHub provider registered.
+- `githubProvider(config?)` creates the GitHub provider for explicit registration.
+- `githubTokenAuth(token, options?)` creates a GitHub-scoped token authentication strategy.
+- `createGitHubProvider(config?)` is the explicit provider factory.
+- `createGitHubProviderConfig(config?)` returns a provider config fragment for `sourceaxis` or
+  `@sourceaxis/core`.
+
+## Provider-Neutral Setup
+
+Use this form when your application wants to register providers explicitly:
+
+```ts
+import { createSourceAxisClient } from "sourceaxis";
+import { createGitHubProviderConfig, githubTokenAuth } from "@sourceaxis/provider-github";
+
+const token = process.env.SOURCEAXIS_GITHUB_TOKEN;
+
+const client = createSourceAxisClient({
+  ...createGitHubProviderConfig(),
+  authentication: token === undefined ? undefined : githubTokenAuth(token)
+});
+```
+
+## Capabilities
+
+GitHub currently supports files, tree, history/commits, search, branches, tags, releases, issues,
+and pull requests.
+
+## Package Choice
+
+- Use `@sourceaxis/provider-github` for GitHub-first application setup.
+- Use `sourceaxis` for provider-neutral apps that register providers explicitly.
+- Use `@sourceaxis/testing` when certifying providers or writing provider contract tests.

package/dist/cjs/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitHubProviderVersion = exports.GitHubProviderName = exports.GitHubProviderId = void 0;
+exports.GitHubProviderId = "github";
+exports.GitHubProviderName = "GitHub";
+exports.GitHubProviderVersion = "0.0.0";
+//# sourceMappingURL=constants.js.map

package/dist/cjs/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,gBAAgB,GAAG,QAAQ,CAAC;AAC5B,QAAA,kBAAkB,GAAG,QAAQ,CAAC;AAC9B,QAAA,qBAAqB,GAAG,OAAO,CAAC"}

package/dist/cjs/github-models.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=github-models.js.map

package/dist/cjs/github-models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"github-models.js","sourceRoot":"","sources":["github-models.ts"],"names":[],"mappings":""}