From 32d6a213fb8a0b3bdddfdb9f9f5bff13d759b572 Mon Sep 17 00:00:00 2001 From: Sean Tan Date: Tue, 12 Sep 2017 14:53:56 +0800 Subject: [PATCH 1/5] Move exising definition for lunr.js 0.5.4 to lunr/v0 --- types/lunr/{ => v0}/index.d.ts | 0 types/lunr/{ => v0}/lunr-tests.ts | 0 types/lunr/{ => v0}/tsconfig.json | 7 +++++-- 3 files changed, 5 insertions(+), 2 deletions(-) rename types/lunr/{ => v0}/index.d.ts (100%) rename types/lunr/{ => v0}/lunr-tests.ts (100%) rename types/lunr/{ => v0}/tsconfig.json (78%) diff --git a/types/lunr/index.d.ts b/types/lunr/v0/index.d.ts similarity index 100% rename from types/lunr/index.d.ts rename to types/lunr/v0/index.d.ts diff --git a/types/lunr/lunr-tests.ts b/types/lunr/v0/lunr-tests.ts similarity index 100% rename from types/lunr/lunr-tests.ts rename to types/lunr/v0/lunr-tests.ts diff --git a/types/lunr/tsconfig.json b/types/lunr/v0/tsconfig.json similarity index 78% rename from types/lunr/tsconfig.json rename to types/lunr/v0/tsconfig.json index 608f88b0b2..37f937893d 100644 --- a/types/lunr/tsconfig.json +++ b/types/lunr/v0/tsconfig.json @@ -7,10 +7,13 @@ "noImplicitAny": true, "noImplicitThis": false, "strictNullChecks": false, - "baseUrl": "../", + "baseUrl": "../../", "typeRoots": [ - "../" + "../../" ], + "paths": { + "lunr": ["lunr/v0"] + }, "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true From 22cf61b868056724de992afb090cdfcc8f08680f Mon Sep 17 00:00:00 2001 From: Sean Tan Date: Tue, 12 Sep 2017 15:26:48 +0800 Subject: [PATCH 2/5] Add v0/tslint.json --- types/lunr/v0/tslint.json | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 types/lunr/v0/tslint.json diff --git a/types/lunr/v0/tslint.json b/types/lunr/v0/tslint.json new file mode 100644 index 0000000000..a6eeebd3be --- /dev/null +++ b/types/lunr/v0/tslint.json @@ -0,0 +1,9 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "ban-types": false, + "only-arrow-functions": [false], + "no-single-declare-module": false, + "no-unnecessary-qualifier": true + } +} \ No newline at end of file From e8d48ef03dfb68b35bd3c270795b846bd04f7e8c Mon Sep 17 00:00:00 2001 From: Sean Tan Date: Tue, 12 Sep 2017 15:26:53 +0800 Subject: [PATCH 3/5] Fix tslint issues in v0/lunr-tests.ts --- types/lunr/v0/lunr-tests.ts | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/types/lunr/v0/lunr-tests.ts b/types/lunr/v0/lunr-tests.ts index 65557ef96a..79f032f695 100644 --- a/types/lunr/v0/lunr-tests.ts +++ b/types/lunr/v0/lunr-tests.ts @@ -1,10 +1,8 @@ - - /** * Basic test, from http://lunrjs.com/ */ function basic_test() { - var index = lunr(function () { + const index = lunr(function() { this.field('title', {boost: 10}); this.field('body'); this.ref('id'); @@ -25,20 +23,19 @@ function basic_test() { index.search('foo'); } - /** * Pipeline test, from http://lunrjs.com/ */ function pipeline_test() { - var index = lunr(function () { - this.pipeline.add(function (token:string, tokenIndex:number, tokens:string[]):string { + const index = lunr(function() { + this.pipeline.add(function(token: string, tokenIndex: number, tokens: string[]): string { // text processing in here return token; }); - this.pipeline.after(lunr.stopWordFilter, function (token:string, tokenIndex:number, tokens:string[]):string { + this.pipeline.after(lunr.stopWordFilter, function(token: string, tokenIndex: number, tokens: string[]): string { // text processing in here return token; }); - }) -} \ No newline at end of file + }); +} From f54859a71d756d109df91aec05a38d5f5ca44dd6 Mon Sep 17 00:00:00 2001 From: Sean Tan Date: Tue, 12 Sep 2017 15:39:57 +0800 Subject: [PATCH 4/5] Fix tslint issues in v0/index.d.ts --- types/lunr/v0/index.d.ts | 327 ++++++++++++++------------------------- 1 file changed, 117 insertions(+), 210 deletions(-) diff --git a/types/lunr/v0/index.d.ts b/types/lunr/v0/index.d.ts index 2bebc99643..919fb5ecf9 100644 --- a/types/lunr/v0/index.d.ts +++ b/types/lunr/v0/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for lunr.js 0.5.4 +// Type definitions for lunr.js 0.5 // Project: https://github.com/olivernn/lunr.js // Definitions by: Sebastian Lenz // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -9,10 +9,8 @@ * MIT Licensed * @license */ -declare namespace lunr -{ - var version:string; - +declare namespace lunr { + const version: string; /** * A function for splitting a string into tokens ready to be inserted into @@ -26,13 +24,9 @@ declare namespace lunr */ function tokenizer(obj: any): string[]; - interface TokenizerFunction { - // obj is usually a string, but the default lunr tokenizer handles null, - // undefined and arrays of objects with a .toString() method. - (obj: any): string[]; - } + type TokenizerFunction = (obj: any) => string[]; - module tokenizer { + namespace tokenizer { /** * The sperator used to split a string into tokens. Override this property to change the behaviour of * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens. @@ -42,11 +36,11 @@ declare namespace lunr * * (Note: this is misspelled in the original API, kept for compatibility sake) */ - var seperator: RegExp | string; + const seperator: RegExp | string; - var label: string; + const label: string; - var registeredFunctions: {[label: string]: TokenizerFunction}; + const registeredFunctions: {[label: string]: TokenizerFunction}; /** * Register a tokenizer function. @@ -74,15 +68,13 @@ declare namespace lunr function load(label: string): TokenizerFunction; } - /** * lunr.stemmer is an english language stemmer, this is a JavaScript implementation of * the PorterStemmer taken from http://tartaurs.org/~martin * * @param token The string to stem */ - function stemmer(token:string):string; - + function stemmer(token: string): string; /** * lunr.stopWordFilter is an English language stop word list filter, any words contained @@ -93,13 +85,12 @@ declare namespace lunr * * @param token The token to pass through the filter */ - function stopWordFilter(token:string):string; + function stopWordFilter(token: string): string; namespace stopWordFilter { - var stopWords:SortedSet; + const stopWords: SortedSet; } - /** * lunr.trimmer is a pipeline function for trimming non word characters from the beginning * and end of tokens before they enter the index. @@ -108,15 +99,13 @@ declare namespace lunr * be removed or adapted for use with languages with non-latin characters. * @param token The token to pass through the filter */ - function trimmer(token:string):string; - + function trimmer(token: string): string; /** * lunr.EventEmitter is an event emitter for lunr. It manages adding and removing event handlers * and triggering events and their handlers. */ - class EventEmitter - { + class EventEmitter { /** * Can bind a single function to many different events in one call. * @@ -124,12 +113,11 @@ declare namespace lunr * @param handler The function to call when an event is fired. Binds a handler * function to a specific event(s). */ - addListener(eventName:string, handler:Function):void; - addListener(eventName:string, eventName2:string, handler:Function):void; - addListener(eventName:string, eventName2:string, eventName3:string, handler:Function):void; - addListener(eventName:string, eventName2:string, eventName3:string, eventName4:string, handler:Function):void; - addListener(eventName:string, eventName2:string, eventName3:string, eventName4:string, eventName5:string, handler:Function):void; - + addListener(eventName: string, handler: Function): void; + addListener(eventName: string, eventName2: string, handler: Function): void; + addListener(eventName: string, eventName2: string, eventName3: string, handler: Function): void; + addListener(eventName: string, eventName2: string, eventName3: string, eventName4: string, handler: Function): void; + addListener(eventName: string, eventName2: string, eventName3: string, eventName4: string, eventName5: string, handler: Function): void; /** * Removes a handler function from a specific event. @@ -137,8 +125,7 @@ declare namespace lunr * @param eventName The name of the event to remove this function from. * @param handler The function to remove from an event. */ - removeListener(eventName:string, handler:Function):void; - + removeListener(eventName: string, handler: Function): void; /** * Calls all functions bound to the given event. @@ -148,24 +135,17 @@ declare namespace lunr * @param eventName The name of the event to emit. * @param args */ - emit(eventName:string, ...args:any[]):void; - + emit(eventName: string, ...args: any[]): void; /** * Checks whether a handler has ever been stored against an event. * * @param eventName The name of the event to check. */ - hasHandler(eventName:string):boolean; - } - - - interface IPipelineFunction { - (token:string):string; - (token:string, tokenIndex:number):string; - (token:string, tokenIndex:number, tokens:string[]):string; + hasHandler(eventName: string): boolean; } + type IPipelineFunction = (token: string, tokenIndex?: number, tokens?: string[]) => string; /** * lunr.Pipelines maintain an ordered list of functions to be applied to all tokens in documents @@ -188,10 +168,8 @@ declare namespace lunr * * If not planning on serialising the pipeline then registering pipeline functions is not necessary. */ - class Pipeline - { - registeredFunctions:{[label:string]:Function}; - + class Pipeline { + registeredFunctions: {[label: string]: Function}; /** * Register a function with the pipeline. @@ -205,16 +183,14 @@ declare namespace lunr * @param fn The function to check for. * @param label The label to register this function with */ - registerFunction(fn:IPipelineFunction, label:string):void; - + registerFunction(fn: IPipelineFunction, label: string): void; /** * Warns if the function is not registered as a Pipeline function. * * @param fn The function to check for. */ - warnIfFunctionNotRegistered(fn:IPipelineFunction):void; - + warnIfFunctionNotRegistered(fn: IPipelineFunction): void; /** * Adds new functions to the end of the pipeline. @@ -223,8 +199,7 @@ declare namespace lunr * * @param functions Any number of functions to add to the pipeline. */ - add(...functions:IPipelineFunction[]):void; - + add(...functions: IPipelineFunction[]): void; /** * Adds a single function after a function that already exists in the pipeline. @@ -234,8 +209,7 @@ declare namespace lunr * @param existingFn A function that already exists in the pipeline. * @param newFn The new function to add to the pipeline. */ - after(existingFn:IPipelineFunction, newFn:IPipelineFunction):void; - + after(existingFn: IPipelineFunction, newFn: IPipelineFunction): void; /** * Adds a single function before a function that already exists in the pipeline. @@ -245,16 +219,14 @@ declare namespace lunr * @param existingFn A function that already exists in the pipeline. * @param newFn The new function to add to the pipeline. */ - before(existingFn:IPipelineFunction, newFn:IPipelineFunction):void; - + before(existingFn: IPipelineFunction, newFn: IPipelineFunction): void; /** * Removes a function from the pipeline. * * @param fn The function to remove from the pipeline. */ - remove(fn:IPipelineFunction):void; - + remove(fn: IPipelineFunction): void; /** * Runs the current list of functions that make up the pipeline against @@ -262,20 +234,17 @@ declare namespace lunr * * @param tokens The tokens to run through the pipeline. */ - run(tokens:string[]):string[]; - + run(tokens: string[]): string[]; /** * Resets the pipeline by removing any existing processors. */ - reset():void; - + reset(): void; /** * Returns a representation of the pipeline ready for serialisation. */ - toJSON():any; - + toJSON(): any; /** * Loads a previously serialised pipeline. @@ -285,93 +254,80 @@ declare namespace lunr * * @param serialised The serialised pipeline to load. */ - static load(serialised:any):Pipeline; + static load(serialised: any): Pipeline; } - /** * lunr.Vectors implement vector related operations for a series of elements. */ - class Vector - { - list:Node; - + class Vector { + list: Node; /** * Calculates the magnitude of this vector. */ - magnitude():number; - + magnitude(): number; /** * Calculates the dot product of this vector and another vector. * @param otherVector The vector to compute the dot product with. */ - dot(otherVector:Vector):number; - + dot(otherVector: Vector): number; /** * Calculates the cosine similarity between this vector and another vector. * * @param otherVector The other vector to calculate the */ - similarity(otherVector:Vector):number; + similarity(otherVector: Vector): number; } - /** * lunr.Vector.Node is a simple struct for each node in a lunr.Vector. */ - class Node - { + class Node { /** * The index of the node in the vector. */ - idx:number; + idx: number; /** * The data at this node in the vector. */ - val:number; + val: number; /** * The node directly after this node in the vector. */ - next:Node; - + next: Node; /** * @param idx The index of the node in the vector. * @param val The data at this node in the vector. * @param next The node directly after this node in the vector. */ - constructor(idx:number, val:number, next:Node); + constructor(idx: number, val: number, next: Node); } - /** * lunr.SortedSets are used to maintain an array of unique values in a sorted order. */ - class SortedSet - { - elements:T[]; - - length:number; + class SortedSet { + elements: T[]; + length: number; /** * Inserts new items into the set in the correct position to maintain the order. * * @param values The objects to add to this set. */ - add(...values:T[]):void; - + add(...values: T[]): void; /** * Converts this sorted set into an array. */ - toArray():T[]; - + toArray(): T[]; /** * Creates a new array with the results of calling a provided function on @@ -382,8 +338,7 @@ declare namespace lunr * @param fn The function that is called on each element of the * @param ctx An optional object that can be used as the context */ - map(fn:Function, ctx:any):T[]; - + map(fn: Function, ctx: any): T[]; /** * Executes a provided function once per sorted set element. @@ -393,8 +348,7 @@ declare namespace lunr * @param fn The function that is called on each element of the * @param ctx An optional object that can be used as the context */ - forEach(fn:Function, ctx:any):any; - + forEach(fn: Function, ctx: any): any; /** * Returns the index at which a given element can be found in the sorted @@ -404,8 +358,7 @@ declare namespace lunr * @param start An optional index at which to start searching from * @param end An optional index at which to stop search from within */ - indexOf(elem:T, start?:number, end?:number):number; - + indexOf(elem: T, start?: number, end?: number): number; /** * Returns the position within the sorted set that an element should be @@ -418,8 +371,7 @@ declare namespace lunr * @param start - An optional index at which to start searching from * @param end - An optional index at which to stop search from within */ - locationFor(elem:T, start?:number, end?:number):number; - + locationFor(elem: T, start?: number, end?: number): number; /** * Creates a new lunr.SortedSet that contains the elements in the @@ -427,8 +379,7 @@ declare namespace lunr * * @param otherSet The set to intersect with this set. */ - intersect(otherSet:SortedSet):SortedSet; - + intersect(otherSet: SortedSet): SortedSet; /** * Creates a new lunr.SortedSet that contains the elements in the union of this @@ -436,75 +387,65 @@ declare namespace lunr * * @param otherSet The set to union with this set. */ - union(otherSet:SortedSet):SortedSet; - + union(otherSet: SortedSet): SortedSet; /** * Makes a copy of this set */ - clone():SortedSet; - + clone(): SortedSet; /** * Returns a representation of the sorted set ready for serialisation. */ - toJSON():any; - + toJSON(): any; /** * Loads a previously serialised sorted set. * * @param serialisedData The serialised set to load. */ - static load(serialisedData:T[]):SortedSet; + static load(serialisedData: T[]): SortedSet; } - - interface IIndexField - { + interface IndexField { /** * The name of the field within the document that */ - name:string; + name: string; /** * An optional boost that can be applied to terms in this field. */ - boost:number; + boost: number; } + interface IndexSearchResult { + ref: any; - interface IIndexSearchResult - { - ref:any; - - score:number; + score: number; } - /** * lunr.Index is object that manages a search index. It contains the indexes and stores * all the tokens and document lookups. It also provides the main user facing API for * the library. */ - class Index - { - eventEmitter:EventEmitter; + class Index { + eventEmitter: EventEmitter; - documentStore:Store; + documentStore: Store; - tokenStore:TokenStore; + tokenStore: TokenStore; - corpusTokens:SortedSet; + corpusTokens: SortedSet; - pipeline:Pipeline; + pipeline: Pipeline; - _fields:IIndexField[]; + _fields: IndexField[]; - _ref:string; - - _idfCache:{[key:string]:string}; + _ref: string; + _idfCache: {[key: string]: string}; /** * Bind a handler to events being emitted by the index. @@ -515,12 +456,11 @@ declare namespace lunr * @param handler The function to call when an event is fired. Binds a handler * function to a specific event(s). */ - on(eventName:string, handler:Function):void; - on(eventName:string, eventName2:string, handler:Function):void; - on(eventName:string, eventName2:string, eventName3:string, handler:Function):void; - on(eventName:string, eventName2:string, eventName3:string, eventName4:string, handler:Function):void; - on(eventName:string, eventName2:string, eventName3:string, eventName4:string, eventName5:string, handler:Function):void; - + on(eventName: string, handler: Function): void; + on(eventName: string, eventName2: string, handler: Function): void; + on(eventName: string, eventName2: string, eventName3: string, handler: Function): void; + on(eventName: string, eventName2: string, eventName3: string, eventName4: string, handler: Function): void; + on(eventName: string, eventName2: string, eventName3: string, eventName4: string, eventName5: string, handler: Function): void; /** * Removes a handler from an event being emitted by the index. @@ -528,8 +468,7 @@ declare namespace lunr * @param eventName The name of events to remove the function from. * @param handler The serialised set to load. */ - off(eventName:string, handler:Function):void; - + off(eventName: string, handler: Function): void; /** * Adds a field to the list of fields that will be searchable within documents in the index. @@ -543,8 +482,7 @@ declare namespace lunr * @param fieldName The name of the field within the document that * @param options An optional boost that can be applied to terms in this field. */ - field(fieldName:string, options?:{boost?:number}):Index; - + field(fieldName: string, options?: {boost?: number}): Index; /** * Sets the property used to uniquely identify documents added to the index, by default this @@ -555,8 +493,7 @@ declare namespace lunr * * @refName The property to use to uniquely identify the */ - ref(refName:string):Index; - + ref(refName: string): Index; /** * Add a document to the index. @@ -571,8 +508,7 @@ declare namespace lunr * @param doc The document to add to the index. * @param emitEvent Whether or not to emit events, default true. */ - add(doc:any, emitEvent?:boolean):void; - + add(doc: any, emitEvent?: boolean): void; /** * Removes a document from the index. @@ -590,8 +526,7 @@ declare namespace lunr * @param doc The document to remove from the index. * @param emitEvent Whether to emit remove events, defaults to true */ - remove(doc:any, emitEvent?:boolean):void; - + remove(doc: any, emitEvent?: boolean): void; /** * Updates a document in the index. @@ -609,16 +544,14 @@ declare namespace lunr * @param doc The document to update in the index. * @param emitEvent Whether to emit update events, defaults to true */ - update(doc:any, emitEvent?:boolean):void; - + update(doc: any, emitEvent?: boolean): void; /** * Calculates the inverse document frequency for a token within the index. * * @param token The token to calculate the idf of. */ - idf(token:string):string; - + idf(token: string): string; /** * Searches the index using the passed query. @@ -639,8 +572,7 @@ declare namespace lunr * * @param query The query to search the index with. */ - search(query:string):IIndexSearchResult[]; - + search(query: string): IndexSearchResult[]; /** * Generates a vector containing all the tokens in the document matching the @@ -652,14 +584,12 @@ declare namespace lunr * * @param documentRef The ref to find the document with. */ - documentVector(documentRef:string):Vector; - + documentVector(documentRef: string): Vector; /** * Returns a representation of the index ready for serialisation. */ - toJSON():any; - + toJSON(): any; /** * Applies a plugin to the current index. @@ -688,8 +618,7 @@ declare namespace lunr * @param plugin The plugin to apply. * @param args */ - use(plugin:Function, ...args:any[]):void; - + use(plugin: Function, ...args: any[]): void; /** * Loads a previously serialised index. @@ -699,20 +628,17 @@ declare namespace lunr * * @param serialisedData The serialised set to load. */ - static load(serialisedData:any):Index; + static load(serialisedData: any): Index; } - /** * lunr.Store is a simple key-value store used for storing sets of tokens for documents * stored in index. */ - class Store - { - store:{[id:string]:SortedSet}; - - length:number; + class Store { + store: {[id: string]: SortedSet}; + length: number; /** * Stores the given tokens in the store against the given id. @@ -720,68 +646,58 @@ declare namespace lunr * @param id The key used to store the tokens against. * @param tokens The tokens to store against the key. */ - set(id:string, tokens:SortedSet):void; - + set(id: string, tokens: SortedSet): void; /** * Retrieves the tokens from the store for a given key. * * @param id The key to lookup and retrieve from the store. */ - get(id:string):SortedSet; - + get(id: string): SortedSet; /** * Checks whether the store contains a key. * * @param id The id to look up in the store. */ - has(id:string):boolean; - + has(id: string): boolean; /** * Removes the value for a key in the store. * * @param id The id to remove from the store. */ - remove(id:string):void; - + remove(id: string): void; /** * Returns a representation of the store ready for serialisation. */ - toJSON():any; - + toJSON(): any; /** * Loads a previously serialised store. * * @param serialisedData The serialised store to load. */ - static load(serialisedData:any):Store; + static load(serialisedData: any): Store; } + interface TokenDocument { + ref: number; - interface ITokenDocument - { - ref:number; - - tf:number; + tf: number; } - /** * lunr.TokenStore is used for efficient storing and lookup of the reverse index of token * to document ref. */ - class TokenStore - { - root:{[token:string]:TokenStore}; + class TokenStore { + root: {[token: string]: TokenStore}; - docs:{[ref:string]:ITokenDocument}; - - length:number; + docs: {[ref: string]: TokenDocument}; + length: number; /** * Adds a new token doc pair to the store. @@ -793,24 +709,21 @@ declare namespace lunr * @param doc The doc to store against the token * @param root An optional node at which to start looking for the */ - add(token:string, doc:ITokenDocument, root?:TokenStore):void; - + add(token: string, doc: TokenDocument, root?: TokenStore): void; /** * Checks whether this key is contained within this lunr.TokenStore. * * @param token The token to check for */ - has(token:string):boolean; - + has(token: string): boolean; /** * Retrieve a node from the token store for a given token. * * @param token The token to get the node for. */ - getNode(token:string):TokenStore; - + getNode(token: string): TokenStore; /** * Retrieve the documents for a node for the given token. @@ -821,11 +734,9 @@ declare namespace lunr * @param token The token to get the documents for. * @param root An optional node at which to start. */ - get(token:string, root:TokenStore):{[ref:string]:ITokenDocument}; - - - count(token:string, root:TokenStore):number; + get(token: string, root: TokenStore): {[ref: string]: TokenDocument}; + count(token: string, root: TokenStore): number; /** * Remove the document identified by ref from the token in the store. @@ -833,8 +744,7 @@ declare namespace lunr * @param token The token to get the documents for. * @param ref The ref of the document to remove from this token. */ - remove(token:string, ref:string):void; - + remove(token: string, ref: string): void; /** * Find all the possible suffixes of the passed token using tokens currently in @@ -843,27 +753,25 @@ declare namespace lunr * @param token The token to expand. * @param memo */ - expand(token:string, memo?:string[]):string[]; - + expand(token: string, memo?: string[]): string[]; /** * Returns a representation of the token store ready for serialisation. */ - toJSON():any; - + toJSON(): any; /** * Loads a previously serialised token store. * * @param serialisedData The serialised token store to load. */ - static load(serialisedData:any):TokenStore; + static load(serialisedData: any): TokenStore; } /** * A namespace containing utils for the rest of the lunr library */ - module utils { + namespace utils { /** * Print a warning message to the console. * @@ -887,7 +795,6 @@ declare namespace lunr } } - /** * Convenience function for instantiating a new lunr index and configuring it with the default * pipeline functions and the passed config function. @@ -915,7 +822,7 @@ declare namespace lunr * }); * ``` */ -declare function lunr(config:Function):lunr.Index; +declare function lunr(config: Function): lunr.Index; export = lunr; export as namespace lunr; From cd8677c0196ce2cd4784222be430f4b21a8b85d9 Mon Sep 17 00:00:00 2001 From: Sean Tan Date: Tue, 12 Sep 2017 15:14:12 +0800 Subject: [PATCH 5/5] Rewritten definition for lunr.js v2.1.3 --- types/lunr/index.d.ts | 1005 ++++++++++++++++++++++++++++++++++++++ types/lunr/lunr-tests.ts | 35 ++ types/lunr/tsconfig.json | 22 + types/lunr/tslint.json | 9 + 4 files changed, 1071 insertions(+) create mode 100644 types/lunr/index.d.ts create mode 100644 types/lunr/lunr-tests.ts create mode 100644 types/lunr/tsconfig.json create mode 100644 types/lunr/tslint.json diff --git a/types/lunr/index.d.ts b/types/lunr/index.d.ts new file mode 100644 index 0000000000..ba652742f3 --- /dev/null +++ b/types/lunr/index.d.ts @@ -0,0 +1,1005 @@ +// Type definitions for lunr.js 2.1 +// Project: https://github.com/olivernn/lunr.js +// Definitions by: Sean Tan +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +/** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright + * Copyright (C) 2014 Oliver Nightingale + * MIT Licensed + * @license + */ +declare namespace lunr { + namespace Builder { + /** + * A plugin is a function that is called with the index builder as its context. + * Plugins can be used to customise or extend the behaviour of the index + * in some way. A plugin is just a function, that encapsulated the custom + * behaviour that should be applied when building the index. + * + * The plugin function will be called with the index builder as its argument, additional + * arguments can also be passed when calling use. The function will be called + * with the index builder as its context. + */ + type Plugin = (this: Builder, ...args: any[]) => void; + } + + /** + * lunr.Builder performs indexing on a set of documents and + * returns instances of lunr.Index ready for querying. + * + * All configuration of the index is done via the builder, the + * fields to index, the document reference, the text processing + * pipeline and document scoring parameters are all set on the + * builder before indexing. + */ + class Builder { + /** + * Internal reference to the document reference field. + */ + _ref: string; + + /** + * Internal reference to the document fields to index. + */ + _fields: string[]; + + /** + * The inverted index maps terms to document fields. + */ + invertedIndex: object; + + /** + * Keeps track of document term frequencies. + */ + documentTermFrequencies: object; + + /** + * Keeps track of the length of documents added to the index. + */ + documentLengths: object; + + /** + * Function for splitting strings into tokens for indexing. + */ + tokenizer: typeof tokenizer; + + /** + * The pipeline performs text processing on tokens before indexing. + */ + pipeline: Pipeline; + + /** + * A pipeline for processing search terms before querying the index. + */ + searchPipeline: Pipeline; + + /** + * Keeps track of the total number of documents indexed. + */ + documentCount: number; + + /** + * A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75. + */ + _b: number; + + /** + * A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2. + */ + _k1: number; + + /** + * A counter incremented for each unique term, used to identify a terms position in the vector space. + */ + termIndex: number; + + /** + * A list of metadata keys that have been whitelisted for entry in the index. + */ + metadataWhitelist: string[]; + + constructor() + + /** + * Sets the document field used as the document reference. Every document must have this field. + * The type of this field in the document should be a string, if it is not a string it will be + * coerced into a string by calling toString. + * + * The default ref is 'id'. + * + * The ref should _not_ be changed during indexing, it should be set before any documents are + * added to the index. Changing it during indexing can lead to inconsistent results. + * + * @param {string} ref - The name of the reference field in the document. + */ + ref(ref: string): void; + + /** + * Adds a field to the list of document fields that will be indexed. Every document being + * indexed should have this field. Null values for this field in indexed documents will + * not cause errors but will limit the chance of that document being retrieved by searches. + * + * All fields should be added before adding documents to the index. Adding fields after + * a document has been indexed will have no effect on already indexed documents. + * + * @param {string} field - The name of a field to index in all documents. + */ + field(field: string): void; + + /** + * A parameter to tune the amount of field length normalisation that is applied when + * calculating relevance scores. A value of 0 will completely disable any normalisation + * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b + * will be clamped to the range 0 - 1. + * + * @param {number} number - The value to set for this tuning parameter. + */ + b(number: number): void; + + /** + * A parameter that controls the speed at which a rise in term frequency results in term + * frequency saturation. The default value is 1.2. Setting this to a higher value will give + * slower saturation levels, a lower value will result in quicker saturation. + * + * @param {number} number - The value to set for this tuning parameter. + */ + k1(number: number): void; + + /** + * Adds a document to the index. + * + * Before adding fields to the index the index should have been fully setup, with the document + * ref and all fields to index already having been specified. + * + * The document must have a field name as specified by the ref (by default this is 'id') and + * it should have all fields defined for indexing, though null or undefined values will not + * cause errors. + * + * @param {object} doc - The document to add to the index. + */ + add(doc: object): void; + + /** + * Builds the index, creating an instance of lunr.Index. + * + * This completes the indexing process and should only be called + * once all documents have been added to the index. + * + * @returns {lunr.Index} + */ + build(): Index; + + /** + * Applies a plugin to the index builder. + * + * A plugin is a function that is called with the index builder as its context. + * Plugins can be used to customise or extend the behaviour of the index + * in some way. A plugin is just a function, that encapsulated the custom + * behaviour that should be applied when building the index. + * + * The plugin function will be called with the index builder as its argument, additional + * arguments can also be passed when calling use. The function will be called + * with the index builder as its context. + * + * @param {Function} plugin The plugin to apply. + */ + use(plugin: Builder.Plugin, ...args: any[]): void; + } + + namespace Index { + interface Attributes { + /** + * An index of term/field to document reference. + */ + invertedIndex: object; + /** + * Document vectors keyed by document reference. + */ + documentVectors: { [docRef: string]: Vector }; + /** + * An set of all corpus tokens. + */ + tokenSet: TokenSet; + /** + * The names of indexed document fields. + */ + fields: string[]; + /** + * The pipeline to use for search terms. + */ + pipeline: Pipeline; + } + + /** + * A result contains details of a document matching a search query. + */ + interface Result { + /** + * The reference of the document this result represents. + */ + ref: string; + + /** + * A number between 0 and 1 representing how similar this document is to the query. + */ + score: number; + + /** + * Contains metadata about this match including which term(s) caused the match. + */ + matchData: MatchData; + } + + /** + * A query builder callback provides a query object to be used to express + * the query to perform on the index. + * + * @callback lunr.Index~queryBuilder + * @param {lunr.Query} query - The query object to build up. + * @this lunr.Query + */ + type QueryBuilder = (this: Query, query: Query) => void; + + /** + * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple + * query language which itself is parsed into an instance of lunr.Query. + * + * For programmatically building queries it is advised to directly use lunr.Query, the query language + * is best used for human entered text rather than program generated text. + * + * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported + * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello' + * or 'world', though those that contain both will rank higher in the results. + * + * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can + * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding + * wildcards will increase the number of documents that will be found but can also have a negative + * impact on query performance, especially with wildcards at the beginning of a term. + * + * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term + * hello in the title field will match this query. Using a field not present in the index will lead + * to an error being thrown. + * + * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term + * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported + * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2. + * Avoid large values for edit distance to improve query performance. + * + * To escape special characters the backslash character '\' can be used, this allows searches to include + * characters that would normally be considered modifiers, e.g. `foo\~2` will search for a term "foo~2" instead + * of attempting to apply a boost of 2 to the search term "foo". + * + * @example Simple single term query + * hello + * @example Multiple term query + * hello world + * @example term scoped to a field + * title:hello + * @example term with a boost of 10 + * hello^10 + * @example term with an edit distance of 2 + * hello~2 + */ + type QueryString = string; + } + + /** + * An index contains the built index of all documents and provides a query interface + * to the index. + * + * Usually instances of lunr.Index will not be created using this constructor, instead + * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be + * used to load previously built and serialized indexes. + */ + class Index { + /** + * @param attrs The attributes of the built search index. + */ + constructor(attrs: Index.Attributes) + + /** + * Performs a search against the index using lunr query syntax. + * + * Results will be returned sorted by their score, the most relevant results + * will be returned first. + * + * For more programmatic querying use lunr.Index#query. + * + * @param {lunr.Index~QueryString} queryString - A string containing a lunr query. + * @throws {lunr.QueryParseError} If the passed query string cannot be parsed. + * @returns {lunr.Index~Result[]} + */ + search(queryString: Index.QueryString): Index.Result[]; + + /** + * Performs a query against the index using the yielded lunr.Query object. + * + * If performing programmatic queries against the index, this method is preferred + * over lunr.Index#search so as to avoid the additional query parsing overhead. + * + * A query object is yielded to the supplied function which should be used to + * express the query to be run against the index. + * + * Note that although this function takes a callback parameter it is _not_ an + * asynchronous operation, the callback is just yielded a query object to be + * customized. + * + * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query. + * @returns {lunr.Index~Result[]} + */ + query(fn: Index.QueryBuilder): Index.Result; + + /** + * Prepares the index for JSON serialization. + * + * The schema for this JSON blob will be described in a + * separate JSON schema file. + * + * @returns {Object} + */ + toJSON(): object; + + /** + * Loads a previously serialized lunr.Index + * + * @param {Object} serializedIndex - A previously serialized lunr.Index + * @returns {lunr.Index} + */ + static load(serializedIndex: object): Index; + } + + /** + * Contains and collects metadata about a matching document. + * A single instance of lunr.MatchData is returned as part of every + * lunr.IndexResult. + */ + class MatchData { + /** + * A cloned collection of metadata associated with this document. + */ + metadata: object; + + /** + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + */ + constructor(term: string, field: string, metadata: object) + + /** + * An instance of lunr.MatchData will be created for every term that matches a + * document. However only one instance is required in a lunr.Index~Result. This + * method combines metadata from another instance of lunr.MatchData with this + * objects metadata. + * + * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one. + * @see {@link lunr.Index~Result} + */ + combine(otherMatchData: MatchData): void; + } + + /** + * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token + * string as well as all known metadata. A pipeline function can mutate the token string + * or mutate (or add) metadata for a given token. + * + * A pipeline function can indicate that the passed token should be discarded by returning + * null. This token will not be passed to any downstream pipeline functions and will not be + * added to the index. + * + * Multiple tokens can be returned by returning an array of tokens. Each token will be passed + * to any downstream pipeline functions and all will returned tokens will be added to the index. + * + * Any number of pipeline functions may be chained together using a lunr.Pipeline. + * + * @interface lunr.PipelineFunction + * @param {lunr.Token} token - A token from the document being processed. + * @param {number} i - The index of this token in the complete list of tokens for this document/field. + * @param {lunr.Token[]} tokens - All tokens for this document/field. + * @returns {(?lunr.Token|lunr.Token[])} + */ + type PipelineFunction = ( + token: Token, + i: number, + tokens: Token[] + ) => null | Token | Token[]; + + /** + * lunr.Pipelines maintain an ordered list of functions to be applied to all + * tokens in documents entering the search index and queries being ran against + * the index. + * + * An instance of lunr.Index created with the lunr shortcut will contain a + * pipeline with a stop word filter and an English language stemmer. Extra + * functions can be added before or after either of these functions or these + * default functions can be removed. + * + * When run the pipeline will call each function in turn, passing a token, the + * index of that token in the original list of all tokens and finally a list of + * all the original tokens. + * + * The output of functions in the pipeline will be passed to the next function + * in the pipeline. To exclude a token from entering the index the function + * should return undefined, the rest of the pipeline will not be called with + * this token. + * + * For serialisation of pipelines to work, all functions used in an instance of + * a pipeline should be registered with lunr.Pipeline. Registered functions can + * then be loaded. If trying to load a serialised pipeline that uses functions + * that are not registered an error will be thrown. + * + * If not planning on serialising the pipeline then registering pipeline functions + * is not necessary. + */ + class Pipeline { + constructor() + + /** + * Register a function with the pipeline. + * + * Functions that are used in the pipeline should be registered if the pipeline + * needs to be serialised, or a serialised pipeline needs to be loaded. + * + * Registering a function does not add it to a pipeline, functions must still be + * added to instances of the pipeline for them to be used when running a pipeline. + * + * @param {lunr.PipelineFunction} fn - The function to check for. + * @param {String} label - The label to register this function with + */ + static registerFunction(fn: PipelineFunction, label: string): void; + + /** + * Loads a previously serialised pipeline. + * + * All functions to be loaded must already be registered with lunr.Pipeline. + * If any function from the serialised data has not been registered then an + * error will be thrown. + * + * @param {Object} serialised - The serialised pipeline to load. + * @returns {lunr.Pipeline} + */ + static load(serialised: object): Pipeline; + + /** + * Adds new functions to the end of the pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline. + */ + add(...functions: PipelineFunction[]): void; + + /** + * Adds a single function after a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ + after(existingFn: PipelineFunction, newFn: PipelineFunction): void; + + /** + * Adds a single function before a function that already exists in the + * pipeline. + * + * Logs a warning if the function has not been registered. + * + * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline. + * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline. + */ + before(existingFn: PipelineFunction, newFn: PipelineFunction): void; + + /** + * Removes a function from the pipeline. + * + * @param {lunr.PipelineFunction} fn The function to remove from the pipeline. + */ + remove(fn: PipelineFunction): void; + + /** + * Runs the current list of functions that make up the pipeline against the + * passed tokens. + * + * @param {Array} tokens The tokens to run through the pipeline. + * @returns {Array} + */ + run(tokens: Token[]): Token[]; + + /** + * Convenience method for passing a string through a pipeline and getting + * strings out. This method takes care of wrapping the passed string in a + * token and mapping the resulting tokens back to strings. + * + * @param {string} str - The string to pass through the pipeline. + * @returns {string[]} + */ + runString(str: string): string[]; + + /** + * Resets the pipeline by removing any existing processors. + * + */ + reset(): void; + + /** + * Returns a representation of the pipeline ready for serialisation. + * + * Logs a warning if the function has not been registered. + * + * @returns {Array} + */ + toJSON(): PipelineFunction[]; + } + + namespace Query { + enum wildcard { + NONE = 0, + LEADING = 1 << 0, + TRAILING = 1 << 1 + } + + /** + * A single clause in a {@link lunr.Query} contains a term and details on how to + * match that term against a {@link lunr.Index}. + * + * @typedef {Object} lunr.Query~Clause + * @property {string[]} fields - The fields in an index this clause should be matched against. + * @property {number} [boost=1] - Any boost that should be applied when matching this clause. + * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be. + * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline. + * @property {number} [wildcard=0] - Whether the term should have wildcards appended or prepended. + */ + interface Clause { + fields: string[]; + boost: number; + editDistance: number; + usePipeline: boolean; + wildcard: number; + } + } + + /** + * A lunr.Query provides a programmatic way of defining queries to be performed + * against a {@link lunr.Index}. + * + * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method + * so the query object is pre-initialized with the right index fields. + * + * @property {lunr.Query~Clause[]} clauses - An array of query clauses. + * @property {string[]} allFields - An array of all available fields in a lunr.Index. + */ + class Query { + /** + * An array of query clauses. + */ + clauses: Query.Clause[]; + + /** + * An array of all available fields in a lunr.Index. + */ + allFields: string[]; + + /** + * @param allFields An array of all available fields in a lunr.Index. + */ + constructor(allFields: string[]) + + /** + * Adds a {@link lunr.Query~Clause} to this query. + * + * Unless the clause contains the fields to be matched all fields will be matched. In addition + * a default boost of 1 is applied to the clause. + * + * @param {lunr.Query~Clause} clause - The clause to add to this query. + * @see lunr.Query~Clause + * @returns {lunr.Query} + */ + clause(clause: Query.Clause): Query; + + /** + * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause} + * to the list of clauses that make up this query. + * + * @param {string} term - The term to add to the query. + * @param {Object} [options] - Any additional properties to add to the query clause. + * @returns {lunr.Query} + * @see lunr.Query#clause + * @see lunr.Query~Clause + * @example adding a single term to a query + * query.term("foo") + * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard + * query.term("foo", { + * fields: ["title"], + * boost: 10, + * wildcard: lunr.Query.wildcard.TRAILING + * }) + */ + term(term: string, options: object): Query; + } + + class QueryParseError extends Error { + name: "QueryParseError"; + message: string; + start: number; + end: number; + + constructor(message: string, start: string, end: string) + } + + /** + * lunr.stemmer is an english language stemmer, this is a JavaScript + * implementation of the PorterStemmer taken from http://tartarus.org/~martin + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token - The string to stem + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + */ + function stemmer(token: Token): Token; + + /** + * lunr.stopWordFilter is an English language stop word list filter, any words + * contained in the list will not be passed through the filter. + * + * This is intended to be used in the Pipeline. If the token does not pass the + * filter then undefined will be returned. + * + * @implements {lunr.PipelineFunction} + * @params {lunr.Token} token - A token to check for being a stop word. + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + */ + function stopWordFilter(token: Token): Token; + + namespace Token { + /** + * A token update function is used when updating or optionally + * when cloning a token. + * + * @callback lunr.Token~updateFunction + * @param {string} str - The string representation of the token. + * @param {Object} metadata - All metadata associated with this token. + */ + type UpdateFunction = (str: string, metadata: object) => void; + } + + /** + * A token wraps a string representation of a token + * as it is passed through the text processing pipeline. + */ + class Token { + /** + * @param {string} [str=''] - The string token being wrapped. + * @param {object} [metadata={}] - Metadata associated with this token. + */ + constructor(str: string, metadata: object) + + /** + * Returns the token string that is being wrapped by this object. + * + * @returns {string} + */ + toString(): string; + + /** + * Applies the given function to the wrapped string token. + * + * @example + * token.update(function (str, metadata) { + * return str.toUpperCase() + * }) + * + * @param {lunr.Token~updateFunction} fn - A function to apply to the token string. + * @returns {lunr.Token} + */ + update(fn: Token.UpdateFunction): Token; + + /** + * Creates a clone of this token. Optionally a function can be + * applied to the cloned token. + * + * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token. + * @returns {lunr.Token} + */ + clone(fn: Token.UpdateFunction): Token; + } + + /** + * A token set is used to store the unique list of all tokens + * within an index. Token sets are also used to represent an + * incoming query to the index, this query token set and index + * token set are then intersected to find which tokens to look + * up in the inverted index. + * + * A token set can hold multiple tokens, as in the case of the + * index token set, or it can hold a single token as in the + * case of a simple query token set. + * + * Additionally token sets are used to perform wildcard matching. + * Leading, contained and trailing wildcards are supported, and + * from this edit distance matching can also be provided. + * + * Token sets are implemented as a minimal finite state automata, + * where both common prefixes and suffixes are shared between tokens. + * This helps to reduce the space used for storing the token set. + */ + class TokenSet { + constructor() + + /** + * Creates a TokenSet instance from the given sorted array of words. + * + * @param {String[]} arr - A sorted array of strings to create the set from. + * @returns {lunr.TokenSet} + * @throws Will throw an error if the input array is not sorted. + */ + fromArray(arr: string[]): TokenSet; + + /** + * Creates a token set representing a single string with a specified + * edit distance. + * + * Insertions, deletions, substitutions and transpositions are each + * treated as an edit distance of 1. + * + * Increasing the allowed edit distance will have a dramatic impact + * on the performance of both creating and intersecting these TokenSets. + * It is advised to keep the edit distance less than 3. + * + * @param {string} str - The string to create the token set from. + * @param {number} editDistance - The allowed edit distance to match. + * @returns {lunr.Vector} + */ + fromFuzzyString(str: string, editDistance: number): Vector; + + /** + * Creates a TokenSet from a string. + * + * The string may contain one or more wildcard characters (*) + * that will allow wildcard matching when intersecting with + * another TokenSet. + * + * @param {string} str - The string to create a TokenSet from. + * @returns {lunr.TokenSet} + */ + fromString(str: string): TokenSet; + + /** + * Converts this TokenSet into an array of strings + * contained within the TokenSet. + * + * @returns {string[]} + */ + toArray(): string[]; + + /** + * Generates a string representation of a TokenSet. + * + * This is intended to allow TokenSets to be used as keys + * in objects, largely to aid the construction and minimisation + * of a TokenSet. As such it is not designed to be a human + * friendly representation of the TokenSet. + * + * @returns {string} + */ + toString(): string; + + /** + * Returns a new TokenSet that is the intersection of + * this TokenSet and the passed TokenSet. + * + * This intersection will take into account any wildcards + * contained within the TokenSet. + * + * @param {lunr.TokenSet} b - An other TokenSet to intersect with. + * @returns {lunr.TokenSet} + */ + intersect(b: TokenSet): TokenSet; + } + + namespace tokenizer { + /** + * The separator used to split a string into tokens. Override this property to change the behaviour of + * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens. + * + * @static + * @see lunr.tokenizer + */ + const separator: RegExp; + } + + /** + * A function for splitting a string into tokens ready to be inserted into + * the search index. Uses `lunr.tokenizer.separator` to split strings, change + * the value of this property to change how strings are split into tokens. + * + * This tokenizer will convert its parameter to a string by calling `toString` and + * then will split this string on the character in `lunr.tokenizer.separator`. + * Arrays will have their elements converted to strings and wrapped in a lunr.Token. + * + * @static + * @param {?(string|object|object[])} obj - The object to convert into tokens + * @returns {lunr.Token[]} + */ + function tokenizer(obj?: null | string | object | object[]): Token[]; + + /** + * lunr.trimmer is a pipeline function for trimming non word + * characters from the beginning and end of tokens before they + * enter the index. + * + * This implementation may not work correctly for non latin + * characters and should either be removed or adapted for use + * with languages with non-latin characters. + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token The token to pass through the filter + * @returns {lunr.Token} + * @see lunr.Pipeline + */ + function trimmer(token: Token): Token; + + /** + * A namespace containing utils for the rest of the lunr library + */ + namespace utils { + /** + * Print a warning message to the console. + * + * @param {String} message The message to be printed. + * @memberOf Utils + */ + function warn(message: string): void; + + /** + * Convert an object to a string. + * + * In the case of `null` and `undefined` the function returns + * the empty string, in all other cases the result of calling + * `toString` on the passed object is returned. + * + * @param {Any} obj The object to convert to a string. + * @return {String} string representation of the passed object. + * @memberOf Utils + */ + function asString(obj: any): string; + } + + /** + * A vector is used to construct the vector space of documents and queries. These + * vectors support operations to determine the similarity between two documents or + * a document and a query. + * + * Normally no parameters are required for initializing a vector, but in the case of + * loading a previously dumped vector the raw elements can be provided to the constructor. + * + * For performance reasons vectors are implemented with a flat array, where an elements + * index is immediately followed by its value. E.g. [index, value, index, value]. This + * allows the underlying array to be as sparse as possible and still offer decent + * performance when being used for vector calculations. + */ + class Vector { + /** + * @param {Number[]} [elements] - The flat list of element index and element value pairs. + */ + constructor(elements: number[]) + + /** + * Calculates the position within the vector to insert a given index. + * + * This is used internally by insert and upsert. If there are duplicate indexes then + * the position is returned as if the value for that index were to be updated, but it + * is the callers responsibility to check whether there is a duplicate at that index + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @returns {Number} + */ + positionForIndex(index: number): number; + + /** + * Inserts an element at an index within the vector. + * + * Does not allow duplicates, will throw an error if there is already an entry + * for this index. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + */ + insert(insertIdx: number, val: number): void; + + /** + * Inserts or updates an existing index within the vector. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + * @param {function} fn - A function that is called for updates, the existing value and the + * requested value are passed as arguments + */ + upsert( + insertIdx: number, + val: number, + fn: (existingVal: number, val: number) => number + ): void; + + /** + * Calculates the magnitude of this vector. + * + * @returns {Number} + */ + magnitude(): number; + + /** + * Calculates the dot product of this vector and another vector. + * + * @param {lunr.Vector} otherVector - The vector to compute the dot product with. + * @returns {Number} + */ + dot(otherVector: Vector): number; + + /** + * Calculates the cosine similarity between this vector and another + * vector. + * + * @param {lunr.Vector} otherVector - The other vector to calculate the + * similarity with. + * @returns {Number} + */ + similarity(otherVector: Vector): number; + + /** + * Converts the vector to an array of the elements within the vector. + * + * @returns {Number[]} + */ + toArray(): number[]; + + /** + * A JSON serializable representation of the vector. + * + * @returns {Number[]} + */ + toJSON(): number[]; + } + + const version: string; + type ConfigFunction = (this: Builder, builder: Builder) => void; +} + +/** + * Convenience function for instantiating a new lunr index and configuring it with the default + * pipeline functions and the passed config function. + * + * When using this convenience function a new index will be created with the following functions + * already in the pipeline: + * + * * lunr.StopWordFilter - filters out any stop words before they enter the index + * + * * lunr.stemmer - stems the tokens before entering the index. + * + * Example: + * + * ```javascript + * var idx = lunr(function () { + * this.field('title', 10); + * this.field('tags', 100); + * this.field('body'); + * + * this.ref('cid'); + * + * this.pipeline.add(function () { + * // some custom pipeline function + * }); + * }); + * ``` + */ +declare function lunr(config: lunr.ConfigFunction): lunr.Index; + +declare module "lunr" { + export = lunr; +} diff --git a/types/lunr/lunr-tests.ts b/types/lunr/lunr-tests.ts new file mode 100644 index 0000000000..6b6fef9fd4 --- /dev/null +++ b/types/lunr/lunr-tests.ts @@ -0,0 +1,35 @@ +import * as lunr from 'lunr'; + +function basic_test() { + const index = lunr(function() { + this.field("title"); + this.field("body"); + this.ref("id"); + this.add({ + id: 1, + title: "Foo", + body: "Foo foo foo!" + }); + this.add({ + id: 2, + title: "Bar", + body: "Bar bar bar!" + }); + }); + + index.search("foo"); +} + +function pipeline_test() { + const index = lunr(function() { + this.pipeline.add(function(token, tokenIndex, tokens) { + // text processing in here + return token; + }); + + this.pipeline.after(lunr.stopWordFilter, function(token, tokenIndex, tokens) { + // text processing in here + return token; + }); + }); +} diff --git a/types/lunr/tsconfig.json b/types/lunr/tsconfig.json new file mode 100644 index 0000000000..22fad6449b --- /dev/null +++ b/types/lunr/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "lunr-tests.ts" + ] +} \ No newline at end of file diff --git a/types/lunr/tslint.json b/types/lunr/tslint.json new file mode 100644 index 0000000000..a6eeebd3be --- /dev/null +++ b/types/lunr/tslint.json @@ -0,0 +1,9 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "ban-types": false, + "only-arrow-functions": [false], + "no-single-declare-module": false, + "no-unnecessary-qualifier": true + } +} \ No newline at end of file