@sajari/sdk-node - npm Package Compare versions

Comparing version 2.0.0-beta.7 to 4.0.0-alpha.1

package.json

 {
   "name": "@sajari/sdk-node",
-  "version": "2.0.0-beta.7",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "author": "Ben Hinchley <[e-mail]>",
+  "version": "4.0.0-alpha.1",
+  "repository": "[e-mail]:github.com/sajari/sdk-node.git",
+  "author": "Sajari Pty Ltd",
   "license": "MIT",
+  "main": "./build/src/index.js",
+  "types": "./build/src/index.d.ts",
   "files": [
     "README.md",
     "LICENSE",
-    "dist/",
-    "generated/"
+    "build/src",
+    "!build/src/**/*.map"
   ],
-  "engines": {
-    "node": ">= 10.0.0"
-  },
-  "scripts": {
-    "prebuild": "npm-run-all gen:useragent lint test",
-    "build": "tsc",
-    "fmt": "prettier --write --config .prettierrc.js \"{src/**/*,*.config,*.d,.*,package}.{js,ts,json}\"",
-    "lint": "tslint --fix -p tsconfig.json",
-    "type-check": "tsc --noEmit",
-    "pretest": "npm-run-all type-check",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "coverage": "jest --coverage",
-    "gen:proto": "node scripts/genproto",
-    "gen:useragent": "node scripts/genuseragent",
-    "docs": "typedoc ./src/index.ts --mode file --out ./docs --exclude \"**/*+(.test).ts\"",
-    "prepublishOnly": "npm-run-all build"
-  },
   "dependencies": {
-    "debug": "^4.1.1",
-    "deepmerge": "^4.0.0",
-    "grpc": "^1.22.2",
-    "protobufjs": "^6.8.8"
+    "request": "2.88.2",
+    "ts-node": "8.10.2"
   },
   "devDependencies": {
-    "@types/debug": "^4.1.4",
-    "@types/jest": "^24.0.15",
-    "globby": "^10.0.1",
-    "grpc-tools": "^1.8.0",
-    "jest": "^24.8.0",
-    "make-dir": "^3.0.0",
-    "npm-run-all": "^4.1.5",
-    "prettier": "^1.18.2",
-    "ts-jest": "^24.0.2",
-    "tslint": "^5.18.0",
-    "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.14.2",
-    "typescript": "^3.5.3"
+    "@types/node": "14.0.12",
+    "@types/request": "2.48.5",
+    "csv-parser": "^2.3.3",
+    "prettier": "2.0.5",
+    "rimraf": "^3.0.2",
+    "typescript": "3.9.5"
+  },
+  "scripts": {
+    "clean": "rimraf ./build",
+    "build": "tsc -p .",
+    "format": "prettier --write \"**/*.{js,json,md,ts,yaml}\"",
+    "setup-examples": "npm link && cd examples && npm install && npm link ../ && cd ../",
+    "test-examples": "cd examples && npm test && cd ../"
   }
 }

README.md

@@ -1,95 +0,52 @@
-# @sajari/sdk-node
+# sajari-sdk-node
 
-> Node.js SDK for Sajari APIs <br/>
-> NOTE: THIS IS STILL IN ALPHA
+**Table of contents:**
 
