@twin.org/node-core 0.0.2-next.16 → 0.0.2-next.18
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.
- package/dist/cjs/index.cjs +211 -75
- package/dist/esm/index.mjs +203 -77
- package/dist/types/builders/engineServerEnvBuilder.d.ts +1 -1
- package/dist/types/builders/extensionsBuilder.d.ts +32 -0
- package/dist/types/defaults.d.ts +6 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/models/IEngineEnvironmentVariables.d.ts +35 -14
- package/dist/types/models/INodeEngineConfig.d.ts +6 -0
- package/dist/types/models/INodeOptions.d.ts +2 -1
- package/dist/types/models/nodeExtensionMethods.d.ts +27 -0
- package/dist/types/node.d.ts +2 -2
- package/dist/types/server.d.ts +4 -2
- package/docs/changelog.md +15 -0
- package/docs/reference/functions/buildConfiguration.md +2 -2
- package/docs/reference/functions/buildEngineServerConfiguration.md +1 -1
- package/docs/reference/functions/extensionsConfiguration.md +25 -0
- package/docs/reference/functions/extensionsInitialiseEngine.md +25 -0
- package/docs/reference/functions/extensionsInitialiseEngineServer.md +31 -0
- package/docs/reference/functions/shutdownExtensions.md +25 -0
- package/docs/reference/functions/start.md +4 -4
- package/docs/reference/index.md +15 -0
- package/docs/reference/interfaces/IEngineEnvironmentVariables.md +73 -22
- package/docs/reference/interfaces/IEngineServerEnvironmentVariables.md +101 -30
- package/docs/reference/interfaces/INodeEngineConfig.md +7 -0
- package/docs/reference/interfaces/INodeEnvironmentVariables.md +101 -30
- package/docs/reference/interfaces/INodeOptions.md +6 -2
- package/docs/reference/type-aliases/NodeExtensionInitialiseEngineMethod.md +18 -0
- package/docs/reference/type-aliases/NodeExtensionInitialiseEngineServerMethod.md +24 -0
- package/docs/reference/type-aliases/NodeExtensionInitialiseMethod.md +23 -0
- package/docs/reference/type-aliases/NodeExtensionShutdownMethod.md +10 -0
- package/docs/reference/variables/ATTESTATION_VERIFICATION_METHOD_ID.md +3 -0
- package/docs/reference/variables/AUTH_SIGNING_KEY_ID.md +3 -0
- package/docs/reference/variables/BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
- package/docs/reference/variables/IMMUTABLE_PROOF_VERIFICATION_METHOD_ID.md +3 -0
- package/docs/reference/variables/SYNCHRONISED_STORAGE_BLOB_STORAGE_ENCRYPTION_KEY_ID.md +3 -0
- package/docs/reference/variables/VC_AUTHENTICATION_VERIFICATION_METHOD_ID.md +3 -0
- package/locales/en.json +9 -2
- package/package.json +13 -1
|
@@ -85,6 +85,18 @@ A prefix for all the table in entity-storage, can be empty.
|
|
|
85
85
|
|
|
86
86
|
***
|
|
87
87
|
|
|
88
|
+
### awsDynamodbAuthMode?
|
|
89
|
+
|
|
90
|
+
> `optional` **awsDynamodbAuthMode**: `string`
|
|
91
|
+
|
|
92
|
+
AWS DynamoDB auth mode, either credentials or pod.
|
|
93
|
+
|
|
94
|
+
#### Inherited from
|
|
95
|
+
|
|
96
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineEnvironmentVariables.md#awsdynamodbauthmode)
|
|
97
|
+
|
|
98
|
+
***
|
|
99
|
+
|
|
88
100
|
### awsDynamodbAccessKeyId?
|
|
89
101
|
|
|
90
102
|
> `optional` **awsDynamodbAccessKeyId**: `string`
|
|
@@ -579,15 +591,15 @@ A prefix for all the blobs in blob-storage, can be empty.
|
|
|
579
591
|
|
|
580
592
|
***
|
|
581
593
|
|
|
582
|
-
###
|
|
594
|
+
### awsS3Region?
|
|
583
595
|
|
|
584
|
-
> `optional` **
|
|
596
|
+
> `optional` **awsS3Region**: `string`
|
|
585
597
|
|
|
586
|
-
AWS S3
|
|
598
|
+
AWS S3 region.
|
|
587
599
|
|
|
588
600
|
#### Inherited from
|
|
589
601
|
|
|
590
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
602
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Region`](IEngineEnvironmentVariables.md#awss3region)
|
|
591
603
|
|
|
592
604
|
***
|
|
593
605
|
|
|
@@ -603,27 +615,27 @@ AWS S3 bucket name.
|
|
|
603
615
|
|
|
604
616
|
***
|
|
605
617
|
|
|
606
|
-
###
|
|
618
|
+
### awsS3AuthMode?
|
|
607
619
|
|
|
608
|
-
> `optional` **
|
|
620
|
+
> `optional` **awsS3AuthMode**: `string`
|
|
609
621
|
|
|
610
|
-
AWS S3
|
|
622
|
+
AWS S3 auth mode, either credentials or pod, defaults to credentials.
|
|
611
623
|
|
|
612
624
|
#### Inherited from
|
|
613
625
|
|
|
614
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
626
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AuthMode`](IEngineEnvironmentVariables.md#awss3authmode)
|
|
615
627
|
|
|
616
628
|
***
|
|
617
629
|
|
|
618
|
-
###
|
|
630
|
+
### awsS3AccessKeyId?
|
|
619
631
|
|
|
620
|
-
> `optional` **
|
|
632
|
+
> `optional` **awsS3AccessKeyId**: `string`
|
|
621
633
|
|
|
622
|
-
AWS S3
|
|
634
|
+
AWS S3 access key id.
|
|
623
635
|
|
|
624
636
|
#### Inherited from
|
|
625
637
|
|
|
626
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
638
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineEnvironmentVariables.md#awss3accesskeyid)
|
|
627
639
|
|
|
628
640
|
***
|
|
629
641
|
|
|
@@ -639,6 +651,18 @@ AWS S3 secret access key.
|
|
|
639
651
|
|
|
640
652
|
***
|
|
641
653
|
|
|
654
|
+
### awsS3Endpoint?
|
|
655
|
+
|
|
656
|
+
> `optional` **awsS3Endpoint**: `string`
|
|
657
|
+
|
|
658
|
+
AWS S3 endpoint.
|
|
659
|
+
|
|
660
|
+
#### Inherited from
|
|
661
|
+
|
|
662
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsS3Endpoint`](IEngineEnvironmentVariables.md#awss3endpoint)
|
|
663
|
+
|
|
664
|
+
***
|
|
665
|
+
|
|
642
666
|
### azureStorageAccountKey?
|
|
643
667
|
|
|
644
668
|
> `optional` **azureStorageAccountKey**: `string`
|
|
@@ -844,39 +868,51 @@ Use the @json: prefix to specify the path to the JSON file.
|
|
|
844
868
|
|
|
845
869
|
***
|
|
846
870
|
|
|
847
|
-
###
|
|
871
|
+
### awsSesRegion?
|
|
848
872
|
|
|
849
|
-
> `optional` **
|
|
873
|
+
> `optional` **awsSesRegion**: `string`
|
|
850
874
|
|
|
851
|
-
AWS SES
|
|
875
|
+
AWS SES region.
|
|
852
876
|
|
|
853
877
|
#### Inherited from
|
|
854
878
|
|
|
855
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
879
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesRegion`](IEngineEnvironmentVariables.md#awssesregion)
|
|
856
880
|
|
|
857
881
|
***
|
|
858
882
|
|
|
859
|
-
###
|
|
883
|
+
### awsSesAuthMode?
|
|
860
884
|
|
|
861
|
-
> `optional` **
|
|
885
|
+
> `optional` **awsSesAuthMode**: `string`
|
|
862
886
|
|
|
863
|
-
AWS SES
|
|
887
|
+
AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
864
888
|
|
|
865
889
|
#### Inherited from
|
|
866
890
|
|
|
867
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
891
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAuthMode`](IEngineEnvironmentVariables.md#awssesauthmode)
|
|
868
892
|
|
|
869
893
|
***
|
|
870
894
|
|
|
871
|
-
###
|
|
895
|
+
### awsSesSecretAccessKey?
|
|
872
896
|
|
|
873
|
-
> `optional` **
|
|
897
|
+
> `optional` **awsSesSecretAccessKey**: `string`
|
|
874
898
|
|
|
875
|
-
AWS SES
|
|
899
|
+
AWS SES secret access key.
|
|
876
900
|
|
|
877
901
|
#### Inherited from
|
|
878
902
|
|
|
879
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
903
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineEnvironmentVariables.md#awssessecretaccesskey)
|
|
904
|
+
|
|
905
|
+
***
|
|
906
|
+
|
|
907
|
+
### awsSesAccessKeyId?
|
|
908
|
+
|
|
909
|
+
> `optional` **awsSesAccessKeyId**: `string`
|
|
910
|
+
|
|
911
|
+
AWS SES access key id.
|
|
912
|
+
|
|
913
|
+
#### Inherited from
|
|
914
|
+
|
|
915
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineEnvironmentVariables.md#awssesaccesskeyid)
|
|
880
916
|
|
|
881
917
|
***
|
|
882
918
|
|
|
@@ -1269,7 +1305,7 @@ Url which points to the api for a trusted synchronised storage node, not require
|
|
|
1269
1305
|
> `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
|
|
1270
1306
|
|
|
1271
1307
|
The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
|
|
1272
|
-
This only required if using a custom verifiable storage item, otherwise it will default
|
|
1308
|
+
This only required if using a custom verifiable storage item, otherwise it will default to the network name.
|
|
1273
1309
|
|
|
1274
1310
|
#### Inherited from
|
|
1275
1311
|
|
|
@@ -1551,16 +1587,39 @@ Is the data space connector enabled, defaults to false.
|
|
|
1551
1587
|
|
|
1552
1588
|
***
|
|
1553
1589
|
|
|
1554
|
-
###
|
|
1590
|
+
### dataSpaceConnectorRetainActivityLogsFor?
|
|
1555
1591
|
|
|
1556
|
-
> `optional` **
|
|
1592
|
+
> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
|
|
1557
1593
|
|
|
1558
|
-
The
|
|
1559
|
-
|
|
1594
|
+
The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
|
|
1595
|
+
|
|
1596
|
+
#### Default
|
|
1597
|
+
|
|
1598
|
+
```ts
|
|
1599
|
+
10
|
|
1600
|
+
```
|
|
1560
1601
|
|
|
1561
1602
|
#### Inherited from
|
|
1562
1603
|
|
|
1563
|
-
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`
|
|
1604
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
|
|
1605
|
+
|
|
1606
|
+
***
|
|
1607
|
+
|
|
1608
|
+
### dataSpaceConnectorActivityLogsCleanUpInterval?
|
|
1609
|
+
|
|
1610
|
+
> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
|
|
1611
|
+
|
|
1612
|
+
The interval for cleaning up the activity logs.
|
|
1613
|
+
|
|
1614
|
+
#### Default
|
|
1615
|
+
|
|
1616
|
+
```ts
|
|
1617
|
+
60
|
|
1618
|
+
```
|
|
1619
|
+
|
|
1620
|
+
#### Inherited from
|
|
1621
|
+
|
|
1622
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
|
|
1564
1623
|
|
|
1565
1624
|
***
|
|
1566
1625
|
|
|
@@ -1589,6 +1648,18 @@ Defaults to node-authentication-assertion.
|
|
|
1589
1648
|
|
|
1590
1649
|
***
|
|
1591
1650
|
|
|
1651
|
+
### extensions?
|
|
1652
|
+
|
|
1653
|
+
> `optional` **extensions**: `string`
|
|
1654
|
+
|
|
1655
|
+
A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
|
|
1656
|
+
|
|
1657
|
+
#### Inherited from
|
|
1658
|
+
|
|
1659
|
+
[`IEngineEnvironmentVariables`](IEngineEnvironmentVariables.md).[`extensions`](IEngineEnvironmentVariables.md#extensions)
|
|
1660
|
+
|
|
1661
|
+
***
|
|
1662
|
+
|
|
1592
1663
|
### port?
|
|
1593
1664
|
|
|
1594
1665
|
> `optional` **port**: `string`
|
|
@@ -81,6 +81,18 @@ A prefix for all the table in entity-storage, can be empty.
|
|
|
81
81
|
|
|
82
82
|
***
|
|
83
83
|
|
|
84
|
+
### awsDynamodbAuthMode?
|
|
85
|
+
|
|
86
|
+
> `optional` **awsDynamodbAuthMode**: `string`
|
|
87
|
+
|
|
88
|
+
AWS DynamoDB auth mode, either credentials or pod.
|
|
89
|
+
|
|
90
|
+
#### Inherited from
|
|
91
|
+
|
|
92
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsDynamodbAuthMode`](IEngineServerEnvironmentVariables.md#awsdynamodbauthmode)
|
|
93
|
+
|
|
94
|
+
***
|
|
95
|
+
|
|
84
96
|
### awsDynamodbAccessKeyId?
|
|
85
97
|
|
|
86
98
|
> `optional` **awsDynamodbAccessKeyId**: `string`
|
|
@@ -575,15 +587,15 @@ A prefix for all the blobs in blob-storage, can be empty.
|
|
|
575
587
|
|
|
576
588
|
***
|
|
577
589
|
|
|
578
|
-
###
|
|
590
|
+
### awsS3Region?
|
|
579
591
|
|
|
580
|
-
> `optional` **
|
|
592
|
+
> `optional` **awsS3Region**: `string`
|
|
581
593
|
|
|
582
|
-
AWS S3
|
|
594
|
+
AWS S3 region.
|
|
583
595
|
|
|
584
596
|
#### Inherited from
|
|
585
597
|
|
|
586
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`
|
|
598
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Region`](IEngineServerEnvironmentVariables.md#awss3region)
|
|
587
599
|
|
|
588
600
|
***
|
|
589
601
|
|
|
@@ -599,27 +611,27 @@ AWS S3 bucket name.
|
|
|
599
611
|
|
|
600
612
|
***
|
|
601
613
|
|
|
602
|
-
###
|
|
614
|
+
### awsS3AuthMode?
|
|
603
615
|
|
|
604
|
-
> `optional` **
|
|
616
|
+
> `optional` **awsS3AuthMode**: `string`
|
|
605
617
|
|
|
606
|
-
AWS S3
|
|
618
|
+
AWS S3 auth mode, either credentials or pod, defaults to credentials.
|
|
607
619
|
|
|
608
620
|
#### Inherited from
|
|
609
621
|
|
|
610
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`
|
|
622
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AuthMode`](IEngineServerEnvironmentVariables.md#awss3authmode)
|
|
611
623
|
|
|
612
624
|
***
|
|
613
625
|
|
|
614
|
-
###
|
|
626
|
+
### awsS3AccessKeyId?
|
|
615
627
|
|
|
616
|
-
> `optional` **
|
|
628
|
+
> `optional` **awsS3AccessKeyId**: `string`
|
|
617
629
|
|
|
618
|
-
AWS S3
|
|
630
|
+
AWS S3 access key id.
|
|
619
631
|
|
|
620
632
|
#### Inherited from
|
|
621
633
|
|
|
622
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`
|
|
634
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3AccessKeyId`](IEngineServerEnvironmentVariables.md#awss3accesskeyid)
|
|
623
635
|
|
|
624
636
|
***
|
|
625
637
|
|
|
@@ -635,6 +647,18 @@ AWS S3 secret access key.
|
|
|
635
647
|
|
|
636
648
|
***
|
|
637
649
|
|
|
650
|
+
### awsS3Endpoint?
|
|
651
|
+
|
|
652
|
+
> `optional` **awsS3Endpoint**: `string`
|
|
653
|
+
|
|
654
|
+
AWS S3 endpoint.
|
|
655
|
+
|
|
656
|
+
#### Inherited from
|
|
657
|
+
|
|
658
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsS3Endpoint`](IEngineServerEnvironmentVariables.md#awss3endpoint)
|
|
659
|
+
|
|
660
|
+
***
|
|
661
|
+
|
|
638
662
|
### azureStorageAccountKey?
|
|
639
663
|
|
|
640
664
|
> `optional` **azureStorageAccountKey**: `string`
|
|
@@ -840,39 +864,51 @@ Use the @json: prefix to specify the path to the JSON file.
|
|
|
840
864
|
|
|
841
865
|
***
|
|
842
866
|
|
|
843
|
-
###
|
|
867
|
+
### awsSesRegion?
|
|
844
868
|
|
|
845
|
-
> `optional` **
|
|
869
|
+
> `optional` **awsSesRegion**: `string`
|
|
846
870
|
|
|
847
|
-
AWS SES
|
|
871
|
+
AWS SES region.
|
|
848
872
|
|
|
849
873
|
#### Inherited from
|
|
850
874
|
|
|
851
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`
|
|
875
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesRegion`](IEngineServerEnvironmentVariables.md#awssesregion)
|
|
852
876
|
|
|
853
877
|
***
|
|
854
878
|
|
|
855
|
-
###
|
|
879
|
+
### awsSesAuthMode?
|
|
856
880
|
|
|
857
|
-
> `optional` **
|
|
881
|
+
> `optional` **awsSesAuthMode**: `string`
|
|
858
882
|
|
|
859
|
-
AWS SES
|
|
883
|
+
AWS SES auth mode, either credentials or pod, defaults to credentials.
|
|
860
884
|
|
|
861
885
|
#### Inherited from
|
|
862
886
|
|
|
863
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`
|
|
887
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAuthMode`](IEngineServerEnvironmentVariables.md#awssesauthmode)
|
|
864
888
|
|
|
865
889
|
***
|
|
866
890
|
|
|
867
|
-
###
|
|
891
|
+
### awsSesSecretAccessKey?
|
|
868
892
|
|
|
869
|
-
> `optional` **
|
|
893
|
+
> `optional` **awsSesSecretAccessKey**: `string`
|
|
870
894
|
|
|
871
|
-
AWS SES
|
|
895
|
+
AWS SES secret access key.
|
|
872
896
|
|
|
873
897
|
#### Inherited from
|
|
874
898
|
|
|
875
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`
|
|
899
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesSecretAccessKey`](IEngineServerEnvironmentVariables.md#awssessecretaccesskey)
|
|
900
|
+
|
|
901
|
+
***
|
|
902
|
+
|
|
903
|
+
### awsSesAccessKeyId?
|
|
904
|
+
|
|
905
|
+
> `optional` **awsSesAccessKeyId**: `string`
|
|
906
|
+
|
|
907
|
+
AWS SES access key id.
|
|
908
|
+
|
|
909
|
+
#### Inherited from
|
|
910
|
+
|
|
911
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`awsSesAccessKeyId`](IEngineServerEnvironmentVariables.md#awssesaccesskeyid)
|
|
876
912
|
|
|
877
913
|
***
|
|
878
914
|
|
|
@@ -1265,7 +1301,7 @@ Url which points to the api for a trusted synchronised storage node, not require
|
|
|
1265
1301
|
> `optional` **synchronisedStorageVerifiableStorageKeyId**: `string`
|
|
1266
1302
|
|
|
1267
1303
|
The key for the smart contract which contains the verifiable storage pointer store for synchronised storage.
|
|
1268
|
-
This only required if using a custom verifiable storage item, otherwise it will default
|
|
1304
|
+
This only required if using a custom verifiable storage item, otherwise it will default to the network name.
|
|
1269
1305
|
|
|
1270
1306
|
#### Inherited from
|
|
1271
1307
|
|
|
@@ -1547,16 +1583,39 @@ Is the data space connector enabled, defaults to false.
|
|
|
1547
1583
|
|
|
1548
1584
|
***
|
|
1549
1585
|
|
|
1550
|
-
###
|
|
1586
|
+
### dataSpaceConnectorRetainActivityLogsFor?
|
|
1551
1587
|
|
|
1552
|
-
> `optional` **
|
|
1588
|
+
> `optional` **dataSpaceConnectorRetainActivityLogsFor**: `string`
|
|
1553
1589
|
|
|
1554
|
-
The
|
|
1555
|
-
|
|
1590
|
+
The length of time to retain the activity logs for in minutes, set to -1 to keep forever.
|
|
1591
|
+
|
|
1592
|
+
#### Default
|
|
1593
|
+
|
|
1594
|
+
```ts
|
|
1595
|
+
10
|
|
1596
|
+
```
|
|
1556
1597
|
|
|
1557
1598
|
#### Inherited from
|
|
1558
1599
|
|
|
1559
|
-
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`
|
|
1600
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorRetainActivityLogsFor`](IEngineServerEnvironmentVariables.md#dataspaceconnectorretainactivitylogsfor)
|
|
1601
|
+
|
|
1602
|
+
***
|
|
1603
|
+
|
|
1604
|
+
### dataSpaceConnectorActivityLogsCleanUpInterval?
|
|
1605
|
+
|
|
1606
|
+
> `optional` **dataSpaceConnectorActivityLogsCleanUpInterval**: `string`
|
|
1607
|
+
|
|
1608
|
+
The interval for cleaning up the activity logs.
|
|
1609
|
+
|
|
1610
|
+
#### Default
|
|
1611
|
+
|
|
1612
|
+
```ts
|
|
1613
|
+
60
|
|
1614
|
+
```
|
|
1615
|
+
|
|
1616
|
+
#### Inherited from
|
|
1617
|
+
|
|
1618
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`dataSpaceConnectorActivityLogsCleanUpInterval`](IEngineServerEnvironmentVariables.md#dataspaceconnectoractivitylogscleanupinterval)
|
|
1560
1619
|
|
|
1561
1620
|
***
|
|
1562
1621
|
|
|
@@ -1585,6 +1644,18 @@ Defaults to node-authentication-assertion.
|
|
|
1585
1644
|
|
|
1586
1645
|
***
|
|
1587
1646
|
|
|
1647
|
+
### extensions?
|
|
1648
|
+
|
|
1649
|
+
> `optional` **extensions**: `string`
|
|
1650
|
+
|
|
1651
|
+
A comma separated list of additional node extensions to load, the initialiseExtension method will be called for each extension.
|
|
1652
|
+
|
|
1653
|
+
#### Inherited from
|
|
1654
|
+
|
|
1655
|
+
[`IEngineServerEnvironmentVariables`](IEngineServerEnvironmentVariables.md).[`extensions`](IEngineServerEnvironmentVariables.md#extensions)
|
|
1656
|
+
|
|
1657
|
+
***
|
|
1658
|
+
|
|
1588
1659
|
### port?
|
|
1589
1660
|
|
|
1590
1661
|
> `optional` **port**: `string`
|
|
@@ -113,15 +113,19 @@ Method to extend the engine environment variables with any additional custom con
|
|
|
113
113
|
|
|
114
114
|
### extendConfig()?
|
|
115
115
|
|
|
116
|
-
> `optional` **extendConfig**: (`config`) => `Promise`\<`void`\>
|
|
116
|
+
> `optional` **extendConfig**: (`envVars`, `config`) => `Promise`\<`void`\>
|
|
117
117
|
|
|
118
118
|
Method to extend the engine configuration with any additional custom configuration.
|
|
119
119
|
|
|
120
120
|
#### Parameters
|
|
121
121
|
|
|
122
|
+
##### envVars
|
|
123
|
+
|
|
124
|
+
[`INodeEnvironmentVariables`](INodeEnvironmentVariables.md)
|
|
125
|
+
|
|
122
126
|
##### config
|
|
123
127
|
|
|
124
|
-
`
|
|
128
|
+
[`INodeEngineConfig`](INodeEngineConfig.md)
|
|
125
129
|
|
|
126
130
|
#### Returns
|
|
127
131
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Type Alias: NodeExtensionInitialiseEngineMethod()
|
|
2
|
+
|
|
3
|
+
> **NodeExtensionInitialiseEngineMethod** = (`engineCore`) => `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
The type for the initialise engine method of an extension module.
|
|
6
|
+
This is called when the engine has been constructed but not yet started.
|
|
7
|
+
|
|
8
|
+
## Parameters
|
|
9
|
+
|
|
10
|
+
### engineCore
|
|
11
|
+
|
|
12
|
+
`IEngineCore`
|
|
13
|
+
|
|
14
|
+
The engine core instance.
|
|
15
|
+
|
|
16
|
+
## Returns
|
|
17
|
+
|
|
18
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Type Alias: NodeExtensionInitialiseEngineServerMethod()
|
|
2
|
+
|
|
3
|
+
> **NodeExtensionInitialiseEngineServerMethod** = (`engineCore`, `engineServer`) => `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
The type for the initialise engine server method of an extension module.
|
|
6
|
+
This is called when the engine server has been constructed but not yet started.
|
|
7
|
+
|
|
8
|
+
## Parameters
|
|
9
|
+
|
|
10
|
+
### engineCore
|
|
11
|
+
|
|
12
|
+
`IEngineCore`
|
|
13
|
+
|
|
14
|
+
The engine core instance.
|
|
15
|
+
|
|
16
|
+
### engineServer
|
|
17
|
+
|
|
18
|
+
`IEngineServer`
|
|
19
|
+
|
|
20
|
+
The engine server instance.
|
|
21
|
+
|
|
22
|
+
## Returns
|
|
23
|
+
|
|
24
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Type Alias: NodeExtensionInitialiseMethod()
|
|
2
|
+
|
|
3
|
+
> **NodeExtensionInitialiseMethod** = (`envVars`, `nodeEngineConfig`) => `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
The type for the initialise method of an extension module.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
### envVars
|
|
10
|
+
|
|
11
|
+
[`INodeEnvironmentVariables`](../interfaces/INodeEnvironmentVariables.md)
|
|
12
|
+
|
|
13
|
+
The environment variables for the node.
|
|
14
|
+
|
|
15
|
+
### nodeEngineConfig
|
|
16
|
+
|
|
17
|
+
[`INodeEngineConfig`](../interfaces/INodeEngineConfig.md)
|
|
18
|
+
|
|
19
|
+
The node engine config.
|
|
20
|
+
|
|
21
|
+
## Returns
|
|
22
|
+
|
|
23
|
+
`Promise`\<`void`\>
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Type Alias: NodeExtensionShutdownMethod()
|
|
2
|
+
|
|
3
|
+
> **NodeExtensionShutdownMethod** = () => `Promise`\<`void`\>
|
|
4
|
+
|
|
5
|
+
The type for the shutdown method of an extension module.
|
|
6
|
+
This is called when the engine is shutting down.
|
|
7
|
+
|
|
8
|
+
## Returns
|
|
9
|
+
|
|
10
|
+
`Promise`\<`void`\>
|
package/locales/en.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"error": {
|
|
3
3
|
"node": {
|
|
4
|
-
"storageFileRootNotSet": "{storageFileRoot} is not set, the server will not start without it, please set it in the shell or create a .env file"
|
|
4
|
+
"storageFileRootNotSet": "{storageFileRoot} is not set, the server will not start without it, please set it in the shell or create a .env file",
|
|
5
|
+
"extensionLoadingError": "Failed to load extension \"{extension}\""
|
|
5
6
|
}
|
|
6
7
|
},
|
|
7
8
|
"node": {
|
|
@@ -31,6 +32,12 @@
|
|
|
31
32
|
"existingUserProfile": "User profile already exists \"{identity}\"",
|
|
32
33
|
"nodeIdentity": "Node identity \"{identity}\"",
|
|
33
34
|
"nodeAdminUserEmail": "Node Admin User Email \"{email}\"",
|
|
34
|
-
"nodeAdminUserPassword": "Node Admin User Password \"{password}\""
|
|
35
|
+
"nodeAdminUserPassword": "Node Admin User Password \"{password}\"",
|
|
36
|
+
"extensionLoading": "Loading Extension",
|
|
37
|
+
"extensionInitialisingEngine": "Initialising engine for extension \"{extension}\"",
|
|
38
|
+
"extensionInitialisingEngineServer": "Initialising engine server for extension \"{extension}\"",
|
|
39
|
+
"extensionShutdown": "Shutdown extension \"{extension}\"",
|
|
40
|
+
"extendingEngine": "Extending Engine",
|
|
41
|
+
"extendingEngineServer": "Extending Engine Server"
|
|
35
42
|
}
|
|
36
43
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/node-core",
|
|
3
|
-
"version": "0.0.2-next.
|
|
3
|
+
"version": "0.0.2-next.18",
|
|
4
4
|
"description": "TWIN Node Core for serving APIs using the specified configuration",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@twin.org/api-auth-entity-storage-service": "next",
|
|
18
|
+
"@twin.org/cli-core": "next",
|
|
18
19
|
"@twin.org/core": "next",
|
|
19
20
|
"@twin.org/crypto": "next",
|
|
20
21
|
"@twin.org/data-space-connector-models": "next",
|
|
@@ -52,5 +53,16 @@
|
|
|
52
53
|
"dist/types",
|
|
53
54
|
"locales",
|
|
54
55
|
"docs"
|
|
56
|
+
],
|
|
57
|
+
"keywords": [
|
|
58
|
+
"twin",
|
|
59
|
+
"trade",
|
|
60
|
+
"iota",
|
|
61
|
+
"framework",
|
|
62
|
+
"blockchain",
|
|
63
|
+
"node",
|
|
64
|
+
"core",
|
|
65
|
+
"foundation",
|
|
66
|
+
"utilities"
|
|
55
67
|
]
|
|
56
68
|
}
|