@democracy-deutschland/bt-dip-sdk - npm Package Compare versions

Comparing version 0.1.0-alpha.0 to 0.1.0-alpha.1

package.json

 {
   "name": "@democracy-deutschland/bt-dip-sdk",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.0-alpha.1",
   "description": "Bundestag DIP - TypeScript SDK",
@@ -8,2 +8,3 @@ "main": "dist/index.js",
   "license": "Apache-2.0",
+  "homepage": "https://github.com/demokratie-live/bt-dip-sdk",
   "repository": "https://github.com/demokratie-live/bt-dip-sdk",
@@ -15,6 +16,8 @@ "scripts": {
     "gen-docs": "typedoc --out docs src/index.ts",
-    "test": "ts-node-dev src/tests/usage.ts"
+    "test": "ts-node-dev -r dotenv/config src/tests/usage.ts"
   },
   "devDependencies": {
     "@openapitools/openapi-generator-cli": "^2.3.3",
+    "@types/node": "^15.12.2",
+    "dotenv": "^10.0.0",
     "ts-node-dev": "^1.1.6",
@@ -21,0 +24,0 @@ "typedoc": "^0.20.36",

README.md

 🚧 Still under Constructionn 🚧
 
-# bt-dip-sdk
+# 🏛 Dokumentations- und Informationssystems für Parlamentsmaterialien (DIP) – SDK
 
+TypeScript SDK for the bundestag dip rest api: https://dip.bundestag.de/über-dip/hilfe/api
+
 ## Docs
@@ -12,7 +14,13 @@
 ```
-yarn add @democracy-deutschland/bt-dip-sdk
+yarn add @democracy-deutschland/bt-dip-sdk@0.1.0-alpha.0
 ```
 
-## Usagee
+## Prerequirements
 
+### ApiKey
+
+You can get an apiKey from https://dip.bundestag.de/über-dip/hilfe/api
+
+## Usage
+
 ```ts
@@ -22,3 +30,3 @@ import { DipApi, Configuration } from "@democracy-deutschland/bt-dip-sdk";
 const config = new Configuration({
-  apiKey: "ApiKey N64VhW8.yChkBUIJeosGojQ7CSR2xwLf3Qy7Apw464",
+  apiKey: "ApiKey #YOUR_API_KEY#", // Replace #YOUR_API_KEY# with your api key
 });
@@ -36,1 +44,9 @@
 ```
+
+## Contribute
+
+```sh
+yarn
+# Edit swagger.yml
+yarn gen
+```

src/tests/usage.ts

 import { DipApi, Configuration } from "../index";
 
 const config = new Configuration({
-  apiKey: "ApiKey N64VhW8.yChkBUIJeosGojQ7CSR2xwLf3Qy7Apw464",
+  apiKey: `ApiKey ${process.env.API_KEY}`,
 });
@@ -6,0 +6,0 @@

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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

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

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

42170

increased by6.4%

Number of package files

17

increased by88.89%

Lines of code

115

increased by33.72%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

50

increased by47.06%

Worsened metrics

Dev dependency count

6

increased by50%

Number of low supply chain risk alerts

2

increased by100%

No dependency changes