shopeasy-sdk 1.0.0

package/README.md

@@ -0,0 +1,383 @@
+# ShopEasy SDK
+
+SDK oficial para integração com a API ShopEasy.
+
+## Instalação
+
+```bash
+npm install shopeasy-sdk
+```
+
+## Configuração
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({
+  secretKey: "sua-chave-secreta",
+  baseUrl: "https://api.shopeasy.site", // opcional
+});
+```
+
+---
+
+## `sdk.carts`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `draft.get` | `cardId: string` | `CartDraft | null` |
+| `draft.set` | `cartId: string, update: CartDraft` | `Cart` |
+| `draft.delete` | `cartId: string` | `void` |
+| `create` | `args: CreateCartArgs` | `Cart` |
+| `get` | `args: CartGetArgs` | `Cart | null` |
+| `getById` | `cartId: string` | `Cart | null` |
+| `getAllByGuild` | `guildId: string` | `Cart[]` |
+| `update` | `args: CartUpdateArgs` | `Cart` |
+| `expires` | `botClient: string` | `Cart[]` |
+| `count` | `guildId: string` | `number` |
+| `delete` | `cartId: string` | `void` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.carts.draft.get(/* args */);
+const result = await sdk.carts.draft.set(/* args */);
+const result = await sdk.carts.draft.delete(/* args */);
+```
+
+---
+
+## `sdk.catalogs`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `setDraft` | `args: CatalogDraftSetArgs` | `Catalog | null` |
+| `getDraft` | `args: CatalogDraftGetArgs` | `Catalog | null` |
+| `getByReference` | `reference: string, guildId: string` | `Catalog | null` |
+| `getById` | `id: string` | `Catalog | null` |
+| `create` | `args: CatalogCreateArgs` | `Catalog` |
+| `getByCaching` | `id: string` | `Catalog | null` |
+| `getAllByGuild` | `guildId: string` | `Array<Catalog>` |
+| `update` | `args: CatalogUpdateArgs` | `Catalog` |
+| `count` | `guildId: string` | `number` |
+| `delete` | `id: string` | `Catalog` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.catalogs.setDraft(/* args */);
+const result = await sdk.catalogs.getDraft(/* args */);
+const result = await sdk.catalogs.getByReference(/* args */);
+```
+
+---
+
+## `sdk.configss`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `getByGuild` | `guildId: string` | `Config` |
+| `setDraft` | `args: ConfigDraftSetArgs` | `Config | null` |
+| `delDraft` | `args: ConfigDraftGetArgs` | `Config | null` |
+| `getDraft` | `args: ConfigDraftGetArgs` | `Config | null` |
+| `update` | `args: ConfigUpdateArgs` | `Config` |
+| `getByCaching` | `_guildId: string` | `Config | null` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.configss.getByGuild(/* args */);
+const result = await sdk.configss.setDraft(/* args */);
+const result = await sdk.configss.delDraft(/* args */);
+```
+
+---
+
+## `sdk.coupons`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `setDraft` | `args: CouponDraftSetArgs` | `Coupon | null` |
+| `getDraft` | `args: CouponDraftGetArgs` | `Coupon | null` |
+| `existsByCode` | `code: string` | `boolean` |
+| `getById` | `id: string` | `Coupon | null` |
+| `create` | `args: CouponCreateArgs` | `Coupon` |
+| `getByCaching` | `id: string` | `Coupon | null` |
+| `getAllByGuild` | `guildId: string` | `Coupon[]` |
+| `update` | `args: CouponUpdateArgs` | `Coupon` |
+| `count` | `guildId: string` | `number` |
+| `delete` | `id: string` | `Coupon` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.coupons.setDraft(/* args */);
+const result = await sdk.coupons.getDraft(/* args */);
+const result = await sdk.coupons.existsByCode(/* args */);
+```
+
+---
+
+## `sdk.customers`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `setDraft` | `args: CustomerDraftSetArgs` | `Customer | null` |
+| `getDraft` | `args: CustomerDraftGetArgs` | `Customer | null` |
+| `existsByReference` | `_reference: string` | `boolean` |
+| `getById` | `id: string` | `Customer | null` |
+| `getByReference` | `_reference: string` | `Customer | null` |
+| `create` | `args: CustomerCreateArgs` | `Customer` |
+| `getByCaching` | `id: string` | `Customer | null` |
+| `getAllByGuild` | `guildId: string` | `Customer[]` |
+| `update` | `args: CustomerUpdateArgs` | `Customer` |
+| `count` | `guildId: string` | `number` |
+| `delete` | `id: string` | `Customer` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.customers.setDraft(/* args */);
+const result = await sdk.customers.getDraft(/* args */);
+const result = await sdk.customers.existsByReference(/* args */);
+```
+
+---
+
+## `sdk.images`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `getAll` | `guildId: string` | `Image[]` |
+| `create` | `args: imageCreate` | `Image` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.images.getAll(/* args */);
+const result = await sdk.images.create(/* args */);
+```
+
+---
+
+## `sdk.orders`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `create` | `args: OrderCreate` | `Order` |
+| `get` | `orderId: string` | `Order | null` |
+| `getPayment` | `orderId: string` | `OrderPayment | null` |
+| `getApprovedUnprocessed` | `botClient: string, guildId?: string` | `Order[]` |
+| `markAsReleased` | `id: string` | `Order` |
+| `aprove` | `id: string` | `Order` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.orders.create(/* args */);
+const result = await sdk.orders.get(/* args */);
+const result = await sdk.orders.getPayment(/* args */);
+```
+
+---
+
+## `sdk.paymentConfig`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `getOrCreate` | `guildId: string` | `PaymentConfig` |
+| `update` | `args: UpdatePaymentConfigArgs` | `PaymentConfig` |
+| `getByCaching` | `guildId: string` | `PaymentConfig | null` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.paymentConfig.getOrCreate(/* args */);
+const result = await sdk.paymentConfig.update(/* args */);
+const result = await sdk.paymentConfig.getByCaching(/* args */);
+```
+
+---
+
+## `sdk.planss`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `getByGuild` | `guildId: string` | `Plan | null` |
+| `havePlan` | `guildId: string` | `PlanType | null` |
+| `create` | `args: Plan` | `Plan` |
+| `getExpiring` | `days?: number` | `ExpiringPlan[]` |
+| `getExpired` | `—` | `ExpiredPlansResponse` |
+| `getPlansNeedingAlert` | `days?: number` | `PlansNeedingAlertResponse` |
+| `markAlertSent` | `guildId: string, daysUntilExpire: number` | `MarkAlertResponse` |
+| `checkExpirations` | `—` | `CheckExpirationsResponse` |
+| `getExpirationStatus` | `guildId: string` | `PlanStatus` |
+| `update` | `guildId: string, updates: Partial<Plan>` | `Plan` |
+| `delete` | `guildId: string` | `void` |
+| `createSubscription` | `args: PlanSubscriptionCreateArgs` | `EfiPixCreateResponse` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.planss.getByGuild(/* args */);
+const result = await sdk.planss.havePlan(/* args */);
+const result = await sdk.planss.create(/* args */);
+```
+
+---
+
+## `sdk.products`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `setDraft` | `args: ProduductDraftSetArgs` | `Product | null` |
+| `pushStock` | `{
+		product, amount, }: ProductStockPushArgs` | `string[]` |
+| `getDraft` | `args: ProduductDraftGetArgs` | `Product | null` |
+| `existsByReference` | `args: ProductGetByReference` | `Product | null` |
+| `getById` | `id: string` | `Product | null` |
+| `getByReference` | `reference: string, guildId: string` | `Product | null` |
+| `create` | `args: ProductCreateArgs` | `Product` |
+| `getByCaching` | `id: string` | `Product | null` |
+| `getAllByGuild` | `guildId: string` | `Array<Product>` |
+| `update` | `args: ProductUpdateArgs` | `Product` |
+| `count` | `guildId: string` | `number` |
+| `delete` | `id: string` | `void` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.products.setDraft(/* args */);
+const result = await sdk.products.pushStock(/* args */);
+const result = await sdk.products.getDraft(/* args */);
+```
+
+---
+
+## `sdk.sales`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `create` | `args: SaleCreateArgs` | `Sale` |
+| `getById` | `id: string` | `Sale | null` |
+| `getAllByGuild` | `guildId: string` | `Sale[]` |
+| `saleProductGet` | `id: string` | `SaleProduct | null` |
+| `delete` | `id: string` | `void` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.sales.create(/* args */);
+const result = await sdk.sales.getById(/* args */);
+const result = await sdk.sales.getAllByGuild(/* args */);
+```
+
+---
+
+## `sdk.tokens`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `listUnused` | `—` | `Token[] | null` |
+| `update` | `args: TokenUpdateArgs` | `Token` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.tokens.listUnused();
+const result = await sdk.tokens.update(/* args */);
+```
+
+---
+
+## `sdk.users`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `get` | `userId: string` | `User | null` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.users.get(/* args */);
+```
+
+---
+
+## `sdk.wallet`
+
+| Método | Parâmetros | Retorno |
+|--------|-----------|--------|
+| `getOrCreate` | `userId: string` | `Wallet` |
+| `getByUserId` | `userId: string` | `Wallet` |
+| `getByApiKey` | `apiKey: string` | `Wallet` |
+| `update` | `args: UpdateWalletArgs` | `Wallet` |
+| `getByCaching` | `userId: string` | `Wallet | null` |
+
+**Exemplo de uso:**
+
+```typescript
+import { ShopEasySdk } from "shopeasy-sdk";
+
+const sdk = new ShopEasySdk({ secretKey: "sua-chave" });
+
+const result = await sdk.wallet.getOrCreate(/* args */);
+const result = await sdk.wallet.getByUserId(/* args */);
+const result = await sdk.wallet.getByApiKey(/* args */);
+```
+
+---
+
+> Documentação gerada automaticamente em 11/03/2026.

