feat: add location data with schema validation by PatrickHeneise · Pull Request #15 · gitevents/fetch

PatrickHeneise · 2025-10-29T16:42:47Z

Summary

Adds location data fetching with schema validation for consistent
venue/location data structure.

Closes #9

Changes

✨ Add getLocations() function with schema validation
📋 Define consistent location schema
✅ Validate required and optional fields
🔧 Support custom fields while normalizing core schema
✅ Add comprehensive test suite
📚 Update README with schema documentation

API Usage

import { getLocations } from 'gitevents-fetch'

const result = await getLocations('org', 'events')

// Access validated locations
result.locations.forEach(location => {
  console.log(location.name, location.coordinates)
})

// Check for validation errors
if (result.errors) {
  console.log('Invalid locations:', result.errors)
}

Location Schema

Required fields:

id (string) - Unique identifier
name (string) - Location name

Optional fields:

address (string) - Physical address
coordinates (object) - { lat: number, lng: number }
url (string) - Location website
what3words (string) - what3words address
description (string) - Description
capacity (number) - Venue capacity
accessibility (string) - Accessibility info
Custom fields are preserved

Features

✅ Schema validation for all locations
✅ Returns valid locations + validation errors
✅ Normalizes optional fields to null if missing
✅ Preserves custom fields beyond core schema
✅ Support custom file names and branches
✅ Comprehensive error reporting per location

Test Plan

Unit tests for parameter validation
Unit tests for valid location data
Unit tests for minimal location data
Unit tests for validation errors
Unit tests for custom fields
Unit tests for non-array data rejection
Unit tests for custom file name/branch
README documentation with examples

🤖 Generated with Claude Code

Add functionality to fetch and validate location data with a consistent schema. ## Changes - Add getLocations() function with schema validation - Validate required fields (id, name) - Normalize optional fields with null defaults - Support custom fields in location objects - Add comprehensive test suite - Update README with schema documentation ## Features - Fetch locations.json with consistent schema - Validate each location against schema - Return both valid locations and validation errors - Support custom file names and branches - Preserve custom fields while normalizing core fields - what3words, coordinates, accessibility support 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

Copilot

Pull Request Overview

This PR adds location management functionality to the gitevents-fetch library, enabling users to fetch and validate venue/location data from GitHub repositories. The implementation introduces a new getLocations API function with schema validation and comprehensive test coverage.

Key Changes:

Added getLocations function with location schema validation (id, name, coordinates, etc.)
Comprehensive test suite covering parameter validation, data normalization, custom fields, and error handling
Updated package version from 0.0.3-dev to 0.0.4

Reviewed Changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
src/locations.js	Implements location fetching and validation logic with schema normalization
src/index.js	Exports the new getLocations function as part of the public API
test/locations.test.js	Comprehensive test suite covering all location functionality scenarios
package.json	Version bump to 0.0.4
package-lock.json	Lock file updated for version 0.0.4
README.md	Documentation for the new getLocations API including schema details and examples

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-29T16:46:13Z

src/locations.js

@@ -0,0 +1,131 @@
+import { getFile } from './files.js'


The imported module './files.js' does not exist in the codebase. This will cause a runtime error when the getLocations function is called. Either create the missing files.js module or replace this with the appropriate file-fetching implementation using the graphql client directly.

Copilot · 2025-10-29T16:46:13Z

src/locations.js

+  if (location.coordinates) {
+    if (typeof location.coordinates !== 'object') {
+      errors.push('Location coordinates must be an object')
+    } else {
+      if (typeof location.coordinates.lat !== 'number') {
+        errors.push('Location coordinates.lat must be a number')
+      }
+      if (typeof location.coordinates.lng !== 'number') {
+        errors.push('Location coordinates.lng must be a number')
+      }
+    }
+  }


The validation logic doesn't check if both lat and lng exist when coordinates is provided. If coordinates is an object but missing lat or lng properties, the validation will pass (no error added) but lines 86-87 will attempt to destructure undefined values, resulting in a location object with { lat: undefined, lng: undefined } instead of null.

Copilot · 2025-10-29T16:46:13Z

test/locations.test.js

+import assert from 'node:assert'
+import { getLocations } from '../src/locations.js'
+
+// Mock getFile function


