@appsemble/types 0.25.2 → 0.26.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.25.2/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.26.0/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.25.2/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.25.2)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.26.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.26.0)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -26,5 +26,5 @@ not guaranteed.
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.25.2/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.26.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/action.d.ts

@@ -1,5 +1,5 @@
 import { type HTTPMethods } from './http.js';
-import { type Remapper } from './index.js';
+import { type ActionDefinition, type Remapper } from './index.js';
 interface BaseAction<T extends string> {
     /**
      * A function which can be called to dispatch the action.
@@ -44,4 +44,41 @@ export type ResourcePatchAction = RequestLikeAction<'resource.patch'>;
  * An action that can be called from within a block.
  */
 export type Action = BaseAction<'analytics'> | BaseAction<'condition'> | BaseAction<'controller'> | BaseAction<'dialog.error'> | BaseAction<'dialog.ok'> | BaseAction<'dialog'> | BaseAction<'download'> | BaseAction<'each'> | 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<'match'> | BaseAction<'message'> | BaseAction<'noop'> | BaseAction<'notify'> | BaseAction<'resource.subscription.status'> | BaseAction<'resource.subscription.subscribe'> | BaseAction<'resource.subscription.toggle'> | BaseAction<'resource.subscription.unsubscribe'> | BaseAction<'share'> | BaseAction<'static'> | BaseAction<'storage.append'> | BaseAction<'storage.delete'> | BaseAction<'storage.read'> | BaseAction<'storage.subtract'> | BaseAction<'storage.update'> | BaseAction<'storage.write'> | BaseAction<'team.invite'> | BaseAction<'team.join'> | BaseAction<'team.list'> | BaseAction<'team.members'> | BaseAction<'throw'> | BaseAction<'user.create'> | BaseAction<'user.login'> | BaseAction<'user.logout'> | BaseAction<'user.query'> | BaseAction<'user.register'> | BaseAction<'user.remove'> | BaseAction<'user.update'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourcePatchAction | ResourceQueryAction | ResourceUpdateAction;
+interface ActionErrorOptions<D extends ActionDefinition> {
+    /**
+     * What caused the error to be thrown.
+     */
+    cause: unknown;
+    /**
+     * The action input data.
+     */
+    data: unknown;
+    /**
+     * The definition of the action that threw the error.
+     */
+    definition: D;
+    /**
+     * The HTTP status code of the error, if there is one.
+     */
+    status?: number;
+}
+/**
+ * This error may be thrown by actions.
+ */
+export declare class ActionError<D extends ActionDefinition = ActionDefinition> extends Error {
+    cause: unknown;
+    /**
+     * The action input data.
+     */
+    data: unknown;
+    /**
+     * The definition of the action that threw the error.
+     */
+    definition: D;
+    /**
+     * The HTTP status code of the error, if there is one.
+     */
+    status?: number;
+    constructor(options: ActionErrorOptions<D>);
+}
 export {};

package/action.js

@@ -1,2 +1,30 @@
-export {};
+/**
+ * This error may be thrown by actions.
+ */
+export class ActionError extends Error {
+    constructor(options) {
+        const { cause, data, definition } = options;
+        super(`An error occurred while running ${definition.type}`, { cause });
+        this.data = data;
+        this.definition = definition;
+        if (typeof cause === 'object' && cause != null && 'response' in cause) {
+            const { response } = cause;
+            if (typeof response === 'object' && response != null && 'status' in response) {
+                const responseStatus = response.status;
+                if (responseStatus && typeof responseStatus === 'number') {
+                    this.status = responseStatus;
+                }
+            }
+        }
+        // eslint-disable-next-line unicorn/custom-error-definition
+        this.name = `ActionError(${definition.type})`;
+        this.cause = cause;
+        if (cause instanceof Error && cause.stack) {
+            this.stack += `\n\n${cause.stack
+                .split('\n')
+                .map((line) => `  ${line}`)
+                .join('\n')}`;
+        }
+    }
+}
 //# sourceMappingURL=action.js.map

package/index.d.ts

@@ -159,6 +159,10 @@ export interface UserInfo {
      * The properties of the currently logged in member of the app
      */
     appMember?: AppMember;
+    /**
+     * Returns `true` if the user has no Oauth connections and no password.
+     */
+    hasNoLoginMethods?: boolean;
 }
 /**
  * The payload stored in our JSON web tokens
@@ -776,7 +780,7 @@ export interface BaseActionDefinition<T extends Action['type']> {
      */
     remapBefore?: Remapper;
     /**
-     * The remapper used to transfrom the output before passing it to the next action.
+     * The remapper used to transform the output before passing it to the next action.
      */
     remapAfter?: Remapper;
     /**
@@ -1493,7 +1497,7 @@ export interface AppDefinition {
         /**
          * The navigation type to use.
          *
-         * If this is omitted, a collapsable side navigation menu will be rendered on the left.
+         * If this is omitted, a collapsible side navigation menu will be rendered on the left.
          *
          * @default 'left-menu'
          */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.25.2",
+  "version": "0.26.0",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",