@sajari/sdk-node - npm Package Compare versions

Comparing version 1.0.0-alpha.3 to 1.0.0-alpha.4

dist/index.d.ts

 export { DefaultClient, withEndpoint } from "./client";
 export { Session, DefaultSession, TrackingType } from "./session";
+export { FieldMode } from "./schema/field";

dist/index.js

@@ -9,1 +9,3 @@ "use strict";
 exports.TrackingType = session_1.TrackingType;
+var field_1 = require("./schema/field");
+exports.FieldMode = field_1.FieldMode;

dist/schema/field.d.ts

@@ -0,1 +1,4 @@
+/**
+ * Field represents a meta field which can be assigned in a collection record.
+ */
 export interface Field {
@@ -6,5 +9,19 @@ name: string;
     mode: FieldMode;
+    /**
+     * deprecated
+     * @hidden
+     */
+    required: boolean;
+    /**
+     * deprecated
+     * @hidden
+     */
+    unique: boolean;
     repeated: boolean;
     indexed?: boolean;
 }
+/**
+ * Type represents the underlying data type of the field. Default is a string.
+ * @hidden
+ */
 export declare enum Type {
@@ -19,4 +36,14 @@ String = "STRING",
 export declare enum FieldMode {
+    /**
+     * Nullable fields do not need to be set.
+     */
     Nullable = 0,
+    /**
+     * Required fields must be specified (cannot be null).
+     */
     Required = 1,
+    /**
+     * Unique fields must be specified, and must be unique.
+     * Unique fields can be used to retrieve/delete records.
+     */
     Unique = 2
@@ -28,2 +55,12 @@ }
     mode: FieldMode;
+    /**
+     * deprecated
+     * @hidden
+     */
+    required: boolean;
+    /**
+     * deprecated
+     * @hidden
+     */
+    unique: boolean;
 }
@@ -30,0 +67,0 @@ /**

dist/schema/field.js

@@ -8,3 +8,6 @@ "use strict";
 var proto_1 = require("../../generated/proto");
-// Type represents the underlying data type of the field. Default is a string.
+/**
+ * Type represents the underlying data type of the field. Default is a string.
+ * @hidden
+ */
 var Type;
@@ -21,8 +24,14 @@ (function (Type) {
 (function (FieldMode) {
+    /**
+     * Nullable fields do not need to be set.
+     */
     FieldMode[FieldMode["Nullable"] = 0] = "Nullable";
-    // Required indicates that this field should always be set on all records.
+    /**
+     * Required fields must be specified (cannot be null).
+     */
     FieldMode[FieldMode["Required"] = 1] = "Required";
-    // Unique indicates that the field is unique (and this will
-    // be enforced when new records are added).  Unique fields can
-    // be used to retrieve/delete records.
+    /**
+     * Unique fields must be specified, and must be unique.
+     * Unique fields can be used to retrieve/delete records.
+     */
     FieldMode[FieldMode["Unique"] = 2] = "Unique";
@@ -36,3 +45,5 @@ })(FieldMode = exports.FieldMode || (exports.FieldMode = {}));
     repeated: false,
-    mode: FieldMode.Nullable
+    mode: FieldMode.Nullable,
+    required: false,
+    unique: false
 };
@@ -44,2 +55,11 @@ /**
     options = deepmerge_1.default(defaultFieldOptions, options || {});
+    switch (options.mode) {
+        case FieldMode.Required:
+            options.required = true;
+            break;
+        case FieldMode.Unique:
+            options.unique = true;
+        default:
+            break;
+    }
     return {
@@ -50,3 +70,5 @@ type: type,
         repeated: options.repeated,
-        mode: options.mode
+        mode: options.mode,
+        unique: options.unique,
+        required: options.required
     };
@@ -53,0 +75,0 @@ }

package.json

 {
   "name": "@sajari/sdk-node",
-  "version": "1.0.0-alpha.3",
+  "version": "1.0.0-alpha.4",
   "main": "dist/index.js",
@@ -5,0 +5,0 @@ "types": "dist/index.d.ts",

README.md

@@ -25,13 +25,14 @@ # @sajari/sdk-node
 
-## Example
+## Examples
 ```js
 // Search Example
 
-const { Client, Session, TrackingNone } = require("sajari-node");
+const { DefaultClient, DefaultSession, TrackingType } = require("@sajari/sdk-node");
 
-const client = new Client("<project>", "<collection>", {
+const client = new DefaultClient("<project>", "<collection>", {
 	key: "<key from console>",
 	secret: "<secret from console>"
 });
-const session = new Session(TrackingNone);
+
+const session = new DefaultSession(TrackingType.None);
 const pipeline = client.pipeline("website");
@@ -44,4 +45,31 @@
 
+```js
+// creating schema example
+
+const { DefaultClient, FieldMode } = require("@sajari/sdk-node");
+
+// create client
+const client = new DefaultClient("<project>", "<collection>", {
+	key: "<key from console>",
+	secret: "<secret from console>"
+});
+
+// get schema client
+const schema = client.schema()
+
+const fields = [
+	schema.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.add(...fields).catch(error => {/* handle error ... */})
+
+```
+
 ## License
 
 [MIT](LICENSE)

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

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

Improved metrics

Total package byte prevSize

2587629

increased by0.07%

Lines of code

43696

increased by0.14%

Number of lines in readme file

74

increased by60.87%

No dependency changes