feat: add additional utils and extensive testing

Author: tkstang

README.md

@@ -6,12 +6,27 @@ This package provides a comprehensive set of TypeScript utilities for interactin
 
 ## Features
 
-- ✅ **Sticky Comments** - Create and manage persistent, updatable comments
-- ✅ **Pull Request Utilities** - Find, label, and manage pull requests
-- ✅ **Comment Search** - Search and filter issue/PR comments
+### 📋 Complete Function Reference
+
+| Category                  | Functions                                                                                                                                                                                                    | Description                                                         |
+| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- |
+| **💬 Comments**           | `createStickyComment`, `findCommentByIdentifier`, `searchComments`, `deleteComment`, `deleteStickyComment`                                                                                                   | Create, find, search, and manage issue/PR comments                  |
+| **🔀 Pull Requests**      | `findPullRequestsByLabels`, `getPullRequest`, `addLabelsToPullRequest`, `removeLabelsFromPullRequest`, `pullRequestHasLabels`, `getPullRequestFiles`                                                         | Find, manage, and interact with pull requests                       |
+| **🔍 Advanced PR Search** | `findPRsWithLabels`, `searchPullRequests`, `findOpenPRsWithLabel`, `checkLabelConflicts`                                                                                                                     | Advanced pull request search and label conflict detection           |
+| **🌿 Branch Management**  | `checkBranchExists`, `listAllBranches`, `getBranchProtection`, `getDefaultBranch`                                                                                                                            | Branch existence, listing, and protection management                |
+| **🚀 Deployments**        | `listDeployments`, `getDeploymentStatuses`, `setDeploymentStatus`, `deleteDeployment`, `createDeployment`                                                                                                    | Deployment lifecycle management                                     |
+| **🔧 Context & Utils**    | `getRepoInfo`, `getCurrentPullRequestNumber`, `getCurrentIssueNumber`, `isPullRequestContext`, `isIssueContext`, `getCurrentSHA`, `getCurrentBranch`, `getRepositoryUrl`, `getIssueUrl`, `getPullRequestUrl` | GitHub Actions context extraction and URL helpers                   |
+| **📝 Text & Formatting**  | `escapeMarkdown`, `codeBlock`, `createMarkdownTable`, `truncateText`, `formatDate`, `parseGitHubDate`, `delay`                                                                                               | Text formatting, markdown utilities, and date handling              |
+| **🔤 String Utilities**   | `snakeToCamel`, `camelToSnake`, `kebabToCamel`, `camelToKebab`, `capitalize`, `toTitleCase`                                                                                                                  | String case conversion and text transformation                      |
+| **⚙️ Input Processing**   | `sanitizeInput`, `sanitizeInputs`, `getBranch`                                                                                                                                                               | Input sanitization and branch extraction from various GitHub events |
+
+### ✨ Key Features
+
 - ✅ **Type Safety** - Full TypeScript support with comprehensive type definitions
-- ✅ **Context Helpers** - Extract repository and event information from GitHub Actions context
-- ✅ **Markdown Utilities** - Format and escape content for GitHub markdown
+- ✅ **Universal Compatibility** - Works with all GitHub event types and contexts
+- ✅ **Comprehensive Testing** - 110+ tests with 94%+ code coverage
+- ✅ **GitHub API Optimized** - Efficient API usage with proper error handling and pagination support
+- ✅ **Developer Friendly** - Intuitive APIs with TypeScript intellisense and JSDoc documentation
 
 ---
 
