@fluidframework/presence 2.92.0 → 2.93.0

package/lib/exposedInternalTypes.d.ts

@@ -1,138 +0,0 @@
-/*!
- * 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.
- *
- * @beta
- * @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.
-     *
-     * @remarks
-     * 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

@@ -1 +0,0 @@
-{"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;;;;;;;;OAQG;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

@@ -1,16 +0,0 @@
-/*!
- * 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.
- *
- * @beta
- * @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

@@ -1 +0,0 @@
-{"version":3,"file":"exposedInternalTypes.js","sourceRoot":"","sources":["../src/exposedInternalTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;;;;;GAMG;AACH,2DAA2D;AAC3D,MAAM,KAAW,aAAa,CA2J7B;AA3JD,WAAiB,aAAa;AA2J9B,CAAC,EA3JgB,aAAa,KAAb,aAAa,QA2J7B","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 * @beta\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 * @remarks\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

@@ -1,108 +0,0 @@
-/*!
- * 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

@@ -1 +0,0 @@
-{"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

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

package/lib/exposedUtilityTypes.js.map

@@ -1 +0,0 @@
-{"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/internalUtils.d.ts

@@ -1,125 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { DeepReadonly, InternalCoreInterfacesUtilityTypes, JsonDeserialized, JsonSerializable, OpaqueJsonDeserialized, OpaqueJsonSerializable } from "@fluidframework/core-interfaces/internal";
-import type { ValidatableOptionalState, ValidatableRequiredState } from "./validatableTypes.js";
-/**
- * Returns union of types of values in a record.
- */
-export type RecordEntryTypes<T> = T[keyof T];
-type MapNumberIndicesToStrings<T> = {
-    [K in keyof T as K extends number ? `${K}` : K]: T[K];
-};
-type KeyValuePairs<T> = {
-    [K in keyof MapNumberIndicesToStrings<Required<T>>]: [K, Required<T>[K]];
-}[keyof MapNumberIndicesToStrings<Required<T>>][];
-type RequiredAndNotUndefined<T> = {
-    [K in keyof T]-?: Exclude<T[K], undefined>;
-};
-/**
- * Object.entries retyped to preserve known keys and their types.
- *
- * @privateRemarks
- * The is a defect in this utility when a string index appears in the object.
- * In such a case, the only result is `[string, T]`, where `T` is the type
- * of the string index entry.
- */
-export declare const objectEntries: <const T>(o: T) => KeyValuePairs<T>;
-/**
- * Object.entries retyped to preserve known keys and their types.
- *
- * @remarks
- * Given `T` should not contain `undefined` values. If it does, use
- * {@link objectEntries} instead. Without `undefined` values, this
- * typing provides best handling of objects with optional properties.
- */
-export declare const objectEntriesWithoutUndefined: <const T>(o: T) => KeyValuePairs<RequiredAndNotUndefined<T>>;
-/**
- * Object.keys retyped to preserve known keys and their types.
- */
-export declare const objectKeys: <const T>(o: T) => (keyof MapNumberIndicesToStrings<T>)[];
-/**
- * Retrieve a value from a record with the given key, or create a new entry if
- * the key is not in the record.
- *
- * @param record - The record to index/update
- * @param key - The key to lookup in the record
- * @param defaultValue - a function which returns a default value. This is
- * called and used to set an initial value for the given key in the record if
- * none exists.
- * @returns either the existing value for the given key, or the newly-created
- * value (the result of `defaultValue`)
- */
-export declare function getOrCreateRecord<const K extends string | number | symbol, const V>(record: Record<K, V>, key: K, defaultValue: (key: K) => V): V;
-/**
- * No-runtime-effect helper to apply deep immutability to a value's type.
- */
-export declare function asDeeplyReadonly<T>(value: T): DeepReadonly<T>;
-export declare function asDeeplyReadonlyDeserializedJson<T>(value: OpaqueJsonDeserialized<T>): DeepReadonly<JsonDeserialized<T>>;
-export declare function asDeeplyReadonlyDeserializedJson<T>(value: OpaqueJsonDeserialized<T> | undefined): DeepReadonly<JsonDeserialized<T>> | undefined;
-/**
- * Conditional type that reveals the underlying JSON type of an opaque JSON value. If `T` is an object, the key values
- * will be revealed.
- */
-type RevealOpaqueJsonDeserialized<T> = T extends OpaqueJsonDeserialized<infer U> ? JsonDeserialized<U> : {
-    [Key in keyof T]: RevealOpaqueJsonDeserialized<T[Key]>;
-};
-/**
- * No-runtime-effect helper to reveal the JSON type from a value's opaque JSON
- * types throughout a structure.
- *
- * @remarks
- * {@link OpaqueJsonDeserialized} instances will be replaced shallowly such
- * that nested instances are retained.
- */
-export declare function revealOpaqueJson<T>(value: T): RevealOpaqueJsonDeserialized<T>;
-/**
- * No-runtime-effect helper to automatically cast JSON type to Opaque JSON type
- * at outermost scope.
- *
- * @remarks
- * Types that satisfy {@link JsonSerializable} may also be deserialized. Thus,
- * the return type is both {@link OpaqueJsonSerializable} and
- * {@link OpaqueJsonDeserialized}.
- */
-export declare function toOpaqueJson<const T>(value: JsonSerializable<T>): OpaqueJsonSerializable<T> & OpaqueJsonDeserialized<T>;
-/**
- * Convert a union of types to an intersection of those types.
- *
- * @privateRemarks
- * First an always true extends clause is used (T extends T) to distribute T
- * into to a union of types contravariant over each member of the T union.
- * Then the constraint on the type parameter in this new context is inferred,
- * giving the intersection.
- *
- * Future: This definition is identical to one in `packages/dds/tree/src/util/typeUtils.ts`
- * and should be consolidated.
- */
-type UnionToIntersection<T> = (T extends T ? (k: T) => unknown : never) extends (k: infer U) => unknown ? U : never;
-/**
- * Generates a union of types that are the remainder from a simple
- * Pick combination (that is the set of common properties).
- */
-type PickRemainder<T> = Pick<T, keyof T> extends infer Common ? T extends unknown ? Omit<T, keyof Common> : never : never;
-/**
- * Combines union of structure into a single structure where common properties
- * are unions of their respective types and optional properties are defined for
- * properties that are not common to each union member.
- *
- * @remarks
- * If a property is common to multiple, but not all union member and the
- * types are incompatible, the resulting type will be `never` for that
- * property. (This can be fixed, but might be best addressed by changing
- * T to be a tuple of types to be combined.)
- */
-export type FlattenUnionWithOptionals<T> = InternalCoreInterfacesUtilityTypes.FlattenIntersection<Pick<T, keyof T> & UnionToIntersection<Partial<PickRemainder<T>>>>;
-/**
- * Type guard to check if a state is a required state (has a value).
- *
- * @param state - The state to check
- * @returns True if the state has a value and is therefore a {@link ValidatableRequiredState}
- */
-export declare function isValueRequiredState<T>(state: ValidatableRequiredState<T> | ValidatableOptionalState<T>): state is ValidatableRequiredState<T>;
-export {};
-//# sourceMappingURL=internalUtils.d.ts.map

