@rachelallyson/planning-center-people-ts 2.6.1 → 2.6.2

package/CHANGELOG.md

@@ -5,6 +5,51 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.6.2] - 2025-01-10
+
+### 🎯 **TYPE DEFINITION ENHANCEMENT**
+
+This patch release adds enhanced type definitions for better TypeScript support and developer experience.
+
+### Added
+
+- **📝 FieldDataType Type**: Added comprehensive type definition for field data types
+  - **Types**: `'boolean' | 'checkboxes' | 'date' | 'file' | 'number' | 'select' | 'string' | 'text'`
+  - **Usage**: Provides type safety for field definition operations
+  - **Benefits**: Better IntelliSense and compile-time validation
+
+### Enhanced Type Safety
+
+```typescript
+// Now you get full type safety for field data types
+const fieldDefinition: FieldDefinitionAttributes = {
+  data_type: 'select', // ✅ TypeScript knows this is valid
+  // ... other properties
+};
+
+// Invalid types will be caught at compile time
+const invalidField = {
+  data_type: 'invalid', // ❌ TypeScript error
+};
+```
+
+### Migration
+
+No breaking changes - this is a type enhancement release:
+
+```typescript
+// Existing code continues to work
+const fields = await client.people.getFieldDefinitions();
+
+// New type safety benefits
+fields.data.forEach(field => {
+  if (field.attributes.data_type === 'select') {
+    // TypeScript knows this is a select field
+    console.log('Select field:', field.attributes.name);
+  }
+});
+```
+
 ## [2.6.1] - 2025-01-10
 
 ### 🐛 **CRITICAL BUG FIXES**

package/dist/people/fields.d.ts

@@ -1,6 +1,6 @@
 import { PcoClientState } from '../core';
 import type { ErrorContext } from '../error-handling';
-import { FieldDataList, FieldDataSingle, FieldDefinitionsList, FieldDefinitionSingle, FieldOptionAttributes, FieldOptionSingle, FieldOptionsList, TabsList } from '../types';
+import { FieldDataList, FieldDataSingle, FieldDataType, FieldDefinitionsList, FieldDefinitionSingle, FieldOptionAttributes, FieldOptionSingle, FieldOptionsList, TabsList } from '../types';
 /**
  * Delete field data for a person
  */
@@ -46,7 +46,7 @@ export declare function getTabs(client: PcoClientState, params?: {
  */
 export declare function createFieldDefinition(client: PcoClientState, tabId: string, data: {
     name: string;
-    data_type: string;
+    data_type: FieldDataType;
     sequence?: number;
     slug?: string;
     config?: string | Record<string, any>;

package/dist/types/people.d.ts

@@ -128,9 +128,10 @@ export interface SocialProfileResource extends ResourceObject<'SocialProfile', S
 }
 export type SocialProfilesList = Paginated<SocialProfileResource>;
 export type SocialProfileSingle = Response<SocialProfileResource>;
+export type FieldDataType = 'boolean' | 'checkboxes' | 'date' | 'file' | 'number' | 'select' | 'string' | 'text';
 export interface FieldDefinitionAttributes extends Attributes {
     config: string | Record<string, any> | null;
-    data_type: string;
+    data_type: FieldDataType;
     deleted_at: string | null | false;
     name: string;
     sequence: number;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@rachelallyson/planning-center-people-ts",
-    "version": "2.6.1",
+    "version": "2.6.2",
     "description": "A strictly typed TypeScript client for Planning Center Online People API with smart matching, batch operations, and enhanced developer experience",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",