@antelopejs/interface-database 0.0.2

package/dist/schema.d.ts

@@ -0,0 +1,102 @@
+import { RegisteringProxy } from "@antelopejs/interface-core";
+import { StagedObject } from "./common";
+import { Query } from "./query";
+import { Table } from "./selection";
+/**
+ * Secondary table index definition
+ */
+export interface IndexDefinition {
+    /**
+     * Fields to use for compound indexes
+     */
+    fields?: string[];
+    /**
+     * Whether or not this is a multi index
+     */
+    multi?: boolean;
+}
+export type FieldType = string | Array<FieldType> | {
+    [subfield: string]: FieldType;
+};
+/**
+ * Schema table definition
+ */
+export interface TableDefinition {
+    /**
+     * Field names and their data types
+     */
+    fields: Record<string, FieldType>;
+    /**
+     * List of secondary indexes
+     */
+    indexes: Record<string, IndexDefinition>;
+}
+/**
+ * Table names and their definitions
+ */
+export interface SchemaDefinition {
+    [tableName: string]: TableDefinition;
+}
+export interface SchemaOptions {
+    rowLevel?: boolean;
+}
+export declare const Schemas: RegisteringProxy<(name: string, def: SchemaDefinition, options: SchemaOptions) => void>;
+/**
+ * A schema determines the structure of a database
+ *
+ * Each schema can have multiple instances
+ *
+ * The internal organization of these instances is left up to the module implementation
+ */
+export declare class Schema<T = any> extends StagedObject {
+    readonly id: string;
+    readonly definition: SchemaDefinition;
+    readonly options: SchemaOptions;
+    private static readonly registry;
+    /**
+     * Retrieves a previously defined schema by its ID
+     *
+     * @param id Schema ID
+     * @returns The schema instance, or undefined if not found
+     */
+    static get(id: string): Schema | undefined;
+    /**
+     * Define a new schema with the given ID
+     *
+     * @param id ID of this schema, changing this will leave previous data inaccessible
+     * @param definition Schema definition (tables, fields, indexes..)
+     */
+    constructor(id: string, definition: SchemaDefinition, options?: SchemaOptions);
+    /**
+     * Gets a specific instance of the schema
+     *
+     * @param id Instance ID
+     * @returns Schema instance
+     */
+    instance(id?: string): SchemaInstance<T>;
+    /**
+     * Creates a new instance of the schema
+     *
+     * @param id Instance ID
+     * @returns Created instance ID
+     */
+    createInstance(id?: string): Query<string>;
+    /**
+     * Destroys an existing instance of the schema
+     *
+     * @param id Instance ID
+     */
+    destroyInstance(id?: string): Query<void>;
+}
+/**
+ * Schema instance, could be a database or a filtered portion of one depending on the implementation
+ */
+export declare class SchemaInstance<T> extends StagedObject {
+    /**
+     * Gets a table from the instance
+     *
+     * @param id Table name
+     * @returns Table
+     */
+    table<TK extends keyof T>(id: TK): Table<T[TK]>;
+}

package/dist/schema.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaInstance = exports.Schema = exports.Schemas = void 0;
+const interface_core_1 = require("@antelopejs/interface-core");
+const common_1 = require("./common");
+const query_1 = require("./query");
+const selection_1 = require("./selection");
+//@internal
+exports.Schemas = new interface_core_1.RegisteringProxy();
+/**
+ * A schema determines the structure of a database
+ *
+ * Each schema can have multiple instances
+ *
+ * The internal organization of these instances is left up to the module implementation
+ */
+class Schema extends common_1.StagedObject {
+    id;
+    definition;
+    options;
+    static registry = new Map();
+    /**
+     * Retrieves a previously defined schema by its ID
+     *
+     * @param id Schema ID
+     * @returns The schema instance, or undefined if not found
+     */
+    static get(id) {
+        return Schema.registry.get(id);
+    }
+    /**
+     * Define a new schema with the given ID
+     *
+     * @param id ID of this schema, changing this will leave previous data inaccessible
+     * @param definition Schema definition (tables, fields, indexes..)
+     */
+    constructor(id, definition, options = {}) {
+        super((0, common_1.QueryStage)("schema", { id }));
+        this.id = id;
+        this.definition = definition;
+        this.options = options;
+        exports.Schemas.register(id, definition, options);
+        Schema.registry.set(id, this);
+    }
+    /**
+     * Gets a specific instance of the schema
+     *
+     * @param id Instance ID
+     * @returns Schema instance
+     */
+    instance(id) {
+        return this.stage((SchemaInstance), "instance", { id });
+    }
+    /**
+     * Creates a new instance of the schema
+     *
+     * @param id Instance ID
+     * @returns Created instance ID
+     */
+    createInstance(id) {
+        return this.stage((query_1.Query), "createInstance", { id });
+    }
+    /**
+     * Destroys an existing instance of the schema
+     *
+     * @param id Instance ID
+     */
+    destroyInstance(id) {
+        return this.stage((query_1.Query), "destroyInstance", { id });
+    }
+}
+exports.Schema = Schema;
+/**
+ * Schema instance, could be a database or a filtered portion of one depending on the implementation
+ */
+class SchemaInstance extends common_1.StagedObject {
+    /**
+     * Gets a table from the instance
+     *
+     * @param id Table name
+     * @returns Table
+     */
+    table(id) {
+        return this.stage((selection_1.Table), "table", { id });
+    }
+}
+exports.SchemaInstance = SchemaInstance;
+//# sourceMappingURL=schema.js.map

package/dist/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":";;;AAAA,+DAA8D;AAC9D,qCAAoD;AACpD,mCAAgC;AAChC,2CAAoC;AAgDpC,WAAW;AACE,QAAA,OAAO,GAAG,IAAI,iCAAgB,EAExC,CAAC;AAEJ;;;;;;GAMG;AACH,MAAa,MAAgB,SAAQ,qBAAY;IAoB7B;IACA;IACA;IArBV,MAAM,CAAU,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE7D;;;;;OAKG;IACI,MAAM,CAAC,GAAG,CAAC,EAAU;QAC1B,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IACjC,CAAC;IAED;;;;;OAKG;IACH,YACkB,EAAU,EACV,UAA4B,EAC5B,UAAyB,EAAE;QAE3C,KAAK,CAAC,IAAA,mBAAU,EAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAJpB,OAAE,GAAF,EAAE,CAAQ;QACV,eAAU,GAAV,UAAU,CAAkB;QAC5B,YAAO,GAAP,OAAO,CAAoB;QAG3C,eAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;QAC1C,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACI,QAAQ,CAAC,EAAW;QACzB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,cAAiB,CAAA,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,EAAW;QAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAa,CAAA,EAAE,gBAAgB,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACI,eAAe,CAAC,EAAW;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAW,CAAA,EAAE,iBAAiB,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAC5D,CAAC;;AAxDH,wBAyDC;AAED;;GAEG;AACH,MAAa,cAAkB,SAAQ,qBAAY;IACjD;;;;;OAKG;IACI,KAAK,CAAqB,EAAM;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,iBAAY,CAAA,EAAE,OAAO,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IACnD,CAAC;CACF;AAVD,wCAUC"}

package/dist/selection.d.ts

@@ -0,0 +1,99 @@
+import type { Changes, DeepPartial, ExtractType, InsertOptions } from "./common";
+import { Datum } from "./datum";
+import { Query } from "./query";
+import { Stream } from "./stream";
+import { ValueProxy } from "./valueproxy";
+/**
+ * Selection containing a single element
+ */
+export declare class SingleSelection<T> extends Datum<T> {
+    /**
+     * Update fields of this selection with the given values
+     *
+     * @param document Partial document with new values
+     * @returns Number of modified documents
+     */
+    update(document: DeepPartial<T>): Query<number>;
+    update<U>(document: (val: ValueProxy<T>) => U): ExtractType<U> extends DeepPartial<T> ? Query<number> : never;
+    /**
+     * Replace documents of this selection
+     *
+     * @param document Partial document to replace with
+     * @returns Number of modified documents
+     */
+    replace(document: DeepPartial<T>): Query<number>;
+    /**
+     * Delete selected documents
+     *
+     * @returns Number of deleted documents
+     */
+    delete(): Query<number>;
+    /**
+     * Turns this selection into a change feed
+     *
+     * @returns Change feed
+     */
+    changes(): Query<Changes<T>[]>;
+}
+/**
+ * Selection containing any number of elements
+ */
+export declare class Selection<T> extends Stream<T> {
+    /**
+     * Update fields of this selection with the given values
+     *
+     * @param document Partial document with new values
+     * @returns Number of modified documents
+     */
+    update(document: DeepPartial<T>): Query<number>;
+    update<U>(document: (val: ValueProxy<T>) => U): ExtractType<U> extends DeepPartial<T> ? Query<number> : never;
+    /**
+     * Replace documents of this selection
+     *
+     * @param document Partial document to replace with
+     * @returns Number of modified documents
+     */
+    replace(document: DeepPartial<T>): Query<number>;
+    /**
+     * Delete selected documents
+     *
+     * @returns Number of deleted documents
+     */
+    delete(): Query<number>;
+}
+/**
+ * Database table
+ */
+export declare class Table<T> extends Selection<T> {
+    /**
+     * Inserts one or more documents into this table
+     *
+     * @param obj Document(s) to insert
+     * @returns Inserted IDs
+     */
+    insert(obj: DeepPartial<T> | DeepPartial<T>[], options?: InsertOptions): Query<string[]>;
+    /**
+     * Gets a document using its primary key
+     *
+     * @param key Primary key value
+     * @returns Single document selection
+     */
+    get(key: string): SingleSelection<T>;
+    /**
+     * Gets multiple documents using a secondary index
+     *
+     * @param keys Key value(s)
+     * @param index Secondary index, will use the primary key if undefined
+     * @returns Multiple document selection
+     */
+    getAll(keys: string | number | boolean | (string | number | boolean)[], index?: string): Selection<T>;
+    /**
+     * Gets multiple documents using a secondary index and bounding values
+     *
+     * @param index Secondary index
+     * @param low Lowest value of the range
+     * @param high Highest value of the range (excluded)
+     * @returns Multiple document selection
+     */
+    between<TK extends keyof T>(index: TK, low: T[TK], high: T[TK]): Selection<T>;
+}

package/dist/selection.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Table = exports.Selection = exports.SingleSelection = void 0;
+const datum_1 = require("./datum");
+const query_1 = require("./query");
+const stream_1 = require("./stream");
+const valueproxy_1 = require("./valueproxy");
+/**
+ * Selection containing a single element
+ */
+class SingleSelection extends datum_1.Datum {
+    update(document) {
+        if (typeof document === "function") {
+            return this.stage((query_1.Query), "update", undefined, this.callfunc(document, (valueproxy_1.ValueProxy)));
+        }
+        return this.stage((query_1.Query), "update", undefined, document);
+    }
+    /**
+     * Replace documents of this selection
+     *
+     * @param document Partial document to replace with
+     * @returns Number of modified documents
+     */
+    replace(document) {
+        return this.stage((query_1.Query), "replace", undefined, document);
+    }
+    /**
+     * Delete selected documents
+     *
+     * @returns Number of deleted documents
+     */
+    delete() {
+        return this.stage((query_1.Query), "delete");
+    }
+    /**
+     * Turns this selection into a change feed
+     *
+     * @returns Change feed
+     */
+    changes() {
+        return this.stage((query_1.Query), "changes");
+    }
+}
+exports.SingleSelection = SingleSelection;
+/**
+ * Selection containing any number of elements
+ */
+class Selection extends stream_1.Stream {
+    update(document) {
+        if (typeof document === "function") {
+            return this.stage((query_1.Query), "update", undefined, this.callfunc(document, (valueproxy_1.ValueProxy)));
+        }
+        return this.stage((query_1.Query), "update", undefined, document);
+    }
+    /**
+     * Replace documents of this selection
+     *
+     * @param document Partial document to replace with
+     * @returns Number of modified documents
+     */
+    replace(document) {
+        return this.stage((query_1.Query), "replace", undefined, document);
+    }
+    /**
+     * Delete selected documents
+     *
+     * @returns Number of deleted documents
+     */
+    delete() {
+        return this.stage((query_1.Query), "delete");
+    }
+}
+exports.Selection = Selection;
+/**
+ * Database table
+ */
+class Table extends Selection {
+    /**
+     * Inserts one or more documents into this table
+     *
+     * @param obj Document(s) to insert
+     * @returns Inserted IDs
+     */
+    insert(obj, options) {
+        return this.stage((query_1.Query), "insert", options, obj);
+    }
+    /**
+     * Gets a document using its primary key
+     *
+     * @param key Primary key value
+     * @returns Single document selection
+     */
+    get(key) {
+        return this.stage((SingleSelection), "get", undefined, key);
+    }
+    /**
+     * Gets multiple documents using a secondary index
+     *
+     * @param keys Key value(s)
+     * @param index Secondary index, will use the primary key if undefined
+     * @returns Multiple document selection
+     */
+    getAll(keys, index) {
+        return this.stage((Selection), "getAll", { index }, keys);
+    }
+    /**
+     * Gets multiple documents using a secondary index and bounding values
+     *
+     * @param index Secondary index
+     * @param low Lowest value of the range
+     * @param high Highest value of the range (excluded)
+     * @returns Multiple document selection
+     */
+    between(index, low, high) {
+        return this.stage((Selection), "between", { index }, low, high);
+    }
+}
+exports.Table = Table;
+//# sourceMappingURL=selection.js.map

