@protocol-offair/gateway-sdk 0.1.1 → 0.1.2

package/README.md

@@ -1,151 +1,54 @@
-# AirPay Gateway SDK
+# OffAir Gateway SDK
 
-SDK TypeScript para integrar aplicações externas ao AirPay Gateway.
+OffAir Gateway SDK is the public TypeScript SDK for integrating external applications with OffAir Gateway.
 
-O pacote cobre o fluxo online do gateway:
+Portuguese version: [README.pt-BR.md](./README.pt-BR.md)
 
-- criação de payment intents em SOL;
-- consulta de intent;
-- registro de webhooks;
-- parsing de QR/link/copia-e-cola compatível com Solana Pay e AirPay;
-- verificação de assinatura HMAC dos webhooks;
-- cliente administrativo opcional para painéis internos.
-
-O SDK não implementa swap, stablecoins, custódia de saldo ou promessa de liquidação fiat.
-
-## Instalação local
+## Installation
 
 ```bash
 npm install @protocol-offair/gateway-sdk
 ```
 
-No monorepo AirPay, use o workspace:
-
-```bash
-npm --workspace @protocol-offair/gateway-sdk run build
-npm --workspace @protocol-offair/gateway-sdk run test
-```
+## Capabilities
 
-## Criar uma fatura SOL
+- Create Gateway payment intents.
+- Fetch payment intent status.
+- Register webhooks.
+- Verify signed webhook payloads.
+- Parse OffAir/Gateway payment links and Solana Pay-compatible codes.
+- Use merchant and admin clients from server-side applications.
 
-Use o cliente merchant apenas em backend ou ambiente server-side. Não exponha a `apiKey` no frontend público.
+## Basic Usage
 
 ```ts
 import { createAirPayGatewayClient } from "@protocol-offair/gateway-sdk";
 
-const airpay = createAirPayGatewayClient({
-  apiBaseUrl: process.env.AIRPAY_GATEWAY_API_BASE_URL!,
-  apiKey: process.env.AIRPAY_GATEWAY_API_KEY!,
+const gateway = createAirPayGatewayClient({
+  apiBaseUrl: process.env.OFFAIR_GATEWAY_API_BASE_URL!,
+  apiKey: process.env.OFFAIR_GATEWAY_API_KEY!,
 });
 
-const intent = await airpay.createPaymentIntent(
-  {
-    amount: "1.5",
-    currency: "SOL",
-    expiresInSeconds: 3600,
-    metadata: {
-      orderId: "order-123",
-      customerEmail: "cliente@example.com",
-    },
-  },
-  {
-    idempotencyKey: "order-123",
-  },
-);
-
-console.log(intent.intentId);
-console.log(intent.solanaPayUrl);
-console.log(intent.airpayUrl);
-```
-
-## Consultar status
-
-```ts
-const intent = await airpay.getPaymentIntent("pay_123");
-
-if (intent.status === "confirmed") {
-  // liberar pedido, atualizar checkout ou aguardar webhook settlement.completed
-}
-```
-
-## Registrar webhook
-
-```ts
-const webhook = await airpay.registerWebhook({
-  endpointUrl: "https://merchant.example/webhooks/airpay",
-  events: ["payment.confirmed", "payment.expired", "settlement.completed"],
-  secret: process.env.AIRPAY_GATEWAY_WEBHOOK_SECRET,
-});
-
-console.log(webhook.webhookId);
-```
-
-## Verificar assinatura de webhook
-
-O Gateway assina o corpo canônico com:
-
-```txt
-sha256 HMAC(secret, `${timestamp}.${body}`)
-```
-
-Headers:
-
-- `x-signature`
-- `x-timestamp`
-- `x-event-id`
-
-Exemplo com Express:
-
-```ts
-import { assertGatewayWebhookSignature } from "@protocol-offair/gateway-sdk";
-
-app.post("/webhooks/airpay", express.raw({ type: "application/json" }), async (req, res) => {
-  const event = await assertGatewayWebhookSignature({
-    payload: req.body.toString("utf8"),
-    headers: req.headers,
-    secret: process.env.AIRPAY_GATEWAY_WEBHOOK_SECRET!,
-  });
-
-  if (event.type === "payment.confirmed") {
-    await markOrderAsPaid(event.metadata.orderId, event.txHash);
-  }
-
-  res.status(204).send();
+const intent = await gateway.createPaymentIntent({
+  amount: "1.5",
+  currency: "SOL",
+  expiresInSeconds: 3600,
+  metadata: { orderId: "order-123" },
 });
-```
 
