@genesislcap/foundation-shell 14.302.0 → 14.302.1-alpha-d11831b.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 (82) hide show
  1. package/dist/InjectManifest.7865178a3d52a13bdda81ca4c7921b55.js.map +1 -0
  2. package/dist/dts/app/app.d.ts +1 -1
  3. package/dist/dts/app/utils.d.ts +1 -1
  4. package/dist/dts/app/utils.d.ts.map +1 -1
  5. package/dist/dts/pbc/vite/exports.d.ts +3 -3
  6. package/dist/dts/pbc/vite/exports.d.ts.map +1 -1
  7. package/dist/dts/pbc/webpack/exports.d.ts +3 -3
  8. package/dist/dts/pbc/webpack/exports.d.ts.map +1 -1
  9. package/dist/dts/pbc/webpack/utils.d.ts +0 -1
  10. package/dist/dts/pbc/webpack/utils.d.ts.map +1 -1
  11. package/dist/dts/serviceWorker/registration.d.ts.map +1 -1
  12. package/dist/dts/tsdoc-metadata.json +1 -1
  13. package/dist/esm/serviceWorker/serviceWorker.js +0 -2
  14. package/dist/foundation-shell.api.json +219 -70
  15. package/dist/foundation-shell.d.ts +2 -2
  16. package/dist/index.html +1 -1
  17. package/dist/main.e4b8b96b193efedd2b59.js +20 -0
  18. package/dist/main.f158b1f2cc070dc187456c00b686b503.js.map +1 -0
  19. package/dist/npm.consola.48b39a3f7c3185d3aa5944ce46e993e7.js.map +1 -0
  20. package/dist/npm.consola.6acd2f4981ccb8aab03b.js +2 -0
  21. package/dist/npm.microsoft.7e017c0ac867c96c95f5610ad9fc520b.js.map +1 -0
  22. package/dist/npm.microsoft.bc8a98e27c50c4f95eb7.js +2 -0
  23. package/dist/sw.js +2 -2
  24. package/dist/swRegistration.42b3e19a5a6f7926dc1b65635a1dd326.js.map +1 -0
  25. package/dist/swRegistration.5ef43fa0abd08b196966.js +2 -0
  26. package/docs/api/foundation-shell.app.md +88 -8
  27. package/docs/api/foundation-shell.app.registerassets.md +33 -3
  28. package/docs/api/foundation-shell.appassets.md +148 -8
  29. package/docs/api/foundation-shell.appconfig.md +60 -4
  30. package/docs/api/foundation-shell.appregister.deregisterelement.md +33 -3
  31. package/docs/api/foundation-shell.appregister.deregisterroute.md +33 -3
  32. package/docs/api/foundation-shell.appregister.deregisterstore.md +33 -3
  33. package/docs/api/foundation-shell.appregister.deregisterstyle.md +33 -3
  34. package/docs/api/foundation-shell.appregister.md +217 -17
  35. package/docs/api/foundation-shell.appregister.registerelement.md +33 -3
  36. package/docs/api/foundation-shell.appregister.registerroute.md +33 -3
  37. package/docs/api/foundation-shell.appregister.registerstore.md +33 -3
  38. package/docs/api/foundation-shell.appregister.registerstyle.md +33 -3
  39. package/docs/api/foundation-shell.appvalidity.isvalid.md +33 -3
  40. package/docs/api/foundation-shell.appvalidity.md +23 -3
  41. package/docs/api/foundation-shell.assetpredicate.md +6 -3
  42. package/docs/api/foundation-shell.defaultapp.deregisterelement.md +33 -3
  43. package/docs/api/foundation-shell.defaultapp.deregisterroute.md +33 -3
  44. package/docs/api/foundation-shell.defaultapp.deregisterstore.md +33 -3
  45. package/docs/api/foundation-shell.defaultapp.deregisterstyle.md +33 -3
  46. package/docs/api/foundation-shell.defaultapp.isvalid.md +33 -3
  47. package/docs/api/foundation-shell.defaultapp.md +391 -27
  48. package/docs/api/foundation-shell.defaultapp.registerassets.md +33 -3
  49. package/docs/api/foundation-shell.defaultapp.registercomponents.md +31 -3
  50. package/docs/api/foundation-shell.defaultapp.registerelement.md +33 -3
  51. package/docs/api/foundation-shell.defaultapp.registerelementstarget.md +65 -5
  52. package/docs/api/foundation-shell.defaultapp.registerroute.md +33 -3
  53. package/docs/api/foundation-shell.defaultapp.registerroutecollection.md +51 -6
  54. package/docs/api/foundation-shell.defaultapp.registerstore.md +33 -3
  55. package/docs/api/foundation-shell.defaultapp.registerstoreroot.md +49 -4
  56. package/docs/api/foundation-shell.defaultapp.registerstyle.md +33 -3
  57. package/docs/api/foundation-shell.defaultapp.registerstylestarget.md +49 -4
  58. package/docs/api/foundation-shell.getqualifiedmoduletokens.md +59 -2
  59. package/docs/api/foundation-shell.isappelement.md +33 -3
  60. package/docs/api/foundation-shell.isappmetadata.md +33 -3
  61. package/docs/api/foundation-shell.isappregistration.md +33 -3
  62. package/docs/api/foundation-shell.isapproute.md +33 -3
  63. package/docs/api/foundation-shell.isappstore.md +33 -3
  64. package/docs/api/foundation-shell.isappstyle.md +33 -3
  65. package/docs/api/foundation-shell.iscomposablestyles.md +33 -3
  66. package/docs/api/foundation-shell.isviewtemplate.md +33 -3
  67. package/docs/api/foundation-shell.mainapplication.md +80 -7
  68. package/docs/api/foundation-shell.md +596 -61
  69. package/docs/api/foundation-shell.registrationpredicate.md +68 -1
  70. package/docs/api/foundation-shell.targetidpredicate.md +54 -1
  71. package/docs/api/index.md +21 -3
  72. package/docs/api-report.md.api.md +296 -0
  73. package/package.json +14 -14
  74. package/dist/InjectManifest.6ed0133479e74098b8726af1c4afda83.js.map +0 -1
  75. package/dist/main.1a7967cf2d9d0148efd2734ff736b11a.js.map +0 -1
  76. package/dist/main.fe4e5011b19da05ecbb8.js +0 -20
  77. package/dist/npm.consola.b3e9f150c910e8d3245c6058379617dd.js.map +0 -1
  78. package/dist/npm.consola.e1392c750470ff16d0ad.js +0 -2
  79. package/dist/npm.microsoft.2b4627a0e71ac31258b5.js +0 -2
  80. package/dist/npm.microsoft.9e39d1bfdec7ff94555640ef134f16bb.js.map +0 -1
  81. package/dist/swRegistration.423eaea82a20f29e5e3019649dac885e.js.map +0 -1
  82. package/dist/swRegistration.6c147e22477e9a69d536.js +0 -2