package/dist/selection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"selection.js","sourceRoot":"","sources":["../src/selection.ts"],"names":[],"mappings":";;;AAMA,mCAAgC;AAChC,mCAAgC;AAChC,qCAAkC;AAClC,6CAA0C;AAE1C;;GAEG;AACH,MAAa,eAAmB,SAAQ,aAAQ;IAWvC,MAAM,CAAC,QAA4D;QACxE,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,KAAK,CACf,CAAA,aAAa,CAAA,EACb,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAA,uBAAa,CAAA,CAAC,CACvC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAa,CAAA,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,QAAwB;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAa,CAAA,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAa,CAAA,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACI,OAAO;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAmB,CAAA,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC;CACF;AAlDD,0CAkDC;AAED;;GAEG;AACH,MAAa,SAAa,SAAQ,eAAS;IAWlC,MAAM,CAAC,QAA4D;QACxE,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,KAAK,CACf,CAAA,aAAa,CAAA,EACb,QAAQ,EACR,SAAS,EACT,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAA,uBAAa,CAAA,CAAC,CACvC,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAa,CAAA,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,OAAO,CAAC,QAAwB;QACrC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAa,CAAA,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;IACnE,CAAC;IAED;;;;OAIG;IACI,MAAM;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAa,CAAA,EAAE,QAAQ,CAAC,CAAC;IAC7C,CAAC;CACF;AAzCD,8BAyCC;AAED;;GAEG;AACH,MAAa,KAAS,SAAQ,SAAY;IACxC;;;;;OAKG;IACI,MAAM,CACX,GAAsC,EACtC,OAAuB;QAEvB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,aAAe,CAAA,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;OAKG;IACI,GAAG,CAAC,GAAW;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,eAAkB,CAAA,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CACX,IAA+D,EAC/D,KAAc;QAEd,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,SAAY,CAAA,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;OAOG;IACI,OAAO,CAAqB,KAAS,EAAE,GAAU,EAAE,IAAW;QACnE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA,SAAY,CAAA,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACnE,CAAC;CACF;AAjDD,sBAiDC"}

package/dist/stream.d.ts

