@matter/protocol 0.16.0-alpha.0-20250809-ee8375bcb → 0.16.0-alpha.0-20250810-5c91a95d2

package/dist/cjs/advertisement/Advertisement.d.ts

@@ -0,0 +1,119 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { Diagnostic } from "#general";
+import type { Advertiser } from "./Advertiser.js";
+import { ServiceDescription } from "./ServiceDescription.js";
+/**
+ * An advertisement for a discrete service.
+ */
+export declare abstract class Advertisement<T extends ServiceDescription = ServiceDescription> {
+    #private;
+    /**
+     * The service advertised.
+     *
+     * This is a unique ID associated with the advertisement.
+     */
+    readonly service: string;
+    /**
+     * The information advertised.
+     */
+    readonly description: T;
+    /**
+     * The {@link Advertiser} that owns this advertisement.
+     */
+    readonly advertiser: Advertiser;
+    /**
+     * Configuration options.
+     */
+    readonly options: Advertisement.Options;
+    constructor(advertiser: Advertiser, service: string, description: T, options?: Advertisement.Options);
+    /**
+     * Begin automatic broadcast.
+     */
+    start(event: Advertiser.BroadcastEvent): void;
+    /**
+     * End automatic broadcast.
+     */
+    stop(): void;
+    /**
+     * Notify the advertiser that a client connection to the advertised service is established.
+     */
+    serviceConnected(): void;
+    /**
+     * Notify the advertiser that there is no client connection to the advertised service.
+     */
+    serviceDisconnected(): void;
+    /**
+     * Close the advertisement but do not wait for the close to finish.
+     *
+     * The advertisement is still tracked by the advertiser until closed.
+     */
+    cancel(): void;
+    /**
+     * Close the advertisement.
+     */
+    close(): Promise<void>;
+    /**
+     * Async setup logic.
+     */
+    protected onCreate(): Promise<void>;
+    /**
+     * Async cleanup logic.
+     */
+    protected onClose(): Promise<void>;
+    /**
+     * Indicates that broadcasts should omit private details.
+     */
+    protected get isPrivacyMasked(): boolean;
+    /**
+     * Implement automatic advertising.
+     */
+    protected abstract run(context: Advertisement.ActivityContext, event: Advertiser.BroadcastEvent): Promise<void>;
+    isCommissioning(): this is Advertisement<ServiceDescription.Commissionable> | Advertisement<ServiceDescription.Commissioner>;
+    isOperational(): this is Advertisement<ServiceDescription.Operational>;
+    /**
+     * Cancel a set of advertisements.
+     */
+    static cancelAll(ads: Iterable<Advertisement>): void;
+    /**
+     * Cancel a set of advertisements and wait for them to complete.
+     */
+    static closeAll(ads: Iterable<Advertisement>): Promise<void>;
+    /**
+     * Identify other advertisers for the same service.  The advertiser will close these automatically.
+     */
+    abstract isDuplicate(other: Advertisement): boolean;
+    /**
+     * Total duration so far.
+     */
+    get duration(): number;
+    /**
+     * True if the advertisement is actively broadcasting.
+     */
+    get isBroadcasting(): boolean;
+    protected dict(values?: Record<string, unknown>): Record<string, unknown> & Diagnostic;
+}
+export declare namespace Advertisement {
+    interface Options {
+        /**
+         * Set this to omit optional details from broadcasts that may affect privacy.
+         *
+         * Per core spec 5.4.2.3.1, the device always omits vendor ID, product ID and extended data during extended
+         * announcement.  Set this value to omit this fields unconditionally.
+         */
+        omitPrivateDetails?: boolean;
+    }
+    interface ActivityContext {
+        /**
+         * Enter cancelable sleep.
+         *
+         * Throws {@link CanceledError} if interrupted.  If thrown from {@link run} this will result in the promise
+         * resolving.
+         */
+        sleep(name: string, intervalMs: number): Promise<void>;
+    }
+}
+//# sourceMappingURL=Advertisement.d.ts.map

package/dist/cjs/advertisement/Advertisement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Advertisement.d.ts","sourceRoot":"","sources":["../../../src/advertisement/Advertisement.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAA6C,UAAU,EAAsC,MAAM,UAAU,CAAC;AAErH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAI7D;;GAEG;AACH,8BAAsB,aAAa,CAAC,CAAC,SAAS,kBAAkB,GAAG,kBAAkB;;IACjF;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;IAExB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;gBAW5B,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa,CAAC,OAAO;IAYpG;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,UAAU,CAAC,cAAc;IAetC;;OAEG;IACH,IAAI;IAKJ;;OAEG;IACH,gBAAgB;IAIhB;;OAEG;IACH,mBAAmB;IAInB;;;;OAIG;IACH,MAAM;IAON;;OAEG;IACH,KAAK;IAuBL;;OAEG;cACa,QAAQ;IASxB;;OAEG;cACa,OAAO;IAEvB;;OAEG;IACH,SAAS,KAAK,eAAe,YAY5B;IAED;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,aAAa,CAAC,eAAe,EAAE,KAAK,EAAE,UAAU,CAAC,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAE/G,eAAe,IAAI,IAAI,IACjB,aAAa,CAAC,kBAAkB,CAAC,cAAc,CAAC,GAChD,aAAa,CAAC,kBAAkB,CAAC,YAAY,CAAC;IAIpD,aAAa,IAAI,IAAI,IAAI,aAAa,CAAC,kBAAkB,CAAC,WAAW,CAAC;IAItE;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ,CAAC,aAAa,CAAC;IAM7C;;OAEG;WACU,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,aAAa,CAAC;IAIlD;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO;IAEnD;;OAEG;IACH,IAAI,QAAQ,WAEX;IAED;;OAEG;IACH,IAAI,cAAc,YAEjB;IAED,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;CAoDlD;AAED,yBAAiB,aAAa,CAAC;IAC3B,UAAiB,OAAO;QACpB;;;;;WAKG;QACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAChC;IAED,UAAiB,eAAe;QAC5B;;;;;WAKG;QACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;KAC1D;CACJ"}

package/dist/cjs/advertisement/Advertisement.js

@@ -0,0 +1,267 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var Advertisement_exports = {};
+__export(Advertisement_exports, {
+  Advertisement: () => Advertisement
+});
+module.exports = __toCommonJS(Advertisement_exports);
+var import_general = require("#general");
+var import_types = require("#types");
+var import_ServiceDescription = require("./ServiceDescription.js");
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const logger = import_general.Logger.get("Advertisement");
+class Advertisement {
+  /**
+   * The service advertised.
+   *
+   * This is a unique ID associated with the advertisement.
+   */
+  service;
+  /**
+   * The information advertised.
+   */
+  description;
+  /**
+   * The {@link Advertiser} that owns this advertisement.
+   */
+  advertiser;
+  /**
+   * Configuration options.
+   */
+  options;
+  #isBroadcasting = false;
+  #closed;
+  #startedAt = import_general.Time.nowMs();
+  /**
+   * Current activity.  This is a promise with helpers for base implementations.
+   */
+  #activity;
+  constructor(advertiser, service, description, options) {
+    this.options = options ?? {};
+    this.service = service;
+    this.advertiser = advertiser;
+    this.description = description;
+    advertiser.advertisements.add(this);
+    this.#start(this.onCreate.bind(this));
+  }
+  /**
+   * Begin automatic broadcast.
+   */
+  start(event) {
+    if (this.#closed) {
+      return;
+    }
+    if (this.isBroadcasting) {
+      return;
+    }
+    this.#start((context) => this.#run(context, event));
+  }
+  /**
+   * End automatic broadcast.
+   */
+  stop() {
+    this.#activity?.cancel();
+    this.#isBroadcasting = false;
+  }
+  /**
+   * Notify the advertiser that a client connection to the advertised service is established.
+   */
+  serviceConnected() {
+  }
+  /**
+   * Notify the advertiser that there is no client connection to the advertised service.
+   */
+  serviceDisconnected() {
+  }
+  /**
+   * Close the advertisement but do not wait for the close to finish.
+   *
+   * The advertisement is still tracked by the advertiser until closed.
+   */
+  cancel() {
+    this.close().catch((e) => {
+      logger.error("Unhandled error closing advertisement for", import_general.Diagnostic.strong(this.service), e);
+    });
+  }
+  /**
+   * Close the advertisement.
+   */
+  close() {
+    if (this.#closed) {
+      return this.#closed;
+    }
+    return this.#closed = this.#close();
+  }
+  async #close() {
+    try {
+      this.#activity?.cancel();
+      await this.#activity;
+      try {
+        await this.onClose();
+      } catch (e) {
+        logger.error("Unhandled error closing advertisement for", import_general.Diagnostic.strong(this.service), e);
+      }
+    } finally {
+      this.advertiser.advertisements.delete(this);
+    }
+  }
+  /**
+   * Async setup logic.
+   */
+  async onCreate() {
+    const duplicates = [...this.advertiser.advertisements].filter(this.isDuplicate.bind(this));
+    if (duplicates.length) {
+      await Advertisement.closeAll(duplicates);
+    }
+  }
+  /**
+   * Async cleanup logic.
+   */
+  async onClose() {
+  }
+  /**
+   * Indicates that broadcasts should omit private details.
+   */
+  get isPrivacyMasked() {
+    if (this.options.omitPrivateDetails) {
+      return true;
+    }
+    if (import_general.Time.nowMs() - this.#startedAt >= import_types.STANDARD_COMMISSIONING_TIMEOUT_S * 1e3) {
+      return true;
+    }
+    return false;
+  }
+  isCommissioning() {
+    return import_ServiceDescription.ServiceDescription.isCommissioning(this.description);
+  }
+  isOperational() {
+    return import_ServiceDescription.ServiceDescription.isOperational(this.description);
+  }
+  /**
+   * Cancel a set of advertisements.
+   */
+  static cancelAll(ads) {
+    for (const ad of ads) {
+      ad.cancel();
+    }
+  }
+  /**
+   * Cancel a set of advertisements and wait for them to complete.
+   */
+  static async closeAll(ads) {
+    await import_general.MatterAggregateError.allSettled([...ads].map((ad) => ad.close()));
+  }
+  /**
+   * Total duration so far.
+   */
+  get duration() {
+    return import_general.Time.nowMs() - this.#startedAt;
+  }
+  /**
+   * True if the advertisement is actively broadcasting.
+   */
+  get isBroadcasting() {
+    return this.#isBroadcasting;
+  }
+  dict(values) {
+    return import_general.Diagnostic.dict({ kind: this.description.kind, service: this.service, ...values });
+  }
+  #start(executor) {
+    const previous = this.#activity;
+    previous?.cancel();
+    this.#activity = new ActivityContext(async (context) => {
+      if (previous) {
+        await previous;
+      }
+      try {
+        await executor(context);
+      } finally {
+        if (this.#activity === context) {
+          this.#activity = void 0;
+        }
+      }
+    });
+  }
+  async #run(context, event, previous) {
+    if (previous) {
+      await previous;
+    }
+    logger.debug("Begin auto broadcast", this.dict());
+    try {
+      this.#isBroadcasting = true;
+      await this.run(context, event);
+    } catch (e) {
+      if (!(e instanceof import_general.CanceledError)) {
+        logger.error("Unhandled error during automatic advertisement for", import_general.Diagnostic.strong(this.service), e);
+      }
+    } finally {
+      if (this.#activity === context) {
+        this.#isBroadcasting = false;
+      }
+    }
+    logger.debug("End auto broadcast", this.dict());
+  }
+}
+class ActivityContext extends import_general.CancelablePromise {
+  #sleep;
+  #cancelReason;
+  constructor(executor) {
+    let resolve, reject;
+    super((res, rej) => {
+      resolve = res;
+      reject = rej;
+    });
+    executor(this).then(resolve, (cause) => {
+      if (cause instanceof import_general.CanceledError) {
+        resolve();
+      } else {
+        reject(cause);
+      }
+    });
+  }
+  sleep(name, intervalMs) {
+    this.abortIfCanceled();
+    const sleep = import_general.Time.sleep(name, intervalMs).finally(() => {
+      if (this.#sleep === sleep) {
+        this.#sleep = void 0;
+      }
+    });
+    this.#sleep = sleep;
+    return sleep;
+  }
+  abortIfCanceled() {
+    if (this.#cancelReason) {
+      throw this.#cancelReason;
+    }
+  }
+  onCancel(reason) {
+    if (this.#cancelReason) {
+      return;
+    }
+    this.#cancelReason = (0, import_general.asError)(reason);
+    if (this.#sleep) {
+      this.#sleep.cancel(reason);
+    }
+  }
+}
+//# sourceMappingURL=Advertisement.js.map

package/dist/cjs/advertisement/Advertisement.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/advertisement/Advertisement.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,qBAA0G;AAC1G,mBAAiD;AAEjD,gCAAmC;AATnC;AAAA;AAAA;AAAA;AAAA;AAWA,MAAM,SAAS,sBAAO,IAAI,eAAe;AAKlC,MAAe,cAAiE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM1E;AAAA;AAAA;AAAA;AAAA,EAKA;AAAA;AAAA;AAAA;AAAA,EAKA;AAAA;AAAA;AAAA;AAAA,EAKA;AAAA,EAET,kBAAkB;AAAA,EAClB;AAAA,EACA,aAAa,oBAAK,MAAM;AAAA;AAAA;AAAA;AAAA,EAKxB;AAAA,EAEA,YAAY,YAAwB,SAAiB,aAAgB,SAAiC;AAClG,SAAK,UAAU,WAAW,CAAC;AAC3B,SAAK,UAAU;AACf,SAAK,aAAa;AAClB,SAAK,cAAc;AAEnB,eAAW,eAAe,IAAI,IAAI;AAGlC,SAAK,OAAO,KAAK,SAAS,KAAK,IAAI,CAAC;AAAA,EACxC;AAAA;AAAA;AAAA;AAAA,EAKA,MAAM,OAAkC;AACpC,QAAI,KAAK,SAAS;AACd;AAAA,IACJ;AAIA,QAAI,KAAK,gBAAgB;AACrB;AAAA,IACJ;AAGA,SAAK,OAAO,aAAW,KAAK,KAAK,SAAS,KAAK,CAAC;AAAA,EACpD;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO;AACH,SAAK,WAAW,OAAO;AACvB,SAAK,kBAAkB;AAAA,EAC3B;AAAA;AAAA;AAAA;AAAA,EAKA,mBAAmB;AAAA,EAEnB;AAAA;AAAA;AAAA;AAAA,EAKA,sBAAsB;AAAA,EAEtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS;AACL,SAAK,MAAM,EAAE,MAAM,OAAK;AAEpB,aAAO,MAAM,6CAA6C,0BAAW,OAAO,KAAK,OAAO,GAAG,CAAC;AAAA,IAChG,CAAC;AAAA,EACL;AAAA;AAAA;AAAA;AAAA,EAKA,QAAQ;AACJ,QAAI,KAAK,SAAS;AACd,aAAO,KAAK;AAAA,IAChB;AAEA,WAAQ,KAAK,UAAU,KAAK,OAAO;AAAA,EACvC;AAAA,EAEA,MAAM,SAAS;AACX,QAAI;AACA,WAAK,WAAW,OAAO;AACvB,YAAM,KAAK;AAEX,UAAI;AACA,cAAM,KAAK,QAAQ;AAAA,MACvB,SAAS,GAAG;AACR,eAAO,MAAM,6CAA6C,0BAAW,OAAO,KAAK,OAAO,GAAG,CAAC;AAAA,MAChG;AAAA,IACJ,UAAE;AACE,WAAK,WAAW,eAAe,OAAO,IAAI;AAAA,IAC9C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,MAAgB,WAAW;AAGvB,UAAM,aAAa,CAAC,GAAG,KAAK,WAAW,cAAc,EAAE,OAAO,KAAK,YAAY,KAAK,IAAI,CAAC;AACzF,QAAI,WAAW,QAAQ;AACnB,YAAM,cAAc,SAAS,UAAU;AAAA,IAC3C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,MAAgB,UAAU;AAAA,EAAC;AAAA;AAAA;AAAA;AAAA,EAK3B,IAAc,kBAAkB;AAE5B,QAAI,KAAK,QAAQ,oBAAoB;AACjC,aAAO;AAAA,IACX;AAGA,QAAI,oBAAK,MAAM,IAAI,KAAK,cAAc,gDAAmC,KAAM;AAC3E,aAAO;AAAA,IACX;AAEA,WAAO;AAAA,EACX;AAAA,EAOA,kBAEqD;AACjD,WAAO,6CAAmB,gBAAgB,KAAK,WAAW;AAAA,EAC9D;AAAA,EAEA,gBAAuE;AACnE,WAAO,6CAAmB,cAAc,KAAK,WAAW;AAAA,EAC5D;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,UAAU,KAA8B;AAC3C,eAAW,MAAM,KAAK;AAClB,SAAG,OAAO;AAAA,IACd;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,aAAa,SAAS,KAA8B;AAChD,UAAM,oCAAqB,WAAW,CAAC,GAAG,GAAG,EAAE,IAAI,QAAM,GAAG,MAAM,CAAC,CAAC;AAAA,EACxE;AAAA;AAAA;AAAA;AAAA,EAUA,IAAI,WAAW;AACX,WAAO,oBAAK,MAAM,IAAI,KAAK;AAAA,EAC/B;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,iBAAiB;AACjB,WAAO,KAAK;AAAA,EAChB;AAAA,EAEU,KAAK,QAAkC;AAC7C,WAAO,0BAAW,KAAK,EAAE,MAAM,KAAK,YAAY,MAAM,SAAS,KAAK,SAAS,GAAG,OAAO,CAAC;AAAA,EAC5F;AAAA,EAEA,OAAO,UAAuD;AAE1D,UAAM,WAAW,KAAK;AACtB,cAAU,OAAO;AAEjB,SAAK,YAAY,IAAI,gBAAgB,OAAM,YAAW;AAElD,UAAI,UAAU;AACV,cAAM;AAAA,MACV;AAGA,UAAI;AACA,cAAM,SAAS,OAAO;AAAA,MAC1B,UAAE;AAEE,YAAI,KAAK,cAAc,SAAS;AAC5B,eAAK,YAAY;AAAA,QACrB;AAAA,MACJ;AAAA,IACJ,CAAC;AAAA,EACL;AAAA,EAEA,MAAM,KAAK,SAA0B,OAAkC,UAA4B;AAE/F,QAAI,UAAU;AACV,YAAM;AAAA,IACV;AAEA,WAAO,MAAM,wBAAwB,KAAK,KAAK,CAAC;AAGhD,QAAI;AACA,WAAK,kBAAkB;AACvB,YAAM,KAAK,IAAI,SAAS,KAAK;AAAA,IACjC,SAAS,GAAG;AACR,UAAI,EAAE,aAAa,+BAAgB;AAC/B,eAAO,MAAM,sDAAsD,0BAAW,OAAO,KAAK,OAAO,GAAG,CAAC;AAAA,MACzG;AAAA,IACJ,UAAE;AACE,UAAI,KAAK,cAAc,SAAS;AAE5B,aAAK,kBAAkB;AAAA,MAC3B;AAAA,IACJ;AAEA,WAAO,MAAM,sBAAsB,KAAK,KAAK,CAAC;AAAA,EAClD;AACJ;AAwBA,MAAM,wBAAwB,iCAA2D;AAAA,EACrF;AAAA,EACA;AAAA,EAEA,YAAY,UAAuD;AAC/D,QAAI,SAAS;AACb,UAAM,CAAC,KAAK,QAAQ;AAChB,gBAAU;AACV,eAAS;AAAA,IACb,CAAC;AAED,aAAS,IAAI,EAAE,KAAK,SAAS,WAAS;AAClC,UAAI,iBAAiB,8BAAe;AAChC,gBAAS;AAAA,MACb,OAAO;AACH,eAAQ,KAAK;AAAA,MACjB;AAAA,IACJ,CAAC;AAAA,EACL;AAAA,EAEA,MAAM,MAAc,YAAoB;AACpC,SAAK,gBAAgB;AAErB,UAAM,QAAQ,oBAAK,MAAM,MAAM,UAAU,EAAE,QAAQ,MAAM;AACrD,UAAI,KAAK,WAAW,OAAO;AACvB,aAAK,SAAS;AAAA,MAClB;AAAA,IACJ,CAAC;AAED,SAAK,SAAS;AACd,WAAO;AAAA,EACX;AAAA,EAEU,kBAAkB;AACxB,QAAI,KAAK,eAAe;AACpB,YAAM,KAAK;AAAA,IACf;AAAA,EACJ;AAAA,EAEmB,SAAS,QAAiB;AACzC,QAAI,KAAK,eAAe;AACpB;AAAA,IACJ;AACA,SAAK,oBAAgB,wBAAQ,MAAM;AAEnC,QAAI,KAAK,QAAQ;AACb,WAAK,OAAO,OAAO,MAAM;AAAA,IAC7B;AAAA,EACJ;AACJ;",
+  "names": []
+}

package/dist/cjs/advertisement/Advertiser.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { Fabric } from "#fabric/Fabric.js";
+import { Advertisement } from "./Advertisement.js";
+import type { ServiceDescription } from "./ServiceDescription.js";
+/**
+ * A component that advertises a Matter service.
+ */
+export declare abstract class Advertiser {
+    #private;
+    /**
+     * Begin advertising on configured schedule.
+     *
+     * Note that so long as the advertisement is installed the device will continue to respond to MDNS queries even if
+     * the advertisement schedule is elapsed.
+     *
+     * Returns undefined if the advertiser does not support this type of advertisement.
+     */
+    advertise(description: ServiceDescription, event: Advertiser.BroadcastEvent): Advertisement | undefined;
+    /**
+     * Create a new advertiser or retrieve existing advertiser.
+     */
+    protected abstract getAdvertisement(description: ServiceDescription): Advertisement | undefined;
+    /**
+     * Destroy the instance.
+     */
+    close(): Promise<void>;
+    /**
+     * The set of advertisements active for this advertiser.
+     */
+    get advertisements(): Set<Advertisement<ServiceDescription>>;
+    /**
+     * Obtain the active advertisement for {@link fabric}, if any.
+     */
+    advertisementForFabric(fabric: Fabric): Advertisement<ServiceDescription.Operational> | undefined;
+    /**
+     * Select advertisements using a predicate.
+     */
+    filter(predicate: (ad: Advertisement) => boolean): Advertisement<ServiceDescription>[];
+}
+export declare namespace Advertiser {
+    /**
+     * A hint for scheduling regarding why broadcast is initiated.
+     */
+    type BroadcastEvent = "startup" | "reconnect" | "retransmit";
+}
+//# sourceMappingURL=Advertiser.d.ts.map

