@sharpee/lang-en-us 2.0.0 → 2.1.0

package/formatters/types.d.ts

@@ -1,52 +0,0 @@
-/**
- * Formatter Types
- *
- * Formatters transform placeholder values in message templates.
- *
- * Syntax: {formatter:formatter:...:placeholder} (the placeholder is the last segment)
- * Example: {a:item} → "a sword"
- * Example: {list:items} → "a sword, a key, and a coin"
- *
- * @see ADR-095 Message Templates with Formatters
- */
-/**
- * Context passed to formatters
- */
-export interface FormatterContext {
-    /** Get entity by ID for nounType/article lookup */
-    getEntity?: (id: string) => EntityInfo | undefined;
-    /** Render-time settings the language layer reads (ADR-190). */
-    settings?: {
-        /** Serial (Oxford) comma in lists. Default true when absent. */
-        serialComma?: boolean;
-    };
-}
-/**
- * Minimal entity info for formatting
- */
-export interface EntityInfo {
-    name: string;
-    nounType?: 'common' | 'proper' | 'mass' | 'unique' | 'plural';
-    properName?: boolean;
-    article?: string;
-    grammaticalNumber?: 'singular' | 'plural';
-    /**
-     * Author-supplied plural form for irregular nouns (ADR-190). Populated from
-     * `IdentityTrait.plural` by `entityInfoFrom`. The `list`/`count` formatters use
-     * it when present, else fall back to the `pluralize()` heuristic.
-     */
-    plural?: string;
-}
-/**
- * Formatter function signature
- *
- * @param value - The value to format (string, array, or EntityInfo)
- * @param context - Formatting context with entity lookup
- * @returns Formatted string
- */
-export type Formatter = (value: string | string[] | EntityInfo | EntityInfo[], context: FormatterContext) => string;
-/**
- * Formatter registry - maps formatter names to functions
- */
-export type FormatterRegistry = Map<string, Formatter>;
-//# sourceMappingURL=types.d.ts.map

package/formatters/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../../../repos/sharpee_v1/packages/lang-en-us/src/formatters/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,mDAAmD;IACnD,SAAS,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,UAAU,GAAG,SAAS,CAAC;IACnD,+DAA+D;IAC/D,QAAQ,CAAC,EAAE;QACT,gEAAgE;QAChE,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC9D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,UAAU,GAAG,QAAQ,CAAC;IAC1C;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,CACtB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,UAAU,GAAG,UAAU,EAAE,EACpD,OAAO,EAAE,gBAAgB,KACtB,MAAM,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC"}

package/formatters/types.js

@@ -1,14 +0,0 @@
-"use strict";
-/**
- * Formatter Types
- *
- * Formatters transform placeholder values in message templates.
- *
- * Syntax: {formatter:formatter:...:placeholder} (the placeholder is the last segment)
- * Example: {a:item} → "a sword"
- * Example: {list:items} → "a sword, a key, and a coin"
- *
- * @see ADR-095 Message Templates with Formatters
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map

package/formatters/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../repos/sharpee_v1/packages/lang-en-us/src/formatters/types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG"}

package/formatters/verb.d.ts

@@ -1,30 +0,0 @@
-/**
- * Verb-Agreement Formatters
- *
- * Formatters that emit a verb form agreeing in number with the entity they
- * are keyed to, so templates need not hardcode a singular verb. The verb is
- * chosen from the entity's grammatical number, mirroring how the article
- * formatters choose articles from `nounType`.
- *
- * Syntax keys the formatter to a placeholder, e.g. `{is:item}` resolves the
- * `item` value and emits the agreeing copula:
- *
- *   "{the:cap:item} {is:item} fixed in place."
- *     → "The white house is fixed in place."   (singular)
- *     → "The pygmy goats are fixed in place."  (plural)
- *
- * An entity is treated as plural when its `nounType` is `'plural'` or its
- * `grammaticalNumber` is `'plural'`. A bare string (no EntityInfo metadata)
- * or a missing value falls back to the singular form.
- *
- * @see ADR-095 Message Templates with Formatters
- * @see ADR-089 Grammatical Number
- */
-import type { Formatter } from './types.js';
-/** "is" formatter — emits "is" (singular) or "are" (plural). */
-export declare const isFormatter: Formatter;
-/** "was" formatter — emits "was" (singular) or "were" (plural). */
-export declare const wasFormatter: Formatter;
-/** "has" formatter — emits "has" (singular) or "have" (plural). */
-export declare const hasFormatter: Formatter;
-//# sourceMappingURL=verb.d.ts.map

