wink-nlp - npm Package Compare versions

Comparing version 1.8.1 to 1.9.0

.nyc_output/processinfo/index.json

@@ -1,1 +0,1 @@
-{"processes":{"e955a9cd-7aab-48de-8a85-b2028f7c3144":{"parent":null,"children":[]}},"files":{"/Users/neilsbohr/dev/winkjs/wink-nlp/src/wink-nlp.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/dd-wrapper.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/constants.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/doc-v2.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-entities.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/locate.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/get-parent-item.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/search.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-get-item.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-get-item.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-each.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-each.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-filter.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-filter.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-token-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/its.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/sort4FT.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/allowed.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/as.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-markings.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-tokens-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-tokens-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-entity-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-entities-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-entities-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-sentence-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-sentences-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-document-out.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/print-tokens.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/cache.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokenizer.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/recursive-tokenizer.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compile-trex.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokens-mappers.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/examples-compiler.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/automaton.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compose-patterns.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/helper.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/bm25-vectorizer.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/allowed.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/similarity.js":["e955a9cd-7aab-48de-8a85-b2028f7c3144"]},"externalIds":{}}
+{"processes":{"f2a3a9a2-3ac8-4f39-9736-44049045f081":{"parent":null,"children":[]}},"files":{"/Users/neilsbohr/dev/winkjs/wink-nlp/src/wink-nlp.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/dd-wrapper.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/constants.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/doc-v2.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-entities.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/locate.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/get-parent-item.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/search.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-get-item.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-get-item.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-each.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-each.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-filter.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-filter.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-token-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/its.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/sort4FT.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/allowed.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/as.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/contained-markings.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-tokens-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-tokens-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-entity-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-entities-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/sel-entities-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-sentence-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/col-sentences-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/itm-document-out.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/api/print-tokens.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/cache.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokenizer.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/recursive-tokenizer.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compile-trex.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/tokens-mappers.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/examples-compiler.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/automaton.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/compose-patterns.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/src/helper.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/bm25-vectorizer.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/allowed.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"],"/Users/neilsbohr/dev/winkjs/wink-nlp/utilities/similarity.js":["f2a3a9a2-3ac8-4f39-9736-44049045f081"]},"externalIds":{}}

CHANGELOG.md

@@ -0,1 +1,10 @@
+# [Enhancing Typescript support](https://github.com/winkjs/wink-nlp/releases/tag/1.9.0)
+## Version 1.9.0 November 06, 2021
+
+### ✨ Features
+- We have enhanced typescript support to allow easy addition of new typescript enabled language models. 👏
+
+### ⚙️ Updates
+- Added naive wikification showcase in README. 😎
+
 # [Operational update](https://github.com/winkjs/wink-nlp/releases/tag/1.8.1)
@@ -2,0 +11,0 @@ ## Version 1.8.1 September 22, 2021

package.json

 {
   "name": "wink-nlp",
-  "version": "1.8.1",
-  "description": "Developer friendly NLP ✨",
+  "version": "1.9.0",
+  "description": "Developer friendly Natural Language Processing ✨",
   "keywords": [
     "NLP",
+    "natural language processing",
     "tokenize",
@@ -23,2 +24,3 @@ "SBD",
     "winkNLP",
+    "winkjs",
     "wink"
@@ -25,0 +27,0 @@ ],

README.md

@@ -5,3 +5,3 @@ # winkNLP
 
-## Developer friendly NLP ✨
+## Developer friendly Natural Language Processing ✨
 [<img align="right" src="https://decisively.github.io/wink-logos/logo-title.png" width="100px" >](https://winkjs.org/)
@@ -15,3 +15,3 @@
 ## Features
-WinkNLP has a comprehensive processing pipeline covering tokenization, sentence boundary detection (sbd), negation handling, sentiment analysis, part-of-speech (pos) tagging, named entity recognition (ner), custom entities recognition (cer):
+WinkNLP has a comprehensive natural language processing (NLP) pipeline covering tokenization, sentence boundary detection (sbd), negation handling, sentiment analysis, part-of-speech (pos) tagging, named entity recognition (ner), custom entities recognition (cer):
 
@@ -114,4 +114,4 @@ <img src="https://winkjs.org/images/wink-nlp-processing-pipeline.png" alt="Processing pipeline: text, tokenization, SBD, negation, sentiment, NER, POS, CER" title="WinkNLP processing pipeline">
 
-#### [Hashtag Sentiment](https://winkjs.org/showcase-hashtag/) 🎭
-Analyzes sentiments of recent tweets containing the given hashtag.
+#### [Naive Wikification Tool](https://observablehq.com/@winkjs/how-to-build-a-naive-wikification-tool) 🔗
+Links entities such as famous persons, locations or objects to the relevant Wikipedia pages.
 
@@ -118,0 +118,0 @@

types/index.d.ts

 // Minimum TypeScript Version: 4.0
 
-declare module 'wink-eng-lite-web-model' {
+declare module 'wink-nlp' {
   // turn off exporting by default since we don't want to expose internal details
-  export {};
+  export { };
 
-  export type ModelAddons = unknown;
+  // these types are internal details of the implementing model
+  type StemAddon = unknown;
+  type LemmatizeAddon = unknown;
+  type ReadabilityStatsAddon = unknown;
+  type WordVectorsAddon = unknown;
 
+  // optional addons that some language models may have
+  export interface ModelAddons {
+    stem?: StemAddon;
+    lemmatize?: LemmatizeAddon;
+    readabilityStats?: ReadabilityStatsAddon;
+    wordVectors?: WordVectorsAddon;
+  }
+
+  // these types are internal details of the implementing model
+  type CoreModel = unknown;
+  type SBDModel = unknown;
+  type POSModel = unknown;
+  type NERModel = unknown;
+  type NEGATIONModel = unknown;
+  type SAModel = unknown;
+  type CERMetaModel = unknown;
+  type FeatureFn = unknown;
+
+  // A language model
   export interface Model {
+    core: CoreModel;
+    sbd: SBDModel;
+    pos: POSModel;
+    ner: NERModel;
+    negation: NEGATIONModel;
+    sa: SAModel;
+    metaCER: CERMetaModel;
+    featureFn: FeatureFn;
     addons: ModelAddons;
   }
 
-  const model: Model;
-  export default model;
-}
-
-declare module 'wink-nlp' {
-  // turn off exporting by default since we don't want to expose internal details
-  export {};
-
-  import { Model, ModelAddons } from 'wink-eng-lite-web-model';
-
   // its helpers
@@ -284,3 +305,3 @@
   // turn off exporting by default since we don't want to expose internal details
-  export {};
+  export { };
 
@@ -311,3 +332,3 @@ import { Tokens, Document, ItsFunction } from 'wink-nlp';
   // turn off exporting by default since we don't want to expose internal details
-  export {};
+  export { };
 
@@ -314,0 +335,0 @@ import { Bow } from 'wink-nlp';

types/test.ts

 import winkNlp, {
+  Model,
   Sentences,
@@ -17,4 +18,6 @@ CustomEntities,
 } from 'wink-nlp';
-import model from 'wink-eng-lite-web-model';
 
+// dummy model to test with
+const model = ({} as any) as Model;
+
 // $ExpectType WinkMethods
@@ -21,0 +24,0 @@ winkNlp(model);

No alert changes

Improved metrics

Total package byte prevSize

544415

increased by0.22%

Lines of code

5837

increased by0.41%

No dependency changes