@@ -0,0 +1,185 @@
+import type { Changes, ExtractType, Value } from "./common";
+import { Datum } from "./datum";
+import { Query } from "./query";
+import type { Selection } from "./selection";
+import { ValueProxy, type ValueProxyOrValue } from "./valueproxy";
+export declare class Stream<T> extends Query<T[]> {
+    /**
+     * Changes the type of the value in this stream.
+     * This does not actually perform any conversion, it only changes the typescript type.
+     *
+     * @returns Same stream with a different type
+     */
+    cast<U>(): Stream<U>;
+    /**
+     * Indexes the stream value.
+     *
+     * TODO: Better name?
+     *
+     * @param key Field name
+     * @param def Default value
+     * @returns New stream
+     */
+    key<K extends keyof T, U = undefined>(key: K, def?: U): Stream<U extends undefined ? T[K] : U | Exclude<T[K], null | undefined>>;
+    /**
+     * Defaults the stream value to a given value if it is null.
+     *
+     * @param value Default value
+     * @returns Stream with non-null value
+     */
+    default<U>(val: Value<U>): Stream<U | Exclude<T, null | undefined>>;
+    /**
+     * Maps the array values using a mapping function.
+     *
+     * @param mapper Mapping function
+     * @returns New stream
+     */
+    map<U>(mapper: (val: ValueProxy<T>) => U): Stream<ExtractType<U>>;
+    /**
+     * Filters the array using a predicate function.
+     *
+     * @param predicate Predicate function.
+     * @returns Filtered stream
+     */
+    filter(predicate: (val: ValueProxy<T>) => ValueProxyOrValue<boolean>): this;
+    /**
+     * Selects specific fields in the documents, discarding the rest.
+     *
+     * @param fields Selected fields
+     * @returns New stream
+     */
+    pluck(...fields: string[]): Stream<Partial<T>>;
+    /**
+     * Excludes specific fields in the documents
+     *
+     * @param fields Excluded fields
+     * @returns New stream
+     */
+    without(...fields: string[]): Stream<Partial<T>>;
+    /**
+     * Concatenates the results of another stream into this stream without deduplication
+     *
+     * @param other Stream to concatenate
+     * @returns New stream containing elements from both streams
+     */
+    union<U>(other: Stream<U>): Stream<T | U>;
+    /**
+     * Perform a left join operation between this stream (left) and another stream (right)
+     *
+     * @param right Right stream
+     * @param predicate Predicate to match elements from the left stream to the right stream
+     * @param mapper Mapping function for each pair of documents
+     * @returns New stream with results of the mapping function
+     */
+    join<U, V>(right: Stream<U>, predicate: (left: ValueProxy<T>, right: ValueProxy<U>) => ValueProxyOrValue<boolean>, mapper: (left: ValueProxy<T>, right: ValueProxy<U | null>) => V): Stream<ExtractType<V>>;
+    /**
+     * Perform an inner join operation between this stream (left) and another stream (right)
+     *
+     * @param right Right stream
+     * @param predicate Predicate to match elements from the left stream to the right stream
+     * @param mapper Mapping function for each pair of documents
+     * @returns New stream with results of the mapping function
+     */
+    joinInner<U, V>(right: Stream<U>, predicate: (left: ValueProxy<T>, right: ValueProxy<U>) => ValueProxyOrValue<boolean>, mapper: (left: ValueProxy<T>, right: ValueProxy<U>) => V): Stream<ExtractType<V>>;
+    /**
+     * Transform a foreign key or array of foreign keys into a document from another stream
+     *
+     * @param right Stream containing the other documents
+     * @param localKey Key in the local document to search with and replace
+     * @param otherKey Key in the other document to match against
+     * @returns New stream
+     */
+    lookup<U, TK extends keyof T>(right: Selection<U>, localKey: TK, otherKey: keyof U): Stream<Omit<T, TK> & Record<TK, T[TK] extends any[] ? U[] : U>>;
+    /**
+     * Group the documents using the given index and maps the result using a mapping function
+     *
+     * The parameters of this function are:
+     * - The stream with all the documents inside the group
+     * - The index value for this group
+     *
+     * The result of this function is used as the element in the new stream
+     *
+     * @param index Index to group on
+     * @param mapper Mapping function
+     * @returns New stream of grouped data
+     */
+    group<U, K extends keyof T | string>(index: K, mapper: (stream: Stream<T>, group: ValueProxy<K extends keyof T ? T[K] : unknown>) => U): Stream<ExtractType<U>>;
+    /**
+     * Sort the stream using the given index and direction
+     *
+     * @param index Index to sort
+     * @param direction Sort direction
+     * @returns New (sorted) stream
+     */
+    orderBy(index: string, direction?: "asc" | "desc"): this;
+    /**
+     * Obtain a slice (subsection) of the stream
+     *
+     * @param offset Offset into the stream
+     * @param count Number of documents to pick
+     * @returns New stream
+     */
+    slice(offset: Value<number>, count?: Value<number>): this;
+    /**
+     * Obtain the Nth document of the stream
+     *
+     * @param n N
+     * @returns Single document
+     */
+    nth(n: Value<number>): Datum<T | null>;
+    /**
+     * Gets the count of documents or the count of distinct values of a given field
+     *
+     * @param field Field to count distinct entries
+     * @returns Count
+     */
+    count(field?: keyof T): Datum<number>;
+    /**
+     * Sum of the values on the given field
+     *
+     * @param field Field to use
+     * @returns Sum
+     */
+    sum(field?: keyof T): Datum<number>;
+    /**
+     * Average of the values on the given field
+     *
+     * @param field Field to use
+     * @returns Average
+     */
+    avg(field?: keyof T): Datum<number>;
+    /**
+     * Minimum of the values on the given field
+     *
+     * @param field Field to use
+     * @returns Minimum value
+     */
+    min(field?: keyof T): Datum<number>;
+    /**
+     * Maximum of the values on the given field
+     *
+     * @param field Field to use
+     * @returns Maximum value
+     */
+    max(field?: keyof T): Datum<number>;
+    /**
+     * Gets an array of distinct documents in the stream
+     *
+     * @returns Array of documents
+     */
+    distinct(): Datum<T[]>;
+    distinct(field: undefined): Datum<T[]>;
+    /**
+     * Gets a stream of the distinct values of a field
+     *
+     * @param index Field to use
+     * @returns New stream
+     */
+    distinct<TK extends keyof T>(field: TK): Stream<T[TK]>;
+    /**
+     * Turns this stream into a change feed
+     *
+     * @returns Change feed
+     */
+    changes(): Query<Changes<T>[]>;
+}