Core Foundation SDK

> The Ultimate Foundation for Enterprise JavaScript/TypeScript Applications.
>
> Unifying Localization, Utilities, and Core Essentials into one robust, zero-config package.

---

🚀 Why Core Foundation?

Building enterprise apps requires a solid base. core-foundation-sdk provides that base with a focus on Developer Experience (DX) and Performance.

$3

* 🧙‍♂️ Magic "L" Object: Fully typed, Proxy-based localization. Just type L. and get autocomplete for your keys.
* 🤖 Auto-Generation: Missing a key? The SDK automatically creates it in your JSON files while you develop. No more manual copy-pasting.
* 🛡️ Smart Batching: Handling 500+ missing keys at once? No problem. Our smart queue prevents file corruption and race conditions.
* 📦 Zero-Config: Locales are bundled. It works out of the box.
* 🔄 Dynamic & Resilient: Use any language, anywhere. Fails safely.

---

📦 Installation

``bash
npm install core-foundation-sdk
`

---

⚡ Quick Start

$3

Call SDK.init() at the root of your application (e.g., index.ts or App.tsx).

`typescript
import { SDK } from 'core-foundation-sdk';

await SDK.init({
// 🌍 Set your default language
defaultLanguage: 'en',

// 🛠️ DEV MODE ONLY: Auto-generate missing keys!
// This will create 'locales/en.json' if it doesn't exist.
saveMissing: process.env.NODE_ENV === 'development',
});
`

$3

Stop using string keys like t('welcome_msg'). Use the L object.

`typescript
import { L } from 'core-foundation-sdk';

// ✅ Simple Usage (String Coercion)
console.log(L.btn_save); // Output: "Save"

// ✅ Interpolation (Function Call)
// Key: "welcome": "Welcome, {{name}}!"
console.log(L.welcome({ name: 'Ali' })); // Output: "Welcome, Ali!"

// ✅ React / JSX Support
export const MyComponent = () => (
{L.btn_submit}
);
`

$3

Change languages instantly. The SDK handles loading and caching.

`typescript
import { SDK } from 'core-foundation-sdk';

await SDK.changeLanguage('ur');
console.log(L.btn_save); // Output: "محفوظ کریں"
`

---

⚙️ Advanced Configuration

You can customize the SDK to fit your project structure.

`typescript
interface SDKConfig {
/* Default language on startup /
defaultLanguage: SupportedLanguage;

/* Enable auto-generation of missing keys (Dev mode recommended) /
saveMissing?: boolean;

/**
* Where to save missing keys?
* Default: 'locales' (project root)
*/
localesPath?: string;

/* Enable debug logs /
debug?: boolean;
}
`

$3

1. Set saveMissing: true.
2. Use a new key in your code: console.log(L.new_amazing_feature).
3. Check your terminal: [SDK] Batch Saved: Added 1 key to en.json.
4. Check locales/en.json: The key is there! 🪄

---

📂 Project Structure

Verified "Option A" flatten structure for simplicity:

`text
my-app/
├── locales/
│ ├── en.json # Master English Strings
│ ├── ur.json # Urdu Strings
│ └── es.json # Spanish (Auto-created if you switch to 'es')
├── src/
│ └── index.ts
└── package.json
`

---

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md` for details.

📄 License

MIT © [Your Organization]