sdk-sapi-promarketingcl
v0.1.4
Published
TypeScript SDK client for SAPI
Downloads
360
Maintainers
Readme
sdk-sapi-promarketingcl
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 (
fetchglobal). - Proyecto TypeScript recomendado (el paquete incluye
.d.ts).
Instalación
npm install sdk-sapi-promarketingclCon yarn o pnpm:
yarn add sdk-sapi-promarketingcl
pnpm add sdk-sapi-promarketingclUso rápido
La clase principal es SdkSAPI (export default). Debes construir un objeto SdkSapiContext con la URL base, proxy, skin y callbacks que necesites.
ESM (import)
import SdkSAPI, { type SdkSapiContext } from "sdk-sapi-promarketingcl";
const context: SdkSapiContext = {
url: "https://api.ejemplo.com",
proxy: "/api/proxy",
skin: "mi-skin",
skinContent: "contenido-skin",
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)
const SdkSAPI = require("sdk-sapi-promarketingcl").default;
const client = new SdkSAPI({
url: "https://api.ejemplo.com",
proxy: "/api/proxy",
skin: "mi-skin",
skinContent: "contenido-skin",
});Tipos (interfaces)
Los tipos de dominio se reexportan desde la raíz del paquete:
import type { QueryType, PlayerType } from "sdk-sapi-promarketingcl";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. |
| valueToken / token | Token Bearer y/o función que lo devuelve. |
| 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:
npm install
npm run buildLa salida va a dist/ (JS, MJS y declaraciones TypeScript).
Enlaces
- Repositorio: Bitbucket — 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.