@@ -9,17 +9,62 @@ API for Application and Seed authors to register the main .
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- registerRouteCollection(routeCollection: any, predicate: any): any;
12
+ registerRouteCollection(routeCollection: any, predicate: any): () => void;
13
13
  ```
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | routeCollection | any | The route collection to register [AppRoutes](./foundation-shell.approute.md) to. |
20
- | predicate | any | Optional [AppRoutePredicate](./foundation-shell.approutepredicate.md)<!-- -->. |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ routeCollection
36
+
37
+
38
+ </td><td>
39
+
40
+ any
21
41
 
22
- **Returns:**
42
+
43
+ </td><td>
44
+
45
+ The route collection to register [AppRoutes](./foundation-shell.approute.md) to.
46
+
47
+
48
+ </td></tr>
49
+ <tr><td>
50
+
51
+ predicate
52
+
53
+
54
+ </td><td>
23
55
 
24
56
  any
25
57
 
58
+
59
+ </td><td>
60
+
61
+ Optional [AppRoutePredicate](./foundation-shell.approutepredicate.md)<!-- -->.
62
+
63
+
64
+ </td></tr>
65
+ </tbody></table>
66
+
67
+ **Returns:**
68
+
69
+ () =&gt; void
70
+
@@ -14,9 +14,39 @@ registerStore(store: any): void;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | store | any | The [AppStore](./foundation-shell.appstore.md) to register. |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ store
36
+
37
+
38
+ </td><td>
39
+
40
+ any
41
+
42
+
43
+ </td><td>
44
+
45
+ The [AppStore](./foundation-shell.appstore.md) to register.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
20
50
 
21
51
  **Returns:**
22
52
 
@@ -14,10 +14,55 @@ registerStoreRoot(storeRoot: any, predicate: any): () => void;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | storeRoot | any | The store root to register [AppStores](./foundation-shell.appstore.md) to. |
20
- | predicate | any | Optional [AppStorePredicate](./foundation-shell.appstorepredicate.md)<!-- -->. |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ storeRoot
36
+
37
+
38
+ </td><td>
39
+
40
+ any
41
+
42
+
43
+ </td><td>
44
+
45
+ The store root to register [AppStores](./foundation-shell.appstore.md) to.
46
+
47
+
48
+ </td></tr>
49
+ <tr><td>
50
+
51
+ predicate
52
+
53
+
54
+ </td><td>
55
+
56
+ any
57
+
58
+
59
+ </td><td>
60
+
61
+ Optional [AppStorePredicate](./foundation-shell.appstorepredicate.md)<!-- -->.
62
+
63
+
64
+ </td></tr>
65
+ </tbody></table>
21
66
 
22
67
  **Returns:**
23
68
 
@@ -14,9 +14,39 @@ registerStyle(style: any): void;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | style | any | The [AppStyle](./foundation-shell.appstyle.md) to register. |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ style
36
+
37
+
38
+ </td><td>
39
+
40
+ any
41
+
42
+
43
+ </td><td>
44
+
45
+ The [AppStyle](./foundation-shell.appstyle.md) to register.
46
+
47
+
48
+ </td></tr>
49
+ </tbody></table>
20
50
 
21
51
  **Returns:**
22
52
 
@@ -14,10 +14,55 @@ registerStylesTarget(targetId: any, predicate: any): AppStylesTargetBehavior;
14
14
 
15
15
  ## Parameters
16
16
 
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | targetId | any | [AppTargetId](./foundation-shell.apptargetid.md)<!-- -->. |
20
- | predicate | any | Optional [AppStylePredicate](./foundation-shell.appstylepredicate.md)<!-- -->. |
17
+ <table><thead><tr><th>
18
+
19
+ Parameter
20
+
21
+
22
+ </th><th>
23
+
24
+ Type
25
+
26
+
27
+ </th><th>
28
+
29
+ Description
30
+
31
+
32
+ </th></tr></thead>
33
+ <tbody><tr><td>
34
+
35
+ targetId
36
+
37
+
38
+ </td><td>
39
+
40
+ any
41
+
42
+
43
+ </td><td>
44
+
45
+ [AppTargetId](./foundation-shell.apptargetid.md)<!-- -->.
46
+
47
+
48
+ </td></tr>
49
+ <tr><td>
50
+
51
+ predicate
52
+
53
+
54
+ </td><td>
55
+
56
+ any
57
+
58
+
59
+ </td><td>
60
+
61
+ Optional [AppStylePredicate](./foundation-shell.appstylepredicate.md)<!-- -->.
62
+
63
+
64
+ </td></tr>
65
+ </tbody></table>
21
66
 
22
67
  **Returns:**
23
68
 
@@ -2,10 +2,67 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [getQualifiedModuleTokens](./foundation-shell.getqualifiedmoduletokens.md)
4
4
 
5
- ## getQualifiedModuleTokens variable
5
+ ## getQualifiedModuleTokens() function
6
6
 
7
7
  **Signature:**
8
8
 
9
9
  ```typescript
