@fluid-internal/presence-definitions 2.93.0

package/lib/exposedInternalTypes.d.ts

@@ -0,0 +1,137 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { OpaqueJsonDeserialized } from "@fluidframework/core-interfaces/internal/exposedUtilityTypes";
+/**
+ * Collection of value types that are not intended to be used/imported
+ * directly outside of this package.
+ *
+ * @public
+ * @system
+ */
+export declare namespace InternalTypes {
+    /**
+     * Metadata for a value state.
+     *
+     * @system
+     */
+    interface ValueStateMetadata {
+        rev: number;
+        timestamp: number;
+    }
+    /**
+     * Represents a state that may have a value.
+     * And it includes standard metadata.
+     *
+     * @see {@link InternalPresenceTypes.ValueRequiredState}.
+     *
+     * @system
+     */
+    interface ValueOptionalState<TValue> extends ValueStateMetadata {
+        value?: OpaqueJsonDeserialized<TValue>;
+    }
+    /**
+     * Represents a state that must have a value.
+     * And it includes standard metadata.
+     *
+     * @remarks
+     * The value is wrapped in `OpaqueJsonDeserialized` as uses are expected
+     * to involve generic or unknown types that will be filtered. It is here
+     * mostly as a convenience to the many such uses that would otherwise
+     * need to specify some wrapper themselves.
+     *
+     * For known cases, construct a custom interface that extends
+     * {@link InternalPresenceTypes.ValueStateMetadata}.
+     *
+     * @system
+     */
+    interface ValueRequiredState<TValue> extends ValueStateMetadata {
+        value: OpaqueJsonDeserialized<TValue>;
+    }
+    /**
+     * A directory of values, where each value may be an optional state or another directory.
+     *
+     * @system
+     */
+    interface ValueDirectory<T> {
+        rev: number;
+        items: {
+            [name: string | number]: ValueOptionalState<T> | ValueDirectory<T>;
+        };
+    }
+    /**
+     * Convenience type for a required state or a directory of values.
+     *
+     * @system
+     */
+    type ValueDirectoryOrState<T> = ValueRequiredState<T> | ValueDirectory<T>;
+    /**
+     * Collection of optional values in a "map" structure.
+     *
+     * @system
+     */
+    interface MapValueState<T, Keys extends string> {
+        rev: number;
+        items: {
+            [name in Keys]: ValueOptionalState<T>;
+        };
+    }
+    /**
+     * Opaque type representing internal state datastore.
+     *
+     * @system
+     */
+    class StateDatastoreHandle<TKey, TValue extends ValueDirectoryOrState<unknown>> {
+        private readonly StateDatastoreHandle;
+    }
+    /**
+     * Brand to ensure state values internal type safety without revealing
+     * internals that are subject to change.
+     *
+     * @system
+     */
+    class StateValueBrand<T> {
+        private readonly StateValue;
+    }
+    /**
+     * This type provides no additional functionality over the type it wraps.
+     * It is used to ensure type safety within package.
+     * Users may find it convenient to just use the type it wraps directly.
+     *
+     * @privateRemarks
+     * Checkout filtering omitting unknown from T (`Omit<T,unknown> &`).
+     *
+     * @system
+     */
+    type StateValue<T> = T & StateValueBrand<T>;
+    /**
+     * Package internal function declaration for state and notification instantiation.
+     *
+     * @remarks
+     * Direct use of this type is discouraged. If in need, try to use the type
+     * returned by the factory functions instead, as those are more specific and
+     * stable.
+     *
+     * @system
+     */
+    type ManagerFactory<TKey extends string, TValue extends ValueDirectoryOrState<unknown>, TManager> = {
+        instanceBase: new (...args: any[]) => unknown;
+    } & ((key: TKey, datastoreHandle: StateDatastoreHandle<TKey, TValue>) => {
+        initialData?: {
+            value: TValue;
+            allowableUpdateLatencyMs: number | undefined;
+        };
+        manager: StateValue<TManager>;
+    });
+    /**
+     * Structure of a generic notification "value".
+     *
+     * @system
+     */
+    interface NotificationType {
+        name: string;
+        args: unknown[];
+    }
+}
+//# sourceMappingURL=exposedInternalTypes.d.ts.map

