@rachelallyson/planning-center-people-ts 1.0.0 → 2.0.0

package/dist/modules/workflows.js

@@ -0,0 +1,221 @@
+"use strict";
+/**
+ * v2.0.0 Workflows Module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowsModule = void 0;
+const base_1 = require("./base");
+class WorkflowsModule extends base_1.BaseModule {
+    /**
+     * Get all workflows
+     */
+    async getAll(options = {}) {
+        const params = {};
+        if (options.where) {
+            Object.entries(options.where).forEach(([key, value]) => {
+                params[`where[${key}]`] = value;
+            });
+        }
+        if (options.include) {
+            params.include = options.include.join(',');
+        }
+        if (options.perPage) {
+            params.per_page = options.perPage;
+        }
+        if (options.page) {
+            params.page = options.page;
+        }
+        return this.getList('/workflows', params);
+    }
+    /**
+     * Get all workflows across all pages
+     */
+    async getAllPagesPaginated(options = {}, paginationOptions) {
+        const params = {};
+        if (options.where) {
+            Object.entries(options.where).forEach(([key, value]) => {
+                params[`where[${key}]`] = value;
+            });
+        }
+        if (options.include) {
+            params.include = options.include.join(',');
+        }
+        return this.getAllPages('/workflows', params, paginationOptions);
+    }
+    /**
+     * Get a single workflow by ID
+     */
+    async getById(id, include) {
+        const params = {};
+        if (include) {
+            params.include = include.join(',');
+        }
+        return this.getSingle(`/workflows/${id}`, params);
+    }
+    /**
+     * Create a workflow
+     */
+    async create(data) {
+        return this.createResource('/workflows', data);
+    }
+    /**
+     * Update a workflow
+     */
+    async update(id, data) {
+        return this.updateResource(`/workflows/${id}`, data);
+    }
+    /**
+     * Delete a workflow
+     */
+    async delete(id) {
+        return this.deleteResource(`/workflows/${id}`);
+    }
+    /**
+     * Get workflow cards for a person
+     */
+    async getPersonWorkflowCards(personId) {
+        return this.getList(`/people/${personId}/workflow_cards`);
+    }
+    /**
+     * Add a person to a workflow with smart duplicate detection
+     */
+    async addPersonToWorkflow(personId, workflowId, options = {}) {
+        const { skipIfExists = true, skipIfActive = true } = options;
+        // Check for existing workflow cards if requested
+        if (skipIfExists || skipIfActive) {
+            const existingCards = await this.getPersonWorkflowCards(personId);
+            const existingCard = existingCards.data.find(card => {
+                const workflowData = card.relationships?.workflow?.data;
+                return workflowData && !Array.isArray(workflowData) && workflowData.id === workflowId;
+            });
+            if (existingCard && existingCard.attributes) {
+                // Check if card is completed or removed
+                if (skipIfExists && (existingCard.attributes.completed_at || existingCard.attributes.removed_at)) {
+                    throw new Error(`Person already has a completed/removed card in this workflow`);
+                }
+                // Check if card is active
+                if (skipIfActive && !existingCard.attributes.completed_at && !existingCard.attributes.removed_at) {
+                    throw new Error(`Person already has an active card in this workflow`);
+                }
+            }
+        }
+        // Create the workflow card
+        const workflowCard = await this.createResource(`/workflows/${workflowId}/cards`, {
+            person_id: personId,
+        });
+        // Add note if provided
+        if (options.note || options.noteTemplate) {
+            const noteText = options.note || this.formatNoteTemplate(options.noteTemplate, { personId, workflowId });
+            await this.createWorkflowCardNote(personId, workflowCard.id, { note: noteText });
+        }
+        return workflowCard;
+    }
+    /**
+     * Create a workflow card
+     */
+    async createWorkflowCard(workflowId, personId) {
+        return this.createResource(`/workflows/${workflowId}/cards`, {
+            person_id: personId,
+        });
+    }
+    /**
+     * Update a workflow card
+     */
+    async updateWorkflowCard(workflowCardId, data, personId) {
+        // If personId is provided, use the person-specific endpoint
+        if (personId) {
+            return this.updateResource(`/people/${personId}/workflow_cards/${workflowCardId}`, data);
+        }
+        // Fallback to the generic endpoint (may not work for all operations)
+        return this.updateResource(`/workflow_cards/${workflowCardId}`, data);
+    }
+    /**
+     * Get workflow card notes
+     */
+    async getWorkflowCardNotes(personId, workflowCardId) {
+        return this.getList(`/people/${personId}/workflow_cards/${workflowCardId}/notes`);
+    }
+    /**
+     * Create a workflow card note
+     */
+    async createWorkflowCardNote(personId, workflowCardId, data) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/notes`, data);
+    }
+    /**
+     * Update a workflow card note
+     */
+    async updateWorkflowCardNote(personId, workflowCardId, noteId, data) {
+        return this.updateResource(`/people/${personId}/workflow_cards/${workflowCardId}/notes/${noteId}`, data);
+    }
+    /**
+     * Delete a workflow card note
+     */
+    async deleteWorkflowCardNote(personId, workflowCardId, noteId) {
+        return this.deleteResource(`/people/${personId}/workflow_cards/${workflowCardId}/notes/${noteId}`);
+    }
+    /**
+     * Create a workflow card with a note
+     */
+    async createWorkflowCardWithNote(workflowId, personId, noteData) {
+        const workflowCard = await this.createWorkflowCard(workflowId, personId);
+        const note = await this.createWorkflowCardNote(personId, workflowCard.id, noteData);
+        return { workflowCard, note };
+    }
+    /**
+     * Move a workflow card back to the previous step
+     */
+    async goBackWorkflowCard(personId, workflowCardId) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/go_back`, {});
+    }
+    /**
+     * Move a workflow card to the next step
+     */
+    async promoteWorkflowCard(personId, workflowCardId) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/promote`, {});
+    }
+    /**
+     * Remove a workflow card
+     */
+    async removeWorkflowCard(personId, workflowCardId) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/remove`, {});
+    }
+    /**
+     * Restore a workflow card
+     */
+    async restoreWorkflowCard(personId, workflowCardId) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/restore`, {});
+    }
+    /**
+     * Send an email to the subject of the workflow card
+     */
+    async sendEmailWorkflowCard(personId, workflowCardId, data) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/send_email`, data);
+    }
+    /**
+     * Move a workflow card to the next step without completing the current step
+     */
+    async skipStepWorkflowCard(personId, workflowCardId) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/skip_step`, {});
+    }
+    /**
+     * Snooze a workflow card for a specific duration
+     */
+    async snoozeWorkflowCard(personId, workflowCardId, data) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/snooze`, data);
+    }
+    /**
+     * Unsnooze a workflow card
+     */
+    async unsnoozeWorkflowCard(personId, workflowCardId) {
+        return this.createResource(`/people/${personId}/workflow_cards/${workflowCardId}/unsnooze`, {});
+    }
+    /**
+     * Format note template with variables
+     */
+    formatNoteTemplate(template, variables) {
+        return template.replace(/\{\{(\w+)\}\}/g, (match, key) => {
+            return variables[key] || match;
+        });
+    }
+}
+exports.WorkflowsModule = WorkflowsModule;

