@genesislcap/foundation-utils 14.22.1 → 14.23.0

package/dist/dts/styles/slotted-styles.d.ts

@@ -1,6 +1,19 @@
 import { ElementStyles, FASTElement } from '@microsoft/fast-element';
+/**
+ * A custom element that encapsulates a set of styles that can be applied to slotted elements.
+ * @public
+ */
 export declare class SlottedStyles extends FASTElement {
+    /**
+     * The styles to apply to slotted elements.
+     */
     styles: ElementStyles;
+    /**
+     * Called when the `styles` property changes.
+     * Removes the previous styles from the parent element's FAST controller and adds the new styles.
+     * @param prev - The previous value of the `styles` property.
+     * @param next - The new value of the `styles` property.
+     */
     stylesChanged(prev: ElementStyles, next: ElementStyles): void;
 }
 //# sourceMappingURL=slotted-styles.d.ts.map

package/dist/dts/styles/slotted-styles.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"slotted-styles.d.ts","sourceRoot":"","sources":["../../../src/styles/slotted-styles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,aAAa,EAAE,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAEhG,qBAGa,aAAc,SAAQ,WAAW;IAChC,MAAM,EAAE,aAAa,CAAC;IAElC,aAAa,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,aAAa,GAAG,IAAI;CAO9D"}
+{"version":3,"file":"slotted-styles.d.ts","sourceRoot":"","sources":["../../../src/styles/slotted-styles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,aAAa,EAAE,WAAW,EAAc,MAAM,yBAAyB,CAAC;AAEhG;;;GAGG;AACH,qBAMa,aAAc,SAAQ,WAAW;IAC5C;;OAEG;IACS,MAAM,EAAE,aAAa,CAAC;IAElC;;;;;OAKG;IACH,aAAa,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,aAAa,GAAG,IAAI;CAO9D"}

package/dist/dts/styles/typography.d.ts

@@ -1,8 +1,22 @@
-export declare const loadFontFaces: (fontFaceRules: any, styleElementId: any) => void;
+/**
+ * Loads font faces by inserting a style element with the specified font face rules into the document.
+ * @param fontFaceRules - The CSS rules for the font faces.
+ * @param styleElementId - The ID of the style element to insert into the document.
+ * @public
+ */
+export declare const loadFontFaces: (fontFaceRules: string, styleElementId: string) => void;
+/**
+ * An enum of possible font styles.
+ * @public
+ */
 export declare enum FontStyle {
     Italic = "italic",
     Normal = "normal"
 }
+/**
+ * An enum of possible font weights.
+ * @public
+ */
 export declare enum FontWeight {
     Thin = 100,
     Light = 300,
@@ -11,7 +25,19 @@ export declare enum FontWeight {
     Bold = 700,
     Black = 900
 }
+/**
+ * Generates a CSS mixin for the specified font family, style, and weight.
+ * @param family - The font family.
+ * @param style - Optional. The font style. Defaults to FontStyle.Normal.
+ * @param weight - Optional. The font weight. Defaults to FontWeight.Regular.
+ * @returns The generated CSS mixin.
+ * @public
+ */
 export declare const getFontMixin: (family: string, style?: FontStyle, weight?: FontWeight) => string;
+/**
+ * An object containing type ramp values.
+ * @public
+ */
 export declare const TypeRampValues: {
     readonly minusOne: -1;
     readonly minusTwo: -2;

package/dist/dts/styles/typography.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typography.d.ts","sourceRoot":"","sources":["../../../src/styles/typography.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,aAAa,mDAEzB,CAAC;AAEF,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED,oBAAY,UAAU;IACpB,IAAI,MAAM;IACV,KAAK,MAAM;IACX,OAAO,MAAM;IACb,MAAM,MAAM;IACZ,IAAI,MAAM;IACV,KAAK,MAAM;CACZ;AAED,eAAO,MAAM,YAAY,WACf,MAAM,UACP,SAAS,WACR,UAAU,WAKnB,CAAC;AAEF,eAAO,MAAM,cAAc;;;;;;;;;CASjB,CAAC"}
+{"version":3,"file":"typography.d.ts","sourceRoot":"","sources":["../../../src/styles/typography.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,aAAa,kBAAmB,MAAM,kBAAkB,MAAM,KAAG,IAE7E,CAAC;AAEF;;;GAGG;AACH,oBAAY,SAAS;IACnB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAED;;;GAGG;AACH,oBAAY,UAAU;IACpB,IAAI,MAAM;IACV,KAAK,MAAM;IACX,OAAO,MAAM;IACb,MAAM,MAAM;IACZ,IAAI,MAAM;IACV,KAAK,MAAM;CACZ;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,YAAY,WACf,MAAM,UACP,SAAS,WACR,UAAU,KACjB,MAIF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc;;;;;;;;;CASjB,CAAC"}

package/dist/dts/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.34.4"
+    }
+  ]
+}

package/dist/dts/uuid/uuid.d.ts

@@ -1,11 +1,30 @@
 /**
- * Allow apps to tailor UUID generation, see constructor note.
+ * A configuration object for customizing UUID generation.
+ * @public
  */
 export interface UUIDConfig {
 }
+/**
+ * An interface for generating UUIDs.
+ * @public
+ */
 export interface UUID {
-    createId(): string;
-    createRemoteId(): Promise<string>;
+    /**
+     * Generates a new UUID.
+     * @param withLogging - Optional. Whether to log the generated UUID to the console. Defaults to false.
+     * @returns The generated UUID.
+     */
+    createId(withLogging?: boolean): string;
+    /**
+     * Generates a new UUID for a remote object.
+     * @param withLogging - Optional. Whether to log the generated UUID to the console. Defaults to false.
+     * @returns A promise that resolves to the generated UUID.
+     */
+    createRemoteId(withLogging?: boolean): Promise<string>;
 }
+/**
+ * A dependency injection token for the UUID interface.
+ * @public
+ */
 export declare const UUID: import("@microsoft/fast-foundation").InterfaceSymbol<UUID>;
 //# sourceMappingURL=uuid.d.ts.map

package/dist/dts/uuid/uuid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../../src/uuid/uuid.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,WAAW,UAAU;CAE1B;AAED,MAAM,WAAW,IAAI;IACnB,QAAQ,IAAI,MAAM,CAAC;IACnB,cAAc,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;CACnC;AAoCD,eAAO,MAAM,IAAI,4DAA4D,CAAC"}
+{"version":3,"file":"uuid.d.ts","sourceRoot":"","sources":["../../../src/uuid/uuid.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,WAAW,UAAU;CAE1B;AAED;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAExC;;;;OAIG;IACH,cAAc,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACxD;AAyCD;;;GAGG;AACH,eAAO,MAAM,IAAI,4DAA4D,CAAC"}

package/dist/dts/window/window.d.ts

@@ -1,6 +1,33 @@
+/**
+ * Returns a boolean value indicating whether the current window is inside an iframe.
+ * @returns true if the window is inside an iframe, false otherwise.
+ * @public
+ */
 export declare const inIFrame: () => boolean;
+/**
+ * Returns a boolean value indicating whether the user is running the Symphony desktop app.
+ * @returns true if the user is running the Symphony desktop app, false otherwise.
+ * @public
+ */
 export declare const inSymphonyDesktop: () => boolean;
+/**
+ * The default width (in pixels) for pop-up windows.
+ * @public
+ */
 export declare const POPUP_DEFAULT_WIDTH = 483;
+/**
+ * The default height (in pixels) for pop-up windows.
+ * @public
+ */
 export declare const POPUP_DEFAULT_HEIGHT = 600;
+/**
+ * Opens a new browser window with the specified URL, target, width, and height.
+ * @param urlNavigate - The URL to navigate to.
+ * @param target - The name of the new window.
+ * @param popUpWidth - The width of the new window (optional).
+ * @param popUpHeight - The height of the new window (optional).
+ * @returns A reference to the new window.
+ * @public
+ */
 export declare const openPopup: (urlNavigate: string, target: string, popUpWidth?: number, popUpHeight?: number) => Window;
 //# sourceMappingURL=window.d.ts.map

package/dist/dts/window/window.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"window.d.ts","sourceRoot":"","sources":["../../../src/window/window.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,QAAQ,eAMpB,CAAC;AAEF,eAAO,MAAM,iBAAiB,eAG7B,CAAC;AAEF,eAAO,MAAM,mBAAmB,MAAM,CAAC;AACvC,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC,eAAO,MAAM,SAAS,gBACP,MAAM,UACX,MAAM,eACF,MAAM,gBACL,MAAM,WAuBpB,CAAC"}
+{"version":3,"file":"window.d.ts","sourceRoot":"","sources":["../../../src/window/window.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,QAAQ,QAAO,OAM3B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,QAAO,OAGpC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,mBAAmB,MAAM,CAAC;AAEvC;;;GAGG;AACH,eAAO,MAAM,oBAAoB,MAAM,CAAC;AAExC;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,gBACP,MAAM,UACX,MAAM,eACF,MAAM,gBACL,MAAM,KAClB,MAsBF,CAAC"}

package/dist/esm/data/inMemoryDatabase.js

@@ -3,6 +3,7 @@ import { createObserver } from '../observer';
 import { logger } from '../utils';
 /**
  * An in memory database of specific DatabaseRecord types.
+ * @public
  */
 export class InMemoryDatabase {
     constructor(uuid) {

package/dist/esm/directives/sync/sync.js

@@ -1,4 +1,8 @@
 import { HTMLBindingDirective, } from '@microsoft/fast-element';
+/**
+ * A map that associates specific HTML element tags with their corresponding default event names.
+ * @public
+ */
 export const defaultEventMap = new Map([
     ['FAST-TEXT-AREA', 'input'],
     ['FAST-TEXT-FIELD', 'input'],
@@ -84,6 +88,10 @@ class SyncDirective extends HTMLBindingDirective {
         }
     }
 }
+/**
+ * Creates a synchronization directive that binds a data source to an HTML element,
+ * @public
+ */
 export function sync(binding, conversionType = 'string', eventName = 'default', keyAttr) {
     return new SyncDirective(binding, conversionType, eventName, keyAttr);
 }

package/dist/esm/directives/when-else/when-else.js

@@ -1,5 +1,5 @@
 /**
- * Directive that allows supplying an "else" template to the traditional {@link @link @microsoft/fast-element#when} directive
+ * Directive that allows supplying an "else" template to the traditional {@link https://www.fast.design/docs/api/fast-element.when/#when-function} directive
  *
  * @param binding - The condition to test for rendering.
  * @param trueTemplateOrTemplateBinding - The template or a binding that gets the template to render when the condition is true.

package/dist/esm/env/is-dev.js

@@ -1 +1,5 @@
+/**
+ * Determines if the current environment is a development environment.
+ * @public
+ */
 export const isDev = () => !process.env.NODE_ENV || process.env.NODE_ENV === 'development';

package/dist/esm/env/variables.js

@@ -1,40 +1,77 @@
 /* eslint-disable import/no-mutable-exports */
+/**
+ * The Genesis Server (host0 to establish a connection (WebSocket or HTTP)).
+ * Example: wss://localhost:9064
+ * @remarks Required.
+ * @public
+ */
 let _API_HOST;
 try {
     _API_HOST = API_HOST;
 }
 catch (_a) { }
 export { _API_HOST as API_HOST };
+/**
+ * The path to a JSON config file for the HTTP mode.
+ * @remarks Optional.
+ * @public
+ */
 let _FORCE_HTTP;
 try {
     _FORCE_HTTP = FORCE_HTTP;
 }
 catch (_b) { }
 export { _FORCE_HTTP as FORCE_HTTP };
+/**
+ * Configuration settings for HTTP, used in http connect flow [`genesislcap-foundation-comms.HttpConnectConfig`](https://link-to-docs).
+ * @remarks Optional.
+ * @public
+ */
 let _HTTP_CONFIG;
 try {
     _HTTP_CONFIG = HTTP_CONFIG;
 }
 catch (_c) { }
 export { _HTTP_CONFIG as HTTP_CONFIG };
+/**
+ * The default Organisation value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
+ * @remarks Optional.
+ * @public
+ */
 let _DEFAULT_ORGANISATION;
 try {
     _DEFAULT_ORGANISATION = DEFAULT_ORGANISATION;
 }
 catch (_d) { }
 export { _DEFAULT_ORGANISATION as DEFAULT_ORGANISATION };
+/**
+ * The default Password value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
+ * @remarks Optional.
+ * @public
+ */
 let _DEFAULT_PASSWORD;
 try {
     _DEFAULT_PASSWORD = DEFAULT_PASSWORD;
 }
 catch (_e) { }
 export { _DEFAULT_PASSWORD as DEFAULT_PASSWORD };
+/**
+ * The default Username value, used in auth/login flow [`genesislcap-foundation-login`](https://link-to-docs).
+ * @remarks Optional.
+ * @public
+ */
 let _DEFAULT_USER;
 try {
     _DEFAULT_USER = DEFAULT_USER;
 }
 catch (_f) { }
 export { _DEFAULT_USER as DEFAULT_USER };
+/**
+ * The sub-path used for WebSocket connections.
+ * Example: API_HOST + '/' + SOCKET_EXT - wss://localhost:9064/gwf.
+ * @remarks Optional. Default is "API_HOST/gwf"
+ * @public
+ */
 let _SOCKET_EXT;
 try {
     _SOCKET_EXT = SOCKET_EXT;

package/dist/esm/formatters/datetime.js

@@ -21,8 +21,8 @@ export function formatDateTimeTimestamp(timestamp) {
 /**
  * Formats [DATE|DATETIME] Unix Timestamps to readable strings
  * @public
- * @param {number} timestamp - The UNIX Timestamp.
- * @param {boolean} withTime - The flag to determine if formatted value should contain 'time' info.
+ * @param timestamp - The UNIX Timestamp.
+ * @param withTime - The flag to determine if formatted value should contain 'time' info.
  */
 export function formatTimestamp(timestamp, withTime) {
     if (withTime) {

package/dist/esm/logger/logger.js

@@ -1,9 +1,20 @@
 import consola from 'consola/src/browser';
 export { LogLevel } from 'consola';
 const logLevelDebug = 4;
+/**
+ * The default logger options.
+ * @public
+ */
 export const defaultLoggerOptions = {
     level: logLevelDebug,
 };
+/**
+ * Creates a logger with the given name and options.
+ * @param name - The name to give the logger.
+ * @param options - The options to use when creating the logger.
+ * @returns The resulting logger.
+ * @public
+ */
 export function createLogger(name, options = defaultLoggerOptions) {
     const baseLogger = consola.create(options);
     const logger = baseLogger.withTag(name);

package/dist/esm/mappers/dto/serverRow.js

@@ -1,6 +1,16 @@
 import { DI } from '@microsoft/fast-foundation';
+/**
+ * The default `ServerRowDTOMapper`.
+ * @public
+ */
 export class DefaultServerRowDTOMapper {
     constructor() {
+        /**
+         * Converts a server row DTO to an entity.
+         * @param dto - The DTO to convert.
+         * @returns The resulting entity.
+         * @public
+         */
         this.fromDTO = (dto) => {
             var _a, _b, _c;
             return ({
@@ -10,6 +20,12 @@ export class DefaultServerRowDTOMapper {
                 },
             });
         };
+        /**
+         * Converts a server row entity to a DTO.
+         * @param entity - The entity to convert.
+         * @returns The resulting DTO.
+         * @public
+         */
         this.toDTO = (entity) => {
             var _a, _b, _c;
             return ({
@@ -21,4 +37,8 @@ export class DefaultServerRowDTOMapper {
         };
     }
 }
+/**
+ * A DI token used to obtain a `ServerRowDTOMapper` instance.
+ * @public
+ */
 export const ServerRowDTOMapper = DI.createInterface((x) => x.singleton(DefaultServerRowDTOMapper));

package/dist/esm/mixins/pendingState/pendingState.js

@@ -1,23 +1,50 @@
 import { __awaiter, __decorate } from "tslib";
 import { observable } from '@microsoft/fast-element';
 import { logger } from '../../utils';
+/**
+ * An enum that defines the names of the events that can be raised by the `PendingState` mixin.
+ * @public
+ */
 export var PendingStateEvents;
 (function (PendingStateEvents) {
     PendingStateEvents["state"] = "pending-state";
     PendingStateEvents["error"] = "pending-state-error";
 })(PendingStateEvents || (PendingStateEvents = {}));
-// WIP
+/**
+ * The `PendingState` mixin.
+ * @public
+ */
 export const PendingState = (Base) => {
     class Pending extends Base {
         constructor() {
             super(...arguments);
+            /**
+             * The number of promises that are currently pending.
+             * @public
+             */
             this.pendingCount = 0;
+            /**
+             * The number of promises that have been resolved.
+             * @public
+             */
             this.resolvedCount = 0;
+            /**
+             * A boolean indicating whether there are any pending children.
+             * @public
+             */
             this.hasPendingChildren = false;
         }
+        /**
+         * Gets the progress of the pending promises as a percentage between 0 and 1.
+         * @public
+         */
         get progress() {
             return this.resolvedCount / this.pendingCount;
         }
+        /**
+         * Called when the element is connected to the DOM.
+         * @internal
+         */
         connectedCallback() {
             super.connectedCallback();
             logger.debug(`PendingState mixin is now connected to the DOM`);
@@ -26,11 +53,20 @@ export const PendingState = (Base) => {
              */
             this.addEventListener(PendingStateEvents.state, this.onPendingState);
         }
+        /**
+         * Called when the element is disconnected from the DOM.
+         * @internal
+         */
         disconnectedCallback() {
             super.disconnectedCallback();
             logger.debug(`PendingState mixin is now disconnected from the DOM`);
             this.removeEventListener(PendingStateEvents.state, this.onPendingState);
         }
+        /**
+         * Handles the `pending-state` event.
+         * @param event - The `pending-state` event.
+         * @internal
+         */
         onPendingState({ detail }) {
             return __awaiter(this, void 0, void 0, function* () {
                 const { promise } = detail;

package/dist/esm/observer/observer.js

@@ -1,3 +1,7 @@
+/**
+ * Creates a new event observer instance.
+ * @public
+ */
 export const createObserver = () => {
     let listeners = [];
     return {
@@ -13,7 +17,7 @@ export const createObserver = () => {
 /**
  * Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen
  * @param element - HTMLElement to observe
- * @param callback - (boolean) => any function called when the visibility changes
+ * @param callback - any function called when the visibility changes
  * @public
  */
 export const respondToVisibility = (element, callback) => {

package/dist/esm/resource/types.js

@@ -1,4 +1,5 @@
 /**
+ * An object that defines two resource types: "local" and "remote".
  * @public
  */
 export const ResourceType = {

package/dist/esm/serializers/json/json.js

@@ -1,8 +1,18 @@
 import { DI } from '@microsoft/fast-foundation';
 class DefaultJSONSerializer {
     constructor() {
+        /**
+         * Serializes an object to a JSON string using `JSON.stringify`.
+         * @param object - The object to serialize.
+         * @returns The serialized JSON string.
+         */
         this.serialize = (object) => JSON.stringify(object);
     }
+    /**
+     * Deserializes a response object from a HTTP request to a JavaScript object using `JSON.parse`.
+     * @param input - The HTTP response object.
+     * @returns A promise that resolves to the deserialized JavaScript object.
+     */
     deserialize(input) {
         if (input && input.ok) {
             return input.text().then((text) => JSON.parse(text));
@@ -13,4 +23,8 @@ class DefaultJSONSerializer {
         return JSON.parse(input);
     }
 }
+/**
+ * A DI token for the JSON serializer.
+ * @public
+ */
 export const JSONSerializer = DI.createInterface((x) => x.singleton(DefaultJSONSerializer));

package/dist/esm/styles/color.js

@@ -1,4 +1,14 @@
 import { baseLayerLuminance, StandardLuminance } from '@microsoft/fast-components';
 import { DesignToken } from '@microsoft/fast-foundation';
 const { create } = DesignToken;
-export const activeColorScheme = create('active-color-scheme').withDefault((elem) => baseLayerLuminance.getValueFor(elem) === StandardLuminance.LightMode ? 'light' : 'dark');
+/**
+ * A design token that represents the active color scheme (light or dark).
+ * @public
+ */
+export const activeColorScheme = create('active-color-scheme').withDefault(
+/**
+ * A callback function that returns the active color scheme based on the base layer luminance of the provided element.
+ * @param {HTMLElement} elem The element to get the active color scheme for.
+ * @returns {string} The active color scheme ('light' or 'dark').
+ */
+(elem) => baseLayerLuminance.getValueFor(elem) === StandardLuminance.LightMode ? 'light' : 'dark');

package/dist/esm/styles/dom.js

@@ -1,4 +1,12 @@
 import { logger } from '../utils/logger';
+/**
+ * Inserts a CSS rule into the document by creating a new style element or using an existing one with the specified ID.
+ * Returns a function that can be called to remove the rule from the document.
+ * @public
+ * @param cssRule - The CSS rule to insert.
+ * @param styleElementId - The ID of the style element to use or create.
+ * @returns A function that removes the rule from the document.
+ */
 export const insertDocumentCSSRule = (cssRule, styleElementId) => {
     var _a;
     let styleElement = document.getElementById(styleElementId);
@@ -21,6 +29,11 @@ export const insertDocumentCSSRule = (cssRule, styleElementId) => {
         headElement.removeChild(styleElement);
     };
 };
+/**
+ * Inserts a CSS link into the document if it doesn't already exist.
+ * @public
+ * @param href - The URL of the CSS file to insert.
+ */
 export const insertDocumentLink = (href) => {
     const links = document.head.querySelectorAll('link');
     // Already been injected

package/dist/esm/styles/slotted-styles.js

@@ -1,6 +1,16 @@
 import { __decorate } from "tslib";
 import { customElement, FASTElement, observable } from '@microsoft/fast-element';
+/**
+ * A custom element that encapsulates a set of styles that can be applied to slotted elements.
+ * @public
+ */
 let SlottedStyles = class SlottedStyles extends FASTElement {
+    /**
+     * Called when the `styles` property changes.
+     * Removes the previous styles from the parent element's FAST controller and adds the new styles.
+     * @param prev - The previous value of the `styles` property.
+     * @param next - The new value of the `styles` property.
+     */
     stylesChanged(prev, next) {
         if (prev) {
             this.parentElement.$fastController.removeStyles(prev);
@@ -15,5 +25,8 @@ SlottedStyles = __decorate([
     customElement({
         name: 'slotted-styles',
     })
+    /**
+     * A custom element that encapsulates a set of styles that can be applied to slotted elements.
+     */
 ], SlottedStyles);
 export { SlottedStyles };

package/dist/esm/styles/typography.js

@@ -1,12 +1,26 @@
 import { insertDocumentCSSRule } from './dom';
+/**
+ * Loads font faces by inserting a style element with the specified font face rules into the document.
+ * @param fontFaceRules - The CSS rules for the font faces.
+ * @param styleElementId - The ID of the style element to insert into the document.
+ * @public
+ */
 export const loadFontFaces = (fontFaceRules, styleElementId) => {
     insertDocumentCSSRule(fontFaceRules, styleElementId);
 };
+/**
+ * An enum of possible font styles.
+ * @public
+ */
 export var FontStyle;
 (function (FontStyle) {
     FontStyle["Italic"] = "italic";
     FontStyle["Normal"] = "normal";
 })(FontStyle || (FontStyle = {}));
+/**
+ * An enum of possible font weights.
+ * @public
+ */
 export var FontWeight;
 (function (FontWeight) {
     FontWeight[FontWeight["Thin"] = 100] = "Thin";
@@ -16,11 +30,23 @@ export var FontWeight;
     FontWeight[FontWeight["Bold"] = 700] = "Bold";
     FontWeight[FontWeight["Black"] = 900] = "Black";
 })(FontWeight || (FontWeight = {}));
+/**
+ * Generates a CSS mixin for the specified font family, style, and weight.
+ * @param family - The font family.
+ * @param style - Optional. The font style. Defaults to FontStyle.Normal.
+ * @param weight - Optional. The font weight. Defaults to FontWeight.Regular.
+ * @returns The generated CSS mixin.
+ * @public
+ */
 export const getFontMixin = (family, style = FontStyle.Normal, weight = FontWeight.Regular) => `
   font-family: ${family};
   font-style: ${style};
   font-weight: ${weight};
 `;
+/**
+ * An object containing type ramp values.
+ * @public
+ */
 export const TypeRampValues = {
     minusOne: -1,
     minusTwo: -2,

package/dist/esm/uuid/uuid.js

@@ -2,32 +2,37 @@ import { __awaiter } from "tslib";
 import { DI } from '@microsoft/fast-foundation';
 import { v4 as uuidv4 } from 'uuid';
 import { logger } from '../utils';
+/**
+ * A service that implements the UUID interface and provides default UUID generation using the uuidv4 library.
+ */
 class UUIDService {
     /**
-     * @UUIDConfig private config: UUIDConfig;
-     *
-     * // Could inject something like this from the app level:
-     * export const AppUUIDConfig = DI.createInterface<UUIDConfig>(); // < Strongly typed key
-     * container.register(
-     *      Registration.instance(AppUUIDConfig, {
-     *          random: [...]
-     *      })
-     * );
+     * Constructs a new instance of the UUIDService.
      */
     constructor() { }
+    /**
+     * Generates a new UUID.
+     * @param withLogging - Optional. Whether to log the generated UUID to the console. Defaults to false.
+     * @returns The generated UUID.
+     */
     createId(withLogging = false) {
         /**
-         * Use this.config to customise uuidv4
+         * Use this.config to customize uuidv4.
          */
         const id = uuidv4();
         withLogging && logger.debug(`UUID.createID ${id}`);
         return id;
     }
+    /**
+     * Generates a new UUID for a remote object.
+     * @param withLogging - Optional. Whether to log the generated UUID to the console. Defaults to false.
+     * @returns A promise that resolves to the generated UUID.
+     */
     createRemoteId(withLogging = false) {
         return __awaiter(this, void 0, void 0, function* () {
             /**
              * TODO: Revisit async nature of id generation with potential server involvement
-             * Use this.config to customise uuidv4
+             * Use this.config to customize uuidv4.
              */
             const id = uuidv4();
             withLogging && logger.debug(`UUID.createRemoteID ${id}`);
@@ -35,4 +40,8 @@ class UUIDService {
         });
     }
 }
+/**
+ * A dependency injection token for the UUID interface.
+ * @public
+ */
 export const UUID = DI.createInterface((x) => x.singleton(UUIDService));