package/lib/exposedInternalTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposedInternalTypes.d.ts","sourceRoot":"","sources":["../src/exposedInternalTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,8DAA8D,CAAC;AAE3G;;;;;;GAMG;AAEH,yBAAiB,aAAa,CAAC;IAC9B;;;;OAIG;IACH,UAAiB,kBAAkB;QAClC,GAAG,EAAE,MAAM,CAAC;QACZ,SAAS,EAAE,MAAM,CAAC;KAClB;IAED;;;;;;;OAOG;IACH,UAAiB,kBAAkB,CAAC,MAAM,CAAE,SAAQ,kBAAkB;QACrE,KAAK,CAAC,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC;KAMvC;IAED;;;;;;;;;;;;;;OAcG;IACH,UAAiB,kBAAkB,CAAC,MAAM,CAAE,SAAQ,kBAAkB;QACrE,KAAK,EAAE,sBAAsB,CAAC,MAAM,CAAC,CAAC;KAMtC;IAED;;;;OAIG;IACH,UAAiB,cAAc,CAAC,CAAC;QAChC,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE;YAIN,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;SACnE,CAAC;KACF;IAED;;;;OAIG;IACH,KAAY,qBAAqB,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAEjF;;;;OAIG;IACH,UAAiB,aAAa,CAAC,CAAC,EAAE,IAAI,SAAS,MAAM;QACpD,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE;aAIL,IAAI,IAAI,IAAI,GAAG,kBAAkB,CAAC,CAAC,CAAC;SACrC,CAAC;KACF;IAED;;;;OAIG;IACH,MAAqB,oBAAoB,CACxC,IAAI,EACJ,MAAM,SAAS,qBAAqB,CAAC,OAAO,CAAC;QAE7C,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAqC;KAC1E;IAED;;;;;OAKG;IACH,MAAqB,eAAe,CAAC,CAAC;QACrC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAgB;KAC3C;IAED;;;;;;;;;OASG;IACH,KAAY,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC;IAEnD;;;;;;;;;OASG;IACH,KAAY,cAAc,CACzB,IAAI,SAAS,MAAM,EACnB,MAAM,SAAS,qBAAqB,CAAC,OAAO,CAAC,EAC7C,QAAQ,IACL;QAAE,YAAY,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAA;KAAE,GAAG,CAAC,CACxD,GAAG,EAAE,IAAI,EACT,eAAe,EAAE,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,KAC/C;QACJ,WAAW,CAAC,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,wBAAwB,EAAE,MAAM,GAAG,SAAS,CAAA;SAAE,CAAC;QAC9E,OAAO,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAC;KAC9B,CAAC,CAAC;IAEH;;;;OAIG;IACH,UAAiB,gBAAgB;QAChC,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,OAAO,EAAE,CAAC;KAChB;CACD"}

package/lib/exposedInternalTypes.js

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Collection of value types that are not intended to be used/imported
+ * directly outside of this package.
+ *
+ * @public
+ * @system
+ */
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export var InternalTypes;
+(function (InternalTypes) {
+})(InternalTypes || (InternalTypes = {}));
+//# sourceMappingURL=exposedInternalTypes.js.map

