@screeb/sdk-vue 0.1.1

package/docs/README.md

@@ -0,0 +1,452 @@
+@screeb/sdk-vue
+
+# @screeb/sdk-vue
+
+## Table of contents
+
+### Type Aliases
+
+- [CloseFunction](README.md#closefunction)
+- [DebugFunction](README.md#debugfunction)
+- [EventTrackFunction](README.md#eventtrackfunction)
+- [IdentityFunction](README.md#identityfunction)
+- [IdentityGetFunction](README.md#identitygetfunction)
+- [IdentityGroupAssignFunction](README.md#identitygroupassignfunction)
+- [IdentityGroupUnassignFunction](README.md#identitygroupunassignfunction)
+- [IdentityPropertiesFunction](README.md#identitypropertiesfunction)
+- [IdentityResetFunction](README.md#identityresetfunction)
+- [InitFunction](README.md#initfunction)
+- [LoadFunction](README.md#loadfunction)
+- [MessageCloseFunction](README.md#messageclosefunction)
+- [MessageStartFunction](README.md#messagestartfunction)
+- [ScreebConfig](README.md#screebconfig)
+- [ScreebContextValues](README.md#screebcontextvalues)
+- [SessionReplayStartFunction](README.md#sessionreplaystartfunction)
+- [SessionReplayStopFunction](README.md#sessionreplaystopfunction)
+- [SurveyCloseFunction](README.md#surveyclosefunction)
+- [SurveyStartFunction](README.md#surveystartfunction)
+- [TargetingCheckFunction](README.md#targetingcheckfunction)
+- [TargetingDebugFunction](README.md#targetingdebugfunction)
+
+### Variables
+
+- [SCREEB\_PLUGIN\_KEY](README.md#screeb_plugin_key)
+- [ScreebPlugin](README.md#screebplugin)
+
+### Functions
+
+- [useScreeb](README.md#usescreeb)
+
+## Type Aliases
+
+### CloseFunction
+
+Ƭ **CloseFunction**: () => `Promise`\<`void`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`void`\>
+
+##### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### DebugFunction
+
+Ƭ **DebugFunction**: () => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### EventTrackFunction
+
+Ƭ **EventTrackFunction**: (`eventName`: `string`, `eventProperties?`: `PropertyRecord`) => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (`eventName`, `eventProperties?`): `Promise`\<`unknown`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `eventName` | `string` |
+| `eventProperties?` | `PropertyRecord` |
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### IdentityFunction
+
+Ƭ **IdentityFunction**: (`userId`: `string`, `userProperties?`: `PropertyRecord`) => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (`userId`, `userProperties?`): `Promise`\<`unknown`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `userId` | `string` |
+| `userProperties?` | `PropertyRecord` |
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### IdentityGetFunction
+
+Ƭ **IdentityGetFunction**: () => `Promise`\<`ScreebIdentityGetReturn`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`ScreebIdentityGetReturn`\>
+
+##### Returns
+
+`Promise`\<`ScreebIdentityGetReturn`\>
+
+___
+
+### IdentityGroupAssignFunction
+
+Ƭ **IdentityGroupAssignFunction**: (`groupName`: `string`, `groupType?`: `string`, `groupProperties?`: `PropertyRecord`) => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (`groupName`, `groupType?`, `groupProperties?`): `Promise`\<`unknown`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `groupName` | `string` |
+| `groupType?` | `string` |
+| `groupProperties?` | `PropertyRecord` |
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### IdentityGroupUnassignFunction
+
+Ƭ **IdentityGroupUnassignFunction**: (`groupName`: `string`, `groupType?`: `string`) => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (`groupName`, `groupType?`): `Promise`\<`unknown`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `groupName` | `string` |
+| `groupType?` | `string` |
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### IdentityPropertiesFunction
+
+Ƭ **IdentityPropertiesFunction**: (`userProperties`: `PropertyRecord`) => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (`userProperties`): `Promise`\<`unknown`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `userProperties` | `PropertyRecord` |
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### IdentityResetFunction
+
+Ƭ **IdentityResetFunction**: () => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### InitFunction
+
+Ƭ **InitFunction**: (`websiteId`: `string`, `userId?`: `string`, `userProperties?`: `PropertyRecord`, `hooks?`: `HooksInit`, `language?`: `string`) => `Promise`\<`void`\>
+
+#### Type declaration
+
+▸ (`websiteId`, `userId?`, `userProperties?`, `hooks?`, `language?`): `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `websiteId` | `string` |
+| `userId?` | `string` |
+| `userProperties?` | `PropertyRecord` |
+| `hooks?` | `HooksInit` |
+| `language?` | `string` |
+
+##### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### LoadFunction
+
+Ƭ **LoadFunction**: (`options?`: `ScreebOptions`) => `Promise`\<`void`\>
+
+#### Type declaration
+
+▸ (`options?`): `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `options?` | `ScreebOptions` |
+
+##### Returns
+
+`Promise`\<`void`\>
+
+___
+
+### MessageCloseFunction
+
+Ƭ **MessageCloseFunction**: () => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### MessageStartFunction
+
+Ƭ **MessageStartFunction**: (`messageId`: `string`, `allowMultipleResponses?`: `boolean`, `hiddenFields?`: `PropertyRecord`, `hooks?`: `HooksMessageStart`, `language?`: `string`) => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (`messageId`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`): `Promise`\<`unknown`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `messageId` | `string` |
+| `allowMultipleResponses?` | `boolean` |
+| `hiddenFields?` | `PropertyRecord` |
+| `hooks?` | `HooksMessageStart` |
+| `language?` | `string` |
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### ScreebConfig
+
+Ƭ **ScreebConfig**: `Object`
+
+Configuration for the ScreebPlugin
+
+#### Type declaration
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `autoInit?` | `boolean` | Indicates if Screeb should be automatically initialized. When true, `init` is called automatically with `websiteId` and `userId`. **`Default`** ```ts false ``` |
+| `hooks?` | `HooksInit` | Hooks to define callback for various Screeb events |
+| `language?` | `string` | Force a specific language (e.g. 'en'). Default: browser language. |
+| `options?` | `ScreebOptions` | Screeb tag initialization options — handle with care. |
+| `shouldLoad?` | `boolean` | Indicates if Screeb should be automatically loaded. Set to false to prevent the SDK from loading (e.g. in CI). **`Default`** ```ts true ``` |
+| `userId?` | `string` | The unique identifier of your user. |
+| `userProperties?` | `PropertyRecord` | The properties of your user. |
+| `websiteId` | `string` | Your website/channel id. |
+
+___
+
+### ScreebContextValues
+
+Ƭ **ScreebContextValues**: `Object`
+
+All Screeb methods provided via `useScreeb()`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `close` | [`CloseFunction`](README.md#closefunction) |
+| `debug` | [`DebugFunction`](README.md#debugfunction) |
+| `eventTrack` | [`EventTrackFunction`](README.md#eventtrackfunction) |
+| `identity` | [`IdentityFunction`](README.md#identityfunction) |
+| `identityGet` | [`IdentityGetFunction`](README.md#identitygetfunction) |
+| `identityGroupAssign` | [`IdentityGroupAssignFunction`](README.md#identitygroupassignfunction) |
+| `identityGroupUnassign` | [`IdentityGroupUnassignFunction`](README.md#identitygroupunassignfunction) |
+| `identityProperties` | [`IdentityPropertiesFunction`](README.md#identitypropertiesfunction) |
+| `identityReset` | [`IdentityResetFunction`](README.md#identityresetfunction) |
+| `init` | [`InitFunction`](README.md#initfunction) |
+| `load` | [`LoadFunction`](README.md#loadfunction) |
+| `messageClose` | [`MessageCloseFunction`](README.md#messageclosefunction) |
+| `messageStart` | [`MessageStartFunction`](README.md#messagestartfunction) |
+| `sessionReplayStart` | [`SessionReplayStartFunction`](README.md#sessionreplaystartfunction) |
+| `sessionReplayStop` | [`SessionReplayStopFunction`](README.md#sessionreplaystopfunction) |
+| `surveyClose` | [`SurveyCloseFunction`](README.md#surveyclosefunction) |
+| `surveyStart` | [`SurveyStartFunction`](README.md#surveystartfunction) |
+| `targetingCheck` | [`TargetingCheckFunction`](README.md#targetingcheckfunction) |
+| `targetingDebug` | [`TargetingDebugFunction`](README.md#targetingdebugfunction) |
+
+___
+
+### SessionReplayStartFunction
+
+Ƭ **SessionReplayStartFunction**: () => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### SessionReplayStopFunction
+
+Ƭ **SessionReplayStopFunction**: () => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### SurveyCloseFunction
+
+Ƭ **SurveyCloseFunction**: () => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### SurveyStartFunction
+
+Ƭ **SurveyStartFunction**: (`surveyId`: `string`, `distributionId?`: `string`, `allowMultipleResponses?`: `boolean`, `hiddenFields?`: `PropertyRecord`, `hooks?`: `HooksSurveyStart`, `language?`: `string`, `selectors?`: `string` \| `string`[]) => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (`surveyId`, `distributionId?`, `allowMultipleResponses?`, `hiddenFields?`, `hooks?`, `language?`, `selectors?`): `Promise`\<`unknown`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `surveyId` | `string` |
+| `distributionId?` | `string` |
+| `allowMultipleResponses?` | `boolean` |
+| `hiddenFields?` | `PropertyRecord` |
+| `hooks?` | `HooksSurveyStart` |
+| `language?` | `string` |
+| `selectors?` | `string` \| `string`[] |
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### TargetingCheckFunction
+
+Ƭ **TargetingCheckFunction**: () => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+___
+
+### TargetingDebugFunction
+
+Ƭ **TargetingDebugFunction**: () => `Promise`\<`unknown`\>
+
+#### Type declaration
+
+▸ (): `Promise`\<`unknown`\>
+
+##### Returns
+
+`Promise`\<`unknown`\>
+
+## Variables
+
+### SCREEB\_PLUGIN\_KEY
+
+• `Const` **SCREEB\_PLUGIN\_KEY**: `InjectionKey`\<[`ScreebContextValues`](README.md#screebcontextvalues)\>
+
+___
+
+### ScreebPlugin
+
+• `Const` **ScreebPlugin**: `Plugin`
+
+## Functions
+
+### useScreeb
+
+▸ **useScreeb**(): [`ScreebContextValues`](README.md#screebcontextvalues)
+
+#### Returns
+
+[`ScreebContextValues`](README.md#screebcontextvalues)

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@screeb/sdk-vue",
+  "version": "0.1.1",
+  "description": "Screeb's browser SDK, optimized for Vue 3.",
+  "keywords": [
+    "product discovery",
+    "product management",
+    "survey",
+    "analytics",
+    "user feedback",
+    "user research",
+    "vue"
+  ],
+  "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/sdk-vue"
+  },
+  "license": "MIT",
+  "author": "Screeb's frontend team",
+  "sideEffects": false,
+  "type": "module",
+  "module": "dist/es/index.mjs",
+  "main": "dist/cjs/index.cjs",
+  "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.5.0"
+  },
+  "devDependencies": {
+    "@screeb/eslint-config": "^0.1.6",
+    "@screeb/typescript-config": "^0.1.10",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "eslint": "^8.51.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-prettier": "^5.0.1",
+    "rollup": "^4.0.2",
+    "typedoc": "^0.25.2",
+    "typedoc-plugin-markdown": "^3.16.0",
+    "typescript": "^5.2.2",
+    "vue": ">=3.0.0"
+  },
+  "peerDependencies": {
+    "vue": ">=3.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}