package/dist/monitoring.d.ts

@@ -0,0 +1,53 @@
+/**
+ * v2.0.0 Event System and Monitoring
+ */
+import type { PcoEvent, EventHandler, EventType, EventEmitter } from './types/events';
+export declare class PcoEventEmitter implements EventEmitter {
+    private handlers;
+    on<T extends PcoEvent>(eventType: T['type'], handler: EventHandler<T>): void;
+    off<T extends PcoEvent>(eventType: T['type'], handler: EventHandler<T>): void;
+    emit<T extends PcoEvent>(event: T): void;
+    /** Remove all event handlers */
+    removeAllListeners(eventType?: EventType): void;
+    /** Get the number of listeners for an event type */
+    listenerCount(eventType: EventType): number;
+    /** Get all registered event types */
+    eventTypes(): EventType[];
+}
+/**
+ * Request ID generator for tracking requests
+ */
+export declare class RequestIdGenerator {
+    private counter;
+    generate(): string;
+}
+/**
+ * Performance metrics collector
+ */
+export declare class PerformanceMetrics {
+    private metrics;
+    record(operation: string, duration: number, success?: boolean): void;
+    getMetrics(): Record<string, {
+        count: number;
+        averageTime: number;
+        minTime: number;
+        maxTime: number;
+        errorRate: number;
+    }>;
+    reset(): void;
+}
+/**
+ * Rate limit tracker
+ */
+export declare class RateLimitTracker {
+    private limits;
+    update(endpoint: string, limit: number, remaining: number, resetTime: number): void;
+    getRemaining(endpoint: string): number;
+    getResetTime(endpoint: string): number;
+    isRateLimited(endpoint: string): boolean;
+    getAllLimits(): Record<string, {
+        limit: number;
+        remaining: number;
+        resetTime: number;
+    }>;
+}

