@zitadel/node - npm Package Compare versions

Comparing version 1.1.122 to 2.0.0

package.json

 {
   "name": "@zitadel/node",
-  "version": "1.1.122",
+  "version": "2.0.0",
   "description": "Library for API access to ZITADEL. Provides compiled gRPC service clients and helpers for applications and service accounts.",
-  "type": "commonjs",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "type": "module",
   "publishConfig": {
@@ -15,6 +13,10 @@ "access": "public"
     "prebuild:tsc": "rimraf dist",
-    "build:tsc": "tsc -p tsconfig.build.json",
-    "prebuild:grpc": "rimraf src/grpc/generated && make-dir src/grpc/generated",
+    "build:tsc": "tshy",
+    "prebuild:test": "rimraf dist",
+    "build:test": "tsc -p tsconfig.test.json",
+    "prebuild:grpc": "rimraf src/api/generated && make-dir src/api/generated",
     "build:grpc": "buf generate https://github.com/zitadel/zitadel.git --path ./proto/zitadel",
-    "test": "ava"
+    "test": "ava",
+    "pretest:ci": "npm run build:grpc && npm run build:test",
+    "test:ci": "npm run test"
   },
@@ -38,11 +40,12 @@ "keywords": [
     "@bufbuild/buf": "^1.18.0-1",
+    "@tsconfig/node-lts": "^20.1.1",
     "@types/node-rsa": "1.1.4",
-    "ava": "4.3.3",
+    "ava": "6.1.1",
     "grpc-tools": "1.12.4",
     "make-dir-cli": "3.1.0",
     "rimraf": "5.0.5",
-    "ts-node": "10.9.2",
     "ts-proto": "1.151.1",
     "tsc-silent": "1.2.2",
-    "typescript": "5.1.6"
+    "tshy": "^1.11.0",
+    "typescript": "5.3.3"
   },
@@ -57,3 +60,34 @@ "dependencies": {
     "protobufjs": "7.2.6"
+  },
+  "tshy": {
+    "selfLink": false,
+    "exports": {
+      "./api": "./src/api/index.ts",
+      "./credentials": "./src/credentials/index.ts",
+      "./package.json": "./package.json"
+    }
+  },
+  "exports": {
+    "./api": {
+      "import": {
+        "types": "./dist/esm/api/index.d.ts",
+        "default": "./dist/esm/api/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/api/index.d.ts",
+        "default": "./dist/commonjs/api/index.js"
+      }
+    },
+    "./credentials": {
+      "import": {
+        "types": "./dist/esm/credentials/index.d.ts",
+        "default": "./dist/esm/credentials/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/credentials/index.d.ts",
+        "default": "./dist/commonjs/credentials/index.js"
+      }
+    },
+    "./package.json": "./package.json"
   }
 }

README.md

@@ -24,2 +24,28 @@ # ZITADEL Node.js
 
+## Goals
+
+This is the "client library" for the ZITADEL API. It contains the compiled
+proto files from the original ZITADEL repository and therefore helps to
+access the API and manage ressources. Also, it contains helpers to
+authenticate a given service account against ZITADEL.
+
+To summarize:
+
+- Provide compiled proto clients
+- Manage resources via proto clients (e.g. `OrganizationServiceClient`, `SessionServiceClient`)
+- Allow authentication of a service account (fetch a token that can be sent)
+
+## Non-Goals
+
+In contrast to the goals of this package, this package does _not_ provide
+means to check for authentication of a user. There exists a multitude
+of frameworks that can be used in conjunction with NodeJS. Therefore, you need
+to use specific framework packages to support authentication.
+
+Known packages:
+
+- [Passport.js](https://www.passportjs.org/): [node-passport-zitadel](https://github.com/buehler/node-passport-zitadel)
+- [NextAuth / Auth.js](https://next-auth.js.org): [ZITADEL Provider](https://next-auth.js.org/providers/zitadel)
+- [NestJS](https://nestjs.com/): [NestJS OIDC](https://github.com/5-stones/nest-oidc)
+
 ### Development
@@ -26,0 +52,0 @@

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29352900

increased by98.54%

Number of package files

269

increased by96.35%

Lines of code

435791

increased by99.82%

Number of lines in readme file

61

increased by74.29%

Is type module

Yes

Worsened metrics

Dev dependency count

11

increased by10%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes