enonic-types - npm Package Compare versions

Comparing version 0.0.21 to 0.0.22

lib/content.d.ts

 import { Component } from "./portal";
 export interface ContentLibrary {
-    get<A>(params: GetContentParams): Content<A, never> | null;
-    query<A>(params: QueryContentParams): QueryResponse<A>;
-    create<A>(params: CreateContentParams<A>): Content<A>;
-    modify<A>(params: ModifyContentParams<A>): Content<A>;
+    get<A extends object, PageConfig extends object = never>(params: GetContentParams): Content<A, PageConfig> | null;
+    query<A extends object>(params: QueryContentParams): QueryResponse<A>;
+    create<A extends object>(params: CreateContentParams<A>): Content<A>;
+    modify<A extends object>(params: ModifyContentParams<A>): Content<A>;
     delete(params: DeleteContentParams): boolean;
     publish(params: PublishContentParams): PublishResponse;
     unpublish(params: UnpublishContentParams): ReadonlyArray<string>;
-    getChildren<A>(params: GetChildrenParams): QueryResponse<A>;
-    move<A>(params: MoveParams): Content<A>;
-    getSite<A, PageConfig = never>(params: GetSiteParams): Site<A, PageConfig>;
-    getSiteConfig<A>(params: GetSiteConfigParams): A;
-    createMedia<A>(params: CreateMediaParams): Content<A>;
+    getChildren<A extends object>(params: GetChildrenParams): QueryResponse<A>;
+    move<A extends object>(params: MoveParams): Content<A>;
+    getSite<A extends object, PageConfig extends object = never>(params: GetSiteParams): Site<A, PageConfig>;
+    getSiteConfig<A extends object>(params: GetSiteConfigParams): A;
+    createMedia<A extends object>(params: CreateMediaParams): Content<A>;
     getAttachments(key: string): Attachments | null;
@@ -23,3 +23,3 @@ getAttachmentStream(params: AttachmentStreamParams): ByteSource | null;
 }
-export interface Content<A, PageConfig = never> {
+export interface Content<A extends object = object, PageConfig extends object = object> {
     readonly _id: string;
@@ -83,10 +83,88 @@ readonly _name: string;
     readonly sort?: string;
-    readonly aggregations?: string;
+    readonly aggregations?: Aggregations;
     readonly contentTypes?: ReadonlyArray<string>;
+    readonly highlight?: Highlight;
 }
-export interface QueryResponse<A> {
-    readonly aggregations: object;
+export interface Aggregations {
+    [name: string]: {
+        terms?: {
+            field: string;
+            order: string;
+            size: number;
+        };
+        stats?: {
+            field: string;
+            order: string;
+            size: number;
+        };
+        range?: {
+            field: string;
+            ranges?: Array<{
+                from?: number;
+                to?: number;
+            }>;
+            range?: {
+                from: number;
+                to: number;
+            };
+        };
+        geoDistance?: {
+            field: string;
+            ranges?: Array<{
+                from?: number;
+                to?: number;
+            }>;
+            range?: {
+                from: number;
+                to: number;
+            };
+            unit: string;
+            origin: {
+                lat: string;
+                lon: string;
+            };
+        };
+        dateRange?: {
+            field: string;
+            format: string;
+            ranges?: Array<{
+                from?: string;
+                to?: string;
+            }>;
+            range?: {
+                from: string;
+                to: string;
+            };
+        };
+        aggregations: Aggregations;
+    };
+}
+export interface Highlight {
+    encoder?: 'default' | 'html';
+    fragmenter?: 'simple' | 'span';
+    fragmentSize?: number;
+    numberOfFragments?: number;
+    noMatchSize?: number;
+    order?: 'score' | 'none';
+    preTag?: string;
+    postTag?: string;
+    requireFieldMatch?: boolean;
+    tagsSchema?: string;
+    properties: Record<string, Highlight>;
+}
+export interface QueryResponse<A extends object> {
     readonly count: number;
     readonly hits: ReadonlyArray<Content<A>>;
     readonly total: number;
+    readonly aggregations: {
+        [name: string]: {
+            buckets: Array<{
+                docCount: number;
+                key: string;
+                from?: number | string;
+                to?: number | string;
+                [key2: string]: any;
+            }>;
+        };
+    };
 }
@@ -111,3 +189,3 @@ export interface GetContentParams {
 }
-export interface ModifyContentParams<A> {
+export interface ModifyContentParams<A extends object> {
     readonly key: string;
@@ -151,3 +229,3 @@ readonly editor: (c: Content<A>) => Content<A>;
 }
-export interface Site<A, PageConfig = never> {
+export interface Site<A extends object, PageConfig extends object = never> {
     readonly _id: string;
@@ -154,0 +232,0 @@ readonly _name: string;

lib/portal.d.ts

@@ -15,3 +15,3 @@ import { ByteSource, Content, Site } from "./content";
     getComponent<A>(): Component<A> | null;
-    getContent<A, PageConfig = never>(): Content<A, PageConfig> | null;
+    getContent<A extends object, PageConfig extends object = never>(): Content<A, PageConfig> | null;
     getIdProviderKey(): string | null;
@@ -34,3 +34,3 @@ /**
     getMultipartText(name: string, index: number): string | null;
-    getSite<A>(): Site<A>;
+    getSite<A extends object>(): Site<A>;
     getSiteConfig<A>(): A;
@@ -37,0 +37,0 @@ idProviderUrl(params: IdProviderUrlParams): string;

package.json

 {
   "name": "enonic-types",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "TypeScript types for Enonic XP",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

No alert changes

Improved metrics

Total package byte prevSize

37361

increased by6.38%

Lines of code

1041

increased by8.1%

No dependency changes