@zitadel/api 0.1.0-alpha.17 → 0.1.0-alpha.19

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