@appsemble/types 0.27.7 → 0.27.9

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 (3) hide show
  1. package/README.md +3 -3
  2. package/cli.d.ts +96 -14
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
- # ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.7/config/assets/logo.svg) Appsemble Types
1
+ # ![](https://gitlab.com/appsemble/appsemble/-/raw/0.27.9/config/assets/logo.svg) Appsemble Types
2
2
 
3
3
  > Reusable TypeScript types
4
4
 
5
5
  [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
6
- [![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.7/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.7)
6
+ [![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.27.9/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.27.9)
7
7
  [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
8
8
 
9
9
  ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
26
26
 
27
27
  ## License
28
28
 
29
- [LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.7/LICENSE.md) ©
29
+ [LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.27.9/LICENSE.md) ©
30
30
  [Appsemble](https://appsemble.com)
package/cli.d.ts CHANGED
@@ -1,67 +1,149 @@
1
1
  import { type AppVisibility } from './app.js';
2
2
  import { type AppLock } from './index.js';
3
+ /**
4
+ * A `context` which can be specified using the `--context` command line argument.
5
+ */
3
6
  export interface AppsembleContext {
4
7
  /**
5
- * If `remote` is specified, this will override `--remote` passed by the command line.
8
+ * The remote the app should be under.
9
+ *
10
+ * If `remote` is specified, this will override `--remote` passed on the command line.
11
+ *
12
+ * @default "https://appsemble.app"
6
13
  */
7
14
  remote?: string;
8
15
  /**
9
- * If `organization` is specified, this will override `--organization` passed by the command line
10
- * when creating apps.
16
+ * The organization ID the app should be under.
17
+ *
18
+ * If `organization` is specified, this will override `--organization` passed on the command line.
11
19
  */
12
20
  organization?: string;
21
+ /**
22
+ * The path to the app icon to use.
23
+ *
24
+ * If `icon` is specified, this will override `--icon` passed on the command line.
25
+ *
26
+ * @default "icon.png"
27
+ */
13
28
  icon?: string;
29
+ /**
30
+ * The background color to use for maskable icons.
31
+ *
32
+ * If `iconBackground` is specified, this will override `--icon-background` passed on the command
33
+ * line.
34
+ */
14
35
  iconBackground?: string;
36
+ /**
37
+ * The path to the maskable app icon to use.
38
+ *
39
+ * If `maskableIcon` is specified, this will override `--maskable-icon` passed on the command
40
+ * line.
41
+ *
42
+ * @default "maskable-icon.png"
43
+ */
15
44
  maskableIcon?: string;
16
45
  /**
17
- * If `id` is specified, this will override `--id` passed by the command line when
18
- * updating an app.
46
+ * The id of the app to update.
47
+ *
48
+ * If `id` is specified, this will override `--id` passed on the command line.
19
49
  */
20
50
  id?: number;
21
51
  /**
22
52
  * The Google Analytics ID that should be used for the app.
53
+ *
54
+ * If `googleAnalyticsId` is specified, this will override `--google-analytics-id` passed on the
55
+ * command line.
23
56
  */
24
57
  googleAnalyticsId?: string;
25
58
  /**
26
59
  * The custom Sentry DSN for the app.
60
+ *
61
+ * If `sentryDsn` is specified, this will override `--sentry-dsn` passed on the command line.
27
62
  */
28
63
  sentryDsn?: string;
29
64
  /**
30
- * The environment for the custom Sentry DSN for the app.
65
+ * The custom Sentry environment to use for the app.
66
+ *
67
+ * If `sentryEnvironment` is specified, this will override `--sentry-environment` passed on the
68
+ * command line.
31
69
  */
32
70
  sentryEnvironment?: string;
33
71
  /**
72
+ * Whether the app-definition should be shown.
73
+ *
74
+ * If `showAppDefinition` is specified, this will override `--show-app-definition` passed on the
75
+ * command line.
76
+ */
77
+ showAppDefinition?: boolean;
78
+ /**
79
+ * The alternative app variant to use instead.
80
+ *
81
+ * If `variant` is specified, this will override `--variant` passed on the command line.
82
+ */
83
+ variant?: string;
84
+ /**
85
+ * Determine the app visibility of the app in the Appsemble app store.
86
+ *
87
+ * This doesn’t affect whether or not the app can be accessed on its own domain.
88
+ *
89
+ * - **public**: The app is publicly listed in the Appsemble app store.
90
+ * - **unlisted**: The app store page can be accessed, but the app isn’t listed publicly in the
91
+ * Appsemble app store.
92
+ * - **private**: The app is only visible to people who are part of the organization.
93
+ *
34
94
  * If `visibility` is specified, this will override `--visibility` passed on the command line.
35
95
  */
36
96
  visibility?: AppVisibility;
37
97
  /**
98
+ * Whether the app should be a template app.
99
+ *
38
100
  * If `template` is specified, this will override `--template` passed on the command line.
39
101
  */
40
102
  template?: boolean;
41
103
  /**
104
+ * Whether the app should be in demoMode.
105
+ *
42
106
  * If `demoMode` is specified, this will override `--demo-mode` passed on the command line.
43
107
  */
44
108
  demoMode?: boolean;
45
109
  /**
46
- * If `seed` is specified, this will override `--seed` passed on the command line.
110
+ * Set the value of AppLock for your app.
111
+ *
112
+ * If `appLock` is specified, this will override `--app-lock` passed on the command line.
47
113
  */
48
- seed?: boolean;
114
+ appLock?: AppLock;
49
115
  /**
50
- * Whether app assets should be clonable.
116
+ * A list of collections the app should be added to.
117
+ *
118
+ * If `collections` is specified, this will override `--collections` passed on the command line.
51
119
  */
52
- assetsClonable?: boolean;
120
+ collections?: number[];
53
121
  /**
54
- * Set the value of AppLock for your app.
122
+ * Whether to publish resources from the resources directory.
123
+ *
124
+ * If resources is specified, this will override --resources passed on the command line.
55
125
  */
56
- appLock?: AppLock;
126
+ resources?: boolean;
57
127
  /**
58
- * A list of collections the app needs to be added to
128
+ * Whether to publish assets from the assets directory.
129
+ *
130
+ * If assets is specified, this will override --assets passed on the command line.
59
131
  */
60
- collections?: string[];
132
+ assets?: boolean;
133
+ /**
134
+ * Whether app assets should be clonable.
135
+ *
136
+ * If `assetsClonable` is specified, this will override `--assets-clonable` passed on the command
137
+ * line.
138
+ */
139
+ assetsClonable?: boolean;
61
140
  }
62
141
  export interface AppsembleRC {
63
142
  /**
64
143
  * The background color to use for maskable icons.
144
+ *
145
+ * If `iconBackground` is specified, this will override `--icon-background` passed on the command
146
+ * line.
65
147
  */
66
148
  iconBackground?: string;
67
149
  context?: Record<string, AppsembleContext>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appsemble/types",
3
- "version": "0.27.7",
3
+ "version": "0.27.9",
4
4
  "description": "TypeScript definitions reused within Appsemble internally",
5
5
  "keywords": [
6
6
  "app",