10
- getQualifiedModuleTokens: <T extends unknown>(module: any, predicate: AppTokenTypePredicate) => T[]
10
+ getQualifiedModuleTokens: <T extends any>(module: any, predicate: AppTokenTypePredicate) => T[]
11
11
  ```
12
+
13
+ ## Parameters
14
+
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ module
34
+
35
+
36
+ </td><td>
37
+
38
+ any
39
+
40
+
41
+ </td><td>
42
+
43
+ An imported module.
44
+
45
+
46
+ </td></tr>
47
+ <tr><td>
48
+
49
+ predicate
50
+
51
+
52
+ </td><td>
53
+
54
+ [AppTokenTypePredicate](./foundation-shell.apptokentypepredicate.md)
55
+
56
+
57
+ </td><td>
58
+
59
+ Token type predicate.
60
+
61
+
62
+ </td></tr>
63
+ </tbody></table>
64
+
65
+ **Returns:**
66
+
67
+ T\[\]
68
+
@@ -12,9 +12,39 @@ export declare function isAppElement(token: unknown): token is AppElement;
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | token | unknown | A module export token. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ token
34
+
35
+
36
+ </td><td>
37
+
38
+ unknown
39
+
40
+
41
+ </td><td>
42
+
43
+ A module export token.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50
 
@@ -12,9 +12,39 @@ export declare function isAppMetadata(token: unknown): token is AppMetadata;
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | token | unknown | A module export token. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ token
34
+
35
+
36
+ </td><td>
37
+
38
+ unknown
39
+
40
+
41
+ </td><td>
42
+
43
+ A module export token.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50
 
@@ -12,9 +12,39 @@ export declare function isAppRegistration(token: unknown): token is AppRegistrat
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | token | unknown | A module export token. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ token
34
+
35
+
36
+ </td><td>
37
+
38
+ unknown
39
+
40
+
41
+ </td><td>
42
+
43
+ A module export token.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50
 
@@ -12,9 +12,39 @@ export declare function isAppRoute(token: unknown): token is AppRoute;
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | token | unknown | A module export token. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ token
34
+
35
+
36
+ </td><td>
37
+
38
+ unknown
39
+
40
+
41
+ </td><td>
42
+
43
+ A module export token.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50
 
@@ -12,9 +12,39 @@ export declare function isAppStore(token: unknown): token is AppStore;
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | token | unknown | A module export token. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ token
34
+
35
+
36
+ </td><td>
37
+
38
+ unknown
39
+
40
+
41
+ </td><td>
42
+
43
+ A module export token.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50
 
@@ -12,9 +12,39 @@ export declare function isAppStyle(token: unknown): token is AppStyle;
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | token | unknown | A module export token. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ token
34
+
35
+
36
+ </td><td>
37
+
38
+ unknown
39
+
40
+
41
+ </td><td>
42
+
43
+ A module export token.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50
 
@@ -12,9 +12,39 @@ export declare function isComposableStyles(token: unknown): token is ComposableS
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | token | unknown | A module export token / styles candidate. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ token
34
+
35
+
36
+ </td><td>
37
+
38
+ unknown
39
+
40
+
41
+ </td><td>
42
+
43
+ A module export token / styles candidate.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50
 
@@ -12,9 +12,39 @@ export declare function isViewTemplate(token: unknown): token is ViewTemplate;
12
12
 
13
13
  ## Parameters
14
14
 
15
- | Parameter | Type | Description |
16
- | --- | --- | --- |
17
- | token | unknown | A module export token / element candidate. |
15
+ <table><thead><tr><th>
16
+
17
+ Parameter
18
+
19
+
20
+ </th><th>
21
+
22
+ Type
23
+
24
+
25
+ </th><th>
26
+
27
+ Description
28
+
29
+
30
+ </th></tr></thead>
31
+ <tbody><tr><td>
32
+
33
+ token
34
+
35
+
36
+ </td><td>
37
+
38
+ unknown
39
+
40
+
41
+ </td><td>
42
+
43
+ A module export token / element candidate.
44
+
45
+
46
+ </td></tr>
47
+ </tbody></table>
18
48
 
19
49
  **Returns:**
20
50