@enonic-types/core 8.0.0-A2 → 8.0.0-B1

package/index.d.ts

@@ -206,7 +206,7 @@ export type RequestBranch = 'draft' | 'master';
 export type RequestGetHeaderFunction = (headerName: string) => string | null;
 export type RequestMethod = 'GET' | 'POST' | ' HEAD' | 'OPTIONS' | ' PUT' | 'DELETE' | 'PATCH' | 'TRACE' | 'CONNECT';
 export type RequestMode = 'edit' | 'inline' | 'live' | 'preview' | 'admin';
-export type RequestParams = Record<string, string | string[]>;
+export type RequestParams = Record<string, string | string[] | undefined>;
 export type RequestScheme = 'http' | 'https';
 
 export type RequestCookies = Record<string, string | undefined>;
@@ -295,6 +295,7 @@ export interface RequestConstructorParams {
     url: string;
     validTicket?: boolean;
     webSocket: boolean;
+    locales: string[];
 }
 
 export interface RequestInterface
@@ -341,7 +342,7 @@ export interface PageContributions {
     bodyEnd?: string[];
 }
 
-export type ResponseBody = unknown[] | Record<string, unknown> | boolean | number | string | null | ByteSource;
+export type ResponseBody = unknown[] | object | boolean | number | string | null | ByteSource;
 
 export interface MappedResponse {
     applyFilters: boolean;
@@ -403,6 +404,18 @@ export interface WebSocketEvent<T> {
 
 type WebSocketEventHandler<T = Record<string, unknown>> = (event: WebSocketEvent<T>) => void;
 
+export type SseEventType = 'open' | 'close' | 'timeout' | 'error';
+
+export interface SseEvent<T = Record<string, unknown>> {
+    type: SseEventType;
+    clientId: string;
+    lastEventId?: string;
+    attributes?: T;
+    error?: string;
+}
+
+type SseEventHandler<T = Record<string, unknown>> = (event: SseEvent<T>) => void;
+
 export interface Controller<
     Request extends RequestInterface = DefaultRequest,
     Response extends ResponseInterface = DefaultResponse,
@@ -418,6 +431,7 @@ export interface Controller<
     put?: RequestHandler<Request, Response>;
     trace?: RequestHandler<Request, Response>;
     webSocketEvent?: WebSocketEventHandler;
+    sseEvent?: SseEventHandler;
 }
 
 export interface ErrorRequest<T extends RequestInterface = DefaultRequest> {
@@ -512,6 +526,8 @@ export type RoleKey = `role:${string}`;
 
 export type PrincipalKey = UserKey | GroupKey | RoleKey;
 
+export type PrincipalType = 'user' | 'group' | 'role';
+
 export interface User {
     type: 'user';
     key: UserKey;
@@ -559,19 +575,19 @@ export interface AttachmentValidationError
     attachment: string;
 }
 
-export interface ValidationError {
-    message: string;
-    i18n: string;
-    errorCode: ValidationErrorCode;
-    /* eslint-disable @typescript-eslint/no-explicit-any*/
-    args: any[];
-}
-
 export interface ValidationErrorCode {
     applicationKey: string;
     code: string;
 }
 
+export interface ValidationError {
+    message: string | null;
+    i18n: string | null;
+    errorCode: ValidationErrorCode;
+    /* eslint-disable @typescript-eslint/no-explicit-any*/
+    args?: any[];
+}
+
 export interface PublishInfo {
     from?: string;
     to?: string;
@@ -714,6 +730,7 @@ export interface Content<
     hasChildren: boolean;
     language?: string;
     valid: boolean;
+    validationErrors?: ValidationError[];
     originProject?: string;
     childOrder?: string;
     _sort?: object[];
@@ -1276,3 +1293,9 @@ export interface FormItemFormFragment {
 }
 
 export type FormItem = FormItemSet | FormItemLayout | FormItemOptionSet | FormItemInput | FormItemFormFragment;
+
+export type ConfigValue = string | number | boolean | ConfigObject | ConfigValue[];
+
+export interface ConfigObject {
+    [key: string]: ConfigValue
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@enonic-types/core",
-    "version": "8.0.0-A2",
+    "version": "8.0.0-B1",
     "description": "Shared type definition for core libraries.",
     "types": "index.d.ts",
     "files": [