@rachelallyson/planning-center-check-ins-ts 1.0.0

package/dist/types/check-ins.d.ts

@@ -0,0 +1,325 @@
+/**
+ * Planning Center Check-Ins API Types
+ * Based on JSON:API 1.0 specification
+ */
+import { Attributes, Paginated, Relationship, ResourceObject, Response } from '@rachelallyson/planning-center-base-ts';
+export interface EventAttributes extends Attributes {
+    name?: string;
+    frequency?: string;
+    enable_services_integration?: boolean;
+    location_times_enabled?: boolean;
+    pre_select_enabled?: boolean;
+    integration_key?: string;
+    app_source?: string;
+    created_at?: string;
+    updated_at?: string;
+    archived_at?: string;
+}
+export interface EventRelationships {
+    attendance_types?: Relationship;
+    check_ins?: Relationship;
+    current_event_times?: Relationship;
+    event_labels?: Relationship;
+    event_periods?: Relationship;
+    integration_links?: Relationship;
+    locations?: Relationship;
+    person_events?: Relationship;
+}
+export interface EventResource extends ResourceObject<'Event', EventAttributes, EventRelationships> {
+}
+export type EventsList = Paginated<EventResource>;
+export type EventSingle = Response<EventResource>;
+export interface CheckInAttributes extends Attributes {
+    first_name?: string;
+    last_name?: string;
+    medical_notes?: string;
+    number?: number;
+    security_code?: string;
+    created_at?: string;
+    updated_at?: string;
+    checked_out_at?: string;
+    confirmed_at?: string;
+    emergency_contact_name?: string;
+    emergency_contact_phone_number?: string;
+    one_time_guest?: boolean;
+    kind?: string;
+}
+export interface CheckInRelationships {
+    check_in_group?: Relationship;
+    check_in_times?: Relationship;
+    checked_in_at?: Relationship;
+    checked_in_by?: Relationship;
+    checked_out_by?: Relationship;
+    event?: Relationship;
+    event_period?: Relationship;
+    event_times?: Relationship;
+    locations?: Relationship;
+    options?: Relationship;
+    person?: Relationship;
+}
+export interface CheckInResource extends ResourceObject<'CheckIn', CheckInAttributes, CheckInRelationships> {
+}
+export type CheckInsList = Paginated<CheckInResource>;
+export type CheckInSingle = Response<CheckInResource>;
+export interface LocationAttributes extends Attributes {
+    name?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface LocationRelationships {
+    event?: Relationship;
+    location_event_periods?: Relationship;
+    location_event_times?: Relationship;
+    location_labels?: Relationship;
+}
+export interface LocationResource extends ResourceObject<'Location', LocationAttributes, LocationRelationships> {
+}
+export type LocationsList = Paginated<LocationResource>;
+export type LocationSingle = Response<LocationResource>;
+export interface EventPeriodAttributes extends Attributes {
+    starts_at?: string;
+    ends_at?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface EventPeriodRelationships {
+    event?: Relationship;
+    event_times?: Relationship;
+    check_ins?: Relationship;
+    location_event_periods?: Relationship;
+}
+export interface EventPeriodResource extends ResourceObject<'EventPeriod', EventPeriodAttributes, EventPeriodRelationships> {
+}
+export type EventPeriodsList = Paginated<EventPeriodResource>;
+export type EventPeriodSingle = Response<EventPeriodResource>;
+export interface EventTimeAttributes extends Attributes {
+    starts_at?: string;
+    ends_at?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface EventTimeRelationships {
+    event?: Relationship;
+    event_period?: Relationship;
+    location_event_times?: Relationship;
+    check_ins?: Relationship;
+}
+export interface EventTimeResource extends ResourceObject<'EventTime', EventTimeAttributes, EventTimeRelationships> {
+}
+export type EventTimesList = Paginated<EventTimeResource>;
+export type EventTimeSingle = Response<EventTimeResource>;
+export interface StationAttributes extends Attributes {
+    name?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface StationRelationships {
+    check_ins?: Relationship;
+}
+export interface StationResource extends ResourceObject<'Station', StationAttributes, StationRelationships> {
+}
+export type StationsList = Paginated<StationResource>;
+export type StationSingle = Response<StationResource>;
+export interface LabelAttributes extends Attributes {
+    name?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface LabelRelationships {
+    event_labels?: Relationship;
+    location_labels?: Relationship;
+}
+export interface LabelResource extends ResourceObject<'Label', LabelAttributes, LabelRelationships> {
+}
+export type LabelsList = Paginated<LabelResource>;
+export type LabelSingle = Response<LabelResource>;
+export interface EventLabelAttributes extends Attributes {
+    created_at?: string;
+    updated_at?: string;
+}
+export interface EventLabelRelationships {
+    event?: Relationship;
+    label?: Relationship;
+}
+export interface EventLabelResource extends ResourceObject<'EventLabel', EventLabelAttributes, EventLabelRelationships> {
+}
+export type EventLabelsList = Paginated<EventLabelResource>;
+export type EventLabelSingle = Response<EventLabelResource>;
+export interface LocationLabelAttributes extends Attributes {
+    created_at?: string;
+    updated_at?: string;
+}
+export interface LocationLabelRelationships {
+    location?: Relationship;
+    label?: Relationship;
+}
+export interface LocationLabelResource extends ResourceObject<'LocationLabel', LocationLabelAttributes, LocationLabelRelationships> {
+}
+export type LocationLabelsList = Paginated<LocationLabelResource>;
+export type LocationLabelSingle = Response<LocationLabelResource>;
+export interface OptionAttributes extends Attributes {
+    name?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface OptionRelationships {
+    check_ins?: Relationship;
+}
+export interface OptionResource extends ResourceObject<'Option', OptionAttributes, OptionRelationships> {
+}
+export type OptionsList = Paginated<OptionResource>;
+export type OptionSingle = Response<OptionResource>;
+export interface CheckInGroupAttributes extends Attributes {
+    name?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface CheckInGroupRelationships {
+    check_ins?: Relationship;
+}
+export interface CheckInGroupResource extends ResourceObject<'CheckInGroup', CheckInGroupAttributes, CheckInGroupRelationships> {
+}
+export type CheckInGroupsList = Paginated<CheckInGroupResource>;
+export type CheckInGroupSingle = Response<CheckInGroupResource>;
+export interface CheckInTimeAttributes extends Attributes {
+    created_at?: string;
+    updated_at?: string;
+}
+export interface CheckInTimeRelationships {
+    check_in?: Relationship;
+    event_time?: Relationship;
+}
+export interface CheckInTimeResource extends ResourceObject<'CheckInTime', CheckInTimeAttributes, CheckInTimeRelationships> {
+}
+export type CheckInTimesList = Paginated<CheckInTimeResource>;
+export type CheckInTimeSingle = Response<CheckInTimeResource>;
+export interface PersonEventAttributes extends Attributes {
+    created_at?: string;
+    updated_at?: string;
+}
+export interface PersonEventRelationships {
+    event?: Relationship;
+    person?: Relationship;
+}
+export interface PersonEventResource extends ResourceObject<'PersonEvent', PersonEventAttributes, PersonEventRelationships> {
+}
+export type PersonEventsList = Paginated<PersonEventResource>;
+export type PersonEventSingle = Response<PersonEventResource>;
+export interface PreCheckAttributes extends Attributes {
+    created_at?: string;
+    updated_at?: string;
+}
+export interface PreCheckRelationships {
+    event?: Relationship;
+    person?: Relationship;
+}
+export interface PreCheckResource extends ResourceObject<'PreCheck', PreCheckAttributes, PreCheckRelationships> {
+}
+export type PreChecksList = Paginated<PreCheckResource>;
+export type PreCheckSingle = Response<PreCheckResource>;
+export interface PassAttributes extends Attributes {
+    name?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface PassRelationships {
+}
+export interface PassResource extends ResourceObject<'Pass', PassAttributes, PassRelationships> {
+}
+export type PassesList = Paginated<PassResource>;
+export type PassSingle = Response<PassResource>;
+export interface HeadcountAttributes extends Attributes {
+    count?: number;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface HeadcountRelationships {
+}
+export interface HeadcountResource extends ResourceObject<'Headcount', HeadcountAttributes, HeadcountRelationships> {
+}
+export type HeadcountsList = Paginated<HeadcountResource>;
+export type HeadcountSingle = Response<HeadcountResource>;
+export interface AttendanceTypeAttributes extends Attributes {
+    name?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface AttendanceTypeRelationships {
+    event?: Relationship;
+}
+export interface AttendanceTypeResource extends ResourceObject<'AttendanceType', AttendanceTypeAttributes, AttendanceTypeRelationships> {
+}
+export type AttendanceTypesList = Paginated<AttendanceTypeResource>;
+export type AttendanceTypeSingle = Response<AttendanceTypeResource>;
+export interface RosterListPersonAttributes extends Attributes {
+    created_at?: string;
+    updated_at?: string;
+}
+export interface RosterListPersonRelationships {
+    person?: Relationship;
+}
+export interface RosterListPersonResource extends ResourceObject<'RosterListPerson', RosterListPersonAttributes, RosterListPersonRelationships> {
+}
+export type RosterListPersonsList = Paginated<RosterListPersonResource>;
+export type RosterListPersonSingle = Response<RosterListPersonResource>;
+export interface OrganizationAttributes extends Attributes {
+    name?: string;
+    time_zone?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface OrganizationRelationships {
+}
+export interface OrganizationResource extends ResourceObject<'Organization', OrganizationAttributes, OrganizationRelationships> {
+}
+export type OrganizationsList = Paginated<OrganizationResource>;
+export type OrganizationSingle = Response<OrganizationResource>;
+export interface IntegrationLinkAttributes extends Attributes {
+    integration_type?: string;
+    external_id?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface IntegrationLinkRelationships {
+    event?: Relationship;
+}
+export interface IntegrationLinkResource extends ResourceObject<'IntegrationLink', IntegrationLinkAttributes, IntegrationLinkRelationships> {
+}
+export type IntegrationLinksList = Paginated<IntegrationLinkResource>;
+export type IntegrationLinkSingle = Response<IntegrationLinkResource>;
+export interface ThemeAttributes extends Attributes {
+    name?: string;
+    created_at?: string;
+    updated_at?: string;
+}
+export interface ThemeRelationships {
+}
+export interface ThemeResource extends ResourceObject<'Theme', ThemeAttributes, ThemeRelationships> {
+}
+export type ThemesList = Paginated<ThemeResource>;
+export type ThemeSingle = Response<ThemeResource>;
+export interface LocationEventPeriodAttributes extends Attributes {
+    created_at?: string;
+    updated_at?: string;
+}
+export interface LocationEventPeriodRelationships {
+    location?: Relationship;
+    event_period?: Relationship;
+    check_ins?: Relationship;
+}
+export interface LocationEventPeriodResource extends ResourceObject<'LocationEventPeriod', LocationEventPeriodAttributes, LocationEventPeriodRelationships> {
+}
+export type LocationEventPeriodsList = Paginated<LocationEventPeriodResource>;
+export type LocationEventPeriodSingle = Response<LocationEventPeriodResource>;
+export interface LocationEventTimeAttributes extends Attributes {
+    created_at?: string;
+    updated_at?: string;
+}
+export interface LocationEventTimeRelationships {
+    location?: Relationship;
+    event_time?: Relationship;
+}
+export interface LocationEventTimeResource extends ResourceObject<'LocationEventTime', LocationEventTimeAttributes, LocationEventTimeRelationships> {
+}
+export type LocationEventTimesList = Paginated<LocationEventTimeResource>;
+export type LocationEventTimeSingle = Response<LocationEventTimeResource>;

package/dist/types/check-ins.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Planning Center Check-Ins API Types
+ * Based on JSON:API 1.0 specification
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/client.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Check-Ins Client Configuration Types
+ */
+import type { PcoClientConfig } from '@rachelallyson/planning-center-base-ts';
+/**
+ * Configuration for the Check-Ins API client
+ * Extends the base client config with check-ins specific defaults
+ */
+export interface PcoCheckInsClientConfig extends Omit<PcoClientConfig, 'baseURL'> {
+    /** Base URL override (defaults to https://api.planningcenteronline.com) */
+    baseUrl?: string;
+}

package/dist/types/client.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Check-Ins Client Configuration Types
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export type { JsonValue, Meta, LinkObject, Link, Links, PaginationLinks, TopLevelLinks, TopLevelJsonApi, ResourceIdentifier, Relationship, ToOne, ToMany, Attributes, ResourceObject, JsonApiBase, ErrorObject, ErrorDocument, DataDocumentSingle, DataDocumentMany, JsonApiDocument, Paginated, Response, } from '@rachelallyson/planning-center-base-ts';
+export * from './check-ins';
+export type { EventAttributes, EventRelationships, EventResource, EventsList, EventSingle, CheckInAttributes, CheckInRelationships, CheckInResource, CheckInsList, CheckInSingle, LocationAttributes, LocationRelationships, LocationResource, LocationsList, LocationSingle, EventPeriodAttributes, EventPeriodRelationships, EventPeriodResource, EventPeriodsList, EventPeriodSingle, EventTimeAttributes, EventTimeRelationships, EventTimeResource, EventTimesList, EventTimeSingle, StationAttributes, StationRelationships, StationResource, StationsList, StationSingle, LabelAttributes, LabelRelationships, LabelResource, LabelsList, LabelSingle, EventLabelAttributes, EventLabelRelationships, EventLabelResource, EventLabelsList, EventLabelSingle, LocationLabelAttributes, LocationLabelRelationships, LocationLabelResource, LocationLabelsList, LocationLabelSingle, OptionAttributes, OptionRelationships, OptionResource, OptionsList, OptionSingle, CheckInGroupAttributes, CheckInGroupRelationships, CheckInGroupResource, CheckInGroupsList, CheckInGroupSingle, CheckInTimeAttributes, CheckInTimeRelationships, CheckInTimeResource, CheckInTimesList, CheckInTimeSingle, PersonEventAttributes, PersonEventRelationships, PersonEventResource, PersonEventsList, PersonEventSingle, PreCheckAttributes, PreCheckRelationships, PreCheckResource, PreChecksList, PreCheckSingle, PassAttributes, PassRelationships, PassResource, PassesList, PassSingle, HeadcountAttributes, HeadcountRelationships, HeadcountResource, HeadcountsList, HeadcountSingle, AttendanceTypeAttributes, AttendanceTypeRelationships, AttendanceTypeResource, AttendanceTypesList, AttendanceTypeSingle, RosterListPersonAttributes, RosterListPersonRelationships, RosterListPersonResource, RosterListPersonsList, RosterListPersonSingle, OrganizationAttributes, OrganizationRelationships, OrganizationResource, OrganizationsList, OrganizationSingle, IntegrationLinkAttributes, IntegrationLinkRelationships, IntegrationLinkResource, IntegrationLinksList, IntegrationLinkSingle, ThemeAttributes, ThemeRelationships, ThemeResource, ThemesList, ThemeSingle, LocationEventPeriodAttributes, LocationEventPeriodRelationships, LocationEventPeriodResource, LocationEventPeriodsList, LocationEventPeriodSingle, LocationEventTimeAttributes, LocationEventTimeRelationships, LocationEventTimeResource, LocationEventTimesList, LocationEventTimeSingle, } from './check-ins';

package/dist/types/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Export all Check-Ins-specific types
+__exportStar(require("./check-ins"), exports);

package/package.json

@@ -0,0 +1,75 @@
+{
+    "name": "@rachelallyson/planning-center-check-ins-ts",
+    "version": "1.0.0",
+    "description": "A strictly typed TypeScript client for Planning Center Online Check-Ins API with batch operations and enhanced developer experience",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "scripts": {
+        "build": "tsc",
+        "dev": "tsc --watch",
+        "clean": "rm -rf dist",
+        "prebuild": "npm run clean",
+        "test": "jest --testPathIgnorePatterns=integration.test.ts",
+        "test:watch": "jest --watch --testPathIgnorePatterns=integration.test.ts",
+        "test:coverage": "jest --coverage --testPathIgnorePatterns=integration.test.ts",
+        "test:ci": "jest --ci --coverage --watchAll=false --testPathIgnorePatterns=integration.test.ts",
+        "test:integration": "dotenv -e .env.test -- jest --testPathPatterns=integration/.*.integration.test.ts --setupFilesAfterEnv='<rootDir>/tests/integration-setup.ts' --testTimeout=60000",
+        "docs": "typedoc",
+        "docs:watch": "typedoc --watch",
+        "prepublishOnly": "npm run build"
+    },
+    "keywords": [
+        "planning-center",
+        "planning-center-online",
+        "pco",
+        "api",
+        "typescript",
+        "json-api",
+        "check-ins",
+        "checkins",
+        "church",
+        "attendance",
+        "client",
+        "sdk",
+        "rate-limiting",
+        "error-handling",
+        "batch-operations",
+        "fluent-api",
+        "event-system"
+    ],
+    "author": "Rachel Allyson",
+    "license": "MIT",
+    "devDependencies": {
+        "@types/jest": "^30.0.0",
+        "dotenv": "^16.6.1",
+        "jest": "^30.2.0",
+        "ts-jest": "^29.4.4",
+        "tslib": "^2.8.1",
+        "typedoc": "^0.28.14",
+        "typedoc-plugin-markdown": "^4.9.0",
+        "typescript": "^5.9.3"
+    },
+    "files": [
+        "dist",
+        "README.md",
+        "LICENSE",
+        "CHANGELOG.md"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/rachelallyson/planning-center-monorepo.git"
+    },
+    "bugs": {
+        "url": "https://github.com/rachelallyson/planning-center-monorepo/issues"
+    },
+    "homepage": "https://github.com/rachelallyson/planning-center-monorepo#readme",
+    "engines": {
+        "node": ">=16.0.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "dependencies": {
+        "@rachelallyson/planning-center-base-ts": "^1.0.0"
+    }
+}