@checkstack/auth-github-backend 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,86 @@
+# @checkstack/auth-github-backend
+
+## 0.0.2
+
+### Patch Changes
+
+- d20d274: Initial release of all @checkstack packages. Rebranded from Checkmate to Checkstack with new npm organization @checkstack and domain checkstack.dev.
+- Updated dependencies [d20d274]
+  - @checkstack/auth-backend@0.0.2
+  - @checkstack/backend-api@0.0.2
+  - @checkstack/common@0.0.2
+
+## 0.0.4
+
+### Patch Changes
+
+- a65e002: Add compile-time type safety for Lucide icon names
+
+  - Add `LucideIconName` type and `lucideIconSchema` Zod schema to `@checkstack/common`
+  - Update backend interfaces (`AuthStrategy`, `NotificationStrategy`, `IntegrationProvider`, `CommandDefinition`) to use `LucideIconName`
+  - Update RPC contracts to use `lucideIconSchema` for proper type inference across RPC boundaries
+  - Simplify `SocialProviderButton` to use `DynamicIcon` directly (removes 30+ lines of pascalCase conversion)
+  - Replace static `iconMap` in `SearchDialog` with `DynamicIcon` for dynamic icon rendering
+  - Add fallback handling in `DynamicIcon` when icon name isn't found
+  - Fix legacy kebab-case icon names to PascalCase: `mail`→`Mail`, `send`→`Send`, `github`→`Github`, `key-round`→`KeyRound`, `network`→`Network`, `AlertCircle`→`CircleAlert`
+
+- Updated dependencies [b4eb432]
+- Updated dependencies [a65e002]
+- Updated dependencies [a65e002]
+  - @checkstack/backend-api@1.1.0
+  - @checkstack/common@0.2.0
+  - @checkstack/auth-backend@1.1.0
+
+## 0.0.3
+
+### Patch Changes
+
+- @checkstack/auth-backend@1.0.1
+
+## 0.0.2
+
+### Patch Changes
+
+- b354ab3: # Strategy Instructions Support & Telegram Notification Plugin
+
+  ## Strategy Instructions Interface
+
+  Added `adminInstructions` and `userInstructions` optional fields to the `NotificationStrategy` interface. These allow strategies to export markdown-formatted setup guides that are displayed in the configuration UI:
+
+  - **`adminInstructions`**: Shown when admins configure platform-wide strategy settings (e.g., how to create API keys)
+  - **`userInstructions`**: Shown when users configure their personal settings (e.g., how to link their account)
+
+  ### Updated Components
+
+  - `StrategyConfigCard` now accepts an `instructions` prop and renders it before config sections
+  - `StrategyCard` passes `adminInstructions` to `StrategyConfigCard`
+  - `UserChannelCard` renders `userInstructions` when users need to connect
+
+  ## New Telegram Notification Plugin
+
+  Added `@checkstack/notification-telegram-backend` plugin for sending notifications via Telegram:
+
+  - Uses [grammY](https://grammy.dev/) framework for Telegram Bot API integration
+  - Sends messages with MarkdownV2 formatting and inline keyboard buttons for actions
+  - Includes comprehensive admin instructions for bot setup via @BotFather
+  - Includes user instructions for account linking
+
+  ### Configuration
+
+  Admins need to configure a Telegram Bot Token obtained from @BotFather.
+
+  ### User Linking
+
+  The strategy uses `contactResolution: { type: "custom" }` for Telegram Login Widget integration. Full frontend integration for the Login Widget is pending future work.
+
+- Updated dependencies [ffc28f6]
+- Updated dependencies [71275dd]
+- Updated dependencies [ae19ff6]
+- Updated dependencies [32f2535]
+- Updated dependencies [b55fae6]
+- Updated dependencies [b354ab3]
+- Updated dependencies [8e889b4]
+- Updated dependencies [81f3f85]
+  - @checkstack/common@0.1.0
+  - @checkstack/backend-api@1.0.0
+  - @checkstack/auth-backend@1.0.0

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@checkstack/auth-github-backend",
+  "version": "0.0.2",
+  "type": "module",
+  "main": "src/index.ts",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@checkstack/backend-api": "workspace:*",
+    "@checkstack/auth-backend": "workspace:*",
+    "@checkstack/common": "workspace:*",
+    "zod": "^4.2.1"
+  },
+  "devDependencies": {
+    "@checkstack/tsconfig": "workspace:*",
+    "typescript": "^5.9.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,70 @@
+import {
+  createBackendPlugin,
+  type AuthStrategy,
+  configString,
+} from "@checkstack/backend-api";
+import { betterAuthExtensionPoint } from "@checkstack/auth-backend";
+import { z } from "zod";
+import { pluginMetadata } from "./plugin-metadata";
+
+/**
+ * GitHub OAuth configuration schema.
+ * Follows better-auth GitHub provider requirements.
+ */
+const _githubConfigV1 = z.object({
+  enabled: z.boolean().default(false),
+  clientId: configString({ "x-secret": true })
+    .describe("GitHub OAuth App Client ID")
+    .optional(),
+  clientSecret: configString({ "x-secret": true })
+    .describe("GitHub OAuth App Client Secret")
+    .optional(),
+});
+
+const githubConfigV2 = z.object({
+  clientId: configString({ "x-secret": true })
+    .describe("GitHub OAuth App Client ID")
+    .optional(),
+  clientSecret: configString({ "x-secret": true })
+    .describe("GitHub OAuth App Client Secret")
+    .optional(),
+});
+
+const githubStrategy: AuthStrategy<z.infer<typeof githubConfigV2>> = {
+  id: "github",
+  displayName: "GitHub",
+  description: "Sign in with GitHub",
+  icon: "Github",
+  configVersion: 2,
+  configSchema: githubConfigV2,
+  requiresManualRegistration: false,
+  adminInstructions: `
+## GitHub OAuth App Setup
+
+1. Go to [GitHub Developer Settings](https://github.com/settings/developers)
+2. Click **New OAuth App**
+3. Set **Homepage URL** to your Checkstack instance URL
+4. Set **Authorization callback URL** to \`https://yourdomain.com/api/auth/callback/github\`
+5. Copy the **Client ID** and generate a **Client Secret**
+`.trim(),
+  migrations: [
+    {
+      fromVersion: 1,
+      toVersion: 2,
+      description: "Remove 'enabled' field from config (moved to meta config)",
+      migrate: (oldConfig: z.infer<typeof _githubConfigV1>) => {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { enabled, ...rest } = oldConfig;
+        return rest;
+      },
+    },
+  ],
+};
+
+export default createBackendPlugin({
+  metadata: pluginMetadata,
+  register(env) {
+    const extensionPoint = env.getExtensionPoint(betterAuthExtensionPoint);
+    extensionPoint.addStrategy(githubStrategy);
+  },
+});

package/src/plugin-metadata.ts

@@ -0,0 +1,9 @@
+import { definePluginMetadata } from "@checkstack/common";
+
+/**
+ * Plugin metadata for the Auth GitHub backend.
+ * This is the single source of truth for the plugin ID.
+ */
+export const pluginMetadata = definePluginMetadata({
+  pluginId: "auth-github",
+});

package/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@checkstack/tsconfig/backend.json"
+}