package/lib/exposedInternalTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposedInternalTypes.js","sourceRoot":"","sources":["../src/exposedInternalTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;;;;GAMG;AACH,2DAA2D;AAC3D,MAAM,KAAW,aAAa,CA0J7B;AA1JD,WAAiB,aAAa;AA0J9B,CAAC,EA1JgB,aAAa,KAAb,aAAa,QA0J7B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { OpaqueJsonDeserialized } from \"@fluidframework/core-interfaces/internal/exposedUtilityTypes\";\n\n/**\n * Collection of value types that are not intended to be used/imported\n * directly outside of this package.\n *\n * @public\n * @system\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace InternalTypes {\n\t/**\n\t * Metadata for a value state.\n\t *\n\t * @system\n\t */\n\texport interface ValueStateMetadata {\n\t\trev: number;\n\t\ttimestamp: number;\n\t}\n\n\t/**\n\t * Represents a state that may have a value.\n\t * And it includes standard metadata.\n\t *\n\t * @see {@link InternalPresenceTypes.ValueRequiredState}.\n\t *\n\t * @system\n\t */\n\texport interface ValueOptionalState<TValue> extends ValueStateMetadata {\n\t\tvalue?: OpaqueJsonDeserialized<TValue>;\n\n\t\t// Uncomment this property and rebuild to check more thoroughly\n\t\t// for incompatibilities between this non-validatable state\n\t\t// and ValidatableOptionalState.\n\t\t// validatedValue?: never;\n\t}\n\n\t/**\n\t * Represents a state that must have a value.\n\t * And it includes standard metadata.\n\t *\n\t * @remarks\n\t * The value is wrapped in `OpaqueJsonDeserialized` as uses are expected\n\t * to involve generic or unknown types that will be filtered. It is here\n\t * mostly as a convenience to the many such uses that would otherwise\n\t * need to specify some wrapper themselves.\n\t *\n\t * For known cases, construct a custom interface that extends\n\t * {@link InternalPresenceTypes.ValueStateMetadata}.\n\t *\n\t * @system\n\t */\n\texport interface ValueRequiredState<TValue> extends ValueStateMetadata {\n\t\tvalue: OpaqueJsonDeserialized<TValue>;\n\n\t\t// Uncomment this property and rebuild to check more thoroughly\n\t\t// for incompatibilities between this non-validatable state\n\t\t// and ValidatableOptionalState.\n\t\t// validatedValue?: never;\n\t}\n\n\t/**\n\t * A directory of values, where each value may be an optional state or another directory.\n\t *\n\t * @system\n\t */\n\texport interface ValueDirectory<T> {\n\t\trev: number;\n\t\titems: {\n\t\t\t// Caution: any particular item may or may not exist\n\t\t\t// Typescript does not support absent keys without forcing type to also be undefined.\n\t\t\t// See https://github.com/microsoft/TypeScript/issues/42810.\n\t\t\t[name: string | number]: ValueOptionalState<T> | ValueDirectory<T>;\n\t\t};\n\t}\n\n\t/**\n\t * Convenience type for a required state or a directory of values.\n\t *\n\t * @system\n\t */\n\texport type ValueDirectoryOrState<T> = ValueRequiredState<T> | ValueDirectory<T>;\n\n\t/**\n\t * Collection of optional values in a \"map\" structure.\n\t *\n\t * @system\n\t */\n\texport interface MapValueState<T, Keys extends string> {\n\t\trev: number;\n\t\titems: {\n\t\t\t// Caution: any particular item may or may not exist\n\t\t\t// Typescript does not support absent keys without forcing type to also be undefined.\n\t\t\t// See https://github.com/microsoft/TypeScript/issues/42810.\n\t\t\t[name in Keys]: ValueOptionalState<T>;\n\t\t};\n\t}\n\n\t/**\n\t * Opaque type representing internal state datastore.\n\t *\n\t * @system\n\t */\n\texport declare class StateDatastoreHandle<\n\t\tTKey,\n\t\tTValue extends ValueDirectoryOrState<unknown>,\n\t> {\n\t\tprivate readonly StateDatastoreHandle: StateDatastoreHandle<TKey, TValue>;\n\t}\n\n\t/**\n\t * Brand to ensure state values internal type safety without revealing\n\t * internals that are subject to change.\n\t *\n\t * @system\n\t */\n\texport declare class StateValueBrand<T> {\n\t\tprivate readonly StateValue: StateValue<T>;\n\t}\n\n\t/**\n\t * This type provides no additional functionality over the type it wraps.\n\t * It is used to ensure type safety within package.\n\t * Users may find it convenient to just use the type it wraps directly.\n\t *\n\t * @privateRemarks\n\t * Checkout filtering omitting unknown from T (`Omit<T,unknown> &`).\n\t *\n\t * @system\n\t */\n\texport type StateValue<T> = T & StateValueBrand<T>;\n\n\t/**\n\t * Package internal function declaration for state and notification instantiation.\n\t *\n\t * @remarks\n\t * Direct use of this type is discouraged. If in need, try to use the type\n\t * returned by the factory functions instead, as those are more specific and\n\t * stable.\n\t *\n\t * @system\n\t */\n\texport type ManagerFactory<\n\t\tTKey extends string,\n\t\tTValue extends ValueDirectoryOrState<unknown>,\n\t\tTManager,\n\t> = { instanceBase: new (...args: any[]) => unknown } & ((\n\t\tkey: TKey,\n\t\tdatastoreHandle: StateDatastoreHandle<TKey, TValue>,\n\t) => {\n\t\tinitialData?: { value: TValue; allowableUpdateLatencyMs: number | undefined };\n\t\tmanager: StateValue<TManager>;\n\t});\n\n\t/**\n\t * Structure of a generic notification \"value\".\n\t *\n\t * @system\n\t */\n\texport interface NotificationType {\n\t\tname: string;\n\t\targs: unknown[];\n\t}\n}\n"]}

