@sampuli/data 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,71 @@
+// Type definitions for @sampuli/data
+
+export interface FieldInfo {
+  key: string
+  label: string
+  num: boolean
+  money: boolean
+  img: boolean
+}
+
+export interface PresetInfo {
+  key: string
+  name: string
+  desc: string
+}
+
+export interface GenerateSettings {
+  /** Any string/number makes output reproducible. */
+  seed?: string | number
+  /**
+   * Which fields a `.person` record includes. Omit for the default-on set;
+   * pass an array of field keys to pick exactly which (e.g.
+   * ['name','phone','email','gps','dob']); pass 'all' for every field the
+   * pack offers, including the optional PII columns.
+   */
+  fields?: string[] | 'all'
+  /** 'symbol' → "KES 1,200.00"; 'number' → 1200. Default 'symbol'. */
+  amountStyle?: 'symbol' | 'number'
+  /** Kenya: mobile network for phone numbers. */
+  network?: 'any' | 'safaricom' | 'airtel' | 'telkom'
+  /** Kenya: phone format. */
+  phoneFmt?: 'local' | 'plus' | 'intl'
+  /** Kenya: KRA PIN class — Individual (A) or Company (P). */
+  pinType?: 'A' | 'P'
+  [key: string]: unknown
+}
+
+/** One synthetic record: field key → generated value. */
+export type SampuliRecord = Record<string, string | number>
+
+/** A preset's output: ordered [label, value] rows (with section separators). */
+export type PresetRows = Array<[string, string | number]>
+
+/** ISO codes of available packs (['KE'] out of the box). */
+export function listPacks(): string[]
+
+/** The generatable fields for a pack. */
+export function listFields(code: string): FieldInfo[]
+
+/** The scenario presets for a pack. */
+export function listPresets(code: string): PresetInfo[]
+
+/** Register an extra country pack at runtime. */
+export function registerPack(pack: unknown): void
+
+/**
+ * Generate one value. The spec is `pack.selector`:
+ * a field key ('ke.phone'), 'ke.person' (a full record),
+ * 'ke.preset:kyc' (preset rows), or just 'ke' (a record).
+ */
+export function generate(
+  spec: string,
+  settings?: GenerateSettings,
+): string | number | SampuliRecord | PresetRows
+
+/** Generate an array of `count` values (records, single fields, or presets). */
+export function generateMany(
+  spec: string,
+  count: number,
+  settings?: GenerateSettings,
+): Array<string | number | SampuliRecord | PresetRows>