@genesislcap/foundation-shell 14.131.0 → 14.132.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (184) hide show
  1. package/MODULE_FEDERATION.md +11 -0
  2. package/README.md +19 -31
  3. package/dist/{13.13.60f90061d33208d1354b.js → 13.13.25393d337a73ab04aacd.js} +2 -2
  4. package/dist/{13.4d4d342ba791da63d597e22d6d61f90f.js.map → 13.18ce90986215931e094ef572bdb883d6.js.map} +1 -1
  5. package/dist/InjectManifest.e1f16063b12a45e391ae7b4f95241ab2.js.map +1 -0
  6. package/dist/dts/app/app.d.ts +159 -0
  7. package/dist/dts/app/app.d.ts.map +1 -0
  8. package/dist/dts/app/behaviors.d.ts +53 -0
  9. package/dist/dts/app/behaviors.d.ts.map +1 -0
  10. package/dist/dts/app/config.d.ts +25 -0
  11. package/dist/dts/app/config.d.ts.map +1 -0
  12. package/dist/dts/app/index.d.ts +5 -0
  13. package/dist/dts/app/index.d.ts.map +1 -0
  14. package/dist/dts/app/types.d.ts +700 -0
  15. package/dist/dts/app/types.d.ts.map +1 -0
  16. package/dist/dts/app/utils.d.ts +61 -0
  17. package/dist/dts/app/utils.d.ts.map +1 -0
  18. package/dist/dts/index.docs.d.ts +8 -0
  19. package/dist/dts/index.docs.d.ts.map +1 -0
  20. package/dist/dts/layouts/default/layout.d.ts.map +1 -1
  21. package/dist/dts/layouts/formatsExample/layout.d.ts.map +1 -1
  22. package/dist/dts/main/main.d.ts +3 -0
  23. package/dist/dts/main/main.d.ts.map +1 -1
  24. package/dist/dts/main/main.styles.d.ts +3 -0
  25. package/dist/dts/main/main.styles.d.ts.map +1 -1
  26. package/dist/dts/main/main.template.d.ts +9 -0
  27. package/dist/dts/main/main.template.d.ts.map +1 -1
  28. package/dist/dts/pbc/index.d.ts +2 -0
  29. package/dist/dts/pbc/index.d.ts.map +1 -0
  30. package/dist/dts/pbc/pbc.d.ts +68 -0
  31. package/dist/dts/pbc/pbc.d.ts.map +1 -0
  32. package/dist/dts/pbc/vite/exports.d.ts +26 -0
  33. package/dist/dts/pbc/vite/exports.d.ts.map +1 -0
  34. package/dist/dts/pbc/vite/index.d.ts +2 -0
  35. package/dist/dts/pbc/vite/index.d.ts.map +1 -0
  36. package/dist/dts/pbc/vite/utils.d.ts +8 -0
  37. package/dist/dts/pbc/vite/utils.d.ts.map +1 -0
  38. package/dist/dts/pbc/webpack/exports.d.ts +26 -0
  39. package/dist/dts/pbc/webpack/exports.d.ts.map +1 -0
  40. package/dist/dts/pbc/webpack/index.d.ts +2 -0
  41. package/dist/dts/pbc/webpack/index.d.ts.map +1 -0
  42. package/dist/dts/pbc/webpack/utils.d.ts +9 -0
  43. package/dist/dts/pbc/webpack/utils.d.ts.map +1 -0
  44. package/dist/dts/serviceWorker/serviceWorker.d.ts +5 -0
  45. package/dist/dts/serviceWorker/serviceWorker.d.ts.map +1 -1
  46. package/dist/dts/tsdoc-metadata.json +11 -0
  47. package/dist/esm/app/app.js +190 -0
  48. package/dist/esm/app/behaviors.js +126 -0
  49. package/dist/esm/app/config.js +28 -0
  50. package/dist/esm/app/index.js +4 -0
  51. package/dist/esm/app/types.js +1 -0
  52. package/dist/esm/app/utils.js +102 -0
  53. package/dist/esm/index.docs.js +7 -0
  54. package/dist/esm/layouts/default/layout.js +3 -0
  55. package/dist/esm/layouts/formatsExample/layout.js +3 -0
  56. package/dist/esm/main/main.js +3 -0
  57. package/dist/esm/main/main.styles.js +3 -0
  58. package/dist/esm/main/main.template.js +9 -0
  59. package/dist/esm/pbc/index.js +1 -0
  60. package/dist/esm/pbc/pbc.js +82 -0
  61. package/dist/esm/pbc/vite/exports.js +38 -0
  62. package/dist/esm/pbc/vite/index.js +1 -0
  63. package/dist/esm/pbc/vite/utils.js +16 -0
  64. package/dist/esm/pbc/webpack/exports.js +26 -0
  65. package/dist/esm/pbc/webpack/index.js +1 -0
  66. package/dist/esm/pbc/webpack/utils.js +16 -0
  67. package/dist/esm/serviceWorker/serviceWorker.js +2 -0
  68. package/dist/foundation-shell.api.json +4415 -0
  69. package/dist/foundation-shell.d.ts +1098 -0
  70. package/dist/{foundationShell.36a3b143a4ba39b4f032455d8eb5e502.js.map → foundationShell.fd507b03419afeadf6bdbe8d1f3fe68d.js.map} +1 -1
  71. package/dist/index.html +2 -2
  72. package/dist/{main.6f018458fb996d9110cc5fd4557cc7b2.js.map → main.29e17abf31c88f12479a7d0f038eaf1e.js.map} +1 -1
  73. package/dist/{main.21fe80be0d6102e2dccf.js → main.d14d2a767d0adcf0df23.js} +2 -2
  74. package/dist/remoteEntry.js +2 -2
  75. package/dist/sw.js +2 -2
  76. package/dist/{swRegistration.de691080ebb6f93ca0a423137ad2c19a.js.map → swRegistration.c548ed7b6209691de616d314b3cc7d74.js.map} +1 -1
  77. package/dist/{swRegistration.5825d13b9d973891da34.js → swRegistration.edc6c10e9b6d64fe5b02.js} +2 -2
  78. package/docs/.gitattributes +2 -0
  79. package/docs/api/foundation-shell.app.config.md +13 -0
  80. package/docs/api/foundation-shell.app.deregisterassets.md +17 -0
  81. package/docs/api/foundation-shell.app.hasassets.md +17 -0
  82. package/docs/api/foundation-shell.app.md +49 -0
  83. package/docs/api/foundation-shell.app.registerassets.md +52 -0
  84. package/docs/api/foundation-shell.appassets.elements.md +13 -0
  85. package/docs/api/foundation-shell.appassets.md +25 -0
  86. package/docs/api/foundation-shell.appassets.metadata.md +13 -0
  87. package/docs/api/foundation-shell.appassets.registrations.md +13 -0
  88. package/docs/api/foundation-shell.appassets.routes.md +13 -0
  89. package/docs/api/foundation-shell.appassets.stores.md +13 -0
  90. package/docs/api/foundation-shell.appassets.styles.md +13 -0
  91. package/docs/api/foundation-shell.appconfig.context.md +11 -0
  92. package/docs/api/foundation-shell.appconfig.defaultelementrepeatoptions.md +11 -0
  93. package/docs/api/foundation-shell.appconfig.md +21 -0
  94. package/docs/api/foundation-shell.appcontext.md +19 -0
  95. package/docs/api/foundation-shell.appdependencies.md +15 -0
  96. package/docs/api/foundation-shell.appdependencyprerequisites.md +15 -0
  97. package/docs/api/foundation-shell.appelement.md +55 -0
  98. package/docs/api/foundation-shell.appelementpredicate.md +17 -0
  99. package/docs/api/foundation-shell.appmetadata.md +45 -0
  100. package/docs/api/foundation-shell.appregister.deregisterelement.md +31 -0
  101. package/docs/api/foundation-shell.appregister.deregisterroute.md +31 -0
  102. package/docs/api/foundation-shell.appregister.deregisterstore.md +31 -0
  103. package/docs/api/foundation-shell.appregister.deregisterstyle.md +31 -0
  104. package/docs/api/foundation-shell.appregister.md +37 -0
  105. package/docs/api/foundation-shell.appregister.registercomponents.md +13 -0
  106. package/docs/api/foundation-shell.appregister.registerelement.md +31 -0
  107. package/docs/api/foundation-shell.appregister.registerelementstarget.md +13 -0
  108. package/docs/api/foundation-shell.appregister.registerroute.md +31 -0
  109. package/docs/api/foundation-shell.appregister.registerroutecollection.md +13 -0
  110. package/docs/api/foundation-shell.appregister.registerstore.md +31 -0
  111. package/docs/api/foundation-shell.appregister.registerstoreroot.md +13 -0
  112. package/docs/api/foundation-shell.appregister.registerstyle.md +31 -0
  113. package/docs/api/foundation-shell.appregister.registerstylestarget.md +13 -0
  114. package/docs/api/foundation-shell.appregistration.md +57 -0
  115. package/docs/api/foundation-shell.appregistrationcontext.md +15 -0
  116. package/docs/api/foundation-shell.approute.md +49 -0
  117. package/docs/api/foundation-shell.approutepredicate.md +17 -0
  118. package/docs/api/foundation-shell.appstore.md +45 -0
  119. package/docs/api/foundation-shell.appstorepredicate.md +17 -0
  120. package/docs/api/foundation-shell.appstyle.md +48 -0
  121. package/docs/api/foundation-shell.appstylepredicate.md +17 -0
  122. package/docs/api/foundation-shell.apptargetid.md +43 -0
  123. package/docs/api/foundation-shell.apptokentypepredicate.md +13 -0
  124. package/docs/api/foundation-shell.appvalidity.isvalid.md +26 -0
  125. package/docs/api/foundation-shell.appvalidity.md +20 -0
  126. package/docs/api/foundation-shell.appvaliditycontext.md +18 -0
  127. package/docs/api/foundation-shell.assetpredicate.md +12 -0
  128. package/docs/api/foundation-shell.defaultapp.deregisterassets.md +17 -0
  129. package/docs/api/foundation-shell.defaultapp.deregisterelement.md +24 -0
  130. package/docs/api/foundation-shell.defaultapp.deregisterroute.md +24 -0
  131. package/docs/api/foundation-shell.defaultapp.deregisterstore.md +24 -0
  132. package/docs/api/foundation-shell.defaultapp.deregisterstyle.md +24 -0
  133. package/docs/api/foundation-shell.defaultapp.elements.md +13 -0
  134. package/docs/api/foundation-shell.defaultapp.hasassets.md +17 -0
  135. package/docs/api/foundation-shell.defaultapp.isvalid.md +26 -0
  136. package/docs/api/foundation-shell.defaultapp.md +48 -0
  137. package/docs/api/foundation-shell.defaultapp.metadata.md +13 -0
  138. package/docs/api/foundation-shell.defaultapp.registerassets.md +24 -0
  139. package/docs/api/foundation-shell.defaultapp.registercomponents.md +24 -0
  140. package/docs/api/foundation-shell.defaultapp.registerelement.md +24 -0
  141. package/docs/api/foundation-shell.defaultapp.registerelementstarget.md +28 -0
  142. package/docs/api/foundation-shell.defaultapp.registerroute.md +24 -0
  143. package/docs/api/foundation-shell.defaultapp.registerroutecollection.md +25 -0
  144. package/docs/api/foundation-shell.defaultapp.registerstore.md +24 -0
  145. package/docs/api/foundation-shell.defaultapp.registerstoreroot.md +25 -0
  146. package/docs/api/foundation-shell.defaultapp.registerstyle.md +24 -0
  147. package/docs/api/foundation-shell.defaultapp.registerstylestarget.md +27 -0
  148. package/docs/api/foundation-shell.defaultapp.registrations.md +13 -0
  149. package/docs/api/foundation-shell.defaultapp.routes.md +13 -0
  150. package/docs/api/foundation-shell.defaultapp.stores.md +13 -0
  151. package/docs/api/foundation-shell.defaultapp.styles.md +13 -0
  152. package/docs/api/foundation-shell.defaultappconfig.md +13 -0
  153. package/docs/api/foundation-shell.dynamictemplate.md +12 -0
  154. package/docs/api/foundation-shell.getapp.md +30 -0
  155. package/docs/api/foundation-shell.getqualifiedmoduletokens.md +11 -0
  156. package/docs/api/foundation-shell.haspredicate.md +17 -0
  157. package/docs/api/foundation-shell.hastarget.md +15 -0
  158. package/docs/api/foundation-shell.importpbcassets.md +75 -0
  159. package/docs/api/foundation-shell.isappelement.md +22 -0
  160. package/docs/api/foundation-shell.isappmetadata.md +22 -0
  161. package/docs/api/foundation-shell.isappregistration.md +22 -0
  162. package/docs/api/foundation-shell.isapproute.md +22 -0
  163. package/docs/api/foundation-shell.isappstore.md +22 -0
  164. package/docs/api/foundation-shell.isappstyle.md +22 -0
  165. package/docs/api/foundation-shell.iscomposablestyles.md +22 -0
  166. package/docs/api/foundation-shell.isviewtemplate.md +22 -0
  167. package/docs/api/foundation-shell.loadingtemplate.md +12 -0
  168. package/docs/api/foundation-shell.mainapplication.connectedcallback.md +15 -0
  169. package/docs/api/foundation-shell.mainapplication.md +27 -0
  170. package/docs/api/foundation-shell.mainapplication.ready.md +11 -0
  171. package/docs/api/foundation-shell.mainapplication.selecttemplate.md +15 -0
  172. package/docs/api/foundation-shell.maintemplate.md +12 -0
  173. package/docs/api/foundation-shell.md +81 -0
  174. package/docs/api/foundation-shell.registercomponents.md +34 -0
  175. package/docs/api/foundation-shell.registerelementstarget.md +39 -0
  176. package/docs/api/foundation-shell.registerroutecollection.md +24 -0
  177. package/docs/api/foundation-shell.registerstoreroot.md +33 -0
  178. package/docs/api/foundation-shell.registerstylestarget.md +27 -0
  179. package/docs/api/foundation-shell.registrationpredicate.md +12 -0
  180. package/docs/api/foundation-shell.targetidpredicate.md +12 -0
  181. package/docs/api/index.md +12 -0
  182. package/docs/api-report.md +293 -0
  183. package/package.json +50 -9
  184. package/dist/InjectManifest.44b41759e967dfc682a50ab3e02bfaba.js.map +0 -1
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppAssets](./foundation-shell.appassets.md) &gt; [registrations](./foundation-shell.appassets.registrations.md)
4
+
5
+ ## AppAssets.registrations property
6
+
7
+ All [AppRegistration](./foundation-shell.appregistration.md) tokens.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ readonly registrations: AppRegistration[];
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppAssets](./foundation-shell.appassets.md) &gt; [routes](./foundation-shell.appassets.routes.md)
4
+
5
+ ## AppAssets.routes property
6
+
7
+ All [AppRoute](./foundation-shell.approute.md) tokens.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ readonly routes: AppRoute[];
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppAssets](./foundation-shell.appassets.md) &gt; [stores](./foundation-shell.appassets.stores.md)
4
+
5
+ ## AppAssets.stores property
6
+
7
+ All [AppStore](./foundation-shell.appstore.md) tokens.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ readonly stores: AppStore[];
13
+ ```
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppAssets](./foundation-shell.appassets.md) &gt; [styles](./foundation-shell.appassets.styles.md)
4
+
5
+ ## AppAssets.styles property
6
+
7
+ All [AppStyle](./foundation-shell.appstyle.md) tokens.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ readonly styles: AppStyle[];
13
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppConfig](./foundation-shell.appconfig.md) &gt; [context](./foundation-shell.appconfig.context.md)
4
+
5
+ ## AppConfig.context property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ context?: AppContext;
11
+ ```
@@ -0,0 +1,11 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppConfig](./foundation-shell.appconfig.md) &gt; [defaultElementRepeatOptions](./foundation-shell.appconfig.defaultelementrepeatoptions.md)
4
+
5
+ ## AppConfig.defaultElementRepeatOptions property
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ defaultElementRepeatOptions?: RepeatOptions;
11
+ ```
@@ -0,0 +1,21 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppConfig](./foundation-shell.appconfig.md)
4
+
5
+ ## AppConfig interface
6
+
7
+ AppConfig DI interface.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface AppConfig
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [context?](./foundation-shell.appconfig.context.md) | | [AppContext](./foundation-shell.appcontext.md) | _(Optional)_ |
20
+ | [defaultElementRepeatOptions?](./foundation-shell.appconfig.defaultelementrepeatoptions.md) | | RepeatOptions | _(Optional)_ |
21
+
@@ -0,0 +1,19 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppContext](./foundation-shell.appcontext.md)
4
+
5
+ ## AppContext type
6
+
7
+ Context passed to predicate functions and other utilities.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type AppContext = {
13
+ env?: string;
14
+ domain?: string;
15
+ user?: {};
16
+ answers?: {};
17
+ featureFlags?: {};
18
+ };
19
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppDependencies](./foundation-shell.appdependencies.md)
4
+
5
+ ## AppDependencies type
6
+
7
+ A record of app dependencies.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type AppDependencies = {
13
+ [key: string]: string;
14
+ };
15
+ ```
@@ -0,0 +1,15 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppDependencyPrerequisites](./foundation-shell.appdependencyprerequisites.md)
4
+
5
+ ## AppDependencyPrerequisites type
6
+
7
+ A record of app dependency prerequisites.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export type AppDependencyPrerequisites = {
13
+ [key: string]: string;
14
+ };
15
+ ```
@@ -0,0 +1,55 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppElement](./foundation-shell.appelement.md)
4
+
5
+ ## AppElement type
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ export type AppElement<TSource = any, TParent = any, TTarget = string> = HasTarget<TTarget> & HasPredicate & {
11
+ elements: ViewTemplate<TSource, TParent>;
12
+ placementIndex?: number;
13
+ slotId?: string;
14
+ };
15
+ ```
16
+ **References:** [HasTarget](./foundation-shell.hastarget.md)<!-- -->, [HasPredicate](./foundation-shell.haspredicate.md)
17
+
18
+ ## Example 1
19
+
20
+ AppElement definition example.
21
+
22
+ ```ts
23
+ const store = getNotifyStore();
24
+ ...
25
+ export const inboxFlyout: AppElement = {
26
+ targetId: 'layout',
27
+ elements: html`
28
+ <zero-flyout
29
+ position="right"
30
+ @closed=${(x, c) => c.parent.$emit('change-inbox-display', false)}
31
+ ?closed=${() => !store.inboxDisplayState}
32
+ displayHeader=${false}
33
+ data-pbc-asset-id="inbox-flyout"
34
+ >
35
+ <foundation-inbox
36
+ @close=${(x, c) => (<Flyout>(<HTMLElement>c.event.target).parentNode).closeFlyout()}
37
+ ></foundation-inbox>
38
+ </zero-flyout>
39
+ `,
40
+ };
41
+ ```
42
+ Note that bindings may need to use `c.parent` to `$emit` or reference properties of the target integration point. The inclusion of a `data-pbc-asset-id` is not a hard requirement, but should be considered for future operations.
43
+
44
+ ## Example 2
45
+
46
+ Optional runtime [AssetPredicate](./foundation-shell.assetpredicate.md) function to determine if the asset should be used.
47
+
48
+ ```ts
49
+ export const inboxFlyout: AppElement = {
50
+ targetId: 'layout',
51
+ predicate: (context: AppContext) => true, // < assess the user, permissions, env, domain, etc.
52
+ elements: html``,
53
+ }
54
+ ```
55
+
@@ -0,0 +1,17 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppElementPredicate](./foundation-shell.appelementpredicate.md)
4
+
5
+ ## AppElementPredicate type
6
+
7
+ Determine if [AppElement](./foundation-shell.appelement.md) should be included during runtime integration.
8
+
9
+ Provides app, micro frontend, and seed author fine-grained control over what assets they will accept in their target integration points. This is a similar concept to which may be applied to slotted content. For example the accordion accepts slotted accordionItems only.
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ export type AppElementPredicate = (element: AppElement, context?: AppContext) => boolean;
15
+ ```
16
+ **References:** [AppElement](./foundation-shell.appelement.md)<!-- -->, [AppContext](./foundation-shell.appcontext.md)
17
+
@@ -0,0 +1,45 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppMetadata](./foundation-shell.appmetadata.md)
4
+
5
+ ## AppMetadata type
6
+
7
+ **Signature:**
8
+
9
+ ```typescript
10
+ export type AppMetadata = {
11
+ name: string;
12
+ version: string;
13
+ description?: string;
14
+ dependencies?: AppDependencies;
15
+ prerequisites?: AppDependencyPrerequisites;
16
+ };
17
+ ```
18
+ **References:** [AppDependencies](./foundation-shell.appdependencies.md)<!-- -->, [AppDependencyPrerequisites](./foundation-shell.appdependencyprerequisites.md)
19
+
20
+ ## Remarks
21
+
22
+ It is not a hard requirement to have a `metadata.ts` file or a `AppMetadata` export token.
23
+
24
+ ## Example
25
+
26
+ AppMetadata definition example.
27
+
28
+ ```ts
29
+ // src/pbc/reporting/metadata.ts
30
+
31
+ export const metadata: AppMetadata = {
32
+ name: '@genesiscommunitysuccess/pbc-reporting',
33
+ description: 'Genesis Reporting PBC',
34
+ version: '1.0.0',
35
+ prerequisites: {
36
+ '@genesislcap/foundation-ui': '14.0.0',
37
+ gsf: '7.1.0-SNAPSHOT',
38
+ },
39
+ dependencies: {
40
+ '@genesislcap/pbc-reporting': '1.0.0',
41
+ serverDepId: '7.1.0-SNAPSHOT',
42
+ },
43
+ };
44
+ ```
45
+
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [deregisterElement](./foundation-shell.appregister.deregisterelement.md)
4
+
5
+ ## AppRegister.deregisterElement() method
6
+
7
+ API for developers to deregister [AppElements](./foundation-shell.appelement.md)<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ deregisterElement(element: AppElement): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | element | [AppElement](./foundation-shell.appelement.md) | The [AppElement](./foundation-shell.appelement.md) to deregister. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Example
26
+
27
+
28
+ ```ts
29
+ getApp().deregisterElement(someAppElement);
30
+ ```
31
+
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [deregisterRoute](./foundation-shell.appregister.deregisterroute.md)
4
+
5
+ ## AppRegister.deregisterRoute() method
6
+
7
+ API for developers to deregister [AppRoutes](./foundation-shell.approute.md)<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ deregisterRoute(route: AppRoute): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | route | [AppRoute](./foundation-shell.approute.md) | The [AppRoute](./foundation-shell.approute.md) to deregister. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Example
26
+
27
+
28
+ ```ts
29
+ getApp().deregisterRoute(someAppRoute);
30
+ ```
31
+
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [deregisterStore](./foundation-shell.appregister.deregisterstore.md)
4
+
5
+ ## AppRegister.deregisterStore() method
6
+
7
+ API for developers to deregister [AppStores](./foundation-shell.appstore.md)<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ deregisterStore(store: AppStore): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | store | [AppStore](./foundation-shell.appstore.md) | The [AppStore](./foundation-shell.appstore.md) to deregister. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Example
26
+
27
+
28
+ ```ts
29
+ getApp().deregisterStore(someAppStore);
30
+ ```
31
+
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [deregisterStyle](./foundation-shell.appregister.deregisterstyle.md)
4
+
5
+ ## AppRegister.deregisterStyle() method
6
+
7
+ API for developers to deregister [AppStyles](./foundation-shell.appstyle.md)<!-- -->.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ deregisterStyle(style: AppStyle): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | style | [AppStyle](./foundation-shell.appstyle.md) | The [AppStyle](./foundation-shell.appstyle.md) to deregister. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Example
26
+
27
+
28
+ ```ts
29
+ getApp().deregisterStyle(someAppStyle);
30
+ ```
31
+
@@ -0,0 +1,37 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md)
4
+
5
+ ## AppRegister interface
6
+
7
+ APIs to register asset targets and assets. These can be lazily registered and deregistered.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ export interface AppRegister
13
+ ```
14
+
15
+ ## Properties
16
+
17
+ | Property | Modifiers | Type | Description |
18
+ | --- | --- | --- | --- |
19
+ | [registerComponents](./foundation-shell.appregister.registercomponents.md) | | [RegisterComponents](./foundation-shell.registercomponents.md) | API for Application and Seed authors to register dynamic components. |
20
+ | [registerElementsTarget](./foundation-shell.appregister.registerelementstarget.md) | | [RegisterElementsTarget](./foundation-shell.registerelementstarget.md) | API for Application and Seed authors to define dynamic [AppElement](./foundation-shell.appelement.md) integration points. |
21
+ | [registerRouteCollection](./foundation-shell.appregister.registerroutecollection.md) | | [RegisterRouteCollection](./foundation-shell.registerroutecollection.md) | API for Application and Seed authors to register the main . |
22
+ | [registerStoreRoot](./foundation-shell.appregister.registerstoreroot.md) | | [RegisterStoreRoot](./foundation-shell.registerstoreroot.md) | API for Application and Seed authors to register the . |
23
+ | [registerStylesTarget](./foundation-shell.appregister.registerstylestarget.md) | | [RegisterStylesTarget](./foundation-shell.registerstylestarget.md) | API for Application and Seed authors to define dynamic [AppStyle](./foundation-shell.appstyle.md) integration points. |
24
+
25
+ ## Methods
26
+
27
+ | Method | Description |
28
+ | --- | --- |
29
+ | [deregisterElement(element)](./foundation-shell.appregister.deregisterelement.md) | API for developers to deregister [AppElements](./foundation-shell.appelement.md)<!-- -->. |
30
+ | [deregisterRoute(route)](./foundation-shell.appregister.deregisterroute.md) | API for developers to deregister [AppRoutes](./foundation-shell.approute.md)<!-- -->. |
31
+ | [deregisterStore(store)](./foundation-shell.appregister.deregisterstore.md) | API for developers to deregister [AppStores](./foundation-shell.appstore.md)<!-- -->. |
32
+ | [deregisterStyle(style)](./foundation-shell.appregister.deregisterstyle.md) | API for developers to deregister [AppStyles](./foundation-shell.appstyle.md)<!-- -->. |
33
+ | [registerElement(element)](./foundation-shell.appregister.registerelement.md) | API for developers to register [AppElements](./foundation-shell.appelement.md) lazily. |
34
+ | [registerRoute(route)](./foundation-shell.appregister.registerroute.md) | API for developers to register [AppRoutes](./foundation-shell.approute.md) lazily. |
35
+ | [registerStore(store)](./foundation-shell.appregister.registerstore.md) | API for developers to register [AppStores](./foundation-shell.appstore.md) lazily. |
36
+ | [registerStyle(style)](./foundation-shell.appregister.registerstyle.md) | API for developers to register [AppStyles](./foundation-shell.appstyle.md) lazily. |
37
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerComponents](./foundation-shell.appregister.registercomponents.md)
4
+
5
+ ## AppRegister.registerComponents property
6
+
7
+ API for Application and Seed authors to register dynamic components.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerComponents: RegisterComponents;
13
+ ```
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerElement](./foundation-shell.appregister.registerelement.md)
4
+
5
+ ## AppRegister.registerElement() method
6
+
7
+ API for developers to register [AppElements](./foundation-shell.appelement.md) lazily.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerElement(element: AppElement): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | element | [AppElement](./foundation-shell.appelement.md) | The [AppElement](./foundation-shell.appelement.md) to register. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Example
26
+
27
+
28
+ ```ts
29
+ getApp().registerElement(someAppElement);
30
+ ```
31
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerElementsTarget](./foundation-shell.appregister.registerelementstarget.md)
4
+
5
+ ## AppRegister.registerElementsTarget property
6
+
7
+ API for Application and Seed authors to define dynamic [AppElement](./foundation-shell.appelement.md) integration points.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerElementsTarget: RegisterElementsTarget;
13
+ ```
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerRoute](./foundation-shell.appregister.registerroute.md)
4
+
5
+ ## AppRegister.registerRoute() method
6
+
7
+ API for developers to register [AppRoutes](./foundation-shell.approute.md) lazily.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerRoute(route: AppRoute): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | route | [AppRoute](./foundation-shell.approute.md) | The [AppRoute](./foundation-shell.approute.md) to register. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Example
26
+
27
+
28
+ ```ts
29
+ getApp().registerRoute(someAppRoute);
30
+ ```
31
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerRouteCollection](./foundation-shell.appregister.registerroutecollection.md)
4
+
5
+ ## AppRegister.registerRouteCollection property
6
+
7
+ API for Application and Seed authors to register the main .
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerRouteCollection: RegisterRouteCollection;
13
+ ```
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerStore](./foundation-shell.appregister.registerstore.md)
4
+
5
+ ## AppRegister.registerStore() method
6
+
7
+ API for developers to register [AppStores](./foundation-shell.appstore.md) lazily.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerStore(store: AppStore): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | store | [AppStore](./foundation-shell.appstore.md) | The [AppStore](./foundation-shell.appstore.md) to register. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Example
26
+
27
+
28
+ ```ts
29
+ getApp().registerStore(someAppStore);
30
+ ```
31
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerStoreRoot](./foundation-shell.appregister.registerstoreroot.md)
4
+
5
+ ## AppRegister.registerStoreRoot property
6
+
7
+ API for Application and Seed authors to register the .
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerStoreRoot: RegisterStoreRoot;
13
+ ```
@@ -0,0 +1,31 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerStyle](./foundation-shell.appregister.registerstyle.md)
4
+
5
+ ## AppRegister.registerStyle() method
6
+
7
+ API for developers to register [AppStyles](./foundation-shell.appstyle.md) lazily.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerStyle(style: AppStyle): void;
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Parameter | Type | Description |
18
+ | --- | --- | --- |
19
+ | style | [AppStyle](./foundation-shell.appstyle.md) | The [AppStyle](./foundation-shell.appstyle.md) to register. |
20
+
21
+ **Returns:**
22
+
23
+ void
24
+
25
+ ## Example
26
+
27
+
28
+ ```ts
29
+ getApp().registerStyle(someAppStyle);
30
+ ```
31
+
@@ -0,0 +1,13 @@
1
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
+
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AppRegister](./foundation-shell.appregister.md) &gt; [registerStylesTarget](./foundation-shell.appregister.registerstylestarget.md)
4
+
5
+ ## AppRegister.registerStylesTarget property
6
+
7
+ API for Application and Seed authors to define dynamic [AppStyle](./foundation-shell.appstyle.md) integration points.
8
+
9
+ **Signature:**
10
+
11
+ ```typescript
12
+ registerStylesTarget: RegisterStylesTarget;
13
+ ```