package/lib/exposedUtilityTypes.d.ts

@@ -0,0 +1,108 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { InternalCoreInterfacesUtilityTypes, JsonDeserialized, JsonSerializable } from "@fluidframework/core-interfaces/internal/exposedUtilityTypes";
+import type { Attendee } from "./presence.js";
+/**
+ * Collection of utility types that are not intended to be used/imported
+ * directly outside of this package.
+ *
+ * @alpha
+ * @system
+ */
+export declare namespace InternalUtilityTypes {
+    /**
+     * Yields `IfParametersValid` when the given type is an acceptable shape for a
+     * notification. `Else` otherwise.
+     *
+     * @system
+     */
+    type IfNotificationParametersSignature<Event, IfParametersValid, Else> = Event extends (...args: infer P) => void ? InternalCoreInterfacesUtilityTypes.IfSameType<P, JsonSerializable<P>, IfParametersValid, Else> : Else;
+    /**
+     * Yields `IfSubscriber` when the given type is an acceptable shape for a notification
+     * listener (subscriber) function. `Else` otherwise.
+     *
+     * @system
+     */
+    type IfNotificationSubscriberSignature<Event, IfSubscriber, Else> = Event extends (sender: Attendee, ...args: infer P) => void ? InternalCoreInterfacesUtilityTypes.IfSameType<P, JsonSerializable<P>, IfSubscriber, Else> : Else;
+    /**
+     * Used to specify the kinds of notifications handled by a {@link NotificationListenable}
+     * by describing the custom parameters in a function signature.
+     *
+     * @remarks
+     *
+     * Any object type is a valid NotificationListeners, but only the notification-like
+     * properties of that type will be included.
+     *
+     * @example
+     *
+     * ```typescript
+     * interface MyNotifications {
+     *   load: (user: string, data: IUserData) => void;
+     *   requestPause: (period: number) => void;
+     * }
+     * ```
+     *
+     * @system
+     */
+    type NotificationListeners<E> = {
+        [P in keyof E as IfNotificationParametersSignature<E[P], P, never>]: E[P];
+    };
+    /**
+     * Converts a notification subscriber signature into parameters signature
+     * (by removing the `sender: Attendee` parameter).
+     *
+     * @remarks
+     * No attempt is made to validate that the original signature is valid with
+     * all parameters being JSON-serializable.
+     *
+     * @system
+     */
+    type NotificationParametersSignatureFromSubscriberSignature<Event> = Event extends (sender: Attendee, ...args: infer P) => void ? (...args: P) => void : never;
+    /**
+     * Used to specify the kinds of notifications handled by a {@link NotificationListenable}
+     * by describing the subscriber signatures.
+     *
+     * @remarks
+     *
+     * Any object type is a valid NotificationListenersWithSubscriberSignatures,
+     * but only the notification-like properties of that type will be included.
+     *
+     * @example
+     *
+     * ```typescript
+     * interface MyNotifications {
+     *   load: (sender: Attendee, user: string, data: IUserData) => void;
+     *   requestPause: (sender: Attendee, period: number) => void;
+     * }
+     * ```
+     *
+     * @system
+     */
+    type NotificationListenersWithSubscriberSignatures<E> = {
+        [P in keyof E as IfNotificationSubscriberSignature<E[P], P, never>]: E[P];
+    };
+    /**
+     * Converts a record of notification subscriber signatures into
+     * a record of base parameter signatures (which are the canonical form).
+     *
+     * @system
+     */
+    type NotificationListenersFromSubscriberSignatures<E extends NotificationListenersWithSubscriberSignatures<E>> = {
+        [K in keyof NotificationListenersWithSubscriberSignatures<E>]: NotificationParametersSignatureFromSubscriberSignature<E[K]>;
+    } extends infer TListeners ? NotificationListeners<TListeners> : never;
+    /**
+     * {@link @fluidframework/core-interfaces#JsonDeserialized} version of the parameters of a function.
+     *
+     * @system
+     */
+    type JsonDeserializedParameters<T extends (...args: any[]) => unknown> = T extends (...args: infer P) => unknown ? JsonDeserialized<P> : never;
+    /**
+     * {@link @fluidframework/core-interfaces#JsonSerializable} version of the parameters of a function.
+     *
+     * @system
+     */
+    type JsonSerializableParameters<T extends (...args: any[]) => unknown> = T extends (...args: infer P) => unknown ? JsonSerializable<P> : never;
+}
+//# sourceMappingURL=exposedUtilityTypes.d.ts.map