package/dist/functions/api/config.cjs

@@ -0,0 +1,81 @@
+'use strict';
+
+const axios = require('axios');
+const http = require('node:http');
+const https = require('node:https');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const axios__default = /*#__PURE__*/_interopDefaultCompat(axios);
+const http__default = /*#__PURE__*/_interopDefaultCompat(http);
+const https__default = /*#__PURE__*/_interopDefaultCompat(https);
+
+class ApiError extends Error {
+  statusCode;
+  details;
+  constructor(statusCode, message, details) {
+    super(message);
+    this.name = "ApiError";
+    this.statusCode = statusCode;
+    this.details = details;
+    Error.captureStackTrace(this, this.constructor);
+  }
+}
+const httpAgent = new http__default.Agent({
+  keepAlive: true,
+  maxSockets: 100,
+  maxFreeSockets: 20,
+  timeout: 3e4
+});
+const httpsAgent = new https__default.Agent({
+  keepAlive: true,
+  maxSockets: 100,
+  maxFreeSockets: 20,
+  timeout: 3e4
+});
+const api = axios__default.create({
+  timeout: 1e4,
+  httpAgent,
+  httpsAgent,
+  headers: {
+    "Content-Type": "application/json"
+  }
+});
+api.interceptors.response.use(
+  (res) => res,
+  (err) => {
+    if (err.response) {
+      const data = err.response.data;
+      return Promise.reject(
+        new ApiError(
+          err.response.status,
+          data?.message ?? "Erro na API",
+          data?.errors ?? data
+        )
+      );
+    }
+    if (err.request) {
+      return Promise.reject(
+        new ApiError(503, "API indispon\xEDvel", {
+          url: err.config?.url,
+          method: err.config?.method,
+          timeout: err.config?.timeout
+        })
+      );
+    }
+    return Promise.reject(new ApiError(500, err.message));
+  }
+);
+function configureApi(baseUrl, secretKey) {
+  api.defaults.baseURL = baseUrl;
+  api.defaults.headers.common["Content-Type"] = "application/json";
+  if (secretKey) {
+    api.defaults.headers.common["Authorization"] = `Bearer ${secretKey}`;
+  } else {
+    delete api.defaults.headers.common["Authorization"];
+  }
+}
+
+exports.ApiError = ApiError;
+exports.api = api;
+exports.configureApi = configureApi;