package/formatters/verb.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"verb.d.ts","sourceRoot":"","sources":["../../../../../../../repos/sharpee_v1/packages/lang-en-us/src/formatters/verb.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAc,MAAM,YAAY,CAAC;AA+BxD,gEAAgE;AAChE,eAAO,MAAM,WAAW,EAAE,SAA+C,CAAC;AAE1E,mEAAmE;AACnE,eAAO,MAAM,YAAY,EAAE,SAAiD,CAAC;AAE7E,mEAAmE;AACnE,eAAO,MAAM,YAAY,EAAE,SAAiD,CAAC"}

package/formatters/verb.js

@@ -1,59 +0,0 @@
-"use strict";
-/**
- * Verb-Agreement Formatters
- *
- * Formatters that emit a verb form agreeing in number with the entity they
- * are keyed to, so templates need not hardcode a singular verb. The verb is
- * chosen from the entity's grammatical number, mirroring how the article
- * formatters choose articles from `nounType`.
- *
- * Syntax keys the formatter to a placeholder, e.g. `{is:item}` resolves the
- * `item` value and emits the agreeing copula:
- *
- *   "{the:cap:item} {is:item} fixed in place."
- *     → "The white house is fixed in place."   (singular)
- *     → "The pygmy goats are fixed in place."  (plural)
- *
- * An entity is treated as plural when its `nounType` is `'plural'` or its
- * `grammaticalNumber` is `'plural'`. A bare string (no EntityInfo metadata)
- * or a missing value falls back to the singular form.
- *
- * @see ADR-095 Message Templates with Formatters
- * @see ADR-089 Grammatical Number
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasFormatter = exports.wasFormatter = exports.isFormatter = void 0;
-/**
- * Decide whether a formatter value should take a plural verb.
- *
- * @param value - The placeholder value (EntityInfo, string, or array thereof).
- * @returns true when the value is grammatically plural.
- */
-function isPlural(value) {
-    // An array of values reads as plural unless it holds exactly one item.
-    if (Array.isArray(value)) {
-        return value.length !== 1;
-    }
-    if (typeof value === 'string') {
-        return false; // No metadata on a bare string — default to singular.
-    }
-    return value.nounType === 'plural' || value.grammaticalNumber === 'plural';
-}
-/**
- * Build a copula/auxiliary formatter that emits `singular` or `plural`
- * depending on the value's grammatical number.
- *
- * @param singular - Verb form for singular subjects (e.g. "is").
- * @param plural - Verb form for plural subjects (e.g. "are").
- * @returns A Formatter that returns the agreeing form.
- */
-function makeAgreementFormatter(singular, plural) {
-    return (value, _context) => (isPlural(value) ? plural : singular);
-}
-/** "is" formatter — emits "is" (singular) or "are" (plural). */
-exports.isFormatter = makeAgreementFormatter('is', 'are');
-/** "was" formatter — emits "was" (singular) or "were" (plural). */
-exports.wasFormatter = makeAgreementFormatter('was', 'were');
-/** "has" formatter — emits "has" (singular) or "have" (plural). */
-exports.hasFormatter = makeAgreementFormatter('has', 'have');
-//# sourceMappingURL=verb.js.map

package/formatters/verb.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"verb.js","sourceRoot":"","sources":["../../../../../../../repos/sharpee_v1/packages/lang-en-us/src/formatters/verb.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AAIH;;;;;GAKG;AACH,SAAS,QAAQ,CAAC,KAAoD;IACpE,uEAAuE;IACvE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC;IAC5B,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC,CAAC,sDAAsD;IACtE,CAAC;IACD,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,KAAK,CAAC,iBAAiB,KAAK,QAAQ,CAAC;AAC7E,CAAC;AAED;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAAC,QAAgB,EAAE,MAAc;IAC9D,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;AACpE,CAAC;AAED,gEAAgE;AACnD,QAAA,WAAW,GAAc,sBAAsB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;AAE1E,mEAAmE;AACtD,QAAA,YAAY,GAAc,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAE7E,mEAAmE;AACtD,QAAA,YAAY,GAAc,sBAAsB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC"}