@plyaz/types 1.1.2 → 1.1.3

package/dist/translations/types.d.ts

@@ -1,4 +1,3 @@
-import type { Paths, Get } from 'type-fest';
 /**
  * Translation leaf type.
  * @description This type represents the structure of a translation leaf.
@@ -37,12 +36,56 @@ TranslationResourcesNested>>;
  * @example 'common', 'errors', etc.
  */
 export type Namespace<Resources extends TranslationResources> = keyof Resources['en'];
+/**
+ * Helper type to remove the first element from a tuple type.
+ * Used internally by LeafPaths to track recursion depth.
+ */
+type PrevTuple<T extends readonly unknown[]> = T extends [unknown, ...infer R] ? R : [];
 /**
  * Recursively extracts all nested keys from an object, creating dot-notation paths.
+ * @description This utility type traverses nested objects and creates dot-separated key paths.
+ * It uses a depth counter to prevent infinite recursion (max 25 levels, which should be sufficient
+ * for most translation structures while avoiding TypeScript compiler limits).
+ * @example
+ * type Paths = LeafPaths<{ a: { b: string, c: { d: string } } }>;
+ * // Result: 'a.b' | 'a.c.d'
+ * @template T - The object type to extract paths from
+ * @template Prev - The accumulated path string (used internally)
+ * @template Depth - Tuple type used to track recursion depth and prevent infinite loops
  */
-export type LeafPaths<T> = Paths<T> extends infer P ? P extends string ? Get<T, P> extends object ? never : P : never : never;
+export type LeafPaths<T, Prev extends string = '', Depth extends readonly unknown[] = [
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1,
+    1
+]> = Depth['length'] extends 0 ? never : T extends string ? Prev : T extends object ? {
+    [K in keyof T]: LeafPaths<T[K], Prev extends '' ? Extract<K, string> : `${Prev}.${Extract<K, string>}`, PrevTuple<Depth>>;
+}[keyof T] : never;
 /**
  * Type-safe union of all translation keys in the form 'namespace.key' or 'namespace.nested.key'.
+ * @description This type generates a union of all possible translation keys by combining
+ * namespace names with their nested key paths. It ensures type safety when accessing translations.
  * @example 'common.hello', 'common.greeting', 'common.followers.zero', etc.
  * @example use: TranslationKeys<TranslationResources, 'en'>
  */
@@ -218,6 +261,11 @@ export interface Translator {
      */
     readonly addNamespace: (namespace: string, translations: Record<string, string>) => void;
 }
+/**
+ * Command-line interface options for extracting translation keys from source code.
+ * @description These types define the configuration options for the CLI tool that
+ * automatically extracts translation keys from source files and generates translation files.
+ */
 export interface ExtractOptions {
     /**
      * File pattern to search for translation keys
@@ -240,6 +288,16 @@ export interface ExtractOptions {
      */
     readonly shouldDryRun: boolean;
 }
+/**
+ * Pluralization test cases for validating translation pluralization rules.
+ * @description These types define the structure for testing pluralization functionality
+ * across different languages, ensuring correct plural forms are used based on numeric values.
+ */
+/**
+ * Represents a single test case for pluralization validation.
+ * @description Defines a numeric value and its expected translation string
+ * to test pluralization rules in different languages.
+ */
 export interface PluralizationValueCase {
     /**
      * The numeric value to test pluralization against
@@ -250,6 +308,11 @@ export interface PluralizationValueCase {
      */
     readonly expected: string;
 }
+/**
+ * Represents a complete set of pluralization test cases for a specific language.
+ * @description Groups multiple pluralization value cases together for a single language,
+ * allowing comprehensive testing of pluralization rules across different numeric values.
+ */
 export interface PluralizationCase {
     /**
      * The language code for this pluralization case
@@ -260,6 +323,16 @@ export interface PluralizationCase {
      */
     readonly values: readonly PluralizationValueCase[];
 }
+/**
+ * Date formatting test cases for validating locale-specific date formatting.
+ * @description These types define the structure for testing date formatting functionality
+ * across different languages and locales.
+ */
+/**
+ * Represents a test case for date formatting validation.
+ * @description Defines a language and its expected formatted date string
+ * to test date formatting rules in different locales.
+ */
 export interface DateCase {
     /**
      * The language code for this date formatting case
@@ -270,6 +343,16 @@ export interface DateCase {
      */
     readonly expected: string;
 }
+/**
+ * Number formatting test cases for validating locale-specific number formatting.
+ * @description These types define the structure for testing number formatting functionality
+ * across different languages and locales.
+ */
+/**
+ * Represents a test case for number formatting validation.
+ * @description Defines a language and its expected formatted number string
+ * to test number formatting rules in different locales.
+ */
 export interface NumberCase {
     /**
      * The language code for this number formatting case
@@ -280,6 +363,16 @@ export interface NumberCase {
      */
     readonly expected: string;
 }
+/**
+ * Currency formatting test cases for validating locale-specific currency formatting.
+ * @description These types define the structure for testing currency formatting functionality
+ * across different languages and locales, including currency symbols and formatting options.
+ */
+/**
+ * Represents a test case for currency formatting validation.
+ * @description Defines a language, expected formatted currency string, and formatting options
+ * to test currency formatting rules in different locales.
+ */
 export interface CurrencyCase {
     /**
      * The language code for this currency formatting case
@@ -294,3 +387,4 @@ export interface CurrencyCase {
      */
     readonly options: Intl.NumberFormatOptions;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plyaz/types",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "author": "Redeemer Pace",
   "license": "ISC",
   "description": "Provides shared TypeScript types and schema utilities for validation and parsing in the @playz ecosystem.",