@useflagly/sdk-javascript 0.1.1

package/README.md

@@ -0,0 +1,63 @@
+# @useflagly/sdk-javascript
+
+SDK JavaScript para interagir com as rotas expostas pelo `SystemModule` (FeatureFlag API).
+
+## 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):
+
+```
+npm install @useflagly/sdk-javascript
+```
+
+## Uso
+
+```js
+import { SystemSDK } from '@featureflag/sdk-system';
+
+const sdk = new SystemSDK({ baseUrl: 'https://api.example.com', token: process.env.API_TOKEN });
+
+// Validar flag
+await sdk.validateFlag('my-flag-slug', { cpf: '00000000000', context: { userId: '123' } }, 'PRD');
+
+// Ler cache de flag
+await sdk.getFlagCache('my-flag-slug', '00000000000');
+
+// Inicializar (producer)
+await sdk.initializeFlags({ pattern: '...' });
+```
+
+## Métodos principais
+
+- `validateFlag(slug, body, environment?)`
+- `getFlagCache(slug, cpf?)`
+- `validateFlow(slug, body, environment?)`
+- `getFlowCache(slug, cpf?)`
+- `validateFlowPart(...)`
+- `getFlowPartCache(...)`
+- `validateScenario(...)`
+- `getScenarioCache(...)`
+- `initializeFlags(payload, environment?)`
+- `getResult(cpf)`
+
+## Publicação no GitHub Packages
+
+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:
+
+```bash
+npm publish --access=restricted
+```
+
+> 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`.

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+export type ValidateBody = {
+    identifier?: string;
+    context?: Record<string, any>;
+};
+export type ReceiveMessage = {
+    identifier: string;
+    slug: string;
+    companyId?: number;
+    context?: Record<string, any>;
+};
+export type SDKOptions = {
+    baseUrl: string;
+    token?: string;
+    timeoutMs?: number;
+};
+export declare class SystemSDK {
+    private baseUrl;
+    private token?;
+    constructor(opts: SDKOptions);
+    private headers;
+    private request;
+    validateFlag(slug: string, body: ValidateBody, environment?: string): Promise<any>;
+    getFlagCache(slug: string, identifier?: string): Promise<any>;
+    validateFlow(slug: string, body: ValidateBody, environment?: string): Promise<any>;
+    getFlowCache(slug: string, identifier?: string): Promise<any>;
+    validateFlowPart(slug: string, body: ValidateBody, environment?: string): Promise<any>;
+    getFlowPartCache(slug: string, identifier?: string): Promise<any>;
+    validateScenario(slug: string, body: ValidateBody, environment?: string): Promise<any>;
+    getScenarioCache(slug: string, identifier?: string): Promise<any>;
+    initializeFlags(payload: ReceiveMessage, environment?: string): Promise<any>;
+    getResult(cpf: string): Promise<any>;
+}

package/dist/index.js

@@ -0,0 +1,80 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SystemSDK = void 0;
+const cross_fetch_1 = __importDefault(require("cross-fetch"));
+class SystemSDK {
+    constructor(opts) {
+        this.baseUrl = opts.baseUrl.replace(/\/+$/, '');
+        this.token = opts.token;
+    }
+    headers(env) {
+        const h = {
+            'content-type': 'application/json',
+        };
+        if (this.token)
+            h['authorization'] = `Bearer ${this.token}`;
+        if (env)
+            h['environment'] = env;
+        return h;
+    }
+    async request(path, method = 'GET', body, env) {
+        const res = await (0, cross_fetch_1.default)(this.baseUrl + path, {
+            method,
+            headers: this.headers(env),
+            body: body ? JSON.stringify(body) : undefined,
+        });
+        if (res.status === 204)
+            return null;
+        const text = await res.text();
+        try {
+            return JSON.parse(text);
+        }
+        catch {
+            return text;
+        }
+    }
+    // Flags
+    async validateFlag(slug, body, environment) {
+        return this.request(`/validate/flag/${encodeURIComponent(slug)}`, 'POST', body, environment);
+    }
+    async getFlagCache(slug, identifier) {
+        const q = identifier ? `?identifier=${encodeURIComponent(identifier)}` : '';
+        return this.request(`/validate/flag/${encodeURIComponent(slug)}${q}`, 'GET');
+    }
+    // Flow
+    async validateFlow(slug, body, environment) {
+        return this.request(`/validate/flow/${encodeURIComponent(slug)}`, 'POST', body, environment);
+    }
+    async getFlowCache(slug, identifier) {
+        const q = identifier ? `?identifier=${encodeURIComponent(identifier)}` : '';
+        return this.request(`/validate/flow/${encodeURIComponent(slug)}${q}`, 'GET');
+    }
+    // Flow part
+    async validateFlowPart(slug, body, environment) {
+        return this.request(`/validate/flow-part/${encodeURIComponent(slug)}`, 'POST', body, environment);
+    }
+    async getFlowPartCache(slug, identifier) {
+        const q = identifier ? `?identifier=${encodeURIComponent(identifier)}` : '';
+        return this.request(`/validate/flow-part/${encodeURIComponent(slug)}${q}`, 'GET');
+    }
+    // Scenario
+    async validateScenario(slug, body, environment) {
+        return this.request(`/validate/scenario/${encodeURIComponent(slug)}`, 'POST', body, environment);
+    }
+    async getScenarioCache(slug, identifier) {
+        const q = identifier ? `?identifier=${encodeURIComponent(identifier)}` : '';
+        return this.request(`/validate/scenario/${encodeURIComponent(slug)}${q}`, 'GET');
+    }
+    // Initialize (producer)
+    async initializeFlags(payload, environment) {
+        return this.request(`/validate/initialize`, 'POST', payload, environment);
+    }
+    // Result
+    async getResult(cpf) {
+        return this.request(`/validate/result/${encodeURIComponent(cpf)}`, 'GET');
+    }
+}
+exports.SystemSDK = SystemSDK;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@useflagly/sdk-javascript",
+  "version": "0.1.1",
+  "description": "JavaScript SDK para SystemModule (FeatureFlag API)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": ["dist"],
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "clean": "rm -rf dist",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/useflagly/backend.git"
+  },
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "cross-fetch": "^3.1.8"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}