@appsemble/types 0.20.9 → 0.20.12

package/action.d.ts

@@ -0,0 +1,46 @@
+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 declare type RequestAction = RequestLikeAction<'request'>;
+export declare type ResourceCreateAction = RequestLikeAction<'resource.create'>;
+export declare type ResourceDeleteAction = RequestLikeAction<'resource.delete'>;
+export declare type ResourceGetAction = RequestLikeAction<'resource.get'>;
+export declare type ResourceQueryAction = RequestLikeAction<'resource.query'>;
+export declare type ResourceCountAction = RequestLikeAction<'resource.count'>;
+export declare type ResourceUpdateAction = RequestLikeAction<'resource.update'>;
+/**
+ * An action that can be called from within a block.
+ */
+export declare 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;
+export {};

package/action.js

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

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.d.ts

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

package/bulma.js

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

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.d.ts

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

package/http.js

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

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}

@@ -1,22 +1,28 @@
-import { Action, BaseMessage, HTTPMethods, LogAction, Theme } from '@appsemble/sdk/src/types';
 import { IconName } from '@fortawesome/fontawesome-common-types';
 import { Schema } from 'jsonschema';
 import { OpenAPIV3 } from 'openapi-types';
 import { JsonObject, RequireExactlyOne } from 'type-fest';
+import { Action, LogAction } from './action';
 import { AppVisibility, TeamsDefinition } from './app';
+import { BulmaColor } from './bulma';
+import { HTTPMethods } from './http';
+import { Theme } from './theme';
+export * from './action';
 export * from './app';
 export * from './appMember';
 export * from './asset';
 export * from './authentication';
 export * from './author';
+export * from './bulma';
+export * from './http';
 export * from './snapshot';
 export * from './resource';
 export * from './saml';
 export * from './ssl';
 export * from './team';
 export * from './template';
+export * from './theme';
 export * from './user';
-export { Theme };
 /**
  * A representation of a generated OAuth2 authorization code response.
  */
@@ -129,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
@@ -569,8 +579,19 @@ export interface BaseActionDefinition<T extends Action['type']> {
     /**
      * A remapper function. This may be used to remap data before it is passed into the action
      * function.
+     *
+     * @deprecated Since 0.20.10, use {@link remapBefore} instead.
      */
     remap?: Remapper;
+    /**
+     * A remapper function. This may be used to remap data before it is passed into the action
+     * function.
+     */
+    remapBefore?: Remapper;
+    /**
+     * The remapper used to transfrom the output before passing it to the next action.
+     */
+    remapAfter?: Remapper;
     /**
      * Another action that is dispatched when the action has been dispatched successfully.
      */
@@ -890,6 +911,26 @@ export interface StaticActionDefinition extends BaseActionDefinition<'static'> {
      */
     value: any;
 }
+export interface BaseMessage {
+    /**
+     * The color to use for the message.
+     *
+     * @default 'info'
+     */
+    color?: BulmaColor;
+    /**
+     * The timeout period for this message (in milliseconds).
+     *
+     * @default 5000
+     */
+    timeout?: number;
+    /**
+     * Whether or not to show the dismiss button.
+     *
+     * @default false
+     */
+    dismissable?: boolean;
+}
 export declare type MessageActionDefinition = BaseActionDefinition<'message'> & BaseMessage & {
     /**
      * The content of the message to display.
@@ -974,6 +1015,7 @@ export interface BlockManifest {
      * If the block has no messages, this property is `null`.
      */
     languages: string[] | null;
+    examples?: string[];
     /**
      * Whether the block should be listed publicly
      * for users who aren’t part of the block’s organization.

package/{dist/index.js → index.js}

@@ -1,13 +1,17 @@
+export * from './action';
 export * from './app';
 export * from './appMember';
 export * from './asset';
 export * from './authentication';
 export * from './author';
+export * from './bulma';
+export * from './http';
 export * from './snapshot';
 export * from './resource';
 export * from './saml';
 export * from './ssl';
 export * from './team';
 export * from './template';
+export * from './theme';
 export * from './user';
 //# sourceMappingURL=index.js.map

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"}