@appsemble/lang-sdk 0.33.7

package/types/resource.d.ts

@@ -0,0 +1,145 @@
+import { type OpenAPIV3 } from 'openapi-types';
+import { type HTTPMethods } from './http.js';
+import { type Remapper } from './remapper.js';
+export type ResourceViewAction = 'get' | 'query';
+export type OwnResourceAction = ResourceViewAction | 'delete' | 'patch' | 'update';
+export type ResourceAction = ResourceViewAction | 'create' | 'delete' | 'history.get' | 'patch' | 'update.positions' | 'update';
+export interface ResourceDefinition {
+    /**
+     * A definition of how versioning should happen for instances of this resource.
+     */
+    history?: ResourceHistoryDefinition | boolean;
+    /**
+     * Whether to enable position column for the instances of this resource. This is used for keeping
+     * an ordered list to enable custom sorting of the data using drag and drop features.
+     */
+    positioning?: boolean;
+    /**
+     * Enforce Custom Ordering By the fields.
+     */
+    enforceOrderingGroupByFields?: string[];
+    /**
+     * The definition for the `resource.create` action.
+     */
+    create?: ResourceCall;
+    /**
+     * The definition for the `resource.delete` action.
+     */
+    delete?: ResourceCall;
+    /**
+     * The definition for the `resource.get` action.
+     */
+    get?: ResourceCall;
+    /**
+     * The definition for the `resource.query` action.
+     */
+    query?: ResourceCall;
+    /**
+     * The definition for the `resource.count` action.
+     */
+    count?: ResourceCall;
+    /**
+     * The definition for the `resource.update` action.
+     */
+    update?: ResourceCall;
+    /**
+     * The definition for the `resource.patch` action.
+     */
+    patch?: ResourceCall;
+    /**
+     * The property to use as the id.
+     *
+     * @default `id`
+     */
+    id?: string;
+    /**
+     * The JSON schema to validate resources against before sending it to the backend.
+     */
+    schema: OpenAPIV3.SchemaObject;
+    /**
+     * The URL to post the resource to.
+     *
+     * @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.
+     */
+    references?: Record<string, ResourceReference>;
+    /**
+     * A time string representing when a resource should expire.
+     *
+     * @example '1d 8h 30m'
+     */
+    expires?: string;
+    /**
+     * Whether the resource should be able to be transferred when cloning the app it belongs to.
+     */
+    clonable?: boolean;
+}
+export interface ResourceReferenceActionTrigger {
+    type: 'create' | 'delete' | 'update';
+    cascade?: 'delete' | 'update';
+}
+interface ResourceReferenceAction {
+    triggers: ResourceReferenceActionTrigger[];
+}
+export interface ResourceReference {
+    /**
+     * The name of the referenced resource.
+     */
+    resource: string;
+    create?: ResourceReferenceAction;
+    update?: ResourceReferenceAction;
+    delete?: ResourceReferenceAction;
+}
+export interface ResourceHistoryDefinition {
+    /**
+     * If set to `false`, edits are still tracked, but exactly what changed is lost.
+     */
+    data: boolean;
+}
+export interface ResourceView {
+    /**
+     * The remappers used to transform the output.
+     */
+    remap: Remapper;
+}
+export interface NotificationDefinition {
+    to?: string[];
+    subscribe?: 'all' | 'both' | 'single';
+    data?: {
+        title: string;
+        content: string;
+        link: string;
+    };
+}
+/**
+ * A collection of hooks that are triggered upon calling a resource actions.
+ */
+export interface ResourceHooks {
+    notification: NotificationDefinition;
+}
+export interface ResourceCall {
+    /**
+     * The HTTP method to use for making the HTTP request.
+     */
+    method?: HTTPMethods;
+    /**
+     * The URL to which to make the resource request.
+     */
+    url?: string;
+    /**
+     * The associated hooks with the resource action.
+     */
+    hooks?: ResourceHooks;
+    /**
+     * Query parameters to pass along with the request.
+     */
+    query?: Remapper;
+}
+export {};

package/types/resource.js

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

package/types/roles.d.ts

