Merge pull request #1 from Eppo-exp/setup

Implement Assignment Logic

Author: ploomiz

.gitignore

@@ -6,3 +6,5 @@ logs/
 temp
 .env
 yarn-error.log
+
+test/assignmentTestData

docs/js-client-sdk.dummy.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [getInstance](./js-client-sdk.getinstance.md)
+
+## getInstance() function
+
+Used to access a singleton SDK client instance. Use the method after calling init() to initialize the client.
+
+<b>Signature:</b>
+
+```typescript
+export declare function getInstance(): IEppoClient;
+```
+<b>Returns:</b>
+
+[IEppoClient](./js-client-sdk.ieppoclient.md)
+
+a singleton client instance
+

docs/js-client-sdk.getinstance.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IClientConfig](./js-client-sdk.iclientconfig.md) &gt; [apiKey](./js-client-sdk.iclientconfig.apikey.md)
+
+## IClientConfig.apiKey property
+
+Eppo API key
+
+<b>Signature:</b>
+
+```typescript
+apiKey: string;
+```

docs/js-client-sdk.iclientconfig.apikey.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IClientConfig](./js-client-sdk.iclientconfig.md) &gt; [baseUrl](./js-client-sdk.iclientconfig.baseurl.md)
+
+## IClientConfig.baseUrl property
+
+Base URL of the Eppo API. Clients should use the default setting in most cases.
+
+<b>Signature:</b>
+
+```typescript
+baseUrl?: string;
+```

docs/js-client-sdk.iclientconfig.baseurl.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IClientConfig](./js-client-sdk.iclientconfig.md)
+
+## IClientConfig interface
+
+Configuration used for initializing the Eppo client
+
+<b>Signature:</b>
+
+```typescript
+export interface IClientConfig 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [apiKey](./js-client-sdk.iclientconfig.apikey.md) | string | Eppo API key |
+|  [baseUrl?](./js-client-sdk.iclientconfig.baseurl.md) | string | <i>(Optional)</i> Base URL of the Eppo API. Clients should use the default setting in most cases. |
+

docs/js-client-sdk.iclientconfig.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IEppoClient](./js-client-sdk.ieppoclient.md) &gt; [getAssignment](./js-client-sdk.ieppoclient.getassignment.md)
+
+## IEppoClient.getAssignment() method
+
+Maps a subject to a variation for a given experiment.
+
+<b>Signature:</b>
+
+```typescript
+getAssignment(subjectKey: string, experimentKey: string, subjectAttributes?: Record<string, any>): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  subjectKey | string | an identifier of the experiment subject, for example a user ID. |
+|  experimentKey | string | experiment identifier |
+|  subjectAttributes | Record&lt;string, any&gt; | <i>(Optional)</i> optional attributes associated with the subject, for example name and email. The subject attributes are used for evaluating any targeting rules tied to the experiment. |
+
+<b>Returns:</b>
+
+string
+
+a variation value if the subject is part of the experiment sample, otherwise null
+

docs/js-client-sdk.ieppoclient.getassignment.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IEppoClient](./js-client-sdk.ieppoclient.md)
+
+## IEppoClient interface
+
+Client for assigning experiment variations.
+
+<b>Signature:</b>
+
+```typescript
+export interface IEppoClient 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [getAssignment(subjectKey, experimentKey, subjectAttributes)](./js-client-sdk.ieppoclient.getassignment.md) | Maps a subject to a variation for a given experiment. |
+

docs/js-client-sdk.ieppoclient.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [init](./js-client-sdk.init.md)
+
+## init() function
+
+Initializes the Eppo client with configuration parameters. This method should be called once on application startup. After invocation of this method, the SDK will poll Eppo's API at regular intervals to retrieve assignment configurations.
+
+<b>Signature:</b>
+
+```typescript
+export declare function init(config: IClientConfig): Promise<IEppoClient>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  config | [IClientConfig](./js-client-sdk.iclientconfig.md) | client configuration |
+
+<b>Returns:</b>
+
+Promise&lt;[IEppoClient](./js-client-sdk.ieppoclient.md)<!-- -->&gt;
+

docs/js-client-sdk.init.md

@@ -8,5 +8,13 @@
 
 |  Function | Description |
 |  --- | --- |
-|  [dummy()](./js-client-sdk.dummy.md) | Test documentation |
+|  [getInstance()](./js-client-sdk.getinstance.md) | Used to access a singleton SDK client instance. Use the method after calling init() to initialize the client. |
+|  [init(config)](./js-client-sdk.init.md) | Initializes the Eppo client with configuration parameters. This method should be called once on application startup. After invocation of this method, the SDK will poll Eppo's API at regular intervals to retrieve assignment configurations. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [IClientConfig](./js-client-sdk.iclientconfig.md) | Configuration used for initializing the Eppo client |
+|  [IEppoClient](./js-client-sdk.ieppoclient.md) | Client for assigning experiment variations. |