@zitadel/sdk 4.1.0-beta.10

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,250 @@
+# Node.js SDK for Zitadel
+
+This is the Zitadel Node.js SDK, designed to provide a convenient and idiomatic
+way to interact with the Zitadel APIs in Node.js. The SDK provides a seamless
+wrapping of the Zitadel API, making it easy to authenticate service users and
+perform API operations.
+
+The SDK enables efficient integration with the Zitadel API, allowing you to
+manage resources and execute actions. However, it's important to note that
+this SDK is tailored for service users and is not intended for user
+authentication scenarios. It does not support authentication mechanisms
+like OAuth2, OIDC, or SAML for client applications, including web, mobile,
+or other environments. For these types of user authentication, you should
+use other libraries that are designed for the specific platform and
+authentication method.
+
+**Disclaimer**: This SDK is not suitable for implementing user authentication.
+It does not handle authentication for client applications using OAuth2, OIDC,
+or SAML and should not be used for scenarios requiring such functionality.
+For those use cases, consider using other solutions that are designed for
+user authentication across various platforms like web, mobile, or other
+client environments.
+
+> [!IMPORTANT]
+> Please be aware that this SDK is currently in an incubating stage. We are releasing it to the community to gather
+> feedback and learn how it is being used. While you are welcome to use it, please note that the API and functionality may
+> evolve based on community input. We encourage you to try it out and share your experiences, but advise caution when
+> considering it for production environments as future updates may introduce changes.
+
+## Getting Started
+
+### Sign up for Zitadel
+
+To use this SDK, you need a Zitadel account. Sign up at the official
+Zitadel website and obtain the necessary credentials to access the API.
+
+### Minimum Requirements
+
+Ensure you have Node.js 20 or higher installed. You also need npm to
+install dependencies.
+
+## Using the SDK
+
+### Installation
+
+Install the SDK by running one of the following commands:
+
+```bash
+npm install @zitadel/sdk
+```
+
+## Authentication Methods
+
+Your SDK offers three ways to authenticate with Zitadel. Each method has its
+own benefits—choose the one that fits your situation best.
+
+#### 1. Private Key JWT Authentication
+
+**What is it?**
+You use a JSON Web Token (JWT) that you sign with a private key stored in a
+JSON file. This process creates a secure token.
+
+**When should you use it?**
+
+- **Best for production:** It offers strong security.
+- **Advanced control:** You can adjust token settings like expiration.
+
+**How do you use it?**
+
+1. Save your private key in a JSON file.
+2. Use the provided method to load this key and create a JWT-based
+   authenticator.
+
+**Example:**
+
+```ts
+import Zitadel, { ApiException } from '@zitadel/sdk';
+
+const zitadel = await Zitadel.withPrivateKey(
+  'https://example.us1.zitadel.cloud',
+  'path/to/jwt-key.json',
+);
+
+try {
+  const response = await zitadel.users.addHumanUser({
+    userServiceAddHumanUserRequest: {
+      username: 'john.doe',
+      profile: {
+        givenName: 'John',
+        familyName: 'Doe',
+      },
+      email: {
+        email: 'john@doe.com',
+      },
+    },
+  });
+  console.log('User created: ' + JSON.stringify(response, null, 2));
+} catch (e) {
+  if (e instanceof ApiException) {
+    console.log('Error: ' + e.message);
+  }
+}
+```
+
+#### 2. Client Credentials Grant
+
+**What is it?**
+This method uses a client ID and client secret to get a secure access token,
+which is then used to authenticate.
+
+**When should you use it?**
+
+- **Simple and straightforward:** Good for server-to-server communication.
+- **Trusted environments:** Use it when both servers are owned or trusted.
+
+**How do you use it?**
+
+1. Provide your client ID and client secret.
+2. Build the authenticator
+
+**Example:**
+
+```ts
+import Zitadel, { ApiException } from '@zitadel/sdk';
+
+const zitadel = await Zitadel.withClientCredentials(
+  'https://example.us1.zitadel.cloud',
+  'id',
+  'secret',
+);
+
+try {
+  const response = await zitadel.users.addHumanUser({
+    userServiceAddHumanUserRequest: {
+      username: 'john.doe',
+      profile: {
+        givenName: 'John',
+        familyName: 'Doe',
+      },
+      email: {
+        email: 'john@doe.com',
+      },
+    },
+  });
+  console.log('User created: ' + JSON.stringify(response, null, 2));
+} catch (e) {
+  if (e instanceof ApiException) {
+    console.log('Error: ' + e.message);
+  }
+}
+```
+
+#### 3. Personal Access Tokens (PATs)
+
+**What is it?**
+A Personal Access Token (PAT) is a pre-generated token that you can use to
+authenticate without exchanging credentials every time.
+
+**When should you use it?**
+
+- **Easy to use:** Great for development or testing scenarios.
+- **Quick setup:** No need for dynamic token generation.
+
+**How do you use it?**
+
+1. Obtain a valid personal access token from your account.
+2. Create the authenticator with: `PersonalAccessTokenAuthenticator`
+
+**Example:**
+
+```ts
+import Zitadel, { ApiException } from '@zitadel/sdk';
+
+const zitadel = Zitadel.withAccessToken(
+  'https://example.us1.zitadel.cloud',
+  'token',
+);
+
+try {
+  const response = await zitadel.users.addHumanUser({
+    userServiceAddHumanUserRequest: {
+      username: 'john.doe',
+      profile: {
+        givenName: 'John',
+        familyName: 'Doe',
+      },
+      email: {
+        email: 'john@doe.com',
+      },
+    },
+  });
+  console.log('User created: ' + JSON.stringify(response, null, 2));
+} catch (e) {
+  if (e instanceof ApiException) {
+    console.log('Error: ' + e.message);
+  }
+}
+```
+
+---
+
+Choose the authentication method that best suits your needs based on your
+environment and security requirements. For more details, please refer to the
+[Zitadel documentation on authenticating service users](https://zitadel.com/docs/guides/integrate/service-users/authenticate-service-users).
+
+## Design and Dependencies
+
+This SDK is designed to be lean and efficient, focusing on providing a
+streamlined way to interact with the Zitadel API. It relies on standard
+HTTP libraries for making requests, which ensures that
+the SDK integrates well with other libraries and provides flexibility
+in terms of request handling and error management.
+
+## Versioning
+
+A key aspect of our strategy is that the SDK's major version is synchronized with the ZITADEL core project's major
+version to ensure compatibility. For a detailed explanation of this policy and our release schedule, please see
+our [Versioning Guide](VERSIONING.md).
+
+## Contributing
+
+This repository is autogenerated. We do not accept direct contributions.
+Instead, please open an issue for any bugs or feature requests.
+
+## Reporting Issues
+
+If you encounter any issues or have suggestions for improvements, please
+open an issue in the [issue tracker](https://github.com/zitadel/client-nodejs/issues).
+When reporting an issue, please provide the following information to help
+us address it more effectively:
+
+- A detailed description of the problem or feature request
+- Steps to reproduce the issue (if applicable)
+- Any relevant error messages or logs
+- Environment details (e.g., OS version, relevant configurations)
+
+## Support
+
+If you need help setting up or configuring the SDK (or anything
+Zitadel), please head over to the [Zitadel Community on Discord](https://zitadel.com/chat).
+
+There are many helpful people in our Discord community who are ready to
+assist you.
+
+Cloud and enterprise customers can additionally reach us privately via our
+[support communication channels](https://zitadel.com/docs/legal/service-description/support-services).
+
+## License
+
+This SDK is distributed under the Apache 2.0 License.

package/dist/api-exception.d.ts

@@ -0,0 +1,45 @@
+import { ZitadelException } from './zitadel-exception.js';
+/**
+ * Represents an HTTP error returned from an API.
+ * Exposes the HTTP status code, response headers, and response body.
+ */
+export declare class ApiException extends ZitadelException {
+    /**
+     * The HTTP body of the server response.
+     * Can be a decoded JSON object, a string, or null.
+     */
+    protected readonly _responseBody: Record<string, unknown> | string | null;
+    /**
+     * The HTTP headers of the server response.
+     * Represented as a record where keys are header names and values are arrays of strings
+     * (to accommodate headers that can appear multiple times).
+     */
+    protected readonly _responseHeaders: Record<string, string[]>;
+    /**
+     * Constructor.
+     *
+     * @param message Error message.
+     * @param code HTTP status code. This will be passed to ZitadelException's constructor.
+     * @param responseHeaders HTTP response headers. Defaults to an empty object.
+     * @param responseBody HTTP response body (decoded JSON object, string, or null). Defaults to null.
+     */
+    constructor(message: string, code: number, responseHeaders?: Record<string, string[]>, responseBody?: Record<string, unknown> | string | null);
+    /**
+     * Gets the HTTP status code.
+     *
+     * @returns HTTP status code.
+     */
+    getStatusCode(): number;
+    /**
+     * Gets the HTTP response headers.
+     *
+     * @returns HTTP response headers.
+     */
+    getResponseHeaders(): Record<string, string[]>;
+    /**
+     * Gets the HTTP response body (decoded JSON object, string, or null).
+     *
+     * @returns HTTP response body.
+     */
+    getResponseBody(): Record<string, unknown> | string | null;
+}

package/dist/api-exception.js

@@ -0,0 +1,56 @@
+import { ZitadelException } from './zitadel-exception.js';
+/**
+ * Represents an HTTP error returned from an API.
+ * Exposes the HTTP status code, response headers, and response body.
+ */
+export class ApiException extends ZitadelException {
+    /**
+     * The HTTP body of the server response.
+     * Can be a decoded JSON object, a string, or null.
+     */
+    _responseBody;
+    /**
+     * The HTTP headers of the server response.
+     * Represented as a record where keys are header names and values are arrays of strings
+     * (to accommodate headers that can appear multiple times).
+     */
+    _responseHeaders;
+    /**
+     * Constructor.
+     *
+     * @param message Error message.
+     * @param code HTTP status code. This will be passed to ZitadelException's constructor.
+     * @param responseHeaders HTTP response headers. Defaults to an empty object.
+     * @param responseBody HTTP response body (decoded JSON object, string, or null). Defaults to null.
+     */
+    constructor(message, code, responseHeaders = {}, responseBody = null) {
+        super(message, undefined, code);
+        this._responseHeaders = responseHeaders;
+        this._responseBody = responseBody;
+    }
+    /**
+     * Gets the HTTP status code.
+     *
+     * @returns HTTP status code.
+     */
+    getStatusCode() {
+        return super.getCode();
+    }
+    /**
+     * Gets the HTTP response headers.
+     *
+     * @returns HTTP response headers.
+     */
+    getResponseHeaders() {
+        return this._responseHeaders;
+    }
+    /**
+     * Gets the HTTP response body (decoded JSON object, string, or null).
+     *
+     * @returns HTTP response body.
+     */
+    getResponseBody() {
+        return this._responseBody;
+    }
+}
+//# sourceMappingURL=api-exception.js.map

package/dist/api-exception.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-exception.js","sourceRoot":"","sources":["../src/api-exception.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D;;;GAGG;AACH,MAAM,OAAO,YAAa,SAAQ,gBAAgB;IAChD;;;OAGG;IACgB,aAAa,CAA0C;IAE1E;;;;OAIG;IACgB,gBAAgB,CAA2B;IAE9D;;;;;;;OAOG;IACH,YACE,OAAe,EACf,IAAY,EACZ,kBAA4C,EAAE,EAC9C,eAAwD,IAAI;QAE5D,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,gBAAgB,GAAG,eAAe,CAAC;QACxC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACI,aAAa;QAClB,OAAO,KAAK,CAAC,OAAO,EAAE,CAAC;IACzB,CAAC;IAED;;;;OAIG;IACI,kBAAkB;QACvB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,eAAe;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;CACF"}