package/lib/exposedUtilityTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposedUtilityTypes.d.ts","sourceRoot":"","sources":["../src/exposedUtilityTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,kCAAkC,EAClC,gBAAgB,EAChB,gBAAgB,EAChB,MAAM,8DAA8D,CAAC;AAEtE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C;;;;;;GAMG;AAEH,yBAAiB,oBAAoB,CAAC;IACrC;;;;;OAKG;IACH,KAAY,iCAAiC,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,IAC3E,KAAK,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,KAAK,IAAI,GACrC,kCAAkC,CAAC,UAAU,CAC7C,CAAC,EACD,gBAAgB,CAAC,CAAC,CAAC,EACnB,iBAAiB,EACjB,IAAI,CACJ,GACA,IAAI,CAAC;IAET;;;;;OAKG;IACH,KAAY,iCAAiC,CAAC,KAAK,EAAE,YAAY,EAAE,IAAI,IAAI,KAAK,SAAS,CACxF,MAAM,EAAE,QAAQ,EAChB,GAAG,IAAI,EAAE,MAAM,CAAC,KACZ,IAAI,GACN,kCAAkC,CAAC,UAAU,CAAC,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,CAAC,GACzF,IAAI,CAAC;IAER;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAY,qBAAqB,CAAC,CAAC,IAAI;SACrC,CAAC,IAAI,MAAM,CAAC,IAAI,iCAAiC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACzE,CAAC;IAEF;;;;;;;;;OASG;IACH,KAAY,sDAAsD,CAAC,KAAK,IAAI,KAAK,SAAS,CACzF,MAAM,EAAE,QAAQ,EAChB,GAAG,IAAI,EAAE,MAAM,CAAC,KACZ,IAAI,GACN,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,IAAI,GACpB,KAAK,CAAC;IAET;;;;;;;;;;;;;;;;;;;OAmBG;IACH,KAAY,6CAA6C,CAAC,CAAC,IAAI;SAC7D,CAAC,IAAI,MAAM,CAAC,IAAI,iCAAiC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACzE,CAAC;IAEF;;;;;OAKG;IACH,KAAY,6CAA6C,CACxD,CAAC,SAAS,6CAA6C,CAAC,CAAC,CAAC,IACvD;SACF,CAAC,IAAI,MAAM,6CAA6C,CAAC,CAAC,CAAC,GAAG,sDAAsD,CACpH,CAAC,CAAC,CAAC,CAAC,CACJ;KACD,SAAS,MAAM,UAAU,GAExB,qBAAqB,CAAC,UAAU,CAAC,GAChC,KAAK,CAAC;IAET;;;;OAIG;IACH,KAAY,0BAA0B,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,IAAI,CAAC,SAAS,CACzF,GAAG,IAAI,EAAE,MAAM,CAAC,KACZ,OAAO,GACT,gBAAgB,CAAC,CAAC,CAAC,GACnB,KAAK,CAAC;IAET;;;;OAIG;IACH,KAAY,0BAA0B,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,IAAI,CAAC,SAAS,CACzF,GAAG,IAAI,EAAE,MAAM,CAAC,KACZ,OAAO,GACT,gBAAgB,CAAC,CAAC,CAAC,GACnB,KAAK,CAAC;CACT"}

package/lib/exposedUtilityTypes.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=exposedUtilityTypes.js.map

