@appsemble/types 0.20.7 → 0.20.10

package/dist/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/dist/action.js

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

package/dist/action.js.map

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

package/dist/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/dist/bulma.js

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

package/dist/bulma.js.map

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

package/dist/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/dist/http.js

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

package/dist/http.js.map

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

package/dist/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.
  */
@@ -309,6 +315,20 @@ export interface Remappers {
      * Assign properties to an existing object given some predefined mapper keys.
      */
     'object.assign': Record<string, Remapper>;
+    /**
+     * Remove properties from an existing object based on the given the object keys.
+     *
+     * Nested properties can be removed using arrays of keys.
+     *
+     * @example
+     * ```yaml
+     * object.omit:
+     *   - foo   # Removes the property foo
+     *   - - bar # Removes the property baz inside of bar
+     *     - baz
+     * ```
+     */
+    'object.omit': (string[] | string)[];
     /**
      * Use a static value.
      */
@@ -331,6 +351,27 @@ export interface Remappers {
      * If the input is not an array, the input is returned as-is.
      */
     'random.choice': null;
+    /**
+     * Pick and return a random entry from an array.
+     *
+     * If the input is not an array, the input is returned as-is.
+     */
+    'random.integer': [number, number];
+    /**
+     * Pick and return a random entry from an array.
+     *
+     * If the input is not an array, the input is returned as-is.
+     */
+    'random.float': [number, number];
+    /**
+     * Pick and return a random entry from an array.
+     *
+     * If the input is not an array, the input is returned as-is.
+     */
+    'random.string': {
+        choice: string;
+        length: number;
+    };
     /**
      * Get the input data as it was initially passed to the remap function.
      */
@@ -452,6 +493,16 @@ export interface ResourceHistoryDefinition {
      */
     data: boolean;
 }
+export interface ResourceView {
+    /**
+     * The roles required to use this view.
+     */
+    roles: string[];
+    /**
+     * The remappers used to transform the output.
+     */
+    remap: Remapper;
+}
 export interface ResourceDefinition {
     /**
      * The default list of roles used for permission checks for each action.
@@ -501,6 +552,10 @@ export interface ResourceDefinition {
      * @default autogenerated for use with the Appsemble resource API.
      */
     url?: string;
+    /**
+     * The alternate views of this resource.
+     */
+    views?: Record<string, ResourceView>;
     /**
      * The references this resources has to other resources.
      */
@@ -520,8 +575,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.
      */
@@ -796,11 +862,17 @@ interface ResourceActionDefinition<T extends Action['type']> extends RequestLike
      */
     resource: string;
 }
+interface ViewResourceDefinition {
+    /**
+     * The view to use for the request.
+     */
+    view?: string;
+}
 export declare type RequestActionDefinition = RequestLikeActionDefinition<'request'>;
 export declare type ResourceCreateActionDefinition = ResourceActionDefinition<'resource.create'>;
 export declare type ResourceDeleteActionDefinition = ResourceActionDefinition<'resource.delete'>;
-export declare type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'>;
-export declare type ResourceQueryActionDefinition = ResourceActionDefinition<'resource.query'>;
+export declare type ResourceGetActionDefinition = ResourceActionDefinition<'resource.get'> & ViewResourceDefinition;
+export declare type ResourceQueryActionDefinition = ResourceActionDefinition<'resource.query'> & ViewResourceDefinition;
 export declare type ResourceCountActionDefinition = ResourceActionDefinition<'resource.count'>;
 export declare type ResourceUpdateActionDefinition = ResourceActionDefinition<'resource.update'>;
 export interface BaseResourceSubscribeActionDefinition<T extends Action['type']> extends BaseActionDefinition<T> {
@@ -835,6 +907,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.
@@ -919,6 +1011,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

@@ -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/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,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,QAAQ,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/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"}

package/dist/theme.d.ts

@@ -0,0 +1,54 @@
+export interface FontDefinition {
+    /**
+     * Where to load a font from.
+     */
+    source?: 'custom' | 'google';
+    /**
+     * The name of the font family.
+     *
+     * This will be referenced in the Bulma CSS.
+     */
+    family: string;
+}
+export interface Theme {
+    /**
+     * The color primarily featured in the color scheme.
+     */
+    primaryColor: string;
+    /**
+     * The color used for links.
+     */
+    linkColor: string;
+    /**
+     * The color used to feature succesful or positive actions.
+     */
+    successColor: string;
+    /**
+     * The color used to indicate information.
+     */
+    infoColor: string;
+    /**
+     * The color used for elements that require extra attention.
+     */
+    warningColor: string;
+    /**
+     * The color used for elements that demand caution for destructive actions.
+     */
+    dangerColor: string;
+    /**
+     * The color used in the foreground of the splash screen.
+     */
+    themeColor: string;
+    /**
+     * The color used in the background of the splash screen.
+     */
+    splashColor: string;
+    /**
+     * The link to the tile layer used for Leaflet maps.
+     */
+    tileLayer: string;
+    /**
+     * The name of a font available on Google fonts.
+     */
+    font: FontDefinition;
+}

package/dist/theme.js

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

package/dist/theme.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.20.7",
+  "version": "0.20.10",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -30,10 +30,9 @@
     "test": "jest"
   },
   "dependencies": {
-    "@appsemble/sdk": "0.20.7",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "jsonschema": "^1.0.0",
-    "openapi-types": "^11.0.0",
+    "openapi-types": "^12.0.0",
     "type-fest": "^2.0.0"
   }
 }