@zitadel/api 0.1.0-alpha.8 → 1.0.0-alpha.20

package/README.md

@@ -1,9 +1,44 @@
 # @zitadel/api
 
-## Runtime proxy path
+The generated TypeScript client for the Zitadel API, plus the runtime
+configuration every SDK and the shared components build on.
+
+## Configure once, get a typed client
+
+`configureZitadel()` (from `@zitadel/api/config`) is the primary entry point —
+it initializes app-wide SDK configuration and returns a frozen, write-once
+`ZitadelProject` handle. `getApi()` returns the typed client bound to it:
 
 ```ts
-import { setProxyPath } from "@zitadel/api/runtime/base-url";
+import { configureZitadel, getApi } from "@zitadel/api/config";
 
-setProxyPath("https://acc.nextgen.zitadel.com");
+const project = configureZitadel({
+  projectId: "proj_01HEXAMPLE",
+  proxyPath: "/__nextgen", // default
+});
+
+export const api = getApi(project);
 ```
+
+Subsequent `configureZitadel()` calls with the same values return the original
+handle; different values log a warning and keep the original — safe for HMR
+and framework double-mounts. The same handle is what you pass to the shared
+web components' `project` property.
+
+## Entry points
+
+| Import | What it carries |
+| --- | --- |
+| `@zitadel/api/config` | `configureZitadel()`, `getApi()` — the primary surface |
+| `@zitadel/api/client` | The client wrapper the SDKs consume |
+| `@zitadel/api/generated/endpoints/zitadelNextGen` | Generated endpoint functions (orval, from the OpenAPI source) |
+| `@zitadel/api/generated/model` | Generated request/response types |
+| `@zitadel/api/generated/endpoints/zitadelNextGen.zod` | Zod schemas per endpoint |
+| `@zitadel/api/generated/endpoints/zitadelNextGen.msw` | MSW handlers for tests |
+| `@zitadel/api/runtime/base-url` | `setProxyPath()` / `getProxyPath()` — the low-level slot `configureZitadel()` writes; call it directly only when you manage configuration yourself |
+| `@zitadel/api/runtime/auth` | `getApiAuthToken()` and bearer plumbing |
+| `@zitadel/api/runtime/fetch` | The shared `customFetch` interceptor |
+
+The generated files come from the OpenAPI 3.1 source in the
+[`zitadel/nextgen`](https://github.com/zitadel/nextgen) repository — do not
+hand-edit them; the spec is the source of truth.

package/dist/generated/endpoints/zitadelNextGen.d.mts

@@ -1,2 +1,2 @@
-import { $ as getListFlowDefinitionsUrl, A as getFlowDefinition, At as setUserPassword, B as getGetOpenIDConfigurationUrl, C as getCreateSchemaUrl, Ct as issueChallenge, D as getDeleteFlowDefinitionUrl, Dt as revokeMySession, E as getCreateUserUrl, Et as listUsers, F as getGetHealthUrl, G as getGetTeamUrl, H as getGetReadyUrl, I as getGetKeysUrl, J as getGetUserInfoUrl, K as getGetTokenUrl, L as getGetLiveUrl, M as getGetAuthAttemptUrl, Mt as submitFlowStep, N as getGetFlowDefinitionUrl, Nt as updateFlowDefinition, O as getEndSessionUrl, Ot as revokeSession, P as getGetFlowStepUrl, Pt as verifyChallengeProof, Q as getKeys, R as getGetMySessionUrl, S as getCreateProjectUrl, St as introspect, T as getCreateTeamUrl, Tt as listSessions, U as getGetSchemaByIdUrl, V as getGetProjectUrl, W as getGetSessionUrl, X as getIntrospectUrl, Y as getHealth, Z as getIssueChallengeUrl, _ as getAuthorizeGetUrl, _t as getToken, a as createFlowDefinition, at as getOpenIDConfiguration, b as getCreateFlowUrl, bt as getUserInfo, c as createSchema, ct as getRevokeMySessionUrl, d as createUser, dt as getSchemaById, et as getListSessionsUrl, f as deleteFlowDefinition, ft as getSession, g as getAuthorizeDeviceUrl, gt as getTeam, h as getAuthAttempt, ht as getSubmitFlowStepUrl, i as createFlow, it as getMyUser, j as getFlowStep, jt as submitFlowEvent, k as getExchangeHandoffUrl, kt as revokeToken, l as createSession, lt as getRevokeSessionUrl, m as exchangeHandoff, mt as getSubmitFlowEventUrl, n as authorizeGet, nt as getLive, o as createHandoff, ot as getProject, p as endSession, pt as getSetUserPasswordUrl, q as getGetUserByIDUrl, r as createAuthAttempt, rt as getMySession, s as createProject, st as getReady, t as authorizeDevice, tt as getListUsersUrl, u as createTeam, ut as getRevokeTokenUrl, v as getCreateAuthAttemptUrl, vt as getUpdateFlowDefinitionUrl, w as getCreateSessionUrl, wt as listFlowDefinitions, x as getCreateHandoffUrl, xt as getVerifyChallengeProofUrl, y as getCreateFlowDefinitionUrl, yt as getUserByID, z as getGetMyUserUrl } from "../../zitadelNextGen-BS4VE7_Y.mjs";
-export { authorizeDevice, authorizeGet, createAuthAttempt, createFlow, createFlowDefinition, createHandoff, createProject, createSchema, createSession, createTeam, createUser, deleteFlowDefinition, endSession, exchangeHandoff, getAuthAttempt, getAuthorizeDeviceUrl, getAuthorizeGetUrl, getCreateAuthAttemptUrl, getCreateFlowDefinitionUrl, getCreateFlowUrl, getCreateHandoffUrl, getCreateProjectUrl, getCreateSchemaUrl, getCreateSessionUrl, getCreateTeamUrl, getCreateUserUrl, getDeleteFlowDefinitionUrl, getEndSessionUrl, getExchangeHandoffUrl, getFlowDefinition, getFlowStep, getGetAuthAttemptUrl, getGetFlowDefinitionUrl, getGetFlowStepUrl, getGetHealthUrl, getGetKeysUrl, getGetLiveUrl, getGetMySessionUrl, getGetMyUserUrl, getGetOpenIDConfigurationUrl, getGetProjectUrl, getGetReadyUrl, getGetSchemaByIdUrl, getGetSessionUrl, getGetTeamUrl, getGetTokenUrl, getGetUserByIDUrl, getGetUserInfoUrl, getHealth, getIntrospectUrl, getIssueChallengeUrl, getKeys, getListFlowDefinitionsUrl, getListSessionsUrl, getListUsersUrl, getLive, getMySession, getMyUser, getOpenIDConfiguration, getProject, getReady, getRevokeMySessionUrl, getRevokeSessionUrl, getRevokeTokenUrl, getSchemaById, getSession, getSetUserPasswordUrl, getSubmitFlowEventUrl, getSubmitFlowStepUrl, getTeam, getToken, getUpdateFlowDefinitionUrl, getUserByID, getUserInfo, getVerifyChallengeProofUrl, introspect, issueChallenge, listFlowDefinitions, listSessions, listUsers, revokeMySession, revokeSession, revokeToken, setUserPassword, submitFlowEvent, submitFlowStep, updateFlowDefinition, verifyChallengeProof };
+import { $ as getGetFlowDefinitionUrl, $t as listReleases, A as getCreateGrantUrl, At as getQueryProjectsUrl, B as getDeleteTeamUrl, Bt as getSetUserPasswordUrl, C as getBrandingById, Ct as getListUserPasskeysUrl, D as getCreateBrandingUrl, Dt as getMyUser, E as getCreateAuthAttemptUrl, Et as getMySession, F as getCreateSessionUrl, Ft as getReleaseById, G as getFinishUserPasskeyRegistrationUrl, Gt as getUserByID, H as getEnvironmentByName, Ht as getTeam, I as getCreateTeamUrl, It as getRevokeMySessionUrl, J as getGetAuthAttemptUrl, Jt as issueChallenge, K as getFlowDefinition, Kt as getVerifyChallengeProofUrl, L as getCreateUserUrl, Lt as getRevokeSessionUrl, M as getCreateProjectUrl, Mt as getQueryTeamsUrl, N as getCreateReleaseUrl, Nt as getQueryUsersUrl, O as getCreateFlowDefinitionUrl, Ot as getPatchProjectUrl, P as getCreateSchemaUrl, Pt as getReady, Q as getGetEventUrl, Qt as listFlowDefinitions, R as getDeleteFlowDefinitionUrl, Rt as getSchemaById, S as getBeginUserPasskeyRegistrationUrl, St as getListSchemasUrl, T as getCompleteClaimUrl, Tt as getLive, U as getEvent, Ut as getUpdateFlowDefinitionUrl, V as getDeleteUserByIDUrl, Vt as getSubmitFlowStepUrl, W as getExchangeHandoffUrl, Wt as getUpdateTeamUrl, X as getGetClaimStatusUrl, Xt as listEnvironments, Y as getGetBrandingByIdUrl, Yt as listBranding, Z as getGetEnvironmentByNameUrl, Zt as listEvents, _ as deleteTeam, _t as getListBrandingUrl, a as createFlow, an as querySessions, at as getGetMyUserUrl, b as finishUserPasskeyRegistration, bt as getListFlowDefinitionsUrl, c as createHandoff, cn as revokeMySession, ct as getGetReleaseByIdUrl, d as createSchema, dn as submitFlowStep, dt as getGetTeamUrl, en as listSchemas, et as getGetFlowStepUrl, f as createSession, fn as updateFlowDefinition, ft as getGetUserByIDUrl, g as deleteGrant, gt as getIssueChallengeUrl, h as deleteFlowDefinition, ht as getInitClaimUrl, i as createBranding, in as queryProjects, it as getGetMySessionUrl, j as getCreateHandoffUrl, jt as getQuerySessionsUrl, k as getCreateFlowUrl, kt as getProject, l as createProject, ln as revokeSession, lt as getGetSchemaByIdUrl, m as createUser, mn as verifyChallengeProof, mt as getHealth, n as completeClaim, nn as listUserTeams, nt as getGetHealthUrl, o as createFlowDefinition, on as queryTeams, ot as getGetProjectUrl, p as createTeam, pn as updateTeam, pt as getGrant, q as getFlowStep, qt as initClaim, r as createAuthAttempt, rn as patchProject, rt as getGetLiveUrl, s as createGrant, sn as queryUsers, st as getGetReadyUrl, t as beginUserPasskeyRegistration, tn as listUserPasskeys, tt as getGetGrantUrl, u as createRelease, un as setUserPassword, ut as getGetSessionUrl, v as deleteUserByID, vt as getListEnvironmentsUrl, w as getClaimStatus, wt as getListUserTeamsUrl, x as getAuthAttempt, xt as getListReleasesUrl, y as exchangeHandoff, yt as getListEventsUrl, z as getDeleteGrantUrl, zt as getSession } from "../../zitadelNextGen-C4IZjGCT.mjs";
+export { beginUserPasskeyRegistration, completeClaim, createAuthAttempt, createBranding, createFlow, createFlowDefinition, createGrant, createHandoff, createProject, createRelease, createSchema, createSession, createTeam, createUser, deleteFlowDefinition, deleteGrant, deleteTeam, deleteUserByID, exchangeHandoff, finishUserPasskeyRegistration, getAuthAttempt, getBeginUserPasskeyRegistrationUrl, getBrandingById, getClaimStatus, getCompleteClaimUrl, getCreateAuthAttemptUrl, getCreateBrandingUrl, getCreateFlowDefinitionUrl, getCreateFlowUrl, getCreateGrantUrl, getCreateHandoffUrl, getCreateProjectUrl, getCreateReleaseUrl, getCreateSchemaUrl, getCreateSessionUrl, getCreateTeamUrl, getCreateUserUrl, getDeleteFlowDefinitionUrl, getDeleteGrantUrl, getDeleteTeamUrl, getDeleteUserByIDUrl, getEnvironmentByName, getEvent, getExchangeHandoffUrl, getFinishUserPasskeyRegistrationUrl, getFlowDefinition, getFlowStep, getGetAuthAttemptUrl, getGetBrandingByIdUrl, getGetClaimStatusUrl, getGetEnvironmentByNameUrl, getGetEventUrl, getGetFlowDefinitionUrl, getGetFlowStepUrl, getGetGrantUrl, getGetHealthUrl, getGetLiveUrl, getGetMySessionUrl, getGetMyUserUrl, getGetProjectUrl, getGetReadyUrl, getGetReleaseByIdUrl, getGetSchemaByIdUrl, getGetSessionUrl, getGetTeamUrl, getGetUserByIDUrl, getGrant, getHealth, getInitClaimUrl, getIssueChallengeUrl, getListBrandingUrl, getListEnvironmentsUrl, getListEventsUrl, getListFlowDefinitionsUrl, getListReleasesUrl, getListSchemasUrl, getListUserPasskeysUrl, getListUserTeamsUrl, getLive, getMySession, getMyUser, getPatchProjectUrl, getProject, getQueryProjectsUrl, getQuerySessionsUrl, getQueryTeamsUrl, getQueryUsersUrl, getReady, getReleaseById, getRevokeMySessionUrl, getRevokeSessionUrl, getSchemaById, getSession, getSetUserPasswordUrl, getSubmitFlowStepUrl, getTeam, getUpdateFlowDefinitionUrl, getUpdateTeamUrl, getUserByID, getVerifyChallengeProofUrl, initClaim, issueChallenge, listBranding, listEnvironments, listEvents, listFlowDefinitions, listReleases, listSchemas, listUserPasskeys, listUserTeams, patchProject, queryProjects, querySessions, queryTeams, queryUsers, revokeMySession, revokeSession, setUserPassword, submitFlowStep, updateFlowDefinition, updateTeam, verifyChallengeProof };