package/lib/exposedUtilityTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exposedUtilityTypes.js","sourceRoot":"","sources":["../src/exposedUtilityTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tInternalCoreInterfacesUtilityTypes,\n\tJsonDeserialized,\n\tJsonSerializable,\n} from \"@fluidframework/core-interfaces/internal/exposedUtilityTypes\";\n\nimport type { Attendee } from \"./presence.js\";\n\n/**\n * Collection of utility types that are not intended to be used/imported\n * directly outside of this package.\n *\n * @alpha\n * @system\n */\n// eslint-disable-next-line @typescript-eslint/no-namespace\nexport namespace InternalUtilityTypes {\n\t/**\n\t * Yields `IfParametersValid` when the given type is an acceptable shape for a\n\t * notification. `Else` otherwise.\n\t *\n\t * @system\n\t */\n\texport type IfNotificationParametersSignature<Event, IfParametersValid, Else> =\n\t\tEvent extends (...args: infer P) => void\n\t\t\t? InternalCoreInterfacesUtilityTypes.IfSameType<\n\t\t\t\t\tP,\n\t\t\t\t\tJsonSerializable<P>,\n\t\t\t\t\tIfParametersValid,\n\t\t\t\t\tElse\n\t\t\t\t>\n\t\t\t: Else;\n\n\t/**\n\t * Yields `IfSubscriber` when the given type is an acceptable shape for a notification\n\t * listener (subscriber) function. `Else` otherwise.\n\t *\n\t * @system\n\t */\n\texport type IfNotificationSubscriberSignature<Event, IfSubscriber, Else> = Event extends (\n\t\tsender: Attendee,\n\t\t...args: infer P\n\t) => void\n\t\t? InternalCoreInterfacesUtilityTypes.IfSameType<P, JsonSerializable<P>, IfSubscriber, Else>\n\t\t: Else;\n\n\t/**\n\t * Used to specify the kinds of notifications handled by a {@link NotificationListenable}\n\t * by describing the custom parameters in a function signature.\n\t *\n\t * @remarks\n\t *\n\t * Any object type is a valid NotificationListeners, but only the notification-like\n\t * properties of that type will be included.\n\t *\n\t * @example\n\t *\n\t * ```typescript\n\t * interface MyNotifications {\n\t *   load: (user: string, data: IUserData) => void;\n\t *   requestPause: (period: number) => void;\n\t * }\n\t * ```\n\t *\n\t * @system\n\t */\n\texport type NotificationListeners<E> = {\n\t\t[P in keyof E as IfNotificationParametersSignature<E[P], P, never>]: E[P];\n\t};\n\n\t/**\n\t * Converts a notification subscriber signature into parameters signature\n\t * (by removing the `sender: Attendee` parameter).\n\t *\n\t * @remarks\n\t * No attempt is made to validate that the original signature is valid with\n\t * all parameters being JSON-serializable.\n\t *\n\t * @system\n\t */\n\texport type NotificationParametersSignatureFromSubscriberSignature<Event> = Event extends (\n\t\tsender: Attendee,\n\t\t...args: infer P\n\t) => void\n\t\t? (...args: P) => void\n\t\t: never;\n\n\t/**\n\t * Used to specify the kinds of notifications handled by a {@link NotificationListenable}\n\t * by describing the subscriber signatures.\n\t *\n\t * @remarks\n\t *\n\t * Any object type is a valid NotificationListenersWithSubscriberSignatures,\n\t * but only the notification-like properties of that type will be included.\n\t *\n\t * @example\n\t *\n\t * ```typescript\n\t * interface MyNotifications {\n\t *   load: (sender: Attendee, user: string, data: IUserData) => void;\n\t *   requestPause: (sender: Attendee, period: number) => void;\n\t * }\n\t * ```\n\t *\n\t * @system\n\t */\n\texport type NotificationListenersWithSubscriberSignatures<E> = {\n\t\t[P in keyof E as IfNotificationSubscriberSignature<E[P], P, never>]: E[P];\n\t};\n\n\t/**\n\t * Converts a record of notification subscriber signatures into\n\t * a record of base parameter signatures (which are the canonical form).\n\t *\n\t * @system\n\t */\n\texport type NotificationListenersFromSubscriberSignatures<\n\t\tE extends NotificationListenersWithSubscriberSignatures<E>,\n\t> = {\n\t\t[K in keyof NotificationListenersWithSubscriberSignatures<E>]: NotificationParametersSignatureFromSubscriberSignature<\n\t\t\tE[K]\n\t\t>;\n\t} extends infer TListeners\n\t\t? // Additional filter is needed to convince TypeScript that the result is NotificationListeners shape\n\t\t\tNotificationListeners<TListeners>\n\t\t: never;\n\n\t/**\n\t * {@link @fluidframework/core-interfaces#JsonDeserialized} version of the parameters of a function.\n\t *\n\t * @system\n\t */\n\texport type JsonDeserializedParameters<T extends (...args: any[]) => unknown> = T extends (\n\t\t...args: infer P\n\t) => unknown\n\t\t? JsonDeserialized<P>\n\t\t: never;\n\n\t/**\n\t * {@link @fluidframework/core-interfaces#JsonSerializable} version of the parameters of a function.\n\t *\n\t * @system\n\t */\n\texport type JsonSerializableParameters<T extends (...args: any[]) => unknown> = T extends (\n\t\t...args: infer P\n\t) => unknown\n\t\t? JsonSerializable<P>\n\t\t: never;\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export type { ClientConnectionId } from "./baseTypes.js";
+export type { BroadcastControls, BroadcastControlSettings } from "./broadcastControlsTypes.js";
+export type { InternalTypes as InternalPresenceTypes } from "./exposedInternalTypes.js";
+export type { InternalUtilityTypes as InternalPresenceUtilityTypes } from "./exposedUtilityTypes.js";
+export type { KeySchemaValidator, LatestMap, LatestMapArguments, LatestMapArgumentsRaw, LatestMapClientData, LatestMapConfiguration, LatestMapEvents, LatestMapFactory, LatestMapItemRemovedClientData, LatestMapItemUpdatedClientData, LatestMapRaw, LatestMapRawConfiguration, LatestMapRawEvents, StateMap, } from "./latestMapTypes.js";
+export type { Latest, LatestArguments, LatestArgumentsRaw, LatestConfiguration, LatestEvents, LatestFactory, LatestRaw, LatestRawConfiguration, LatestRawEvents, } from "./latestTypes.js";
+export type { Accessor, LatestClientData, LatestData, LatestMetadata, ProxiedValueAccessor, RawValueAccessor, StateSchemaValidator, ValueAccessor, } from "./latestValueTypes.js";
+export type { NotificationEmitter, NotificationListenable, NotificationsConfiguration, NotificationsManager, NotificationsManagerEvents, NotificationSubscriberSignatures, NotificationsWithSubscriptionsConfiguration, } from "./notificationsManagerTypes.js";
+export type { Attendee, AttendeeId, AttendeesEvents, Presence, PresenceEvents, PresenceWithNotifications, } from "./presence.js";
+export { AttendeeStatus } from "./presence.js";
+export type { NotificationsWorkspace, NotificationsWorkspaceSchema, StatesWorkspace, StatesWorkspaceEntries, StatesWorkspaceEntry, StatesWorkspaceSchema, WorkspaceAddress, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,YAAY,EAAE,iBAAiB,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAE/F,YAAY,EAAE,aAAa,IAAI,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAExF,YAAY,EAAE,oBAAoB,IAAI,4BAA4B,EAAE,MAAM,0BAA0B,CAAC;AAErG,YAAY,EACX,kBAAkB,EAClB,SAAS,EACT,kBAAkB,EAClB,qBAAqB,EACrB,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EACf,gBAAgB,EAChB,8BAA8B,EAC9B,8BAA8B,EAC9B,YAAY,EACZ,yBAAyB,EACzB,kBAAkB,EAClB,QAAQ,GACR,MAAM,qBAAqB,CAAC;AAE7B,YAAY,EACX,MAAM,EACN,eAAe,EACf,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACZ,aAAa,EACb,SAAS,EACT,sBAAsB,EACtB,eAAe,GACf,MAAM,kBAAkB,CAAC;AAE1B,YAAY,EACX,QAAQ,EACR,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,aAAa,GACb,MAAM,uBAAuB,CAAC;AAE/B,YAAY,EACX,mBAAmB,EACnB,sBAAsB,EACtB,0BAA0B,EAC1B,oBAAoB,EACpB,0BAA0B,EAC1B,gCAAgC,EAChC,2CAA2C,GAC3C,MAAM,gCAAgC,CAAC;AAExC,YAAY,EACX,QAAQ,EACR,UAAU,EACV,eAAe,EACf,QAAQ,EACR,cAAc,EACd,yBAAyB,GACzB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAE/C,YAAY,EACX,sBAAsB,EACtB,4BAA4B,EAC5B,eAAe,EACf,sBAAsB,EACtB,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,GAChB,MAAM,YAAY,CAAC"}

package/lib/index.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { AttendeeStatus } from "./presence.js";
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAoEH,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type { ClientConnectionId } from \"./baseTypes.js\";\n\nexport type { BroadcastControls, BroadcastControlSettings } from \"./broadcastControlsTypes.js\";\n\nexport type { InternalTypes as InternalPresenceTypes } from \"./exposedInternalTypes.js\";\n\nexport type { InternalUtilityTypes as InternalPresenceUtilityTypes } from \"./exposedUtilityTypes.js\";\n\nexport type {\n\tKeySchemaValidator,\n\tLatestMap,\n\tLatestMapArguments,\n\tLatestMapArgumentsRaw,\n\tLatestMapClientData,\n\tLatestMapConfiguration,\n\tLatestMapEvents,\n\tLatestMapFactory,\n\tLatestMapItemRemovedClientData,\n\tLatestMapItemUpdatedClientData,\n\tLatestMapRaw,\n\tLatestMapRawConfiguration,\n\tLatestMapRawEvents,\n\tStateMap,\n} from \"./latestMapTypes.js\";\n\nexport type {\n\tLatest,\n\tLatestArguments,\n\tLatestArgumentsRaw,\n\tLatestConfiguration,\n\tLatestEvents,\n\tLatestFactory,\n\tLatestRaw,\n\tLatestRawConfiguration,\n\tLatestRawEvents,\n} from \"./latestTypes.js\";\n\nexport type {\n\tAccessor,\n\tLatestClientData,\n\tLatestData,\n\tLatestMetadata,\n\tProxiedValueAccessor,\n\tRawValueAccessor,\n\tStateSchemaValidator,\n\tValueAccessor,\n} from \"./latestValueTypes.js\";\n\nexport type {\n\tNotificationEmitter,\n\tNotificationListenable,\n\tNotificationsConfiguration,\n\tNotificationsManager,\n\tNotificationsManagerEvents,\n\tNotificationSubscriberSignatures,\n\tNotificationsWithSubscriptionsConfiguration,\n} from \"./notificationsManagerTypes.js\";\n\nexport type {\n\tAttendee,\n\tAttendeeId,\n\tAttendeesEvents,\n\tPresence,\n\tPresenceEvents,\n\tPresenceWithNotifications,\n} from \"./presence.js\";\nexport { AttendeeStatus } from \"./presence.js\";\n\nexport type {\n\tNotificationsWorkspace,\n\tNotificationsWorkspaceSchema,\n\tStatesWorkspace,\n\tStatesWorkspaceEntries,\n\tStatesWorkspaceEntry,\n\tStatesWorkspaceSchema,\n\tWorkspaceAddress,\n} from \"./types.js\";\n"]}

