@zennify/sdk-js 1.0.0-beta.1

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

@@ -0,0 +1,35 @@
+name: Publish to npm
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+      - run: npm ci
+      - run: npm run build
+
+  publish-gpr:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public --tag beta
+        env:
+          NPM_TOKEN: ${{secrets.NPM_TOKEN}}

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@zennify/sdk-js",
+  "version": "1.0.0-beta.1",
+  "description": "A simple package to work with https://api.zennify.app",
+  "main": "dist/main.js",
+  "keywords": [],
+  "author": "josejooj",
+  "license": "ISC",
+  "repository": {
+    "url": "git+https://github.com/zennify-ofc/sdk-js.git"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.12",
+    "typescript": "^5.5.3"
+  },
+  "scripts": {
+    "build": "tsc"
+  },
+  "dependencies": {
+    "undici-types": "^5.26.5"
+  },
+  "bugs": {
+    "url": "https://github.com/zennify-ofc/sdk-js/issues"
+  },
+  "homepage": "https://github.com/zennify-ofc/sdk-js#readme"
+}

package/src/RequestError.ts

@@ -0,0 +1,55 @@
+import pt_BR from '../translations/pt_BR.json';
+import en_US from '../translations/en_US.json';
+import { ZENNIFY_API_RESPONSE_LANGUAGE } from './var';
+
+const errors_translations = { pt_BR, en_US };
+const match_regex = /{[\w.]+}/g;
+const replacer = (body: any, value: string) => {
+    return body[value.slice(1, -1)]
+}
+
+type Body = Record<string, any> & {
+    code: number
+}
+
+export class ZennifyAPIRequestError extends Error {
+
+    status: number = 0;
+    code: number = 0;
+    body: Body
+
+    constructor(response: Response, body: 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: { name: string, message: string } =
+            errors_translations[ZENNIFY_API_RESPONSE_LANGUAGE][body.code as 0] ||
+            errors_translations[ZENNIFY_API_RESPONSE_LANGUAGE]["1"];
+
+        this.name = error.name
+            .replace(match_regex, (value) => replacer(body, value));
+
+        this.message = error.message
+            .replace(match_regex, (value) => replacer(body, value));
+
+    }
+
+}

package/src/errors.ts

@@ -0,0 +1,108 @@
+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
+    // 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,
+}

package/src/main.ts

@@ -0,0 +1,3 @@
+export * from './var';
+export * from './errors';
+export * from './utils';

package/src/utils.ts

@@ -0,0 +1,25 @@
+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 }
+
+}
+
+export async function TreatZennifyResponse<T extends any>(response: Response): Promise<T> {
+
+    const body = await response.json();
+
+    if (response.ok) {
+        return body as T;
+    }
+
+    throw new ZennifyAPIRequestError(response, body);
+
+}

package/src/var.ts

@@ -0,0 +1,3 @@
+type Languages = 'pt_BR' | 'en_US';
+
+export let ZENNIFY_API_RESPONSE_LANGUAGE: Languages = 'en_US';

package/translations/en_US.json

@@ -0,0 +1,10 @@
+{
+    "0": {
+        "name": "An unknown error happened.",
+        "message": "Contact the support with id {id}"
+    },
+    "1": {
+        "name": "{code} not translated yet",
+        "message": "Contact the support."
+    }
+}

package/translations/pt_BR.json

@@ -0,0 +1,10 @@
+{
+    "0": {
+        "name": "Um erro deconhecido ocorreu.",
+        "message": "Contate o suporte com o ID {id}"
+    },
+    "1": {
+        "name": "{code} não traduzido ainda",
+        "message": "Entre em contato com o suporte."
+    }
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    "target": "ES2022",                               /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "module": "CommonJS",                             /* Specify what module code is generated. */
+    "rootDir": "./src",                               /* Specify the root folder within your source files. */
+    "resolveJsonModule": true,                        /* Enable importing .json files. */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "outDir": "dist",                                 /* Specify an output folder for all emitted files. */
+    "declarationDir": "./types",                      /* Specify the output directory for generated declaration files. */
+    "esModuleInterop": true,                          /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true,         /* Ensure that casing is correct in imports. */
+    "strict": true,                                   /* Enable all strict type-checking options. */
+    "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    "skipLibCheck": true,                             /* Skip type checking all .d.ts files. */
+  }
+}