Paquetes TypeScript Última 0.3.0
@vorluno/niiko-sdk
El cliente de TypeScript. Un método tipado por acción y por lectura, una unión Result con los desenlaces, cero dependencias.
Última actualización
- Entorno
- Node 18+
- Licencia
- Apache-2.0
- Código
- vorluno/niiko-sdk-typescript
- Registro
- www.npmjs.com/package/@vorluno/niiko-sdk
Instalar
npm install @vorluno/niiko-sdkUso
Un método por acción y por lectura, entrada y salida tipadas, y una unión Result<T> sobre la que bifurcas una vez — ReadResult<T> en las lecturas, con dos desenlaces. Pasa accessToken para leer. Cero dependencias: fetch viene con Node 18+.
npm install @vorluno/niiko-sdk
import { Niiko } from "@vorluno/niiko-sdk";
const niiko = new Niiko({ apiKey: process.env.NIIKO_API_KEY! });
// The second argument is the idempotency key: keep it if you retry.
const r = await niiko.createLead({
submissionId: "01890a5d-ac96-774b-bcce-b302099a8057",
source: "web_form",
}, crypto.randomUUID());
// Branch once on status: a refusal is a state, not an exception.
if (r.status === "done") console.log(r.output);
else if (r.status === "refused") console.error(r.reason, r.detail?.message);
else console.log("waiting for a human signature", r.proposalId);Dos permisos, no uno
Hacen falta las dos cosas: una llave con ese alcance, y que el dueño del workspace haya encendido el permiso. Tener la llave no basta — son dos decisiones de personas distintas.
Lo que no hace
- Validar tu entrada — lo hace el servidor, y su negativa viaja con nombre.
- Leer tablas — solo las lecturas declaradas, cada una con su contrato, y solo con un token OAuth.
- Reintentar por su cuenta — un reintento es una decisión sobre tu clave de idempotencia.
Versiones
Cada versión publicada en el registro, la más reciente primero, con el momento en que se pudo instalar. Cada una tiene su propia página.