@saplingai/sapling-js 1.0.1 → 1.0.5

package/README.md

@@ -2,19 +2,23 @@
 
 Node.js client for the [Sapling.ai API](https://sapling.ai/api).
 
-Here's a [grammar check demo](https://sapling.ai/grammar-check).
+Try out a [grammar check demo](https://sapling.ai/grammar-check).
+Compare against grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
 
-Sapling Features:
+Functionality
 --------
 
-Sapling is an AI Writing Assistant offering spelling and grammar checker capabilities. Compare against grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
+Sapling is an AI messaging assistant.
+The API currently offers spelling and grammar checking endpoints.
 
+Benefits include:
 - **60% more grammar corrections**: compared to [other systems](https://sapling.ai/comparison/api) at similar accuracy using state-of-the-art machine learning systems for natural language processing.
 - **Low Latency**: Achieve the same real-time performance that users of Sapling's own interface experience.
 - **Over 20 error types**: Error categories such as preposition, noun form, and verb tense, including both high-level and fine-grained error information.
 - **Custom Models**: Get corrections and edits tuned to the domain of your text—for example academic writing vs. subtitles.
-- **Enterprise Security**: Ask us about our no data rention policies, [self-hosted/on-premise](https://sapling.ai/onprem) deployment options, and other [cybersecurity policies and procedures](https://sapling.ai/security).
-- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others.
+- **Enterprise Security**: Contact us for our no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and other [cybersecurity policies and procedures](https://sapling.ai/security).
+- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others. Consider using [Sapling's JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for displaying the API's outputs on webpage editors.
+
 
 
 Installation
@@ -22,8 +26,8 @@ Installation
 
 `npm install @saplingai/sapling-js`
 
-- Register for an account at [Sapling.ai](https://sapling.ai).
-- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings)
+- Register for an account at [Sapling.ai](https://sapling.ai/user/register).
+- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
 
 
 Quickstart - Backend
@@ -48,7 +52,7 @@ Quickstart - Frontend
 
 The SDK provides a way to automatically apply edit suggestions to any HTML contenteditable and textarea elements.
 
-Do not serve a page like this publicly, as it exposes the API key. See documentation [Deploying to Production](https://sapling.ai/docs/sdk/quickstart#deploying-to-production) for an example of setting up the API key in a backend environment.
+Do **not** serve a page like this publicly, as it exposes the API key. See documentation [Deploying to Production](https://sapling.ai/docs/sdk/quickstart#deploying-to-production) for an example of setting up the API key with a separate backend environment.
 
 ```javscript
 import { useEffect } from 'react';
@@ -78,10 +82,10 @@ function App() {
 ```
 
 
-[Documentation](https://sapling.ai/docs)
+Documentation
 -------------
 
-- Javascript/HTML [sample code](https://github.com/saplingai/sapling-samples/tree/master/javscript)
-- Complete Sapling SDK and HTTP API [documentation](https://sapling.ai/docs).
-- More information on [request options and response structure](https://sapling.ai/docs/api/edits-overview)
+- Complete Sapling HTTP API and SDK [documentation](https://sapling.ai/docs).
 - Get a production key by following [these instructions](https://sapling.ai/docs/api/api-access).
+- JavaScript, HTML, and Python [starter code](https://github.com/saplingai/sapling-samples).
+- More information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).

package/index.d.ts

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

package/index.ts

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

package/observer/index.d.ts

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

package/observer/index.ts

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

package/package.json

@@ -1,27 +1,41 @@
 {
   "name": "@saplingai/sapling-js",
-  "version": "1.0.1",
-  "description": "Grammar/spell checker for text/writing using the Sapling API",
-  "type":"module",
+  "version": "1.0.5",
+  "description": "JavaScript library for using the Sapling.ai API.",
+  "type": "module",
   "dependencies": {
     "axios": "^0.26.1",
     "uuid": "^8.3.2"
   },
   "main": "./sapling/client.js",
+  "types": "./sapling/client.d.ts",
   "author": "Sapling Intelligence",
   "email": "info@sapling.ai",
   "url": "https://sapling.ai",
   "homepage": "https://sapling.ai/docs/",
   "repository": {
     "type": "git",
-    "url": "https://github.com/james-huang/sapling-samples.git"
+    "url": "https://github.com/saplingai/sapling-samples.git"
   },
   "bugs": {
-    "url" : "https://github.com/saplingai/sapling-samples/issues",
-    "email" : "support@sapling.ai"
+    "url": "https://github.com/saplingai/sapling-samples/issues",
+    "email": "support@sapling.ai"
   },
+  "license": "Apache-2.0",
+  "licenses": [
+    {
+      "type": "Apache-2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0"
+    }
+  ],
   "exports": {
-    "./client": "./sapling/client.js",
-    "./observer": "./sapling/observer.js"
+    "./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

@@ -0,0 +1,20 @@
+import { AxiosResponse } from "axios";
+
+type ConstructorOptions = {
+   timeout?: number,
+   hostname?: string,
+   pathname?: string,
+}
+
+type EditOptions = {
+   variety?: string,
+   autoApply?: boolean,
+}
+
+declare class Client {
+  constructor(apiKey: string, options?: ConstructorOptions);
+
+  edits(text: string, sessionId: string, options?: EditOptions):  Promise<AxiosResponse>;
+  accept(editUUID: string, sessionId: string): void;
+  reject(editUUID: string, sessionId: string): void;
+}

package/sapling/observer.d.ts

@@ -0,0 +1,20 @@
+type InitSettings = {
+   endpointHostname?: string,
+   editPathname?: string,
+   completePathname?: string,
+   statusBadge?: boolean,
+   lang?: string,
+   autocomplete?: boolean,
+   mode?: string,
+   key?: string,
+   variety?: string,
+}
+
+interface SaplingInterface {
+  init(settings: InitSettings): void;
+  observe(elem: HTMLElement): void;
+  unobserve(elem: HTMLElement): void;
+  checkOnce(elem: HTMLElement): void;
+}
+
+export const Sapling: SaplingInterface;

package/sapling/observer.js

@@ -1,3 +1,3 @@
-import { SaplingModule } from './sapling-sdk-v1.0.1.min.js';
+import { SaplingModule } from './sapling-sdk-v1.0.2.min.js';
 
 export const Sapling = SaplingModule.SaplingModule;