package/dist/monitoring.js

@@ -0,0 +1,142 @@
+"use strict";
+/**
+ * v2.0.0 Event System and Monitoring
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitTracker = exports.PerformanceMetrics = exports.RequestIdGenerator = exports.PcoEventEmitter = void 0;
+class PcoEventEmitter {
+    constructor() {
+        this.handlers = new Map();
+    }
+    on(eventType, handler) {
+        if (!this.handlers.has(eventType)) {
+            this.handlers.set(eventType, new Set());
+        }
+        this.handlers.get(eventType).add(handler);
+    }
+    off(eventType, handler) {
+        const eventHandlers = this.handlers.get(eventType);
+        if (eventHandlers) {
+            eventHandlers.delete(handler);
+            if (eventHandlers.size === 0) {
+                this.handlers.delete(eventType);
+            }
+        }
+    }
+    emit(event) {
+        const eventHandlers = this.handlers.get(event.type);
+        if (eventHandlers) {
+            for (const handler of eventHandlers) {
+                try {
+                    handler(event);
+                }
+                catch (error) {
+                    console.error(`Error in event handler for ${event.type}:`, error);
+                }
+            }
+        }
+    }
+    /** Remove all event handlers */
+    removeAllListeners(eventType) {
+        if (eventType) {
+            this.handlers.delete(eventType);
+        }
+        else {
+            this.handlers.clear();
+        }
+    }
+    /** Get the number of listeners for an event type */
+    listenerCount(eventType) {
+        return this.handlers.get(eventType)?.size || 0;
+    }
+    /** Get all registered event types */
+    eventTypes() {
+        return Array.from(this.handlers.keys());
+    }
+}
+exports.PcoEventEmitter = PcoEventEmitter;
+/**
+ * Request ID generator for tracking requests
+ */
+class RequestIdGenerator {
+    constructor() {
+        this.counter = 0;
+    }
+    generate() {
+        return `req_${Date.now()}_${++this.counter}`;
+    }
+}
+exports.RequestIdGenerator = RequestIdGenerator;
+/**
+ * Performance metrics collector
+ */
+class PerformanceMetrics {
+    constructor() {
+        this.metrics = new Map();
+    }
+    record(operation, duration, success = true) {
+        const existing = this.metrics.get(operation) || {
+            count: 0,
+            totalTime: 0,
+            minTime: Infinity,
+            maxTime: 0,
+            errors: 0,
+        };
+        existing.count++;
+        existing.totalTime += duration;
+        existing.minTime = Math.min(existing.minTime, duration);
+        existing.maxTime = Math.max(existing.maxTime, duration);
+        if (!success) {
+            existing.errors++;
+        }
+        this.metrics.set(operation, existing);
+    }
+    getMetrics() {
+        const result = {};
+        for (const [operation, metrics] of this.metrics) {
+            result[operation] = {
+                count: metrics.count,
+                averageTime: metrics.totalTime / metrics.count,
+                minTime: metrics.minTime === Infinity ? 0 : metrics.minTime,
+                maxTime: metrics.maxTime,
+                errorRate: metrics.errors / metrics.count,
+            };
+        }
+        return result;
+    }
+    reset() {
+        this.metrics.clear();
+    }
+}
+exports.PerformanceMetrics = PerformanceMetrics;
+/**
+ * Rate limit tracker
+ */
+class RateLimitTracker {
+    constructor() {
+        this.limits = new Map();
+    }
+    update(endpoint, limit, remaining, resetTime) {
+        this.limits.set(endpoint, { limit, remaining, resetTime });
+    }
+    getRemaining(endpoint) {
+        const limit = this.limits.get(endpoint);
+        return limit?.remaining || 0;
+    }
+    getResetTime(endpoint) {
+        const limit = this.limits.get(endpoint);
+        return limit?.resetTime || 0;
+    }
+    isRateLimited(endpoint) {
+        const limit = this.limits.get(endpoint);
+        return limit ? limit.remaining <= 0 : false;
+    }
+    getAllLimits() {
+        const result = {};
+        for (const [endpoint, limit] of this.limits) {
+            result[endpoint] = limit;
+        }
+        return result;
+    }
+}
+exports.RateLimitTracker = RateLimitTracker;

package/dist/people/contacts.d.ts