package/dist/functions/api/config.mjs

@@ -0,0 +1,71 @@
+import axios from 'axios';
+import http from 'node:http';
+import https from 'node:https';
+
+class ApiError extends Error {
+  statusCode;
+  details;
+  constructor(statusCode, message, details) {
+    super(message);
+    this.name = "ApiError";
+    this.statusCode = statusCode;
+    this.details = details;
+    Error.captureStackTrace(this, this.constructor);
+  }
+}
+const httpAgent = new http.Agent({
+  keepAlive: true,
+  maxSockets: 100,
+  maxFreeSockets: 20,
+  timeout: 3e4
+});
+const httpsAgent = new https.Agent({
+  keepAlive: true,
+  maxSockets: 100,
+  maxFreeSockets: 20,
+  timeout: 3e4
+});
+const api = axios.create({
+  timeout: 1e4,
+  httpAgent,
+  httpsAgent,
+  headers: {
+    "Content-Type": "application/json"
+  }
+});
+api.interceptors.response.use(
+  (res) => res,
+  (err) => {
+    if (err.response) {
+      const data = err.response.data;
+      return Promise.reject(
+        new ApiError(
+          err.response.status,
+          data?.message ?? "Erro na API",
+          data?.errors ?? data
+        )
+      );
+    }
+    if (err.request) {
+      return Promise.reject(
+        new ApiError(503, "API indispon\xEDvel", {
+          url: err.config?.url,
+          method: err.config?.method,
+          timeout: err.config?.timeout
+        })
+      );
+    }
+    return Promise.reject(new ApiError(500, err.message));
+  }
+);
+function configureApi(baseUrl, secretKey) {
+  api.defaults.baseURL = baseUrl;
+  api.defaults.headers.common["Content-Type"] = "application/json";
+  if (secretKey) {
+    api.defaults.headers.common["Authorization"] = `Bearer ${secretKey}`;
+  } else {
+    delete api.defaults.headers.common["Authorization"];
+  }
+}
+
+export { ApiError, api, configureApi };

