@appsemble/types 0.20.10 → 0.20.13

package/README.md

@@ -1,10 +1,10 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.18.23/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.20.13/config/assets/logo.svg) Appsemble Types
 
 > Reusable TypeScript types
 
 [![npm](https://img.shields.io/npm/v/@appsemble/types)](https://www.npmjs.com/package/@appsemble/types)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.18.23/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.18.23)
-[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.18.23/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.20.13/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.20.13)
+[![Code coverage](https://codecov.io/gl/appsemble/appsemble/branch/0.20.13/graph/badge.svg)](https://codecov.io/gl/appsemble/appsemble)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Installation
@@ -21,5 +21,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.18.23/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.20.13/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/action.js.map

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

package/action.ts

@@ -0,0 +1,93 @@
+import { Remapper } from '.';
+import { HTTPMethods } from './http';
+
+interface BaseAction<T extends string> {
+  /**
+   * A function which can be called to dispatch the action.
+   */
+  <R>(data?: any, context?: Record<string, any>): Promise<R>;
+
+  /**
+   * The type of the action.
+   */
+  type: T;
+}
+
+export interface LinkAction extends BaseAction<'link'> {
+  /**
+   * Get the link that the action would link to if the given data was passed.
+   */
+  href: (data?: unknown) => string;
+}
+
+export interface LogAction extends BaseAction<'log'> {
+  /**
+   * The logging level.
+   */
+  level: 'error' | 'info' | 'warn';
+}
+
+interface RequestLikeAction<T extends Action['type']> extends BaseAction<T> {
+  /**
+   * The HTTP method used to make the request.
+   */
+  method: HTTPMethods;
+  /**
+   * The URL to which the request will be made.
+   */
+  url: Remapper;
+}
+
+export type RequestAction = RequestLikeAction<'request'>;
+export type ResourceCreateAction = RequestLikeAction<'resource.create'>;
+export type ResourceDeleteAction = RequestLikeAction<'resource.delete'>;
+export type ResourceGetAction = RequestLikeAction<'resource.get'>;
+export type ResourceQueryAction = RequestLikeAction<'resource.query'>;
+export type ResourceCountAction = RequestLikeAction<'resource.count'>;
+export type ResourceUpdateAction = RequestLikeAction<'resource.update'>;
+
+/**
+ * An action that can be called from within a block.
+ */
+export type Action =
+  | BaseAction<'analytics'>
+  | BaseAction<'condition'>
+  | BaseAction<'dialog.error'>
+  | BaseAction<'dialog.ok'>
+  | BaseAction<'dialog'>
+  | BaseAction<'download'>
+  | BaseAction<'email'>
+  | BaseAction<'event'>
+  | BaseAction<'flow.back'>
+  | BaseAction<'flow.cancel'>
+  | BaseAction<'flow.finish'>
+  | BaseAction<'flow.next'>
+  | BaseAction<'flow.to'>
+  | BaseAction<'link.back'>
+  | BaseAction<'link.next'>
+  | BaseAction<'message'>
+  | BaseAction<'noop'>
+  | BaseAction<'resource.subscription.status'>
+  | BaseAction<'resource.subscription.subscribe'>
+  | BaseAction<'resource.subscription.toggle'>
+  | BaseAction<'resource.subscription.unsubscribe'>
+  | BaseAction<'share'>
+  | BaseAction<'static'>
+  | BaseAction<'storage.read'>
+  | BaseAction<'storage.write'>
+  | BaseAction<'team.invite'>
+  | BaseAction<'team.join'>
+  | BaseAction<'team.list'>
+  | BaseAction<'throw'>
+  | BaseAction<'user.login'>
+  | BaseAction<'user.register'>
+  | BaseAction<'user.update'>
+  | LinkAction
+  | LogAction
+  | RequestAction
+  | ResourceCountAction
+  | ResourceCreateAction
+  | ResourceDeleteAction
+  | ResourceGetAction
+  | ResourceQueryAction
+  | ResourceUpdateAction;

package/app.js.map

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

package/app.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 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/appMember.js.map

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

package/appMember.ts

@@ -0,0 +1,22 @@
+import { IconName } from '@fortawesome/fontawesome-common-types';
+
+import { App } from '.';
+
+export interface SSOConfiguration {
+  type: 'oauth2' | 'saml';
+  url: string;
+  icon: IconName;
+  name: string;
+}
+
+export interface AppAccount {
+  id: string;
+  role: string;
+  name: string;
+  email: string;
+  emailVerified: boolean;
+  picture: string;
+  app: App;
+  sso: SSOConfiguration[];
+  properties: Record<string, string>;
+}

package/asset.js.map

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

package/asset.ts

@@ -0,0 +1,31 @@
+export interface Asset {
+  /**
+   * The unique ID of the asset.
+   */
+  id: string;
+
+  /**
+   * The mime type of the asset.
+   */
+  mime: string;
+
+  /**
+   * The filename of the asset as it was uploaded.
+   */
+  filename?: string;
+
+  /**
+   * A custom name that was given to the asset.
+   */
+  name?: string;
+
+  /**
+   * The ID of the resource the asset is linked to.
+   */
+  resourceId?: number;
+
+  /**
+   * The type of the resource the asset is linked to.
+   */
+  resourceType?: number;
+}

package/{dist/authentication.js.map → authentication.js.map}

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

package/authentication.ts

@@ -0,0 +1,5 @@
+export interface LoginCodeResponse {
+  isAllowed: boolean;
+  appName?: string;
+  code: string;
+}

package/author.js.map

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

package/author.ts

@@ -0,0 +1,14 @@
+/**
+ * A minimal user representation used to display author information on various data types.
+ */
+export interface Author {
+  /**
+   * The user id.
+   */
+  id: string;
+
+  /**
+   * The display name of the user.
+   */
+  name: string;
+}

package/bulma.js.map

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

package/bulma.ts

@@ -0,0 +1,14 @@
+/**
+ * A color known to Bulma.
+ */
+export type BulmaColor =
+  | 'danger'
+  | 'dark'
+  | 'info'
+  | 'link'
+  | 'primary'
+  | 'success'
+  | 'warning'
+  | 'white';
+
+export type BulmaSize = 'large' | 'medium' | 'normal' | 'small';

package/http.js.map

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

package/http.ts

@@ -0,0 +1,14 @@
+/**
+ * Common HTTP methods, but either all upper case or all lower case.
+ */
+export type HTTPMethods =
+  | 'DELETE'
+  | 'delete'
+  | 'GET'
+  | 'get'
+  | 'PATCH'
+  | 'patch'
+  | 'POST'
+  | 'post'
+  | 'PUT'
+  | 'put';

package/{dist/index.d.ts → index.d.ts}

@@ -135,6 +135,10 @@ export interface UserInfo {
      * The end-user’s locale, represented as a BCP47 language tag.
      */
     locale?: string;
+    /**
+     * The end-user’s time zone.
+     */
+    zoneinfo?: string;
 }
 /**
  * The payload stored in our JSON web tokens

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAWA,cAAc,UAAU,CAAC;AACzB,cAAc,OAAO,CAAC;AACtB,cAAc,aAAa,CAAC;AAC5B,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC;AACvB,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,SAAS,CAAC;AACxB,cAAc,QAAQ,CAAC"}