@treeviz/familysearch-sdk 1.0.10

package/dist/index-D6H-lvis.d.ts

@@ -0,0 +1,484 @@
+/**
+ * FamilySearch SDK Types
+ *
+ * Core type definitions for the FamilySearch API
+ */
+/**
+ * FamilySearch API environment
+ */
+type FamilySearchEnvironment = "production" | "beta" | "integration";
+/**
+ * Environment-specific endpoint configuration
+ */
+interface EnvironmentConfig {
+    /** Identity server host for OAuth */
+    identHost: string;
+    /** Platform API host for data operations */
+    platformHost: string;
+}
+/**
+ * SDK initialization options
+ */
+interface FamilySearchSDKConfig {
+    /** API environment (default: "integration") */
+    environment?: FamilySearchEnvironment;
+    /** OAuth access token */
+    accessToken?: string;
+    /** Application key for API requests */
+    appKey?: string;
+    /** Optional logger for debugging */
+    logger?: SDKLogger;
+}
+/**
+ * Logger interface for SDK debugging
+ */
+interface SDKLogger {
+    log: (message: string, ...args: unknown[]) => void;
+    warn: (message: string, ...args: unknown[]) => void;
+    error: (message: string, ...args: unknown[]) => void;
+}
+/**
+ * Generic API response wrapper
+ */
+interface FamilySearchApiResponse<T> {
+    /** Response data */
+    data?: T;
+    /** HTTP status code */
+    statusCode: number;
+    /** HTTP status text */
+    statusText: string;
+    /** Response headers */
+    headers: Record<string, string>;
+}
+/**
+ * API error with additional context
+ */
+interface FamilySearchApiError extends Error {
+    /** HTTP status code if available */
+    statusCode?: number;
+    /** Full response object */
+    response?: FamilySearchApiResponse<unknown>;
+}
+/**
+ * FamilySearch user information
+ */
+interface FamilySearchUser {
+    /** User ID */
+    id: string;
+    /** Contact name */
+    contactName?: string;
+    /** Display name */
+    displayName?: string;
+    /** Given/first name */
+    givenName?: string;
+    /** Family/last name */
+    familyName?: string;
+    /** Email address */
+    email?: string;
+    /** Gender */
+    gender?: string;
+    /** Birth date */
+    birthDate?: string;
+    /** Person ID in the tree */
+    personId?: string;
+    /** Tree user ID */
+    treeUserId?: string;
+}
+/**
+ * FamilySearch person in the tree
+ */
+interface FamilySearchPerson {
+    /** Person ID */
+    id: string;
+    /** Full name */
+    name?: string;
+    /** Given/first name */
+    givenName?: string;
+    /** Family/last name */
+    familyName?: string;
+    /** Gender (Male, Female, Unknown) */
+    gender?: string;
+    /** Birth date */
+    birthDate?: string;
+    /** Birth place */
+    birthPlace?: string;
+    /** Death date */
+    deathDate?: string;
+    /** Death place */
+    deathPlace?: string;
+    /** Lifespan string (e.g., "1900-1980") */
+    lifespan?: string;
+}
+/**
+ * Display information for a person
+ */
+interface PersonDisplay {
+    name?: string;
+    gender?: string;
+    birthDate?: string;
+    birthPlace?: string;
+    deathDate?: string;
+    deathPlace?: string;
+}
+/**
+ * Name form with parts
+ */
+interface NameForm {
+    fullText?: string;
+    parts?: Array<{
+        type?: string;
+        value?: string;
+    }>;
+}
+/**
+ * Fact/event information
+ */
+interface PersonFact {
+    type?: string;
+    date?: {
+        formal?: string;
+        original?: string;
+    };
+    place?: {
+        original?: string;
+    };
+    value?: string;
+    links?: {
+        conclusion?: {
+            href?: string;
+        };
+        person?: {
+            href?: string;
+        };
+    };
+}
+/**
+ * Full person data from API
+ */
+interface PersonData {
+    id: string;
+    display?: PersonDisplay;
+    names?: Array<{
+        nameForms?: NameForm[];
+    }>;
+    gender?: {
+        type?: string;
+    };
+    facts?: PersonFact[];
+    links?: {
+        person?: {
+            href?: string;
+        };
+    };
+    identifiers?: Record<string, string[]>;
+}
+/**
+ * Relationship between persons (couple relationships)
+ */
+/**
+ * Person reference in a relationship (can have different structures from API)
+ */
+interface PersonReference {
+    resourceId?: string;
+    resource?: {
+        resourceId?: string;
+    };
+}
+interface Relationship {
+    id: string;
+    type?: string;
+    person1?: PersonReference;
+    person2?: PersonReference;
+    parent1?: {
+        resourceId?: string;
+    };
+    parent2?: {
+        resourceId?: string;
+    };
+    child?: {
+        resourceId?: string;
+    };
+    facts?: PersonFact[];
+    details?: RelationshipDetails;
+}
+/**
+ * Child and parents relationship
+ */
+interface ChildAndParentsRelationship {
+    id: string;
+    parent1?: {
+        resourceId?: string;
+    };
+    parent2?: {
+        resourceId?: string;
+    };
+    child?: {
+        resourceId?: string;
+    };
+    parent1Facts?: PersonFact[];
+    parent2Facts?: PersonFact[];
+    sources?: Array<{
+        description?: string;
+    }>;
+    notes?: Array<{
+        text?: string;
+    }>;
+}
+/**
+ * Detailed relationship information
+ */
+interface RelationshipDetails {
+    facts?: PersonFact[];
+    persons?: Array<{
+        facts?: PersonFact[];
+    }>;
+}
+/**
+ * Person memories response from FamilySearch API
+ */
+interface PersonMemoriesResponse {
+    /** Array of source descriptions (memories) */
+    sourceDescriptions?: SourceDescription[];
+    /** Pagination info */
+    links?: Record<string, {
+        href: string;
+    }>;
+}
+/**
+ * Person search response from FamilySearch API
+ */
+interface PersonSearchResponse {
+    /** Search results */
+    results?: Array<{
+        /** Person ID */
+        id?: string;
+        /** Title (person's name) */
+        title?: string;
+        /** Score */
+        score?: number;
+        /** Person data */
+        person?: PersonData;
+    }>;
+    /** Pagination info */
+    links?: Record<string, {
+        href: string;
+    }>;
+}
+/**
+ * FamilySearch place
+ */
+interface FamilySearchPlace {
+    /** Place ID */
+    id: string;
+    /** Place name */
+    name: string;
+    /** Fully qualified name */
+    fullName?: string;
+    /** Place type */
+    type?: string;
+    /** Latitude coordinate */
+    latitude?: number;
+    /** Longitude coordinate */
+    longitude?: number;
+}
+/**
+ * Place description from API
+ */
+interface PlaceDescription {
+    id?: string;
+    names?: Array<{
+        lang?: string;
+        value?: string;
+    }>;
+    type?: string;
+    temporalDescription?: {
+        original?: string;
+        formal?: string;
+    };
+    latitude?: number;
+    longitude?: number;
+    place?: {
+        original?: string;
+        description?: string;
+    };
+    jurisdiction?: {
+        id?: string;
+        name?: string;
+    };
+    spatialDescription?: {
+        type?: string;
+        geojson?: unknown;
+    };
+}
+/**
+ * Place search result
+ */
+interface PlaceSearchResult {
+    id?: string;
+    title?: string;
+    fullyQualifiedName?: string;
+    names?: Array<{
+        lang?: string;
+        value?: string;
+    }>;
+    standardized?: {
+        id?: string;
+        fullyQualifiedName?: string;
+    };
+    jurisdiction?: {
+        id?: string;
+        name?: string;
+    };
+    temporalDescription?: {
+        formal?: string;
+        original?: string;
+    };
+}
+/**
+ * Place search API response
+ */
+interface PlaceSearchResponse {
+    entries?: Array<{
+        id?: string;
+        title?: string;
+        content?: {
+            gedcomx?: {
+                places?: PlaceDescription[];
+            };
+        };
+    }>;
+    results?: number;
+}
+/**
+ * Place details API response
+ */
+interface PlaceDetailsResponse {
+    places?: PlaceDescription[];
+}
+/**
+ * Pedigree data from ancestry API
+ */
+interface PedigreeData {
+    persons?: PersonData[];
+    relationships?: Relationship[];
+}
+/**
+ * Person notes response from API
+ */
+interface PersonNotesResponse {
+    persons?: Array<{
+        notes?: Array<{
+            id?: string;
+            subject?: string;
+            text?: string;
+            attribution?: {
+                contributor?: {
+                    resourceId?: string;
+                };
+                modified?: string;
+            };
+        }>;
+    }>;
+}
+/**
+ * Enhanced person with additional details
+ */
+interface EnhancedPerson extends PersonData {
+    fullDetails?: PersonWithRelationships;
+    notes?: PersonNotesResponse;
+}
+/**
+ * Person with relationships response from getPersonWithDetails API
+ */
+interface PersonWithRelationships {
+    persons?: PersonData[];
+    relationships?: Relationship[];
+    childAndParentsRelationships?: ChildAndParentsRelationship[];
+    sourceDescriptions?: SourceDescription[];
+    sources?: SourceReference[];
+}
+/**
+ * FamilySearch Source Description
+ */
+interface SourceDescription {
+    id: string;
+    about?: string;
+    titles?: Array<{
+        value: string;
+    }>;
+    citations?: Array<{
+        value: string;
+    }>;
+    resourceType?: string;
+}
+/**
+ * FamilySearch Source Reference
+ */
+interface SourceReference {
+    description?: string;
+    descriptionId?: string;
+    qualifiers?: Array<{
+        name: string;
+        value: string;
+    }>;
+}
+/**
+ * Enhanced pedigree with full details
+ */
+interface EnhancedPedigreeData {
+    persons: EnhancedPerson[];
+    relationships: Relationship[];
+    environment?: FamilySearchEnvironment;
+    /**
+     * IDs of persons in the direct ancestry before fullTree expansion.
+     * These are the persons returned by the ancestry API (typically 8-15 persons for 4 generations).
+     * Used to determine which persons are "connectable" to the root person.
+     */
+    ancestryPersonIds?: string[];
+}
+/**
+ * OAuth token response
+ */
+interface OAuthTokenResponse {
+    access_token: string;
+    token_type: string;
+    expires_in?: number;
+    refresh_token?: string;
+    id_token?: string;
+}
+/**
+ * OAuth endpoints for an environment
+ */
+interface OAuthEndpoints {
+    authorization: string;
+    token: string;
+    currentUser: string;
+}
+/**
+ * OAuth configuration
+ */
+interface OAuthConfig {
+    clientId: string;
+    redirectUri: string;
+    environment?: FamilySearchEnvironment;
+}
+/**
+ * OAuth state validation result
+ */
+interface OAuthStateValidation {
+    valid: boolean;
+    isLinkMode: boolean;
+    lang?: string;
+    parentUid?: string;
+}
+/**
+ * Progress callback for long operations
+ */
+type ProgressCallback = (progress: {
+    stage: string;
+    current: number;
+    total: number;
+    percent: number;
+}) => void;
+
+export type { ChildAndParentsRelationship as C, EnvironmentConfig as E, FamilySearchEnvironment as F, NameForm as N, OAuthTokenResponse as O, PersonDisplay as P, Relationship as R, SDKLogger as S, FamilySearchSDKConfig as a, FamilySearchApiResponse as b, FamilySearchApiError as c, FamilySearchUser as d, FamilySearchPerson as e, PersonFact as f, PersonData as g, RelationshipDetails as h, PersonWithRelationships as i, PersonNotesResponse as j, FamilySearchPlace as k, PlaceDescription as l, PlaceSearchResult as m, PlaceSearchResponse as n, PlaceDetailsResponse as o, PedigreeData as p, EnhancedPerson as q, EnhancedPedigreeData as r, OAuthEndpoints as s, OAuthConfig as t, OAuthStateValidation as u, ProgressCallback as v, PersonMemoriesResponse as w, PersonSearchResponse as x };