@mseep/safe-omada-mcp 0.17.0

package/dist/omadaClient/account.js

@@ -0,0 +1,103 @@
+/**
+ * Account-related operations for the Omada API.
+ * Covers users, roles, cloud access, and MFA settings.
+ */
+export class AccountOperations {
+    request;
+    buildPath;
+    constructor(request, buildPath) {
+        this.request = request;
+        this.buildPath = buildPath;
+    }
+    /**
+     * Get all cloud users (excluding root).
+     * OperationId: getAllCloudUsersExcludeRoot
+     */
+    async getAllCloudUsers(customHeaders) {
+        const path = this.buildPath('/users/cloud');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get all local users (excluding root).
+     * OperationId: getAllLocalUsersExcludeRoot
+     */
+    async getAllLocalUsers(customHeaders) {
+        const path = this.buildPath('/users/local');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get all roles.
+     * OperationId: getAllRoles
+     */
+    async getAllRoles(customHeaders) {
+        const path = this.buildPath('/roles');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get role detail by role ID.
+     * OperationId: getRole
+     */
+    async getRoleDetail(roleId, customHeaders) {
+        const path = this.buildPath(`/roles/${encodeURIComponent(roleId)}`);
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get available roles for assignment.
+     * OperationId: getAvailableRole
+     */
+    async getAvailableRoles(customHeaders) {
+        const path = this.buildPath('/roles/available');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get all users (app grid view).
+     * OperationId: getAppGridUsers
+     */
+    async getAllUsersApp(customHeaders) {
+        const path = this.buildPath('/all-users');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get cloud access status.
+     * OperationId: getCloudAccessStatus
+     */
+    async getCloudAccessStatus(customHeaders) {
+        const path = this.buildPath('/cloud/status');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get cloud user info.
+     * OperationId: getCloudUserInfo
+     */
+    async getCloudUserInfo(customHeaders) {
+        const path = this.buildPath('/cloud/user');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get global MFA status.
+     * OperationId: getGlobalMFAStatus
+     */
+    async getMfaStatus(customHeaders) {
+        const path = this.buildPath('/mfa/status');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    /**
+     * Get remote binding status.
+     * OperationId: getRemoteBindingStatus
+     */
+    async getRemoteBindingStatus(customHeaders) {
+        const path = this.buildPath('/cloud/remote/bind/status');
+        const response = await this.request.get(path, undefined, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+}
+//# sourceMappingURL=account.js.map

package/dist/omadaClient/account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../src/omadaClient/account.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAEL;IACA;IAFrB,YACqB,OAAuB,EACvB,SAAmC;QADnC,YAAO,GAAP,OAAO,CAAgB;QACvB,cAAS,GAAT,SAAS,CAA0B;IACrD,CAAC;IAEJ;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,aAA6B;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,aAA6B;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,WAAW,CAAC,aAA6B;QAClD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,aAAa,CAAC,MAAc,EAAE,aAA6B;QACpE,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACpE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,iBAAiB,CAAC,aAA6B;QACxD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,cAAc,CAAC,aAA6B;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC1C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,oBAAoB,CAAC,aAA6B;QAC3D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,gBAAgB,CAAC,aAA6B;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,aAA6B;QACnD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC3C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,sBAAsB,CAAC,aAA6B;QAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAA4B,IAAI,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACnG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;CACJ"}

package/dist/omadaClient/actions.d.ts

@@ -0,0 +1,18 @@
+import type { CustomHeaders } from '../types/index.js';
+import type { RequestHandler } from './request.js';
+import type { SiteOperations } from './site.js';
+/**
+ * Low-risk operational actions backed by the official Omada Open API.
+ * These are intentionally limited to device/client actions with clear operator intent.
+ */
+export declare class ActionOperations {
+    private readonly request;
+    private readonly site;
+    private readonly buildPath;
+    constructor(request: RequestHandler, site: SiteOperations, buildPath: (path: string, version?: string) => string);
+    rebootDevice(deviceMac: string, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+    blockClient(clientMac: string, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+    unblockClient(clientMac: string, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+    reconnectClient(clientMac: string, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+    setDeviceLed(deviceMac: string, ledSetting: number, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+}

package/dist/omadaClient/actions.js

@@ -0,0 +1,45 @@
+/**
+ * Low-risk operational actions backed by the official Omada Open API.
+ * These are intentionally limited to device/client actions with clear operator intent.
+ */
+export class ActionOperations {
+    request;
+    site;
+    buildPath;
+    constructor(request, site, buildPath) {
+        this.request = request;
+        this.site = site;
+        this.buildPath = buildPath;
+    }
+    async rebootDevice(deviceMac, siteId, customHeaders) {
+        const resolvedSiteId = this.site.resolveSiteId(siteId);
+        const path = this.buildPath(`/sites/${encodeURIComponent(resolvedSiteId)}/devices/${encodeURIComponent(deviceMac)}/reboot`);
+        const response = await this.request.post(path, {}, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    async blockClient(clientMac, siteId, customHeaders) {
+        const resolvedSiteId = this.site.resolveSiteId(siteId);
+        const path = this.buildPath(`/sites/${encodeURIComponent(resolvedSiteId)}/clients/${encodeURIComponent(clientMac)}/block`);
+        const response = await this.request.post(path, {}, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    async unblockClient(clientMac, siteId, customHeaders) {
+        const resolvedSiteId = this.site.resolveSiteId(siteId);
+        const path = this.buildPath(`/sites/${encodeURIComponent(resolvedSiteId)}/clients/${encodeURIComponent(clientMac)}/unblock`);
+        const response = await this.request.post(path, {}, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    async reconnectClient(clientMac, siteId, customHeaders) {
+        const resolvedSiteId = this.site.resolveSiteId(siteId);
+        const path = this.buildPath(`/sites/${encodeURIComponent(resolvedSiteId)}/clients/${encodeURIComponent(clientMac)}/reconnect`);
+        const response = await this.request.post(path, {}, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+    async setDeviceLed(deviceMac, ledSetting, siteId, customHeaders) {
+        const resolvedSiteId = this.site.resolveSiteId(siteId);
+        const path = this.buildPath(`/sites/${encodeURIComponent(resolvedSiteId)}/devices/${encodeURIComponent(deviceMac)}/led-setting`);
+        const response = await this.request.post(path, { ledSetting }, customHeaders);
+        return this.request.ensureSuccess(response);
+    }
+}
+//# sourceMappingURL=actions.js.map

package/dist/omadaClient/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../src/omadaClient/actions.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAEJ;IACA;IACA;IAHrB,YACqB,OAAuB,EACvB,IAAoB,EACpB,SAAqD;QAFrD,YAAO,GAAP,OAAO,CAAgB;QACvB,SAAI,GAAJ,IAAI,CAAgB;QACpB,cAAS,GAAT,SAAS,CAA4C;IACvE,CAAC;IAEG,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,MAAe,EAAE,aAA6B;QACvF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,kBAAkB,CAAC,cAAc,CAAC,YAAY,kBAAkB,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAC5H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAA4B,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;QAC7F,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,MAAe,EAAE,aAA6B;QACtF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,kBAAkB,CAAC,cAAc,CAAC,YAAY,kBAAkB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC3H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAA4B,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;QAC7F,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,MAAe,EAAE,aAA6B;QACxF,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,kBAAkB,CAAC,cAAc,CAAC,YAAY,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAC7H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAA4B,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;QAC7F,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,SAAiB,EAAE,MAAe,EAAE,aAA6B;QAC1F,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,kBAAkB,CAAC,cAAc,CAAC,YAAY,kBAAkB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC/H,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAA4B,IAAI,EAAE,EAAE,EAAE,aAAa,CAAC,CAAC;QAC7F,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,UAAkB,EAAE,MAAe,EAAE,aAA6B;QAC3G,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,UAAU,kBAAkB,CAAC,cAAc,CAAC,YAAY,kBAAkB,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACjI,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAA4B,IAAI,EAAE,EAAE,UAAU,EAAE,EAAE,aAAa,CAAC,CAAC;QACzG,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IAChD,CAAC;CACJ"}

package/dist/omadaClient/auth.d.ts

@@ -0,0 +1,34 @@
+import type { AxiosInstance } from 'axios';
+/**
+ * Authentication state management for the Omada client.
+ */
+export declare class AuthManager {
+    private readonly http;
+    private readonly clientId;
+    private readonly clientSecret;
+    private readonly omadacId;
+    private accessToken?;
+    private refreshToken?;
+    private tokenExpiresAt?;
+    constructor(http: AxiosInstance, clientId: string, clientSecret: string, omadacId: string);
+    /**
+     * Get the current access token, refreshing if necessary.
+     */
+    getAccessToken(): Promise<string>;
+    /**
+     * Clear the current authentication token.
+     */
+    clearToken(): void;
+    /**
+     * Ensure a valid access token is available, refreshing or re-authenticating if necessary.
+     */
+    private ensureAccessToken;
+    /**
+     * Authenticate with the Omada controller using the specified grant type.
+     */
+    private authenticate;
+    /**
+     * Store the authentication token and calculate expiration time.
+     */
+    private setToken;
+}

package/dist/omadaClient/auth.js

@@ -0,0 +1,103 @@
+import { logger } from '../utils/logger.js';
+const TOKEN_EXPIRY_BUFFER_SECONDS = 30;
+/**
+ * Authentication state management for the Omada client.
+ */
+export class AuthManager {
+    http;
+    clientId;
+    clientSecret;
+    omadacId;
+    accessToken;
+    refreshToken;
+    tokenExpiresAt;
+    constructor(http, clientId, clientSecret, omadacId) {
+        this.http = http;
+        this.clientId = clientId;
+        this.clientSecret = clientSecret;
+        this.omadacId = omadacId;
+    }
+    /**
+     * Get the current access token, refreshing if necessary.
+     */
+    async getAccessToken() {
+        await this.ensureAccessToken();
+        return this.accessToken ?? '';
+    }
+    /**
+     * Clear the current authentication token.
+     */
+    clearToken() {
+        this.accessToken = undefined;
+        this.refreshToken = undefined;
+        this.tokenExpiresAt = undefined;
+    }
+    /**
+     * Ensure a valid access token is available, refreshing or re-authenticating if necessary.
+     */
+    async ensureAccessToken() {
+        if (this.accessToken && this.tokenExpiresAt && Date.now() < this.tokenExpiresAt) {
+            return;
+        }
+        if (this.refreshToken) {
+            try {
+                await this.authenticate('refresh_token');
+                return;
+            }
+            catch {
+                this.clearToken();
+            }
+        }
+        await this.authenticate('client_credentials');
+    }
+    /**
+     * Authenticate with the Omada controller using the specified grant type.
+     */
+    async authenticate(grantType) {
+        const params = { grant_type: grantType };
+        const body = {
+            client_id: this.clientId,
+            client_secret: this.clientSecret,
+        };
+        if (grantType === 'client_credentials') {
+            body.omadacId = this.omadacId;
+        }
+        else {
+            if (!this.refreshToken) {
+                throw new Error('No refresh token available to refresh the access token');
+            }
+            params.refresh_token = this.refreshToken;
+        }
+        try {
+            const { data } = await this.http.post('/openapi/authorize/token', body, { params });
+            if (data.errorCode !== 0) {
+                logger.error('Omada authentication error', {
+                    errorCode: data.errorCode,
+                    message: data.msg,
+                });
+                throw new Error(data.msg ?? 'Omada authentication failed');
+            }
+            const token = data.result ?? {};
+            this.setToken(token);
+        }
+        catch (error) {
+            logger.error('Omada authentication failed', {
+                grantType,
+                baseUrl: this.http.defaults.baseURL,
+                error: error instanceof Error ? error.message : String(error),
+            });
+            throw error;
+        }
+    }
+    /**
+     * Store the authentication token and calculate expiration time.
+     */
+    setToken(token) {
+        this.accessToken = token.accessToken;
+        this.refreshToken = token.refreshToken;
+        const expiresInSeconds = Number.isFinite(token.expiresIn) ? token.expiresIn : 0;
+        const expiresInMs = Math.max(expiresInSeconds - TOKEN_EXPIRY_BUFFER_SECONDS, 0) * 1000;
+        this.tokenExpiresAt = Date.now() + expiresInMs;
+    }
+}
+//# sourceMappingURL=auth.js.map

package/dist/omadaClient/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth.js","sourceRoot":"","sources":["../../src/omadaClient/auth.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,MAAM,2BAA2B,GAAG,EAAE,CAAC;AAEvC;;GAEG;AACH,MAAM,OAAO,WAAW;IAQC;IACA;IACA;IACA;IAVb,WAAW,CAAU;IAErB,YAAY,CAAU;IAEtB,cAAc,CAAU;IAEhC,YACqB,IAAmB,EACnB,QAAgB,EAChB,YAAoB,EACpB,QAAgB;QAHhB,SAAI,GAAJ,IAAI,CAAe;QACnB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,iBAAY,GAAZ,YAAY,CAAQ;QACpB,aAAQ,GAAR,QAAQ,CAAQ;IAClC,CAAC;IAEJ;;OAEG;IACI,KAAK,CAAC,cAAc;QACvB,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,UAAU;QACb,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAC7B,IAAI,CAAC,YAAY,GAAG,SAAS,CAAC;QAC9B,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;IACpC,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,iBAAiB;QAC3B,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;YAC9E,OAAO;QACX,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,IAAI,CAAC;gBACD,MAAM,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;gBACzC,OAAO;YACX,CAAC;YAAC,MAAM,CAAC;gBACL,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,CAAC;QACL,CAAC;QAED,MAAM,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,YAAY,CAAC,SAAiD;QACxE,MAAM,MAAM,GAA2B,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;QACjE,MAAM,IAAI,GAA2B;YACjC,SAAS,EAAE,IAAI,CAAC,QAAQ;YACxB,aAAa,EAAE,IAAI,CAAC,YAAY;SACnC,CAAC;QAEF,IAAI,SAAS,KAAK,oBAAoB,EAAE,CAAC;YACrC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QAClC,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBACrB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;YAC9E,CAAC;YAED,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QAC7C,CAAC;QAED,IAAI,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,CAAgC,0BAA0B,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YAEnH,IAAI,IAAI,CAAC,SAAS,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,CAAC,KAAK,CAAC,4BAA4B,EAAE;oBACvC,SAAS,EAAE,IAAI,CAAC,SAAS;oBACzB,OAAO,EAAE,IAAI,CAAC,GAAG;iBACpB,CAAC,CAAC;gBACH,MAAM,IAAI,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,6BAA6B,CAAC,CAAC;YAC/D,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,IAAK,EAAkB,CAAC;YACjD,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACzB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CAAC,6BAA6B,EAAE;gBACxC,SAAS;gBACT,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO;gBACnC,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;aAChE,CAAC,CAAC;YACH,MAAM,KAAK,CAAC;QAChB,CAAC;IACL,CAAC;IAED;;OAEG;IACK,QAAQ,CAAC,KAAkB;QAC/B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,CAAC;QAEvC,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAChF,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,gBAAgB,GAAG,2BAA2B,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;QACvF,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,CAAC;IACnD,CAAC;CACJ"}

package/dist/omadaClient/client.d.ts

@@ -0,0 +1,113 @@
+import type { ActiveClientInfo, ClientActivity, ClientPastConnection, ClientRateLimitSetting, CustomHeaders, GetClientActivityOptions, ListClientsPastConnectionsOptions, OmadaClientInfo, RateLimitProfile } from '../types/index.js';
+import type { RequestHandler } from './request.js';
+import type { SiteOperations } from './site.js';
+/**
+ * Client-related operations for the Omada API.
+ */
+export declare class ClientOperations {
+    private readonly request;
+    private readonly site;
+    private readonly buildPath;
+    constructor(request: RequestHandler, site: SiteOperations, buildPath: (path: string) => string);
+    /**
+     * List all clients in a site.
+     */
+    listClients(siteId?: string, customHeaders?: CustomHeaders): Promise<OmadaClientInfo[]>;
+    /**
+     * Get a specific client by MAC address or client ID.
+     */
+    getClient(identifier: string, siteId?: string, customHeaders?: CustomHeaders): Promise<OmadaClientInfo | undefined>;
+    /**
+     * Get most active clients in a site (dashboard endpoint).
+     * Returns clients sorted by total traffic.
+     *
+     * @param siteId - Optional site ID, uses default from config if not provided
+     * @returns Array of active client information
+     */
+    listMostActiveClients(siteId?: string, customHeaders?: CustomHeaders): Promise<ActiveClientInfo[]>;
+    /**
+     * Get client activity statistics over time (dashboard endpoint).
+     * Returns time-series data about new, active, and disconnected clients.
+     *
+     * @param options - Options including optional siteId, start, and end timestamps
+     * @returns Array of client activity snapshots over time
+     */
+    listClientsActivity(options?: GetClientActivityOptions, customHeaders?: CustomHeaders): Promise<ClientActivity[]>;
+    /**
+     * Get client past connection list (insight endpoint).
+     * Returns historical client connection data with support for pagination, filtering, and sorting.
+     *
+     * @param options - Options including siteId, pagination, filters, and search parameters
+     * @returns Array of client past connection information
+     */
+    listClientsPastConnections(options: ListClientsPastConnectionsOptions, customHeaders?: CustomHeaders): Promise<ClientPastConnection[]>;
+    /**
+     * Get rate limit profile list for a site.
+     * Returns available rate limit profiles that can be applied to clients.
+     *
+     * @param siteId - Optional site ID, uses default from config if not provided
+     * @returns Array of rate limit profiles
+     */
+    getRateLimitProfiles(siteId?: string, customHeaders?: CustomHeaders): Promise<RateLimitProfile[]>;
+    /**
+     * Set custom rate limit for a client.
+     * Configures download and upload bandwidth limits directly without using a profile.
+     *
+     * @param clientMac - MAC address of the client
+     * @param downLimit - Download limit in Kbps
+     * @param upLimit - Upload limit in Kbps
+     * @param siteId - Optional site ID, uses default from config if not provided
+     * @returns Updated rate limit setting
+     */
+    setClientRateLimit(clientMac: string, downLimit: number, upLimit: number, siteId?: string, customHeaders?: CustomHeaders): Promise<ClientRateLimitSetting>;
+    /**
+     * Set rate limit profile for a client.
+     * Applies a predefined rate limit profile to the client.
+     *
+     * @param clientMac - MAC address of the client
+     * @param profileId - Rate limit profile ID
+     * @param siteId - Optional site ID, uses default from config if not provided
+     * @returns Updated rate limit setting
+     */
+    setClientRateLimitProfile(clientMac: string, profileId: string, siteId?: string, customHeaders?: CustomHeaders): Promise<ClientRateLimitSetting>;
+    /**
+     * Disable rate limit for a client.
+     * Removes any rate limiting applied to the client.
+     *
+     * @param clientMac - MAC address of the client
+     * @param siteId - Optional site ID, uses default from config if not provided
+     * @returns Updated rate limit setting
+     */
+    disableClientRateLimit(clientMac: string, siteId?: string, customHeaders?: CustomHeaders): Promise<ClientRateLimitSetting>;
+    /**
+     * Get full detail for a single client by MAC address.
+     * OperationId: getClientDetail
+     */
+    getClientDetail(clientMac: string, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+    /**
+     * Get historical known clients list (paginated).
+     * OperationId: getGridKnownClients
+     */
+    getGridKnownClients(page: number, pageSize: number, options?: {
+        sortLastSeen?: string;
+        timeStart?: string;
+        timeEnd?: string;
+        guest?: string;
+        searchKey?: string;
+    }, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+    /**
+     * Get per-client connection history (paginated).
+     * OperationId: getGridClientHistory
+     */
+    getGridClientHistory(clientMac: string, page: number, pageSize: number, searchKey?: string, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+    /**
+     * Get client count distribution by type/band.
+     * OperationId: getClientsDistribution
+     */
+    getClientsDistribution(siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+    /**
+     * Get historical client count trend over a time range.
+     * OperationId: getPastClientNum
+     */
+    getPastClientNum(start: number, end: number, siteId?: string, customHeaders?: CustomHeaders): Promise<unknown>;
+}