sdk-sapi-promarketing 0.0.1

package/README.md

@@ -0,0 +1,110 @@
+# sdk-sapi2-promarketing
+
+Cliente TypeScript para consumir la API SAPI (skins, jugador, pagos, bonos, etc.). Se publica en npm como paquete dual **CommonJS + ESM** con tipos incluidos.
+
+## Requisitos
+
+- **Node.js** 18 o superior (`fetch` global).
+- Proyecto TypeScript recomendado (el paquete incluye `.d.ts`).
+
+## Instalación
+
+```bash
+npm install sdk-sapi2-promarketing
+```
+
+Con yarn o pnpm:
+
+```bash
+yarn add sdk-sapi2-promarketing
+pnpm add sdk-sapi2-promarketing
+```
+
+## Uso rápido
+
+La clase principal es **`SdkSAPI`**. Debes construir un objeto **`SdkSapiContext`** con la URL base, proxy, skin y callbacks que necesites.
+
+### ESM (`import`)
+
+```typescript
+import { SdkSAPI, type SdkSapiContext } from "sdk-sapi2-promarketing";
+
+const context: SdkSapiContext = {
+    url: "https://api.ejemplo.com",
+    proxy: "/api/proxy",
+    skin: "mi-skin",
+    skinContent: "contenido-skin",
+    onlyServer: false,
+    token: () => "Bearer-token-desde-tu-auth",
+    callback401: async () => {
+        // Renovar sesión o redirigir login
+    },
+};
+
+const client = new SdkSAPI(context);
+
+// Los métodos vienen de los servicios mezclados (p. ej. GameService, PlayerService).
+// Consulta el tipado de SdkSAPI en tu IDE o el código fuente de `services/`.
+```
+
+### CommonJS (`require`)
+
+```javascript
+const { SdkSAPI } = require("sdk-sapi2-promarketing");
+
+const client = new SdkSAPI({
+    url: "https://api.ejemplo.com",
+    proxy: "/api/proxy",
+    skin: "mi-skin",
+    skinContent: "contenido-skin",
+    onlyServer: false,
+});
+```
+
+### Tipos (interfaces)
+
+Los tipos de dominio se reexportan desde la raíz del paquete:
+
+```typescript
+import type { QueryType, PlayerType } from "sdk-sapi2-promarketing";
+```
+
+## Contexto (`SdkSapiContext`)
+
+| Campo | Descripción |
+|--------|-------------|
+| `url` | URL base del servicio (opcional según cómo montes el `fetch`). |
+| `proxy` | Prefijo o ruta proxy usada por las peticiones relativas. |
+| `skin` | Identificador de skin. |
+| `skinContent` | Identificador de contenido de skin. |
+| `onlyServer` | Si es `true`, las peticiones usan `url` directamente; si es `false` o se omite, usan la ruta relativa con `proxy`. |
+| `valueToken` / `token` | Token Bearer en caché y/o función que lo devuelve (requerida cuando el endpoint pide autenticación). |
+| `callback401` | Opcional: lógica ante respuesta 401. |
+
+Ajusta valores según el entorno (desarrollo / producción).
+
+## Desarrollo del paquete (mantenedores)
+
+Clonar el repositorio, instalar dependencias y compilar:
+
+```bash
+npm install
+npm run build
+```
+
+Simular el contenido que se publicará en npm:
+
+```bash
+npm pack --dry-run
+```
+
+La salida va a `dist/` (JS, MJS y declaraciones TypeScript).
+
+## Enlaces
+
+- **Repositorio:** [Bitbucket — skin2-sdk-sapi](https://bitbucket.org/promarketing/skin2-sdk-sapi)
+- **Issues:** ver `package.json` → `bugs.url`
+
+## Licencia
+
+`UNLICENSED` — uso restringido según política interna de Promarketing. Para términos exactos, consulta con el equipo legal o el propietario del paquete en npm.