package/dist/functions/api/index.cjs

@@ -0,0 +1,35 @@
+'use strict';
+
+const carts_service = require('./services/carts.service.cjs');
+const catalog_service = require('./services/catalog.service.cjs');
+const configs_service = require('./services/configs.service.cjs');
+const coupons_service = require('./services/coupons.service.cjs');
+const customer_service = require('./services/customer.service.cjs');
+const images_service = require('./services/images.service.cjs');
+const orders_service = require('./services/orders.service.cjs');
+const payment_service = require('./services/payment.service.cjs');
+const plans_service = require('./services/plans.service.cjs');
+const products_service = require('./services/products.service.cjs');
+const sales_service = require('./services/sales.service.cjs');
+const token_service = require('./services/token.service.cjs');
+const users_service = require('./services/users.service.cjs');
+const wallet_service = require('./services/wallet.service.cjs');
+
+const db = {
+  products: products_service,
+  images: images_service,
+  configs: configs_service,
+  plans: plans_service,
+  coupon: coupons_service,
+  carts: carts_service,
+  customers: customer_service,
+  catalogs: catalog_service,
+  payment: payment_service,
+  sales: sales_service,
+  wallet: wallet_service,
+  orders: orders_service,
+  tokens: token_service,
+  users: users_service
+};
+
+exports.db = db;

package/dist/functions/api/index.mjs

@@ -0,0 +1,33 @@
+import cartService from './services/carts.service.mjs';
+import CatalogService from './services/catalog.service.mjs';
+import ConfigsService from './services/configs.service.mjs';
+import CouponService from './services/coupons.service.mjs';
+import CustomerService from './services/customer.service.mjs';
+import ImageService from './services/images.service.mjs';
+import ordersService from './services/orders.service.mjs';
+import PaymentService from './services/payment.service.mjs';
+import PlanService from './services/plans.service.mjs';
+import ProductService from './services/products.service.mjs';
+import SaleService from './services/sales.service.mjs';
+import tokenService from './services/token.service.mjs';
+import usersService from './services/users.service.mjs';
+import walletService from './services/wallet.service.mjs';
+
+const db = {
+  products: ProductService,
+  images: ImageService,
+  configs: ConfigsService,
+  plans: PlanService,
+  coupon: CouponService,
+  carts: cartService,
+  customers: CustomerService,
+  catalogs: CatalogService,
+  payment: PaymentService,
+  sales: SaleService,
+  wallet: walletService,
+  orders: ordersService,
+  tokens: tokenService,
+  users: usersService
+};
+
+export { db };

package/dist/functions/api/services/carts.service.cjs

@@ -0,0 +1,64 @@
+'use strict';
+
+const config = require('../config.cjs');
+
+class cartService {
+  draft = {
+    get: async (cardId) => {
+      const { data } = await config.api.get(`/carts/draft/${cardId}`);
+      return data;
+    },
+    set: async ({
+      cartId,
+      update
+    }) => {
+      const { data } = await config.api.patch(`/carts/draft/${cartId}`, update);
+      return data;
+    },
+    delete: async (cartId) => {
+      await config.api.request({
+        method: "DELETE",
+        url: `/carts/draft/${cartId}`,
+        data: {}
+      });
+      return;
+    }
+  };
+  async create(args) {
+    const { data } = await config.api.post("/carts", args);
+    return data;
+  }
+  async get(args) {
+    const { data } = await config.api.get(
+      `/carts/by-userid/${args.guildId}/${args.userId}`
+    );
+    return data;
+  }
+  async getById(cartId) {
+    const { data } = await config.api.get(`/carts/${cartId}`);
+    return data;
+  }
+  async getAllByGuild(guildId) {
+    const { data } = await config.api.get(`/carts/by-guild/${guildId}`);
+    return data.data ?? data;
+  }
+  async update(args) {
+    const { data } = await config.api.patch(`/carts/${args.id}`, args.data);
+    return data;
+  }
+  async expires(botClient) {
+    const { data } = await config.api.get(`/carts/expires/${botClient}`);
+    return data;
+  }
+  async count(guildId) {
+    const { data } = await config.api.get(`/carts/count/${guildId}`);
+    return data ?? 0;
+  }
+  async delete(cartId) {
+    await config.api.request({ method: "DELETE", url: `/carts/${cartId}`, data: {} });
+    return;
+  }
+}
+const cartService$1 = new cartService();
+
+module.exports = cartService$1;