package/lib/internalUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"internalUtils.d.ts","sourceRoot":"","sources":["../src/internalUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,YAAY,EACZ,kCAAkC,EAClC,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,0CAA0C,CAAC;AAElD,OAAO,KAAK,EACX,wBAAwB,EACxB,wBAAwB,EACxB,MAAM,uBAAuB,CAAC;AAE/B;;GAEG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;AAE7C,KAAK,yBAAyB,CAAC,CAAC,IAAI;KAClC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACrD,CAAC;AAEF,KAAK,aAAa,CAAC,CAAC,IAAI;KACtB,CAAC,IAAI,MAAM,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CACxE,CAAC,MAAM,yBAAyB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAElD,KAAK,uBAAuB,CAAC,CAAC,IAAI;KAChC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC;CAC1C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,eAAkC,CAAC,KAAK,cAAc,CAAC,CAAC,CAAC;AAEnF;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B,eACtC,CAAC,KACA,cAAc,wBAAwB,CAAC,CAAC,CAAC,CAAC;AAE/C;;GAEG;AACH,eAAO,MAAM,UAAU,eACnB,CAAC,KACA,CAAC,MAAM,0BAA0B,CAAC,CAAC,CAAC,EAAE,CAAC;AAE5C;;;;;;;;;;;GAWG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,KAAK,CAAC,CAAC,EAClF,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,GAAG,EAAE,CAAC,EACN,YAAY,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GACzB,CAAC,CAKH;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAE7D;AAGD,wBAAgB,gCAAgC,CAAC,CAAC,EACjD,KAAK,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAC9B,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AACrC,wBAAgB,gCAAgC,CAAC,CAAC,EACjD,KAAK,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,SAAS,GAC1C,YAAY,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC;AAWjD;;;GAGG;AACH,KAAK,4BAA4B,CAAC,CAAC,IAClC,CAAC,SAAS,sBAAsB,CAAC,MAAM,CAAC,CAAC,GACtC,gBAAgB,CAAC,CAAC,CAAC,GACnB;KAAG,GAAG,IAAI,MAAM,CAAC,GAAG,4BAA4B,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CAAE,CAAC;AAE/D;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,4BAA4B,CAAC,CAAC,CAAC,CAE7E;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,KAAK,CAAC,CAAC,EACnC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,GACxB,sBAAsB,CAAC,CAAC,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAEvD;AAED;;;;;;;;;;;GAWG;AACH,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,OAAO,GAAG,KAAK,CAAC,SAAS,CAC/E,CAAC,EAAE,MAAM,CAAC,KACN,OAAO,GACT,CAAC,GACD,KAAK,CAAC;AAET;;;GAGG;AACH,KAAK,aAAa,CAAC,CAAC,IACnB,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,SAAS,MAAM,MAAM,GAClC,CAAC,SAAS,OAAO,GAChB,IAAI,CAAC,CAAC,EAAE,MAAM,MAAM,CAAC,GACrB,KAAK,GACN,KAAK,CAAC;AAEV;;;;;;;;;;GAUG;AACH,MAAM,MAAM,yBAAyB,CAAC,CAAC,IACtC,kCAAkC,CAAC,mBAAmB,CACrD,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,GAAG,mBAAmB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CACjE,CAAC;AAEH;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EACrC,KAAK,EAAE,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,GAC9D,KAAK,IAAI,wBAAwB,CAAC,CAAC,CAAC,CAEtC"}

