Togglr SDK

SDK JavaScript para Togglr - Feature Flags para Desenvolvedores Brasileiros.

🚀 Instalação

npm install @Togglr/sdk
# ou
yarn add @Togglr/sdk
# ou
pnpm add @Togglr/sdk

📖 Quick Start

import { Togglr } from "@Togglr/sdk";

// Inicializa
const flags = Togglr.init({
  apiKey: "pk_your_api_key_here",
  apiUrl: "https://api.Togglr.com.br", // Opcional
});

// Verifica flag
const enabled = await flags.check("nova-feature");

if (enabled) {
  // Nova versão
} else {
  // Versão antiga
}

🎯 Uso com Next.js

'use client'
import { Togglr } from '@Togglr/sdk'
import { useEffect, useState } from 'react'

export default function Page() {
  const [enabled, setEnabled] = useState(false)

  useEffect(() => {
    const flags = Togglr.init({ apiKey: 'pk_...' })
    flags.check('nova-feature').then(setEnabled)
  }, [])

  return enabled ? <NovaVersao /> : <VersaoAntiga />
}

📚 API

Togglr.init(config)

Inicializa o SDK.

Parâmetros:

• apiKey (string, obrigatório): Sua API key do projeto
• apiUrl (string, opcional): URL da API (default: produção)
• userId (string, opcional): ID do usuário padrão

Retorna: Instância do Togglr

flags.check(flagKey, userId?)

Verifica se uma flag está habilitada.

Parâmetros:

• flagKey (string): Nome da flag
• userId (string, opcional): ID do usuário específico

Retorna: Promise<boolean>

🔒 Cache

O SDK cacheia flags por 5 minutos para melhor performance. Se a API estiver indisponível, retorna o último valor conhecido.

📝 Licença

MIT

🇧🇷 Suporte

• Docs: https://Togglr.com/docs
• Email: [email protected]
• GitHub: https://github.com/seuusuario/Togglr-sdk/issues

---

### **3. Cria `.npmignore`**

**Arquivo: `Togglr-sdk/.npmignore`**

src/ tsconfig.json node_modules/ .git/ .env *.log

**Publica só o `dist/`, não o código fonte.**

---

### **4. Cria `LICENSE`**

**Arquivo: `Togglr-sdk/LICENSE`**

MIT License

Copyright (c) 2024 Seu Nome

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.