@zennify/sdk-js 1.0.0-beta.1 → 1.0.0-beta.11

package/.github/workflows/npm-publish-package.yml

@@ -32,4 +32,4 @@ jobs:
       - run: npm run build
       - run: npm publish --access public --tag beta
         env:
-          NPM_TOKEN: ${{secrets.NPM_TOKEN}}
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/dist/RequestError.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZennifyAPIRequestError = void 0;
+const pt_BR_json_1 = __importDefault(require("../translations/pt_BR.json"));
+const en_US_json_1 = __importDefault(require("../translations/en_US.json"));
+const var_1 = require("./var");
+const errors_translations = { pt_BR: pt_BR_json_1.default, en_US: en_US_json_1.default };
+const match_regex = /{[\w.]+}/g;
+const replacer = (body, value) => {
+    return body[value.slice(1, -1)];
+};
+class ZennifyAPIRequestError extends Error {
+    status = 0;
+    code = 0;
+    body;
+    constructor(response, body) {
+        super();
+        this.body = body;
+        this.status = response.status;
+        if (this.status === 403) {
+            this.name = "Usuário inválido";
+            this.message = "Por favor, se re-autentique";
+        }
+        if (this.status === 503) {
+            this.name = "API em atualização.";
+            this.message = "Por favor, tente novamente em alguns minutos.";
+        }
+        if (this.status === 429) {
+            this.name = "Calma ai!";
+            this.message = "Suas ações estão sendo limitadas!";
+        }
+        const error = errors_translations[var_1.ZENNIFY_API_RESPONSE_LANGUAGE][body.code] ||
+            errors_translations[var_1.ZENNIFY_API_RESPONSE_LANGUAGE]["UNKNOWN_TRANSLATION"];
+        this.name = error.name
+            .replace(match_regex, (value) => replacer(body, value));
+        this.message = error.message
+            .replace(match_regex, (value) => replacer(body, value));
+    }
+}
+exports.ZennifyAPIRequestError = ZennifyAPIRequestError;

package/dist/errors.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Media.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Panels.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/interfaces/Products.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/main.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./var"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./RequestError"), exports);
+__exportStar(require("./interfaces/Media"), exports);
+__exportStar(require("./interfaces/Panels"), exports);
+__exportStar(require("./interfaces/Products"), exports);

package/dist/utils.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetResponseError = GetResponseError;
+exports.TreatZennifyResponse = TreatZennifyResponse;
+const RequestError_1 = require("./RequestError");
+function GetResponseError(code, additional = {}) {
+    return { code, ...additional };
+}
+async function TreatZennifyResponse(response) {
+    const body = await response.json().catch(() => ({}));
+    if (response.ok) {
+        return body;
+    }
+    throw new RequestError_1.ZennifyAPIRequestError(response, body);
+}

package/dist/var.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZENNIFY_API_RESPONSE_LANGUAGE = void 0;
+exports.SetAPIResponseLanguage = SetAPIResponseLanguage;
+exports.ZENNIFY_API_RESPONSE_LANGUAGE = 'en_US';
+function SetAPIResponseLanguage(lang) {
+    return exports.ZENNIFY_API_RESPONSE_LANGUAGE = lang;
+}

package/package.json

