@incognia/web-sdk-types 1.5.0

package/README.md

@@ -0,0 +1,13 @@
+![Alt logoImage][logo]
+
+# Incognia SDK TypeScript Definitions
+
+This package contains TypeScript definitions for the `window.IncogniaWebSdk` global object. It is only necessary if your project:
+
+- Uses TypeScript; and
+- Integrates using a `<script>` tag pointing to the Incognia CDN (instead of https://www.npmjs.com/package/@incognia/web-sdk).
+
+See our [documentation][docs] for more details.
+
+[logo]: https://www.incognia.com/hubfs/US/Brand/Logo/logo-incognia-purple.svg
+[docs]: https://developer.incognia.com/docs/web/v1

package/index.d.ts

@@ -0,0 +1,57 @@
+type Identity = {
+  accountId: string
+}
+/**
+ * @deprecated Since v1.2.0 - Use `GenerateRequestTokenParams` instead.
+ */
+type GetSessionTokenParams = {
+  askForGeolocation: boolean
+}
+type GenerateRequestTokenParams = {
+  askForGeolocation: boolean
+}
+type EventProperties = Record<string, string | number | boolean>
+type EventAddress = {
+  locale?: string
+  countryCode?: string
+  countryName?: string
+  state?: string
+  city?: string
+  neighborhood?: string
+  number?: string | number
+  street?: string
+  postalCode?: string | number
+  addressLine?: string
+  latitude?: number
+  longitude?: number
+}
+type CustomEventParams = {
+  tag: string
+  accountId?: string | number
+  externalId?: string | number
+  address?: EventAddress
+  properties?: EventProperties
+}
+type IncogniaOptions = {
+  appId?: string
+  logEnabled?: boolean
+}
+type IncogniaWebSdk = {
+  init(appIdOrOptions: string | IncogniaOptions): Promise<void>
+  setAccountId(accountId: string): Promise<void>
+  clearAccountId(): Promise<void>
+  /**
+   * @deprecated Since v1.2.0 - Use `setAccountId` to set a new account id and `clearAccountId` to clear the account id instead.
+   */
+  identify(identity: Identity): Promise<void>
+  generateRequestToken(
+    options?: GenerateRequestTokenParams
+  ): Promise<string | undefined>
+  /**
+   * @deprecated Since v1.2.0 - Use `generateRequestToken` instead.
+   */
+  getSessionToken(options?: GetSessionTokenParams): Promise<string | undefined>
+  sendCustomEvent(params: CustomEventParams): Promise<void>
+}
+// eslint-disable-next-line no-redeclare
+declare var IncogniaWebSdk: IncogniaWebSdk

package/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@incognia/web-sdk-types",
+  "description": "Incognia SDK type definitions",
+  "author": "",
+  "version": "1.5.0",
+  "license": "MIT",
+  "keywords": [
+    "incognia",
+    "web",
+    "sdk"
+  ],
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts"
+  ]
+}