@d4l/collect-lib 1.11.0 → 1.12.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.
package/README.md CHANGED
@@ -48,14 +48,15 @@ Update the types by running `yarn run readme:update`.
48
48
 
49
49
  #### ProgramFeatured
50
50
 
51
- | Properties | Required | Type | Description |
52
- | ---------------------- | -------- | ------- | -------------------------------------------------- |
53
- | enabled | true | boolean | Denotes if the program is featured |
54
- | showProgramImage | false | boolean | Denotes if the program image should be shown |
55
- | showInstituteImage | false | boolean | Denotes if the institute image should be shown |
56
- | showContactInformation | false | boolean | Denotes if the contact information should be shown |
57
- | showSensors | false | boolean | Denotes if the sensors should be shown |
58
- | estimatedEffort | false | object | The estimated effort for the program |
51
+ | Properties | Required | Type | Description |
52
+ | ---------------------- | -------- | ---------------- | -------------------------------------------------------------------------------- |
53
+ | enabled | true | boolean | Denotes if the program is featured |
54
+ | showProgramImage | false | boolean | Denotes if the program image should be shown |
55
+ | showInstituteImage | false | boolean | Denotes if the institute image should be shown |
56
+ | showContactInformation | false | boolean | Denotes if the contact information should be shown |
57
+ | showSensors | false | boolean | Denotes if the sensors should be shown |
58
+ | estimatedEffort | false | object | The estimated effort for the program |
59
+ | description | false | TranslatedString | Shown as short description in featured listing (required if featured is enabled) |
59
60
 
60
61
  ### ProgramSteps
61
62
 
package/dist/index.d.mts CHANGED
@@ -168,6 +168,7 @@ type ProgramFeatured = {
168
168
  unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
169
169
  per: 'day' | 'week' | 'month' | 'year';
170
170
  };
171
+ description?: TranslatedString;
171
172
  };
172
173
  type ProgramType = 'study' | 'sensor';
173
174
  type ProgramStepBase = {
package/dist/index.d.ts CHANGED
@@ -168,6 +168,7 @@ type ProgramFeatured = {
168
168
  unit: 'minutes' | 'hours' | 'days' | 'weeks' | 'months' | 'years';
169
169
  per: 'day' | 'week' | 'month' | 'year';
170
170
  };
171
+ description?: TranslatedString;
171
172
  };
172
173
  type ProgramType = 'study' | 'sensor';
173
174
  type ProgramStepBase = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d4l/collect-lib",
3
- "version": "1.11.0",
3
+ "version": "1.12.0",
4
4
  "main": "./dist/index.js",
5
5
  "module": "./dist/index.mjs",
6
6
  "types": "./dist/index.d.ts",