Merge pull request #52 from lemoncloud-io/feature/louis-update-case

feat(storage): support camelCase and snake_case keys

Author: louis-lemon

src/token-storage/aws-storage.service.ts

@@ -26,10 +26,17 @@ export class AWSStorageService extends TokenStorageService {
     ];
 
     /**
-     * Gets the storage key (always snake_case).
+     * Gets whether to use snake_case based on configuration.
+     */
+    private get useSnakeCase(): boolean {
+        return this.config.defaultCaseStyle !== 'camelCase';
+    }
+
+    /**
+     * Gets the storage key in the configured default case style.
      */
     private getKey(key: string): string {
-        return getStorageKey(this.prefix, key);
+        return getStorageKey(this.prefix, key, this.useSnakeCase);
     }
 
     /**
@@ -40,21 +47,29 @@ export class AWSStorageService extends TokenStorageService {
     }
 
     /**
-     * Migrates camelCase keys to snake_case if needed.
+     * Migrates keys to the configured default case style if needed.
      */
     private async migrateKey(key: string): Promise<void> {
         const { snakeKey, camelKey } = getStorageKeyVariants(this.prefix, key);
         const snakeValue = await this.storage.getItem(snakeKey);
         const camelValue = await this.storage.getItem(camelKey);
 
-        // If both exist, prefer snake_case and remove camelCase
-        if (snakeValue && camelValue) {
-            await this.storage.removeItem(camelKey);
-        }
-        // If only camelCase exists, migrate it to snake_case
-        else if (!snakeValue && camelValue) {
-            await this.storage.setItem(snakeKey, camelValue);
-            await this.storage.removeItem(camelKey);
+        if (this.useSnakeCase) {
+            // Prefer snake_case: migrate camelCase to snake_case if needed
+            if (snakeValue && camelValue) {
+                await this.storage.removeItem(camelKey);
+            } else if (!snakeValue && camelValue) {
+                await this.storage.setItem(snakeKey, camelValue);
+                await this.storage.removeItem(camelKey);
+            }
+        } else {
+            // Prefer camelCase: migrate snake_case to camelCase if needed
+            if (snakeValue && camelValue) {
+                await this.storage.removeItem(snakeKey);
+            } else if (snakeValue && !camelValue) {
+                await this.storage.setItem(camelKey, snakeValue);
+                await this.storage.removeItem(snakeKey);
+            }
         }
     }
 

src/token-storage/azure-storage.service.ts

@@ -22,10 +22,17 @@ export class AzureStorageService extends TokenStorageService {
     ];
 
     /**
-     * Gets the storage key (always snake_case).
+     * Gets whether to use snake_case based on configuration.
+     */
+    private get useSnakeCase(): boolean {
+        return this.config.defaultCaseStyle !== 'camelCase';
+    }
+
+    /**
+     * Gets the storage key in the configured default case style.
      */
     private getKey(key: string): string {
-        return getStorageKey(this.prefix, key);
+        return getStorageKey(this.prefix, key, this.useSnakeCase);
     }
 
     /**
@@ -36,21 +43,29 @@ export class AzureStorageService extends TokenStorageService {
     }
 
     /**
-     * Migrates camelCase keys to snake_case if needed.
+     * Migrates keys to the configured default case style if needed.
      */
     private async migrateKey(key: string): Promise<void> {
         const { snakeKey, camelKey } = getStorageKeyVariants(this.prefix, key);
         const snakeValue = await this.storage.getItem(snakeKey);
         const camelValue = await this.storage.getItem(camelKey);
 
-        // If both exist, prefer snake_case and remove camelCase
-        if (snakeValue && camelValue) {
-            await this.storage.removeItem(camelKey);
-        }
-        // If only camelCase exists, migrate it to snake_case
-        else if (!snakeValue && camelValue) {
-            await this.storage.setItem(snakeKey, camelValue);
-            await this.storage.removeItem(camelKey);
+        if (this.useSnakeCase) {
+            // Prefer snake_case: migrate camelCase to snake_case if needed
+            if (snakeValue && camelValue) {
+                await this.storage.removeItem(camelKey);
+            } else if (!snakeValue && camelValue) {
+                await this.storage.setItem(snakeKey, camelValue);
+                await this.storage.removeItem(camelKey);
+            }
+        } else {
+            // Prefer camelCase: migrate snake_case to camelCase if needed
+            if (snakeValue && camelValue) {
+                await this.storage.removeItem(snakeKey);
+            } else if (snakeValue && !camelValue) {
+                await this.storage.setItem(camelKey, snakeValue);
+                await this.storage.removeItem(snakeKey);
+            }
         }
     }
 

src/types/core.ts

@@ -56,6 +56,11 @@ export type WebCoreServiceMap = {
  */
 export type CloudProvider = keyof WebCoreServiceMap;
 
+/**
+ * Type representing the case style for localStorage keys.
+ */
+export type CaseStyle = 'snake_case' | 'camelCase';
+
 /**
  * Type representing the configuration for the web core.
  * @template T - The cloud provider type.
@@ -66,6 +71,13 @@ export type WebCoreConfig<T extends CloudProvider> = {
     oAuthEndpoint: string;
     region?: string;
     storage?: Storage;
+    /**
+     * Default case style for new localStorage keys.
+     * - 'snake_case': Use snake_case format (e.g., access_key_id)
+     * - 'camelCase': Use camelCase format (e.g., accessKeyId)
+     * @default 'snake_case'
+     */
+    defaultCaseStyle?: CaseStyle;
 };
 
 /**

src/utils/utils.ts

@@ -75,9 +75,9 @@ export const convertSnakeCaseFromCamel = (key: string) => {
     return key.replace(/[A-Z]/g, letter => `_${letter.toLowerCase()}`);
 };
 
-export const getStorageKey = (prefix: string, key: string) => {
-    // Always use snake_case for new storage keys
-    return `${prefix}.${key}`;
+export const getStorageKey = (prefix: string, key: string, useSnakeCase: boolean = true) => {
+    const storageKey = useSnakeCase ? key : convertCamelCaseFromSnake(key);
+    return `${prefix}.${storageKey}`;
 };
 
 export const getStorageKeyVariants = (prefix: string, key: string) => {