@screeb/sdk-angular 0.1.1

package/docs/classes/Screeb.md

@@ -0,0 +1,505 @@
+[@screeb/sdk-angular](../README.md) / Screeb
+
+# Class: Screeb
+
+## Table of contents
+
+### Constructors
+
+- [constructor](Screeb.md#constructor)
+
+### Properties
+
+- [config](Screeb.md#config)
+- [isInitialized](Screeb.md#isinitialized)
+
+### Methods
+
+- [close](Screeb.md#close)
+- [debug](Screeb.md#debug)
+- [ensureScreeb](Screeb.md#ensurescreeb)
+- [eventTrack](Screeb.md#eventtrack)
+- [identity](Screeb.md#identity)
+- [identityGet](Screeb.md#identityget)
+- [identityGroupAssign](Screeb.md#identitygroupassign)
+- [identityGroupUnassign](Screeb.md#identitygroupunassign)
+- [identityProperties](Screeb.md#identityproperties)
+- [identityReset](Screeb.md#identityreset)
+- [init](Screeb.md#init)
+- [load](Screeb.md#load)
+- [surveyClose](Screeb.md#surveyclose)
+- [surveyStart](Screeb.md#surveystart)
+- [targetingCheck](Screeb.md#targetingcheck)
+- [targetingDebug](Screeb.md#targetingdebug)
+
+## Constructors
+
+### constructor
+
+• **new Screeb**(`config`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `config` | [`ScreebConfig`](ScreebConfig.md) |
+
+## Properties
+
+### config
+
+• `Private` **config**: [`ScreebConfig`](ScreebConfig.md)
+
+___
+
+### isInitialized
+
+• `Private` **isInitialized**: `boolean` = `false`
+
+## Methods
+
+### close
+
+▸ **close**(): `Promise`<`unknown`\>
+
+Shutdowns current Screeb session.
+
+**`Example`**
+
+```ts
+this.screeb.close();
+```
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### debug
+
+▸ **debug**(): `Promise`<`unknown`\>
+
+Prints the actual state information of Screeb tag.
+
+**`Example`**
+
+```ts
+this.screeb.debug();
+// ******************* SCREEB SESSION DEBUG *********************
+// Screeb channel id: <UUID>
+// Screeb channel type: widget
+// Screeb respondent id: <UUID>
+// Screeb survey id: none
+// Screeb response id: none
+//
+// Screeb current session start: Thu May 04 2023 16:53:49 GMT+0200 (Central European Summer Time)
+// Screeb current session last activity: Thu May 04 2023 17:41:30 GMT+0200 (Central European Summer Time)
+//
+// Screeb targeting engine status: disabled
+// Screeb targeting engine: 3 surveys
+//
+// Detected platform: desktop
+// Detected locale: en-GB
+// Detected timezone: -120
+// **************************************************************
+```
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### ensureScreeb
+
+▸ `Private` **ensureScreeb**(`functionName`, `onlyLoaded?`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `functionName` | `string` | `undefined` |
+| `onlyLoaded` | `boolean` | `false` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+___
+
+### eventTrack
+
+▸ **eventTrack**(`eventName`, `eventProperties?`): `Promise`<`unknown`\>
+
+Tracks a user event.
+
+**`Example`**
+
+```ts
+this.screeb.eventTrack(
+  "Product added to cart",
+  {
+    product_name: 'Red bike 2021',
+    category: 'sport',
+    color: 'red',
+    price: 299,
+    count: 1,
+    reference: '2CF093TG1',
+    delivery_method: 'UPS',
+    user_logged: false,
+    added_at: new Date(),
+  }
+);
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `eventName` | `string` | The event name. |
+| `eventProperties?` | `PropertyRecord` | The properties of your event. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### identity
+
+▸ **identity**(`userId`, `userProperties?`): `Promise`<`unknown`\>
+
+Change the current user identity.
+Warning: Running surveys will be closed.
+
+**`Example`**
+
+```ts
+this.screeb.identity(
+  "<your-user-id>",
+  {
+    firstname: '<user-firstname>',
+    lastname: '<user-lastname>',
+    plan: '<user-plan>',
+    last_seen_at: new Date(),
+    authenticated: true
+  }
+);
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userId` | `string` | The unique identifier of your user. |
+| `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### identityGet
+
+▸ **identityGet**(): `Promise`<`ScreebIdentityGetReturn`\>
+
+Retrieves the current user identity.
+
+**`Example`**
+
+```ts
+console.log(await this.screeb.identityGet());
+// {
+//   anonymous_id: "<UUID>",
+//   user_id: "<UUID>",
+//   session_id: "<UUID>",
+//   session_start: "2023-05-04T16:30:15.882Z",
+//   session_end: "2023-05-04T17:02:09.087Z",
+//   channel_id: "<UUID>",
+//   is_ready: true,
+// }
+```
+
+#### Returns
+
+`Promise`<`ScreebIdentityGetReturn`\>
+
+___
+
+### identityGroupAssign
+
+▸ **identityGroupAssign**(`groupName`, `groupType?`, `groupProperties?`): `Promise`<`unknown`\>
+
+Assigns the current user to a group.
+
+**`Example`**
+
+```ts
+this.screeb.identityGroupAssign(
+  'company',
+  'Apple',
+  {
+    address_line_1: 'Apple Campus',
+    address_line_2: '1 Infinite Loop',
+    city: 'Cupertino',
+    zipcode: 95014,
+    state: 'California',
+    country: 'United states',
+  }
+);
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupName` | `string` |  |
+| `groupType?` | `string` |  |
+| `groupProperties?` | `PropertyRecord` | The properties of your user group. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### identityGroupUnassign
+
+▸ **identityGroupUnassign**(`groupName`, `groupType?`): `Promise`<`unknown`\>
+
+Unassigns the current user to a group.
+
+**`Example`**
+
+```ts
+this.screeb.identityGroupUnassign('company', 'Apple');
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `groupName` | `string` | The name of your user group. |
+| `groupType?` | `string` | The type of your user group. |
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### identityProperties
+
+▸ **identityProperties**(`userProperties`): `Promise`<`unknown`\>
+
+Adds properties to the current user identity.
+
+**`Example`**
+
+```ts
+// Set user properties
+this.screeb.identityProperties(
+  {
+    firstname: '<user-firstname>',
+    lastname: '<user-lastname>',
+    plan: '<user-plan>',
+    last_seen_at: new Date(),
+    authenticated: true
+  }
+);
+
+// Delete user property : set values to null
+this.screeb.identityProperties(
+  {
+    age: null,
+    company: null,
+    logged: true,
+  }
+);
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userProperties` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### identityReset
+
+▸ **identityReset**(): `Promise`<`unknown`\>
+
+Resets the current user identity.
+Warning: This command must be called only once, since it creates a new identity on Screeb side.
+
+**`Example`**
+
+```ts
+this.screeb.identityReset();
+```
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### init
+
+▸ **init**(`websiteId`, `userId?`, `userProperties?`): `Promise`<`unknown`\>
+
+Initializes Screeb tag.
+
+**`Example`**
+
+```ts
+this.screeb.init(
+  "<your-website-id>",
+  "<your-user-id>",
+  {
+    firstname: '<user-firstname>',
+    lastname: '<user-lastname>',
+    plan: '<user-plan>',
+    last_seen_at: new Date(),
+    authenticated: true
+  }
+);
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `websiteId` | `string` | Your website/channel id. |
+| `userId?` | `string` | The unique identifier of your user. |
+| `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date ``` |
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### load
+
+▸ **load**(): `Promise`<`undefined`\>
+
+Appends Screeb tag into your dom.
+
+**`Example`**
+
+```ts
+this.screeb.load();
+```
+
+#### Returns
+
+`Promise`<`undefined`\>
+
+___
+
+### surveyClose
+
+▸ **surveyClose**(): `Promise`<`unknown`\>
+
+Interrupts a running survey.
+
+**`Example`**
+
+```ts
+this.screeb.surveyClose();
+```
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### surveyStart
+
+▸ **surveyStart**(`surveyId`, `allowMultipleResponses`, `hiddenFields`): `Promise`<`unknown`\>
+
+Starts a survey by its ID.
+
+**`Example`**
+
+```ts
+this.screeb.surveyStart(
+  '<UUID>',
+  false,
+  {
+    color: "green",
+    article_id: 42
+  }
+);
+```
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `surveyId` | `string` |
+| `allowMultipleResponses` | `boolean` |
+| `hiddenFields` | `PropertyRecord` |
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### targetingCheck
+
+▸ **targetingCheck**(): `Promise`<`unknown`\>
+
+Forces a targeting check.
+
+**`Example`**
+
+```ts
+this.screeb.targetingCheck();
+```
+
+#### Returns
+
+`Promise`<`unknown`\>
+
+___
+
+### targetingDebug
+
+▸ **targetingDebug**(): `Promise`<`unknown`\>
+
+Prints the current state of the targeting engine.
+
+**`Example`**
+
+```ts
+console.log(await this.screeb.targetingDebug());
+// targeting ************ SCREEB TARGETING RULES DEBUG **************
+// Disabled surveys are not listed here.
+//
+// Screeb channel id: <UUID>
+// Screeb respondent id: <UUID>
+//
+// Survey <UUID>:
+// https://admin.screeb.app/org/last/survey/<UUID>/share
+//
+//   - Rule of type "Device type (desktop/mobile/tablet)": true 🟢
+//   - Rule of type "Multiple display": true 🟢
+//   - Rule of type "Capping per time between survey display on current respondent": true 🟢
+//   - Rule of type "User event count": false 🔴
+//   - Rule of type "Capping per respondent display count": false 🔴
+```
+
+#### Returns
+
+`Promise`<`unknown`\>

package/docs/classes/ScreebConfig.md

@@ -0,0 +1,87 @@
+[@screeb/sdk-angular](../README.md) / ScreebConfig
+
+# Class: ScreebConfig
+
+Configuration of Screeb module
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ScreebConfig.md#constructor)
+
+### Properties
+
+- [autoInit](ScreebConfig.md#autoinit)
+- [options](ScreebConfig.md#options)
+- [shouldLoad](ScreebConfig.md#shouldload)
+- [userId](ScreebConfig.md#userid)
+- [userProperties](ScreebConfig.md#userproperties)
+- [websiteId](ScreebConfig.md#websiteid)
+
+## Constructors
+
+### constructor
+
+• **new ScreebConfig**()
+
+## Properties
+
+### autoInit
+
+• `Optional` **autoInit**: `boolean`
+
+Indicates if Screeb should be automatically initialized.
+
+**`Remarks`**
+
+if `true`, 'init' does not need to be called manually
+
+___
+
+### options
+
+• `Optional` **options**: `ScreebOptions`
+
+Screeb tag initialization options.
+
+**`Remarks`**
+
+this is used is really particular cases, handle with care.
+
+___
+
+### shouldLoad
+
+• `Optional` **shouldLoad**: `boolean`
+
+Indicates if Screeb should be automatically loaded.
+This will ping to the Screeb servers.
+
+**`Remarks`**
+
+if `true`, 'load' does not need to be called manually. Can be used for multistaged environments
+
+___
+
+### userId
+
+• `Optional` **userId**: `string`
+
+The unique identifier of your user.
+
+___
+
+### userProperties
+
+• `Optional` **userProperties**: `PropertyRecord`
+
+The properties of your user.
+
+___
+
+### websiteId
+
+• `Optional` **websiteId**: `string`
+
+Your website/channel id.

package/docs/classes/ScreebModule.md

@@ -0,0 +1,61 @@
+[@screeb/sdk-angular](../README.md) / ScreebModule
+
+# Class: ScreebModule
+
+## Table of contents
+
+### Constructors
+
+- [constructor](ScreebModule.md#constructor)
+
+### Methods
+
+- [forRoot](ScreebModule.md#forroot)
+
+## Constructors
+
+### constructor
+
+• **new ScreebModule**(`config`, `screeb`)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `config` | [`ScreebConfig`](ScreebConfig.md) |
+| `screeb` | [`Screeb`](Screeb.md) |
+
+## Methods
+
+### forRoot
+
+▸ `Static` **forRoot**(`config`): `ModuleWithProviders`<[`ScreebModule`](ScreebModule.md)\>
+
+This is used to initialize Screeb at the top of your Angular application
+
+**`Example`**
+
+```ts
+ScreebModule.forRoot({
+  autoInit: true,
+  "<your-website-id>",
+  "<your-user-id>",
+  {
+    firstname: '<user-firstname>',
+    lastname: '<user-lastname>',
+    plan: '<user-plan>',
+    last_seen_at: new Date(),
+    authenticated: true
+  }
+})
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `config` | [`ScreebConfig`](ScreebConfig.md) | Configuration to pass to Screeb browser SDK |
+
+#### Returns
+
+`ModuleWithProviders`<[`ScreebModule`](ScreebModule.md)\>

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@screeb/sdk-angular",
+  "version": "0.1.1",
+  "description": "Screeb's browser sdk, optimized for Angular.",
+  "keywords": [
+    "product discovery",
+    "product management",
+    "survey",
+    "analytics",
+    "user feedback",
+    "user voice",
+    "user research"
+  ],
+  "homepage": "https://screeb.app",
+  "bugs": {
+    "url": "https://github.com/ScreebApp/sdk-js/issues",
+    "email": "support@screeb.app"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ScreebApp/sdk-js.git",
+    "directory": "packages/screeb-sdk-angular"
+  },
+  "license": "MIT",
+  "author": "Screeb's frontend team",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./dist/es/index.js"
+    }
+  },
+  "module": "dist/es/index.js",
+  "types": "dist/es/index.d.ts",
+  "files": [
+    "dist",
+    "docs",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "rollup -c ./node_modules/@screeb/typescript-config/src/rollup.config.js",
+    "build:doc": "typedoc src/index.ts",
+    "clean": "rm -Rf dist",
+    "lint": "eslint .",
+    "test": "echo '@TODO'"
+  },
+  "dependencies": {
+    "@screeb/sdk-browser": "^0.1.8"
+  },
+  "devDependencies": {
+    "@angular/common": "^16.0.3",
+    "@angular/core": "^16.0.3",
+    "@screeb/eslint-config": "^0.1.5",
+    "@screeb/sdk-browser": "^0.1.6",
+    "@screeb/typescript-config": "^0.1.5",
+    "@types/jest": "^29.5.1",
+    "@types/node": "^18.11.19",
+    "@typescript-eslint/eslint-plugin": "^5.59.6",
+    "eslint": "^8.41.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.8",
+    "rollup": "^3.23.0",
+    "typedoc": "^0.24.7",
+    "typedoc-plugin-markdown": "^3.15.3"
+  },
+  "peerDependencies": {
+    "@angular/common": ">=10",
+    "@angular/core": ">=10"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}