Compare commits

..

No commits in common. "master" and "v1.0.3" have entirely different histories.

13 changed files with 2802 additions and 4112 deletions

View File

@ -1,24 +0,0 @@
# Changelog
## 2024-08-27 - 1.1.0 - feat(core)
Add delete user functionality and necessary tests
- Implemented delete method in ZitadelUser class.
- Extended tests to cover user deletion functionality.
- Refactored createUser method to return a ZitadelUser instance.
## 2024-08-26 - 1.0.9 - fix(dependencies)
Update dependencies to latest versions
- Updated @git.zone/tsbuild from ^2.1.25 to ^2.1.84
- Updated @git.zone/tsrun from ^1.2.46 to ^1.2.49
- Updated @push.rocks/tapbundle from ^5.0.15 to ^5.0.24
- Updated @types/node from ^20.8.7 to ^22.5.0
- Updated @tsclass/tsclass from ^4.0.54 to ^4.1.2
- Updated @zitadel/node from ^2.0.8 to 2.0.17
## 2024-05-02 to 2024-05-03 - 1.0.1 to 1.0.8 - Fixes and Updates
General updates and fixes to the core functionality across multiple versions.
- Various fixes in core functionality
- Incremental improvements and updates

View File

@ -5,22 +5,10 @@
"githost": "code.foss.global",
"gitscope": "apiclient.xyz",
"gitrepo": "zitadel",
"description": "An unofficial client for interacting with Zitadel API, enabling user and project management functionalities.",
"description": "an unofficial zitadel client",
"npmPackagename": "@apiclient.xyz/zitadel",
"license": "MIT",
"projectDomain": "apiclient.xyz",
"keywords": [
"Zitadel",
"API client",
"TypeScript",
"authentication",
"user management",
"project management",
"unofficial client",
"node.js",
"access control",
"software development"
]
"projectDomain": "apiclient.xyz"
}
},
"npmci": {

View File

@ -1,8 +1,8 @@
{
"name": "@apiclient.xyz/zitadel",
"version": "1.1.0",
"version": "1.0.3",
"private": false,
"description": "An unofficial client for interacting with Zitadel API, enabling user and project management functionalities.",
"description": "an unofficial zitadel client",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
@ -14,17 +14,17 @@
"buildDocs": "(tsdoc)"
},
"devDependencies": {
"@git.zone/tsbuild": "^2.1.84",
"@git.zone/tsbuild": "^2.1.25",
"@git.zone/tsbundle": "^2.0.5",
"@git.zone/tsrun": "^1.2.49",
"@git.zone/tsrun": "^1.2.46",
"@git.zone/tstest": "^1.0.44",
"@push.rocks/qenv": "^6.0.5",
"@push.rocks/tapbundle": "^5.0.24",
"@types/node": "^22.5.0"
"@push.rocks/tapbundle": "^5.0.15",
"@types/node": "^20.8.7"
},
"dependencies": {
"@tsclass/tsclass": "^4.1.2",
"@zitadel/node": "2.0.17"
"@tsclass/tsclass": "^4.0.54",
"@zitadel/node": "^2.0.8"
},
"repository": {
"type": "git",
@ -48,17 +48,5 @@
"cli.js",
"npmextra.json",
"readme.md"
],
"keywords": [
"Zitadel",
"API client",
"TypeScript",
"authentication",
"user management",
"project management",
"unofficial client",
"node.js",
"access control",
"software development"
]
}

6516
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

135
readme.md
View File

