@stryke/string-format 0.12.13 → 0.12.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stryke/string-format",
-  "version": "0.12.13",
+  "version": "0.12.20",
   "type": "module",
   "description": "A package containing utility functions to transform strings into various formats.",
   "repository": {
@@ -9,441 +9,119 @@
     "directory": "packages/string-format"
   },
   "private": false,
-  "publishConfig": { "access": "public" },
-  "dependencies": { "@stryke/helpers": "^0.9.15", "@stryke/types": "^0.10.13" },
-  "devDependencies": {},
-  "sideEffects": false,
-  "files": ["dist/**/*"],
-  "homepage": "https://stormsoftware.com",
-  "bugs": {
-    "url": "https://stormsoftware.com/support",
-    "email": "support@stormsoftware.com"
-  },
-  "license": "Apache-2.0",
-  "keywords": [
-    "stryke",
-    "typescript",
-    "utilities",
-    "storm-software",
-    "storm",
-    "storm-ops",
-    "cyclone-ui",
-    "sullivanpj",
-    "monorepo"
-  ],
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/storm-software"
-  },
-  "author": {
-    "name": "Storm Software",
-    "email": "contact@stormsoftware.com",
-    "url": "https://stormsoftware.com"
-  },
-  "maintainers": [
-    {
-      "name": "Storm Software",
-      "email": "contact@stormsoftware.com",
-      "url": "https://stormsoftware.com"
-    }
-  ],
-  "contributors": [
-    {
-      "name": "Storm Software",
-      "email": "contact@stormsoftware.com",
-      "url": "https://stormsoftware.com"
-    }
-  ],
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
   "exports": {
-    "./upper-case-first": {
-      "import": {
-        "types": "./dist/upper-case-first.d.ts",
-        "default": "./dist/upper-case-first.mjs"
-      },
-      "require": {
-        "types": "./dist/upper-case-first.d.ts",
-        "default": "./dist/upper-case-first.cjs"
-      },
-      "default": {
-        "types": "./dist/upper-case-first.d.ts",
-        "default": "./dist/upper-case-first.mjs"
-      }
-    },
-    "./unescape": {
-      "import": {
-        "types": "./dist/unescape.d.ts",
-        "default": "./dist/unescape.mjs"
-      },
-      "require": {
-        "types": "./dist/unescape.d.ts",
-        "default": "./dist/unescape.cjs"
-      },
-      "default": {
-        "types": "./dist/unescape.d.ts",
-        "default": "./dist/unescape.mjs"
-      }
-    },
-    "./title-case": {
-      "import": {
-        "types": "./dist/title-case.d.ts",
-        "default": "./dist/title-case.mjs"
-      },
-      "require": {
-        "types": "./dist/title-case.d.ts",
-        "default": "./dist/title-case.cjs"
-      },
-      "default": {
-        "types": "./dist/title-case.d.ts",
-        "default": "./dist/title-case.mjs"
-      }
+    ".": { "require": "./dist/index.cjs", "import": "./dist/index.mjs" },
+    "./acronyms": {
+      "require": "./dist/acronyms.cjs",
+      "import": "./dist/acronyms.mjs"
     },
-    "./strip-indents": {
-      "import": {
-        "types": "./dist/strip-indents.d.ts",
-        "default": "./dist/strip-indents.mjs"
-      },
-      "require": {
-        "types": "./dist/strip-indents.d.ts",
-        "default": "./dist/strip-indents.cjs"
-      },
-      "default": {
-        "types": "./dist/strip-indents.d.ts",
-        "default": "./dist/strip-indents.mjs"
-      }
+    "./articles": {
+      "require": "./dist/articles.cjs",
+      "import": "./dist/articles.mjs"
     },
-    "./start-case": {
-      "import": {
-        "types": "./dist/start-case.d.ts",
-        "default": "./dist/start-case.mjs"
-      },
-      "require": {
-        "types": "./dist/start-case.d.ts",
-        "default": "./dist/start-case.cjs"
-      },
-      "default": {
-        "types": "./dist/start-case.d.ts",
-        "default": "./dist/start-case.mjs"
-      }
+    "./camel-case": {
+      "require": "./dist/camel-case.cjs",
+      "import": "./dist/camel-case.mjs"
     },
-    "./special-cases": {
-      "import": {
-        "types": "./dist/special-cases.d.ts",
-        "default": "./dist/special-cases.mjs"
-      },
-      "require": {
-        "types": "./dist/special-cases.d.ts",
-        "default": "./dist/special-cases.cjs"
-      },
-      "default": {
-        "types": "./dist/special-cases.d.ts",
-        "default": "./dist/special-cases.mjs"
-      }
+    "./combine": {
+      "require": "./dist/combine.cjs",
+      "import": "./dist/combine.mjs"
     },
-    "./snake-case": {
-      "import": {
-        "types": "./dist/snake-case.d.ts",
-        "default": "./dist/snake-case.mjs"
-      },
-      "require": {
-        "types": "./dist/snake-case.d.ts",
-        "default": "./dist/snake-case.cjs"
-      },
-      "default": {
-        "types": "./dist/snake-case.d.ts",
-        "default": "./dist/snake-case.mjs"
-      }
+    "./conjunctions": {
+      "require": "./dist/conjunctions.cjs",
+      "import": "./dist/conjunctions.mjs"
     },
-    "./pretty-bytes": {
-      "import": {
-        "types": "./dist/pretty-bytes.d.ts",
-        "default": "./dist/pretty-bytes.mjs"
-      },
-      "require": {
-        "types": "./dist/pretty-bytes.d.ts",
-        "default": "./dist/pretty-bytes.cjs"
-      },
-      "default": {
-        "types": "./dist/pretty-bytes.d.ts",
-        "default": "./dist/pretty-bytes.mjs"
-      }
+    "./constant-case": {
+      "require": "./dist/constant-case.cjs",
+      "import": "./dist/constant-case.mjs"
     },
-    "./prepositions": {
-      "import": {
-        "types": "./dist/prepositions.d.ts",
-        "default": "./dist/prepositions.mjs"
-      },
-      "require": {
-        "types": "./dist/prepositions.d.ts",
-        "default": "./dist/prepositions.cjs"
-      },
-      "default": {
-        "types": "./dist/prepositions.d.ts",
-        "default": "./dist/prepositions.mjs"
-      }
+    "./deburr": {
+      "require": "./dist/deburr.cjs",
+      "import": "./dist/deburr.mjs"
     },
-    "./period-split": {
-      "import": {
-        "types": "./dist/period-split.d.ts",
-        "default": "./dist/period-split.mjs"
-      },
-      "require": {
-        "types": "./dist/period-split.d.ts",
-        "default": "./dist/period-split.cjs"
-      },
-      "default": {
-        "types": "./dist/period-split.d.ts",
-        "default": "./dist/period-split.mjs"
-      }
+    "./decamelize": {
+      "require": "./dist/decamelize.cjs",
+      "import": "./dist/decamelize.mjs"
     },
-    "./pascal-case": {
-      "import": {
-        "types": "./dist/pascal-case.d.ts",
-        "default": "./dist/pascal-case.mjs"
-      },
-      "require": {
-        "types": "./dist/pascal-case.d.ts",
-        "default": "./dist/pascal-case.cjs"
-      },
-      "default": {
-        "types": "./dist/pascal-case.d.ts",
-        "default": "./dist/pascal-case.mjs"
-      }
+    "./escape": {
+      "require": "./dist/escape.cjs",
+      "import": "./dist/escape.mjs"
     },
-    "./pad": {
-      "import": { "types": "./dist/pad.d.ts", "default": "./dist/pad.mjs" },
-      "require": { "types": "./dist/pad.d.ts", "default": "./dist/pad.cjs" },
-      "default": { "types": "./dist/pad.d.ts", "default": "./dist/pad.mjs" }
+    "./format-special-cases": {
+      "require": "./dist/format-special-cases.cjs",
+      "import": "./dist/format-special-cases.mjs"
     },
-    "./package": {
-      "import": {
-        "types": "./dist/package.d.ts",
-        "default": "./dist/package.mjs"
-      },
-      "require": {
-        "types": "./dist/package.d.ts",
-        "default": "./dist/package.cjs"
-      },
-      "default": {
-        "types": "./dist/package.d.ts",
-        "default": "./dist/package.mjs"
-      }
+    "./get-words": {
+      "require": "./dist/get-words.cjs",
+      "import": "./dist/get-words.mjs"
     },
-    "./normalize-email": {
-      "import": {
-        "types": "./dist/normalize-email.d.ts",
-        "default": "./dist/normalize-email.mjs"
-      },
-      "require": {
-        "types": "./dist/normalize-email.d.ts",
-        "default": "./dist/normalize-email.cjs"
-      },
-      "default": {
-        "types": "./dist/normalize-email.d.ts",
-        "default": "./dist/normalize-email.mjs"
-      }
+    "./kebab-case": {
+      "require": "./dist/kebab-case.cjs",
+      "import": "./dist/kebab-case.mjs"
     },
     "./lower-case-first": {
-      "import": {
-        "types": "./dist/lower-case-first.d.ts",
-        "default": "./dist/lower-case-first.mjs"
-      },
-      "require": {
-        "types": "./dist/lower-case-first.d.ts",
-        "default": "./dist/lower-case-first.cjs"
-      },
-      "default": {
-        "types": "./dist/lower-case-first.d.ts",
-        "default": "./dist/lower-case-first.mjs"
-      }
-    },
-    "./kebab-case": {
-      "import": {
-        "types": "./dist/kebab-case.d.ts",
-        "default": "./dist/kebab-case.mjs"
-      },
-      "require": {
-        "types": "./dist/kebab-case.d.ts",
-        "default": "./dist/kebab-case.cjs"
-      },
-      "default": {
-        "types": "./dist/kebab-case.d.ts",
-        "default": "./dist/kebab-case.mjs"
-      }
+      "require": "./dist/lower-case-first.cjs",
+      "import": "./dist/lower-case-first.mjs"
     },
-    "./index": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
-      },
-      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
+    "./normalize-email": {
+      "require": "./dist/normalize-email.cjs",
+      "import": "./dist/normalize-email.mjs"
     },
-    "./get-words": {
-      "import": {
-        "types": "./dist/get-words.d.ts",
-        "default": "./dist/get-words.mjs"
-      },
-      "require": {
-        "types": "./dist/get-words.d.ts",
-        "default": "./dist/get-words.cjs"
-      },
-      "default": {
-        "types": "./dist/get-words.d.ts",
-        "default": "./dist/get-words.mjs"
-      }
+    "./package": {
+      "require": "./dist/package.cjs",
+      "import": "./dist/package.mjs"
     },
-    "./format-special-cases": {
-      "import": {
-        "types": "./dist/format-special-cases.d.ts",
-        "default": "./dist/format-special-cases.mjs"
-      },
-      "require": {
-        "types": "./dist/format-special-cases.d.ts",
-        "default": "./dist/format-special-cases.cjs"
-      },
-      "default": {
-        "types": "./dist/format-special-cases.d.ts",
-        "default": "./dist/format-special-cases.mjs"
-      }
+    "./pad": { "require": "./dist/pad.cjs", "import": "./dist/pad.mjs" },
+    "./pascal-case": {
+      "require": "./dist/pascal-case.cjs",
+      "import": "./dist/pascal-case.mjs"
     },
-    "./escape": {
-      "import": {
-        "types": "./dist/escape.d.ts",
-        "default": "./dist/escape.mjs"
-      },
-      "require": {
-        "types": "./dist/escape.d.ts",
-        "default": "./dist/escape.cjs"
-      },
-      "default": {
-        "types": "./dist/escape.d.ts",
-        "default": "./dist/escape.mjs"
-      }
+    "./period-split": {
+      "require": "./dist/period-split.cjs",
+      "import": "./dist/period-split.mjs"
     },
-    "./decamelize": {
-      "import": {
-        "types": "./dist/decamelize.d.ts",
-        "default": "./dist/decamelize.mjs"
-      },
-      "require": {
-        "types": "./dist/decamelize.d.ts",
-        "default": "./dist/decamelize.cjs"
-      },
-      "default": {
-        "types": "./dist/decamelize.d.ts",
-        "default": "./dist/decamelize.mjs"
-      }
+    "./prepositions": {
+      "require": "./dist/prepositions.cjs",
+      "import": "./dist/prepositions.mjs"
     },
-    "./deburr": {
-      "import": {
-        "types": "./dist/deburr.d.ts",
-        "default": "./dist/deburr.mjs"
-      },
-      "require": {
-        "types": "./dist/deburr.d.ts",
-        "default": "./dist/deburr.cjs"
-      },
-      "default": {
-        "types": "./dist/deburr.d.ts",
-        "default": "./dist/deburr.mjs"
-      }
+    "./pretty-bytes": {
+      "require": "./dist/pretty-bytes.cjs",
+      "import": "./dist/pretty-bytes.mjs"
     },
-    "./constant-case": {
-      "import": {
-        "types": "./dist/constant-case.d.ts",
-        "default": "./dist/constant-case.mjs"
-      },
-      "require": {
-        "types": "./dist/constant-case.d.ts",
-        "default": "./dist/constant-case.cjs"
-      },
-      "default": {
-        "types": "./dist/constant-case.d.ts",
-        "default": "./dist/constant-case.mjs"
-      }
+    "./snake-case": {
+      "require": "./dist/snake-case.cjs",
+      "import": "./dist/snake-case.mjs"
     },
-    "./conjunctions": {
-      "import": {
-        "types": "./dist/conjunctions.d.ts",
-        "default": "./dist/conjunctions.mjs"
-      },
-      "require": {
-        "types": "./dist/conjunctions.d.ts",
-        "default": "./dist/conjunctions.cjs"
-      },
-      "default": {
-        "types": "./dist/conjunctions.d.ts",
-        "default": "./dist/conjunctions.mjs"
-      }
+    "./special-cases": {
+      "require": "./dist/special-cases.cjs",
+      "import": "./dist/special-cases.mjs"
     },
-    "./combine": {
-      "import": {
-        "types": "./dist/combine.d.ts",
-        "default": "./dist/combine.mjs"
-      },
-      "require": {
-        "types": "./dist/combine.d.ts",
-        "default": "./dist/combine.cjs"
-      },
-      "default": {
-        "types": "./dist/combine.d.ts",
-        "default": "./dist/combine.mjs"
-      }
+    "./start-case": {
+      "require": "./dist/start-case.cjs",
+      "import": "./dist/start-case.mjs"
     },
-    "./camel-case": {
-      "import": {
-        "types": "./dist/camel-case.d.ts",
-        "default": "./dist/camel-case.mjs"
-      },
-      "require": {
-        "types": "./dist/camel-case.d.ts",
-        "default": "./dist/camel-case.cjs"
-      },
-      "default": {
-        "types": "./dist/camel-case.d.ts",
-        "default": "./dist/camel-case.mjs"
-      }
+    "./strip-indents": {
+      "require": "./dist/strip-indents.cjs",
+      "import": "./dist/strip-indents.mjs"
     },
-    "./articles": {
-      "import": {
-        "types": "./dist/articles.d.ts",
-        "default": "./dist/articles.mjs"
-      },
-      "require": {
-        "types": "./dist/articles.d.ts",
-        "default": "./dist/articles.cjs"
-      },
-      "default": {
-        "types": "./dist/articles.d.ts",
-        "default": "./dist/articles.mjs"
-      }
+    "./title-case": {
+      "require": "./dist/title-case.cjs",
+      "import": "./dist/title-case.mjs"
     },
-    "./acronyms": {
-      "import": {
-        "types": "./dist/acronyms.d.ts",
-        "default": "./dist/acronyms.mjs"
-      },
-      "require": {
-        "types": "./dist/acronyms.d.ts",
-        "default": "./dist/acronyms.cjs"
-      },
-      "default": {
-        "types": "./dist/acronyms.d.ts",
-        "default": "./dist/acronyms.mjs"
-      }
+    "./unescape": {
+      "require": "./dist/unescape.cjs",
+      "import": "./dist/unescape.mjs"
     },
-    ".": {
-      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.cjs"
-      },
-      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.mjs" }
+    "./upper-case-first": {
+      "require": "./dist/upper-case-first.cjs",
+      "import": "./dist/upper-case-first.mjs"
     },
-    "./package.json": "./package.json"
+    "./*": "./*"
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "gitHead": "eb28313b3230b7ea654c87586ca07773e2e57f52"
+  "types": "./dist/index.d.cts",
+  "devDependencies": { "tsdown": "^0.17.1" },
+  "publishConfig": { "access": "public" },
+  "gitHead": "5c645896466d1f6a26fb9cf9748ba226dd4d1f07"
 }

package/dist/acronyms.d.ts

@@ -1,13 +0,0 @@
-/**
- * A running list of common acronyms and their meanings.
- *
- * @remarks
- * This list is not exhaustive and may be updated over time.
- */
-export declare const ACRONYMS: Record<string, {
-    description: string;
-    display?: string;
-}>;
-export declare const ACRONYM_DISPLAY: Record<string, string>;
-export declare const ACRONYM_DESCRIPTION: Record<string, string>;
-export declare const ACRONYM_LIST: string[];

package/dist/articles.d.ts

@@ -1 +0,0 @@
-export declare const ARTICLES: string[];

package/dist/combine.d.ts

@@ -1,8 +0,0 @@
-/**
- * Combine two strings with a space in between.
- *
- * @param acc - The accumulated string.
- * @param str - The string to add.
- * @returns The combined string.
- */
-export declare function combine(acc: string, str: string): string;

package/dist/conjunctions.d.ts

@@ -1 +0,0 @@
-export declare const CONJUNCTIONS: string[];

package/dist/format-special-cases.d.ts

@@ -1,19 +0,0 @@
-export interface FormatSpecialCasesOptions {
-    /**
-     * If true, use the descriptions from the acronym list instead of the display names.
-     *
-     * @defaultValue true
-     */
-    useDescriptions?: boolean;
-}
-/**
- * Handle special words in a title.
- *
- * @see https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case
- *
- * @param value - The word to handle
- * @param index - The index of the word in the title
- * @param words - The full title as an array of words
- * @returns The formatted word
- */
-export declare function formatSpecialCases(value: string, index: number, words: string[], options?: FormatSpecialCasesOptions): string;

package/dist/index.d.ts

@@ -1,35 +0,0 @@
-/**
- * The string-format library used by Storm Software for building TypeScript applications.
- *
- * @remarks
- * A collection of helper functions used to manipulate string values
- *
- * @packageDocumentation
- */
-export * from "./acronyms";
-export * from "./articles";
-export * from "./camel-case";
-export * from "./combine";
-export * from "./conjunctions";
-export * from "./constant-case";
-export * from "./deburr";
-export * from "./decamelize";
-export * from "./escape";
-export * from "./format-special-cases";
-export * from "./get-words";
-export * from "./kebab-case";
-export * from "./lower-case-first";
-export * from "./normalize-email";
-export * from "./package";
-export * from "./pad";
-export * from "./pascal-case";
-export * from "./period-split";
-export * from "./prepositions";
-export * from "./pretty-bytes";
-export * from "./snake-case";
-export * from "./special-cases";
-export * from "./start-case";
-export * from "./strip-indents";
-export * from "./title-case";
-export * from "./unescape";
-export * from "./upper-case-first";

package/dist/lower-case-first.d.ts

@@ -1,10 +0,0 @@
-/**
- * Lower case the first character of an input string.
- *
- * @remarks
- * "tHISISANEXAMPLE"
- *
- * @param input - The input string.
- * @returns The lower-cased string.
- */
-export declare function lowerCaseFirst<T extends string | undefined>(input?: T): T;

package/dist/prepositions.d.ts

@@ -1 +0,0 @@
-export declare const PREPOSITIONS: string[];