Merge branch 'gerencianet:main' into main

Author: jvoliveiraGN

.npmignore

@@ -0,0 +1,7 @@
+.eslint.json
+.gitignore
+.npmignore
+.prettierrc.json
+package.json
+README.md
+tsconfig.json

README.md

@@ -1 +1,114 @@
+# gn-api-sdk-typescript
 
+> A nodejs module for integration of your backend with the payment services provided by [Gerencianet](http://gerencianet.com.br).
+
+> Um módulo nodejs para integrar seu backend com os serviços de pagamento da [Gerencianet](http://gerencianet.com.br).
+
+## Instalação
+
+```bash
+$ npm install gn-api-sdk-typescript
+```
+
+## Uso Básico
+
+Importe o módulo:
+
+```typescript
+import Gerencianet from 'gn-api-sdk-typescript';
+```
+
+Insira suas credenciais e defina se deseja usar o sandbox ou não.
+Você também pode usar o arquivo [examples/config.ts](examples/config.ts) de modelo.
+```typescript
+export = {
+	// PRODUÇÃO = false
+	// HOMOLOGAÇÃO = true
+	sandbox: false,
+
+	// CREDENCIAIS DE PRODUÇÃO
+	clientIdProducao: '',
+	clientSecretProducao: '',
+	pathCertProducao: '',
+
+	// CREDENCIAIS DE HOMOLOGAÇÃO
+	clientIdHomologacao: '',
+	clientSecretHomologacao: '',
+	pathCertHomologacao: '',
+
+	// VALIDAR MTLS?
+	validateMtls: false,
+};
+```
+
+Instancie o módulo passando as options:
+
+```typescript
+const gerencianet = Gerencianet(options);
+```
+
+Crie uma cobrança:
+
+```typescript
+var body = {
+  items: [{
+    name: 'Product A',
+    value: 1000,
+    amount: 2
+  }]
+}
+
+gerencianet
+  .createCharge({}, body)
+  .then(console.log)
+  .catch(console.log)
+  .done();
+```
+
+## Exemplos
+
+Para executar os exemplos, clone este repo e instale as dependências:
+
+```bash
+$ git clone git@github.com:gerencianet/gn-api-sdk-typescript.git
+$ cd gn-api-sdk-typescript/examples
+$ npm install
+```
+
+Defina suas credenciais em config.ts:
+
+```typescript
+export = {
+	// PRODUÇÃO = false
+	// HOMOLOGAÇÃO = true
+	sandbox: false,
+
+	// CREDENCIAIS DE PRODUÇÃO
+	clientIdProducao: '',
+	clientSecretProducao: '',
+	pathCertProducao: '',
+
+	// CREDENCIAIS DE HOMOLOGAÇÃO
+	clientIdHomologacao: '',
+	clientSecretHomologacao: '',
+	pathCertHomologacao: '',
+
+	// VALIDAR MTLS?
+	validateMtls: false,
+};
+```
+
+Em seguida, execute o exemplo que você deseja:
+
+```bash
+$ ts-node createCharge.ts
+```
+
+
+## Documentação
+
+A documentação completa com todos os endpoints disponíveis você encontra em: https://dev.gerencianet.com.br/.
+
+## License
+
+[MIT](LICENSE)

examples/package.json

@@ -1,5 +1,6 @@
 {
     "dependencies": {
-        "gn-api-sdk-typescript": "https://github.com/gerencianet/gn-api-sdk-typescript.git"
+        "gn-api-sdk-typescript": "https://github.com/gerencianet/gn-api-sdk-typescript.git",
+        "ts-node": "^9.1.1"
     }
-}
+}

package.json

@@ -1,15 +1,19 @@
 {
   "name": "gn-api-sdk-typescript",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Module for integration with Gerencianet API\"",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "npx tsc -p ./tsconfig.json",
+    "prepare": "npm run build",
+    "postversion": "git push --tags"
   },
   "author": "Gerencianet - Consultoria Tecnica | João Vitor Oliveira",
   "license": "MIT",
   "repository": "gerencianet/gn-api-sdk-typescript",
   "homepage": "https://github.com/gerencianet/gn-api-sdk-typescript",
+  "files": ["dist/*", "examples"],
   "keywords": [
     "gerencianet",
     "pagamentos",

tsconfig.json

@@ -68,5 +68,8 @@
     "skipLibCheck": true,                           /* Skip type checking of declaration files. */
     "forceConsistentCasingInFileNames": true,        /* Disallow inconsistently-cased references to the same file. */
     "resolveJsonModule": true
-  }
+  },
+  "exclude": [
+    "examples"
+  ]
 }