@useflagly/sdk-javascript 0.1.1 → 0.2.0

package/README.md

@@ -1,63 +1,54 @@
 # @useflagly/sdk-javascript
 
-SDK JavaScript para interagir com as rotas expostas pelo `SystemModule` (FeatureFlag API).
+SDK JavaScript para a API de feature flags da Flagly.
 
 ## Instalação
 
-Configurar publicação/registro para o GitHub Packages (ex.: `useflagly`):
-
-.npmrc (no repositório ou no CI):
-
-```
-@useflagly:registry=https://npm.pkg.github.com
-//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
-```
-
-Para instalar em outro projeto (após publicar):
-
-```
+```bash
 npm install @useflagly/sdk-javascript
 ```
 
 ## Uso
 
 ```js
-import { SystemSDK } from '@featureflag/sdk-system';
+import { SystemSDK } from '@useflagly/sdk-javascript';
 
-const sdk = new SystemSDK({ baseUrl: 'https://api.example.com', token: process.env.API_TOKEN });
+const sdk = new SystemSDK({ token: 'seu-api-token' });
+// A URL padrão é https://api.useflagly.com.br — pode ser sobrescrita com { baseUrl: '...' }
 
 // Validar flag
-await sdk.validateFlag('my-flag-slug', { cpf: '00000000000', context: { userId: '123' } }, 'PRD');
+await sdk.validateFlag('minha-flag', { identifier: '00000000000' }, 'PRD');
 
 // Ler cache de flag
-await sdk.getFlagCache('my-flag-slug', '00000000000');
-
-// Inicializar (producer)
-await sdk.initializeFlags({ pattern: '...' });
-```
+await sdk.getFlagCache('minha-flag', '00000000000');
 
-## Métodos principais
+// Validar flow
+await sdk.validateFlow('meu-flow', { identifier: '00000000000' }, 'PRD');
 
-- `validateFlag(slug, body, environment?)`
-- `getFlagCache(slug, cpf?)`
-- `validateFlow(slug, body, environment?)`
-- `getFlowCache(slug, cpf?)`
-- `validateFlowPart(...)`
-- `getFlowPartCache(...)`
-- `validateScenario(...)`
-- `getScenarioCache(...)`
-- `initializeFlags(payload, environment?)`
-- `getResult(cpf)`
+// Validar flow-part
+await sdk.validateFlowPart('meu-flow-part', { identifier: '00000000000' }, 'PRD');
 
-## Publicação no GitHub Packages
+// Validar scenario
+await sdk.validateScenario('meu-scenario', { identifier: '00000000000' }, 'PRD');
 
-1. Crie um Personal Access Token com `write:packages` e `read:packages` (scope).
-2. Adicione o token como `GITHUB_TOKEN` no CI ou no `~/.npmrc` local.
-3. Ajuste `package.json` `name` e `repository.url` se necessário (já configurado para `useflagly`).
-4. Rodar:
+// Inicializar (producer)
+await sdk.initializeFlags({ identifier: '...', slug: '...', companyId: 1 });
 
-```bash
-npm publish --access=restricted
+// Buscar resultado
+await sdk.getResult('00000000000');
 ```
 
-> Observação: para pacotes sob escopo de organização, garanta que o registro do escopo está apontado para `https://npm.pkg.github.com` no `.npmrc`.
+## Métodos
+
+| Método | Descrição |
+|---|---|
+| `validateFlag(slug, body, environment?)` | Valida uma feature flag |
+| `getFlagCache(slug, identifier?)` | Lê o cache de uma flag |
+| `validateFlow(slug, body, environment?)` | Valida um flow |
+| `getFlowCache(slug, identifier?)` | Lê o cache de um flow |
+| `validateFlowPart(slug, body, environment?)` | Valida um flow-part |
+| `getFlowPartCache(slug, identifier?)` | Lê o cache de um flow-part |
+| `validateScenario(slug, body, environment?)` | Valida um scenario |
+| `getScenarioCache(slug, identifier?)` | Lê o cache de um scenario |
+| `initializeFlags(payload, environment?)` | Inicializa flags (producer) |
+| `getResult(identifier)` | Busca resultado por identifier |

package/dist/index.d.ts

@@ -9,14 +9,14 @@ export type ReceiveMessage = {
     context?: Record<string, any>;
 };
 export type SDKOptions = {
-    baseUrl: string;
+    baseUrl?: string;
     token?: string;
     timeoutMs?: number;
 };
 export declare class SystemSDK {
     private baseUrl;
     private token?;
-    constructor(opts: SDKOptions);
+    constructor(opts?: SDKOptions);
     private headers;
     private request;
     validateFlag(slug: string, body: ValidateBody, environment?: string): Promise<any>;

package/dist/index.js

@@ -5,9 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemSDK = void 0;
 const cross_fetch_1 = __importDefault(require("cross-fetch"));
+const DEFAULT_BASE_URL = 'https://api.useflagly.com.br';
 class SystemSDK {
-    constructor(opts) {
-        this.baseUrl = opts.baseUrl.replace(/\/+$/, '');
+    constructor(opts = {}) {
+        var _a;
+        this.baseUrl = ((_a = opts.baseUrl) !== null && _a !== void 0 ? _a : DEFAULT_BASE_URL).replace(/\/+$/, '');
         this.token = opts.token;
     }
     headers(env) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@useflagly/sdk-javascript",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "JavaScript SDK para SystemModule (FeatureFlag API)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",