featureflow-node-sdk 0.6.7 → 0.6.9

package/README.md

@@ -14,6 +14,14 @@ Get your Featureflow account at [featureflow.io](http://www.featureflow.io)
 
 The easiest way to get started is to follow the [Featureflow quick start guides](http://docs.featureflow.io/docs)
 
+## Examples
+
+Express: [here](https://github.com/featureflow/featureflow-node-example)
+
+NextJS: [here](https://github.com/featureflow/featureflow-example-nextjs)
+
+5 Minute: [here](https://github.com/featureflow/featureflow-fiveminute-node) [(docs)](https://docs.featureflow.io/docs/nodejs-5-minute-test)
+
 ## Change Log
 
 Please see [CHANGELOG](https://github.com/featureflow/featureflow-node-sdk/blob/master/CHANGELOG.md).

package/dist/Client.d.ts

@@ -0,0 +1,13 @@
+export default class Featureflow {
+    constructor(config: any, callback?: (_err: any, self: any) => void);
+    failoverVariants: {};
+    isReady: boolean;
+    config: any;
+    eventsClient: EventsClient;
+    close: PollingClient;
+    ready(callback?: () => void): any;
+    evaluateAll(): any;
+    evaluate(key: any): any;
+}
+import EventsClient from "./EventsClient";
+import PollingClient from "./PollingClient";

package/dist/Client.js

@@ -44,7 +44,7 @@ var Featureflow = function (_EventEmitter) {
     _inherits(Featureflow, _EventEmitter);
 
     function Featureflow(config) {
-        var callback = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : function () {};
+        var callback = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : function (_err, self) {};
 
         _classCallCheck(this, Featureflow);
 

package/dist/Conditions.d.ts

@@ -0,0 +1 @@
+export function test(op: any, a: any, b: any): any;

package/dist/Evaluate.d.ts

@@ -0,0 +1,11 @@
+export default class Evaluate {
+    constructor(featureKey: any, evaluatedVariant: any, user: any, eventsClient: any);
+    featureKey: any;
+    evaluatedVariant: any;
+    user: any;
+    eventsClient: any;
+    is(value: any): boolean;
+    isOn(): boolean;
+    isOff(): boolean;
+    value(): any;
+}

package/dist/EvaluateHelpers.d.ts

@@ -0,0 +1,5 @@
+export function featureEvaluation(feature: any, user: any): any;
+export function ruleMatches(rule: any, user: any): boolean;
+export function getVariantSplitKey(variantSplits: any, variantValue: any): any;
+export function calculateHash(salt: any, feature: any, id: any): any;
+export function getVariantValue(hash: any): number;

package/dist/EvaluateHelpers.js

@@ -52,7 +52,7 @@ function featureEvaluation(feature, user) {
 }
 
 function ruleMatches(rule, user) {
-  if (rule.defaultRule) {
+  if (!rule.audience) {
     return true;
   } else {
     for (var cKey in rule.audience.conditions) {

package/dist/EventsClient.d.ts

@@ -0,0 +1,19 @@
+export default class EventsClient {
+    constructor(apiKey: any, eventsUrl?: string, disabled?: boolean);
+    SEND_INTERVAL: number;
+    QUEUE_SIZE: number;
+    clientVersion: string;
+    queue: any[];
+    overLimit: boolean;
+    apiKey: any;
+    eventsUrl: string;
+    disabled: boolean;
+    sendInterval: number;
+    interval: number;
+    registerFeaturesEvent(features: any): void;
+    evaluateEvent(featureKey: any, evaluatedVariant: any, expectedVariant: any, user: any): void;
+    queueEvaluateEvent(event: any): void;
+    sendQueue(): void;
+    sendEvent(eventType: any, method: any, url: any, json: any): void;
+    close(): void;
+}

package/dist/ExpressMiddleware.d.ts

@@ -0,0 +1 @@
+export default function _default(options: any): (req: any, res: any, next: any) => void;

package/dist/Feature.d.ts

@@ -0,0 +1,12 @@
+export default class Feature {
+    constructor(key: any, failoverVariant?: string);
+    variants: any[];
+    key: any;
+    failoverVariant: string;
+    addVariant(key: any, value: any): Feature;
+    build(): {
+        key: any;
+        failoverVariant: string;
+        variants: any[];
+    };
+}

package/dist/FeatureStore.d.ts

@@ -0,0 +1,8 @@
+export class InMemoryFeatureStore {
+    constructor(features?: {});
+    features: {};
+    get(key: any): any;
+    set(key: any, feature: any): void;
+    setAll(features: any): void;
+    getAll(): {};
+}

package/dist/PollingClient.d.ts

@@ -0,0 +1,13 @@
+export default class PollingClient {
+    constructor(url: any, config: any, callback: any);
+    DEFAULT_TIMEOUT: number;
+    DEFAULT_INTERVAL: number;
+    clientVersion: string;
+    url: any;
+    apiKey: any;
+    featureStore: any;
+    interval: number;
+    timeout: number;
+    etag: string;
+    getFeatures(callback?: () => void): void;
+}

package/dist/User.d.ts

@@ -0,0 +1,20 @@
+export class UserBuilder {
+    constructor(id: any);
+    id: any;
+    attributes: {
+        'featureflow.user.id': any[];
+        'featureflow.date': string[];
+    };
+    withAttribute(key: any, value: any): UserBuilder;
+    withAttributes(key: any, values: any): UserBuilder;
+    build(): User;
+}
+declare class User {
+    constructor(id: any, attributes: any);
+    id: any;
+    attributes: any;
+    getId(): any;
+    getAttributesForKey(key: any): any;
+    addAttribute(key: any, value: any): void;
+}
+export {};

package/dist/debug.d.ts

@@ -0,0 +1,2 @@
+declare const _exports: any;
+export = _exports;

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+declare namespace _default {
+    export { Client };
+    export { UserBuilder };
+    export { Feature };
+    export { ExpressClient };
+}
+export default _default;
+import Client from "./Client";
+import { UserBuilder } from "./User";
+import Feature from "./Feature";
+import ExpressClient from "./ExpressMiddleware";

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "featureflow-node-sdk",
-  "version": "0.6.7",
+  "version": "0.6.9",
   "description": "Featureflow sdk for Node",
   "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "engines": {
     "node": ">4.0.0"
   },
@@ -10,7 +11,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "babel src -d dist",
+    "build": "babel src -d dist && tsc",
     "watch": "babel --watch src -d dist",
     "prepublish": "npm run build",
     "test": "cucumber.js --compiler js:babel-core/register --tags \"not @ignore and not @integration\"",
@@ -31,7 +32,8 @@
     "big-integer": "^1.6.17",
     "debug": "^2.6.2",
     "request": "^2.88.0",
-    "sha1-hex": "^1.0.0"
+    "sha1-hex": "^1.0.0",
+    "typescript": "^4.8.2"
   },
   "devDependencies": {
     "babel-cli": "^6.26.0",

package/CHANGELOG.md

@@ -1,42 +0,0 @@
-# Change log
-## [0.6.4] - 2018-012-18
-### Changed
-- Simplify express middleware
-- Update url to events.featureflow.io for events
-- Improve polling time
-- Update readme
-## [0.5.5] - 2017-07-14
-### Changed
-- Updated tests
-## [0.5.4] - 2017-07-14
-### Changed
-- Added baseUrl config option, added `featureflow.ready(function(){})` callback
-### Fixed
-- Issue with offVariantKey
-## [0.5.2] - 2017-07-10
-### Changed
-- Fix support for `var Featureflow = require('featureflow-node-sdk')`, previously was on `Featureflow.default`
-## [0.5.0] - 2017-06-30
-### Breaking Changes
-- Entire api rewritten to follow closer to other SDK implementations.
-## [0.3.0] - 2017-04-13
-### Changed
-- `Featureflow.init()` now returns the client, and the callback is optional. You can listen to `Featureflow.events.INIT` and `Featureflow.events.UPDATED` separately using `featureflow.on(event, callback)`.
-- Added new events `Featureflow.events.INIT` and `Featureflow.events.UPDATED_VERBOSE`.
-### Fixed
-- `Featureflow.events.INIT` now fires before `Featureflow.events.UPDATED`
-## [0.1.3] - 2017-03-21
-### Changed
-- Added `Featureflow.events.UPDATED` and `Featureflow.events.ERROR` constants for usage with `featureflow.on(event, callback)`. 
-## [0.1.2] - 2017-03-21
-### Changed
-- `featureflow.close()` added to close connection with **featureflow.io**.
-## [0.1.1] - 2017-03-21
-### Changed
-- `Featureflow.init(config, callback)` now starts up with the feature values passed in with `config.withFeatures` 
-  and corresponding failoverVariants if your app is not able to connect to **featureflow.io**.
-- Callback now only fires once per call to `Featureflow.init(...)`
-## [0.1.0] - 2017-03-20
-### Changed
-- Initial Build
-