@enonic-types/core 7.16.2 → 8.0.0-A3

package/README.md

@@ -23,16 +23,16 @@ import type {Content} from '@enonic-types/core';
 
 ### Content
 
-`Content` contains the `x` property, that has a very special `XpXData` type.
+`Content` contains the `x` property, that has a very special `XpMixin` type.
 
-`XpXData` is an interface, that is added to the global scope, so it can be
+`XpMixin` is an interface, that is added to the global scope, so it can be
 modified using the [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#merging-interfaces).
-This allows you to set the shape of the XData in your project, simply by
-declaring the `XpXData` like this:
+This allows you to set the shape of the Mixin in your project, simply by
+declaring the `XpMixin` like this:
 
 ```ts
 declare global {
-    interface XpXData {
+    interface XpMixin {
         'com-mysite-app': {
             metadata: {
                 metaTagTitle: string;

package/index.d.ts

@@ -1,24 +1,19 @@
 export type ComponentDescriptor = `${string}:${string}`;
 
 export interface NestedRecord {
-	[name: PropertyKey]: NestedRecord | unknown
+    [name: PropertyKey]: NestedRecord | unknown
 }
 
 declare global {
     interface XpBeans {}
-    interface XpLayoutMap {
-        [layoutDescriptor: ComponentDescriptor]: NestedRecord;
-    }
+
+    type XpLayoutMap = Record<ComponentDescriptor, NestedRecord>;
+
     interface XpLibraries {}
-    interface XpPageMap {
-        [pageDescriptor: ComponentDescriptor]: NestedRecord;
-    }
-    interface XpPartMap {
-        [partDescriptor: ComponentDescriptor]: NestedRecord;
-    }
-    interface XpXData {
-        [key: string]: Record<string, Record<string, unknown>>;
-    }
+
+    type XpPageMap = Record<ComponentDescriptor, NestedRecord>;
+    type XpPartMap = Record<ComponentDescriptor, NestedRecord>;
+    type XpMixin = Record<string, Record<string, Record<string, unknown>>>;
 }
 
 export interface App {
@@ -58,7 +53,7 @@ export interface DoubleUnderscore {
      * Converts JSON to a Java Map structure that can be used as parameters to a Java method on a bean created with newBean.
      * @param value Value to convert
      */
-    toScriptValue: <T = object>(value: T) => ScriptValue;
+    toScriptValue: <T = unknown>(value: T) => T extends null | undefined ? null : ScriptValue;
     /**
      * Add a disposer that is called when the app is stopped.
      * @param callback Function to call
@@ -69,8 +64,7 @@ export interface DoubleUnderscore {
      * If the JavaScript variable is defined, it is returned as is.
      * @param value Value to convert
      */
-    nullOrValue: <T = object>(value: T) => T | null | undefined;
-
+    nullOrValue: <T = unknown>(value: T) => T extends null | undefined ? null : T;
     /**
      * Doc registerMock.
      *
@@ -212,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>;
@@ -221,15 +215,40 @@ export type ResponseCookies = Record<string, string | ComplexCookie | undefined>
 export type RequestHeaders = Record<string, string | undefined>;
 export type ResponseHeaders = Record<string, string | number | (string | number)[] | undefined>;
 
-export interface DefaultRequestCookies extends RequestCookies {
+export interface DefaultRequestCookies
+    extends RequestCookies {
     JSESSIONID?: string;
 }
 
-export type SecFetchDest = 'audio' | 'audioworklet' | 'document' | 'embed' | 'empty' | 'fencedframe' | 'font' | 'frame' | 'iframe' | 'image' | 'manifest' | 'object' | 'paintworklet' | 'report' | 'script' | 'serviceworker' | 'sharedworker' | 'style' | 'track' | 'video' | 'webidentity' | 'worker' | 'xslt';
-export type SecFetchMode = 'cors'| 'navigate' | 'no-cors' | 'same-origin' | 'websocket';
+export type SecFetchDest =
+    'audio'
+    | 'audioworklet'
+    | 'document'
+    | 'embed'
+    | 'empty'
+    | 'fencedframe'
+    | 'font'
+    | 'frame'
+    | 'iframe'
+    | 'image'
+    | 'manifest'
+    | 'object'
+    | 'paintworklet'
+    | 'report'
+    | 'script'
+    | 'serviceworker'
+    | 'sharedworker'
+    | 'style'
+    | 'track'
+    | 'video'
+    | 'webidentity'
+    | 'worker'
+    | 'xslt';
+export type SecFetchMode = 'cors' | 'navigate' | 'no-cors' | 'same-origin' | 'websocket';
 export type SecFetchSite = 'cross-site' | 'same-origin' | 'same-site' | 'none';
 
-export interface DefaultRequestHeaders extends RequestHeaders {
+export interface DefaultRequestHeaders
+    extends RequestHeaders {
     Accept?: string;
     'Accept-Charset'?: string;
     'Accept-Encoding'?: string;
@@ -276,13 +295,16 @@ export interface RequestConstructorParams {
     url: string;
     validTicket?: boolean;
     webSocket: boolean;
+    locales: string[];
 }
 
-export interface RequestInterface extends RequestConstructorParams {
+export interface RequestInterface
+    extends RequestConstructorParams {
     getHeader: RequestGetHeaderFunction;
 }
 
-export interface DefaultRequest extends RequestInterface {
+export interface DefaultRequest
+    extends RequestInterface {
     cookies: DefaultRequestCookies;
     headers: DefaultRequestHeaders;
 }
@@ -298,7 +320,8 @@ export type SerializableRequest<T extends RequestInterface = DefaultRequest> = O
     body?: unknown[] | Record<string, unknown> | boolean | number | string | null;
 };
 
-export interface DefaultResponseHeaders extends ResponseHeaders {
+export interface DefaultResponseHeaders
+    extends ResponseHeaders {
     'Cache-Control'?: string;
     'Content-Encoding'?: string;
     'Content-Type'?: string;
@@ -313,13 +336,13 @@ export interface DefaultResponseHeaders extends ResponseHeaders {
 // So perhaps it's better to enforce that, so it's consistent both ways.
 // It also causes problems in ResponseProcessors, since they work with both from and to Java.
 export interface PageContributions {
-	headBegin?: string[];
-	headEnd?: string[];
-	bodyBegin?: string[];
-	bodyEnd?: string[];
+    headBegin?: string[];
+    headEnd?: string[];
+    bodyBegin?: string[];
+    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;
@@ -332,11 +355,13 @@ export interface MappedResponse {
     status: number;
 }
 
-export interface ResponseInterface extends Partial<MappedResponse> {
+export interface ResponseInterface
+    extends Partial<MappedResponse> {
     redirect?: string;
 }
 
-export interface DefaultResponse extends ResponseInterface {
+export interface DefaultResponse
+    extends ResponseInterface {
     contentType?: LiteralUnion<'text/html' | 'application/json'>;
     headers?: DefaultResponseHeaders;
 }
@@ -363,7 +388,7 @@ export interface WebSocketSession {
     id: string;
     params: Record<string, string | string[]>;
     path: string;
-    user: Omit<User,'type'>;
+    user: Omit<User, 'type'>;
 }
 
 export type WebSocketEventType = 'open' | 'message' | 'error' | 'close';
@@ -452,7 +477,8 @@ export interface ErrorController {
     handleError?: ErrorRequestHandler;
 }
 
-export interface IdProviderController extends Controller {
+export interface IdProviderController
+    extends Controller {
     autoLogin?: AutoLoginRequestHandler;
     handle401?: RequestHandler;
     login?: RequestHandler;
@@ -460,9 +486,9 @@ export interface IdProviderController extends Controller {
 }
 
 export interface HttpFilterController<
-  RequestFromJava extends RequestInterface = DefaultRequest,
-  ResponseFromNext extends ResponseInterface = Response,
-  ResponseToJava extends ResponseInterface = ResponseFromNext
+    RequestFromJava extends RequestInterface = DefaultRequest,
+    ResponseFromNext extends ResponseInterface = Response,
+    ResponseToJava extends ResponseInterface = ResponseFromNext
 > {
     filter: (
         request: RequestFromJava,
@@ -487,6 +513,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;
@@ -524,6 +552,29 @@ export interface Attachment {
     mimeType: string;
 }
 
+export interface DataValidationError
+    extends ValidationError {
+    propertyPath: string;
+}
+
+export interface AttachmentValidationError
+    extends ValidationError {
+    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 PublishInfo {
     from?: string;
     to?: string;
@@ -537,13 +588,12 @@ export interface FragmentComponent {
 }
 
 export interface LayoutComponent<
-    Descriptor extends ComponentDescriptor = ComponentDescriptor,
+    Descriptor extends LayoutDescriptor = LayoutDescriptor,
     Config extends NestedRecord = Descriptor extends LayoutDescriptor
-        ? XpLayoutMap[Descriptor]
-        : NestedRecord,
-    Regions extends
-        Record<string, Region<(FragmentComponent | PartComponent | TextComponent)[]>> =
-        Record<string, Region<(FragmentComponent | Part          | TextComponent)[]>>
+                                  ? XpLayoutMap[Descriptor]
+                                  : NestedRecord,
+    Regions extends Record<string, Region<(FragmentComponent | PartComponent | TextComponent)[]>> =
+        Record<string, Region<(FragmentComponent | Part | TextComponent)[]>>
 > {
     type: 'layout'
     descriptor: Descriptor
@@ -551,13 +601,15 @@ export interface LayoutComponent<
     path?: string // Missing in fragmentPreview https://github.com/enonic/xp/issues/10116
     regions: Regions;
 }
+
 type LayoutDescriptor = keyof XpLayoutMap;
+/* eslint-disable @typescript-eslint/no-explicit-any*/
 type Layout = LayoutDescriptor extends any // this lets us iterate over every member of the union
-    ? LayoutComponent<LayoutDescriptor, XpLayoutMap[LayoutDescriptor]>
-    : never;
+              ? LayoutComponent<LayoutDescriptor, XpLayoutMap[LayoutDescriptor]>
+              : never;
 
 export interface PartComponent<
-    Descriptor extends ComponentDescriptor = ComponentDescriptor,
+    Descriptor extends PartDescriptor = PartDescriptor,
     Config extends NestedRecord =
         Descriptor extends PartDescriptor
         ? XpPartMap[Descriptor]
@@ -568,22 +620,23 @@ export interface PartComponent<
     config: Config
     path?: string // Missing in fragmentPreview https://github.com/enonic/xp/issues/10116
 }
+
 type PartDescriptor = keyof XpPartMap;
+/* eslint-disable @typescript-eslint/no-explicit-any*/
 type Part = PartDescriptor extends any // this lets us iterate over every member of the union
-    ? PartComponent<PartDescriptor, XpPartMap[PartDescriptor]>
-    : never;
+            ? PartComponent<PartDescriptor, XpPartMap[PartDescriptor]>
+            : never;
 
 // NOTE: This reflect lib-portal.getContent where page templates are resolved.
 // WARNING: This does NOT reflect lib-content.getContent where page templates are NOT resolved!
 export interface PageComponent<
-    Descriptor extends ComponentDescriptor = ComponentDescriptor,
+    Descriptor extends PageDescriptor = PageDescriptor,
     Config extends NestedRecord =
         Descriptor extends PageDescriptor
         ? XpPageMap[Descriptor]
         : NestedRecord,
-    Regions extends
-        Record<string, Region<(FragmentComponent | LayoutComponent | PartComponent | TextComponent)[]>> =
-        Record<string, Region<(FragmentComponent | Layout          | Part          | TextComponent)[]>>
+    Regions extends Record<string, Region<(FragmentComponent | LayoutComponent | PartComponent | TextComponent)[]>> =
+        Record<string, Region<(FragmentComponent | Layout | Part | TextComponent)[]>>
 > {
     config: Config
     descriptor: Descriptor
@@ -594,9 +647,10 @@ export interface PageComponent<
 }
 
 type PageDescriptor = keyof XpPageMap;
+/* eslint-disable @typescript-eslint/no-explicit-any*/
 type Page = PageDescriptor extends any // this lets us iterate over every member of the union
-    ? PageComponent<PageDescriptor, XpPageMap[PageDescriptor]>
-    : never;
+            ? PageComponent<PageDescriptor, XpPageMap[PageDescriptor]>
+            : never;
 
 export interface TextComponent {
     type: 'text'
@@ -605,15 +659,15 @@ export interface TextComponent {
 }
 
 export type Component<
-    Descriptor extends ComponentDescriptor = LayoutDescriptor | PageDescriptor | PartDescriptor,
+    Descriptor extends ComponentDescriptor = ComponentDescriptor,
     Config extends NestedRecord = NestedRecord,
     Regions extends (
         Descriptor extends LayoutDescriptor
         ? Record<string, Region<(FragmentComponent | PartComponent | TextComponent)[]>>
         : Record<string, Region>
-    ) = Descriptor extends LayoutDescriptor
-        ? Record<string, Region<(FragmentComponent | PartComponent | TextComponent)[]>>
-        : Record<string, Region>,
+        ) = Descriptor extends LayoutDescriptor
+            ? Record<string, Region<(FragmentComponent | PartComponent | TextComponent)[]>>
+            : Record<string, Region>,
 > =
     | FragmentComponent
     | LayoutComponent<Descriptor, Config, Regions>
@@ -622,43 +676,32 @@ export type Component<
     | TextComponent;
 
 export interface PageRegion<
-    Components extends
-        (FragmentComponent | LayoutComponent | PartComponent | TextComponent)[] =
-        (FragmentComponent | Layout          | Part          | TextComponent)[]
+    Components extends (FragmentComponent | LayoutComponent | PartComponent | TextComponent)[] =
+        (FragmentComponent | Layout | Part | TextComponent)[]
 > {
     name: string;
     components: Components;
 }
 
 export interface LayoutRegion<
-    Components extends
-        (FragmentComponent | PartComponent | TextComponent)[] =
-        (FragmentComponent | Part          | TextComponent)[]
+    Components extends (FragmentComponent | PartComponent | TextComponent)[] =
+        (FragmentComponent | Part | TextComponent)[]
 > {
     name: string;
     components: Components;
 }
 
 export type Region<
-    Components extends
-        (FragmentComponent | LayoutComponent | PartComponent | TextComponent)[] =
-        (FragmentComponent | Layout          | Part          | TextComponent)[]
+    Components extends (FragmentComponent | LayoutComponent | PartComponent | TextComponent)[] =
+        (FragmentComponent | Layout | Part | TextComponent)[]
 // @ts-expect-error TODO LayoutRegion can't eat LayoutComponent nor Layout!!!
 > = PageRegion<Components> | LayoutRegion<Components>;
 
 export interface Content<
     Data = Record<string, unknown>,
     Type extends string = string,
-    _Component extends (
-        Type extends 'portal:fragment'
-            ? LayoutComponent | PartComponent
-            : PageComponent
-        ) = (
-            Type extends 'portal:fragment'
-                ? Layout | Part
-                : Page
-            ),
-    > {
+    _Component extends ContentComponentConstraint<Type> = ContentComponent<Type>
+> {
     _id: string;
     _name: string;
     _path: string;
@@ -668,7 +711,7 @@ export interface Content<
     createdTime: string;
     modifiedTime?: string;
     owner: string;
-    data: Type extends 'portal:fragment' ? Record<string,never> : Data;
+    data: Type extends 'portal:fragment' ? Record<string, never> : Data;
     type: Type;
     displayName: string;
     hasChildren: boolean;
@@ -678,7 +721,7 @@ export interface Content<
     childOrder?: string;
     _sort?: object[];
     page?: Type extends 'portal:fragment' ? never : _Component;
-    x: XpXData;
+    x: XpMixin;
     attachments: Record<string, Attachment>;
     publish?: PublishInfo;
     workflow?: Workflow;
@@ -687,19 +730,30 @@ export interface Content<
     fragment?: Type extends 'portal:fragment' ? _Component : never;
 }
 
-export type Workflow = {
-    state: 'IN_PROGRESS' | 'PENDING_APPROVAL' | 'REJECTED' | 'READY';
-    checks?: Record<string, 'PENDING' | 'REJECTED' | 'APPROVED'>;
-};
+export type WorkflowState = 'IN_PROGRESS' | 'PENDING_APPROVAL' | 'REJECTED' | 'READY';
+
+export interface Workflow {
+    state: WorkflowState;
+}
 
 export type ContentInheritValue = 'CONTENT' | 'PARENT' | 'NAME' | 'SORT';
 
+export type ContentComponentConstraint<Type extends string> =
+    Type extends 'portal:fragment'
+    ? LayoutComponent | PartComponent
+    : PageComponent;
+
+export type ContentComponent<Type extends string> =
+    Type extends 'portal:fragment'
+    ? Layout | Part
+    : Page;
+
 // Compliant with npm module ts-brand
 type Brand<
     Base,
     Branding
 > = Base & {
-  '__type__': Branding
+    '__type__': Branding
 };
 
 export type ByteSource = Brand<object, 'ByteSource'>;
@@ -719,10 +773,15 @@ export interface Resource {
 
 export interface ResourceKey {
     getApplicationKey(): string;
+
     getPath(): string;
+
     getUri(): string;
+
     isRoot(): boolean;
+
     getName(): string;
+
     getExtension(): string;
 }
 
@@ -860,6 +919,7 @@ export type DistanceUnit =
 export interface FieldSortDsl {
     field: string;
     direction?: SortDirection;
+    language?: string;
 }
 
 export interface GeoDistanceSortDsl
@@ -1067,9 +1127,7 @@ export interface Highlight {
     properties?: Record<string, Highlight>;
 }
 
-export interface HighlightResult {
-    [highlightedFieldName: string]: string[];
-}
+export type HighlightResult = Record<string, string[]>;
 
 export interface ExistsFilter {
     exists: {
@@ -1112,6 +1170,7 @@ export type Filter = ExistsFilter | NotExistsFilter | HasValueFilter | IdsFilter
 export type InputType =
     | 'Time'
     | 'DateTime'
+    | 'Instant'
     | 'CheckBox'
     | 'ComboBox'
     | 'Long'
@@ -1136,7 +1195,6 @@ export interface FormItemSet {
     formItemType: 'ItemSet';
     name: string;
     label: string;
-    customText: string;
     helpText: string;
     maximize: boolean;
     inputType: InputType;
@@ -1174,7 +1232,6 @@ export interface FormItemInput {
     formItemType: 'Input';
     name: string;
     label: string;
-    customText: string;
     helpText: string;
     validationRegexp: string;
     maximize: boolean;
@@ -1187,12 +1244,10 @@ export interface FormItemInput {
         value: string;
         type: ValueType;
     }
-    config: {
-        [configName: string]: {
-            [attributeKey: string]: string;
-            value: string;
-        }[]
-    }
+    config: Record<string, {
+        [attributeKey: string]: string;
+        value: string;
+    }[]>
 }
 
 export interface FormItemOptionSet {
@@ -1218,9 +1273,15 @@ export interface FormItemOptionSet {
     }[];
 }
 
-export interface FormItemInlineMixin {
-    formItemType: 'InlineMixin';
+export interface FormItemFormFragment {
+    formItemType: 'FormFragment';
     name: string;
 }
 
-export type FormItem = FormItemSet | FormItemLayout | FormItemOptionSet | FormItemInput | FormItemInlineMixin;
+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": "7.16.2",
+    "version": "8.0.0-A3",
     "description": "Shared type definition for core libraries.",
     "types": "index.d.ts",
     "files": [