The comment states 'Mock getFile function' but the code that follows actually mocks the graphql function, not getFile. Update comment to 'Mock graphql function for file fetching' to accurately describe what createMockGraphql does.

Suggested change

// Mock getFile function

// Mock graphql function for file fetching

- Add explicit checks for lat/lng existence in coordinates object - Update test comment to accurately describe mocking graphql function - Add test case for missing lat or lng in coordinates Addresses Copilot review comments in PR #15

PatrickHeneise · 2025-10-29T16:54:40Z

Review Updates

Addressed Copilot review comments:

✅ Fixed coordinates validation - Added explicit checks for missing lat or lng properties in coordinates object to prevent undefined values

✅ Fixed test comment - Updated comment to accurately describe mocking graphql function instead of getFile

✅ Added test case - Added comprehensive test for missing lat/lng in coordinates

Dependency Note

⚠️ This PR depends on #12 (File Fetching Support) being merged first, as it imports getFile from ./files.js.

The files.js module exists in PR #12 and provides the file fetching functionality that this locations feature builds upon.

Suggested merge order:

Merge PR feat: add file fetching support #12 first
Rebase/merge this PR feat: add location data with schema validation #15 to include the files.js dependency
Then this PR can be merged

Alternatively, all file-fetching related PRs (#5, #12) can be reviewed together as they form the foundation for this location data feature.

Resolved conflicts between location feature and new main features: - Combined getLocations, getUser, and getFile imports in src/index.js - Merged API documentation for all three functions in README.md - Added parameter validation to getLocations for consistency - All 59 tests passing 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>

Copilot

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-29T22:35:12Z

src/locations.js

+
+function validateParams(params) {
+  const missing = []
+  for (const [key, value] of Object.entries(params)) {
+    if (!value) missing.push(key)
+  }
+  if (missing.length > 0) {
+    throw new Error(`Missing required parameters: ${missing.join(', ')}`)
+  }
+}
+


Duplicated code: The validateParams function is duplicated from src/lib/validateParams.js. Import and use the existing utility function instead of redefining it.

Suggested change

function validateParams(params) {

const missing = []

for (const [key, value] of Object.entries(params)) {

if (!value) missing.push(key)

}

if (missing.length > 0) {

throw new Error(`Missing required parameters: ${missing.join(', ')}`)

}

}

import { validateParams } from './lib/validateParams.js'

Copilot · 2025-10-29T22:35:12Z

src/locations.js

+          url: location.url || null,
+          what3words: location.what3words || null,
+          description: location.description || null,
+          capacity: location.capacity || null,


Incorrect falsy value handling: Using || will convert capacity: 0 to null. Use nullish coalescing (??) instead to preserve zero values.

Suggested change

capacity: location.capacity || null,

capacity: location.capacity ?? null,

github-actions · 2025-10-29T22:42:54Z

🎉 This PR is included in version 1.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Copilot AI review requested due to automatic review settings October 29, 2025 16:42

Copilot AI reviewed Oct 29, 2025

View reviewed changes

PatrickHeneise changed the title ~~feat: add location data with schema validation (#9)~~ feat: add location data with schema validation Oct 29, 2025

PatrickHeneise requested a review from Copilot October 29, 2025 22:33

Copilot AI reviewed Oct 29, 2025

View reviewed changes

PatrickHeneise merged commit 47df775 into main Oct 29, 2025
12 checks passed

PatrickHeneise deleted the feature/locations-schema-9 branch October 29, 2025 22:41

github-actions bot added the released label Oct 29, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add location data with schema validation#15

feat: add location data with schema validation#15
PatrickHeneise merged 3 commits intomainfrom
feature/locations-schema-9

PatrickHeneise commented Oct 29, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

PatrickHeneise commented Oct 29, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Uh oh!

github-actions bot commented Oct 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

	// Mock getFile function
	// Mock graphql function for file fetching

	capacity: location.capacity \|\| null,
	capacity: location.capacity ?? null,

Conversation

PatrickHeneise commented Oct 29, 2025

Summary

Changes

API Usage

Location Schema

Features

Test Plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes:

Reviewed Changes

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

PatrickHeneise commented Oct 29, 2025

Review Updates

Dependency Note

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Oct 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant