@fluidframework/container-runtime-definitions 2.41.0-338401 → 2.42.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @fluidframework/container-runtime-definitions
 
+## 2.42.0
+
+Dependency updates only.
+
+## 2.41.0
+
+Dependency updates only.
+
 ## 2.40.0
 
 Dependency updates only.

package/dist/containerExtension.d.ts

@@ -0,0 +1,246 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ILayerCompatDetails } from "@fluid-internal/client-utils";
+import type { IAudience } from "@fluidframework/container-definitions/internal";
+import type { BrandedType, InternalUtilityTypes, ITelemetryBaseLogger, JsonDeserialized, JsonSerializable, Listenable, TypedMessage } from "@fluidframework/core-interfaces/internal";
+import type { IQuorumClients } from "@fluidframework/driver-definitions/internal";
+/**
+ * While connected, the id of a client within a session.
+ *
+ * @internal
+ */
+export type ClientConnectionId = string;
+/**
+ * Common structure between incoming and outgoing extension signals.
+ *
+ * @remarks
+ * Do not use directly, use {@link OutboundExtensionMessage} or {@link InboundExtensionMessage} instead.
+ *
+ * @sealed
+ * @internal
+ */
+export type ExtensionMessage<TMessage extends TypedMessage = {
+    type: string;
+    content: JsonSerializable<unknown> | JsonDeserialized<unknown>;
+}> = TMessage extends TypedMessage ? InternalUtilityTypes.FlattenIntersection<TMessage & {
+    /**
+     * Client ID of the singular client the message is being (or has been) sent to.
+     * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.
+     */
+    targetClientId?: ClientConnectionId;
+}> : never;
+/**
+ * Outgoing extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type OutboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> = ExtensionMessage<{
+    type: TMessage["type"];
+    content: JsonSerializable<TMessage["content"]>;
+}>;
+/**
+ * Brand for value that has not been verified.
+ *
+ * @remarks
+ * Usage:
+ *
+ * - Cast any value to `UnverifiedBrand` using `as unknown as UnverifiedBrand<T>`
+ * when it is not yet confirmed that value is of type `T`.
+ *
+ * - When `T` value is needed, use narrowing type guards to check (preferred)
+ * or cast from `UnverifiedBrand` using `as unknown` when "instance" must
+ * be parsed to `T`.
+ *
+ * @example Example narrowing type guard:
+ * ```typescript
+ * function validateFoo(
+ *   unverified: Foo | (Record<string, unknown> & UnverifiedBrand<Foo>)
+ * ): unverified is Foo {
+ *   return unverified.IFooProvider === unverified;
+ * }
+ * ```
+ *
+ * @sealed
+ * @internal
+ */
+export declare class UnverifiedBrand<T> extends BrandedType<T> {
+    private readonly UnverifiedValue;
+    private constructor();
+}
+/**
+ * Unverified incoming extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type RawInboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> = TMessage extends TypedMessage ? InternalUtilityTypes.FlattenIntersection<ExtensionMessage<{
+    type: string;
+    content: JsonDeserialized<unknown>;
+}> & {
+    /**
+     * The client ID that submitted the message.
+     * For server generated messages the clientId will be null.
+     */
+    clientId: ClientConnectionId | null;
+}> & UnverifiedBrand<TMessage> : never;
+/**
+ * Verified incoming extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type VerifiedInboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> = TMessage extends TypedMessage ? InternalUtilityTypes.FlattenIntersection<ExtensionMessage<{
+    type: TMessage["type"];
+    content: JsonDeserialized<TMessage["content"]>;
+}> & {
+    /**
+     * The client ID that submitted the message.
+     * For server generated messages the clientId will be null.
+     */
+    clientId: ClientConnectionId | null;
+}> : never;
+/**
+ * Incoming extension signal that may be of the known type or has not yet been validated.
+ *
+ * @sealed
+ * @internal
+ */
+export type InboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> = RawInboundExtensionMessage<TMessage> | VerifiedInboundExtensionMessage<TMessage>;
+/**
+ * Runtime properties of an extension.
+ *
+ * @remarks
+ * This is used to coordinate select types that are known only to the extension, but
+ * that host will respect where it calls back or provides extension specific data.
+ *
+ * @internal
+ */
+export interface ExtensionRuntimeProperties {
+    SignalMessages: TypedMessage;
+}
+/**
+ * Defines requirements for a component to register with container as an extension.
+ *
+ * @internal
+ */
+export interface ContainerExtension<TRuntimeProperties extends ExtensionRuntimeProperties, TUseContext extends unknown[] = []> {
+    /**
+     * Notifies the extension of a new use context.
+     *
+     * @param useContext - Context new reference to extension is acquired within.
+     *
+     * @remarks
+     * This is called when a secondary reference to the extension is acquired.
+     * useContext is the array of arguments that would otherwise be passed to
+     * the factory during first acquisition request.
+     */
+    onNewUse(...useContext: TUseContext): void;
+    /**
+     * Callback for signal sent by this extension.
+     *
+     * @param addressChain - Address chain of the signal
+     * @param signalMessage - Signal unverified content and metadata
+     * @param local - True if signal was sent by this client
+     *
+     */
+    processSignal?: (addressChain: string[], signalMessage: InboundExtensionMessage<TRuntimeProperties["SignalMessages"]>, local: boolean) => void;
+}
+/**
+ * Events emitted by the {@link ExtensionHost}.
+ *
+ * @internal
+ */
+export interface ExtensionHostEvents {
+    "disconnected": () => void;
+    "connected": (clientId: ClientConnectionId) => void;
+}
+/**
+ * Defines the runtime aspects an extension may access.
+ *
+ * @remarks
+ * In most cases this is a logical subset of {@link @fluidframework/container-runtime-definitions#IContainerRuntime}.
+ *
+ * @sealed
+ * @internal
+ */
+export interface ExtensionHost<TRuntimeProperties extends ExtensionRuntimeProperties> {
+    readonly isConnected: () => boolean;
+    readonly getClientId: () => ClientConnectionId | undefined;
+    readonly events: Listenable<ExtensionHostEvents>;
+    readonly logger: ITelemetryBaseLogger;
+    readonly supportedFeatures: ILayerCompatDetails["supportedFeatures"];
+    /**
+     * Submits a signal to be sent to other clients.
+     * @param addressChain - Custom address sequence for the signal.
+     * @param message - Custom message content of the signal.
+     *
+     * Upon receipt of signal, {@link ContainerExtension.processSignal} will be called with the same
+     * address and message (less any non-{@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify|JSON.stringify}-able data).
+     */
+    submitAddressedSignal: (addressChain: string[], message: OutboundExtensionMessage<TRuntimeProperties["SignalMessages"]>) => void;
+    /**
+     * The collection of write clients which were connected as of the current sequence number.
+     * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.
+     */
+    getQuorum: () => IQuorumClients;
+    getAudience: () => IAudience;
+}
+/**
+ * Factory method to create an extension instance.
+ *
+ * Any such method provided to {@link ContainerExtensionStore.acquireExtension}
+ * must use the same value for a given {@link ContainerExtensionId} so that an
+ * `instanceof` check may be performed at runtime.
+ *
+ * @typeParam T - Type of extension to create
+ * @typeParam TRuntimeProperties - Extension runtime properties
+ * @typeParam TUseContext - Array of custom use context passed to factory or onNewUse
+ *
+ * @param host - Host runtime for extension to work against
+ * @param useContext - Custom use context for extension.
+ * @returns Record providing:
+ * `interface` instance (type `T`) that is provided to caller of
+ * {@link ContainerExtensionStore.acquireExtension} and
+ * `extension` store/runtime uses to interact with extension.
+ *
+ * @internal
+ */
+export type ContainerExtensionFactory<T, TRuntimeProperties extends ExtensionRuntimeProperties, TUseContext extends unknown[] = []> = new (host: ExtensionHost<TRuntimeProperties>, ...useContext: TUseContext) => {
+    readonly interface: T;
+    readonly extension: ContainerExtension<TRuntimeProperties, TUseContext>;
+};
+/**
+ * Unique identifier for extension
+ *
+ * @remarks
+ * A string known to all clients working with a certain ContainerExtension and unique
+ * among ContainerExtensions. Not `/` may be used in the string. Recommend using
+ * concatenation of: type of unique identifier, `:` (required), and unique identifier.
+ *
+ * @example Examples
+ * ```typescript
+ *   "guid:g0fl001d-1415-5000-c00l-g0fa54g0b1g1"
+ *   "name:@foo-scope_bar:v1"
+ * ```
+ *
+ * @internal
+ */
+export type ContainerExtensionId = `${string}:${string}`;
+/**
+ * @sealed
+ * @internal
+ */
+export interface ContainerExtensionStore {
+    /**
+     * Acquires an extension from store or adds new one.
+     *
+     * @param id - Identifier for the requested extension
+     * @param factory - Factory to create the extension if not found
+     * @returns The extension
+     */
+    acquireExtension<T, TRuntimeProperties extends ExtensionRuntimeProperties, TUseContext extends unknown[] = []>(id: ContainerExtensionId, factory: ContainerExtensionFactory<T, TRuntimeProperties, TUseContext>, ...context: TUseContext): T;
+}
+//# sourceMappingURL=containerExtension.d.ts.map

package/dist/containerExtension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerExtension.d.ts","sourceRoot":"","sources":["../src/containerExtension.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAC;AAEhF,OAAO,KAAK,EACX,WAAW,EACX,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAC;AAElF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAC3B,QAAQ,SAAS,YAAY,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;CAC/D,IAED,QAAQ,SAAS,YAAY,GAC1B,oBAAoB,CAAC,mBAAmB,CACxC,QAAQ,GAAG;IACV;;;OAGG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;CACpC,CACD,GACA,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAChF,gBAAgB,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAAC,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAA;CAAE,CAAC,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,CAAC,CAAC;IAC7D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAI;IACpC,OAAO;CACP;AAED;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAElF,QAAQ,SAAS,YAAY,GAC1B,oBAAoB,CAAC,mBAAmB,CACxC,gBAAgB,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;CACnC,CAAC,GAAG;IACJ;;;OAGG;IAEH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpC,CACD,GACA,eAAe,CAAC,QAAQ,CAAC,GACzB,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAEvF,QAAQ,SAAS,YAAY,GAC1B,oBAAoB,CAAC,mBAAmB,CACxC,gBAAgB,CAAC;IAChB,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvB,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;CAC/C,CAAC,GAAG;IACJ;;;OAGG;IAEH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpC,CACD,GACA,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC7E,0BAA0B,CAAC,QAAQ,CAAC,GACpC,+BAA+B,CAAC,QAAQ,CAAC,CAAC;AAE7C;;;;;;;;GAQG;AACH,MAAM,WAAW,0BAA0B;IAC1C,cAAc,EAAE,YAAY,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAClC,kBAAkB,SAAS,0BAA0B,EACrD,WAAW,SAAS,OAAO,EAAE,GAAG,EAAE;IAElC;;;;;;;;;OASG;IACH,QAAQ,CAAC,GAAG,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAE3C;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,CACf,YAAY,EAAE,MAAM,EAAE,EACtB,aAAa,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,EAC5E,KAAK,EAAE,OAAO,KACV,IAAI,CAAC;CACV;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,WAAW,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAC;CACpD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa,CAAC,kBAAkB,SAAS,0BAA0B;IACnF,QAAQ,CAAC,WAAW,EAAE,MAAM,OAAO,CAAC;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,kBAAkB,GAAG,SAAS,CAAC;IAE3D,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAEjD,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC,QAAQ,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;IAErE;;;;;;;OAOG;IACH,qBAAqB,EAAE,CACtB,YAAY,EAAE,MAAM,EAAE,EACtB,OAAO,EAAE,wBAAwB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,KACnE,IAAI,CAAC;IAEV;;;OAGG;IACH,SAAS,EAAE,MAAM,cAAc,CAAC;IAEhC,WAAW,EAAE,MAAM,SAAS,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,yBAAyB,CACpC,CAAC,EACD,kBAAkB,SAAS,0BAA0B,EACrD,WAAW,SAAS,OAAO,EAAE,GAAG,EAAE,IAC/B,KACH,IAAI,EAAE,aAAa,CAAC,kBAAkB,CAAC,EACvC,GAAG,UAAU,EAAE,WAAW,KACtB;IACJ,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,oBAAoB,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;OAMG;IACH,gBAAgB,CACf,CAAC,EACD,kBAAkB,SAAS,0BAA0B,EACrD,WAAW,SAAS,OAAO,EAAE,GAAG,EAAE,EAElC,EAAE,EAAE,oBAAoB,EACxB,OAAO,EAAE,yBAAyB,CAAC,CAAC,EAAE,kBAAkB,EAAE,WAAW,CAAC,EACtE,GAAG,OAAO,EAAE,WAAW,GACrB,CAAC,CAAC;CACL"}

package/dist/containerRuntime.d.ts

@@ -9,6 +9,7 @@ import type { IFluidHandleContext } from "@fluidframework/core-interfaces/intern
 import type { IClientDetails } from "@fluidframework/driver-definitions";
 import type { IDocumentStorageService, IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
 import type { FlushMode, IContainerRuntimeBase, IContainerRuntimeBaseEvents, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions/internal";
+import type { ContainerExtensionStore } from "./containerExtension.js";
 /**
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
  * @legacy
@@ -150,4 +151,11 @@ export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, ICont
      */
     getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
 }
+/**
+ * Represents the internal version of the runtime of the container.
+ *
+ * @internal
+ */
+export interface IContainerRuntimeInternal extends IContainerRuntime, ContainerExtensionStore {
+}
 //# sourceMappingURL=containerRuntime.d.ts.map

package/dist/containerRuntime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EACX,uBAAuB,EACvB,gBAAgB,EAChB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EACX,SAAS,EACT,qBAAqB,EACrB,2BAA2B,EAC3B,8BAA8B,EAC9B,MAAM,8CAA8C,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,6CAA8C,SAAQ,iBAAiB;IACvF,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAClD,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAChB,SAAQ,2BAA2B,EAClC,iBAAiB;IAClB,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,GAAG,OAAO,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC/E,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB;AAC/B;;GAEG;AACD,iBAAiB;AACnB;;GAEG;GACD,oBAAoB;AACtB;;;;;GAKG;GACD,kBAAkB;AACpB;;GAEG;GACD,kBAAkB;AACpB;;GAEG;GACD,8BAA8B;AAChC;;GAEG;GACD,qBAAqB;AACvB;;;GAGG;GACD,yBAAyB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC7C,yBAAyB,EAAE,MAAM,CAAC;IAClC,4BAA4B,EAAE,MAAM,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,MAAM;IAChD,CACC,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,oBAAoB,GAAG,6BAA6B,KAAK,IAAI,OAC9E;IACF,CACC,KAAK,EAAE,4BAA4B,EACnC,QAAQ,EAAE,CACT,KAAK,EAAE,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,GAAG,6BAA6B,KACvE,IAAI,OACR;IACF,CACC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,EAAE,CAET,KAAK,EAAE;QAAE,UAAU,EAAE,oBAAoB,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,6BAA6B,KACpF,IAAI,OACR;IACF,CACC,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,6BAA6B,KAAK,IAAI,OAChF;IACF,CACC,KAAK,EAAE,yBAAyB,EAChC,QAAQ,EAAE,CACT,KAAK,EAAE;QAAE,MAAM,EAAE,oBAAoB,CAAA;KAAE,GAAG,6BAA6B,KACnE,IAAI,OACR;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,iBAChB,SAAQ,8BAA8B,EACrC,uCAAuC;IAExC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACjE"}
+{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EACX,uBAAuB,EACvB,gBAAgB,EAChB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EACX,SAAS,EACT,qBAAqB,EACrB,2BAA2B,EAC3B,8BAA8B,EAC9B,MAAM,8CAA8C,CAAC;AAEtD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;;GAIG;AACH,MAAM,WAAW,6CAA8C,SAAQ,iBAAiB;IACvF,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAClD,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAChB,SAAQ,2BAA2B,EAClC,iBAAiB;IAClB,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,GAAG,OAAO,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC/E,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB;AAC/B;;GAEG;AACD,iBAAiB;AACnB;;GAEG;GACD,oBAAoB;AACtB;;;;;GAKG;GACD,kBAAkB;AACpB;;GAEG;GACD,kBAAkB;AACpB;;GAEG;GACD,8BAA8B;AAChC;;GAEG;GACD,qBAAqB;AACvB;;;GAGG;GACD,yBAAyB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC7C,yBAAyB,EAAE,MAAM,CAAC;IAClC,4BAA4B,EAAE,MAAM,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,MAAM;IAChD,CACC,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,oBAAoB,GAAG,6BAA6B,KAAK,IAAI,OAC9E;IACF,CACC,KAAK,EAAE,4BAA4B,EACnC,QAAQ,EAAE,CACT,KAAK,EAAE,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,GAAG,6BAA6B,KACvE,IAAI,OACR;IACF,CACC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,EAAE,CAET,KAAK,EAAE;QAAE,UAAU,EAAE,oBAAoB,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,6BAA6B,KACpF,IAAI,OACR;IACF,CACC,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,6BAA6B,KAAK,IAAI,OAChF;IACF,CACC,KAAK,EAAE,yBAAyB,EAChC,QAAQ,EAAE,CACT,KAAK,EAAE;QAAE,MAAM,EAAE,oBAAoB,CAAA;KAAE,GAAG,6BAA6B,KACnE,IAAI,OACR;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,iBAChB,SAAQ,8BAA8B,EACrC,uCAAuC;IAExC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACjE;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAChB,SAAQ,iBAAiB,EACxB,uBAAuB;CAAG"}

package/dist/index.d.ts

@@ -2,5 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export type { IContainerRuntime, IContainerRuntimeBaseWithCombinedEvents, IContainerRuntimeEvents, IContainerRuntimeWithResolveHandle_Deprecated, SummarizerStopReason, ISummarizeEventProps, ISummarizerObservabilityProps, ISummarizerEvents, } from "./containerRuntime.js";
+export type { ClientConnectionId, ContainerExtensionFactory, ContainerExtensionId, ContainerExtensionStore, ContainerExtension, ExtensionHost, ExtensionHostEvents, ExtensionMessage, ExtensionRuntimeProperties, InboundExtensionMessage, OutboundExtensionMessage, RawInboundExtensionMessage, UnverifiedBrand, VerifiedInboundExtensionMessage, } from "./containerExtension.js";
+export type { IContainerRuntime, IContainerRuntimeBaseWithCombinedEvents, IContainerRuntimeEvents, IContainerRuntimeInternal, IContainerRuntimeWithResolveHandle_Deprecated, SummarizerStopReason, ISummarizeEventProps, ISummarizerObservabilityProps, ISummarizerEvents, } from "./containerRuntime.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,iBAAiB,EACjB,uCAAuC,EACvC,uBAAuB,EACvB,6CAA6C,EAC7C,oBAAoB,EACpB,oBAAoB,EACpB,6BAA6B,EAC7B,iBAAiB,GACjB,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,kBAAkB,EAClB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,eAAe,EACf,+BAA+B,GAC/B,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACX,iBAAiB,EACjB,uCAAuC,EACvC,uBAAuB,EACvB,yBAAyB,EACzB,6CAA6C,EAC7C,oBAAoB,EACpB,oBAAoB,EACpB,6BAA6B,EAC7B,iBAAiB,GACjB,MAAM,uBAAuB,CAAC"}

package/lib/containerExtension.d.ts

@@ -0,0 +1,246 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { ILayerCompatDetails } from "@fluid-internal/client-utils";
+import type { IAudience } from "@fluidframework/container-definitions/internal";
+import type { BrandedType, InternalUtilityTypes, ITelemetryBaseLogger, JsonDeserialized, JsonSerializable, Listenable, TypedMessage } from "@fluidframework/core-interfaces/internal";
+import type { IQuorumClients } from "@fluidframework/driver-definitions/internal";
+/**
+ * While connected, the id of a client within a session.
+ *
+ * @internal
+ */
+export type ClientConnectionId = string;
+/**
+ * Common structure between incoming and outgoing extension signals.
+ *
+ * @remarks
+ * Do not use directly, use {@link OutboundExtensionMessage} or {@link InboundExtensionMessage} instead.
+ *
+ * @sealed
+ * @internal
+ */
+export type ExtensionMessage<TMessage extends TypedMessage = {
+    type: string;
+    content: JsonSerializable<unknown> | JsonDeserialized<unknown>;
+}> = TMessage extends TypedMessage ? InternalUtilityTypes.FlattenIntersection<TMessage & {
+    /**
+     * Client ID of the singular client the message is being (or has been) sent to.
+     * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.
+     */
+    targetClientId?: ClientConnectionId;
+}> : never;
+/**
+ * Outgoing extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type OutboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> = ExtensionMessage<{
+    type: TMessage["type"];
+    content: JsonSerializable<TMessage["content"]>;
+}>;
+/**
+ * Brand for value that has not been verified.
+ *
+ * @remarks
+ * Usage:
+ *
+ * - Cast any value to `UnverifiedBrand` using `as unknown as UnverifiedBrand<T>`
+ * when it is not yet confirmed that value is of type `T`.
+ *
+ * - When `T` value is needed, use narrowing type guards to check (preferred)
+ * or cast from `UnverifiedBrand` using `as unknown` when "instance" must
+ * be parsed to `T`.
+ *
+ * @example Example narrowing type guard:
+ * ```typescript
+ * function validateFoo(
+ *   unverified: Foo | (Record<string, unknown> & UnverifiedBrand<Foo>)
+ * ): unverified is Foo {
+ *   return unverified.IFooProvider === unverified;
+ * }
+ * ```
+ *
+ * @sealed
+ * @internal
+ */
+export declare class UnverifiedBrand<T> extends BrandedType<T> {
+    private readonly UnverifiedValue;
+    private constructor();
+}
+/**
+ * Unverified incoming extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type RawInboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> = TMessage extends TypedMessage ? InternalUtilityTypes.FlattenIntersection<ExtensionMessage<{
+    type: string;
+    content: JsonDeserialized<unknown>;
+}> & {
+    /**
+     * The client ID that submitted the message.
+     * For server generated messages the clientId will be null.
+     */
+    clientId: ClientConnectionId | null;
+}> & UnverifiedBrand<TMessage> : never;
+/**
+ * Verified incoming extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type VerifiedInboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> = TMessage extends TypedMessage ? InternalUtilityTypes.FlattenIntersection<ExtensionMessage<{
+    type: TMessage["type"];
+    content: JsonDeserialized<TMessage["content"]>;
+}> & {
+    /**
+     * The client ID that submitted the message.
+     * For server generated messages the clientId will be null.
+     */
+    clientId: ClientConnectionId | null;
+}> : never;
+/**
+ * Incoming extension signal that may be of the known type or has not yet been validated.
+ *
+ * @sealed
+ * @internal
+ */
+export type InboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> = RawInboundExtensionMessage<TMessage> | VerifiedInboundExtensionMessage<TMessage>;
+/**
+ * Runtime properties of an extension.
+ *
+ * @remarks
+ * This is used to coordinate select types that are known only to the extension, but
+ * that host will respect where it calls back or provides extension specific data.
+ *
+ * @internal
+ */
+export interface ExtensionRuntimeProperties {
+    SignalMessages: TypedMessage;
+}
+/**
+ * Defines requirements for a component to register with container as an extension.
+ *
+ * @internal
+ */
+export interface ContainerExtension<TRuntimeProperties extends ExtensionRuntimeProperties, TUseContext extends unknown[] = []> {
+    /**
+     * Notifies the extension of a new use context.
+     *
+     * @param useContext - Context new reference to extension is acquired within.
+     *
+     * @remarks
+     * This is called when a secondary reference to the extension is acquired.
+     * useContext is the array of arguments that would otherwise be passed to
+     * the factory during first acquisition request.
+     */
+    onNewUse(...useContext: TUseContext): void;
+    /**
+     * Callback for signal sent by this extension.
+     *
+     * @param addressChain - Address chain of the signal
+     * @param signalMessage - Signal unverified content and metadata
+     * @param local - True if signal was sent by this client
+     *
+     */
+    processSignal?: (addressChain: string[], signalMessage: InboundExtensionMessage<TRuntimeProperties["SignalMessages"]>, local: boolean) => void;
+}
+/**
+ * Events emitted by the {@link ExtensionHost}.
+ *
+ * @internal
+ */
+export interface ExtensionHostEvents {
+    "disconnected": () => void;
+    "connected": (clientId: ClientConnectionId) => void;
+}
+/**
+ * Defines the runtime aspects an extension may access.
+ *
+ * @remarks
+ * In most cases this is a logical subset of {@link @fluidframework/container-runtime-definitions#IContainerRuntime}.
+ *
+ * @sealed
+ * @internal
+ */
+export interface ExtensionHost<TRuntimeProperties extends ExtensionRuntimeProperties> {
+    readonly isConnected: () => boolean;
+    readonly getClientId: () => ClientConnectionId | undefined;
+    readonly events: Listenable<ExtensionHostEvents>;
+    readonly logger: ITelemetryBaseLogger;
+    readonly supportedFeatures: ILayerCompatDetails["supportedFeatures"];
+    /**
+     * Submits a signal to be sent to other clients.
+     * @param addressChain - Custom address sequence for the signal.
+     * @param message - Custom message content of the signal.
+     *
+     * Upon receipt of signal, {@link ContainerExtension.processSignal} will be called with the same
+     * address and message (less any non-{@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify|JSON.stringify}-able data).
+     */
+    submitAddressedSignal: (addressChain: string[], message: OutboundExtensionMessage<TRuntimeProperties["SignalMessages"]>) => void;
+    /**
+     * The collection of write clients which were connected as of the current sequence number.
+     * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.
+     */
+    getQuorum: () => IQuorumClients;
+    getAudience: () => IAudience;
+}
+/**
+ * Factory method to create an extension instance.
+ *
+ * Any such method provided to {@link ContainerExtensionStore.acquireExtension}
+ * must use the same value for a given {@link ContainerExtensionId} so that an
+ * `instanceof` check may be performed at runtime.
+ *
+ * @typeParam T - Type of extension to create
+ * @typeParam TRuntimeProperties - Extension runtime properties
+ * @typeParam TUseContext - Array of custom use context passed to factory or onNewUse
+ *
+ * @param host - Host runtime for extension to work against
+ * @param useContext - Custom use context for extension.
+ * @returns Record providing:
+ * `interface` instance (type `T`) that is provided to caller of
+ * {@link ContainerExtensionStore.acquireExtension} and
+ * `extension` store/runtime uses to interact with extension.
+ *
+ * @internal
+ */
+export type ContainerExtensionFactory<T, TRuntimeProperties extends ExtensionRuntimeProperties, TUseContext extends unknown[] = []> = new (host: ExtensionHost<TRuntimeProperties>, ...useContext: TUseContext) => {
+    readonly interface: T;
+    readonly extension: ContainerExtension<TRuntimeProperties, TUseContext>;
+};
+/**
+ * Unique identifier for extension
+ *
+ * @remarks
+ * A string known to all clients working with a certain ContainerExtension and unique
+ * among ContainerExtensions. Not `/` may be used in the string. Recommend using
+ * concatenation of: type of unique identifier, `:` (required), and unique identifier.
+ *
+ * @example Examples
+ * ```typescript
+ *   "guid:g0fl001d-1415-5000-c00l-g0fa54g0b1g1"
+ *   "name:@foo-scope_bar:v1"
+ * ```
+ *
+ * @internal
+ */
+export type ContainerExtensionId = `${string}:${string}`;
+/**
+ * @sealed
+ * @internal
+ */
+export interface ContainerExtensionStore {
+    /**
+     * Acquires an extension from store or adds new one.
+     *
+     * @param id - Identifier for the requested extension
+     * @param factory - Factory to create the extension if not found
+     * @returns The extension
+     */
+    acquireExtension<T, TRuntimeProperties extends ExtensionRuntimeProperties, TUseContext extends unknown[] = []>(id: ContainerExtensionId, factory: ContainerExtensionFactory<T, TRuntimeProperties, TUseContext>, ...context: TUseContext): T;
+}
+//# sourceMappingURL=containerExtension.d.ts.map

package/lib/containerExtension.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerExtension.d.ts","sourceRoot":"","sources":["../src/containerExtension.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gDAAgD,CAAC;AAEhF,OAAO,KAAK,EACX,WAAW,EACX,oBAAoB,EACpB,oBAAoB,EACpB,gBAAgB,EAChB,gBAAgB,EAChB,UAAU,EACV,YAAY,EACZ,MAAM,0CAA0C,CAAC;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,6CAA6C,CAAC;AAElF;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,CAC3B,QAAQ,SAAS,YAAY,GAAG;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;CAC/D,IAED,QAAQ,SAAS,YAAY,GAC1B,oBAAoB,CAAC,mBAAmB,CACxC,QAAQ,GAAG;IACV;;;OAGG;IACH,cAAc,CAAC,EAAE,kBAAkB,CAAC;CACpC,CACD,GACA,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAChF,gBAAgB,CAAC;IAAE,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAAC,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAA;CAAE,CAAC,CAAC;AAE9F;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe,CAAC,CAAC,CAAE,SAAQ,WAAW,CAAC,CAAC,CAAC;IAC7D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAI;IACpC,OAAO;CACP;AAED;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAElF,QAAQ,SAAS,YAAY,GAC1B,oBAAoB,CAAC,mBAAmB,CACxC,gBAAgB,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;CACnC,CAAC,GAAG;IACJ;;;OAGG;IAEH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpC,CACD,GACA,eAAe,CAAC,QAAQ,CAAC,GACzB,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAEvF,QAAQ,SAAS,YAAY,GAC1B,oBAAoB,CAAC,mBAAmB,CACxC,gBAAgB,CAAC;IAChB,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvB,OAAO,EAAE,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;CAC/C,CAAC,GAAG;IACJ;;;OAGG;IAEH,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACpC,CACD,GACA,KAAK,CAAC;AAEV;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,CAAC,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC7E,0BAA0B,CAAC,QAAQ,CAAC,GACpC,+BAA+B,CAAC,QAAQ,CAAC,CAAC;AAE7C;;;;;;;;GAQG;AACH,MAAM,WAAW,0BAA0B;IAC1C,cAAc,EAAE,YAAY,CAAC;CAC7B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAClC,kBAAkB,SAAS,0BAA0B,EACrD,WAAW,SAAS,OAAO,EAAE,GAAG,EAAE;IAElC;;;;;;;;;OASG;IACH,QAAQ,CAAC,GAAG,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAE3C;;;;;;;OAOG;IACH,aAAa,CAAC,EAAE,CACf,YAAY,EAAE,MAAM,EAAE,EACtB,aAAa,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,EAC5E,KAAK,EAAE,OAAO,KACV,IAAI,CAAC;CACV;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IACnC,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,WAAW,EAAE,CAAC,QAAQ,EAAE,kBAAkB,KAAK,IAAI,CAAC;CACpD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa,CAAC,kBAAkB,SAAS,0BAA0B;IACnF,QAAQ,CAAC,WAAW,EAAE,MAAM,OAAO,CAAC;IACpC,QAAQ,CAAC,WAAW,EAAE,MAAM,kBAAkB,GAAG,SAAS,CAAC;IAE3D,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;IAEjD,QAAQ,CAAC,MAAM,EAAE,oBAAoB,CAAC;IAEtC,QAAQ,CAAC,iBAAiB,EAAE,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;IAErE;;;;;;;OAOG;IACH,qBAAqB,EAAE,CACtB,YAAY,EAAE,MAAM,EAAE,EACtB,OAAO,EAAE,wBAAwB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,KACnE,IAAI,CAAC;IAEV;;;OAGG;IACH,SAAS,EAAE,MAAM,cAAc,CAAC;IAEhC,WAAW,EAAE,MAAM,SAAS,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,MAAM,yBAAyB,CACpC,CAAC,EACD,kBAAkB,SAAS,0BAA0B,EACrD,WAAW,SAAS,OAAO,EAAE,GAAG,EAAE,IAC/B,KACH,IAAI,EAAE,aAAa,CAAC,kBAAkB,CAAC,EACvC,GAAG,UAAU,EAAE,WAAW,KACtB;IACJ,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC;IACtB,QAAQ,CAAC,SAAS,EAAE,kBAAkB,CAAC,kBAAkB,EAAE,WAAW,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,oBAAoB,GAAG,GAAG,MAAM,IAAI,MAAM,EAAE,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC;;;;;;OAMG;IACH,gBAAgB,CACf,CAAC,EACD,kBAAkB,SAAS,0BAA0B,EACrD,WAAW,SAAS,OAAO,EAAE,GAAG,EAAE,EAElC,EAAE,EAAE,oBAAoB,EACxB,OAAO,EAAE,yBAAyB,CAAC,CAAC,EAAE,kBAAkB,EAAE,WAAW,CAAC,EACtE,GAAG,OAAO,EAAE,WAAW,GACrB,CAAC,CAAC;CACL"}

package/lib/containerRuntime.d.ts

@@ -9,6 +9,7 @@ import type { IFluidHandleContext } from "@fluidframework/core-interfaces/intern
 import type { IClientDetails } from "@fluidframework/driver-definitions";
 import type { IDocumentStorageService, IDocumentMessage, ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
 import type { FlushMode, IContainerRuntimeBase, IContainerRuntimeBaseEvents, IProvideFluidDataStoreRegistry } from "@fluidframework/runtime-definitions/internal";
+import type { ContainerExtensionStore } from "./containerExtension.js";
 /**
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
  * @legacy
@@ -150,4 +151,11 @@ export interface IContainerRuntime extends IProvideFluidDataStoreRegistry, ICont
      */
     getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
 }
+/**
+ * Represents the internal version of the runtime of the container.
+ *
+ * @internal
+ */
+export interface IContainerRuntimeInternal extends IContainerRuntime, ContainerExtensionStore {
+}
 //# sourceMappingURL=containerRuntime.d.ts.map

package/lib/containerRuntime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EACX,uBAAuB,EACvB,gBAAgB,EAChB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EACX,SAAS,EACT,qBAAqB,EACrB,2BAA2B,EAC3B,8BAA8B,EAC9B,MAAM,8CAA8C,CAAC;AAEtD;;;;GAIG;AACH,MAAM,WAAW,6CAA8C,SAAQ,iBAAiB;IACvF,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAClD,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAChB,SAAQ,2BAA2B,EAClC,iBAAiB;IAClB,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,GAAG,OAAO,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC/E,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB;AAC/B;;GAEG;AACD,iBAAiB;AACnB;;GAEG;GACD,oBAAoB;AACtB;;;;;GAKG;GACD,kBAAkB;AACpB;;GAEG;GACD,kBAAkB;AACpB;;GAEG;GACD,8BAA8B;AAChC;;GAEG;GACD,qBAAqB;AACvB;;;GAGG;GACD,yBAAyB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC7C,yBAAyB,EAAE,MAAM,CAAC;IAClC,4BAA4B,EAAE,MAAM,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,MAAM;IAChD,CACC,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,oBAAoB,GAAG,6BAA6B,KAAK,IAAI,OAC9E;IACF,CACC,KAAK,EAAE,4BAA4B,EACnC,QAAQ,EAAE,CACT,KAAK,EAAE,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,GAAG,6BAA6B,KACvE,IAAI,OACR;IACF,CACC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,EAAE,CAET,KAAK,EAAE;QAAE,UAAU,EAAE,oBAAoB,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,6BAA6B,KACpF,IAAI,OACR;IACF,CACC,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,6BAA6B,KAAK,IAAI,OAChF;IACF,CACC,KAAK,EAAE,yBAAyB,EAChC,QAAQ,EAAE,CACT,KAAK,EAAE;QAAE,MAAM,EAAE,oBAAoB,CAAA;KAAE,GAAG,6BAA6B,KACnE,IAAI,OACR;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,iBAChB,SAAQ,8BAA8B,EACrC,uCAAuC;IAExC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACjE"}
+{"version":3,"file":"containerRuntime.d.ts","sourceRoot":"","sources":["../src/containerRuntime.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACzE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gDAAgD,CAAC;AACpF,OAAO,KAAK,EACX,WAAW,EACX,MAAM,EACN,cAAc,EACd,QAAQ,EACR,SAAS,EACT,MAAM,iCAAiC,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACzE,OAAO,KAAK,EACX,uBAAuB,EACvB,gBAAgB,EAChB,yBAAyB,EACzB,MAAM,6CAA6C,CAAC;AACrD,OAAO,KAAK,EACX,SAAS,EACT,qBAAqB,EACrB,2BAA2B,EAC3B,8BAA8B,EAC9B,MAAM,8CAA8C,CAAC;AAEtD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;;GAIG;AACH,MAAM,WAAW,6CAA8C,SAAQ,iBAAiB;IACvF,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,CAAC;IAClD,aAAa,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAChB,SAAQ,2BAA2B,EAClC,iBAAiB;IAClB,CAAC,KAAK,EAAE,OAAO,GAAG,cAAc,GAAG,OAAO,GAAG,UAAU,EAAE,QAAQ,EAAE,MAAM,IAAI,OAAE;IAC/E,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,OAAE;CAC3D;AAED;;;;GAIG;AACH,MAAM,MAAM,oBAAoB;AAC/B;;GAEG;AACD,iBAAiB;AACnB;;GAEG;GACD,oBAAoB;AACtB;;;;;GAKG;GACD,kBAAkB;AACpB;;GAEG;GACD,kBAAkB;AACpB;;GAEG;GACD,8BAA8B;AAChC;;GAEG;GACD,qBAAqB;AACvB;;;GAGG;GACD,yBAAyB,CAAC;AAE7B;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACpC,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,CAAC;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;IAEpB,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,6BAA6B;IAC7C,yBAAyB,EAAE,MAAM,CAAC;IAClC,4BAA4B,EAAE,MAAM,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAkB,SAAQ,MAAM;IAChD,CACC,KAAK,EAAE,WAAW,EAClB,QAAQ,EAAE,CAAC,KAAK,EAAE,oBAAoB,GAAG,6BAA6B,KAAK,IAAI,OAC9E;IACF,CACC,KAAK,EAAE,4BAA4B,EACnC,QAAQ,EAAE,CACT,KAAK,EAAE,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC,GAAG,6BAA6B,KACvE,IAAI,OACR;IACF,CACC,KAAK,EAAE,gBAAgB,EACvB,QAAQ,EAAE,CAET,KAAK,EAAE;QAAE,UAAU,EAAE,oBAAoB,CAAC;QAAC,KAAK,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,6BAA6B,KACpF,IAAI,OACR;IACF,CACC,KAAK,EAAE,iBAAiB,EACxB,QAAQ,EAAE,CAAC,KAAK,EAAE;QAAE,UAAU,EAAE,MAAM,CAAA;KAAE,GAAG,6BAA6B,KAAK,IAAI,OAChF;IACF,CACC,KAAK,EAAE,yBAAyB,EAChC,QAAQ,EAAE,CACT,KAAK,EAAE;QAAE,MAAM,EAAE,oBAAoB,CAAA;KAAE,GAAG,6BAA6B,KACnE,IAAI,OACR;CACF;AAED;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,GAAG,qBAAqB,GAC1E,cAAc,CAAC,uBAAuB,CAAC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,iBAChB,SAAQ,8BAA8B,EACrC,uCAAuC;IAExC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC;IAC/C,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAC;IACvC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;IAClF,QAAQ,CAAC,OAAO,EAAE,uBAAuB,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACjE;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAChB,SAAQ,iBAAiB,EACxB,uBAAuB;CAAG"}

package/lib/index.d.ts

@@ -2,5 +2,6 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-export type { IContainerRuntime, IContainerRuntimeBaseWithCombinedEvents, IContainerRuntimeEvents, IContainerRuntimeWithResolveHandle_Deprecated, SummarizerStopReason, ISummarizeEventProps, ISummarizerObservabilityProps, ISummarizerEvents, } from "./containerRuntime.js";
+export type { ClientConnectionId, ContainerExtensionFactory, ContainerExtensionId, ContainerExtensionStore, ContainerExtension, ExtensionHost, ExtensionHostEvents, ExtensionMessage, ExtensionRuntimeProperties, InboundExtensionMessage, OutboundExtensionMessage, RawInboundExtensionMessage, UnverifiedBrand, VerifiedInboundExtensionMessage, } from "./containerExtension.js";
+export type { IContainerRuntime, IContainerRuntimeBaseWithCombinedEvents, IContainerRuntimeEvents, IContainerRuntimeInternal, IContainerRuntimeWithResolveHandle_Deprecated, SummarizerStopReason, ISummarizeEventProps, ISummarizerObservabilityProps, ISummarizerEvents, } from "./containerRuntime.js";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,iBAAiB,EACjB,uCAAuC,EACvC,uBAAuB,EACvB,6CAA6C,EAC7C,oBAAoB,EACpB,oBAAoB,EACpB,6BAA6B,EAC7B,iBAAiB,GACjB,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,kBAAkB,EAClB,yBAAyB,EACzB,oBAAoB,EACpB,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,gBAAgB,EAChB,0BAA0B,EAC1B,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,eAAe,EACf,+BAA+B,GAC/B,MAAM,yBAAyB,CAAC;AACjC,YAAY,EACX,iBAAiB,EACjB,uCAAuC,EACvC,uBAAuB,EACvB,yBAAyB,EACzB,6CAA6C,EAC7C,oBAAoB,EACpB,oBAAoB,EACpB,6BAA6B,EAC7B,iBAAiB,GACjB,MAAM,uBAAuB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/container-runtime-definitions",
-  "version": "2.41.0-338401",
+  "version": "2.42.0",
   "description": "Fluid Runtime definitions",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -41,10 +41,11 @@
   "main": "",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "2.41.0-338401",
-    "@fluidframework/core-interfaces": "2.41.0-338401",
-    "@fluidframework/driver-definitions": "2.41.0-338401",
-    "@fluidframework/runtime-definitions": "2.41.0-338401"
+    "@fluid-internal/client-utils": "~2.42.0",
+    "@fluidframework/container-definitions": "~2.42.0",
+    "@fluidframework/core-interfaces": "~2.42.0",
+    "@fluidframework/driver-definitions": "~2.42.0",
+    "@fluidframework/runtime-definitions": "~2.42.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
@@ -52,8 +53,8 @@
     "@fluid-tools/build-cli": "^0.55.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.55.0",
-    "@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.40.0",
-    "@fluidframework/eslint-config-fluid": "^5.7.3",
+    "@fluidframework/container-runtime-definitions-previous": "npm:@fluidframework/container-runtime-definitions@2.41.0",
+    "@fluidframework/eslint-config-fluid": "^5.7.4",
     "@microsoft/api-extractor": "7.52.8",
     "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",

package/src/containerExtension.ts

@@ -0,0 +1,323 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import type { ILayerCompatDetails } from "@fluid-internal/client-utils";
+import type { IAudience } from "@fluidframework/container-definitions/internal";
+// eslint-disable-next-line @typescript-eslint/consistent-type-imports -- BrandedType is a class declaration only
+import type {
+	BrandedType,
+	InternalUtilityTypes,
+	ITelemetryBaseLogger,
+	JsonDeserialized,
+	JsonSerializable,
+	Listenable,
+	TypedMessage,
+} from "@fluidframework/core-interfaces/internal";
+import type { IQuorumClients } from "@fluidframework/driver-definitions/internal";
+
+/**
+ * While connected, the id of a client within a session.
+ *
+ * @internal
+ */
+export type ClientConnectionId = string;
+
+/**
+ * Common structure between incoming and outgoing extension signals.
+ *
+ * @remarks
+ * Do not use directly, use {@link OutboundExtensionMessage} or {@link InboundExtensionMessage} instead.
+ *
+ * @sealed
+ * @internal
+ */
+export type ExtensionMessage<
+	TMessage extends TypedMessage = {
+		type: string;
+		content: JsonSerializable<unknown> | JsonDeserialized<unknown>;
+	},
+> = // `TMessage extends TypedMessage` encourages processing union elements individually
+	TMessage extends TypedMessage
+		? InternalUtilityTypes.FlattenIntersection<
+				TMessage & {
+					/**
+					 * Client ID of the singular client the message is being (or has been) sent to.
+					 * May only be specified when IConnect.supportedFeatures['submit_signals_v2'] is true, will throw otherwise.
+					 */
+					targetClientId?: ClientConnectionId;
+				}
+			>
+		: never;
+
+/**
+ * Outgoing extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type OutboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> =
+	ExtensionMessage<{ type: TMessage["type"]; content: JsonSerializable<TMessage["content"]> }>;
+
+/**
+ * Brand for value that has not been verified.
+ *
+ * @remarks
+ * Usage:
+ *
+ * - Cast any value to `UnverifiedBrand` using `as unknown as UnverifiedBrand<T>`
+ * when it is not yet confirmed that value is of type `T`.
+ *
+ * - When `T` value is needed, use narrowing type guards to check (preferred)
+ * or cast from `UnverifiedBrand` using `as unknown` when "instance" must
+ * be parsed to `T`.
+ *
+ * @example Example narrowing type guard:
+ * ```typescript
+ * function validateFoo(
+ *   unverified: Foo | (Record<string, unknown> & UnverifiedBrand<Foo>)
+ * ): unverified is Foo {
+ *   return unverified.IFooProvider === unverified;
+ * }
+ * ```
+ *
+ * @sealed
+ * @internal
+ */
+export declare class UnverifiedBrand<T> extends BrandedType<T> {
+	private readonly UnverifiedValue: T;
+	private constructor();
+}
+
+/**
+ * Unverified incoming extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type RawInboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> =
+	// `TMessage extends TypedMessage` encourages processing union elements individually
+	TMessage extends TypedMessage
+		? InternalUtilityTypes.FlattenIntersection<
+				ExtensionMessage<{
+					type: string;
+					content: JsonDeserialized<unknown>;
+				}> & {
+					/**
+					 * The client ID that submitted the message.
+					 * For server generated messages the clientId will be null.
+					 */
+					// eslint-disable-next-line @rushstack/no-new-null
+					clientId: ClientConnectionId | null;
+				}
+			> &
+				UnverifiedBrand<TMessage>
+		: never;
+
+/**
+ * Verified incoming extension signals.
+ *
+ * @sealed
+ * @internal
+ */
+export type VerifiedInboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> =
+	// `TMessage extends TypedMessage` encourages processing union elements individually
+	TMessage extends TypedMessage
+		? InternalUtilityTypes.FlattenIntersection<
+				ExtensionMessage<{
+					type: TMessage["type"];
+					content: JsonDeserialized<TMessage["content"]>;
+				}> & {
+					/**
+					 * The client ID that submitted the message.
+					 * For server generated messages the clientId will be null.
+					 */
+					// eslint-disable-next-line @rushstack/no-new-null
+					clientId: ClientConnectionId | null;
+				}
+			>
+		: never;
+
+/**
+ * Incoming extension signal that may be of the known type or has not yet been validated.
+ *
+ * @sealed
+ * @internal
+ */
+export type InboundExtensionMessage<TMessage extends TypedMessage = TypedMessage> =
+	| RawInboundExtensionMessage<TMessage>
+	| VerifiedInboundExtensionMessage<TMessage>;
+
+/**
+ * Runtime properties of an extension.
+ *
+ * @remarks
+ * This is used to coordinate select types that are known only to the extension, but
+ * that host will respect where it calls back or provides extension specific data.
+ *
+ * @internal
+ */
+export interface ExtensionRuntimeProperties {
+	SignalMessages: TypedMessage;
+}
+
+/**
+ * Defines requirements for a component to register with container as an extension.
+ *
+ * @internal
+ */
+export interface ContainerExtension<
+	TRuntimeProperties extends ExtensionRuntimeProperties,
+	TUseContext extends unknown[] = [],
+> {
+	/**
+	 * Notifies the extension of a new use context.
+	 *
+	 * @param useContext - Context new reference to extension is acquired within.
+	 *
+	 * @remarks
+	 * This is called when a secondary reference to the extension is acquired.
+	 * useContext is the array of arguments that would otherwise be passed to
+	 * the factory during first acquisition request.
+	 */
+	onNewUse(...useContext: TUseContext): void;
+
+	/**
+	 * Callback for signal sent by this extension.
+	 *
+	 * @param addressChain - Address chain of the signal
+	 * @param signalMessage - Signal unverified content and metadata
+	 * @param local - True if signal was sent by this client
+	 *
+	 */
+	processSignal?: (
+		addressChain: string[],
+		signalMessage: InboundExtensionMessage<TRuntimeProperties["SignalMessages"]>,
+		local: boolean,
+	) => void;
+}
+
+/**
+ * Events emitted by the {@link ExtensionHost}.
+ *
+ * @internal
+ */
+export interface ExtensionHostEvents {
+	"disconnected": () => void;
+	"connected": (clientId: ClientConnectionId) => void;
+}
+
+/**
+ * Defines the runtime aspects an extension may access.
+ *
+ * @remarks
+ * In most cases this is a logical subset of {@link @fluidframework/container-runtime-definitions#IContainerRuntime}.
+ *
+ * @sealed
+ * @internal
+ */
+export interface ExtensionHost<TRuntimeProperties extends ExtensionRuntimeProperties> {
+	readonly isConnected: () => boolean;
+	readonly getClientId: () => ClientConnectionId | undefined;
+
+	readonly events: Listenable<ExtensionHostEvents>;
+
+	readonly logger: ITelemetryBaseLogger;
+
+	readonly supportedFeatures: ILayerCompatDetails["supportedFeatures"];
+
+	/**
+	 * Submits a signal to be sent to other clients.
+	 * @param addressChain - Custom address sequence for the signal.
+	 * @param message - Custom message content of the signal.
+	 *
+	 * Upon receipt of signal, {@link ContainerExtension.processSignal} will be called with the same
+	 * address and message (less any non-{@link https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify|JSON.stringify}-able data).
+	 */
+	submitAddressedSignal: (
+		addressChain: string[],
+		message: OutboundExtensionMessage<TRuntimeProperties["SignalMessages"]>,
+	) => void;
+
+	/**
+	 * The collection of write clients which were connected as of the current sequence number.
+	 * Also contains a map of key-value pairs that must be agreed upon by all clients before being accepted.
+	 */
+	getQuorum: () => IQuorumClients;
+
+	getAudience: () => IAudience;
+}
+
+/**
+ * Factory method to create an extension instance.
+ *
+ * Any such method provided to {@link ContainerExtensionStore.acquireExtension}
+ * must use the same value for a given {@link ContainerExtensionId} so that an
+ * `instanceof` check may be performed at runtime.
+ *
+ * @typeParam T - Type of extension to create
+ * @typeParam TRuntimeProperties - Extension runtime properties
+ * @typeParam TUseContext - Array of custom use context passed to factory or onNewUse
+ *
+ * @param host - Host runtime for extension to work against
+ * @param useContext - Custom use context for extension.
+ * @returns Record providing:
+ * `interface` instance (type `T`) that is provided to caller of
+ * {@link ContainerExtensionStore.acquireExtension} and
+ * `extension` store/runtime uses to interact with extension.
+ *
+ * @internal
+ */
+export type ContainerExtensionFactory<
+	T,
+	TRuntimeProperties extends ExtensionRuntimeProperties,
+	TUseContext extends unknown[] = [],
+> = new (
+	host: ExtensionHost<TRuntimeProperties>,
+	...useContext: TUseContext
+) => {
+	readonly interface: T;
+	readonly extension: ContainerExtension<TRuntimeProperties, TUseContext>;
+};
+
+/**
+ * Unique identifier for extension
+ *
+ * @remarks
+ * A string known to all clients working with a certain ContainerExtension and unique
+ * among ContainerExtensions. Not `/` may be used in the string. Recommend using
+ * concatenation of: type of unique identifier, `:` (required), and unique identifier.
+ *
+ * @example Examples
+ * ```typescript
+ *   "guid:g0fl001d-1415-5000-c00l-g0fa54g0b1g1"
+ *   "name:@foo-scope_bar:v1"
+ * ```
+ *
+ * @internal
+ */
+export type ContainerExtensionId = `${string}:${string}`;
+
+/**
+ * @sealed
+ * @internal
+ */
+export interface ContainerExtensionStore {
+	/**
+	 * Acquires an extension from store or adds new one.
+	 *
+	 * @param id - Identifier for the requested extension
+	 * @param factory - Factory to create the extension if not found
+	 * @returns The extension
+	 */
+	acquireExtension<
+		T,
+		TRuntimeProperties extends ExtensionRuntimeProperties,
+		TUseContext extends unknown[] = [],
+	>(
+		id: ContainerExtensionId,
+		factory: ContainerExtensionFactory<T, TRuntimeProperties, TUseContext>,
+		...context: TUseContext
+	): T;
+}

package/src/containerRuntime.ts

@@ -26,6 +26,8 @@ import type {
 	IProvideFluidDataStoreRegistry,
 } from "@fluidframework/runtime-definitions/internal";
 
+import type { ContainerExtensionStore } from "./containerExtension.js";
+
 /**
  * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
  * @legacy
@@ -198,3 +200,12 @@ export interface IContainerRuntime
 	 */
 	getAbsoluteUrl(relativeUrl: string): Promise<string | undefined>;
 }
+
+/**
+ * Represents the internal version of the runtime of the container.
+ *
+ * @internal
+ */
+export interface IContainerRuntimeInternal
+	extends IContainerRuntime,
+		ContainerExtensionStore {}

package/src/index.ts

@@ -3,10 +3,27 @@
  * Licensed under the MIT License.
  */
 
+export type {
+	ClientConnectionId,
+	ContainerExtensionFactory,
+	ContainerExtensionId,
+	ContainerExtensionStore,
+	ContainerExtension,
+	ExtensionHost,
+	ExtensionHostEvents,
+	ExtensionMessage,
+	ExtensionRuntimeProperties,
+	InboundExtensionMessage,
+	OutboundExtensionMessage,
+	RawInboundExtensionMessage,
+	UnverifiedBrand,
+	VerifiedInboundExtensionMessage,
+} from "./containerExtension.js";
 export type {
 	IContainerRuntime,
 	IContainerRuntimeBaseWithCombinedEvents,
 	IContainerRuntimeEvents,
+	IContainerRuntimeInternal,
 	IContainerRuntimeWithResolveHandle_Deprecated,
 	SummarizerStopReason,
 	ISummarizeEventProps,