package/lib/internalUtils.js

@@ -1,90 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * Object.entries retyped to preserve known keys and their types.
- *
- * @privateRemarks
- * The is a defect in this utility when a string index appears in the object.
- * In such a case, the only result is `[string, T]`, where `T` is the type
- * of the string index entry.
- */
-export const objectEntries = Object.entries;
-/**
- * Object.entries retyped to preserve known keys and their types.
- *
- * @remarks
- * Given `T` should not contain `undefined` values. If it does, use
- * {@link objectEntries} instead. Without `undefined` values, this
- * typing provides best handling of objects with optional properties.
- */
-export const objectEntriesWithoutUndefined = Object.entries;
-/**
- * Object.keys retyped to preserve known keys and their types.
- */
-export const objectKeys = Object.keys;
-/**
- * Retrieve a value from a record with the given key, or create a new entry if
- * the key is not in the record.
- *
- * @param record - The record to index/update
- * @param key - The key to lookup in the record
- * @param defaultValue - a function which returns a default value. This is
- * called and used to set an initial value for the given key in the record if
- * none exists.
- * @returns either the existing value for the given key, or the newly-created
- * value (the result of `defaultValue`)
- */
-export function getOrCreateRecord(record, key, defaultValue) {
-    if (!(key in record)) {
-        record[key] = defaultValue(key);
-    }
-    return record[key];
-}
-/**
- * No-runtime-effect helper to apply deep immutability to a value's type.
- */
-export function asDeeplyReadonly(value) {
-    return value;
-}
-/**
- * No-runtime-effect helper to apply deep immutability to a value's opaque JSON
- * type, revealing the JSON type.
- */
-export function asDeeplyReadonlyDeserializedJson(value) {
-    return value;
-}
-/**
- * No-runtime-effect helper to reveal the JSON type from a value's opaque JSON
- * types throughout a structure.
- *
- * @remarks
- * {@link OpaqueJsonDeserialized} instances will be replaced shallowly such
- * that nested instances are retained.
- */
-export function revealOpaqueJson(value) {
-    return value;
-}
-/**
- * No-runtime-effect helper to automatically cast JSON type to Opaque JSON type
- * at outermost scope.
- *
- * @remarks
- * Types that satisfy {@link JsonSerializable} may also be deserialized. Thus,
- * the return type is both {@link OpaqueJsonSerializable} and
- * {@link OpaqueJsonDeserialized}.
- */
-export function toOpaqueJson(value) {
-    return value;
-}
-/**
- * Type guard to check if a state is a required state (has a value).
- *
- * @param state - The state to check
- * @returns True if the state has a value and is therefore a {@link ValidatableRequiredState}
- */
-export function isValueRequiredState(state) {
-    return state.value !== undefined;
-}
-//# sourceMappingURL=internalUtils.js.map

