@saplingai/sapling-js 1.0.37 → 1.0.39

package/client/index.d.ts

@@ -0,0 +1 @@
+export * from '../sapling/client';

package/package.json

@@ -1,24 +1,54 @@
 {
   "name": "@saplingai/sapling-js",
-  "version": "1.0.37",
+  "version": "1.0.39",
   "description": "JavaScript library for using the Sapling.ai API.",
   "type": "module",
+  "main": "./sapling/client.js",
+  "types": "./sapling/client.d.ts",
+  "exports": {
+    ".": {
+      "types": "./sapling/client.d.ts",
+      "default": "./sapling/client.js"
+    },
+    "./client": {
+      "types": "./sapling/client.d.ts",
+      "default": "./sapling/client.js"
+    },
+    "./observer": {
+      "types": "./sapling/observer.d.ts",
+      "default": "./sapling/observer.js"
+    }
+  },
+  "files": [
+    "sapling",
+    "client",
+    "observer",
+    "index.ts",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "node --test test/client.test.js test/pack.test.js",
+    "prepublishOnly": "npm test"
+  },
   "dependencies": {
-    "axios": "^1.6.7",
+    "axios": "^1.19.0",
     "uuid": "^8.3.2"
   },
-  "main": "./sapling/client.js",
-  "types": "./sapling/client.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "author": "Sapling Intelligence",
   "email": "info@sapling.ai",
   "url": "https://sapling.ai",
   "homepage": "https://sapling.ai/docs/",
   "repository": {
     "type": "git",
-    "url": "https://github.com/saplingai/sapling-samples.git"
+    "url": "git+https://github.com/saplingai/sapling-js.git"
   },
   "bugs": {
-    "url": "https://github.com/saplingai/sapling-samples/issues",
+    "url": "https://github.com/saplingai/sapling-js/issues",
     "email": "support@sapling.ai"
   },
   "license": "Apache-2.0",
@@ -27,15 +57,5 @@
       "type": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0"
     }
-  ],
-  "exports": {
-    "./client": {
-      "types": "./sapling/client.d.ts",
-      "default": "./sapling/client.js"
-    },
-    "./observer": {
-      "types": "./sapling/observer.d.ts",
-      "default": "./sapling/observer.js"
-    }
-  }
+  ]
 }

package/sapling/client.d.ts

@@ -1,6 +1,6 @@
 import { AxiosResponse } from "axios";
 
-type AdvancedEditOptions = {
+export type AdvancedEditOptions = {
    advanced_edits?: boolean,
    adverbs?: boolean,
    simplifications?: boolean,
@@ -20,13 +20,13 @@ type AdvancedEditOptions = {
    violence?: boolean,
 }
 
-type ConstructorOptions = {
+export type ConstructorOptions = {
    timeout?: number,
    hostname?: string,
    pathname?: string,
 }
 
-type EditOptions = {
+export type EditOptions = {
    variety?: string,
    autoApply?: boolean,
    lang?: string,
@@ -34,11 +34,16 @@ type EditOptions = {
    advancedEdits?: AdvancedEditOptions,
 }
 
-type AIDetectOptions = {
+export type AIDetectOptions = {
    sent_scores?: boolean,
 }
 
-type SpellcheckOptions = {
+export type LangdetectOptions = {
+   top_k?: number,
+   segments?: boolean,
+}
+
+export type SpellcheckOptions = {
    minLength?: number,
    multipleEdits?: boolean,
    lang?: string,
@@ -47,18 +52,24 @@ type SpellcheckOptions = {
    userData?: any,
 }
 
-declare class Client {
+export type UserDetails = {
+   userId?: string,
+   anonUser?: boolean,
+}
+
+export declare class Client {
    constructor(apiKey: string, options?: ConstructorOptions);
 
-   edits(text: string, sessionId: string, options?: EditOptions): Promise<AxiosResponse>;
-   acceptEdit(editUUID: string, sessionId: string): Promise<AxiosResponse>;
-   rejectEdit(editUUID: string, sessionId: string): Promise<AxiosResponse>;
+   edits(text: string, sessionId?: string, options?: EditOptions, userDetails?: UserDetails): Promise<AxiosResponse>;
+   acceptEdit(editUUID: string, sessionId?: string, userId?: string): Promise<AxiosResponse>;
+   rejectEdit(editUUID: string, sessionId?: string, userId?: string): Promise<AxiosResponse>;
 
-   spellcheck(text: string, sessionId: string, options?: SpellcheckOptions): Promise<AxiosResponse>;
+   spellcheck(text: string, sessionId?: string, options?: SpellcheckOptions, userDetails?: UserDetails): Promise<AxiosResponse>;
 
-   complete(query: string, sessionId: string): Promise<AxiosResponse>;
-   acceptComplete(completeUUID: string, query: string, completion: string, sessionId: string): Promise<AxiosResponse>;
+   complete(query: string, sessionId?: string): Promise<AxiosResponse>;
+   acceptComplete(completeUUID: string, query: string, completion: string, sessionId?: string): Promise<AxiosResponse>;
    tone(text: string): Promise<AxiosResponse>;
 
    aidetect(text: string, options?: AIDetectOptions): Promise<AxiosResponse>;
+   langdetect(text: string, options?: LangdetectOptions): Promise<AxiosResponse>;
 }

package/sapling/client.js

@@ -106,27 +106,27 @@ export class Client {
     }
 
     if (options.minLength != null) {
-      data.min_length = minLength;
+      data.min_length = options.minLength;
     }
 
     if (options.multipleEdits != null) {
-      data.multiple_edits = multipleEdits;
+      data.multiple_edits = options.multipleEdits;
     }
 
     if (options.lang != null) {
-      data.lang = lang;
+      data.lang = options.lang;
     }
 
     if (options.autoApply != null) {
-      data.auto_apply = autoApply;
+      data.auto_apply = options.autoApply;
     }
 
     if (options.variety != null) {
-      data.variety = variety;
+      data.variety = options.variety;
     }
 
     if (options.userData != null) {
-      data.user_data = userData;
+      data.user_data = options.userData;
     }
 
     if (userDetails) {
@@ -176,6 +176,24 @@ export class Client {
     return this.axiosPromise(url, 'post', data);
   }
 
+  langdetect(text, options = {}) {
+    const url = `${this.urlEndpoint}langdetect`;
+
+    let data = {
+      text,
+      key: this.apiKey,
+    }
+
+    if (options?.top_k != null) {
+      data.top_k = options.top_k;
+    }
+    if (options?.segments != null) {
+      data.segments = options.segments;
+    }
+
+    return this.axiosPromise(url, 'post', data);
+  }
+
   aidetect(text, options = {}) {
     const url = `${this.urlEndpoint}aidetect`;