@appsemble/types 0.20.0 → 0.20.3

package/dist/app.d.ts

@@ -9,3 +9,28 @@
  * - **private**: The app is only visible to people who are part of the organization.
  */
 export declare type AppVisibility = 'private' | 'public' | 'unlisted';
+/**
+ * This defines how teams are handled by an app.
+ */
+export interface TeamsDefinition {
+    /**
+     * If this is set to `anyone`, any logged in user may join a team. If this is set to `invite`,
+     * only users may join who have been invited.
+     */
+    join: 'anyone' | 'invite';
+    /**
+     * A list of app roles which may create a team.
+     *
+     * By default teams can only be created from Appsemble Studio.
+     *
+     * @default []
+     */
+    create?: string[];
+    /**
+     * The roles here determine which users may invite a team member.
+     *
+     * The special roles `$team:member` and `$team:manager` mean that users who are already member of
+     * manager of the team may also invite new members.
+     */
+    invite: string[];
+}

package/dist/index.d.ts

@@ -3,7 +3,7 @@ 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';
+import { AppVisibility, TeamsDefinition } from './app';
 export * from './app';
 export * from './appMember';
 export * from './asset';
@@ -13,6 +13,7 @@ export * from './snapshot';
 export * from './resource';
 export * from './saml';
 export * from './ssl';
+export * from './team';
 export * from './template';
 export * from './user';
 export { Theme };
@@ -330,6 +331,10 @@ export interface Security {
         policy?: 'everyone' | 'invite' | 'organization';
     };
     roles: Record<string, RoleDefinition>;
+    /**
+     * Define how teams are handled by the app.
+     */
+    teams?: TeamsDefinition;
 }
 export declare type Navigation = 'bottom' | 'hidden' | 'left-menu';
 export declare type LayoutPosition = 'hidden' | 'navbar' | 'navigation';
@@ -608,6 +613,16 @@ export interface StorageWriteActionDefinition extends BaseActionDefinition<'stor
      */
     storage?: StorageType;
 }
+export interface TeamInviteActionDefinition extends BaseActionDefinition<'team.invite'> {
+    /**
+     * The ID of the team to invite the user to.
+     */
+    id?: Remapper;
+    /**
+     * The email address of the user to invite.
+     */
+    email?: Remapper;
+}
 export interface UserLoginAction extends BaseActionDefinition<'user.login'> {
     /**
      * The email address to login with.
@@ -751,7 +766,7 @@ export declare type MessageActionDefinition = BaseActionDefinition<'message'> &
      */
     body: Remapper;
 };
-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 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 | TeamInviteActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.
@@ -829,6 +844,15 @@ export interface BlockManifest {
      * If the block has no messages, this property is `null`.
      */
     languages: string[] | null;
+    /**
+     * Whether the block should be listed publicly
+     * for users who aren’t part of the block’s organization.
+     *
+     * - **`public`**: The block is visible for everyone.
+     * - **`unlisted`**: The block will only be visible if the user is
+     * logged in and is part of the block’s organization.
+     */
+    visibility?: 'public' | 'unlisted';
     /**
      * Whether action validation for wildcard action is skipped.
      */
@@ -1194,26 +1218,6 @@ export interface Organization {
      */
     iconUrl: string;
 }
-/**
- * Represents a team within an organization.
- */
-export interface Team {
-    /**
-     * The ID of the team.
-     */
-    id: number;
-    /**
-     * The display name of the team.
-     */
-    name: string;
-    /**
-     * Custom annotations for the team.
-     */
-    annotations?: Record<string, string>;
-}
-export interface TeamMember extends Team {
-    role: 'manager' | 'member';
-}
 /**
  * An invite for an organizaton.
  */
@@ -1409,7 +1413,7 @@ export declare type SAMLStatus = 'badsignature' | 'emailconflict' | 'invalidrela
  *
  * This configuration is also passed to the Webpack configuration function as the `env` variable.
  */
-export interface BlockConfig extends Pick<BlockManifest, 'actions' | 'description' | 'events' | 'layout' | 'longDescription' | 'messages' | 'name' | 'parameters' | 'version' | 'wildcardActions'> {
+export interface BlockConfig extends Pick<BlockManifest, 'actions' | 'description' | 'events' | 'layout' | 'longDescription' | 'messages' | 'name' | 'parameters' | 'version' | 'visibility' | 'wildcardActions'> {
     /**
      * The path to the webpack configuration file relative to the block project directory.
      */

package/dist/index.js

@@ -7,6 +7,7 @@ export * from './snapshot';
 export * from './resource';
 export * from './saml';
 export * from './ssl';
+export * from './team';
 export * from './template';
 export * from './user';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"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"}
+{"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,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC"}

package/dist/team.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Represents a team within an organization.
+ */
+export interface Team {
+    /**
+     * The ID of the team.
+     */
+    id: number;
+    /**
+     * The display name of the team.
+     */
+    name: string;
+    /**
+     * Custom annotations for the team.
+     */
+    annotations?: Record<string, string>;
+}
+export interface TeamMember extends Team {
+    role: 'manager' | 'member';
+}

package/dist/team.js

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

package/dist/team.js.map

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

package/package.json

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