@@ -0,0 +1,43 @@
+import { PcoClientState } from '../core';
+import type { ErrorContext } from '../error-handling';
+import { AddressAttributes, AddressesList, AddressSingle, EmailAttributes, EmailSingle, EmailsList, PhoneNumberAttributes, PhoneNumberSingle, PhoneNumbersList, SocialProfileAttributes, SocialProfileSingle, SocialProfilesList } from '../types';
+/**
+ * Get all emails for a person
+ */
+export declare function getPersonEmails(client: PcoClientState, personId: string, context?: Partial<ErrorContext>): Promise<EmailsList>;
+/**
+ * Create an email for a person
+ */
+export declare function createPersonEmail(client: PcoClientState, personId: string, data: Partial<EmailAttributes>, context?: Partial<ErrorContext>): Promise<EmailSingle>;
+/**
+ * Get all phone numbers for a person
+ */
+export declare function getPersonPhoneNumbers(client: PcoClientState, personId: string, context?: Partial<ErrorContext>): Promise<PhoneNumbersList>;
+/**
+ * Create a phone number for a person
+ */
+export declare function createPersonPhoneNumber(client: PcoClientState, personId: string, data: Partial<PhoneNumberAttributes>, context?: Partial<ErrorContext>): Promise<PhoneNumberSingle>;
+/**
+ * Get all addresses for a person
+ */
+export declare function getPersonAddresses(client: PcoClientState, personId: string, context?: Partial<ErrorContext>): Promise<AddressesList>;
+/**
+ * Create an address for a person
+ */
+export declare function createPersonAddress(client: PcoClientState, personId: string, data: Partial<AddressAttributes>, context?: Partial<ErrorContext>): Promise<AddressSingle>;
+/**
+ * Update an address for a person
+ */
+export declare function updatePersonAddress(client: PcoClientState, personId: string, addressId: string, data: Partial<AddressAttributes>, context?: Partial<ErrorContext>): Promise<AddressSingle>;
+/**
+ * Get social profiles for a person
+ */
+export declare function getPersonSocialProfiles(client: PcoClientState, personId: string, context?: Partial<ErrorContext>): Promise<SocialProfilesList>;
+/**
+ * Create a social profile for a person
+ */
+export declare function createPersonSocialProfile(client: PcoClientState, personId: string, data: Partial<SocialProfileAttributes>, context?: Partial<ErrorContext>): Promise<SocialProfileSingle>;
+/**
+ * Delete a social profile
+ */
+export declare function deleteSocialProfile(client: PcoClientState, socialProfileId: string, context?: Partial<ErrorContext>): Promise<void>;

package/dist/people/contacts.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPersonEmails = getPersonEmails;
+exports.createPersonEmail = createPersonEmail;
+exports.getPersonPhoneNumbers = getPersonPhoneNumbers;
+exports.createPersonPhoneNumber = createPersonPhoneNumber;
+exports.getPersonAddresses = getPersonAddresses;
+exports.createPersonAddress = createPersonAddress;
+exports.updatePersonAddress = updatePersonAddress;
+exports.getPersonSocialProfiles = getPersonSocialProfiles;
+exports.createPersonSocialProfile = createPersonSocialProfile;
+exports.deleteSocialProfile = deleteSocialProfile;
+const core_1 = require("../core");
+/**
+ * Get all emails for a person
+ */
+async function getPersonEmails(client, personId, context) {
+    return (0, core_1.getList)(client, `/people/${personId}/emails`, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/emails`,
+        method: 'GET',
+        personId,
+    });
+}
+/**
+ * Create an email for a person
+ */
+async function createPersonEmail(client, personId, data, context) {
+    return (0, core_1.post)(client, `/people/${personId}/emails`, data, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/emails`,
+        method: 'POST',
+        personId,
+    });
+}
+/**
+ * Get all phone numbers for a person
+ */
+async function getPersonPhoneNumbers(client, personId, context) {
+    return (0, core_1.getList)(client, `/people/${personId}/phone_numbers`, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/phone_numbers`,
+        method: 'GET',
+        personId,
+    });
+}
+/**
+ * Create a phone number for a person
+ */
+async function createPersonPhoneNumber(client, personId, data, context) {
+    return (0, core_1.post)(client, `/people/${personId}/phone_numbers`, data, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/phone_numbers`,
+        method: 'POST',
+        personId,
+    });
+}
+/**
+ * Get all addresses for a person
+ */
+async function getPersonAddresses(client, personId, context) {
+    return (0, core_1.getList)(client, `/people/${personId}/addresses`, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/addresses`,
+        method: 'GET',
+        personId,
+    });
+}
+/**
+ * Create an address for a person
+ */
+async function createPersonAddress(client, personId, data, context) {
+    return (0, core_1.post)(client, `/people/${personId}/addresses`, data, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/addresses`,
+        method: 'POST',
+        personId,
+    });
+}
+/**
+ * Update an address for a person
+ */
+async function updatePersonAddress(client, personId, addressId, data, context) {
+    return (0, core_1.patch)(client, `/people/${personId}/addresses/${addressId}`, data, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/addresses/${addressId}`,
+        method: 'PATCH',
+        personId,
+    });
+}
+/**
+ * Get social profiles for a person
+ */
+async function getPersonSocialProfiles(client, personId, context) {
+    return (0, core_1.getList)(client, `/people/${personId}/social_profiles`, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/social_profiles`,
+        method: 'GET',
+        personId,
+    });
+}
+/**
+ * Create a social profile for a person
+ */
+async function createPersonSocialProfile(client, personId, data, context) {
+    return (0, core_1.post)(client, `/people/${personId}/social_profiles`, data, undefined, {
+        ...context,
+        endpoint: `/people/${personId}/social_profiles`,
+        method: 'POST',
+        personId,
+    });
+}
+/**
+ * Delete a social profile
+ */
+async function deleteSocialProfile(client, socialProfileId, context) {
+    return (0, core_1.del)(client, `/social_profiles/${socialProfileId}`, {
+        ...context,
+        endpoint: `/social_profiles/${socialProfileId}`,
+        method: 'DELETE',
+    });
+}

