@rachelallyson/planning-center-people-ts 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -5,6 +5,12 @@ 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).
 
+## [3.1.0] - 2026-02-05
+
+### Added
+
+- **ListsModule.getRules(listId)**: New method to fetch rules for a list (`GET /people/v2/lists/:id/rules`). Returns paginated list of rules with `data`, `meta`, and `links`. Types `ListRuleResource`, `ListRuleAttributes`, and `ListRulesList` are exported.
+
 ## [3.0.0] - 2026-01-28
 
 ### Added

package/dist/helpers.js

@@ -528,12 +528,13 @@ async function getPeopleByHousehold(client, householdId) {
             const household = p.household;
             if (!household)
                 return false;
-            // household can be a HouseholdResource or ResourceIdentifier (both have id)
+            // household can be a HouseholdResource, ResourceIdentifier, or array at runtime (types say to-one only)
             if (Array.isArray(household)) {
                 return household.some((h) => h && 'id' in h && h.id === householdId);
             }
             // Check if it has an id property (both ResourceIdentifier and HouseholdResource have it)
-            return 'id' in household && household.id === householdId;
+            const h = household;
+            return 'id' in h && h.id === householdId;
         })
     };
     return filtered;

package/dist/index.d.ts

@@ -9,7 +9,7 @@ export type { Paginated, Relationship, ResourceIdentifier, ResourceObject, } fro
 export type { PersonResource, PersonAttributes, PersonSingle, PeopleList, EmailResource, EmailAttributes, PhoneNumberResource, PhoneNumberAttributes, AddressResource, AddressAttributes, SocialProfileResource, SocialProfileAttributes, } from './types';
 export type { FieldDefinitionResource, FieldDefinitionAttributes, FieldDatumResource, FieldDatumAttributes, FieldOptionResource, FieldOptionAttributes, TabResource, TabAttributes, } from './types';
 export type { WorkflowResource, WorkflowAttributes, WorkflowCardResource, WorkflowCardAttributes, WorkflowCardNoteResource, WorkflowCardNoteAttributes, } from './types';
-export type { HouseholdResource, HouseholdAttributes, NoteResource, NoteAttributes, ListResource, ListAttributes, OrganizationResource, OrganizationAttributes, CampusResource, CampusAttributes, CampusesList, ServiceTimeResource, ServiceTimeAttributes, ServiceTimesList, FormResource, FormAttributes, FormsList, FormCategoryResource, FormCategoryAttributes, FormFieldResource, FormFieldAttributes, FormFieldOptionResource, FormFieldOptionAttributes, FormSubmissionResource, FormSubmissionAttributes, FormSubmissionValueResource, FormSubmissionValueAttributes, ReportResource, ReportAttributes, ReportsList, } from './types';
+export type { HouseholdResource, HouseholdAttributes, NoteResource, NoteAttributes, ListResource, ListAttributes, ListRuleResource, ListRuleAttributes, ListRulesList, OrganizationResource, OrganizationAttributes, CampusResource, CampusAttributes, CampusesList, ServiceTimeResource, ServiceTimeAttributes, ServiceTimesList, FormResource, FormAttributes, FormsList, FormCategoryResource, FormCategoryAttributes, FormFieldResource, FormFieldAttributes, FormFieldOptionResource, FormFieldOptionAttributes, FormSubmissionResource, FormSubmissionAttributes, FormSubmissionValueResource, FormSubmissionValueAttributes, ReportResource, ReportAttributes, ReportsList, } from './types';
 export { createPcoClient, getRateLimitInfo } from './core';
 export type { PcoClientState, PcoClientConfig as CorePcoClientConfig } from './core';
 export { attemptTokenRefresh, refreshAccessToken, updateClientTokens, hasRefreshTokenCapability } from './auth';

package/dist/modules/lists.d.ts

@@ -61,6 +61,14 @@ export declare class ListsModule extends BaseModule {
         meta?: Meta;
         links?: TopLevelLinks;
     }>;
+    /**
+     * Get rules for a list (GET /people/v2/lists/:id/rules)
+     */
+    getRules(listId: string): Promise<{
+        data: import("@rachelallyson/planning-center-base-ts").FlattenedResource<"Rule", import("../types").ListRuleAttributes, import("../types").ListRuleRelationships, Record<string, never>>[];
+        meta?: Meta;
+        links?: TopLevelLinks;
+    }>;
     /**
      * Run a List to update its results
      */

package/dist/modules/lists.js

@@ -81,6 +81,13 @@ class ListsModule extends planning_center_base_ts_1.BaseModule {
     async getPeople(listId) {
         return this.getList(`/lists/${listId}/people`);
     }
+    /**
+     * Get rules for a list (GET /people/v2/lists/:id/rules)
+     */
+    async getRules(listId) {
+        this.debugLog('lists.getRules', { listId });
+        return this.getList(`/lists/${listId}/rules`);
+    }
     /**
      * Run a List to update its results
      */

package/dist/modules/workflows.js

@@ -80,7 +80,9 @@ class WorkflowsModule extends planning_center_base_ts_1.BaseModule {
         if (skipIfExists || skipIfActive) {
             const existingCards = await this.getPersonWorkflowCards(personId);
             const existingCard = existingCards.data.find(card => {
-                const workflowData = card?.workflow?.data;
+                // workflow may be Relationship (with .data) or flattened resource/identifier; support both
+                const raw = card?.workflow;
+                const workflowData = raw && 'id' in raw ? raw : raw?.data;
                 return workflowData && !Array.isArray(workflowData) && workflowData.id === workflowId;
             });
             if (existingCard) {

package/dist/types/people.d.ts

@@ -273,6 +273,20 @@ export interface ListStarResource extends ResourceObject<'ListStar', ListStarAtt
 }
 export type ListStarsList = Paginated<ListStarResource>;
 export type ListStarSingle = Response<ListStarResource>;
+export interface ListRuleAttributes extends Attributes {
+    group?: string;
+    operator?: string;
+    value?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface ListRuleRelationships {
+    list?: Relationship;
+}
+export interface ListRuleResource extends ResourceObject<'Rule', ListRuleAttributes, ListRuleRelationships> {
+}
+export type ListRulesList = Paginated<ListRuleResource>;
+export type ListRuleSingle = Response<ListRuleResource>;
 export interface NoteAttributes extends Attributes {
     note?: string;
     note_category_id?: string;

package/package.json

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