@@ -0,0 +1,20 @@
+import { AppPermission } from './permission.js';
+export declare enum PredefinedAppRole {
+    Member = "Member",
+    MembersManager = "MembersManager",
+    GroupMembersManager = "GroupMembersManager",
+    GroupsManager = "GroupsManager",
+    ResourcesManager = "ResourcesManager",
+    Owner = "Owner"
+}
+export type AppRole = string;
+export type ViewRole = AppRole | '$guest';
+export declare const predefinedAppRolePermissions: {
+    Member: AppPermission[];
+    MembersManager: AppPermission[];
+    GroupMembersManager: AppPermission[];
+    GroupsManager: AppPermission[];
+    ResourcesManager: AppPermission[];
+    Owner: AppPermission[];
+};
+export declare const predefinedAppRoles: PredefinedAppRole[];

package/types/roles.js

@@ -0,0 +1,61 @@
+import { AppPermission } from './permission.js';
+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/types/security.d.ts

@@ -0,0 +1,42 @@
+import { type AppPermission } from './permission.js';
+import { type OwnResourceAction, type ResourceAction, type ResourceViewAction } from './resource.js';
+import { type AppRole, type PredefinedAppRole } from './roles.js';
+export type CustomAppResourcePermission = `$resource:${string}:${ResourceAction}`;
+export type CustomAppOwnResourcePermission = `$resource:${string}:own:${OwnResourceAction}`;
+export type CustomAppResourceViewPermission = `$resource:${string}:${ResourceViewAction}:${string}`;
+export type CustomAppGuestPermission = AppPermission | CustomAppResourcePermission | CustomAppResourceViewPermission;
+export type CustomAppPermission = CustomAppGuestPermission | CustomAppOwnResourcePermission;
+export interface GuestDefinition {
+    permissions?: CustomAppPermission[];
+    inherits?: AppRole[];
+}
+export interface CronSecurityDefinition {
+    permissions?: CustomAppPermission[];
+    inherits?: AppRole[];
+}
+export interface RoleDefinition {
+    description?: string;
+    defaultPage?: string;
+    inherits?: AppRole[];
+    permissions?: CustomAppPermission[];
+}
+export type SecurityPolicy = 'everyone' | 'invite' | 'organization';
+export interface MinimalSecurity {
+    guest: GuestDefinition;
+    cron?: CronSecurityDefinition;
+    default?: {
+        role: AppRole;
+        policy?: SecurityPolicy;
+    };
+    roles?: Record<Exclude<string, PredefinedAppRole>, RoleDefinition>;
+}
+export interface StrictSecurity {
+    guest?: GuestDefinition;
+    cron?: CronSecurityDefinition;
+    default: {
+        role: AppRole;
+        policy?: SecurityPolicy;
+    };
+    roles: Record<string, RoleDefinition>;
+}
+export type Security = MinimalSecurity | StrictSecurity;

package/types/security.js

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

package/types/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 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/types/theme.js

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

package/validation.d.ts

@@ -0,0 +1,25 @@
+import { type ValidatorResult } from 'jsonschema';
+import { type Promisable } from 'type-fest';
+import { type IdentifiableBlock } from './blockUtils.js';
+import { type AppDefinition, type BlockManifest, type ProjectImplementations, type Remapper } from './types/index.js';
+/**
+ * Check whether or not the given link represents a link related to the Appsemble core.
+ *
+ * @param link The link to check
+ * @returns Whether or not the given link represents a link related to the Appsemble core.
+ */
+export declare function isAppLink(link: Remapper | string[] | string): boolean;
+export type BlockVersionsGetter = (blockMap: IdentifiableBlock[]) => Promisable<BlockManifest[]>;
+/**
+ * Validate an app definition.
+ *
+ * This check various conditions which can’t be validated using basic JSON schema validation.
+ *
+ * @param definition The app validation to check.
+ * @param getBlockVersions A function for getting block manifests from block versions.
+ * @param controllerImplementations App controller implementations of interfaces.
+ * @param validatorResult If specified, error messages will be applied to this existing validator
+ *   result.
+ * @returns A validator result which contains all app validation violations.
+ */
+export declare function validateAppDefinition(definition: AppDefinition, getBlockVersions: BlockVersionsGetter, controllerImplementations?: ProjectImplementations, validatorResult?: ValidatorResult): Promise<ValidatorResult>;