@appsemble/types 0.19.7 → 0.19.11

package/dist/app.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The app visibility of the app in the Appsemble app store.
+ *
+ * This doesn’t affect whether or not the app can be accessed on its own domain.
+ *
+ * - **public**: The app is publicly listed in the Appsemble app store.
+ * - **unlisted**: The app store page can be accessed, but the app isn’t listed publicly in the
+ * Appsemble app store.
+ * - **private**: The app is only visible to people who are part of the organization.
+ */
+export declare type AppVisibility = 'private' | 'public' | 'unlisted';

package/dist/app.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=app.js.map

package/dist/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -3,6 +3,8 @@ import { IconName } from '@fortawesome/fontawesome-common-types';
 import { Schema } from 'jsonschema';
 import { OpenAPIV3 } from 'openapi-types';
 import { JsonObject, RequireExactlyOne } from 'type-fest';
+import { AppVisibility } from './app';
+export * from './app';
 export * from './appMember';
 export * from './asset';
 export * from './authentication';
@@ -253,8 +255,10 @@ export interface Remappers {
     static: any;
     /**
      * Get a property from an object.
+     *
+     * If the prop is an array, nested properties will be retrieved in sequence.
      */
-    prop: number | string;
+    prop: number[] | string[] | number | string;
     /**
      * Recursively strip all nullish values from an object or array.
      */
@@ -453,6 +457,16 @@ export interface BaseActionDefinition<T extends Action['type']> {
      */
     onError?: ActionDefinition;
 }
+export interface AnalyticsAction extends BaseActionDefinition<'analytics'> {
+    /**
+     * The analytics event target name.
+     */
+    target: string;
+    /**
+     * Additional config to pass to analytics.
+     */
+    config?: Remapper;
+}
 export interface ConditionActionDefinition extends BaseActionDefinition<'condition'> {
     /**
      * The condition to check for.
@@ -490,6 +504,12 @@ export interface EmailActionDefinition extends BaseActionDefinition<'email'> {
      * The recipient of the email.
      */
     to?: Remapper;
+    /**
+     * The name of the sender.
+     *
+     * The default value depends on the email server.
+     */
+    from?: Remapper;
     /**
      * The recipients to CC the email to.
      */
@@ -708,7 +728,7 @@ export declare type MessageActionDefinition = BaseActionDefinition<'message'> &
      */
     body: Remapper;
 };
-export declare type ActionDefinition = BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'team.join'> | BaseActionDefinition<'team.list'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | DialogActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageReadActionDefinition | StorageWriteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
+export declare type ActionDefinition = AnalyticsAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'team.join'> | BaseActionDefinition<'team.list'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | DialogActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MessageActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageReadActionDefinition | StorageWriteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.
@@ -981,6 +1001,10 @@ export interface App {
      */
     id?: number;
     domain?: string;
+    /**
+     * The name used for emails
+     */
+    emailName?: string;
     /**
      * The id of the organization this app belongs to.
      */
@@ -998,9 +1022,13 @@ export interface App {
      */
     path: string;
     /**
-     * Whether the app should be visible for users outside of the app’s organization.
+     * Visibility of the app in the public app store.
+     */
+    visibility: AppVisibility;
+    /**
+     * Whether or not the app definition is exposed for display in Appsemble Studio.
      */
-    private: boolean;
+    showAppDefinition: boolean;
     /**
      * The Google analytics ID of the app.
      */
@@ -1017,6 +1045,14 @@ export interface App {
      * Whether the Appsemble OAuth2 login method should be shown.
      */
     showAppsembleOAuth2Login: boolean;
+    /**
+     * The Sentry DSN of the app.
+     */
+    sentryDsn: string;
+    /**
+     * The Sentry environment associated with the Sentry DSN.
+     */
+    sentryEnvironment: string;
     /**
      * The app definition.
      */

package/dist/index.js

@@ -1,3 +1,4 @@
+export * from './app';
 export * from './appMember';
 export * from './asset';
 export * from './authentication';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC;AACvB,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC"}

package/dist/template.d.ts

@@ -1,3 +1,4 @@
+import { AppVisibility } from './app';
 export interface Template {
     /**
      * The id of the app to clone.
@@ -16,9 +17,9 @@ export interface Template {
      */
     organizationId: string;
     /**
-     * Whether or not the cloned app should be marked as private.
+     * Whether or not the cloned app may be listed in the app store.
      */
-    private: boolean;
+    visibility: AppVisibility;
     /**
      * Whether or not clonable resources should be cloned from the template app.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.19.7",
+  "version": "0.19.11",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -30,10 +30,10 @@
     "test": "jest"
   },
   "dependencies": {
-    "@appsemble/sdk": "0.19.7",
+    "@appsemble/sdk": "0.19.11",
     "@fortawesome/fontawesome-common-types": "^0.2.0",
     "jsonschema": "^1.0.0",
-    "openapi-types": "^9.0.0",
+    "openapi-types": "^10.0.0",
     "type-fest": "^2.0.0"
   }
 }