keycloak-api 0.2.6 → 1.0.1

package/README.md

@@ -1,8 +1,79 @@
-# Keycloak API JavaScript SDK
+# keycloak-api
 
-Unofficial Keycloak API JavaScript SDK built from the OpenAPI specification and with TypeScript types.
+Auto-generated, fully typed client for the [Keycloak Admin and Account REST APIs](https://www.keycloak.org/docs-api/latest/rest-api/index.html).
+
+## Features
+
+- **Fully typed** - every endpoint, parameter and response is generated from the official OpenAPI specs
+- **Admin and Account APIs** - separate clients for the two Keycloak surfaces
+- **Tree-shakable** - only the operations you import end up in your bundle
+- **Runtime agnostic** - uses the global `fetch`, or bring your own implementation
+
+## Installation
+
+```bash
+npm install keycloak-api
+```
+
+## Quick Start
+
+Keycloak is self-hosted, so both clients require the `baseUrl` of your server. Endpoints are addressed
+as `"<METHOD> <path>"`.
+
+### Admin API
 
 ```ts
-const keycloak = new KeycloakApi({ token: 'token' });
-const realms = await keycloak.request('GET /admin/realms', {});
+import { KeycloakAdminApi } from "keycloak-api";
+
+const admin = new KeycloakAdminApi({
+  baseUrl: "https://keycloak.example.com",
+  token: process.env.KEYCLOAK_TOKEN ?? null,
+});
+
+const realms = await admin.request("GET /admin/realms", {});
+const realm = await admin.request("GET /admin/realms/{realm}", {
+  pathParams: { realm: "master" },
+});
 ```
+
+### Account API
+
+The Account API is scoped to a single realm, passed at construction time.
+
+```ts
+import { KeycloakAccountApi } from "keycloak-api";
+
+const account = new KeycloakAccountApi({
+  baseUrl: "https://keycloak.example.com",
+  realm: "master",
+  token: process.env.KEYCLOAK_TOKEN ?? null,
+});
+
+const me = await account.request("GET /account/", {});
+```
+
+### Custom fetch
+
+```ts
+const admin = new KeycloakAdminApi({
+  baseUrl: "https://keycloak.example.com",
+  token: process.env.KEYCLOAK_TOKEN ?? null,
+  fetch: myFetchImplementation,
+});
+```
+
+## Entrypoints
+
+| Import | Contents |
+| --- | --- |
+| `keycloak-api` | both client classes, plus admin/account operations, schemas and types |
+| `keycloak-api/admin/components` | admin operations grouped by tag and by path |
+| `keycloak-api/admin/schemas` | Zod schemas for admin operations |
+| `keycloak-api/admin/types` | TypeScript types for admin operations |
+| `keycloak-api/account/components` | account operations grouped by tag and by path |
+| `keycloak-api/account/schemas` | Zod schemas for account operations |
+| `keycloak-api/account/types` | TypeScript types for account operations |
+
+## License
+
+ISC

package/dist/account/components.cjs

@@ -0,0 +1,371 @@
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var fetcher = require('../fetcher-aq8636lm.cjs');
+
+/**
+ * @description Get user details for currently logged in user
+ * @summary Get account
+ * {@link /account/}
+ */ async function getAccount({ queryParams, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "GET",
+        url: `/account/`,
+        queryParams,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Update account
+ * {@link /account/}
+ */ async function updateAccount({ body, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "POST",
+        url: `/account/`,
+        body,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Get applications
+ * {@link /account/applications}
+ */ async function getApplications({ queryParams, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "GET",
+        url: `/account/applications`,
+        queryParams,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Get consent
+ * {@link /account/applications/:clientId/consent}
+ */ async function getConsent({ pathParams: { clientId }, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!clientId) {
+        throw new Error(`Missing required path parameter: clientId`);
+    }
+    const data = await request({
+        method: "GET",
+        url: `/account/applications/${clientId}/consent`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Create consent
+ * {@link /account/applications/:clientId/consent}
+ */ async function createConsent({ pathParams: { clientId }, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!clientId) {
+        throw new Error(`Missing required path parameter: clientId`);
+    }
+    const data = await request({
+        method: "POST",
+        url: `/account/applications/${clientId}/consent`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Update consent
+ * {@link /account/applications/:clientId/consent}
+ */ async function updateConsent({ pathParams: { clientId }, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!clientId) {
+        throw new Error(`Missing required path parameter: clientId`);
+    }
+    const data = await request({
+        method: "PUT",
+        url: `/account/applications/${clientId}/consent`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Delete consent
+ * {@link /account/applications/:clientId/consent}
+ */ async function deleteConsent({ pathParams: { clientId }, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!clientId) {
+        throw new Error(`Missing required path parameter: clientId`);
+    }
+    const data = await request({
+        method: "DELETE",
+        url: `/account/applications/${clientId}/consent`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @description Get credentials for currently logged in user
+ * @summary Get credentials
+ * {@link /account/credentials}
+ */ async function getCredentials({ queryParams, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "GET",
+        url: `/account/credentials`,
+        queryParams,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Delete the credential
+ * {@link /account/credentials/:credentialId}
+ */ async function deleteCredential({ pathParams: { credentialId }, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!credentialId) {
+        throw new Error(`Missing required path parameter: credentialId`);
+    }
+    const data = await request({
+        method: "DELETE",
+        url: `/account/credentials/${credentialId}`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Update a user label of specified credential of current user
+ * {@link /account/credentials/:credentialId/label}
+ */ async function updateCredentialLabel({ pathParams: { credentialId }, body, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!credentialId) {
+        throw new Error(`Missing required path parameter: credentialId`);
+    }
+    const data = await request({
+        method: "PUT",
+        url: `/account/credentials/${credentialId}/label`,
+        body,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @description Get sessions for currently logged in user
+ * @summary Get sessions
+ * {@link /account/sessions}
+ */ async function getSessions({ config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "GET",
+        url: `/account/sessions`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Delete current session
+ * {@link /account/sessions}
+ */ async function deleteCurrentSession({ config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "DELETE",
+        url: `/account/sessions`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @description Get devices for currently logged in user
+ * @summary Get devices
+ * {@link /account/sessions/devices}
+ */ async function getDevices({ config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "GET",
+        url: `/account/sessions/devices`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Delete the session
+ * {@link /account/sessions/:sessionId}
+ */ async function deleteSession({ pathParams: { sessionId }, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!sessionId) {
+        throw new Error(`Missing required path parameter: sessionId`);
+    }
+    const data = await request({
+        method: "DELETE",
+        url: `/account/sessions/${sessionId}`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @description Get linked accounts for currently logged in user
+ * @summary Get linked accounts
+ * {@link /account/linked-accounts}
+ */ async function getLinkedAccounts({ config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "GET",
+        url: `/account/linked-accounts`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @description Build account linking URI
+ * @summary Build account linking URI
+ * {@link /account/linked-accounts/:providerId}
+ */ async function buildLinkingUri({ pathParams: { providerId }, queryParams, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!providerId) {
+        throw new Error(`Missing required path parameter: providerId`);
+    }
+    const data = await request({
+        method: "GET",
+        url: `/account/linked-accounts/${providerId}`,
+        queryParams,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Delete the linked provider
+ * {@link /account/linked-accounts/:providerId}
+ */ async function deleteLinkedProvider({ pathParams: { providerId }, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    if (!providerId) {
+        throw new Error(`Missing required path parameter: providerId`);
+    }
+    const data = await request({
+        method: "DELETE",
+        url: `/account/linked-accounts/${providerId}`,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @summary Get groups that this user is a member of
+ * {@link /account/groups}
+ */ async function getGroups({ queryParams, config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "GET",
+        url: `/account/groups`,
+        queryParams,
+        ...requestConfig
+    });
+    return data;
+}
+/**
+ * @description Get organizations for currently logged in user
+ * @summary Get organizations
+ * {@link /account/organizations}
+ */ async function getOrganizations({ config = {} }) {
+    const { client: request = fetcher.client, ...requestConfig } = config;
+    const data = await request({
+        method: "GET",
+        url: `/account/organizations`,
+        ...requestConfig
+    });
+    return data;
+}
+const operationsByPath = {
+    "GET /account/": getAccount,
+    "POST /account/": updateAccount,
+    "GET /account/applications": getApplications,
+    "GET /account/applications/{clientId}/consent": getConsent,
+    "POST /account/applications/{clientId}/consent": createConsent,
+    "PUT /account/applications/{clientId}/consent": updateConsent,
+    "DELETE /account/applications/{clientId}/consent": deleteConsent,
+    "GET /account/credentials": getCredentials,
+    "DELETE /account/credentials/{credentialId}": deleteCredential,
+    "PUT /account/credentials/{credentialId}/label": updateCredentialLabel,
+    "GET /account/sessions": getSessions,
+    "DELETE /account/sessions": deleteCurrentSession,
+    "GET /account/sessions/devices": getDevices,
+    "DELETE /account/sessions/{sessionId}": deleteSession,
+    "GET /account/linked-accounts": getLinkedAccounts,
+    "GET /account/linked-accounts/{providerId}": buildLinkingUri,
+    "DELETE /account/linked-accounts/{providerId}": deleteLinkedProvider,
+    "GET /account/groups": getGroups,
+    "GET /account/organizations": getOrganizations
+};
+const operationsByTag = {
+    account: {
+        getAccount,
+        updateAccount,
+        getApplications,
+        getConsent,
+        createConsent,
+        updateConsent,
+        deleteConsent,
+        getCredentials,
+        deleteCredential,
+        updateCredentialLabel,
+        getSessions,
+        deleteCurrentSession,
+        getDevices,
+        deleteSession,
+        getLinkedAccounts,
+        buildLinkingUri,
+        deleteLinkedProvider,
+        getGroups,
+        getOrganizations
+    }
+};
+const tagDictionary = {
+    account: {
+        GET: [
+            "getAccount",
+            "getApplications",
+            "getConsent",
+            "getCredentials",
+            "getSessions",
+            "getDevices",
+            "getLinkedAccounts",
+            "buildLinkingUri",
+            "getGroups",
+            "getOrganizations"
+        ],
+        POST: [
+            "updateAccount",
+            "createConsent"
+        ],
+        PUT: [
+            "updateConsent",
+            "updateCredentialLabel"
+        ],
+        DELETE: [
+            "deleteConsent",
+            "deleteCredential",
+            "deleteCurrentSession",
+            "deleteSession",
+            "deleteLinkedProvider"
+        ]
+    }
+};
+
+exports.buildLinkingUri = buildLinkingUri;
+exports.createConsent = createConsent;
+exports.deleteConsent = deleteConsent;
+exports.deleteCredential = deleteCredential;
+exports.deleteCurrentSession = deleteCurrentSession;
+exports.deleteLinkedProvider = deleteLinkedProvider;
+exports.deleteSession = deleteSession;
+exports.getAccount = getAccount;
+exports.getApplications = getApplications;
+exports.getConsent = getConsent;
+exports.getCredentials = getCredentials;
+exports.getDevices = getDevices;
+exports.getGroups = getGroups;
+exports.getLinkedAccounts = getLinkedAccounts;
+exports.getOrganizations = getOrganizations;
+exports.getSessions = getSessions;
+exports.operationsByPath = operationsByPath;
+exports.operationsByTag = operationsByTag;
+exports.tagDictionary = tagDictionary;
+exports.updateAccount = updateAccount;
+exports.updateConsent = updateConsent;
+exports.updateCredentialLabel = updateCredentialLabel;