recurrence-stripe - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "recurrence-stripe",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
@@ -5,0 +5,0 @@ "main": "./src/index.ts",

README.md

@@ -1,18 +0,65 @@
-# GERAR CERTIFICADO SSL
+# Recurrence Stripe Library
 
-Primeiro, você precisa criar os arquivos `selfsigned.key` e `selfsigned.crt`.
-Para criar um Certificado SSL Autoassinado Ou siga os seguintes passos.
+Esta biblioteca oferece uma interface simples para interagir com a API do Stripe, permitindo que você consulte detalhes de assinaturas utilizando o `axios` para realizar as requisições HTTP.
 
-#### Vá para o terminal e execute o seguinte comando.
+## Instalação
 
-`sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout ./selfsigned.key -out selfsigned.crt`
+Primeiro, você precisa instalar as bibliotecas e suas dependências:
 
-#### Depois disso coloque as seguintes informações
+```bash
+npm install axios dotenv-safe
+```
 
-**Nome do país:** BR
-**Nome do estado:** SP
-**Nome da localidade:** SP
-**Nome da organização:** JUAD
-**Nome da unidade organizacional:** juad
-**Nome comum:** juad.verce.app
-**Endereço de e-mail:** Seu e-mail
+## Configuração
+
+Você precisa criar um arquivo **.env** na raiz do seu projeto para armazenar suas credenciais do Stripe:
+
+```bash
+touch .env
+```
+
+Exemplo de conteúdo do arquivo .env:
+
+```bash
+STRIPE_SECRET_KEY=sk_test_xxx
+```
+
+## Segurança das Variáveis de Ambiente
+
+Para garantir que todas as variáveis de ambiente necessárias estejam configuradas corretamente, dotenv-safe é usado. Crie um arquivo **.env.example** na raiz do seu projeto para listar todas as variáveis necessárias:
+
+```bash
+touch .env.example
+```
+
+Exemplo de conteúdo do arquivo .env.example:
+
+```bash
+STRIPE_SECRET_KEY=sk_test_xxx
+```
+
+## Uso
+
+Após configurar as variáveis de ambiente, você pode usar a biblioteca para consultar informações de uma assinatura no Stripe:
+
+```ts
+import { Stripe } from './caminho/para/a/sua/biblioteca';
+
+const subscriptionId = 'sub_YDwPML4JZ8XHT';
+
+Stripe.subscriptions(subscriptionId)
+  .then((data) => {
+    console.log(data);
+  })
+  .catch((error) => {
+    console.error('Erro ao consultar a assinatura:', error);
+  });
+```
+
+#### Descrição das Funções
+
+**Stripe.subscriptions(subscriptionId: string | undefined):** Retorna os detalhes da assinatura especificada pelo **subscriptionId**.
+
+## Contribuição
+
+Se desejar contribuir com este projeto, sinta-se à vontade para enviar pull requests ou abrir issues para discutir melhorias.

src/index.ts

@@ -6,3 +6,2 @@ import axios from 'axios';
 
-const subscriptionId = process.env.STRIPE_SUBSCRIPTION_ID;
 const secretKey = process.env.STRIPE_SECRET_KEY;
@@ -12,5 +11,3 @@
   baseURL: 'https://api.stripe.com/v1',
-  headers: {
-    Authorization: `Bearer ${secretKey}`,
-  },
+  headers: { Authorization: `Bearer ${secretKey}` },
 });
@@ -25,3 +22,1 @@
 };
-
-Stripe.subscriptions(subscriptionId);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5158

increased by22.66%

Number of lines in readme file

66

increased by247.37%

Worsened metrics

Lines of code

85

decreased by-4.49%

No dependency changes