@reform-society/agera-core 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,385 @@
+import * as _$nanostores from "nanostores";
+
+//#region src/types.d.ts
+type PredicateOp = "eq" | "neq" | "in" | "nin" | "gt" | "gte" | "lt" | "lte" | "exists" | "truthy" | "falsy" | "contains" | "starts_with" | "ends_with";
+type SimplePredicate = {
+  field: string;
+  op: PredicateOp;
+  value?: unknown;
+};
+type CompositePredicate = {
+  all?: Predicate[];
+  any?: Predicate[];
+  not?: Predicate;
+};
+type Predicate = SimplePredicate | CompositePredicate;
+type Validators = {
+  required(val: string): boolean;
+  email(val: string): boolean;
+  name(val: string): boolean;
+  pattern(val: string, re: string): boolean;
+  min(val: string, n: string): boolean;
+  max(val: string, n: string): boolean;
+};
+type QuestionMetrics = {
+  displayedAt: Date;
+  firstFocusedAt?: Date;
+  firstAnsweredAt?: Date;
+  lastEditedAt?: Date;
+};
+type QuizQuestionModel = "single_select" | "multi_select";
+type QuizScoringModel = "weighted" | "exact" | "partial";
+type QuizOutcomeModel = "score" | "weighted" | "pass" | "band" | "sections";
+type QuizQuestionState = "unanswered" | "correct" | "partial" | "incorrect";
+type QuizQuestionResult = {
+  key: string;
+  model: QuizQuestionModel;
+  section: string | null;
+  eligible: boolean;
+  answeredValues: string[];
+  answeredLabels: string[];
+  expectedValues: string[] | null;
+  expectedLabels: string[] | null;
+  state: QuizQuestionState;
+  earnedPoints: number;
+  possiblePoints: number;
+};
+type ScoreQuizResults = {
+  earnedPoints: number;
+  possiblePoints: number;
+  percent: number;
+  eligibleCount: number;
+  correctCount: number;
+  partialCount: number;
+  incorrectCount: number;
+  unansweredCount: number;
+};
+type WeightedQuizResults = {
+  scores: Record<string, number>;
+  winner: string | null;
+  winnerScore: number;
+  ties: string[];
+};
+type PassQuizResults = {
+  passed: boolean;
+  label: "pass" | "fail";
+};
+type BandQuizResults = {
+  id: string | null;
+  label: string | null;
+};
+type QuizSectionResults = {
+  score: ScoreQuizResults | null;
+  weighted: WeightedQuizResults | null;
+  pass: PassQuizResults | null;
+  band: BandQuizResults | null;
+};
+type QuizResults = {
+  activeQuestionModels: QuizQuestionModel[];
+  activeScoringModels: QuizScoringModel[];
+  activeOutcomes: QuizOutcomeModel[];
+  questions: Record<string, QuizQuestionResult>;
+  score: ScoreQuizResults | null;
+  weighted: WeightedQuizResults | null;
+  pass: PassQuizResults | null;
+  band: BandQuizResults | null;
+  sections: Record<string, QuizSectionResults>;
+};
+type QuizPassFailConfig = {
+  percentGte: number;
+};
+type QuizBandDefinition = {
+  id: string;
+  label: string;
+  minPercent?: number;
+  maxPercent?: number;
+};
+type QuizSectionConfig = {
+  passFail?: QuizPassFailConfig | null;
+  bands?: QuizBandDefinition[] | null;
+};
+type QuizConfig = {
+  passFail?: QuizPassFailConfig | null;
+  bands?: QuizBandDefinition[] | null;
+  sections?: Record<string, QuizSectionConfig> | null;
+};
+type QuizQuestionInput = {
+  key: string;
+  model: QuizQuestionModel;
+  section: string | null;
+  eligible: boolean;
+  invalid?: boolean;
+  answeredValues: string[];
+  answeredLabels: string[];
+  expectedValues: string[] | null;
+  expectedLabels: string[] | null;
+  scoringModel: Exclude<QuizScoringModel, "weighted"> | null;
+  usesWeightedScoring: boolean;
+  weightedScores: Record<string, number>;
+};
+type SessionState = {
+  id: string;
+  clientId?: string;
+  surveyId?: string;
+  answers: Record<string, unknown>;
+  quiz?: QuizResults | WeightedQuizResults;
+  anonymousEmail?: string;
+  startedAt: Date;
+};
+type StepState = {
+  current: string;
+  path: string[];
+};
+type SurveyOptions = {
+  siteId?: string;
+  debug?: boolean;
+};
+type ProgressModeInfo = {
+  current: number;
+  total: number;
+  percent: number;
+};
+type ProgressInfo = {
+  viewing: ProgressModeInfo;
+  completed: ProgressModeInfo;
+};
+type ValidationRule = "required" | "email" | "name" | "phone" | "pattern" | "min" | "max" | "minValue" | "maxValue";
+type ErrorMessages = Record<ValidationRule, string>;
+//#endregion
+//#region src/stores.d.ts
+declare function createSessionStore(initial?: Partial<SessionState>): _$nanostores.PreinitializedWritableAtom<SessionState> & object;
+declare function createStepsStore(initial?: Partial<StepState>): _$nanostores.PreinitializedWritableAtom<StepState> & object;
+//#endregion
+//#region src/resolve.d.ts
+type ResolveValueSources = {
+  queryParams?: URLSearchParams;
+  storage?: Record<string, string>;
+  crmResponse?: Record<string, unknown>;
+  env?: {
+    device?: "mobile" | "tablet" | "desktop" | "tv";
+    utm?: Record<string, string>;
+  };
+};
+declare function resolveValue(field: string, answers: Record<string, unknown>, sources?: ResolveValueSources): unknown;
+//#endregion
+//#region src/answers.d.ts
+declare function mergeAnswers(previous: Record<string, unknown>, dom: Record<string, unknown>, preserveKeys?: Set<string>): Record<string, unknown>;
+declare function answersChanged(previous: Record<string, unknown>, next: Record<string, unknown>): boolean;
+//#endregion
+//#region src/predicates.d.ts
+declare function evaluatePredicate(predicate: Predicate, answers: Record<string, unknown>, sources?: ResolveValueSources): boolean;
+declare function evaluateShowIf(predicateJson: string, answers: Record<string, unknown>, sources?: ResolveValueSources): boolean;
+declare function evaluateNextMap(nextMapJson: string, answers: Record<string, unknown>, sources?: ResolveValueSources): string | null;
+//#endregion
+//#region src/validators.d.ts
+declare const validators: Validators;
+//#endregion
+//#region src/validation-messages.d.ts
+type PlacesMessageKey = "hint" | "noResults" | "validate" | "manual" | "backToSearch" | "manualValidate" | "postalErr";
+type PlacesMessages = Record<PlacesMessageKey, string>;
+declare const errorMessages: Record<string, ErrorMessages>;
+declare function getPhoneExample(region?: string, format?: string): string;
+declare function getPostalExample(region?: string): string;
+declare function getPlacesMessagesForLanguage(lang?: string, region?: string): PlacesMessages;
+/**
+ * Gets error messages for a given language tag.
+ * Falls back to English if language is not found.
+ */
+declare function getErrorMessagesForLanguage(lang?: string): ErrorMessages;
+//#endregion
+//#region src/quiz.d.ts
+/**
+ * Calculate the winner from scores, handling ties
+ */
+declare function calculateWinner(scores: Record<string, number>): WeightedQuizResults;
+declare function deriveQuestionState(answeredValues: string[], earnedPoints: number, possiblePoints: number): QuizQuestionState;
+declare function scoreExactQuestion(question: QuizQuestionInput): QuizQuestionResult | null;
+declare function scorePartialQuestion(question: QuizQuestionInput): QuizQuestionResult | null;
+declare function scoreQuizQuestions(questions: QuizQuestionInput[]): Record<string, QuizQuestionResult>;
+declare function calculateScoreResults(questionResults: QuizQuestionResult[]): ScoreQuizResults | null;
+declare function aggregateWeightedScores(questions: QuizQuestionInput[]): WeightedQuizResults | null;
+declare function derivePassResults(scoreResults: ScoreQuizResults | null, config?: QuizConfig["passFail"]): PassQuizResults | null;
+declare function deriveBandResults(scoreResults: ScoreQuizResults | null, bands?: QuizBandDefinition[] | null): BandQuizResults | null;
+declare function calculateSectionResults(questions: QuizQuestionInput[], questionResults: Record<string, QuizQuestionResult>, config?: QuizConfig): Record<string, QuizSectionResults>;
+declare function scoreQuiz(questions: QuizQuestionInput[], config?: QuizConfig): QuizResults;
+//#endregion
+//#region src/basin-client.d.ts
+/** Check if JWT is expired (with 60s buffer) */
+declare function isJwtExpired(jwt: string): boolean;
+type StorageAccessor = {
+  getItem(key: string): string | null;
+  setItem(key: string, value: string): void;
+  removeItem(key: string): void;
+};
+declare function fetchBasinJWT(endpoint: string, storage: StorageAccessor, storageKey: string): Promise<string>;
+//#endregion
+//#region src/crm-types.d.ts
+type CounterUpdateConfig = {
+  name: string;
+  add_amount?: number;
+  add_amount_field?: string;
+};
+type CounterDisplayConfig = {
+  target?: number;
+  auto_target?: boolean;
+  hide_below?: number;
+  remove_below?: number;
+  locale?: string;
+  notation?: "standard" | "compact";
+  use_grouping?: boolean;
+};
+type ShareConfig = {
+  platform: "facebook" | "twitter" | "linkedin" | "email" | "copy" | "native";
+  url?: string;
+  text?: string;
+  hashtags?: string;
+};
+type SplitConfig = {
+  variants: string[];
+  weights?: number[];
+  storage_key?: string;
+};
+type CrmFrontendKey = "wait_for_response" | "show_success" | "redirect_url" | "redirect_utm" | "redirect_params" | "follow_redirect" | "json_groups" | "counter_update" | "method";
+type CrmConfig = {
+  wait_for_response?: boolean;
+  show_success?: boolean;
+  redirect_url?: string;
+  redirect_utm?: boolean;
+  redirect_params?: boolean;
+  follow_redirect?: boolean;
+  json_groups?: string[];
+  counter_update?: CounterUpdateConfig[];
+  method?: "POST" | "PATCH" | "PUT";
+  [key: string]: unknown;
+};
+type CrmV2Request = {
+  body: Record<string, unknown>;
+  source: string;
+  utms?: Record<string, string>;
+  query_params?: Record<string, string>;
+  context?: Record<string, unknown>;
+};
+type CrmV2PatchRequest = CrmV2Request & {
+  response: Record<string, unknown>;
+};
+type CrmFetchResult = {
+  ok: boolean;
+  status: number;
+  data: Record<string, unknown> | null;
+};
+//#endregion
+//#region src/utm.d.ts
+declare const UTM_KEYS: readonly ["source", "campaign", "medium", "content", "term", "wec"];
+type Utms = Partial<Record<(typeof UTM_KEYS)[number], string>>;
+declare function extractUtms(search: string): Utms;
+declare function buildFcrmUtms(utms: Utms): Record<string, string>;
+//#endregion
+//#region src/url-utils.d.ts
+/** Appends query params to a URL without overriding existing ones. */
+declare function updateUrlWithParams(url: string, params: URLSearchParams, base?: string): string;
+//#endregion
+//#region src/memory-cache.d.ts
+type MemoryCacheOptions = {
+  max?: number;
+  ttlMs?: number;
+  now?: () => number;
+};
+type MemoryCacheSetOptions = {
+  ttlMs?: number;
+};
+type MemoryCache<Key, Value> = {
+  get: (key: Key) => Value | undefined;
+  set: (key: Key, value: Value, options?: MemoryCacheSetOptions) => Value;
+  has: (key: Key) => boolean;
+  delete: (key: Key) => boolean;
+  clear: () => void;
+  size: () => number;
+};
+declare function createMemoryCache<Key, Value>(options?: MemoryCacheOptions): MemoryCache<Key, Value>;
+//#endregion
+//#region src/flatten.d.ts
+declare function flattenObject(obj: Record<string, unknown>, prefix?: string): Record<string, unknown>;
+//#endregion
+//#region src/counter.d.ts
+declare function inferCounterName(client: string, pathname: string): string;
+declare function parseCounterUpdateAttr(value: string | null, client: string, pathname: string): CounterUpdateConfig[];
+type CounterResponse = {
+  count: number;
+  name: string;
+};
+type CounterPayload = {
+  name: string;
+  body: Record<string, unknown>;
+};
+declare function buildCounterPayload(config: CounterUpdateConfig, context?: {
+  source_url?: string;
+}): CounterPayload;
+//#endregion
+//#region src/counter-display.d.ts
+declare function computeAutoTarget(current: number): number;
+declare function formatCounterValue(value: number, locale?: string, notation?: "standard" | "compact", useGrouping?: boolean): string;
+//#endregion
+//#region src/insert.d.ts
+type InsertDirective = {
+  source: string;
+  key: string;
+};
+declare function parseInsertDirective(value: string): InsertDirective | null;
+declare function parseInsertDirectives(value: string): InsertDirective[];
+//#endregion
+//#region src/crm-context.d.ts
+declare function buildContext(config: Partial<CrmConfig>, frontendKeys: ReadonlySet<string>, counters?: CounterUpdateConfig[]): Record<string, unknown>;
+//#endregion
+//#region src/crm-utils.d.ts
+declare function isCounterResponse(data: Record<string, unknown>): boolean;
+declare function isSafeRedirectUrl(url: string): boolean;
+//#endregion
+//#region src/counter-fetch.d.ts
+declare function fetchCounter(name: string, siteId: string, apiBaseUrl: string, sourceUrl: string): Promise<CounterResponse>;
+//#endregion
+//#region src/device.d.ts
+type DeviceType = "mobile" | "tablet" | "desktop";
+type DeviceInput = {
+  userAgent?: string;
+  maxTouchPoints?: number;
+  screenWidth?: number;
+  uaDataMobile?: boolean;
+};
+declare function detectDeviceType(input: DeviceInput): DeviceType;
+//#endregion
+//#region src/crm-fetch.d.ts
+type CrmFetchOptions = {
+  waitForResponse?: boolean;
+  sourceUrl?: string;
+  deviceType?: DeviceType;
+  method?: "POST" | "PATCH" | "PUT";
+};
+declare function crmFetch(url: string, payload: Record<string, unknown> | object, options?: CrmFetchOptions): Promise<CrmFetchResult>;
+//#endregion
+//#region src/crm-request.d.ts
+type AssembleCrmRequestParams = {
+  body: Record<string, unknown>;
+  config: Partial<CrmConfig>;
+  frontendKeys: ReadonlySet<string>;
+  utms: Utms;
+  queryParams: Record<string, string>;
+  sourceUrl: string;
+  counters?: CounterUpdateConfig[];
+  jsonGroups?: Record<string, Record<string, string>>;
+};
+declare function assembleCrmRequest({
+  body: rawBody,
+  config,
+  frontendKeys,
+  utms,
+  queryParams,
+  sourceUrl,
+  counters,
+  jsonGroups
+}: AssembleCrmRequestParams): CrmV2Request;
+//#endregion
+//#region src/polling.d.ts
+declare function matchesFormat(example: unknown, value: unknown): boolean;
+//#endregion
+export { type AssembleCrmRequestParams, type BandQuizResults, type CompositePredicate, type CounterDisplayConfig, type CounterPayload, type CounterResponse, type CounterUpdateConfig, type CrmConfig, type CrmFetchOptions, type CrmFetchResult, type CrmFrontendKey, type CrmV2PatchRequest, type CrmV2Request, type DeviceInput, type DeviceType, type ErrorMessages, type InsertDirective, type MemoryCache, type MemoryCacheOptions, type MemoryCacheSetOptions, type PassQuizResults, type PlacesMessageKey, type PlacesMessages, type Predicate, type PredicateOp, type ProgressInfo, type ProgressModeInfo, type QuestionMetrics, type QuizBandDefinition, type QuizConfig, type QuizOutcomeModel, type QuizPassFailConfig, type QuizQuestionInput, type QuizQuestionModel, type QuizQuestionResult, type QuizQuestionState, type QuizResults, type QuizScoringModel, type QuizSectionConfig, type QuizSectionResults, type ResolveValueSources, type ScoreQuizResults, type SessionState, type ShareConfig, type SimplePredicate, type SplitConfig, type StepState, type StorageAccessor, type SurveyOptions, type Utms, type ValidationRule, type Validators, type WeightedQuizResults, aggregateWeightedScores, answersChanged, assembleCrmRequest, buildContext, buildCounterPayload, buildFcrmUtms, calculateScoreResults, calculateSectionResults, calculateWinner, computeAutoTarget, createMemoryCache, createSessionStore, createStepsStore, crmFetch, deriveBandResults, derivePassResults, deriveQuestionState, detectDeviceType, errorMessages, evaluateNextMap, evaluatePredicate, evaluateShowIf, extractUtms, fetchBasinJWT, fetchCounter, flattenObject, formatCounterValue, getErrorMessagesForLanguage, getPhoneExample, getPlacesMessagesForLanguage, getPostalExample, inferCounterName, isCounterResponse, isJwtExpired, isSafeRedirectUrl, matchesFormat, mergeAnswers, parseCounterUpdateAttr, parseInsertDirective, parseInsertDirectives, resolveValue, scoreExactQuestion, scorePartialQuestion, scoreQuiz, scoreQuizQuestions, updateUrlWithParams, validators };
+//# sourceMappingURL=index.d.ts.map