@genesislcap/foundation-utils 14.103.0-auth-mf.23 → 14.103.0-auth-mf.24

package/dist/custom-elements.json

@@ -414,6 +414,7 @@
               }
             }
           ],
+          "description": "assureDesignSystem.",
           "privacy": "public"
         }
       ],

package/dist/dts/design-system/design-system.d.ts

@@ -1,5 +1,6 @@
 import { DesignSystem } from '@microsoft/fast-foundation';
 /**
+ * DesignSystemModule.
  * @public
  */
 export interface DesignSystemModule {
@@ -7,10 +8,46 @@ export interface DesignSystemModule {
     [key: string]: any;
 }
 /**
+ * DesignSystemResource.
  * @public
  */
 export type DesignSystemResource<T = DesignSystemModule> = Promise<T>;
 /**
+ * assureDesignSystem.
+ *
+ * @remarks
+ * Webpack caching strategies can backfill missing modules with placeholders in an attempt to prevent errors. In the case
+ * of offline remotes, we rely on the error to fall back to local versions. This utility assures we have a design system.
+ *
+ * @example
+ * ```ts
+ * async function zeroDesignSystemImport(): Promise<DesignSystemModule> {
+ *   let module: DesignSystemModule;
+ *   let type: ResourceType = ResourceType.remote;
+ *   try {
+ *     module = await import('foundationZero/ZeroDesignSystem');
+ *     return assureDesignSystem(module);
+ *   } catch (e) {
+ *     logger.info(
+ *       `Please note remoteEntry.js load errors are expected if module federated dependencies are offline. Falling back to locally bundled versions.`,
+ *     );
+ *     type = ResourceType.local;
+ *     module = await import('@genesislcap/foundation-zero');
+ *     return assureDesignSystem(module);
+ *   } finally {
+ *     logger.debug(`Using '${type}' version of foundation-zero`);
+ *   }
+ * }
+ * ```
+ *
+ * @example You can also instruct webpack to use strict handling.
+ * ```ts
+ * output: {
+ *   strictModuleErrorHandling: true,
+ *   strictModuleExceptionHandling: true,
+ * }
+ * ```
+ *
  * @public
  */
 export declare function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;

package/dist/dts/design-system/design-system.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"design-system.d.ts","sourceRoot":"","sources":["../../../src/design-system/design-system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,mBAAmB,CACjB,OAAO,CAAC,EAAE,WAAW,EACrB,MAAM,CAAC,EAAE,MAAM,GACd,YAAY,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,kBAAkB,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;AAEtE;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,CAQjF"}
+{"version":3,"file":"design-system.d.ts","sourceRoot":"","sources":["../../../src/design-system/design-system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,mBAAmB,CACjB,OAAO,CAAC,EAAE,WAAW,EACrB,MAAM,CAAC,EAAE,MAAM,GACd,YAAY,GAAG,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACjD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,kBAAkB,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,kBAAkB,GAAG,kBAAkB,CAQjF"}

package/dist/esm/design-system/design-system.js

@@ -1,4 +1,39 @@
 /**
+ * assureDesignSystem.
+ *
+ * @remarks
+ * Webpack caching strategies can backfill missing modules with placeholders in an attempt to prevent errors. In the case
+ * of offline remotes, we rely on the error to fall back to local versions. This utility assures we have a design system.
+ *
+ * @example
+ * ```ts
+ * async function zeroDesignSystemImport(): Promise<DesignSystemModule> {
+ *   let module: DesignSystemModule;
+ *   let type: ResourceType = ResourceType.remote;
+ *   try {
+ *     module = await import('foundationZero/ZeroDesignSystem');
+ *     return assureDesignSystem(module);
+ *   } catch (e) {
+ *     logger.info(
+ *       `Please note remoteEntry.js load errors are expected if module federated dependencies are offline. Falling back to locally bundled versions.`,
+ *     );
+ *     type = ResourceType.local;
+ *     module = await import('@genesislcap/foundation-zero');
+ *     return assureDesignSystem(module);
+ *   } finally {
+ *     logger.debug(`Using '${type}' version of foundation-zero`);
+ *   }
+ * }
+ * ```
+ *
+ * @example You can also instruct webpack to use strict handling.
+ * ```ts
+ * output: {
+ *   strictModuleErrorHandling: true,
+ *   strictModuleExceptionHandling: true,
+ * }
+ * ```
+ *
  * @public
  */
 export function assureDesignSystem(module) {

package/dist/foundation-utils.api.json

@@ -230,7 +230,7 @@
         {
           "kind": "Function",
           "canonicalReference": "@genesislcap/foundation-utils!assureDesignSystem:function(1)",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * assureDesignSystem.\n *\n * @remarks\n *\n * Webpack caching strategies can backfill missing modules with placeholders in an attempt to prevent errors. In the case of offline remotes, we rely on the error to fall back to local versions. This utility assures we have a design system.\n *\n * @example\n * ```ts\n * async function zeroDesignSystemImport(): Promise<DesignSystemModule> {\n *   let module: DesignSystemModule;\n *   let type: ResourceType = ResourceType.remote;\n *   try {\n *     module = await import('foundationZero/ZeroDesignSystem');\n *     return assureDesignSystem(module);\n *   } catch (e) {\n *     logger.info(\n *       `Please note remoteEntry.js load errors are expected if module federated dependencies are offline. Falling back to locally bundled versions.`,\n *     );\n *     type = ResourceType.local;\n *     module = await import('@genesislcap/foundation-zero');\n *     return assureDesignSystem(module);\n *   } finally {\n *     logger.debug(`Using '${type}' version of foundation-zero`);\n *   }\n * }\n * ```\n *\n * @example\n *\n * You can also instruct webpack to use strict handling.\n * ```ts\n * output: {\n *   strictModuleErrorHandling: true,\n *   strictModuleExceptionHandling: true,\n * }\n * ```\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -2372,7 +2372,7 @@
         {
           "kind": "Interface",
           "canonicalReference": "@genesislcap/foundation-utils!DesignSystemModule:interface",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * DesignSystemModule.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -2519,7 +2519,7 @@
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-utils!DesignSystemResource:type",
-          "docComment": "/**\n * @public\n */\n",
+          "docComment": "/**\n * DesignSystemResource.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",

package/dist/foundation-utils.d.ts

@@ -29,6 +29,41 @@ export declare const activeColorScheme: CSSDesignToken<string>;
 export declare let API_HOST: string;
 
 /**
+ * assureDesignSystem.
+ *
+ * @remarks
+ * Webpack caching strategies can backfill missing modules with placeholders in an attempt to prevent errors. In the case
+ * of offline remotes, we rely on the error to fall back to local versions. This utility assures we have a design system.
+ *
+ * @example
+ * ```ts
+ * async function zeroDesignSystemImport(): Promise<DesignSystemModule> {
+ *   let module: DesignSystemModule;
+ *   let type: ResourceType = ResourceType.remote;
+ *   try {
+ *     module = await import('foundationZero/ZeroDesignSystem');
+ *     return assureDesignSystem(module);
+ *   } catch (e) {
+ *     logger.info(
+ *       `Please note remoteEntry.js load errors are expected if module federated dependencies are offline. Falling back to locally bundled versions.`,
+ *     );
+ *     type = ResourceType.local;
+ *     module = await import('@genesislcap/foundation-zero');
+ *     return assureDesignSystem(module);
+ *   } finally {
+ *     logger.debug(`Using '${type}' version of foundation-zero`);
+ *   }
+ * }
+ * ```
+ *
+ * @example You can also instruct webpack to use strict handling.
+ * ```ts
+ * output: {
+ *   strictModuleErrorHandling: true,
+ *   strictModuleExceptionHandling: true,
+ * }
+ * ```
+ *
  * @public
  */
 export declare function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;
@@ -268,6 +303,7 @@ export declare class DefaultServerRowDTOMapper implements ServerRowDTOMapper {
 }
 
 /**
+ * DesignSystemModule.
  * @public
  */
 export declare interface DesignSystemModule {
@@ -276,6 +312,7 @@ export declare interface DesignSystemModule {
 }
 
 /**
+ * DesignSystemResource.
  * @public
  */
 export declare type DesignSystemResource<T = DesignSystemModule> = Promise<T>;

package/docs/api/foundation-utils.assuredesignsystem.md

@@ -4,6 +4,7 @@
 
 ## assureDesignSystem() function
 
+assureDesignSystem.
 
 **Signature:**
 
@@ -21,3 +22,41 @@ export declare function assureDesignSystem(module: DesignSystemModule): DesignSy
 
 [DesignSystemModule](./foundation-utils.designsystemmodule.md)
 
+## Remarks
+
+Webpack caching strategies can backfill missing modules with placeholders in an attempt to prevent errors. In the case of offline remotes, we rely on the error to fall back to local versions. This utility assures we have a design system.
+
+## Example 1
+
+
+```ts
+async function zeroDesignSystemImport(): Promise<DesignSystemModule> {
+  let module: DesignSystemModule;
+  let type: ResourceType = ResourceType.remote;
+  try {
+    module = await import('foundationZero/ZeroDesignSystem');
+    return assureDesignSystem(module);
+  } catch (e) {
+    logger.info(
+      `Please note remoteEntry.js load errors are expected if module federated dependencies are offline. Falling back to locally bundled versions.`,
+    );
+    type = ResourceType.local;
+    module = await import('@genesislcap/foundation-zero');
+    return assureDesignSystem(module);
+  } finally {
+    logger.debug(`Using '${type}' version of foundation-zero`);
+  }
+}
+```
+
+## Example 2
+
+You can also instruct webpack to use strict handling.
+
+```ts
+output: {
+  strictModuleErrorHandling: true,
+  strictModuleExceptionHandling: true,
+}
+```
+

package/docs/api/foundation-utils.designsystemmodule.md

@@ -4,6 +4,7 @@
 
 ## DesignSystemModule interface
 
+DesignSystemModule.
 
 **Signature:**
 

package/docs/api/foundation-utils.designsystemresource.md

@@ -4,6 +4,7 @@
 
 ## DesignSystemResource type
 
+DesignSystemResource.
 
 **Signature:**
 

package/docs/api/foundation-utils.md

@@ -26,7 +26,7 @@
 
 |  Function | Description |
 |  --- | --- |
-|  [assureDesignSystem(module)](./foundation-utils.assuredesignsystem.md) |  |
+|  [assureDesignSystem(module)](./foundation-utils.assuredesignsystem.md) | assureDesignSystem. |
 |  [createLogger(name, options)](./foundation-utils.createlogger.md) | Creates a logger with the given name and options. |
 |  [customNumberParser(value)](./foundation-utils.customnumberparser.md) | A Default Number Parser for deserializing objects. |
 |  [formatDateTimestamp(timestamp)](./foundation-utils.formatdatetimestamp.md) | Formats \[DATE\] UNIX Timestamps (without time) to readable strings |
@@ -45,7 +45,7 @@
 |  --- | --- |
 |  [Database](./foundation-utils.database.md) | Represents a database with basic CRUD operations. |
 |  [DatabaseRecord](./foundation-utils.databaserecord.md) | Represents a database record. |
-|  [DesignSystemModule](./foundation-utils.designsystemmodule.md) |  |
+|  [DesignSystemModule](./foundation-utils.designsystemmodule.md) | DesignSystemModule. |
 |  [DTOMapper](./foundation-utils.dtomapper.md) |  |
 |  [ErrorMap](./foundation-utils.errormap.md) |  |
 |  [JSONSerializer](./foundation-utils.jsonserializer.md) | An interface representing a JSON serializer. |
@@ -108,7 +108,7 @@
 |  [ConstructableLifecycleHandler](./foundation-utils.constructablelifecyclehandler.md) |  |
 |  [ConstructablePendingState](./foundation-utils.constructablependingstate.md) | A mixin that provides functionality for raising <code>pending-state</code> events. |
 |  [ConversionType](./foundation-utils.conversiontype.md) | Represents the possible types of value conversion for data synchronization. |
-|  [DesignSystemResource](./foundation-utils.designsystemresource.md) |  |
+|  [DesignSystemResource](./foundation-utils.designsystemresource.md) | DesignSystemResource. |
 |  [ErrorDetailMap](./foundation-utils.errordetailmap.md) |  |
 |  [ErrorMapLogger](./foundation-utils.errormaplogger.md) |  |
 |  [EventName](./foundation-utils.eventname.md) | Represents the possible event names for data synchronization. |

package/docs/api-report.md

@@ -25,7 +25,7 @@ export const activeColorScheme: CSSDesignToken<string>;
 // @public
 export let API_HOST: string;
 
-// @public (undocumented)
+// @public
 export function assureDesignSystem(module: DesignSystemModule): DesignSystemModule;
 
 // Warning: (ae-internal-missing-underscore) The name "BIG_INT_64_BITS" should be prefixed with an underscore because the declaration is marked as @internal
@@ -163,7 +163,7 @@ export class DefaultServerRowDTOMapper implements ServerRowDTOMapper {
     toDTO: (entity: ServerRowEntity) => ServerRowDTO;
 }
 
-// @public (undocumented)
+// @public
 export interface DesignSystemModule {
     // (undocumented)
     [key: string]: any;
@@ -171,7 +171,7 @@ export interface DesignSystemModule {
     provideDesignSystem(element?: HTMLElement, prefix?: string): DesignSystem | Pick<DesignSystem, 'register'>;
 }
 
-// @public (undocumented)
+// @public
 export type DesignSystemResource<T = DesignSystemModule> = Promise<T>;
 
 // Warning: (ae-internal-missing-underscore) The name "DOMContainer" should be prefixed with an underscore because the declaration is marked as @internal

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-utils",
   "description": "Genesis Foundation Utils",
-  "version": "14.103.0-auth-mf.23",
+  "version": "14.103.0-auth-mf.24",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -19,12 +19,12 @@
     "test": "genx test"
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.103.0-auth-mf.23",
-    "@genesislcap/genx": "14.103.0-auth-mf.23",
+    "@genesislcap/foundation-testing": "14.103.0-auth-mf.24",
+    "@genesislcap/genx": "14.103.0-auth-mf.24",
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@genesislcap/foundation-logger": "14.103.0-auth-mf.23",
+    "@genesislcap/foundation-logger": "14.103.0-auth-mf.24",
     "@microsoft/fast-components": "^2.21.3",
     "@microsoft/fast-element": "^1.7.0",
     "@microsoft/fast-foundation": "^2.33.2",
@@ -42,5 +42,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "66e311fb26ce45f26e0083e7075e73948e1765e9"
+  "gitHead": "0ecbee6397572e9daf901d0560d465b653440f52"
 }