@augment-vir/common 31.51.1 → 31.52.0

package/dist/augments/string/casing/capitalization.d.ts

@@ -1,12 +1,14 @@
-import { type CasingOptions } from './casing.js';
 /**
  * Capitalize the first letter of the input _only if_ the given options specifies doing so.
  *
+ * @deprecated Prefer `setFirstLetterCasing`.
  * @category String
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export declare function maybeCapitalize(input: string, casingOptions: Pick<CasingOptions, 'capitalizeFirstLetter'>): string;
+export declare function maybeCapitalize(input: string, casingOptions: {
+    capitalizeFirstLetter: boolean;
+}): string;
 /**
  * Capitalize the first letter of the input.
  *

package/dist/augments/string/casing/capitalization.js

@@ -1,6 +1,8 @@
+/* node:coverage disable */
 /**
  * Capitalize the first letter of the input _only if_ the given options specifies doing so.
  *
+ * @deprecated Prefer `setFirstLetterCasing`.
  * @category String
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)

package/dist/augments/string/casing/casing.d.ts

@@ -1,4 +1,15 @@
 import { type FirstLetterLowercase, type FirstLetterUppercase, type PartialWithUndefined } from '@augment-vir/core';
+/**
+ * The different string cases.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export declare enum StringCase {
+    Upper = "upper",
+    Lower = "lower"
+}
 /**
  * Options for casing functions in `@augment-vir/common`.
  *
@@ -10,9 +21,9 @@ export type CasingOptions = {
     /**
      * Capitalize the first letter of the string.
      *
-     * @default false
+     * @default StringCase.Lower
      */
-    capitalizeFirstLetter: boolean;
+    firstLetterCase: StringCase;
 };
 /**
  * Default options for {@link CasingOptions}.
@@ -22,17 +33,6 @@ export type CasingOptions = {
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
 export declare const defaultCasingOptions: Required<CasingOptions>;
-/**
- * The different string cases.
- *
- * @category String
- * @category Package : @augment-vir/common
- * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
- */
-export declare enum StringCase {
-    Upper = "upper",
-    Lower = "lower"
-}
 /**
  * Convert the first letter of a string to either lower or uppercase.
  *

package/dist/augments/string/casing/casing.js

@@ -1,13 +1,3 @@
-/**
- * Default options for {@link CasingOptions}.
- *
- * @category String
- * @category Package : @augment-vir/common
- * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
- */
-export const defaultCasingOptions = {
-    capitalizeFirstLetter: false,
-};
 /**
  * The different string cases.
  *
@@ -20,6 +10,16 @@ export var StringCase;
     StringCase["Upper"] = "upper";
     StringCase["Lower"] = "lower";
 })(StringCase || (StringCase = {}));
+/**
+ * Default options for {@link CasingOptions}.
+ *
+ * @category String
+ * @category Package : @augment-vir/common
+ * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
+ */
+export const defaultCasingOptions = {
+    firstLetterCase: StringCase.Lower,
+};
 /**
  * Set the first letter of the input to uppercase or lowercase.
  *

package/dist/augments/string/casing/kebab-and-camel.d.ts

@@ -1,3 +1,4 @@
+import { type PartialWithUndefined } from '@augment-vir/core';
 import { type CasingOptions } from './casing.js';
 /**
  * Converts a kebab-case string to CamelCase.
@@ -6,7 +7,7 @@ import { type CasingOptions } from './casing.js';
  * @category Package : @augment-vir/common
  * @package [`@augment-vir/common`](https://www.npmjs.com/package/@augment-vir/common)
  */
-export declare function kebabCaseToCamelCase(rawKebabCase: string, casingOptions?: Partial<CasingOptions> | undefined): string;
+export declare function kebabCaseToCamelCase(rawKebabCase: string, casingOptions?: PartialWithUndefined<CasingOptions> | undefined): string;
 /**
  * Converts a CamelCase string to kebab-case.
  *

package/dist/augments/string/casing/kebab-and-camel.js

@@ -1,6 +1,5 @@
 import { mergeDefinedProperties } from '../../object/merge-defined-properties.js';
-import { maybeCapitalize } from './capitalization.js';
-import { defaultCasingOptions, isCase, StringCase } from './casing.js';
+import { defaultCasingOptions, isCase, setFirstLetterCasing, StringCase, } from './casing.js';
 /**
  * Converts a kebab-case string to CamelCase.
  *
@@ -25,7 +24,8 @@ export function kebabCaseToCamelCase(rawKebabCase, casingOptions = {}) {
             return '';
         }
     });
-    return maybeCapitalize(camelCase, mergeDefinedProperties(defaultCasingOptions, casingOptions));
+    const options = mergeDefinedProperties(defaultCasingOptions, casingOptions);
+    return setFirstLetterCasing(camelCase, options.firstLetterCase);
 }
 /**
  * Converts a CamelCase string to kebab-case.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "31.51.1",
+    "version": "31.52.0",
     "description": "A collection of augments, helpers types, functions, and classes for any JavaScript environment.",
     "keywords": [
         "augment",
@@ -40,8 +40,8 @@
         "test:web": "virmator --no-deps test web"
     },
     "dependencies": {
-        "@augment-vir/assert": "^31.51.1",
-        "@augment-vir/core": "^31.51.1",
+        "@augment-vir/assert": "^31.52.0",
+        "@augment-vir/core": "^31.52.0",
         "@date-vir/duration": "^8.0.0",
         "ansi-styles": "^6.2.3",
         "deepcopy-esm": "^2.1.1",