package/lib/internal.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export type { InternalTypes } from "./exposedInternalTypes.js";
+export type { PostUpdateAction, ValueManager } from "./statesManagerTypes.js";
+export type { AnyWorkspace } from "./types.js";
+export type { ValidatableOptionalState, ValidatableRequiredState, ValidatableValueDirectory, ValidatableValueDirectoryOrState, ValidatableValueStructure, } from "./validatableTypes.js";
+//# sourceMappingURL=internal.d.ts.map

package/lib/internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE/D,YAAY,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAE9E,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,YAAY,EACX,wBAAwB,EACxB,wBAAwB,EACxB,yBAAyB,EACzB,gCAAgC,EAChC,yBAAyB,GACzB,MAAM,uBAAuB,CAAC"}

package/lib/internal.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=internal.js.map

package/lib/internal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type { InternalTypes } from \"./exposedInternalTypes.js\";\n\nexport type { PostUpdateAction, ValueManager } from \"./statesManagerTypes.js\";\n\nexport type { AnyWorkspace } from \"./types.js\";\n\nexport type {\n\tValidatableOptionalState,\n\tValidatableRequiredState,\n\tValidatableValueDirectory,\n\tValidatableValueDirectoryOrState,\n\tValidatableValueStructure,\n} from \"./validatableTypes.js\";\n"]}