@appsemble/sdk 0.23.5 → 0.23.7

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.5/config/assets/logo.svg) Appsemble SDK
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.23.7/config/assets/logo.svg) Appsemble SDK
 
 > Build your own blocks
 
 [![npm](https://img.shields.io/npm/v/@appsemble/sdk)](https://www.npmjs.com/package/@appsemble/sdk)
-[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.23.5/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.5)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.23.7/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.23.7)
 [![Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io)
 
 ## Table of Contents
@@ -153,5 +153,5 @@ declare module '@appsemble/sdk' {
 
 ## License
 
-[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.23.5/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.23.7/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/index.d.ts

@@ -144,6 +144,8 @@ export interface Utils {
      * @returns The result of the remapped data.
      */
     remap: (remapper: Remapper | undefined, data: unknown, context?: Record<string, unknown>) => unknown;
+}
+export interface BlockUtils extends Utils {
     /**
      * Show a bulma style message.
      */
@@ -204,20 +206,13 @@ export interface Events {
         [K in keyof EventListeners]: <T>(callback: (data: T, error?: string) => void) => boolean;
     };
 }
-/**
- * The parameters that get passed to the bootstrap function.
- */
-export interface BootstrapParams {
+export interface EventParams {
     /**
      * The actions that may be dispatched by the block.
      */
     actions: {
         [K in keyof Actions]: Action;
     };
-    /**
-     * The parameters as they are defined in the app definition.
-     */
-    parameters: Parameters;
     /**
      * Any kind of data that has been passed in by some context.
      */
@@ -226,6 +221,15 @@ export interface BootstrapParams {
      * Event related functions and constants.
      */
     events: Events;
+    /**
+     * Some utility functions provided by the Appsemble app framework.
+     */
+    utils: Utils;
+}
+/**
+ * The parameters that get passed to the bootstrap function.
+ */
+export interface BootstrapParams extends EventParams {
     /**
      * URL parameters of the current route.
      *
@@ -254,7 +258,11 @@ export interface BootstrapParams {
     /**
      * Some utility functions provided by the Appsemble app framework.
      */
-    utils: Utils;
+    utils: BlockUtils;
+    /**
+     * The parameters as they are defined in the app definition.
+     */
+    parameters: Parameters;
 }
 export type BootstrapFunction = (params: BootstrapParams) => Promisable<Element | void>;
 export interface AppsembleBootstrapEvent extends CustomEvent {
@@ -271,3 +279,17 @@ export interface AppsembleBootstrapEvent extends CustomEvent {
  *   If the function returns an element, it’s appended to the shadow root.
  */
 export declare function bootstrap(fn: BootstrapFunction): void;
+export type HandlerFunction = (...params: any[]) => Promisable<unknown>;
+export type ControllerFunction = (params: EventParams) => Promisable<Record<keyof Actions, HandlerFunction>>;
+export interface AppsembleControllerEvent extends CustomEvent {
+    detail: {
+        fn: ControllerFunction;
+        document: Document;
+    };
+}
+/**
+ * Register a controller function.
+ *
+ * @param fn The controller function to register
+ */
+export declare function controller(fn: ControllerFunction): void;

package/index.js

@@ -16,4 +16,20 @@ export function bootstrap(fn) {
         document.currentScript.dispatchEvent(event);
     }
 }
+/**
+ * Register a controller function.
+ *
+ * @param fn The controller function to register
+ */
+export function controller(fn) {
+    const event = new CustomEvent('AppsembleController', {
+        detail: {
+            fn,
+            document,
+        },
+    });
+    if (document.currentScript) {
+        document.currentScript.dispatchEvent(event);
+    }
+}
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/sdk",
-  "version": "0.23.5",
+  "version": "0.23.7",
   "description": "Build your own blocks",
   "keywords": [
     "app",
@@ -41,7 +41,7 @@
     "test": "vitest"
   },
   "dependencies": {
-    "@appsemble/types": "0.23.5",
+    "@appsemble/types": "0.23.7",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "type-fest": "^4.0.0"
   },