package/dist/people/core.d.ts

@@ -0,0 +1,28 @@
+import { PcoClientState } from '../core';
+import type { ErrorContext } from '../error-handling';
+import { PeopleList, PersonAttributes, PersonSingle } from '../types';
+/**
+ * Get all people with optional filtering and pagination
+ */
+export declare function getPeople(client: PcoClientState, params?: {
+    where?: Record<string, any>;
+    include?: string[];
+    per_page?: number;
+    page?: number;
+}, context?: Partial<ErrorContext>): Promise<PeopleList>;
+/**
+ * Get a single person by ID
+ */
+export declare function getPerson(client: PcoClientState, id: string, include?: string[], context?: Partial<ErrorContext>): Promise<PersonSingle>;
+/**
+ * Create a new person
+ */
+export declare function createPerson(client: PcoClientState, data: Partial<PersonAttributes>, context?: Partial<ErrorContext>): Promise<PersonSingle>;
+/**
+ * Update a person
+ */
+export declare function updatePerson(client: PcoClientState, id: string, data: Partial<PersonAttributes>, context?: Partial<ErrorContext>): Promise<PersonSingle>;
+/**
+ * Delete a person
+ */
+export declare function deletePerson(client: PcoClientState, id: string, context?: Partial<ErrorContext>): Promise<void>;

package/dist/people/core.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPeople = getPeople;
+exports.getPerson = getPerson;
+exports.createPerson = createPerson;
+exports.updatePerson = updatePerson;
+exports.deletePerson = deletePerson;
+const core_1 = require("../core");
+const helpers_1 = require("../helpers");
+/**
+ * Get all people with optional filtering and pagination
+ */
+async function getPeople(client, params, context) {
+    const result = await (0, core_1.getList)(client, '/people', (0, helpers_1.buildQueryParams)(params), {
+        ...context,
+        endpoint: '/people',
+        method: 'GET',
+    });
+    return result;
+}
+/**
+ * Get a single person by ID
+ */
+async function getPerson(client, id, include, context) {
+    const params = {};
+    if (include) {
+        params.include = include.join(',');
+    }
+    return (await (0, core_1.getSingle)(client, `/people/${id}`, params, {
+        ...context,
+        endpoint: `/people/${id}`,
+        method: 'GET',
+        personId: id,
+    }));
+}
+/**
+ * Create a new person
+ */
+async function createPerson(client, data, context) {
+    return (0, core_1.post)(client, '/people', data, undefined, {
+        ...context,
+        endpoint: '/people',
+        method: 'POST',
+    });
+}
+/**
+ * Update a person
+ */
+async function updatePerson(client, id, data, context) {
+    return (0, core_1.patch)(client, `/people/${id}`, data, undefined, {
+        ...context,
+        endpoint: `/people/${id}`,
+        method: 'PATCH',
+        personId: id,
+    });
+}
+/**
+ * Delete a person
+ */
+async function deletePerson(client, id, context) {
+    return (0, core_1.del)(client, `/people/${id}`, undefined, {
+        ...context,
+        endpoint: `/people/${id}`,
+        method: 'DELETE',
+        personId: id,
+        metadata: { operation: 'delete_person' },
+        timestamp: new Date().toISOString(),
+    });
+}