@enonic-types/core 7.11.0-B2

package/README.md

@@ -0,0 +1,58 @@
+# Enonic XP Core TS types
+
+> TypeScript definitions that are shared between libraries and represent core 
+> data structures.
+
+## Install
+
+```bash
+npm i --save-dev @enonic-types/core
+```
+
+## Use
+
+> It is not necessary to include this dependency into your project, as all
+> libraries export related core types, e.g. Content library exports `Content`
+> type.
+
+All core types can be imported using ES6-style import:
+
+```ts
+import type {Content} from '@enonic-types/core';
+```
+
+### Content
+
+`Content` contains the `x` property, that has a very special `XpXData` type.
+
+`XpXData` 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:
+
+```ts
+declare global {
+    interface XpXData {
+        'com-mysite-app': {
+            metadata: {
+                metaTagTitle: string;
+                metaTagImageId: string;
+            }
+        }
+    }
+}
+```
+
+### Additional types
+
+`Content` is a complex type that contains unions and maps, that are not exported, but may be needed during the development. Actually, these types can easily be retrieved from the `Content` itself:
+
+```ts
+import type {Content} from '@enonic-types/core';
+
+type Attachments = Content['attachments'];
+
+type ContentInheritType = Content['inherit'];
+
+type Workflow = Content['workflow'];
+```

package/index.d.ts

@@ -0,0 +1,110 @@
+declare global {
+    interface XpXData {
+        [key: string]: Record<string, Record<string, unknown>>;
+    }
+}
+
+export type UserKey = `user:${string}:${string}`;
+export type GroupKey = `group:${string}:${string}`;
+export type RoleKey = `role:${string}`;
+
+export type PrincipalKey = UserKey | GroupKey | RoleKey;
+
+export interface User {
+    type: 'user';
+    key: UserKey;
+    displayName: string;
+    modifiedTime: string;
+    disabled?: boolean;
+    email?: string;
+    login?: string;
+    idProvider: string;
+}
+
+export interface Group {
+    type: 'group';
+    key: GroupKey;
+    displayName: string;
+    modifiedTime: string;
+    description?: string;
+}
+
+export interface Role {
+    type: 'role';
+    key: RoleKey;
+    displayName: string;
+    modifiedTime: string;
+    description?: string;
+}
+
+export type Principal = User | Group | Role;
+
+export interface Attachment {
+    name: string;
+    label?: string;
+    size: number;
+    mimeType: string;
+}
+
+export interface PublishInfo {
+    from?: string;
+    to?: string;
+    first?: string;
+}
+
+export interface Component<Config extends object = object, Regions extends Record<string, Region> = Record<string, Region>> {
+    config: Config;
+    descriptor: string;
+    path: string;
+    type: 'page' | 'layout' | 'part';
+    regions: Regions;
+}
+
+export interface Region<Config extends object = object> {
+    name: string;
+    components: Component<Config>[];
+}
+
+export interface Content<
+    Data = Record<string, unknown>,
+    Type extends string = string,
+    Page extends Component = Component,
+    > {
+    _id: string;
+    _name: string;
+    _path: string;
+    _score: number;
+    creator: UserKey;
+    modifier: UserKey;
+    createdTime: string;
+    modifiedTime: string;
+    owner: string;
+    data: Data;
+    type: Type;
+    displayName: string;
+    hasChildren: boolean;
+    language: string;
+    valid: boolean;
+    originProject: string;
+    childOrder?: string;
+    _sort?: object[];
+    page: Page;
+    x: XpXData;
+    attachments: Record<string, Attachment>;
+    publish?: PublishInfo;
+    workflow?: {
+        state: 'IN_PROGRESS' | 'PENDING_APPROVAL' | 'REJECTED' | 'READY';
+        checks?: Record<string, 'PENDING' | 'REJECTED' | 'APPROVED'>;
+    };
+    inherit?: ('CONTENT' | 'PARENT' | 'NAME' | 'SORT')[];
+}
+
+export interface Resource {
+    getSize(): number;
+
+    getTimestamp(): number;
+
+    getStream(): object;
+
+    exists(): boolean;
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@enonic-types/core",
+    "version": "7.11.0-B2",
+    "description": "Shared type definition for core libraries.",
+    "types": "index.d.ts",
+    "files": [
+        "index.d.ts"
+    ],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/enonic/xp.git#master"
+    },
+    "keywords": [
+        "enonic",
+        "enonic-xp",
+        "core",
+        "shared",
+        "types",
+        "typescript"
+    ],
+    "contributors": [
+        "Mikita Taukachou <edloidas@gmail.com> (https://edloidas.github.io/)"
+    ],
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/enonic/xp/issues"
+    },
+    "homepage": "https://github.com/enonic/xp/tree/master#readme",
+    "dependencies": {},
+    "publishConfig": {
+        "access": "public"
+    }
+}