@ -1,118 +1,31 @@
# @apiclient.xyz/zitadel
an unofficial zitadel client
An unofficial client for interacting with Zitadel API.
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@apiclient.xyz/zitadel)
* [gitlab.com (source)](https://code.foss.global/apiclient.xyz/zitadel)
* [github.com (source mirror)](https://github.com/apiclient.xyz/zitadel)
* [docs (typedoc)](https://apiclient.xyz.gitlab.io/zitadel/)
## Install
## Status for master
To get started with `@apiclient.xyz/zitadel`, ensure you have Node.js installed on your machine. Then, you can add this package to your project by running:
```bash
npm install @apiclient.xyz/zitadel --save
```
This module is written in TypeScript to take advantage of type safety and autocompletion in IDEs. If you haven't installed TypeScript globally, you can do so by running:
```bash
npm install -g typescript
```
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://code.foss.global/apiclient.xyz/zitadel/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://code.foss.global/apiclient.xyz/zitadel/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@apiclient.xyz/zitadel)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/apiclient.xyz/zitadel)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@apiclient.xyz/zitadel)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@apiclient.xyz/zitadel)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@apiclient.xyz/zitadel)](https://lossless.cloud)
## Usage
Use TypeScript for best in class intellisense
For further information read the linked docs at the top of this readme.
The `@apiclient.xyz/zitadel` package provides an unofficial TypeScript client for easy interaction with Zitadel's API, allowing for convenient management operations such as user and project management.
### Getting Started
First, ensure you import the core client class from the package:
```typescript
import { ZitaldelClient } from '@apiclient.xyz/zitadel';
```
Initialize the `ZitaldelClient` with your Zitadel instance URL and access token:
```typescript
const zitadelClient = new ZitaldelClient({
url: 'https://your-zitadel-instance.com', // Replace with your Zitadel instance URL.
accessToken: 'your_access_token_here' // Replace with your actual access token.
});
```
### User Management
The library allows performing user operations such as listing all users, getting info of the current user, and creating new users.
#### List All Users
```typescript
async function listUsers() {
const users = await zitadelClient.listUsers();
console.log(users); // Outputs user list
}
listUsers();
```
#### Get Current User Information
```typescript
async function getCurrentUser() {
const user = await zitadelClient.listOwnUser();
console.log(user); // Outputs current user information.
}
getCurrentUser();
```
#### Create a New User
```typescript
async function createUser() {
await zitadelClient.createUser({
email: 'newuser@example.com',
firstName: 'First',
lastName: 'Last'
});
console.log('User created successfully.');
}
createUser();
```
### Project Management
Beyond user management, the client also supports actions on projects—like listing and managing project roles.
#### List Projects
```typescript
async function listProjects() {
const projects = await zitadelClient.listProjects();
console.log(projects); // Outputs list of projects
}
listProjects();
```
#### Project Roles
Each project comes with roles that can be managed through the client.
##### Listing Project Roles
To inspect roles within a project:
```typescript
async function listProjectRoles(projectId: string) {
const projectRoles = await someProject.listProjectRoles(); // Assume `someProject` is an instance of `ZitadelProject`.
console.log(projectRoles);
}
```
Note: The `ZitadelProject` object would typically be obtained as part of the list from `listProjects`.
### Advanced Topics
For more complex scenarios, such as direct interaction with Zitadel's gRPC APIs, or detailed configuration, please refer to the comprehensive [official Zitadel documentation](https://docs.zitadel.ch/). This client offers a simplified abstraction over Zitadel's API functionalities but can be extended or used in conjunction with direct API calls to meet specific needs.
For instance, the `ZitaldelClient` class can be tweaked to support custom interceptors for logging, authentication flow enhancements, or to integrate with Zitadel's event system for real-time updates on resources.
---
This is a basic introduction to `@apiclient.xyz/zitadel`. The client simplifies the interaction with Zitadel's API, focusing on core functionalities like user and project management. For specific use cases, detailed configurations, or advanced features, you may need to extend the client or use it as a foundation for more complex interactions with the Zitadel API.
undefined
## Legal
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

View File

@ -24,24 +24,15 @@ tap.test('should list users', async () => {
const users = await testZitadel.listUsers();
expect(users).toBeArray();
expect(users[0]).toBeInstanceOf(zitadel.ZitaldelUser);
console.log(JSON.stringify(users, null, 2));
console.log(users);
})
const createUserTest = tap.test('should invite user', async (toolsArg) => {
const user = await testZitadel.createUser({
tap.test('should invite user', async () => {
await testZitadel.createUser({
email: await testQenv.getEnvVarOnDemand('ZITADEL_TEST_EMAIL'),
firstName: 'firstname',
lastName: 'lastname',
})
await toolsArg.delayFor(5000);
return user;
})
tap.test('should delete user', async () => {
const createdUser: zitadel.ZitaldelUser = (await createUserTest.testResultPromise) as any;
expect(createdUser).toBeInstanceOf(zitadel.ZitaldelUser);
await createdUser.delete();
})
export default tap.start()

View File

@ -1,8 +1,8 @@
/**
* autocreated commitinfo by @push.rocks/commitinfo
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@apiclient.xyz/zitadel',
version: '1.1.0',
description: 'An unofficial client for interacting with Zitadel API, enabling user and project management functionalities.'
version: '1.0.3',
description: 'an unofficial zitadel client'
}

View File

@ -1,6 +1,5 @@
import { ZitadelProject } from './classes.zitadelproject.js';
import { ZitaldelUser } from './classes.zitadeluser.js';
import * as plugins from './plugins.js';
import * as plugins from './zitadel.plugins.js';
export interface IZitadelContructorOptions {
url: string;
@ -11,7 +10,6 @@ export class ZitaldelClient {
private options: IZitadelContructorOptions;
public authClient: plugins.zitadel.AuthServiceClient;
public userClient: plugins.zitadel.UserServiceClient;
public managementClient: plugins.zitadel.ManagementServiceClient;
constructor(optionsArg: IZitadelContructorOptions) {
this.options = optionsArg;
@ -24,10 +22,6 @@ export class ZitaldelClient {
this.options.url,
plugins.zitadel.createAccessTokenInterceptor(this.options.accessToken)
);
this.managementClient = plugins.zitadel.createManagementClient(
this.options.url,
plugins.zitadel.createAccessTokenInterceptor(this.options.accessToken)
);
}
public async listOwnUser() {
@ -40,18 +34,6 @@ export class ZitaldelClient {
return zitadelUser;
}
public async listProjects() {
const returnProjects: ZitadelProject[] = [];
const response = await this.managementClient.listProjects({});
for (const projectObject of response.result) {
returnProjects.push(new ZitadelProject(this, {
id: projectObject.id,
name: projectObject.name,
}));
}
return returnProjects;
}
public async listUsers() {
const response = await this.userClient.listUsers({});
const returnArray: ZitaldelUser[] = [];
@ -79,12 +61,6 @@ export class ZitaldelClient {
familyName: optionsArg.lastName,
}
});
// const allUsers = await this.listUsers();
// console.log(JSON.stringify(allUsers, null, 2));
return new ZitaldelUser(this, {
id: response.userId,
lastLogin: null,
username: optionsArg.email,
});
console.log(response);
}
}

View File

@ -1,33 +0,0 @@
import type { ZitaldelClient } from './classes.zitadelclient.js';
import { ZitadelProjectRole } from './classes.zitadelprojectrole.js';
import * as plugins from './plugins.js';
export class IZitadelProjectData {
id: string;
name: string;
}
export class ZitadelProject {
ziadelclientRef: ZitaldelClient;
public data: IZitadelProjectData;
constructor(zitadelclientRefArg: ZitaldelClient, dataArg: IZitadelProjectData) {
this.ziadelclientRef = zitadelclientRefArg;
this.data = dataArg;
}
public async listProjectRoles() {
const returnRoles: ZitadelProjectRole[] = [];
const response = await this.ziadelclientRef.managementClient.listProjectRoles({
projectId: this.data.id,
});
for (const roleObject of response.result) {
returnRoles.push(new ZitadelProjectRole(this.ziadelclientRef, {
project: this,
name: roleObject.displayName,
key: roleObject.key,
}));
}
return returnRoles;
}
}

View File

@ -1,19 +0,0 @@
import type { ZitaldelClient } from './classes.zitadelclient.js';
import type { ZitadelProject } from './classes.zitadelproject.js';
import * as plugins from './plugins.js';
export interface IZitadelProjectRoleData {
project: ZitadelProject;
key: string;
name: string;
}
export class ZitadelProjectRole {
ziadelclientRef: ZitaldelClient;
public data: IZitadelProjectRoleData;
constructor(zitadelclientRefArg: ZitaldelClient, dataArg: IZitadelProjectRoleData) {
this.ziadelclientRef = zitadelclientRefArg;
this.data = dataArg;
}
}

View File

@ -1,76 +1,20 @@
import type { ZitaldelClient } from './classes.zitadelclient.js';
import type { ZitadelProjectRole } from './classes.zitadelprojectrole.js';
import * as plugins from './plugins.js';
import * as plugins from './zitadel.plugins.js';
export interface IZitadelUserData {
id: string;
lastLogin: Date;
username: string;
}
};
export class ZitaldelUser {
// INSTANCE
zitadelclientRef: ZitaldelClient;
data: IZitadelUserData;
constructor(zitadelclientRefArg: ZitaldelClient, dataArg: IZitadelUserData) {
this.zitadelclientRef = zitadelclientRefArg;
this.data = dataArg;
}
public async addRole(projectRole: ZitadelProjectRole) {
const response = await this.zitadelclientRef.managementClient.addUserGrant({
userId: this.data.id,
roleKeys: [projectRole.data.key],
projectId: projectRole.data.project.data.id,
});
}
/**
* change email address of user,
* optionally supply own url for email verification
* @param emailAddress
* @param verificationUrl
*/
public async changeEmail(optionsArg: { emailAddress: string; verificationUrl?: string }) {
const response = await this.zitadelclientRef.userClient.setEmail({
userId: this.data.id,
email: optionsArg.emailAddress,
...(optionsArg.verificationUrl
? {
sendCode: {
urlTemplate: optionsArg.verificationUrl,
},
}
: {}),
});
}
public async setPassword(optionsArg: { password: string; changeRequired?: boolean }) {
const response = await this.zitadelclientRef.userClient.setPassword({
userId: this.data.id,
newPassword: {
password: optionsArg.password,
...(optionsArg.changeRequired ? { changeRequired: optionsArg.changeRequired } : {}),
},
});
}
/**
* triggers a password reset action for the user
*/
public async resetPassword() {
const response = await this.zitadelclientRef.userClient.passwordReset({
userId: this.data.id,
});
}
/**
* deletes the user
*/
public async delete() {
const response = await this.zitadelclientRef.userClient.deleteUser({
userId: this.data.id,
});
}
// INSTANCE
data: IZitadelUserData;
}