import { ESPCDFAPIResponse, ESPCDFPaginatedAPIResponse, ESPCDFAPIDataResponse, ESPCDFSceneCreateInput, ESPCDFScheduleCreateInput, ESPCDFAutomationCreateInput } from "../../types"; import { ESPCDFGroup } from "../../entities/ESPCDFGroup"; import { ESPCDFNodeInterface } from "./node"; import { ESPCDFNode } from "../../entities/ESPCDFNode"; import { ESPCDFAutomation } from "../../entities/ESPCDFAutomation"; /** * Operation types that can trigger callbacks for groups */ export type ESPCDFGroupOperationType = "getNodes" | "getSubGroups" | "createSubGroup" | "createScene" | "getScenes" | "getSceneCapableDevices" | "createSchedule" | "getSchedules" | "getScheduleCapableDevices" | "createAutomation" | "getAutomations" | "share" | "removeSharingFor" | "transfer" | "getSharingInfo" | "delete" | "updateMetadata" | "updateGroupInfo" | "addNodes" | "removeNodes" | "leave" | "issueUserNoC" | "issueNodeNoC" | "startCommissioning" | "getFabricDetails" | "getNodesWithDetails" | "convertToMatterFabric" | "setParams"; /** * Interface representing a group sharing user information. */ export interface ESPCDFGroupSharingUserInfoInterface { username: string; metadata?: Record; } /** * Interface representing a group sharing information. */ export interface ESPCDFGroupSharingInfoInterface { groupId: string; mutuallyExclusive: boolean; primaryUsers?: ESPCDFGroupSharingUserInfoInterface[]; secondaryUsers?: ESPCDFGroupSharingUserInfoInterface[]; subGroupsInfo?: ESPCDFGroupSharingInfoInterface[]; parentGroupsInfo?: ESPCDFGroupSharingInfoInterface[]; } export interface ESPCDFGroupOperation { createSubGroup(data: Record): Promise; createScene?(sceneData: ESPCDFSceneCreateInput): Promise; getScenes?(group: ESPCDFGroup): Promise; getSceneCapableDevices?(group: ESPCDFGroup): Promise; createSchedule?(scheduleData: ESPCDFScheduleCreateInput): Promise; getSchedules?(group: ESPCDFGroup): Promise; getScheduleCapableDevices?(group: ESPCDFGroup): Promise; createAutomation?(automationData: ESPCDFAutomationCreateInput): Promise; getAutomations?(): Promise>; delete(): Promise; getNodes(): Promise; getSubGroups(): Promise; share(params: Record): Promise; transfer(params: Record): Promise; removeSharingFor(username: string): Promise; getSharingInfo(options: Record): Promise>; updateMetadata(metadata: Record): Promise; updateGroupInfo(updates: Record): Promise; addNodes(nodeIds: string[]): Promise; removeNodes(nodeIds: string[]): Promise; leave(): Promise; /** Fetches and caches fabric credentials (`ESPRMFabric.getFabricDetails`). */ getFabricDetails?(): Promise; /** Converts a RainMaker home to a Matter fabric (`ESPRMGroup.convertToFabric`). */ convertToMatterFabric?(): Promise; /** Issues user NoC for this fabric (`ESPRMFabric.issueUserNoC`). */ issueUserNoC?(): Promise; /** Issues node NoC during commissioning (`ESPRMFabric.issueNodeNoC`). */ issueNodeNoC?(request: ESPCDFIssueNodeNoCRequest): Promise; /** Fabric nodes with full details (`ESPRMFabric.getNodesWithDetails`). */ getNodesWithDetails?(): Promise; /** Starts Matter commissioning (`ESPRMFabric.startCommissioning`). */ startCommissioning?(qrData: string, onProgress?: (message: ESPCDFCommissioningProgress) => void): Promise<() => void>; setParams?(payload: Record>): Promise; } export interface ESPCDFIssueUserNoCResponse { status: string; description: string; certificates?: { groupId: string; matterUserId: string; userNoC: string; }[]; } export interface ESPCDFCommissioningProgress { status?: string; description?: string; } /** Request for {@link ESPCDFGroup.issueNodeNoC} (`ESPRMIssueNodeNoCRequest`). */ export interface ESPCDFIssueNodeNoCRequest { csr: string; tags?: string[]; metadata?: Record; deviceId?: string; } /** * Commissioning handle returned by {@link ESPCDFGroup.issueNodeNoC} * (`ESPRMMatterCommissioningRequest`). */ export interface ESPCDFMatterCommissioningRequest { requestId: string; groupId: string; status: string; description: string; certificates?: unknown[]; confirmMatterNodeCommissioning?(request: Record): Promise; } /** Matter fabric credentials returned by {@link ESPCDFGroup.getFabricDetails} (`ESPRMFabricDetails`). */ export interface ESPCDFMatterFabricDetails { rootCa: string; matterUserId: string; ipk?: string; groupCatIdOperate?: string; groupCatIdAdmin?: string; userCatId?: string; } export interface ESPCDFGroupInterface { identifier: string; name: string; id: string; nodeIds?: string[]; nodeDetails?: ESPCDFNodeInterface[]; subGroups?: ESPCDFGroupInterface[]; isPrimaryUser?: boolean; /** * Normalized user access to this group: RMNG maps SDK `accessType`; classic RM maps from * `isPrimaryUser` (`primary` | `secondary`). RM has no subgroup-share mode. */ accessType?: string; totalNodes?: number; parentId?: string; type?: string; mutuallyExclusive?: boolean; description?: string; metadata?: Record; customData?: Record; isMatter?: boolean; fabricId?: string; fabricDetails?: ESPCDFMatterFabricDetails; operations: ESPCDFGroupOperation; _raw: any; /** * Group-level param publish. */ setParams?(payload: Record>): Promise; }