{ "id": "insurance", "title": "Insurance", "summary": "General insurance from quote to claim: rating factors, IPT, instalments, mid-term changes, cancellations, no-claims discount, excess, underinsurance and reserves.", "synonyms": [ "insurance", "insurer", "policy", "premium", "quote", "underwriting", "claims", "broker", "MGA", "motor insurance", "home insurance", "general insurance", "policy administration" ], "apps": [ "insurance quote engine", "policy administration system", "claims management system", "insurance broker app", "MGA platform", "comparison quote tool" ], "language": "typescript", "includes": [ "money-basics", "dates-basics", "validation-basics" ], "includedBy": [], "caveats": [ "Not insurance or regulatory advice. Rating tables, scales and factors are the insurer's own, supplied by the caller; IPT follows UK HMRC rates." ], "sections": [ { "key": "rating", "title": "Rating and quotes", "purpose": "Price a policy from the risk's details.", "from": "insurance", "members": [ { "id": "insurance.rating-factors", "tier": "core", "why": "Premium from a base rate times factor-table lookups, loadings and discounts, within a minimum and maximum.", "section": "rating", "from": "insurance", "version": "1.0.1", "summary": "Premium from a base rate times factor-table lookups, loadings and discounts, within minimum and maximum premiums.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "ratePremium" ], "signatures": [ "export function ratePremium(basePremium: Money, tables: readonly FactorTable[], risk: Readonly>, adjustments: readonly PremiumAdjustment[], minimumPremium: Money | null, maximumPremium: Money | null, mode: RoundingMode): RatedPremium" ], "reference": "import { ratePremium } from \"#fune/insurance.rating-factors@^1\";", "url": "http://www.functionalweave.com/functions/insurance.rating-factors" }, { "id": "insurance.ipt", "tier": "core", "why": "UK Insurance Premium Tax at the standard or higher rate in force, added to or taken out of a premium.", "section": "rating", "from": "insurance", "version": "1.0.2", "summary": "UK Insurance Premium Tax at the standard or higher rate in force on a date, added to or taken out of a premium.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "insurancePremiumTax" ], "signatures": [ "export function insurancePremiumTax(amount: Money, includesTax: boolean, band: IptBand, onDate: string, mode: RoundingMode): IptBreakdown" ], "reference": "import { insurancePremiumTax } from \"#fune/insurance.ipt@^1\";", "url": "http://www.functionalweave.com/functions/insurance.ipt" }, { "id": "insurance.age-banding", "tier": "optional", "why": "Age at inception and the rating band it falls in, from your age bands.", "section": "rating", "from": "insurance", "version": "1.0.1", "summary": "Age at policy inception and the rating band it falls in, from a table of age bands.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "ageBand" ], "signatures": [ "export function ageBand(birthDate: string, inceptionDate: string, bands: readonly AgeBand[]): AgeBanding" ], "reference": "import { ageBand } from \"#fune/insurance.age-banding@^1\";", "url": "http://www.functionalweave.com/functions/insurance.age-banding" }, { "id": "insurance.no-claims-discount", "tier": "optional", "why": "No-claims discount at renewal: earn a year or step back after claims on your scale, with protection.", "section": "rating", "from": "insurance", "version": "1.0.1", "summary": "No-claims discount at renewal: earn a year, or step back after claims on the insurer's scale, with NCD protection.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "nextNoClaimsDiscount" ], "signatures": [ "export function nextNoClaimsDiscount(scale: readonly NcdLevel[], currentYears: number, claims: number, protection: NcdProtection | null): NcdOutcome" ], "reference": "import { nextNoClaimsDiscount } from \"#fune/insurance.no-claims-discount@^1\";", "url": "http://www.functionalweave.com/functions/insurance.no-claims-discount" }, { "id": "dates.age", "tier": "optional", "why": "Age in whole years on a date, for age-based rating.", "section": "rating", "from": "insurance", "version": "1.0.0", "summary": "Age in whole years on a given date, with 29 February birthdays ageing on 1 March in other years.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "age" ], "signatures": [ "export function age(birthDate: string, onDate: string): number" ], "reference": "import { age } from \"#fune/dates.age@^1\";", "url": "http://www.functionalweave.com/functions/dates.age" } ], "gaps": [ { "key": "risk-data", "text": "External risk data (vehicle lookups, flood and crime scores, address data) comes from data providers.", "section": "rating", "from": "insurance" } ] }, { "key": "payment", "title": "Paying the premium", "purpose": "Let customers pay annually or by monthly instalments.", "from": "insurance", "members": [ { "id": "insurance.instalment-plan", "tier": "core", "why": "Deposit, flat credit charge, instalments to the penny and the APR for paying monthly.", "section": "payment", "from": "insurance", "version": "1.0.1", "summary": "Pay a premium by monthly instalments: deposit, flat credit charge, instalments exact to the penny, and the APR.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "instalmentPlan" ], "signatures": [ "export function instalmentPlan(premium: Money, deposit: Money, instalmentCount: number, creditChargeBasisPoints: number, firstInstalmentMonth: number): InstalmentPlan" ], "reference": "import { instalmentPlan } from \"#fune/insurance.instalment-plan@^1\";", "url": "http://www.functionalweave.com/functions/insurance.instalment-plan" }, { "id": "lending.apr", "tier": "optional", "why": "The consumer-credit APR from drawdowns and repayments, for credit agreements beyond the instalment plan.", "section": "payment", "from": "insurance", "version": "1.0.1", "summary": "Consumer-credit APR from drawdowns and repayments, by the FCA CONC App 1.2.6 equation, to one decimal place.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "apr" ], "signatures": [ "export function apr(advances: readonly CreditFlow[], repayments: readonly CreditFlow[], periodsPerYear: number): AprResult" ], "reference": "import { apr } from \"#fune/lending.apr@^1\";", "url": "http://www.functionalweave.com/functions/lending.apr" } ], "gaps": [] }, { "key": "changes", "title": "Mid-term changes and cancellations", "purpose": "Re-price a policy when it changes or ends early.", "from": "insurance", "members": [ { "id": "insurance.mid-term-adjustment", "tier": "core", "why": "Additional or return premium for a mid-term change, pro rata on the days left, plus an admin fee.", "section": "changes", "from": "insurance", "version": "1.0.1", "summary": "Additional or return premium for a mid-term policy change, pro rata on the days left, plus an admin fee.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "midTermAdjustment" ], "signatures": [ "export function midTermAdjustment(oldPremium: Money, newPremium: Money, inceptionDate: string, expiryDate: string, changeDate: string, adminFee: Money, mode: RoundingMode): MidTermAdjustment" ], "reference": "import { midTermAdjustment } from \"#fune/insurance.mid-term-adjustment@^1\";", "url": "http://www.functionalweave.com/functions/insurance.mid-term-adjustment" }, { "id": "insurance.premium-proration", "tier": "core", "why": "Return premium on cancellation, pro rata or on a short-period scale, with a minimum retained premium.", "section": "changes", "from": "insurance", "version": "1.0.1", "summary": "Return premium on mid-term cancellation, pro rata or on a short-period scale, with an optional minimum retained premium.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "cancellationReturnPremium" ], "signatures": [ "export function cancellationReturnPremium(premium: Money, inceptionDate: string, expiryDate: string, cancellationDate: string, basis: CancellationBasis, shortPeriodScale: readonly ShortPeriodBand[], minimumRetained: Money | null): CancellationRefund" ], "reference": "import { cancellationReturnPremium } from \"#fune/insurance.premium-proration@^1\";", "url": "http://www.functionalweave.com/functions/insurance.premium-proration" }, { "id": "finance.proration", "tier": "optional", "why": "Splits any amount into used and unused parts over a period.", "section": "changes", "from": "insurance", "version": "1.0.0", "summary": "Split an amount into the part used and the part unused over a billing period, losing nothing.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "prorate" ], "signatures": [ "export function prorate(amount: Money, totalDays: number, usedDays: number): ProrationSplit" ], "reference": "import { prorate } from \"#fune/finance.proration@^1\";", "url": "http://www.functionalweave.com/functions/finance.proration" } ], "gaps": [] }, { "key": "claims", "title": "Claims", "purpose": "Settle claims and keep reserves.", "from": "insurance", "members": [ { "id": "insurance.excess-apply", "tier": "core", "why": "Claim payout after the compulsory and voluntary excess, capped at the policy limit.", "section": "claims", "from": "insurance", "version": "1.0.1", "summary": "Claim payout after the compulsory and voluntary excess, capped at the policy limit.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "applyExcess" ], "signatures": [ "export function applyExcess(loss: Money, compulsoryExcess: Money, voluntaryExcess: Money, policyLimit: Money | null, excessWithinLimit: boolean): ExcessSettlement" ], "reference": "import { applyExcess } from \"#fune/insurance.excess-apply@^1\";", "url": "http://www.functionalweave.com/functions/insurance.excess-apply" }, { "id": "insurance.claim-reserve", "tier": "core", "why": "Paid, recovered, outstanding and incurred after each claim transaction, and the movement.", "section": "claims", "from": "insurance", "version": "1.0.1", "summary": "Claim reserve history: paid, recovered, outstanding and incurred after each transaction, and the movement.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "claimReserveHistory" ], "signatures": [ "export function claimReserveHistory(transactions: readonly ClaimTransaction[], currency: string): readonly ReservePosition[]" ], "reference": "import { claimReserveHistory } from \"#fune/insurance.claim-reserve@^1\";", "url": "http://www.functionalweave.com/functions/insurance.claim-reserve" }, { "id": "insurance.sum-insured-average", "tier": "optional", "why": "Average clause settlement when the property was underinsured.", "section": "claims", "from": "insurance", "version": "1.0.1", "summary": "Average clause settlement for underinsurance: the loss times sum insured over value at risk, capped at the loss.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "averageClauseSettlement" ], "signatures": [ "export function averageClauseSettlement(loss: Money, sumInsured: Money, valueAtRisk: Money, conditionBasisPoints: number, mode: RoundingMode): AverageSettlement" ], "reference": "import { averageClauseSettlement } from \"#fune/insurance.sum-insured-average@^1\";", "url": "http://www.functionalweave.com/functions/insurance.sum-insured-average" } ], "gaps": [ { "key": "fraud-checks", "text": "Claims fraud detection and industry databases (CUE, IFB) are services caps does not have.", "section": "claims", "from": "insurance" } ] }, { "key": "performance", "title": "Portfolio reporting", "purpose": "Report how the book is performing.", "from": "insurance", "members": [ { "id": "insurance.loss-ratio", "tier": "optional", "why": "Loss, expense and combined ratios in basis points from earned premium, claims and expenses.", "section": "performance", "from": "insurance", "version": "1.0.1", "summary": "Loss ratio, expense ratio and combined ratio in basis points, from earned premium, incurred claims and expenses.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "lossRatios" ], "signatures": [ "export function lossRatios(earnedPremium: Money, incurredClaims: Money, expenses: Money, mode: RoundingMode): LossRatios" ], "reference": "import { lossRatios } from \"#fune/insurance.loss-ratio@^1\";", "url": "http://www.functionalweave.com/functions/insurance.loss-ratio" }, { "id": "stats.mean-median", "tier": "optional", "why": "Means and medians of claim sizes, exactly.", "section": "performance", "from": "insurance", "version": "1.0.0", "summary": "Mean, median and mode of a list of integers, with the mean and median as exact fractions.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "meanMedianMode" ], "signatures": [ "export function meanMedianMode(values: readonly number[]): CentralTendency" ], "reference": "import { meanMedianMode } from \"#fune/stats.mean-median@^1\";", "url": "http://www.functionalweave.com/functions/stats.mean-median" } ], "gaps": [ { "key": "earned-premium", "text": "Earned and unearned premium reserves across the book at a reporting date are not computed by caps.", "section": "performance", "from": "insurance" } ] }, { "key": "amounts", "title": "Amounts", "purpose": "Hold money as currency-tagged integer minor units and do plain arithmetic on it safely.", "from": "money-basics", "members": [ { "id": "money.amount", "tier": "core", "why": "The Money type ({ minor, currency }) every other money capability takes and returns.", "section": "amounts", "from": "money-basics", "version": "1.0.2", "summary": "A currency-tagged monetary amount held in integer minor units.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "money" ], "signatures": [ "export function money(minor: number, currency: string): Money" ], "reference": "import { money } from \"#fune/money.amount@^1\";", "url": "http://www.functionalweave.com/functions/money.amount" }, { "id": "money.add", "tier": "core", "why": "Adds and subtracts amounts, refusing to mix currencies by accident.", "section": "amounts", "from": "money-basics", "version": "1.0.1", "summary": "Add, subtract and negate monetary amounts, refusing to mix currencies.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addMoney" ], "signatures": [ "export function addMoney(a: Money, b: Money): Money" ], "reference": "import { addMoney } from \"#fune/money.add@^1\";", "url": "http://www.functionalweave.com/functions/money.add" }, { "id": "money.sum", "tier": "core", "why": "Totals a list of amounts, with an explicit currency for an empty list.", "section": "amounts", "from": "money-basics", "version": "1.0.1", "summary": "Total a list of monetary amounts, with an explicit currency for the empty case.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "sumMoney" ], "signatures": [ "export function sumMoney(amounts: readonly Money[], currency: string): Money" ], "reference": "import { sumMoney } from \"#fune/money.sum@^1\";", "url": "http://www.functionalweave.com/functions/money.sum" }, { "id": "money.compare", "tier": "core", "why": "Compares, mins, maxes and clamps amounts of one currency without unwrapping them.", "section": "amounts", "from": "money-basics", "version": "2.0.0", "summary": "Compare two amounts of one currency, refusing to compare across currencies; min, max and clamp too.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "compareMoney", "minMoney", "maxMoney", "clampMoney" ], "signatures": [ "export function compareMoney(a: Money, b: Money): number", "export function minMoney(a: Money, b: Money): Money", "export function maxMoney(a: Money, b: Money): Money", "export function clampMoney(amount: Money, min: Money, max: Money): Money" ], "reference": "import { compareMoney, minMoney, maxMoney, clampMoney } from \"#fune/money.compare@^2\";", "url": "http://www.functionalweave.com/functions/money.compare" } ], "gaps": [] }, { "key": "rates", "title": "Rates and rounding", "purpose": "Apply percentages and divide amounts with the rounding stated, never a float.", "from": "money-basics", "members": [ { "id": "money.apply-rate", "tier": "core", "why": "Applies a basis-point rate (VAT, discount, commission) to an amount with explicit rounding.", "section": "rates", "from": "money-basics", "version": "1.0.1", "summary": "Apply a rate expressed in basis points to a monetary amount, with an explicit rounding mode.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "applyRate" ], "signatures": [ "export function applyRate(amount: Money, basisPoints: number, mode: RoundingMode): Money" ], "reference": "import { applyRate } from \"#fune/money.apply-rate@^1\";", "url": "http://www.functionalweave.com/functions/money.apply-rate" }, { "id": "math.round-div", "tier": "core", "why": "Integer division with a named rounding mode, for any money maths the others do not cover.", "section": "rates", "from": "money-basics", "version": "1.0.0", "summary": "Integer division with an explicit rounding mode, for money arithmetic that must not drift.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "roundDiv" ], "signatures": [ "export function roundDiv(numerator: number, denominator: number, mode: RoundingMode): number" ], "reference": "import { roundDiv } from \"#fune/math.round-div@^1\";", "url": "http://www.functionalweave.com/functions/math.round-div" }, { "id": "math.basis-points", "tier": "optional", "why": "Converts \"12.5%\" to and from basis points exactly, for rates typed in by users.", "section": "rates", "from": "money-basics", "version": "2.0.0", "summary": "Convert a rate between percent, basis points and a plain ratio exactly, as decimal text or integer basis points.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "convertRate", "toBasisPoints", "fromBasisPoints" ], "signatures": [ "export function convertRate(value: string, fromUnit: RateUnit, toUnit: RateUnit): string", "export function toBasisPoints(value: string, unit: RateUnit): number", "export function fromBasisPoints(basisPoints: number, unit: RateUnit): string" ], "reference": "import { convertRate, toBasisPoints, fromBasisPoints } from \"#fune/math.basis-points@^2\";", "url": "http://www.functionalweave.com/functions/math.basis-points" }, { "id": "math.percent-change", "tier": "optional", "why": "Percentage change between two figures in basis points, for \"up 4.2% on last month\".", "section": "rates", "from": "money-basics", "version": "1.0.0", "summary": "Percentage change from one value to another, in basis points, with an explicit rounding mode.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "percentChange" ], "signatures": [ "export function percentChange(fromValue: number, toValue: number, mode: RoundingMode): number | null" ], "reference": "import { percentChange } from \"#fune/math.percent-change@^1\";", "url": "http://www.functionalweave.com/functions/math.percent-change" }, { "id": "math.rational", "tier": "optional", "why": "Exact fractions for rates that must not drift across many steps.", "section": "rates", "from": "money-basics", "version": "2.0.0", "summary": "Exact fraction arithmetic, always reduced, for rates and ratios that must not drift.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "calculateRational", "rational", "addRational", "subtractRational", "multiplyRational", "divideRational", "compareRational", "rationalToInteger" ], "signatures": [ "export function calculateRational(a: Rational, op: RationalOp, b: Rational): Rational", "export function rational(numerator: number, denominator: number): Rational", "export function addRational(a: Rational, b: Rational): Rational", "export function subtractRational(a: Rational, b: Rational): Rational", "export function multiplyRational(a: Rational, b: Rational): Rational", "export function divideRational(a: Rational, b: Rational): Rational", "export function compareRational(a: Rational, b: Rational): number", "export function rationalToInteger(r: Rational, mode: RoundingMode): number" ], "reference": "import { calculateRational, rational, addRational, subtractRational, multiplyRational, divideRational, compareRational, rationalToInteger } from \"#fune/math.rational@^2\";", "url": "http://www.functionalweave.com/functions/math.rational" }, { "id": "math.round-div-big", "tier": "optional", "why": "Rounded division on numbers past 2^53, for very large totals.", "section": "rates", "from": "money-basics", "version": "1.0.0", "summary": "Divide two integers of any size with an explicit rounding mode, on decimal strings, for exact money sums past 2^53.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "roundDivBig" ], "signatures": [ "export function roundDivBig(numerator: string, denominator: string, mode: RoundingMode): string" ], "reference": "import { roundDivBig } from \"#fune/math.round-div-big@^1\";", "url": "http://www.functionalweave.com/functions/math.round-div-big" } ], "gaps": [] }, { "key": "splitting", "title": "Splitting", "purpose": "Divide an amount between people, periods or lines so the parts add back to the whole.", "from": "money-basics", "members": [ { "id": "money.allocate", "tier": "core", "why": "Splits an amount by ratios (60/40, by quantity) without losing or inventing a penny.", "section": "splitting", "from": "money-basics", "version": "1.0.1", "summary": "Split an amount across ratios without losing or inventing a single minor unit.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "allocate" ], "signatures": [ "export function allocate(amount: Money, ratios: readonly number[]): readonly Money[]" ], "reference": "import { allocate } from \"#fune/money.allocate@^1\";", "url": "http://www.functionalweave.com/functions/money.allocate" }, { "id": "money.split-even", "tier": "optional", "why": "Splits an amount into n near-equal parts that sum exactly, for instalments or shares.", "section": "splitting", "from": "money-basics", "version": "1.0.0", "summary": "Split an amount into n near-equal parts that add back up to exactly the whole.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "splitEven" ], "signatures": [ "export function splitEven(amount: Money, parts: number): readonly Money[]" ], "reference": "import { splitEven } from \"#fune/money.split-even@^1\";", "url": "http://www.functionalweave.com/functions/money.split-even" } ], "gaps": [] }, { "key": "display", "title": "Display and input", "purpose": "Show amounts to people and read what they type.", "from": "money-basics", "members": [ { "id": "money.format", "tier": "core", "why": "Renders an amount as text with the currency's real number of decimal places.", "section": "display", "from": "money-basics", "version": "1.0.0", "summary": "Render a monetary amount as text, using the currency's real minor-unit precision.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "formatMoney" ], "signatures": [ "export function formatMoney(amount: Money): string" ], "reference": "import { formatMoney } from \"#fune/money.format@^1\";", "url": "http://www.functionalweave.com/functions/money.format" }, { "id": "money.parse", "tier": "optional", "why": "Reads \"£1,234.50\" or \"1.234,50 €\" typed by a user into minor units, strictly.", "section": "display", "from": "money-basics", "version": "1.0.0", "summary": "Parse \"£1,234.50\" or \"1.234,50 €\" into integer minor units, strictly: no guessing, no rounding.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "parseMoney" ], "signatures": [ "export function parseMoney(text: string, currency: string, style: NumberStyle): Money" ], "reference": "import { parseMoney } from \"#fune/money.parse@^1\";", "url": "http://www.functionalweave.com/functions/money.parse" }, { "id": "money.currency-digits", "tier": "optional", "why": "How many decimal places each ISO 4217 currency has, for input boxes and validation.", "section": "display", "from": "money-basics", "version": "1.0.0", "summary": "How many decimal places a currency's minor unit has, from the ISO 4217 list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "currencyDigits" ], "signatures": [ "export function currencyDigits(currency: string): number" ], "reference": "import { currencyDigits } from \"#fune/money.currency-digits@^1\";", "url": "http://www.functionalweave.com/functions/money.currency-digits" } ], "gaps": [] }, { "key": "currencies", "title": "Other currencies", "purpose": "Convert between currencies at a rate you hold.", "from": "money-basics", "members": [ { "id": "money.convert", "tier": "optional", "why": "Converts an amount at a supplied exact rate with explicit rounding.", "section": "currencies", "from": "money-basics", "version": "1.0.0", "summary": "Convert an amount to another currency at a supplied exact rate, with an explicit rounding mode.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "convertMoney" ], "signatures": [ "export function convertMoney(amount: Money, rate: ExchangeRate, mode: RoundingMode): Money" ], "reference": "import { convertMoney } from \"#fune/money.convert@^1\";", "url": "http://www.functionalweave.com/functions/money.convert" } ], "gaps": [] }, { "key": "date-arithmetic", "title": "Calendar arithmetic", "purpose": "Move and measure ISO dates exactly, with no date library and no clock reads.", "from": "dates-basics", "members": [ { "id": "dates.add-days", "tier": "core", "why": "Shifts a date by whole days, for due dates and windows.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Shift an ISO date by a whole number of days, forwards or backwards, with exact calendar arithmetic.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addDays" ], "signatures": [ "export function addDays(iso: string, days: number): string" ], "reference": "import { addDays } from \"#fune/dates.add-days@^1\";", "url": "http://www.functionalweave.com/functions/dates.add-days" }, { "id": "dates.add-months", "tier": "core", "why": "Adds months clamping to month end, so 31 January plus a month is the end of February.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Add calendar months to an ISO date, clamping to the month end: 31 Jan + 1 month is 28 or 29 Feb.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addMonths" ], "signatures": [ "export function addMonths(iso: string, months: number): string" ], "reference": "import { addMonths } from \"#fune/dates.add-months@^1\";", "url": "http://www.functionalweave.com/functions/dates.add-months" }, { "id": "dates.days-between", "tier": "core", "why": "Signed calendar days between two dates, for ages of invoices and stays.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Calendar days from one ISO date to another, signed: negative when the second date is earlier.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "daysBetween" ], "signatures": [ "export function daysBetween(startIso: string, endIso: string): number" ], "reference": "import { daysBetween } from \"#fune/dates.days-between@^1\";", "url": "http://www.functionalweave.com/functions/dates.days-between" }, { "id": "dates.month-boundaries", "tier": "core", "why": "First and last day of a date's month, for monthly periods and statements.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "The first day, last day and length of the calendar month containing a date.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "monthBoundaries" ], "signatures": [ "export function monthBoundaries(iso: string): MonthBoundaries" ], "reference": "import { monthBoundaries } from \"#fune/dates.month-boundaries@^1\";", "url": "http://www.functionalweave.com/functions/dates.month-boundaries" }, { "id": "dates.day-of-week", "tier": "core", "why": "ISO weekday of a date, for weekend rules and opening hours.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "The ISO 8601 day of the week for a date: 1 is Monday through 7 is Sunday.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "dayOfWeek" ], "signatures": [ "export function dayOfWeek(iso: string): number" ], "reference": "import { dayOfWeek } from \"#fune/dates.day-of-week@^1\";", "url": "http://www.functionalweave.com/functions/dates.day-of-week" }, { "id": "dates.is-leap-year", "tier": "optional", "why": "Whether a year is a leap year, for 365/366-day calculations.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Whether a year is a Gregorian leap year: every 4th, except centuries, except every 400th.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isLeapYear" ], "signatures": [ "export function isLeapYear(year: number): boolean" ], "reference": "import { isLeapYear } from \"#fune/dates.is-leap-year@^1\";", "url": "http://www.functionalweave.com/functions/dates.is-leap-year" }, { "id": "dates.overlap", "tier": "optional", "why": "Days two date ranges share, for prorating and clash checks.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Days two date ranges have in common, with the end of each range stated as inclusive or exclusive.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "overlapDays" ], "signatures": [ "export function overlapDays(aStart: string, aEnd: string, bStart: string, bEnd: string, endInclusive: boolean): number" ], "reference": "import { overlapDays } from \"#fune/dates.overlap@^1\";", "url": "http://www.functionalweave.com/functions/dates.overlap" } ], "gaps": [] }, { "key": "reporting-periods", "title": "Periods and reporting dates", "purpose": "Put dates into the periods reports are grouped by.", "from": "dates-basics", "members": [ { "id": "dates.quarter", "tier": "core", "why": "Calendar and fiscal quarter of a date for any year-start month.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "Calendar quarter and fiscal quarter of a date, with the fiscal year and quarter date ranges, for any start month.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "quarter" ], "signatures": [ "export function quarter(iso: string, fiscalYearStartMonth: number): Quarter" ], "reference": "import { quarter } from \"#fune/dates.quarter@^1\";", "url": "http://www.functionalweave.com/functions/dates.quarter" }, { "id": "dates.week-number", "tier": "optional", "why": "ISO week number and week-year, for weekly reports.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "ISO 8601 week number and week-numbering year of a date: weeks start Monday, week 1 holds the first Thursday.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "weekNumber" ], "signatures": [ "export function weekNumber(iso: string): IsoWeek" ], "reference": "import { weekNumber } from \"#fune/dates.week-number@^1\";", "url": "http://www.functionalweave.com/functions/dates.week-number" }, { "id": "dates.day-count-fraction", "tier": "optional", "why": "Year fraction by ACT/365F, ACT/360, 30/360 or ACT/ACT, for interest periods.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "Year fraction between two dates by ACT/365F, ACT/360, 30/360, 30E/360 or ACT/ACT ISDA, as an exact fraction.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "dayCountFraction" ], "signatures": [ "export function dayCountFraction(startIso: string, endIso: string, convention: DayCountConvention): YearFraction" ], "reference": "import { dayCountFraction } from \"#fune/dates.day-count-fraction@^1\";", "url": "http://www.functionalweave.com/functions/dates.day-count-fraction" } ], "gaps": [] }, { "key": "working-days", "title": "Working days and holidays", "purpose": "Skip weekends and public holidays when counting or adding days.", "from": "dates-basics", "members": [ { "id": "dates.bank-holidays", "tier": "core", "why": "UK bank holidays for a region and year, as gov.uk publishes them.", "section": "working-days", "from": "dates-basics", "version": "1.0.1", "summary": "UK bank and public holidays for a region and year, as published by gov.uk, including one-off holidays.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "bankHolidays" ], "signatures": [ "export function bankHolidays(region: UkRegion, year: number): readonly BankHoliday[]" ], "reference": "import { bankHolidays } from \"#fune/dates.bank-holidays@^1\";", "url": "http://www.functionalweave.com/functions/dates.bank-holidays" }, { "id": "dates.add-business-days", "tier": "core", "why": "Moves a date by working days, skipping weekends and a holiday list.", "section": "working-days", "from": "dates-basics", "version": "1.0.0", "summary": "Move a date forward or back by working days, skipping weekends and a caller-supplied holiday list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addBusinessDays" ], "signatures": [ "export function addBusinessDays(iso: string, days: number, holidays: readonly string[]): string" ], "reference": "import { addBusinessDays } from \"#fune/dates.add-business-days@^1\";", "url": "http://www.functionalweave.com/functions/dates.add-business-days" }, { "id": "dates.business-days-between", "tier": "core", "why": "Working days between two dates, for SLAs and notice periods.", "section": "working-days", "from": "dates-basics", "version": "1.0.0", "summary": "Working days between two dates, excluding weekends and a caller-supplied holiday list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "businessDaysBetween" ], "signatures": [ "export function businessDaysBetween(startIso: string, endIso: string, holidays: readonly string[]): number" ], "reference": "import { businessDaysBetween } from \"#fune/dates.business-days-between@^1\";", "url": "http://www.functionalweave.com/functions/dates.business-days-between" } ], "gaps": [] }, { "key": "repeating-dates", "title": "Repeating schedules", "purpose": "Generate the dates of something that repeats.", "from": "dates-basics", "members": [ { "id": "dates.recurrence", "tier": "optional", "why": "The next n dates of a rule: monthly on the 31st, last Friday, every two weeks.", "section": "repeating-dates", "from": "dates-basics", "version": "1.0.0", "summary": "The next n dates of a repeating rule: monthly on a day, last weekday of the month, every k days or weeks, yearly.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "recurrence" ], "signatures": [ "export function recurrence(rule: RecurrenceRule, startIso: string, count: number): readonly string[]" ], "reference": "import { recurrence } from \"#fune/dates.recurrence@^1\";", "url": "http://www.functionalweave.com/functions/dates.recurrence" } ], "gaps": [] }, { "key": "times", "title": "Times and durations", "purpose": "Work with times of day, durations and timestamps.", "from": "dates-basics", "members": [ { "id": "time.duration", "tier": "optional", "why": "Parses and adds durations like 1h30m in whole minutes, and formats the total.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Parse durations written as 1h30m, 90m or 01:30, add them up in whole minutes, and format the total.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "duration" ], "signatures": [ "export function duration(parts: readonly string[]): Duration" ], "reference": "import { duration } from \"#fune/time.duration@^1\";", "url": "http://www.functionalweave.com/functions/time.duration" }, { "id": "time.minutes-between", "tier": "optional", "why": "Minutes between two local date-times, across midnight.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Minutes from one local date and time to another, correct across midnight; wall-clock time, no time zones.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "minutesBetween" ], "signatures": [ "export function minutesBetween(startDate: string, startTime: string, endDate: string, endTime: string): number" ], "reference": "import { minutesBetween } from \"#fune/time.minutes-between@^1\";", "url": "http://www.functionalweave.com/functions/time.minutes-between" }, { "id": "time.round-to-increment", "tier": "optional", "why": "Rounds minutes to a billing increment such as 6 or 15.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Round a duration in minutes to a billing increment such as 6 or 15 minutes, up, down or to nearest.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "roundToIncrement" ], "signatures": [ "export function roundToIncrement(minutes: number, increment: number, mode: RoundingMode): number" ], "reference": "import { roundToIncrement } from \"#fune/time.round-to-increment@^1\";", "url": "http://www.functionalweave.com/functions/time.round-to-increment" }, { "id": "time.iso-to-unix", "tier": "optional", "why": "RFC 3339 timestamps to Unix seconds.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "An RFC 3339 timestamp with a Z or offset, such as 2026-09-26T13:00:00+01:00, to Unix time in whole seconds.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isoToUnix" ], "signatures": [ "export function isoToUnix(timestamp: string): number" ], "reference": "import { isoToUnix } from \"#fune/time.iso-to-unix@^1\";", "url": "http://www.functionalweave.com/functions/time.iso-to-unix" }, { "id": "time.unix-to-iso", "tier": "optional", "why": "Unix seconds to an ISO 8601 UTC timestamp.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Unix time in seconds to an ISO 8601 UTC timestamp such as 2026-09-26T12:00:00Z, for years 0001 to 9999.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "unixToIso" ], "signatures": [ "export function unixToIso(seconds: number): string" ], "reference": "import { unixToIso } from \"#fune/time.unix-to-iso@^1\";", "url": "http://www.functionalweave.com/functions/time.unix-to-iso" }, { "id": "time.countdown", "tier": "optional", "why": "Seconds left until a moment and a 4:05 style timer text.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Seconds left until a Unix time, whether it has passed, and a timer text like 4:05, for tokens or retry waits.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "countdown" ], "signatures": [ "export function countdown(until: number, now: number): Countdown" ], "reference": "import { countdown } from \"#fune/time.countdown@^1\";", "url": "http://www.functionalweave.com/functions/time.countdown" } ], "gaps": [] }, { "key": "contact", "title": "Contact details", "purpose": "Check and normalise a person's contact details before storing them.", "from": "validation-basics", "members": [ { "id": "validation.email", "tier": "core", "why": "Is an email address plausible, by a documented subset of RFC 5322.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Is this a plausible email address? A documented, pragmatic subset of RFC 5322, not the full grammar.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isEmail" ], "signatures": [ "export function isEmail(value: string): boolean" ], "reference": "import { isEmail } from \"#fune/validation.email@^1\";", "url": "http://www.functionalweave.com/functions/validation.email" }, { "id": "validation.phone-e164", "tier": "core", "why": "Normalises a phone number to +44… E.164 for a default country.", "section": "contact", "from": "validation-basics", "version": "2.0.0", "summary": "Normalise a phone number to E.164 (+447700900123) using a default country's trunk and dialling prefixes.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validatePhoneE164" ], "signatures": [ "export function validatePhoneE164(value: string, defaultCountry: string): PhoneE164" ], "reference": "import { validatePhoneE164 } from \"#fune/validation.phone-e164@^2\";", "url": "http://www.functionalweave.com/functions/validation.phone-e164" }, { "id": "validation.uk-postcode", "tier": "core", "why": "Validates a UK postcode and puts it in canonical form.", "section": "contact", "from": "validation-basics", "version": "2.0.0", "summary": "Validate a UK postcode and normalise it to canonical upper case with one space before the inward code.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkPostcode" ], "signatures": [ "export function validateUkPostcode(value: string): UkPostcode" ], "reference": "import { validateUkPostcode } from \"#fune/validation.uk-postcode@^2\";", "url": "http://www.functionalweave.com/functions/validation.uk-postcode" }, { "id": "text.normalise-name", "tier": "optional", "why": "Tidies a typed name: spacing and title case with Mc, O' and hyphen rules.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Tidy a personal name: trim, collapse whitespace and title-case, with Mc, Mac, O', hyphen and van/de rules.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "normaliseName" ], "signatures": [ "export function normaliseName(value: string): string" ], "reference": "import { normaliseName } from \"#fune/text.normalise-name@^1\";", "url": "http://www.functionalweave.com/functions/text.normalise-name" }, { "id": "auth.normalise-email", "tier": "optional", "why": "Lower-cases an email's domain for storage and lookup.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Trim an email address and lower-case its domain for storage and lookup, or null if it is not a plausible address.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "normaliseEmail" ], "signatures": [ "export function normaliseEmail(value: string): string | null" ], "reference": "import { normaliseEmail } from \"#fune/auth.normalise-email@^1\";", "url": "http://www.functionalweave.com/functions/auth.normalise-email" } ], "gaps": [] }, { "key": "bank", "title": "Bank details", "purpose": "Check payee and customer bank details before money moves.", "from": "validation-basics", "members": [ { "id": "validation.iban", "tier": "core", "why": "Checks an IBAN's mod-97 checksum and its country's length.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Check an IBAN against the ISO 13616 mod-97-10 checksum and the registered length for its country.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isIban" ], "signatures": [ "export function isIban(value: string): boolean" ], "reference": "import { isIban } from \"#fune/validation.iban@^1\";", "url": "http://www.functionalweave.com/functions/validation.iban" }, { "id": "validation.bic", "tier": "optional", "why": "Checks a SWIFT/BIC code's format and splits it.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Check the format of a SWIFT/BIC code (8 or 11 characters) and split it into its parts.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateBic" ], "signatures": [ "export function validateBic(value: string): BicCheck" ], "reference": "import { validateBic } from \"#fune/validation.bic@^1\";", "url": "http://www.functionalweave.com/functions/validation.bic" }, { "id": "validation.uk-sort-code-account", "tier": "optional", "why": "Checks a UK sort code and account number by the Vocalink modulus rules, against a table you supply.", "section": "bank", "from": "validation-basics", "version": "3.0.0", "summary": "Check a UK sort code and account number with the Vocalink/Pay.UK modulus rules, against a table you supply.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkSortCodeAccount" ], "signatures": [ "export function validateUkSortCodeAccount(sortCode: string, accountNumber: string, table: UkModulusTable): UkSortCodeAccount" ], "reference": "import { validateUkSortCodeAccount } from \"#fune/validation.uk-sort-code-account@^3\";", "url": "http://www.functionalweave.com/functions/validation.uk-sort-code-account" }, { "id": "validation.uk-modulus-table", "tier": "optional", "why": "Parses Vocalink's VALACDOS and SCSUBTAB files into that table.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Parse Vocalink's VALACDOS.txt and SCSUBTAB.txt into the table UK sort code modulus checking needs.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "parseUkModulusTable" ], "signatures": [ "export function parseUkModulusTable(valacdos: string, scsubtab: string): UkModulusTable" ], "reference": "import { parseUkModulusTable } from \"#fune/validation.uk-modulus-table@^1\";", "url": "http://www.functionalweave.com/functions/validation.uk-modulus-table" } ], "gaps": [] }, { "key": "check-digits", "title": "Identifiers and check digits", "purpose": "Catch mistyped reference numbers by their check digits.", "from": "validation-basics", "members": [ { "id": "validation.luhn", "tier": "optional", "why": "Luhn mod-10 check, for card numbers and many reference numbers.", "section": "check-digits", "from": "validation-basics", "version": "1.0.0", "summary": "Check a digit string against the Luhn mod-10 checksum used by payment cards and many identifiers.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isLuhn" ], "signatures": [ "export function isLuhn(value: string): boolean" ], "reference": "import { isLuhn } from \"#fune/validation.luhn@^1\";", "url": "http://www.functionalweave.com/functions/validation.luhn" }, { "id": "validation.uk-company-number", "tier": "optional", "why": "Checks a Companies House number's format and prefix.", "section": "check-digits", "from": "validation-basics", "version": "2.0.1", "summary": "Check a Companies House company number's format and prefix (SC, NI, OC, LP...) and zero-pad it to eight characters.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkCompanyNumber" ], "signatures": [ "export function validateUkCompanyNumber(value: string): UkCompanyNumber" ], "reference": "import { validateUkCompanyNumber } from \"#fune/validation.uk-company-number@^2\";", "url": "http://www.functionalweave.com/functions/validation.uk-company-number" }, { "id": "validation.lei", "tier": "optional", "why": "Checks a Legal Entity Identifier's check digits.", "section": "check-digits", "from": "validation-basics", "version": "1.0.0", "summary": "Check a 20-character Legal Entity Identifier against its ISO 17442 / ISO 7064 MOD 97-10 check digits.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateLei" ], "signatures": [ "export function validateLei(value: string): LeiCheck" ], "reference": "import { validateLei } from \"#fune/validation.lei@^1\";", "url": "http://www.functionalweave.com/functions/validation.lei" }, { "id": "validation.gtin", "tier": "optional", "why": "Checks an EAN/UPC/GTIN barcode number.", "section": "check-digits", "from": "validation-basics", "version": "1.1.0", "summary": "Check an EAN-8, UPC-A, EAN-13 or GTIN-14 barcode number against the GS1 mod-10 check digit.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateGtin" ], "signatures": [ "export function validateGtin(value: string): GtinCheck" ], "reference": "import { validateGtin } from \"#fune/validation.gtin@^1\";", "url": "http://www.functionalweave.com/functions/validation.gtin" } ], "gaps": [] }, { "key": "masking", "title": "Displaying sensitive values", "purpose": "Show stored identifiers without exposing them.", "from": "validation-basics", "members": [ { "id": "text.mask", "tier": "optional", "why": "Masks all but the last digits of a card, account or phone number.", "section": "masking", "from": "validation-basics", "version": "1.0.0", "summary": "Mask all but the last n characters of a card, account or phone number, optionally keeping separators.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "mask" ], "signatures": [ "export function mask(value: string, visible: number, maskChar: string, keepSeparators: boolean): string" ], "reference": "import { mask } from \"#fune/text.mask@^1\";", "url": "http://www.functionalweave.com/functions/text.mask" } ], "gaps": [] } ], "gaps": [ { "key": "risk-data", "text": "External risk data (vehicle lookups, flood and crime scores, address data) comes from data providers.", "section": "rating", "from": "insurance" }, { "key": "fraud-checks", "text": "Claims fraud detection and industry databases (CUE, IFB) are services caps does not have.", "section": "claims", "from": "insurance" }, { "key": "earned-premium", "text": "Earned and unearned premium reserves across the book at a reporting date are not computed by caps.", "section": "performance", "from": "insurance" }, { "key": "policy-documents", "text": "Policy schedules, certificates and statements of fact: caps gives figures, not documents.", "section": null, "from": "insurance" }, { "key": "renewal-pricing", "text": "Renewal pricing rules (the FCA's price-walking ban: renewal no dearer than new business) are policy you implement.", "section": null, "from": "insurance" }, { "key": "fx-rate-source", "text": "Where exchange rates come from: money.convert takes a rate you supply; fetching and storing daily rates (ECB, a provider's API) is yours.", "section": null, "from": "money-basics" }, { "key": "money-storage", "text": "Storing amounts: the database columns (integer minor units plus a currency code) and their migrations are yours.", "section": null, "from": "money-basics" }, { "key": "time-zones", "text": "Time zones and daylight saving: caps works in ISO dates, UTC and wall-clock times; converting with the IANA tz rules is yours.", "section": null, "from": "dates-basics" }, { "key": "locale-formatting", "text": "Showing dates in a user's language and format (\"3 octobre 2026\"): caps returns ISO dates, not localised text.", "section": null, "from": "dates-basics" }, { "key": "non-uk-holidays", "text": "Public holidays outside the UK: dates.bank-holidays is UK only; pass another country's list to the working-day functions yourself.", "section": null, "from": "dates-basics" }, { "key": "address-lookup", "text": "Turning a postcode into a list of addresses (Royal Mail PAF or a lookup API) is network work and not in caps.", "section": null, "from": "validation-basics" }, { "key": "email-deliverability", "text": "Whether a mailbox exists (MX lookups, a confirmation email): validation.email checks the syntax only.", "section": null, "from": "validation-basics" }, { "key": "vocalink-data", "text": "The Vocalink modulus tables themselves: download them from Pay.UK under its terms; caps parses them but does not ship them.", "section": null, "from": "validation-basics" } ], "counts": { "members": 65, "core": 28, "optional": 37, "unreviewed": 12, "deprecated": [], "unavailable": [], "missing": [], "gaps": 13 }, "warnings": [ "7 core capabilities are unreviewed - they pass their tests but await an expert's sign-off; tell the user before relying on them, and never use one silently for tax, payroll, legal, clinical or other regulated rules: insurance.rating-factors, insurance.ipt, insurance.instalment-plan, insurance.mid-term-adjustment, insurance.premium-proration, insurance.excess-apply, insurance.claim-reserve", "5 optional capabilities are unreviewed too: insurance.age-banding, insurance.no-claims-discount, lending.apr, insurance.sum-insured-average, insurance.loss-ratio", "Not insurance or regulatory advice. Rating tables, scales and factors are the insurer's own, supplied by the caller; IPT follows UK HMRC rates." ], "url": "http://www.functionalweave.com/suites/insurance", "owner": null }