@@ -1,14 +1,18 @@
 {
   "name": "@zennify/sdk-js",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.11",
   "description": "A simple package to work with https://api.zennify.app",
   "main": "dist/main.js",
   "keywords": [],
   "author": "josejooj",
   "license": "ISC",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
   "repository": {
     "url": "git+https://github.com/zennify-ofc/sdk-js.git"
   },
+  "types": "./types/main.d.ts",
   "devDependencies": {
     "@types/node": "^20.12.12",
     "typescript": "^5.5.3"

package/src/RequestError.ts

@@ -1,6 +1,7 @@
 import pt_BR from '../translations/pt_BR.json';
 import en_US from '../translations/en_US.json';
 import { ZENNIFY_API_RESPONSE_LANGUAGE } from './var';
+import { APIErrors } from './errors';
 
 const errors_translations = { pt_BR, en_US };
 const match_regex = /{[\w.]+}/g;
@@ -9,7 +10,7 @@ const replacer = (body: any, value: string) => {
 }
 
 type Body = Record<string, any> & {
-    code: number
+    code: APIErrors
 }
 
 export class ZennifyAPIRequestError extends Error {
@@ -41,8 +42,8 @@ export class ZennifyAPIRequestError extends Error {
         }
 
         const error: { name: string, message: string } =
-            errors_translations[ZENNIFY_API_RESPONSE_LANGUAGE][body.code as 0] ||
-            errors_translations[ZENNIFY_API_RESPONSE_LANGUAGE]["1"];
+            errors_translations[ZENNIFY_API_RESPONSE_LANGUAGE][body.code] ||
+            errors_translations[ZENNIFY_API_RESPONSE_LANGUAGE]["UNKNOWN_TRANSLATION"];
 
         this.name = error.name
             .replace(match_regex, (value) => replacer(body, value));

package/src/errors.ts

@@ -1,108 +1,101 @@
-export enum APIErrors {
-    UNKNOWN_ERROR = 0,
-    UNKNOWN_TRANSLATION = 1,
-    METHOD_NOT_ALLOWED = 2,
-    EXPECTED_AN_OBJECT_ARRAY = 3,
-    EXPECTED_A_STRING_ARRAY = 4,
-    EXPECTED_A_NUMBER_ARRAY = 5,
-    EXPECTED_AN_OBJECT = 6,
-    EXPECTED_A_NON_EMPTY_OBJECT = 7,
-    EXPECTED_A_STRING = 8,
-    EXPECTED_A_NUMBER = 9,
-    DUPLICATED_VALUES_ISNT_ALLOWED = 10,
-    // 1000-1100 = oAuth errors
-    GRANT_CODE_MISSING_IN_QUERY = 1000,
-    INVALID_SCOPE = 1001,
-    VERIFY_YOUR_EMAIL = 1002,
-    PLEASE_REVERIFY = 1003,
-    // 1500-2000 = user errors
-    USER_NOT_FOUND = 1500,
-    // 1501 - 1510
-    // password errors
-    INSERT_A_VALID_PASSWORD = 1501,
-    YOU_MUST_INSERT_THE_ACTUAL_PASSWORD = 1502,
-    THE_PASSWORD_DOES_NOT_MATCH = 1503,
-    THE_PASSWORD_MUST_HAVE_AT_LEAST_8_CHARACTERS = 1504,
-    THE_PASSWORD_MUST_HAVE_AT_LEAST_ONE_NUMBER = 1505,
-    THE_PASSWORD_MUST_HAVE_AT_LEAST_ONE_LETTER = 1506,
-    THE_PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER = 1507,
-    // 1511 - 1520
-    // pix key errors
-    THE_PIX_KEY_SENDED_ISNT_A_VALID_STRING = 1511,
-    THE_EMAIL_SENDED_ISNT_VALID = 1512,
-    CELLPHONE_NUMBERS_MUST_HAVE_THE_9_DIGIT = 1513,
-    THE_CELLPHONE_NUMBER_MUST_HAVE_ONLY_DIGITS = 1514,
-    THE_PIX_KEY_INSERTED_ISNT_VALID = 1515,
-    // 1521 - 1530
-    // webhook url error
-    INSERT_A_VALID_URL = 1521,
-    THE_ONLY_ACCEPTED_PROTOCOL_IS_HTTPS = 1522,
-    THIS_DOMAIN_IS_BLACKLISTED = 1523,
-    THE_URL_EXTENSION_ISNT_ACCEPTED_YET = 1524,
-    THE_URL_IS_INACCESSIBLE_BY_THE_WEBHOOK_SERVER = 1525,
-    THE_URL_WOULD_NOT_HAVE_REDIRECTS = 1526,
-    THE_URL_HAS_TIMEOUT_5S = 1527,
-    // 2000-3000 = payment errors
-    INVALID_PAYMENT_METHOD = 2000,
-    // 2200-2500
+export type APIErrors =
+    // = general errors
+    | 'UNKNOWN_ERROR'
+    | 'UNKNOWN_TRANSLATION'
+    | 'METHOD_NOT_ALLOWED'
+    | 'EXPECTED_AN_OBJECT_ARRAY'
+    | 'EXPECTED_A_STRING_ARRAY'
+    | 'EXPECTED_A_NUMBER_ARRAY'
+    | 'EXPECTED_AN_OBJECT'
+    | 'EXPECTED_A_NON_EMPTY_OBJECT'
+    | 'EXPECTED_A_STRING'
+    | 'EXPECTED_A_NUMBER'
+    | 'EXPECTED_A_VALID_ID'
+    | 'DUPLICATED_VALUES_ISNT_ALLOWED'
+    // = oAuth errors
+    | 'GRANT_CODE_MISSING_IN_QUERY'
+    | 'INVALID_SCOPE'
+    | 'VERIFY_YOUR_EMAIL'
+    | 'PLEASE_REVERIFY'
+    // = user errors
+    | 'USER_NOT_FOUND'
+    /// password errors
+    | 'INVALID_PASSWORD'
+    | 'YOU_MUST_INSERT_THE_ACTUAL_PASSWORD'
+    | 'THE_PASSWORD_DOES_NOT_MATCH'
+    | 'THE_PASSWORD_MUST_HAVE_AT_LEAST_8_CHARACTERS'
+    | 'THE_PASSWORD_MUST_HAVE_AT_LEAST_ONE_NUMBER'
+    | 'THE_PASSWORD_MUST_HAVE_AT_LEAST_ONE_LETTER'
+    | 'THE_PASSWORD_MUST_HAVE_AT_LEAST_ONE_SPECIAL_CHARACTER'
+    /// pix key errors
+    | 'THE_EMAIL_SENDED_ISNT_VALID'
+    | 'CELLPHONE_NUMBERS_MUST_HAVE_THE_9_DIGIT'
+    | 'THE_CELLPHONE_NUMBER_MUST_HAVE_ONLY_DIGITS'
+    | 'THE_PIX_KEY_INSERTED_ISNT_VALID'
+    /// webhook url error
+    | 'INSERT_A_VALID_URL'
+    | 'THE_ONLY_ACCEPTED_PROTOCOL_IS_HTTPS'
+    | 'THIS_DOMAIN_IS_BLACKLISTED'
+    | 'THE_URL_EXTENSION_ISNT_ACCEPTED_YET'
+    | 'THE_URL_IS_INACCESSIBLE_BY_THE_WEBHOOK_SERVER'
+    | 'THE_URL_WOULD_NOT_HAVE_REDIRECTS'
+    | 'THE_URL_HAS_TIMEOUT_5S'
+    /// payment errors
+    | 'INVALID_PAYMENT_METHOD'
     // Order Errors
-    YOU_NEED_TO_INSERT_AT_LEAST_1_ITEM = 2200,
-    ONE_PROVIDED_PRODUCT_IS_OUT_OF_STOCK = 2201,
-    WE_DONT_HAVE_THIS_AMOUNT_IN_STOCK = 2202,
-    THIS_SELLER_WAS_BANNED_FROM_ZENNIFY = 2203,
-    WE_DO_NOT_YET_SUPPORT_MULTIPLE_USER_PRODUCTS = 2204,
-    WE_DO_NOT_YET_SUPPORT_MULTIPLE_STORE_PRODUCTS = 2205,
-    YOU_ALREADY_HAVE_ANOTHER_ORDER_WAITING_PAYMENT = 2206,
-    YOU_INSERTED_AN_INVALID_ADDITIONAL = 2207,
-    // 2211 - 2250
-    // subtype
-    // bad preference configuration
-    THIS_SELLER_HAS_NOT_YET_CONFIGURED_RECEIPT_VIA_PIX = 2211,
-    THIS_SELLER_HAS_NOT_YET_CONFIGURED_RECEIPT_VIA_BOLETO = 2212,
-    THIS_SELLER_HAS_NOT_YET_CONFIGURED_RECEIPT_VIA_CRYPTO = 2213,
-    // 2251 - 2275
-    // subtype
-    // coupons
-    THIS_COUPON_DOES_NOT_EXISTS = 2251,
-    THIS_COUPON_HAS_EXPIRED = 2252,
-    THIS_COUPON_REACHED_THE_USE_LIMIT = 2253,
-    YOU_NEED_TO_SELECT_MORE_ITENS_DO_REACH_THE_MINIMUM_VALUE_OF_THE_COUPON = 2254,
-    THIS_COUPON_IS_VALID_ONLY_FOR_THE_FIRST_BUY = 2255,
-    // 2500 - 2600 = store errors
-    UNKNOWN_STORE = 2500,
-    UNKNOWN_BANK = 2501,
-    INVALID_STORE_NAME = 2502,
-    // 2600 - 3000 = product errors
-    UNKNOWN_PRODUCT = 2600,
-    INVALID_PRODUCT_NAME = 2601,
-    INVALID_PRODUCT_VALUE = 2602,
-    YOU_REACHED_THE_PRODUCT_LIMIT = 2603,
-    YOU_ALREADY_HAVE_ANOTHER_PRODUCT_WITH_THIS_NAME = 2604,
-    // 2605 - 2610
-    // Description errors
-    INVALID_DISCORD_DESCRIPTION = 2605,
-    // 2611 - 2650
-    // Stock errors
-    INVALID_STOCK_ID = 2611,
-    UNKNOWN_STOCK = 2612,
-    INVALID_STOCK_CONTENT = 2613,
-    INVALID_STOCK_COST = 2614,
-    // 3001 - 3100 = Media Errors
-    UNKNOWN_FILE = 3001,
-    NO_FILES_FOUND = 3002,
-    INVALID_FILE_TYPE = 3003,
-    INVALID_FILE_NAME = 3004,
-    INVALID_FILE_SIZE = 3005,
-    YOU_REACHED_THE_MAXIMUM_STORAGE = 3006,
-    YOU_REACHED_THE_MAXIMUM_MEDIA_COUNT = 3007,
-    YOU_ALREADY_HAVE_THIS_IMAGE_ON_ZENNIFY = 3008,
-    YOU_ALREADY_HAVE_ANOTHER_IMAGE_WITH_THIS_NAME = 3009,
-    // 3101 - 3200 = Discord Panels Errors
-    UNKNOWN_PANEL = 3101,
-    INVALID_PANEL_NAME = 3102,
-    INVALID_PANEL_DESCRIPTION = 3103,
-    INVALID_PANEL_PLACEHOLDER = 3104,
-    YOU_REACHED_THE_PANEL_LIMIT = 3105,
-    YOU_ALREADY_HAVE_ANOTHER_PANEL_WITH_THIS_NAME = 3106,
-    YOU_REACHED_THE_PRODUCTS_LIMIT_ON_PANEL = 3107,
-}
+    | 'YOU_NEED_TO_INSERT_AT_LEAST_1_ITEM'
+    | 'ONE_PROVIDED_PRODUCT_IS_OUT_OF_STOCK'
+    | 'WE_DONT_HAVE_THIS_AMOUNT_IN_STOCK'
+    | 'THIS_SELLER_WAS_BANNED_FROM_ZENNIFY'
+    | 'WE_DO_NOT_YET_SUPPORT_MULTIPLE_USER_PRODUCTS'
+    | 'WE_DO_NOT_YET_SUPPORT_MULTIPLE_STORE_PRODUCTS'
+    | 'YOU_ALREADY_HAVE_ANOTHER_ORDER_WAITING_PAYMENT'
+    | 'YOU_INSERTED_AN_INVALID_ADDITIONAL'
+    /// bad preference configuration
+    | 'THIS_SELLER_HAS_NOT_YET_CONFIGURED_RECEIPT_VIA_PIX'
+    | 'THIS_SELLER_HAS_NOT_YET_CONFIGURED_RECEIPT_VIA_BOLETO'
+    | 'THIS_SELLER_HAS_NOT_YET_CONFIGURED_RECEIPT_VIA_CRYPTO'
+    /// coupons
+    | 'THIS_COUPON_DOES_NOT_EXISTS'
+    | 'THIS_COUPON_HAS_EXPIRED'
+    | 'THIS_COUPON_REACHED_THE_USE_LIMIT'
+    | 'SELECT_MORE_ITENS_TO_REACH_MINIMUM_COUPON_VALUE'
+    | 'THIS_COUPON_IS_VALID_ONLY_FOR_THE_FIRST_BUY'
+    // store errors
+    | 'UNKNOWN_STORE'
+    | 'UNKNOWN_BANK'
+    | 'INVALID_STORE_NAME'
+    /// bot errors
+    | 'WAIT_OR_TRY_AGAIN_WITH_ANOTHER_DISCORD_BOT'
+    | 'INVALID_DISCORD_BOT_TOKEN'
+    | 'DISABLE_REQUIRE_CODE_GRANT'
+    // product errors
+    | 'UNKNOWN_PRODUCT'
+    | 'INVALID_PRODUCT_NAME'
+    | 'INVALID_PRODUCT_VALUE'
+    | 'YOU_REACHED_THE_PRODUCT_LIMIT'
+    | 'PRODUCT_NAME_ALREADY_EXIST'
+    /// Description errors
+    | 'INVALID_PRODUCT_DESCRIPTION_FOR_DISCORD'
+    /// Stock errors
+    | 'UNKNOWN_STOCK'
+    | 'INVALID_STOCK_CONTENT'
+    | 'INVALID_STOCK_COST'
+    // Media Errors
+    | 'UNKNOWN_FILE'
+    | 'NO_FILES_FOUND'
+    | 'INVALID_FILE_TYPE'
+    | 'INVALID_FILE_NAME'
+    | 'INVALID_FILE_SIZE'
+    | 'YOU_REACHED_STORAGE_LIMIT'
+    | 'YOU_REACHED_MEDIA_LIMIT'
+    | 'YOU_ALREADY_HAVE_THIS_MEDIA'
+    | 'MEDIA_NAME_ALREADY_EXIST'
+    // Discord Panels Errors
+    | 'UNKNOWN_PANEL'
+    | 'INVALID_PANEL_NAME'
+    | 'INVALID_PANEL_DESCRIPTION'
+    | 'INVALID_PANEL_PLACEHOLDER'
+    | 'YOU_REACHED_PANEL_LIMIT'
+    | 'PANEL_NAME_ALREADY_EXIST'
+    | 'YOU_REACHED_THE_PRODUCT_LIMIT_ON_PANEL'

package/src/interfaces/Media.ts

@@ -0,0 +1,6 @@
+export interface Medium {
+    id: number,
+    name: string,
+    size: number,
+    mime_type: string,
+}

package/src/interfaces/Panels.ts

@@ -0,0 +1,15 @@
+export interface PanelProduct {
+    id: number,
+    position: number,
+    emoji: string
+}
+
+export interface Panel {
+    id: number,
+    name: string,
+    placeholder: string,
+    description: string | null,
+    icon_id: number | null,
+    banner_id: number | null,
+    products: PanelProduct[]
+}

package/src/interfaces/Products.ts

@@ -0,0 +1,29 @@
+export interface PartialProduct {
+    id: number,
+    name: string,
+    value: number,
+    icon_id: number | null,
+    banner_id: number | null,
+    stock_locked: boolean | null,
+    stock_count: number
+}
+
+export interface Product {
+    id: number,
+    name: string,
+    created_at: string,
+    store_id: number,
+    owner_id: number,
+    icon_id: null | number,
+    banner_id: null | number,
+    value: number,
+    description: {
+        short: null | string,
+        discord: null | string,
+        website: null | string
+    },
+    stock: {
+        size: number,
+        locked: boolean
+    }
+}

package/src/main.ts

@@ -1,3 +1,7 @@
 export * from './var';
 export * from './errors';
-export * from './utils';
+export * from './utils';
+export * from './RequestError';
+export * from './interfaces/Media';
+export * from './interfaces/Panels';
+export * from './interfaces/Products';

package/src/utils.ts

@@ -1,20 +1,31 @@
 import { ZennifyAPIRequestError } from './RequestError';
 import { APIErrors } from './errors';
 
-export function GetResponseError(
-    error: keyof typeof APIErrors,
-    additional: any = {}
-): { error: keyof APIErrors | string, code: number } & Record<string, any> {
-
-    const code = APIErrors[error];
-
-    return { error, code, ...additional }
-
+type ExpectedErrorAdditional = { field: string; received: any; type: string }
+type ExpectedError = Extract<
+    APIErrors,
+    | 'EXPECTED_AN_OBJECT_ARRAY'
+    | 'EXPECTED_A_STRING_ARRAY'
+    | 'EXPECTED_A_NUMBER_ARRAY'
+    | 'EXPECTED_AN_OBJECT'
+    | 'EXPECTED_A_NON_EMPTY_OBJECT'
+    | 'EXPECTED_A_STRING'
+    | 'EXPECTED_A_NUMBER'
+    | 'EXPECTED_A_VALID_ID'
+>;
+
+type CommonError = Exclude<APIErrors, ExpectedError>;
+
+export function GetResponseError(code: CommonError): { code: CommonError };
+export function GetResponseError(code: ExpectedError, additional: ExpectedErrorAdditional): { code: ExpectedError } & ExpectedErrorAdditional;
+export function GetResponseError<T extends object>(code: CommonError, additional?: T): { code: CommonError } & T;
+export function GetResponseError(code: APIErrors, additional: any = {}) {
+    return { code, ...additional };
 }
 
 export async function TreatZennifyResponse<T extends any>(response: Response): Promise<T> {
 
-    const body = await response.json();
+    const body = await response.json().catch(() => ({}));
 
     if (response.ok) {
         return body as T;

package/src/var.ts

@@ -1,3 +1,5 @@
-type Languages = 'pt_BR' | 'en_US';
-
-export let ZENNIFY_API_RESPONSE_LANGUAGE: Languages = 'en_US';
+export type SupportedLanguages = 'pt_BR' | 'en_US';
+export let ZENNIFY_API_RESPONSE_LANGUAGE: SupportedLanguages = 'en_US';
+export function SetAPIResponseLanguage(lang: SupportedLanguages) {
+    return ZENNIFY_API_RESPONSE_LANGUAGE = lang;
+}