@appsemble/types 0.33.5 → 0.33.9

package/index.js

@@ -1,22 +1,22 @@
-export * from './action.js';
 export * from './app.js';
 export * from './asset.js';
 export * from './authentication.js';
 export * from './author.js';
 export * from './bulma.js';
 export * from './appCollection.js';
-export * from './http.js';
 export * from './cli.js';
 export * from './snapshot.js';
 export * from './resource.js';
 export * from './saml.js';
 export * from './ssl.js';
 export * from './template.js';
-export * from './theme.js';
 export * from './oauth2.js';
 export * from './training.js';
 export * from './quota.js';
 export * from './permissions.js';
 export * from './roles.js';
+const assertAppMemberInfoIsBaseUserInfo = true;
+// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+assertAppMemberInfoIsBaseUserInfo;
 export const resourceSubscribableAction = ['create', 'update', 'delete'];
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.33.5",
+  "version": "0.33.9",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",
@@ -40,6 +40,7 @@
     "test": "vitest"
   },
   "dependencies": {
+    "@appsemble/lang-sdk": "0.33.9",
     "@fortawesome/fontawesome-common-types": "^6.0.0",
     "jsonschema": "~1.4.1",
     "openapi-types": "^12.0.0",

package/permissions.d.ts

@@ -1,108 +1,4 @@
-/**
- * A permission an app member may have within an app because of their given role.
- */
-export declare enum AppPermission {
-    /**
-     * The permission to create app invites.
-     */
-    CreateAppInvites = "$member:invite",
-    /**
-     * The permission to query app members.
-     */
-    QueryAppMembers = "$member:query",
-    /**
-     * The permission to query app members.
-     */
-    DeleteAppMembers = "$member:delete",
-    /**
-     * The permission to update the role of app members.
-     */
-    UpdateAppMemberRoles = "$member:role:update",
-    /**
-     * The permission to patch the properties of app members.
-     */
-    PatchAppMemberProperties = "$member:properties:patch",
-    /**
-     * The permission to query app groups.
-     */
-    QueryGroups = "$group:query",
-    /**
-     * The permission to create app groups.
-     */
-    CreateGroups = "$group:create",
-    /**
-     * The permission to update app groups.
-     */
-    UpdateGroups = "$group:update",
-    /**
-     * The permission to create app groups.
-     */
-    DeleteGroups = "$group:delete",
-    /**
-     * The permission to create group invites.
-     */
-    CreateGroupInvites = "$group:member:invite",
-    /**
-     * The permission to query app members.
-     */
-    QueryGroupMembers = "$group:member:query",
-    /**
-     * The permission to delete group members.
-     */
-    RemoveGroupMembers = "$group:member:delete",
-    /**
-     * The permission to change the role of members in a group.
-     */
-    UpdateGroupMemberRoles = "$group:member:role:update",
-    /**
-     * The permission to create any app resources.
-     */
-    CreateResources = "$resource:all:create",
-    /**
-     * The permission to fetch history of a resource.
-     */
-    GetResourceHistory = "$resource:all:history:get",
-    /**
-     * The permission to query app resources.
-     */
-    QueryResources = "$resource:all:query",
-    /**
-     * The permission to get app resources.
-     */
-    GetResources = "$resource:all:get",
-    /**
-     * The permission to update app resources.
-     */
-    UpdateResources = "$resource:all:update",
-    /**
-     * The permission to patch app resources.
-     */
-    PatchResources = "$resource:all:patch",
-    /**
-     * The permission to delete app resources.
-     */
-    DeleteResources = "$resource:all:delete",
-    /**
-     * The permission to query own app resources.
-     */
-    QueryOwnResources = "$resource:all:own:query",
-    /**
-     * The permission to get own app resources.
-     */
-    GetOwnResources = "$resource:all:own:get",
-    /**
-     * The permission to update own app resources.
-     */
-    UpdateOwnResources = "$resource:all:own:update",
-    /**
-     * The permission to patch own app resources.
-     */
-    PatchOwnResources = "$resource:all:own:patch",
-    /**
-     * The permission to delete own app resources.
-     */
-    DeleteOwnResources = "$resource:all:own:delete"
-}
+import { AppPermission } from '@appsemble/lang-sdk';
 /**
  * A permission a user may have within the platform because of their given role.
  */

package/permissions.js

@@ -1,109 +1,4 @@
-/**
- * A permission an app member may have within an app because of their given role.
- */
-export var AppPermission;
-(function (AppPermission) {
-    /**
-     * The permission to create app invites.
-     */
-    AppPermission["CreateAppInvites"] = "$member:invite";
-    /**
-     * The permission to query app members.
-     */
-    AppPermission["QueryAppMembers"] = "$member:query";
-    /**
-     * The permission to query app members.
-     */
-    AppPermission["DeleteAppMembers"] = "$member:delete";
-    /**
-     * The permission to update the role of app members.
-     */
-    AppPermission["UpdateAppMemberRoles"] = "$member:role:update";
-    /**
-     * The permission to patch the properties of app members.
-     */
-    AppPermission["PatchAppMemberProperties"] = "$member:properties:patch";
-    /**
-     * The permission to query app groups.
-     */
-    AppPermission["QueryGroups"] = "$group:query";
-    /**
-     * The permission to create app groups.
-     */
-    AppPermission["CreateGroups"] = "$group:create";
-    /**
-     * The permission to update app groups.
-     */
-    AppPermission["UpdateGroups"] = "$group:update";
-    /**
-     * The permission to create app groups.
-     */
-    AppPermission["DeleteGroups"] = "$group:delete";
-    /**
-     * The permission to create group invites.
-     */
-    AppPermission["CreateGroupInvites"] = "$group:member:invite";
-    /**
-     * The permission to query app members.
-     */
-    AppPermission["QueryGroupMembers"] = "$group:member:query";
-    /**
-     * The permission to delete group members.
-     */
-    AppPermission["RemoveGroupMembers"] = "$group:member:delete";
-    /**
-     * The permission to change the role of members in a group.
-     */
-    AppPermission["UpdateGroupMemberRoles"] = "$group:member:role:update";
-    /**
-     * The permission to create any app resources.
-     */
-    AppPermission["CreateResources"] = "$resource:all:create";
-    /**
-     * The permission to fetch history of a resource.
-     */
-    AppPermission["GetResourceHistory"] = "$resource:all:history:get";
-    /**
-     * The permission to query app resources.
-     */
-    AppPermission["QueryResources"] = "$resource:all:query";
-    /**
-     * The permission to get app resources.
-     */
-    AppPermission["GetResources"] = "$resource:all:get";
-    /**
-     * The permission to update app resources.
-     */
-    AppPermission["UpdateResources"] = "$resource:all:update";
-    /**
-     * The permission to patch app resources.
-     */
-    AppPermission["PatchResources"] = "$resource:all:patch";
-    /**
-     * The permission to delete app resources.
-     */
-    AppPermission["DeleteResources"] = "$resource:all:delete";
-    /**
-     * The permission to query own app resources.
-     */
-    AppPermission["QueryOwnResources"] = "$resource:all:own:query";
-    /**
-     * The permission to get own app resources.
-     */
-    AppPermission["GetOwnResources"] = "$resource:all:own:get";
-    /**
-     * The permission to update own app resources.
-     */
-    AppPermission["UpdateOwnResources"] = "$resource:all:own:update";
-    /**
-     * The permission to patch own app resources.
-     */
-    AppPermission["PatchOwnResources"] = "$resource:all:own:patch";
-    /**
-     * The permission to delete own app resources.
-     */
-    AppPermission["DeleteOwnResources"] = "$resource:all:own:delete";
-})(AppPermission || (AppPermission = {}));
+import { AppPermission } from '@appsemble/lang-sdk';
 /**
  * A permission a user may have within the platform because of their given role.
  */

package/roles.d.ts

@@ -1,4 +1,4 @@
-import { AppPermission, OrganizationPermission } from './permissions.js';
+import { OrganizationPermission } from './permissions.js';
 export declare enum PredefinedOrganizationRole {
     Member = "Member",
     AppTranslator = "AppTranslator",
@@ -28,21 +28,3 @@ export declare const predefinedOrganizationRolePermissions: {
     Owner: OrganizationPermission[];
 };
 export declare const predefinedOrganizationRoles: PredefinedOrganizationRole[];
-export declare enum PredefinedAppRole {
-    Member = "Member",
-    MembersManager = "MembersManager",
-    GroupMembersManager = "GroupMembersManager",
-    GroupsManager = "GroupsManager",
-    ResourcesManager = "ResourcesManager",
-    Owner = "Owner"
-}
-export type AppRole = string;
-export declare const predefinedAppRolePermissions: {
-    Member: AppPermission[];
-    MembersManager: AppPermission[];
-    GroupMembersManager: AppPermission[];
-    GroupsManager: AppPermission[];
-    ResourcesManager: AppPermission[];
-    Owner: AppPermission[];
-};
-export declare const predefinedAppRoles: PredefinedAppRole[];

package/roles.js

@@ -1,4 +1,4 @@
-import { AppPermission, OrganizationPermission } from './permissions.js';
+import { OrganizationPermission } from './permissions.js';
 const OrganizationMemberPermissions = [
     OrganizationPermission.QueryApps,
     OrganizationPermission.QueryOrganizationMembers,
@@ -133,63 +133,4 @@ export const predefinedOrganizationRolePermissions = {
     [PredefinedOrganizationRole.Owner]: OrganizationOwnerPermissions,
 };
 export const predefinedOrganizationRoles = Object.values(PredefinedOrganizationRole);
-const AppMemberPermissions = [];
-const AppMembersManagerPermissions = [
-    ...AppMemberPermissions,
-    AppPermission.CreateAppInvites,
-    AppPermission.QueryAppMembers,
-    AppPermission.DeleteAppMembers,
-    AppPermission.UpdateAppMemberRoles,
-    AppPermission.PatchAppMemberProperties,
-];
-const AppGroupMembersManagerPermissions = [
-    ...AppMemberPermissions,
-    AppPermission.CreateGroupInvites,
-    AppPermission.QueryGroupMembers,
-    AppPermission.RemoveGroupMembers,
-    AppPermission.UpdateGroupMemberRoles,
-];
-const AppGroupsManagerPermissions = [
-    ...AppMemberPermissions,
-    ...AppGroupMembersManagerPermissions,
-    AppPermission.QueryGroups,
-    AppPermission.CreateGroups,
-    AppPermission.UpdateGroups,
-    AppPermission.DeleteGroups,
-];
-const AppResourcesManagerPermissions = [
-    ...AppMemberPermissions,
-    AppPermission.CreateResources,
-    AppPermission.QueryResources,
-    AppPermission.GetResourceHistory,
-    AppPermission.GetResources,
-    AppPermission.UpdateResources,
-    AppPermission.PatchResources,
-    AppPermission.DeleteResources,
-];
-const AppOwnerPermissions = [
-    ...AppMemberPermissions,
-    ...AppMembersManagerPermissions,
-    ...AppGroupMembersManagerPermissions,
-    ...AppGroupsManagerPermissions,
-    ...AppResourcesManagerPermissions,
-];
-export var PredefinedAppRole;
-(function (PredefinedAppRole) {
-    PredefinedAppRole["Member"] = "Member";
-    PredefinedAppRole["MembersManager"] = "MembersManager";
-    PredefinedAppRole["GroupMembersManager"] = "GroupMembersManager";
-    PredefinedAppRole["GroupsManager"] = "GroupsManager";
-    PredefinedAppRole["ResourcesManager"] = "ResourcesManager";
-    PredefinedAppRole["Owner"] = "Owner";
-})(PredefinedAppRole || (PredefinedAppRole = {}));
-export const predefinedAppRolePermissions = {
-    [PredefinedAppRole.Member]: AppMemberPermissions,
-    [PredefinedAppRole.MembersManager]: AppMembersManagerPermissions,
-    [PredefinedAppRole.GroupMembersManager]: AppGroupMembersManagerPermissions,
-    [PredefinedAppRole.GroupsManager]: AppGroupsManagerPermissions,
-    [PredefinedAppRole.ResourcesManager]: AppResourcesManagerPermissions,
-    [PredefinedAppRole.Owner]: AppOwnerPermissions,
-};
-export const predefinedAppRoles = Object.values(PredefinedAppRole);
 //# sourceMappingURL=roles.js.map

package/action.d.ts

@@ -1,88 +0,0 @@
-import { type HTTPMethods } from './http.js';
-import { type ActionDefinition, type Remapper } from './index.js';
-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 ResourceUpdatePositionsAction = RequestLikeAction<'resource.update.positions'>;
-export type ResourceDeleteAllAction = RequestLikeAction<'resource.delete.all'>;
-export type ResourceDeleteBulkAction = RequestLikeAction<'resource.delete.bulk'>;
-export type ResourceGetAction = RequestLikeAction<'resource.get'>;
-export type ResourceHistoryGetAction = RequestLikeAction<'resource.history.get'>;
-export type ResourceQueryAction = RequestLikeAction<'resource.query'>;
-export type ResourceCountAction = RequestLikeAction<'resource.count'>;
-export type ResourceUpdateAction = RequestLikeAction<'resource.update'>;
-export type ResourcePatchAction = RequestLikeAction<'resource.patch'>;
-/**
- * An action that can be called from within a block.
- */
-export type Action = BaseAction<'analytics'> | BaseAction<'app.member.current.patch'> | BaseAction<'app.member.delete'> | BaseAction<'app.member.invite'> | BaseAction<'app.member.login'> | BaseAction<'app.member.logout'> | BaseAction<'app.member.properties.patch'> | BaseAction<'app.member.query'> | BaseAction<'app.member.register'> | BaseAction<'app.member.role.update'> | BaseAction<'condition'> | BaseAction<'controller'> | BaseAction<'csv.parse'> | 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<'group.member.delete'> | BaseAction<'group.member.invite'> | BaseAction<'group.member.query'> | BaseAction<'group.member.role.update'> | BaseAction<'group.query'> | 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<'throw'> | LinkAction | LogAction | RequestAction | ResourceCountAction | ResourceCreateAction | ResourceDeleteAction | ResourceDeleteAllAction | ResourceDeleteBulkAction | ResourceGetAction | ResourceHistoryGetAction | ResourcePatchAction | ResourceQueryAction | ResourceUpdateAction | ResourceUpdatePositionsAction;
-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,30 +0,0 @@
-/**
- * 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/http.d.ts

@@ -1,4 +0,0 @@
-/**
- * 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/http.js

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

package/theme.d.ts

@@ -1,54 +0,0 @@
-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 successful 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/theme.js

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