@appsemble/types 0.21.2 → 0.22.0

package/README.md

@@ -1,9 +1,9 @@
-# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.21.2/config/assets/logo.svg) Appsemble Types
+# ![](https://gitlab.com/appsemble/appsemble/-/raw/0.22.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.21.2/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.21.2)
+[![GitLab CI](https://gitlab.com/appsemble/appsemble/badges/0.22.0/pipeline.svg)](https://gitlab.com/appsemble/appsemble/-/releases/0.22.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.21.2/LICENSE.md) ©
+[LGPL-3.0-only](https://gitlab.com/appsemble/appsemble/-/blob/0.22.0/LICENSE.md) ©
 [Appsemble](https://appsemble.com)

package/action.d.ts

@@ -43,5 +43,5 @@ export type ResourcePatchAction = RequestLikeAction<'resource.patch'>;
 /**
  * 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<'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.login'> | BaseAction<'user.register'> | BaseAction<'user.update'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourcePatchAction | ResourceQueryAction | ResourceUpdateAction;
+export type Action = BaseAction<'analytics'> | BaseAction<'condition'> | 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.login'> | BaseAction<'user.logout'> | BaseAction<'user.register'> | BaseAction<'user.update'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceGetAction | ResourcePatchAction | ResourceQueryAction | ResourceUpdateAction;
 export {};

package/cli.d.ts

@@ -0,0 +1,47 @@
+import { type AppVisibility } from './app.js';
+export interface AppsembleContext {
+    /**
+     * If `remote` is specified, this will override `--remote` passed by the command line.
+     */
+    remote?: string;
+    /**
+     * If `organization` is specified, this will override `--organization` passed by the command line
+     * when creating apps.
+     */
+    organization?: string;
+    icon?: string;
+    iconBackground?: string;
+    maskableIcon?: string;
+    /**
+     * If `id` is specified, this will override `--id` passed by the command line when
+     * updating an app.
+     */
+    id?: number;
+    /**
+     * The Google Analytics ID that should be used for the app.
+     */
+    googleAnalyticsId?: string;
+    /**
+     * The custom Sentry DSN for the app.
+     */
+    sentryDsn?: string;
+    /**
+     * The environment for the custom Sentry DSN for the app.
+     */
+    sentryEnvironment?: string;
+    /**
+     * If `visibility` is specified, this will override `--visibility` passed on the command line.
+     */
+    visibility?: AppVisibility;
+    /**
+     * If `template` is specified, this will override `--template` passed on the command line.
+     */
+    template?: boolean;
+}
+export interface AppsembleRC {
+    /**
+     * The background color to use for maskable icons.
+     */
+    iconBackground?: string;
+    context?: Record<string, AppsembleContext>;
+}

package/cli.js

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

package/index.d.ts

@@ -15,6 +15,7 @@ export * from './authentication.js';
 export * from './author.js';
 export * from './bulma.js';
 export * from './http.js';
+export * from './cli.js';
 export * from './snapshot.js';
 export * from './resource.js';
 export * from './saml.js';
@@ -23,6 +24,7 @@ export * from './team.js';
 export * from './template.js';
 export * from './theme.js';
 export * from './user.js';
+export * from './quota.js';
 /**
  * A representation of a generated OAuth2 authorization code response.
  */
@@ -139,6 +141,10 @@ export interface UserInfo {
      * The end-user’s time zone.
      */
     zoneinfo?: string;
+    /**
+     * The end-user's additional properties
+     */
+    properties?: Record<string, string>;
 }
 /**
  * The payload stored in our JSON web tokens
@@ -255,9 +261,13 @@ export interface Remappers {
      */
     'date.add': string;
     /**
-     * Format a date to an iso8601 / rfc3339 compatible string.
+     * Formats a date to an iso8601 / rfc3339 compatible string.
+     *
+     * An argument can also be specified to use a different output format.
+     *
+     * Please refer to https://date-fns.org/docs/format for the supported patterns.
      */
-    'date.format': null;
+    'date.format'?: string;
     /**
      * Compare all computed remapper values against each other.
      *
@@ -1115,6 +1125,7 @@ export type ResourceQueryActionDefinition = ResourceActionDefinition<'resource.q
 export type ResourceCountActionDefinition = ResourceActionDefinition<'resource.count'>;
 export type ResourceUpdateActionDefinition = ResourceActionDefinition<'resource.update'>;
 export type ResourcePatchActionDefinition = ResourceActionDefinition<'resource.patch'>;
+export type UserLogoutAction = BaseActionDefinition<'user.logout'>;
 export interface BaseResourceSubscribeActionDefinition<T extends Action['type']> extends BaseActionDefinition<T> {
     /**
      * The name of the resource.
@@ -1179,7 +1190,7 @@ export type MessageActionDefinition = BaseActionDefinition<'message'> & BaseMess
      */
     body: Remapper;
 };
-export type ActionDefinition = AnalyticsAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'team.join'> | BaseActionDefinition<'team.list'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | DialogActionDefinition | DownloadActionDefinition | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MatchActionDefinition | MessageActionDefinition | NotifyActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourcePatchActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageAppendActionDefinition | StorageDeleteActionDefinition | StorageReadActionDefinition | StorageSubtractActionDefinition | StorageUpdateActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | TeamMembersActionDefinition | UserLoginAction | UserRegisterAction | UserUpdateAction;
+export type ActionDefinition = AnalyticsAction | BaseActionDefinition<'dialog.error'> | BaseActionDefinition<'dialog.ok'> | BaseActionDefinition<'flow.back'> | BaseActionDefinition<'flow.cancel'> | BaseActionDefinition<'flow.finish'> | BaseActionDefinition<'flow.next'> | BaseActionDefinition<'link.back'> | BaseActionDefinition<'link.next'> | BaseActionDefinition<'noop'> | BaseActionDefinition<'team.join'> | BaseActionDefinition<'team.list'> | BaseActionDefinition<'throw'> | ConditionActionDefinition | DialogActionDefinition | DownloadActionDefinition | EachActionDefinition | EmailActionDefinition | EventActionDefinition | FlowToActionDefinition | LinkActionDefinition | LogActionDefinition | MatchActionDefinition | MessageActionDefinition | NotifyActionDefinition | RequestActionDefinition | ResourceCountActionDefinition | ResourceCreateActionDefinition | ResourceDeleteActionDefinition | ResourceGetActionDefinition | ResourcePatchActionDefinition | ResourceQueryActionDefinition | ResourceSubscriptionStatusActionDefinition | ResourceSubscriptionSubscribeActionDefinition | ResourceSubscriptionToggleActionDefinition | ResourceSubscriptionUnsubscribeActionDefinition | ResourceUpdateActionDefinition | ShareActionDefinition | StaticActionDefinition | StorageAppendActionDefinition | StorageDeleteActionDefinition | StorageReadActionDefinition | StorageSubtractActionDefinition | StorageUpdateActionDefinition | StorageWriteActionDefinition | TeamInviteActionDefinition | TeamMembersActionDefinition | UserLoginAction | UserLogoutAction | UserRegisterAction | UserUpdateAction;
 export interface ActionType {
     /**
      * Whether or not app creators are required to define this action.

package/index.js

@@ -6,6 +6,7 @@ export * from './authentication.js';
 export * from './author.js';
 export * from './bulma.js';
 export * from './http.js';
+export * from './cli.js';
 export * from './snapshot.js';
 export * from './resource.js';
 export * from './saml.js';
@@ -14,4 +15,5 @@ export * from './team.js';
 export * from './template.js';
 export * from './theme.js';
 export * from './user.js';
+export * from './quota.js';
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.21.2",
+  "version": "0.22.0",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -22,6 +22,12 @@
   "author": "Appsemble <info@appsemble.com> (https://appsemble.com)",
   "sideEffects": false,
   "type": "module",
+  "exports": {
+    ".": [
+      "./index.js",
+      "./index.ts"
+    ]
+  },
   "files": [
     "**/*.d.ts",
     "**/*.js",

package/quota.d.ts

@@ -0,0 +1,14 @@
+export interface Quota {
+    /**
+     * The used quota so far.
+     */
+    used: number;
+    /**
+     * The quota usage limit.
+     */
+    limit: number;
+    /**
+     * The quota reset date in ISO 8601 format.
+     */
+    reset: string;
+}

package/quota.js

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

package/vitest.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vitest/dist/config.js").UserProjectConfigExport;
-export default _default;