@hyphen/sdk 1.0.3 → 1.1.0

package/README.md

@@ -1,4 +1,4 @@
-![Hyphen AI](https://github.com/Hyphen/nodejs-sdk/raw/main/logo.svg)
+![Hyphen AI](https://github.com/Hyphen/nodejs-sdk/raw/main/logo.png)
 
 [![tests](https://github.com/Hyphen/nodejs-sdk/actions/workflows/tests.yaml/badge.svg)](https://github.com/Hyphen/nodejs-sdk/actions/workflows/tests.yaml)
 [![npm](https://img.shields.io/npm/v/@hyphen/sdk)](https://www.npmjs.com/package/@hyphen/sdk)
@@ -18,8 +18,9 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 	- [Toggle API](#toggle-api)
 	- [Toggle Hooks](#toggle-hooks)
 	- [Toggle Error Handling](#toggle-error-handling)
+	- [Toggle Self-Hosted](#toggle-self-hosted)
 - [Contributing](#contributing)
-	- [Testing Your Changes](#testing-your-changes)
+- [Testing Your Changes](#testing-your-changes)
 - [License and Copyright](#license-and-copyright)
 
 # Installation
@@ -311,10 +312,100 @@ try {
 }
 ```
 
+## Toggle Self-Hosted
+
+Toggle uses [Horizon](https://hyphen.ai/horizon) to fetch the feature flags. If you are using a self-hosted version of Hyphen you can use the `uris` option in the constructor to set the url of your self-hosted version:
+
+```javascript
+import { Toggle, ToggleContext } from '@hyphen/sdk';
+
+const context: ToggleContext = {
+	targetingKey: 'user-123',
+	ipAddress: '203.0.113.42',
+	customAttributes: {
+		subscriptionLevel: 'premium',
+		region: 'us-east',
+	},
+	user: {
+		id: 'user-123',
+		email: 'john.doe@example.com',
+		name: 'John Doe',
+		customAttributes: {
+			role: 'admin',
+		},
+	},
+};
+
+const toggleOptions = {
+  publicApiKey: 'your_public_api_key',
+  applicationId: 'your_application_id',
+  context: context,
+  uris: [
+	'https://your-self-hosted-horizon-url',
+  ],
+};
+
+const toggle = new Toggle(toggleOptions);
+
+const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
+console.log('Boolean toggle value:', result); // true
+```
+
+If you want to use your self-hosted version of [Horizon](https://hyphen.ai/horizon) as a primary and fallback to our hosted version you can do it like this:
+
+```javascript
+import { Toggle, ToggleContext } from '@hyphen/sdk';
+
+const context: ToggleContext = {
+	targetingKey: 'user-123',
+	ipAddress: '203.0.113.42',
+	customAttributes: {
+		subscriptionLevel: 'premium',
+		region: 'us-east',
+	},
+	user: {
+		id: 'user-123',
+		email: 'john.doe@example.com',
+		name: 'John Doe',
+		customAttributes: {
+			role: 'admin',
+		},
+	},
+};
+
+const toggleOptions = {
+  publicApiKey: 'your_public_api_key',
+  applicationId: 'your_application_id',
+  context: context,
+  uris: [
+	'https://your-self-hosted-horizon-url',
+	'https://toggle.hyphen.cloud',
+  ],
+};
+
+const toggle = new Toggle(toggleOptions);
+
+const result = await toggle.getBoolean('hyphen-sdk-boolean', false);
+console.log('Boolean toggle value:', result); // true
+```
+
 # Contributing
 
 We welcome contributions to the Hyphen Node.js SDK! If you have an idea for a new feature, bug fix, or improvement, please follow these steps:
 
+1. Fork the repository.
+2. Create a new branch for your feature or bug fix.
+3. Install `pnpm` by running `npm install -g pnpm` if you don't have it already.
+3. Run the installation and tests to ensure everything is working correctly `pnpm i && pnpm test`. 
+4. Make your changes and commit them with a clear message. In the following format:
+   - `feat: <describe the feature>`
+   - `fix: <describe the bug fix>`
+   - `chore: updgrading xxx to version x.x.x`
+
+5. Push your changes to your forked repository.
+6. Create a pull request to the main repository.
+7. Describe your changes and why they are necessary.
+
 ## Testing Your Changes
 
 To test your changes locally you will need to create an account on [Hyphen](https://hyphen.ai) and do the following:

package/dist/index.cjs

@@ -62,6 +62,7 @@ var Toggle = class extends import_hookified.Hookified {
   _client;
   _context;
   _throwErrors = false;
+  _uris;
   constructor(options) {
     super();
     this._applicationId = options.applicationId;
@@ -69,6 +70,7 @@ var Toggle = class extends import_hookified.Hookified {
     this._environment = options.environment ?? import_node_process.default.env.NODE_ENV ?? "development";
     this._context = options.context;
     this._throwErrors = options.throwErrors ?? false;
+    this._uris = options.uris;
   }
   get applicationId() {
     return this._applicationId;
@@ -100,6 +102,12 @@ var Toggle = class extends import_hookified.Hookified {
   set context(value) {
     this._context = value;
   }
+  get uris() {
+    return this._uris;
+  }
+  set uris(value) {
+    this._uris = value;
+  }
   setContext(context) {
     this._context = context;
     this._client = void 0;
@@ -108,7 +116,8 @@ var Toggle = class extends import_hookified.Hookified {
     if (!this._client) {
       const options = {
         application: this._applicationId,
-        environment: this._environment
+        environment: this._environment,
+        horizonUrls: this._uris
       };
       await import_server_sdk.OpenFeature.setProviderAndWait(new import_openfeature_server_provider.HyphenProvider(this._publicKey, options));
       this._client = import_server_sdk.OpenFeature.getClient(this._context);

package/dist/index.d.cts

@@ -47,6 +47,13 @@ type ToggleOptions = {
      * @default false
      */
     throwErrors?: boolean;
+    /**
+     * Horizon URIs to use for talking to Toggle. You can use this to override
+     * the default URIs for testin or if you are using a self-hosted version.
+     * @type {Array<string>}
+     * @example ['https://toggle.hyphen.ai']
+     */
+    uris?: string[];
 };
 type ToggleRequestOptions = {
     context?: ToggleContext;
@@ -58,6 +65,7 @@ declare class Toggle extends Hookified {
     private _client;
     private _context;
     private _throwErrors;
+    private _uris?;
     constructor(options: ToggleOptions);
     get applicationId(): string;
     set applicationId(value: string);
@@ -69,6 +77,8 @@ declare class Toggle extends Hookified {
     set throwErrors(value: boolean);
     get context(): ToggleContext | undefined;
     set context(value: ToggleContext | undefined);
+    get uris(): string[] | undefined;
+    set uris(value: string[] | undefined);
     setContext(context: ToggleContext): void;
     getClient(): Promise<Client>;
     get<T>(key: string, defaultValue: T, options?: ToggleRequestOptions): Promise<T>;

package/dist/index.d.ts

@@ -47,6 +47,13 @@ type ToggleOptions = {
      * @default false
      */
     throwErrors?: boolean;
+    /**
+     * Horizon URIs to use for talking to Toggle. You can use this to override
+     * the default URIs for testin or if you are using a self-hosted version.
+     * @type {Array<string>}
+     * @example ['https://toggle.hyphen.ai']
+     */
+    uris?: string[];
 };
 type ToggleRequestOptions = {
     context?: ToggleContext;
@@ -58,6 +65,7 @@ declare class Toggle extends Hookified {
     private _client;
     private _context;
     private _throwErrors;
+    private _uris?;
     constructor(options: ToggleOptions);
     get applicationId(): string;
     set applicationId(value: string);
@@ -69,6 +77,8 @@ declare class Toggle extends Hookified {
     set throwErrors(value: boolean);
     get context(): ToggleContext | undefined;
     set context(value: ToggleContext | undefined);
+    get uris(): string[] | undefined;
+    set uris(value: string[] | undefined);
     setContext(context: ToggleContext): void;
     getClient(): Promise<Client>;
     get<T>(key: string, defaultValue: T, options?: ToggleRequestOptions): Promise<T>;

package/dist/index.js

@@ -27,6 +27,7 @@ var Toggle = class extends Hookified {
   _client;
   _context;
   _throwErrors = false;
+  _uris;
   constructor(options) {
     super();
     this._applicationId = options.applicationId;
@@ -34,6 +35,7 @@ var Toggle = class extends Hookified {
     this._environment = options.environment ?? process.env.NODE_ENV ?? "development";
     this._context = options.context;
     this._throwErrors = options.throwErrors ?? false;
+    this._uris = options.uris;
   }
   get applicationId() {
     return this._applicationId;
@@ -65,6 +67,12 @@ var Toggle = class extends Hookified {
   set context(value) {
     this._context = value;
   }
+  get uris() {
+    return this._uris;
+  }
+  set uris(value) {
+    this._uris = value;
+  }
   setContext(context) {
     this._context = context;
     this._client = void 0;
@@ -73,7 +81,8 @@ var Toggle = class extends Hookified {
     if (!this._client) {
       const options = {
         application: this._applicationId,
-        environment: this._environment
+        environment: this._environment,
+        horizonUrls: this._uris
       };
       await OpenFeature.setProviderAndWait(new HyphenProvider(this._publicKey, options));
       this._client = OpenFeature.getClient(this._context);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hyphen/sdk",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Hyphen SDK for Node.js",
   "type": "module",
   "main": "dist/index.cjs",