heim 0.1.0-alpha.6 → 0.1.0-alpha.8

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 (2) hide show
  1. package/package.json +1 -1
  2. package/types.d.ts +20 -7
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "heim",
3
- "version": "0.1.0-alpha.6",
3
+ "version": "0.1.0-alpha.8",
4
4
  "description": "The library to create heim.ts files for heim apps.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
package/types.d.ts CHANGED
@@ -44,7 +44,7 @@ declare global {
44
44
  */
45
45
  slug: string;
46
46
  /**
47
- * The version of the app, must be a valid semver version.
47
+ * The version of the app, must be a valid semver version with no build metadata. Examples: 1.0.0, 2.3.4-beta.1
48
48
  */
49
49
  version: string;
50
50
  /**
@@ -54,11 +54,11 @@ declare global {
54
54
  /**
55
55
  * A short description of the app.
56
56
  */
57
- tagline: LocalizedString1 | string;
57
+ tagline: LocalizedString | string;
58
58
  /**
59
59
  * The description of the app. It needs to be a markdown file.
60
60
  */
61
- readme?: LocalizedString2 | string;
61
+ readme?: LocalizedString | string;
62
62
  /**
63
63
  * The category of the app.
64
64
  */
@@ -100,7 +100,7 @@ declare global {
100
100
  /**
101
101
  * A list of images that showcase the app.
102
102
  */
103
- galleryImages?: string[] | LocalizedString3;
103
+ galleryImages?: string[] | LocalizedStringArray;
104
104
  /**
105
105
  * The website of the app.
106
106
  */
@@ -116,15 +116,27 @@ declare global {
116
116
  /**
117
117
  * The license file of the app.
118
118
  */
119
- license?: LocalizedString4 | string;
119
+ license?: LocalizedString | string;
120
120
  /**
121
121
  * The CPU architectures of the app. This is required, if your `compose` field contains a function instead of a static object.
122
122
  */
123
123
  supportedArchitectures?: ("amd64" | "arm64" | "riscv64")[];
124
124
  /**
125
- * The minimum version of heim that is required to run the app. This is used to prevent users from installing an app that requires features of a newer version of heim.
125
+ * The minimum version of heim as a valid semver (e.g. 1.0.0) that is required to run the app. This is used to prevent users from installing an app that requires features of a newer version of heim.
126
126
  */
127
127
  minHeimVersion?: string;
128
+ /**
129
+ * The minimum version of the app from which an update is allowed, as a valid semver (e.g. 1.0.0). If multiple updates needed to be performed (stepped update), "heim update" will handle them automatically.
130
+ */
131
+ minUpdateFrom?: string;
132
+ };
133
+
134
+ type LocalizedString = {
135
+ [locale: string]: string;
136
+ };
137
+
138
+ type LocalizedStringArray = {
139
+ [locale: string]: string[];
128
140
  };
129
141
 
130
142
  type Inputs = Record<string, Input>;
@@ -384,8 +396,9 @@ declare global {
384
396
  * Stores a configuration value for the given key.
385
397
  * @param key The key of the configuration item to store.
386
398
  * @param value The value to store.
399
+ * @param options Mark passwords, tokens, etc... as secrets with `{ secret: true }`, so they are encrypted
387
400
  */
388
- setItem(key: string, value: string): void;
401
+ setItem(key: string, value: string, options?: { secret?: boolean }): void;
389
402
  /**
390
403
  * Removes a configuration value for the given key.
391
404
  * @param key The key of the configuration item to remove.