@treeviz/gedcom-parser 1.0.13 → 1.0.15

package/dist/factories/index.d.ts

@@ -1,13 +1,202 @@
-export type { CacheManagerFactory } from "./cache-factory";
-export type { DateLocaleProvider } from "./date-locale-factory";
-export type { I18nProvider } from "./i18n-factory";
-export type { KinshipTranslatorConstructor } from "./kinship-factory";
-export type { PlaceParserFunction } from "./place-parser-provider";
-export type { PlaceTranslatorFunction } from "./place-translator-provider";
-export * from "./cache-factory";
-export * from "./date-locale-factory";
-export * from "./i18n-factory";
-export * from "./kinship-factory";
-export * from "./place-parser-provider";
-export * from "./place-translator-provider";
-//# sourceMappingURL=index.d.ts.map
+import { I as ICacheManager, P as PlaceParts } from '../place-parser-RlXCXZ8F.js';
+import { Locale } from 'date-fns';
+import { a1 as IndiType, n as IndiKey, L as Language } from '../index-BvW-KWJP.js';
+
+/**
+ * Factory function type for creating cache manager instances.
+ * This allows the main project to inject custom cache implementations (e.g., IndexedDB).
+ */
+type CacheManagerFactory = <T>(name: string, store: string, type: string, encrypted: boolean) => ICacheManager<T>;
+/**
+ * Set a custom cache manager factory.
+ * Call this from the main project to inject IndexedDB or other cache implementations.
+ *
+ * @example
+ * ```typescript
+ * import { setCacheManagerFactory } from '@treeviz/gedcom-parser/factories/cache-factory';
+ * import { getInstance } from './utils/indexed-db-manager';
+ *
+ * setCacheManagerFactory(getInstance);
+ * ```
+ */
+declare const setCacheManagerFactory: (factory: CacheManagerFactory) => void;
+/**
+ * Get the current cache manager factory.
+ * Used internally by the cache utility.
+ */
+declare const getCacheManagerFactory: () => CacheManagerFactory;
+/**
+ * Reset to default in-memory cache factory.
+ * Useful for testing or when switching between projects.
+ */
+declare const resetCacheManagerFactory: () => void;
+
+/**
+ * Date locale provider function type.
+ * Returns the date-fns Locale object for the current language.
+ */
+type DateLocaleProvider = () => Locale | undefined;
+/**
+ * Set a custom date locale provider.
+ * This allows the main project or external projects to override the date locale logic.
+ *
+ * @example
+ * ```typescript
+ * import { setDateLocaleProvider } from '@treeviz/gedcom-parser/factories/date-locale-factory';
+ * import { getDateFnsLocale } from './constants/ui-options';
+ *
+ * setDateLocaleProvider(getDateFnsLocale);
+ * ```
+ */
+declare const setDateLocaleProvider: (provider: DateLocaleProvider) => void;
+/**
+ * Get the current date locale.
+ * Used internally by the Date class for formatting dates.
+ */
+declare const getDateLocale: () => Locale | undefined;
+/**
+ * Reset to the default date locale provider.
+ * Useful for testing or when switching between projects.
+ */
+declare const resetDateLocaleProvider: () => void;
+
+/**
+ * I18n provider factory for pluggable translation
+ * This allows the main project to inject its i18n instance
+ */
+/**
+ * I18n provider function type.
+ * Mimics the i18next.t() function signature.
+ */
+type I18nProvider = (key: string, options?: Record<string, unknown>) => string;
+/**
+ * Set a custom i18n provider.
+ * This allows the main project to inject its i18n translation function.
+ *
+ * @example
+ * ```typescript
+ * import { setI18nProvider } from '@treeviz/gedcom-parser/factories/i18n-factory';
+ * import i18n from './translation/i18n';
+ *
+ * setI18nProvider((key, options) => i18n.t(key, options));
+ * ```
+ */
+declare const setI18nProvider: (provider: I18nProvider) => void;
+/**
+ * Get the current i18n provider.
+ * Used internally for translations.
+ */
+declare const getI18n: () => I18nProvider;
+/**
+ * Reset to the default i18n provider.
+ * Useful for testing.
+ */
+declare const resetI18nProvider: () => void;
+/**
+ * Helper object that mimics i18next interface
+ * Usage: i18n.t(key, options)
+ */
+declare const i18n: {
+    t: (key: string, options?: Record<string, unknown>) => string;
+};
+
+/**
+ * Kinship translator class constructor type
+ */
+type KinshipTranslatorConstructor = new (person1: IndiType, person2?: IndiType | IndiKey, lang?: Language, entirePath?: boolean, displayName?: "none" | "givenname" | "surname" | "all") => {
+    translate: <T extends boolean | undefined>(showMainPerson: boolean) => (T extends false | undefined ? string : Array<{
+        id?: IndiKey;
+        gen: number;
+        relative?: string;
+        absolute?: string;
+    }>) | undefined;
+};
+/**
+ * Set a custom kinship translator class.
+ * This allows the main project or external projects to override the kinship translation logic.
+ *
+ * @example
+ * ```typescript
+ * import { setKinshipTranslatorClass } from '@treeviz/gedcom-parser/factories/kinship-factory';
+ * import MyCustomKinshipTranslator from './my-custom-kinship-translator';
+ *
+ * setKinshipTranslatorClass(MyCustomKinshipTranslator);
+ * ```
+ */
+declare const setKinshipTranslatorClass: (TranslatorClass: KinshipTranslatorConstructor) => void;
+/**
+ * Get the current kinship translator class.
+ * Used internally by the Indi class.
+ */
+declare const getKinshipTranslatorClass: () => KinshipTranslatorConstructor;
+/**
+ * Reset to the default built-in kinship translator.
+ * Useful for testing or when switching between projects.
+ */
+declare const resetKinshipTranslatorClass: () => void;
+
+/**
+ * Place Parser Provider Factory
+ * Allows consumer applications to provide their own place parsing implementation
+ */
+
+/**
+ * Place parser function type
+ * Receives a place string or array and returns parsed place parts
+ */
+type PlaceParserFunction = (place: string | (string | undefined)[]) => PlaceParts[];
+/**
+ * Set the place parser provider
+ * @param parser - Custom place parser function
+ * @example
+ * ```typescript
+ * import { setPlaceParserProvider } from '@treeviz/gedcom-parser';
+ * import { getPlaceParts } from './my-place-parser';
+ *
+ * setPlaceParserProvider(getPlaceParts);
+ * ```
+ */
+declare const setPlaceParserProvider: (parser: PlaceParserFunction | undefined) => void;
+/**
+ * Get the current place parser provider
+ * @returns The current place parser function or undefined
+ */
+declare const getPlaceParserProvider: () => PlaceParserFunction | undefined;
+/**
+ * Reset the place parser provider to default (undefined)
+ */
+declare const resetPlaceParserProvider: () => void;
+
+/**
+ * Place Translator Provider Factory
+ * Allows consumer applications to provide their own place translation implementation
+ */
+/**
+ * Place translator function type
+ * Receives place string or array and optional parameters, returns translated string
+ * Compatible with main app's placeTranslator signature
+ */
+type PlaceTranslatorFunction = (place?: string | string[], level?: number, toReversed?: boolean) => string | undefined;
+/**
+ * Set the place translator provider
+ * @param translator - Custom place translator function
+ * @example
+ * ```typescript
+ * import { setPlaceTranslatorProvider } from '@treeviz/gedcom-parser';
+ * import { placeTranslator } from './my-place-translator';
+ *
+ * setPlaceTranslatorProvider(placeTranslator);
+ * ```
+ */
+declare const setPlaceTranslatorProvider: (translator: PlaceTranslatorFunction | undefined) => void;
+/**
+ * Get the current place translator provider
+ * @returns The current place translator function or undefined
+ */
+declare const getPlaceTranslatorProvider: () => PlaceTranslatorFunction | undefined;
+/**
+ * Reset the place translator provider to default (undefined)
+ */
+declare const resetPlaceTranslatorProvider: () => void;
+
+export { type CacheManagerFactory, type DateLocaleProvider, type I18nProvider, type KinshipTranslatorConstructor, type PlaceParserFunction, type PlaceTranslatorFunction, getCacheManagerFactory, getDateLocale, getI18n, getKinshipTranslatorClass, getPlaceParserProvider, getPlaceTranslatorProvider, i18n, resetCacheManagerFactory, resetDateLocaleProvider, resetI18nProvider, resetKinshipTranslatorClass, resetPlaceParserProvider, resetPlaceTranslatorProvider, setCacheManagerFactory, setDateLocaleProvider, setI18nProvider, setKinshipTranslatorClass, setPlaceParserProvider, setPlaceTranslatorProvider };