package/lib/internalUtils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"internalUtils.js","sourceRoot":"","sources":["../src/internalUtils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiCH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,OAA8C,CAAC;AAEnF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,MAAM,CAAC,OAEN,CAAC;AAE/C;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,IAEU,CAAC;AAE5C;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,iBAAiB,CAChC,MAAoB,EACpB,GAAM,EACN,YAA2B;IAE3B,IAAI,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAI,KAAQ;IAC3C,OAAO,KAAwB,CAAC;AACjC,CAAC;AASD;;;GAGG;AACH,MAAM,UAAU,gCAAgC,CAC/C,KAA4C;IAE5C,OAAO,KAAsD,CAAC;AAC/D,CAAC;AAWD;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAAI,KAAQ;IAC3C,OAAO,KAAwC,CAAC;AACjD,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAC3B,KAA0B;IAE1B,OAAO,KAA8D,CAAC;AACvE,CAAC;AA+CD;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CACnC,KAAgE;IAEhE,OAAO,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC;AAClC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tDeepReadonly,\n\tInternalCoreInterfacesUtilityTypes,\n\tJsonDeserialized,\n\tJsonSerializable,\n\tOpaqueJsonDeserialized,\n\tOpaqueJsonSerializable,\n} from \"@fluidframework/core-interfaces/internal\";\n\nimport type {\n\tValidatableOptionalState,\n\tValidatableRequiredState,\n} from \"./validatableTypes.js\";\n\n/**\n * Returns union of types of values in a record.\n */\nexport type RecordEntryTypes<T> = T[keyof T];\n\ntype MapNumberIndicesToStrings<T> = {\n\t[K in keyof T as K extends number ? `${K}` : K]: T[K];\n};\n\ntype KeyValuePairs<T> = {\n\t[K in keyof MapNumberIndicesToStrings<Required<T>>]: [K, Required<T>[K]];\n}[keyof MapNumberIndicesToStrings<Required<T>>][];\n\ntype RequiredAndNotUndefined<T> = {\n\t[K in keyof T]-?: Exclude<T[K], undefined>;\n};\n\n/**\n * Object.entries retyped to preserve known keys and their types.\n *\n * @privateRemarks\n * The is a defect in this utility when a string index appears in the object.\n * In such a case, the only result is `[string, T]`, where `T` is the type\n * of the string index entry.\n */\nexport const objectEntries = Object.entries as <const T>(o: T) => KeyValuePairs<T>;\n\n/**\n * Object.entries retyped to preserve known keys and their types.\n *\n * @remarks\n * Given `T` should not contain `undefined` values. If it does, use\n * {@link objectEntries} instead. Without `undefined` values, this\n * typing provides best handling of objects with optional properties.\n */\nexport const objectEntriesWithoutUndefined = Object.entries as <const T>(\n\to: T,\n) => KeyValuePairs<RequiredAndNotUndefined<T>>;\n\n/**\n * Object.keys retyped to preserve known keys and their types.\n */\nexport const objectKeys = Object.keys as <const T>(\n\to: T,\n) => (keyof MapNumberIndicesToStrings<T>)[];\n\n/**\n * Retrieve a value from a record with the given key, or create a new entry if\n * the key is not in the record.\n *\n * @param record - The record to index/update\n * @param key - The key to lookup in the record\n * @param defaultValue - a function which returns a default value. This is\n * called and used to set an initial value for the given key in the record if\n * none exists.\n * @returns either the existing value for the given key, or the newly-created\n * value (the result of `defaultValue`)\n */\nexport function getOrCreateRecord<const K extends string | number | symbol, const V>(\n\trecord: Record<K, V>,\n\tkey: K,\n\tdefaultValue: (key: K) => V,\n): V {\n\tif (!(key in record)) {\n\t\trecord[key] = defaultValue(key);\n\t}\n\treturn record[key];\n}\n\n/**\n * No-runtime-effect helper to apply deep immutability to a value's type.\n */\nexport function asDeeplyReadonly<T>(value: T): DeepReadonly<T> {\n\treturn value as DeepReadonly<T>;\n}\n\n// function overloads\nexport function asDeeplyReadonlyDeserializedJson<T>(\n\tvalue: OpaqueJsonDeserialized<T>,\n): DeepReadonly<JsonDeserialized<T>>;\nexport function asDeeplyReadonlyDeserializedJson<T>(\n\tvalue: OpaqueJsonDeserialized<T> | undefined,\n): DeepReadonly<JsonDeserialized<T>> | undefined;\n/**\n * No-runtime-effect helper to apply deep immutability to a value's opaque JSON\n * type, revealing the JSON type.\n */\nexport function asDeeplyReadonlyDeserializedJson<T>(\n\tvalue: OpaqueJsonDeserialized<T> | undefined,\n): DeepReadonly<JsonDeserialized<T>> | undefined {\n\treturn value as DeepReadonly<JsonDeserialized<T>> | undefined;\n}\n\n/**\n * Conditional type that reveals the underlying JSON type of an opaque JSON value. If `T` is an object, the key values\n * will be revealed.\n */\ntype RevealOpaqueJsonDeserialized<T> =\n\tT extends OpaqueJsonDeserialized<infer U>\n\t\t? JsonDeserialized<U>\n\t\t: { [Key in keyof T]: RevealOpaqueJsonDeserialized<T[Key]> };\n\n/**\n * No-runtime-effect helper to reveal the JSON type from a value's opaque JSON\n * types throughout a structure.\n *\n * @remarks\n * {@link OpaqueJsonDeserialized} instances will be replaced shallowly such\n * that nested instances are retained.\n */\nexport function revealOpaqueJson<T>(value: T): RevealOpaqueJsonDeserialized<T> {\n\treturn value as RevealOpaqueJsonDeserialized<T>;\n}\n\n/**\n * No-runtime-effect helper to automatically cast JSON type to Opaque JSON type\n * at outermost scope.\n *\n * @remarks\n * Types that satisfy {@link JsonSerializable} may also be deserialized. Thus,\n * the return type is both {@link OpaqueJsonSerializable} and\n * {@link OpaqueJsonDeserialized}.\n */\nexport function toOpaqueJson<const T>(\n\tvalue: JsonSerializable<T>,\n): OpaqueJsonSerializable<T> & OpaqueJsonDeserialized<T> {\n\treturn value as OpaqueJsonSerializable<T> & OpaqueJsonDeserialized<T>;\n}\n\n/**\n * Convert a union of types to an intersection of those types.\n *\n * @privateRemarks\n * First an always true extends clause is used (T extends T) to distribute T\n * into to a union of types contravariant over each member of the T union.\n * Then the constraint on the type parameter in this new context is inferred,\n * giving the intersection.\n *\n * Future: This definition is identical to one in `packages/dds/tree/src/util/typeUtils.ts`\n * and should be consolidated.\n */\ntype UnionToIntersection<T> = (T extends T ? (k: T) => unknown : never) extends (\n\tk: infer U,\n) => unknown\n\t? U\n\t: never;\n\n/**\n * Generates a union of types that are the remainder from a simple\n * Pick combination (that is the set of common properties).\n */\ntype PickRemainder<T> =\n\tPick<T, keyof T> extends infer Common\n\t\t? T extends unknown\n\t\t\t? Omit<T, keyof Common>\n\t\t\t: never\n\t\t: never;\n\n/**\n * Combines union of structure into a single structure where common properties\n * are unions of their respective types and optional properties are defined for\n * properties that are not common to each union member.\n *\n * @remarks\n * If a property is common to multiple, but not all union member and the\n * types are incompatible, the resulting type will be `never` for that\n * property. (This can be fixed, but might be best addressed by changing\n * T to be a tuple of types to be combined.)\n */\nexport type FlattenUnionWithOptionals<T> =\n\tInternalCoreInterfacesUtilityTypes.FlattenIntersection<\n\t\tPick<T, keyof T> & UnionToIntersection<Partial<PickRemainder<T>>>\n\t>;\n\n/**\n * Type guard to check if a state is a required state (has a value).\n *\n * @param state - The state to check\n * @returns True if the state has a value and is therefore a {@link ValidatableRequiredState}\n */\nexport function isValueRequiredState<T>(\n\tstate: ValidatableRequiredState<T> | ValidatableOptionalState<T>,\n): state is ValidatableRequiredState<T> {\n\treturn state.value !== undefined;\n}\n"]}