-## Getting Started
+- [Quickstart](#quickstart)
+  - [Before you begin](#before-you-begin)
+  - [Install the SDK](#install-the-sdk)
+  - [Use the SDK](#use-the-sdk)
+- [Samples](#samples)
+- [Contributing](#contributing)
 
-### Installation
+## Quickstart
 
-This is a [Node.js](https://nodejs.org/) module available through the
-[npm registry](https://www.npmjs.com/). It can be installed using the
-[`npm`](https://docs.npmjs.com/getting-started/installing-npm-packages-locally)
-or [`yarn`](https://yarnpkg.com/en/) command line tools.
+### Before you begin
 
-```sh
-npm install @sajari/sdk-node --save # yarn add @sajari/sdk-node
-```
+1. [Create a Sajari account](http://sajari.com/console)
+1. [Retrieve your account credentials](https://www.sajari.com/console/project/credentials)
 
-### Tests
+### Install the SDK
 
-```sh
-npm install
-npm test
+```bash
+npm install @sajari/sdk-node
 ```
 
-## Examples
+### Use the SDK
 
-**Creating a schema**
-```js
-const { Client, FieldMode, schema } = require("@sajari/sdk-node");
+```javascript
+// Import the Sajari SDK.
+const { CollectionsClient, withKeyCredentials } = require("@sajari/sdk-node");
 
-// create client
-const client = new Client("<project>", "<collection>", {
-	key: "<key from console>",
-	secret: "<secret from console>"
-});
+// Create a client for working with collections from the account ID and key
+// credentials.
+const client = new CollectionsClient(
+  "account-id",
+  withKeyCredentials("key-id", "key-secret")
+);
 
-const fields = [
-	schema.field.boolean("my-boolean-field", {
-		// Set this field to be required.
-		// FieldMode options are defined here,
-		// https://sajari-sdk-node.netlify.com/enums/fieldmode.html
-		mode: FieldMode.Required 
-	}),
-	schema.field.string("text")
-]
+async function createCollection() {
+  // Create a new collection.
+  const collection = await client.createCollection({ id, displayName });
+  console.log(`Collection ${collection.displayName} created.`);
 
-client.schema().add(...fields).catch(error => {/* handle error ... */})
-```
-
-**Adding a record**
-```js
-const { Client } = require("@sajari/sdk-node");
-
-// create client
-const client = new Client("<project>", "<collection>", {
-	key: "<key from console>",
-	secret: "<secret from console>"
-});
-
-// get the pipeline client
-const pipeline = client.pipeline({name: "<your pipeline name>", version: "<your pipeline version>"});
-
-const record = {
-	"my-boolean-field": true,
-	"text": "hello"
+  // Clean up.
+  await client.deleteCollection(collection.id);
 }
 
-pipeline.add({}, record)
-	.then(key => {/* handle key ... */})
-	.catch(error => {/* handle error ... */})
+createCollection().catch(console.error);
 ```
 
-**Performing a search**
-```js
-const { Client, DefaultSession, TrackingType } = require("@sajari/sdk-node");
+## Contributing
 
-const client = new Client("<project>", "<collection>", {
-	key: "<key from console>",
-	secret: "<secret from console>"
-});
-
-const session = new DefaultSession(TrackingType.None);
-const pipeline = client.pipeline({name: "<your pipeline name>", version: "<your pipeline version>"});
-const values = { q: "hello" };
-
-pipeline.search(values, session.next(values))
-	.then(response => {/* handle response ... */})
-	.catch(error => {/* handle error ... */})
-```
-
-
-## License
-
-[MIT](LICENSE)
+Contributions are welcome. See the [Contributing](CONTRIBUTING.md) guide.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Dependency count

2

decreased by-50%

Dev dependency count

6

decreased by-53.85%

Number of package files

173

increased by121.79%

Number of low supply chain risk alerts

1

decreased by-66.67%

Worsened metrics

Total package byte prevSize

363204

decreased by-78.2%

Lines of code

8676

decreased by-71.81%

Number of lines in readme file

53

decreased by-44.79%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addedrequest@2.88.2

• + Addedts-node@8.10.2

• + Addedajv@6.12.6(transitive)

• + Addedarg@4.1.3(transitive)

• + Addedasn1@0.2.6(transitive)

• + Addedassert-plus@1.0.0(transitive)

• + Addedasynckit@0.4.0(transitive)

• + Addedaws-sign2@0.7.0(transitive)

• + Addedaws4@1.13.2(transitive)

• + Addedbcrypt-pbkdf@1.0.2(transitive)

• + Addedbuffer-from@1.1.2(transitive)

• + Addedcaseless@0.12.0(transitive)

• + Addedcombined-stream@1.0.8(transitive)

• + Addedcore-util-is@1.0.2(transitive)

• + Addeddashdash@1.14.1(transitive)

• + Addeddelayed-stream@1.0.0(transitive)

• + Addeddiff@4.0.2(transitive)

• + Addedecc-jsbn@0.1.2(transitive)

• + Addedextend@3.0.2(transitive)

• + Addedextsprintf@1.3.0(transitive)

• + Addedfast-deep-equal@3.1.3(transitive)

• + Addedfast-json-stable-stringify@2.1.0(transitive)

• + Addedforever-agent@0.6.1(transitive)

• + Addedform-data@2.3.3(transitive)

• + Addedgetpass@0.1.7(transitive)

• + Addedhar-schema@2.0.0(transitive)

• + Addedhar-validator@5.1.5(transitive)

• + Addedhttp-signature@1.2.0(transitive)

• + Addedis-typedarray@1.0.0(transitive)

• + Addedisstream@0.1.2(transitive)

• + Addedjsbn@0.1.1(transitive)

• + Addedjson-schema@0.4.0(transitive)

• + Addedjson-schema-traverse@0.4.1(transitive)

• + Addedjson-stringify-safe@5.0.1(transitive)

• + Addedjsprim@1.4.2(transitive)

• + Addedmake-error@1.3.6(transitive)

• + Addedmime-db@1.52.0(transitive)

• + Addedmime-types@2.1.35(transitive)

• + Addedoauth-sign@0.9.0(transitive)

• + Addedperformance-now@2.1.0(transitive)

• + Addedpsl@1.9.0(transitive)

• + Addedpunycode@2.3.1(transitive)

• + Addedqs@6.5.3(transitive)

• + Addedrequest@2.88.2(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedsource-map@0.6.1(transitive)

• + Addedsource-map-support@0.5.21(transitive)

• + Addedsshpk@1.18.0(transitive)

• + Addedtough-cookie@2.5.0(transitive)

• + Addedts-node@8.10.2(transitive)

• + Addedtunnel-agent@0.6.0(transitive)

• + Addedtweetnacl@0.14.5(transitive)

• + Addedtypescript@5.6.2(transitive)

• + Addeduri-js@4.4.1(transitive)

• + Addeduuid@3.4.0(transitive)

• + Addedverror@1.10.0(transitive)

• + Addedyn@3.1.1(transitive)

• - Removeddebug@^4.1.1

• - Removeddeepmerge@^4.0.0

• - Removedgrpc@^1.22.2

• - Removedprotobufjs@^6.8.8

• - Removed@mapbox/node-pre-gyp@1.0.11(transitive)

• - Removed@protobufjs/aspromise@1.1.2(transitive)

• - Removed@protobufjs/base64@1.1.2(transitive)

• - Removed@protobufjs/codegen@2.0.4(transitive)

• - Removed@protobufjs/eventemitter@1.1.0(transitive)

• - Removed@protobufjs/fetch@1.1.0(transitive)

• - Removed@protobufjs/float@1.0.2(transitive)

• - Removed@protobufjs/inquire@1.1.0(transitive)

• - Removed@protobufjs/path@1.1.2(transitive)

• - Removed@protobufjs/pool@1.1.0(transitive)

• - Removed@protobufjs/utf8@1.1.0(transitive)

• - Removed@types/bytebuffer@5.0.49(transitive)

• - Removed@types/long@3.0.324.0.2(transitive)

• - Removed@types/node@22.7.4(transitive)

• - Removedabbrev@1.1.1(transitive)

• - Removedagent-base@6.0.2(transitive)

• - Removedansi-regex@2.1.15.0.1(transitive)

• - Removedaproba@2.0.0(transitive)

• - Removedare-we-there-yet@2.0.0(transitive)

• - Removedascli@1.0.1(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbrace-expansion@1.1.11(transitive)

• - Removedbytebuffer@5.0.1(transitive)

• - Removedcamelcase@2.1.1(transitive)

• - Removedchownr@2.0.0(transitive)

• - Removedcliui@3.2.0(transitive)

• - Removedcode-point-at@1.1.0(transitive)

• - Removedcolor-support@1.1.3(transitive)

• - Removedcolour@0.7.1(transitive)

• - Removedconcat-map@0.0.1(transitive)

• - Removedconsole-control-strings@1.1.0(transitive)

• - Removeddebug@4.3.7(transitive)

• - Removeddecamelize@1.2.0(transitive)

• - Removeddeepmerge@4.3.1(transitive)

• - Removeddelegates@1.0.0(transitive)

• - Removeddetect-libc@2.0.3(transitive)

• - Removedemoji-regex@8.0.0(transitive)

• - Removedfs-minipass@2.1.0(transitive)

• - Removedfs.realpath@1.0.0(transitive)

• - Removedgauge@3.0.2(transitive)

• - Removedglob@7.2.3(transitive)

• - Removedgrpc@1.24.11(transitive)

• - Removedhas-unicode@2.0.1(transitive)

• - Removedhttps-proxy-agent@5.0.1(transitive)

• - Removedinflight@1.0.6(transitive)

• - Removedinherits@2.0.4(transitive)

• - Removedinvert-kv@1.0.0(transitive)

• - Removedis-fullwidth-code-point@1.0.03.0.0(transitive)

• - Removedlcid@1.0.0(transitive)

• - Removedlodash.camelcase@4.3.0(transitive)

• - Removedlodash.clone@4.5.0(transitive)

• - Removedlong@3.2.04.0.0(transitive)

• - Removedmake-dir@3.1.0(transitive)

• - Removedminimatch@3.1.2(transitive)

• - Removedminipass@3.3.65.0.0(transitive)

• - Removedminizlib@2.1.2(transitive)

• - Removedmkdirp@1.0.4(transitive)

• - Removedms@2.1.3(transitive)

• - Removednan@2.20.0(transitive)

• - Removednode-fetch@2.7.0(transitive)

• - Removednopt@5.0.0(transitive)

• - Removednpmlog@5.0.1(transitive)

• - Removednumber-is-nan@1.0.1(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedonce@1.4.0(transitive)

• - Removedoptjs@3.2.2(transitive)

• - Removedos-locale@1.4.0(transitive)

• - Removedpath-is-absolute@1.0.1(transitive)

• - Removedprotobufjs@5.0.36.11.4(transitive)

• - Removedreadable-stream@3.6.2(transitive)

• - Removedrimraf@3.0.2(transitive)

• - Removedsemver@6.3.17.6.3(transitive)

• - Removedset-blocking@2.0.0(transitive)

• - Removedsignal-exit@3.0.7(transitive)

• - Removedstring-width@1.0.24.2.3(transitive)

• - Removedstring_decoder@1.3.0(transitive)

• - Removedstrip-ansi@3.0.16.0.1(transitive)

• - Removedtar@6.2.1(transitive)

• - Removedtr46@0.0.3(transitive)

• - Removedundici-types@6.19.8(transitive)

• - Removedutil-deprecate@1.0.2(transitive)

• - Removedwebidl-conversions@3.0.1(transitive)

• - Removedwhatwg-url@5.0.0(transitive)

• - Removedwide-align@1.1.5(transitive)

• - Removedwindow-size@0.1.4(transitive)

• - Removedwrap-ansi@2.1.0(transitive)

• - Removedwrappy@1.0.2(transitive)

• - Removedy18n@3.2.2(transitive)

• - Removedyallist@4.0.0(transitive)

• - Removedyargs@3.32.0(transitive)