@genesislcap/foundation-shell 14.225.3 → 14.225.4-alpha-5f6eefd.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 (17) hide show
  1. package/dist/dts/app/utils.d.ts.map +1 -1
  2. package/dist/dts/pbc/vite/exports.d.ts +3 -3
  3. package/dist/dts/pbc/vite/exports.d.ts.map +1 -1
  4. package/dist/dts/pbc/webpack/exports.d.ts +3 -3
  5. package/dist/dts/pbc/webpack/exports.d.ts.map +1 -1
  6. package/dist/dts/serviceWorker/serviceWorker.d.ts +6 -0
  7. package/dist/dts/serviceWorker/serviceWorker.d.ts.map +1 -1
  8. package/dist/dts/tsdoc-metadata.json +1 -1
  9. package/dist/foundation-shell.api.json +218 -69
  10. package/dist/sw.js +1 -1
  11. package/docs/api/foundation-shell.assetpredicate.md +6 -3
  12. package/docs/api/foundation-shell.getqualifiedmoduletokens.md +13 -1
  13. package/docs/api/foundation-shell.md +4 -4
  14. package/docs/api/foundation-shell.registrationpredicate.md +14 -1
  15. package/docs/api/foundation-shell.targetidpredicate.md +13 -1
  16. package/docs/{api-report.md → api-report.md.api.md} +304 -304
  17. package/package.json +14 -14
package/docs/api/foundation-shell.assetpredicate.md CHANGED
@@ -1,12 +1,15 @@
1
1
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
2
 
3
- [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [assetPredicate](./foundation-shell.assetpredicate.md)
3
+ [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [AssetPredicate](./foundation-shell.assetpredicate.md)
4
4
 
5
- ## assetPredicate variable
5
+ ## AssetPredicate type
6
6
 
7
+ Asset runtime predicate function.
7
8
 
8
9
  **Signature:**
9
10
 
10
11
  ```typescript
11
- assetPredicate: (asset: HasPredicate, context: AppContext) => boolean
12
+ export type AssetPredicate = (context?: AppContext) => boolean;
12
13
  ```
14
+ **References:** [AppContext](./foundation-shell.appcontext.md)
15
+
package/docs/api/foundation-shell.getqualifiedmoduletokens.md CHANGED
@@ -2,10 +2,22 @@
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
10
  getQualifiedModuleTokens: <T extends unknown>(module: any, predicate: AppTokenTypePredicate) => T[]
11
11
  ```
12
+
13
+ ## Parameters
14
+
15
+ | Parameter | Type | Description |
16
+ | --- | --- | --- |
17
+ | module | any | An imported module. |
18
+ | predicate | [AppTokenTypePredicate](./foundation-shell.apptokentypepredicate.md) | Token type predicate. |
19
+
20
+ **Returns:**
21
+
22
+ T\[\]
23
+
package/docs/api/foundation-shell.md CHANGED
@@ -15,7 +15,9 @@
15
15
 
16
16
  | Function | Description |
17
17
  | --- | --- |
18
+ | [assetPredicate(asset, context)](./foundation-shell.assetpredicate.md) | |
18
19
  | [getApp()](./foundation-shell.getapp.md) | Gets App from the DI container. |
20
+ | [getQualifiedModuleTokens(module, predicate)](./foundation-shell.getqualifiedmoduletokens.md) | |
19
21
  | [importPBCAssets()](./foundation-shell.importpbcassets.md) | <p>A utility for importing PBC assets that have been added to the application's src/pbc directory via genx add.</p><p>The <code>genx</code> builder (webpack or vite) will attempt to dynamically load all PBC assets from the application's <code>src/pbc</code> directory by default. The returned AppAssets can then be applied to the App. Please note that <code>app.registerAssets</code> is a one-time operation, intended for upfront bulk registration. After this point, you must use the single asset APIs of the <code>App</code> for lazy asset registration or deregistration.</p> |
20
22
  | [isAppElement(token)](./foundation-shell.isappelement.md) | |
21
23
  | [isAppMetadata(token)](./foundation-shell.isappmetadata.md) | |
@@ -25,6 +27,8 @@
25
27
  | [isAppStyle(token)](./foundation-shell.isappstyle.md) | |
26
28
  | [isComposableStyles(token)](./foundation-shell.iscomposablestyles.md) | |
27
29
  | [isViewTemplate(token)](./foundation-shell.isviewtemplate.md) | |
30
+ | [registrationPredicate(asset, predicate, context)](./foundation-shell.registrationpredicate.md) | |
31
+ | [targetIdPredicate(asset, targetId)](./foundation-shell.targetidpredicate.md) | |
28
32
 
29
33
  ## Interfaces
30
34
 
@@ -40,15 +44,11 @@
40
44
 
41
45
  | Variable | Description |
42
46
  | --- | --- |
43
- | [assetPredicate](./foundation-shell.assetpredicate.md) | |
44
47
  | [defaultAppConfig](./foundation-shell.defaultappconfig.md) | Default AppConfig DI implementation. |
45
48
  | [DynamicTemplate](./foundation-shell.dynamictemplate.md) | |
46
- | [getQualifiedModuleTokens](./foundation-shell.getqualifiedmoduletokens.md) | |
47
49
  | [LoadingTemplate](./foundation-shell.loadingtemplate.md) | |
48
50
  | [logger](./foundation-shell.logger.md) | Logger for the foundation-shell package |
49
51
  | [MainTemplate](./foundation-shell.maintemplate.md) | |
50
- | [registrationPredicate](./foundation-shell.registrationpredicate.md) | |
51
- | [targetIdPredicate](./foundation-shell.targetidpredicate.md) | |
52
52
 
53
53
  ## Type Aliases
54
54
 
package/docs/api/foundation-shell.registrationpredicate.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [registrationPredicate](./foundation-shell.registrationpredicate.md)
4
4
 
5
- ## registrationPredicate variable
5
+ ## registrationPredicate() function
6
6
 
7
7
 
8
8
  **Signature:**
@@ -10,3 +10,16 @@
10
10
  ```typescript
11
11
  registrationPredicate: <A, P>(asset: A, predicate: P, context: AppContext) => boolean
12
12
  ```
13
+
14
+ ## Parameters
15
+
16
+ | Parameter | Type | Description |
17
+ | --- | --- | --- |
18
+ | asset | A | |
19
+ | predicate | P | |
20
+ | context | [AppContext](./foundation-shell.appcontext.md) | |
21
+
22
+ **Returns:**
23
+
24
+ boolean
25
+
package/docs/api/foundation-shell.targetidpredicate.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-shell](./foundation-shell.md) &gt; [targetIdPredicate](./foundation-shell.targetidpredicate.md)
4
4
 
5
- ## targetIdPredicate variable
5
+ ## targetIdPredicate() function
6
6
 
7
7
 
8
8
  **Signature:**
@@ -10,3 +10,15 @@
10
10
  ```typescript
11
11
  targetIdPredicate: (asset: HasTarget, targetId: AppTargetId) => boolean
12
12
  ```
13
+
14
+ ## Parameters
15
+
16
+ | Parameter | Type | Description |
17
+ | --- | --- | --- |
18
+ | asset | [HasTarget](./foundation-shell.hastarget.md) | |
19
+ | targetId | [AppTargetId](./foundation-shell.apptargetid.md) | |
20
+
21
+ **Returns:**
22
+
23
+ boolean
24
+