package/dist/cjs/advertisement/Advertiser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Advertiser.d.ts","sourceRoot":"","sources":["../../../src/advertisement/Advertiser.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAElE;;GAEG;AACH,8BAAsB,UAAU;;IAI5B;;;;;;;OAOG;IACH,SAAS,CAAC,WAAW,EAAE,kBAAkB,EAAE,KAAK,EAAE,UAAU,CAAC,cAAc,GAAG,aAAa,GAAG,SAAS;IAavG;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,gBAAgB,CAAC,WAAW,EAAE,kBAAkB,GAAG,aAAa,GAAG,SAAS;IAE/F;;OAEG;IACG,KAAK;IAKX;;OAEG;IACH,IAAI,cAAc,2CAEjB;IAED;;OAEG;IACH,sBAAsB,CAAC,MAAM,EAAE,MAAM;IAQrC;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,aAAa,KAAK,OAAO;CAGnD;AAED,yBAAiB,UAAU,CAAC;IACxB;;OAEG;IACH,KAAY,cAAc,GAAG,SAAS,GAAG,WAAW,GAAG,YAAY,CAAC;CACvE"}

package/dist/cjs/advertisement/Advertiser.js

@@ -0,0 +1,81 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var Advertiser_exports = {};
+__export(Advertiser_exports, {
+  Advertiser: () => Advertiser
+});
+module.exports = __toCommonJS(Advertiser_exports);
+var import_Advertisement = require("./Advertisement.js");
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+class Advertiser {
+  #advertisements = /* @__PURE__ */ new Set();
+  #isClosed = false;
+  /**
+   * Begin advertising on configured schedule.
+   *
+   * Note that so long as the advertisement is installed the device will continue to respond to MDNS queries even if
+   * the advertisement schedule is elapsed.
+   *
+   * Returns undefined if the advertiser does not support this type of advertisement.
+   */
+  advertise(description, event) {
+    if (this.#isClosed) {
+      return;
+    }
+    const ad = this.getAdvertisement(description);
+    if (ad) {
+      ad.start(event);
+    }
+    return ad;
+  }
+  /**
+   * Destroy the instance.
+   */
+  async close() {
+    this.#isClosed = true;
+    await import_Advertisement.Advertisement.closeAll(this.#advertisements);
+  }
+  /**
+   * The set of advertisements active for this advertiser.
+   */
+  get advertisements() {
+    return this.#advertisements;
+  }
+  /**
+   * Obtain the active advertisement for {@link fabric}, if any.
+   */
+  advertisementForFabric(fabric) {
+    for (const ad of this.#advertisements) {
+      if (ad.isOperational() && ad.description.fabric === fabric) {
+        return ad;
+      }
+    }
+  }
+  /**
+   * Select advertisements using a predicate.
+   */
+  filter(predicate) {
+    return [...this.#advertisements].filter(predicate);
+  }
+}
+//# sourceMappingURL=Advertiser.js.map

package/dist/cjs/advertisement/Advertiser.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/advertisement/Advertiser.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAOA,2BAA8B;AAP9B;AAAA;AAAA;AAAA;AAAA;AAaO,MAAe,WAAW;AAAA,EAC7B,kBAAkB,oBAAI,IAAmB;AAAA,EACzC,YAAY;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUZ,UAAU,aAAiC,OAA6D;AACpG,QAAI,KAAK,WAAW;AAChB;AAAA,IACJ;AAEA,UAAM,KAAK,KAAK,iBAAiB,WAAW;AAC5C,QAAI,IAAI;AACJ,SAAG,MAAM,KAAK;AAAA,IAClB;AAEA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA,EAUA,MAAM,QAAQ;AACV,SAAK,YAAY;AACjB,UAAM,mCAAc,SAAS,KAAK,eAAe;AAAA,EACrD;AAAA;AAAA;AAAA;AAAA,EAKA,IAAI,iBAAiB;AACjB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA,EAKA,uBAAuB,QAAgB;AACnC,eAAW,MAAM,KAAK,iBAAiB;AACnC,UAAI,GAAG,cAAc,KAAK,GAAG,YAAY,WAAW,QAAQ;AACxD,eAAO;AAAA,MACX;AAAA,IACJ;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA,EAKA,OAAO,WAA2C;AAC9C,WAAO,CAAC,GAAG,KAAK,eAAe,EAAE,OAAO,SAAS;AAAA,EACrD;AACJ;",
+  "names": []
+}

package/dist/cjs/advertisement/CommissioningMode.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export declare enum CommissioningMode {
+    NotCommissioning = 0,
+    Basic = 1,
+    Enhanced = 2
+}
+//# sourceMappingURL=CommissioningMode.d.ts.map

package/dist/cjs/advertisement/CommissioningMode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CommissioningMode.d.ts","sourceRoot":"","sources":["../../../src/advertisement/CommissioningMode.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,oBAAY,iBAAiB;IACzB,gBAAgB,IAAI;IACpB,KAAK,IAAI;IACT,QAAQ,IAAI;CACf"}

package/dist/cjs/advertisement/CommissioningMode.js

@@ -0,0 +1,35 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var CommissioningMode_exports = {};
+__export(CommissioningMode_exports, {
+  CommissioningMode: () => CommissioningMode
+});
+module.exports = __toCommonJS(CommissioningMode_exports);
+/**
+ * @license
+ * Copyright 2022-2025 Matter.js Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+var CommissioningMode = /* @__PURE__ */ ((CommissioningMode2) => {
+  CommissioningMode2[CommissioningMode2["NotCommissioning"] = 0] = "NotCommissioning";
+  CommissioningMode2[CommissioningMode2["Basic"] = 1] = "Basic";
+  CommissioningMode2[CommissioningMode2["Enhanced"] = 2] = "Enhanced";
+  return CommissioningMode2;
+})(CommissioningMode || {});
+//# sourceMappingURL=CommissioningMode.js.map

package/dist/cjs/advertisement/CommissioningMode.js.map

@@ -0,0 +1,6 @@
+{
+  "version": 3,
+  "sources": ["../../../src/advertisement/CommissioningMode.ts"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAK,oBAAL,kBAAKA,uBAAL;AACH,EAAAA,sCAAA,sBAAmB,KAAnB;AACA,EAAAA,sCAAA,WAAQ,KAAR;AACA,EAAAA,sCAAA,cAAW,KAAX;AAHQ,SAAAA;AAAA,GAAA;",
+  "names": ["CommissioningMode"]
+}