-## Ler QR Code ou copia-e-cola
-
-```ts
-import { parseAirPayGatewayPaymentCode } from "@protocol-offair/gateway-sdk";
-
-const request = parseAirPayGatewayPaymentCode(copiedOrScannedText);
-
-console.log(request.wallet);
-console.log(request.amount);
-console.log(request.reference);
-console.log(request.intentId);
+console.log(intent.intentId);
 ```
 
-## Cliente administrativo
+The exported function names still include legacy `AirPay` wording for API compatibility. New documentation should refer to the product as OffAir.
 
-Use apenas em painéis internos ou workers controlados.
+## Development
 
-```ts
-import { createAirPayGatewayAdminClient } from "@protocol-offair/gateway-sdk";
-
-const admin = createAirPayGatewayAdminClient({
-  apiBaseUrl: process.env.AIRPAY_GATEWAY_API_BASE_URL!,
-  adminKey: process.env.AIRPAY_GATEWAY_ADMIN_KEY!,
-});
-
-const overview = await admin.getOverview();
-const pending = await admin.listPaymentIntents({ status: "pending", limit: 50 });
+```bash
+npm install
+npm run build
+npm test
 ```
 
-## Limites intencionais
+## Security
 
-- Ativo suportado: `SOL`.
-- O SDK não cria carteiras nem assina transações pelo usuário.
-- O SDK não promete liquidação offline.
-- Chaves merchant/admin devem ficar no servidor do integrador.
+Use merchant API keys only in trusted server-side environments. Do not embed private API keys in public frontend code.

package/README.pt-BR.md

@@ -0,0 +1,54 @@
+# OffAir Gateway SDK
+
+OffAir Gateway SDK é o SDK TypeScript público para integrar aplicações externas ao OffAir Gateway.
+
+Versão em inglês: [README.md](./README.md)
+
+## Instalação
+
+```bash
+npm install @protocol-offair/gateway-sdk
+```
+
+## Funcionalidades
+
+- Criar payment intents do Gateway.
+- Consultar status de payment intents.
+- Registrar webhooks.
+- Verificar payloads assinados de webhook.
+- Interpretar links de pagamento OffAir/Gateway e códigos compatíveis com Solana Pay.
+- Usar clientes merchant e admin em aplicações server-side.
+
+## Uso Básico
+
+```ts
+import { createAirPayGatewayClient } from "@protocol-offair/gateway-sdk";
+
+const gateway = createAirPayGatewayClient({
+  apiBaseUrl: process.env.OFFAIR_GATEWAY_API_BASE_URL!,
+  apiKey: process.env.OFFAIR_GATEWAY_API_KEY!,
+});
+
+const intent = await gateway.createPaymentIntent({
+  amount: "1.5",
+  currency: "SOL",
+  expiresInSeconds: 3600,
+  metadata: { orderId: "order-123" },
+});
+
+console.log(intent.intentId);
+```
+
+Os nomes exportados ainda contêm `AirPay` por compatibilidade de API. A documentação nova deve tratar o produto como OffAir.
+
+## Desenvolvimento
+
+```bash
+npm install
+npm run build
+npm test
+```
+
+## Segurança
+
+Use API keys de merchant apenas em ambientes server-side confiáveis. Não embuta chaves privadas de API em frontend público.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protocol-offair/gateway-sdk",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "type": "module",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -30,6 +30,6 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/protocol-offair/airpay-gateway-sdk.git"
+    "url": "git+https://github.com/protocol-offair/offair-gateway-sdk.git"
   }
 }