@@ -278,6 +293,180 @@ const table = createMarkdownTable(
 const short = truncateText("Very long text...", 50);
 ```
 
+### String Utilities
+
+#### Case Conversion
+
+```ts
+import {
+  snakeToCamel,
+  camelToSnake,
+  kebabToCamel,
+  camelToKebab,
+  capitalize,
+  toTitleCase,
+} from "github-typescript-utils";
+
+// Convert between naming conventions
+const camelCase = snakeToCamel("hello_world"); // "helloWorld"
+const snakeCase = camelToSnake("helloWorld"); // "hello_world"
+const kebabCase = camelToKebab("helloWorld"); // "hello-world"
+const camelFromKebab = kebabToCamel("hello-world"); // "helloWorld"
+
+// Text transformation
+const capitalized = capitalize("hello"); // "Hello"
+const titleCase = toTitleCase("hello world"); // "Hello World"
+```
+
+### Branch Management
+
+#### Branch Operations
+
+```ts
+import {
+  checkBranchExists,
+  listAllBranches,
+  getBranchProtection,
+  getDefaultBranch,
+} from "github-typescript-utils";
+
+// Check if branch exists
+const exists = await checkBranchExists({
+  ctx: { core, github, context },
+  repo,
+  branch: "feature-branch",
+});
+
+// List all branches
+const branches = await listAllBranches({
+  ctx: { core, github, context },
+  repo,
+  limit: 50,
+});
+
+// Get branch protection rules
+const protection = await getBranchProtection({
+  ctx: { core, github, context },
+  repo,
+  branch: "main",
+});
+
+// Get default branch
+const defaultBranch = await getDefaultBranch({
+  ctx: { core, github, context },
+  repo,
+});
+```
+
+### Deployment Management
+
+#### Deployment Lifecycle
+
+```ts
+import {
+  listDeployments,
+  createDeployment,
+  setDeploymentStatus,
+  getDeploymentStatuses,
+  deleteDeployment,
+} from "github-typescript-utils";
+
+// Create a deployment
+const deployment = await createDeployment({
+  ctx: { core, github, context },
+  repo,
+  ref: "main",
+  environment: "production",
+  description: "Deploy v1.0.0",
+});
+
+// Set deployment status
+await setDeploymentStatus({
+  ctx: { core, github, context },
+  repo,
+  deploymentId: deployment.id,
+  state: "success",
+  description: "Deployment completed successfully",
+});
+
+// List deployments
+const deployments = await listDeployments({
+  ctx: { core, github, context },
+  repo,
+  environment: "production",
+});
+```
+
+### Advanced PR Search
+
+#### Enhanced PR Operations
+
+```ts
+import {
+  findPRsWithLabels,
+  searchPullRequests,
+  checkLabelConflicts,
+  findOpenPRsWithLabel,
+} from "github-typescript-utils";
+
+// Find PRs with multiple labels
+const prs = await findPRsWithLabels({
+  ctx: { core, github, context },
+  repo,
+  labels: ["bug", "urgent"],
+  excludePRs: [123], // Exclude specific PR numbers
+});
+
+// Advanced PR search
+const searchResults = await searchPullRequests({
+  ctx: { core, github, context },
+  repo,
+  options: {
+    labels: ["feature"],
+    author: "dependabot[bot]",
+    state: "open",
+  },
+});
+
+// Check for label conflicts
+const conflict = await checkLabelConflicts({
+  ctx: { core, github, context },
+  repo,
+  prNumber: 123,
+  label: "sync-branch: main",
+});
+
+if (conflict.hasConflict) {
+  core.warning(`Label conflict with PR #${conflict.conflictingPR?.number}`);
+}
+```
+
+### Input Processing
+
+#### Input Sanitization and Branch Extraction
+
+```ts
+import {
+  sanitizeInput,
+  sanitizeInputs,
+  getBranch,
+} from "github-typescript-utils";
+
+// Remove quotes from workflow inputs
+const cleanInput = sanitizeInput('"quoted-value"'); // "quoted-value"
+
+// Sanitize all string properties in an object
+const cleanInputs = sanitizeInputs({
+  name: '"John"',
+  age: 30,
+  title: '"Developer"',
+}); // { name: "John", age: 30, title: "Developer" }
+
+// Extract branch from any GitHub event
+const branch = getBranch({ core, github, context });
+// Works with: pull_request, push, workflow_run, etc.
+```
+
 ---
 
 ## Type Definitions
@@ -286,13 +475,24 @@ The package exports comprehensive TypeScript types:
 
 ```ts
 import type {
+  // Core types
   GitHubContext,
   RepoInfo,
   PullRequest,
   IssueComment,
+
+  // Comment types
   StickyCommentOptions,
   CommentSearchOptions,
+
+  // Pull request types
   PullRequestSearchOptions,
+  PullRequestFile,
+  AdvancedPRSearchOptions,
+
+  // Deployment types
+  Deployment,
+  DeploymentStatus,
 } from "github-typescript-utils";
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-typescript-utils",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Utility functions for GitHub REST API interactions with github-typescript",
   "type": "module",
   "main": "./dist/index.js",
@@ -41,14 +41,17 @@
     "build:watch": "tsc --watch",
     "clean": "rm -rf dist",
     "dev": "tsc --watch",
+    "test": "vitest",
+    "test:run": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "lint": "biome lint src/",
     "lint:fix": "biome lint --write src/",
     "format": "biome format src/",
     "format:fix": "biome format --write src/",
     "check": "biome check src/",
     "check:fix": "biome check --write src/",
     "type-check": "tsc --noEmit",
-    "prepublishOnly": "pnpm run clean && pnpm run build"
+    "prepublishOnly": "pnpm run clean && pnpm run test:run && pnpm run build"
   },
   "peerDependencies": {
     "@actions/core": "^1.10.0",
@@ -59,7 +62,9 @@
     "@actions/github": "^6.0.0",
     "@biomejs/biome": "^2.1.1",
     "@types/node": "^22.17.0",
-    "typescript": "^5.8.3"
+    "@vitest/coverage-v8": "^3.2.4",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4"
   },
   "packageManager": "[email protected]",
   "engines": {