{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.19.4", "schemaVersion": 1004, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true } } }, "kind": "Package", "canonicalReference": "@samelogic/samelogic-js!", "docComment": "/**\n * Samelogic SDK contains the client that is required to run your Samelogic Projects in your product.\n *\n * The main entry point to samelogic.js is the {@link @samelogic/samelogic-js#Samelogic} class, which when instantiated with an appId, will return an object that is ready to use. This object requires an init() method to be called for the client to start.\n *\n * @packageDocumentation\n */\n", "name": "@samelogic/samelogic-js", "members": [ { "kind": "EntryPoint", "canonicalReference": "@samelogic/samelogic-js!", "name": "", "members": [ { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!ElementEventProps:interface", "docComment": "/**\n * The shape of the payload for the ElementClick and ElementMouseOver events.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface ElementEventProps extends " }, { "kind": "Reference", "text": "TriggerEventProps", "canonicalReference": "@samelogic/samelogic-js!TriggerEventProps:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "ElementEventProps", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!ElementEventProps#cssSelector:member", "docComment": "/**\n * The CSS Selector of the element that was clicked or hovered over.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "cssSelector: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "cssSelector", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!ElementEventProps#delayDefaultBehavior:member", "docComment": "/**\n * If the element had a default behavior, it will be delayed until the workflow is completed.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "delayDefaultBehavior?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "delayDefaultBehavior", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!ElementEventProps#event:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "event: " }, { "kind": "Content", "text": "'ElementClick' | 'ElementMouseOver'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "event", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!ElementEventProps#preventDefault:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "preventDefault?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "preventDefault", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!IdentityPropertySource:interface", "docComment": "/**\n * The configuration of the source of identity variables\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IdentityPropertySource " } ], "releaseTag": "Public", "name": "IdentityPropertySource", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!IdentityPropertySource#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!IdentityPropertySource#variable:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "variable: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "variable", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!IdentitySourceConfig:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface IdentitySourceConfig " } ], "releaseTag": "Public", "name": "IdentitySourceConfig", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!IdentitySourceConfig#email:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "email?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "email", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!IdentitySourceConfig#identity:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "identity?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "identity", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!IdentitySourceConfig#properties:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "properties?: " }, { "kind": "Reference", "text": "IdentityPropertySource", "canonicalReference": "@samelogic/samelogic-js!IdentityPropertySource:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "properties", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!Options:interface", "docComment": "/**\n * The options to pass into {@link @samelogic/samelogic-js#Samelogic} initialization.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface Options " } ], "releaseTag": "Public", "name": "Options", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!Options#baseUrl:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "baseUrl?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "baseUrl", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!Options#envId:member", "docComment": "/**\n * The `ENV_ID` provided, which you have received for creating a project on the Samelogic platform.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "envId: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "envId", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!Options#user:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "user?: " }, { "kind": "Reference", "text": "SLUser", "canonicalReference": "@samelogic/samelogic-js!SLUser:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "user", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!Options#workflows:member", "docComment": "/**\n * The list of currently **active** workflows. Worklows must be published to be active.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "workflows: " }, { "kind": "Reference", "text": "WorkflowConfig", "canonicalReference": "@samelogic/samelogic-js!WorkflowConfig:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "workflows", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!PageEventProps:interface", "docComment": "/**\n * The shape of the payload for the PageView event.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface PageEventProps extends " }, { "kind": "Reference", "text": "TriggerEventProps", "canonicalReference": "@samelogic/samelogic-js!TriggerEventProps:interface" }, { "kind": "Content", "text": " " } ], "releaseTag": "Public", "name": "PageEventProps", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!PageEventProps#event:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "event: " }, { "kind": "Content", "text": "'PageView'" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "event", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!PageEventProps#urlPattern:member", "docComment": "/**\n * A URL that can contain wildcards.\n *\n * @remarks\n *\n * For example, `https://samelogic.com/*\\/docs` matches all URLs that contain `samelogic.com` and end with `/docs`.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "urlPattern: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "urlPattern", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [ { "startIndex": 1, "endIndex": 3 } ] }, { "kind": "Class", "canonicalReference": "@samelogic/samelogic-js!Samelogic:class", "docComment": "/**\n * Samelogic Client SDK API. The Samelogic class handles the creation of a client instance.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class Samelogic " } ], "releaseTag": "Public", "name": "Samelogic", "members": [ { "kind": "Constructor", "canonicalReference": "@samelogic/samelogic-js!Samelogic:constructor(1)", "docComment": "/**\n * Samelogic Client SDK API - instance constructor. The Samelogic class handles the creation and configuration of a client instance.\n *\n * @param options - the configuration options for the client instance.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "constructor(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "@samelogic/samelogic-js!Options:interface" }, { "kind": "Content", "text": ");" } ], "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ] }, { "kind": "Method", "canonicalReference": "@samelogic/samelogic-js!Samelogic#identify:member(1)", "docComment": "/**\n * This method is used to uniquelly identify the user for maintaining an association across sessions.\n *\n * @param identity - this is a unique identifier for the user, such as an email address or a user ID.\n *\n * @param properties - this is a set of key/value pairs that can be used to enrich the user's profile.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "identify(identity: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", properties?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "identity", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "parameterName": "properties", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 5 } } ], "name": "identify" }, { "kind": "Method", "canonicalReference": "@samelogic/samelogic-js!Samelogic#init:member(1)", "docComment": "/**\n * Initializes the client instance. This will start the client to begin listening for triggers and executing worklows.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "init(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "init" }, { "kind": "Method", "canonicalReference": "@samelogic/samelogic-js!Samelogic.init:member(1)", "docComment": "/**\n * Creates an instance of the client and then initializes it. This is a static method and is a convenience method for initializing through a single API call from the window object. This allows tools like Google Tag Manager to initialize the client instance without the `new` keyword being available.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "static init(options: " }, { "kind": "Reference", "text": "Options", "canonicalReference": "@samelogic/samelogic-js!Options:interface" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "Samelogic", "canonicalReference": "@samelogic/samelogic-js!Samelogic:class" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "isStatic": true, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 7 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "options", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "name": "init" }, { "kind": "Method", "canonicalReference": "@samelogic/samelogic-js!Samelogic#resetIdentity:member(1)", "docComment": "/**\n * This method is used to reset the user session and identity. This can be used when the user logs out.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resetIdentity(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [], "name": "resetIdentity" }, { "kind": "Property", "canonicalReference": "@samelogic/samelogic-js!Samelogic#version:member", "docComment": "/**\n * The current version of the library\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readonly version: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "version", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false } ], "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!SLUser:interface", "docComment": "/**\n * A Samelogic user object.\n *\n * Maps 1:1 to LaunchDarkly user object. https://launchdarkly.github.io/node-client-sdk/interfaces/_launchdarkly_node_client_sdk_.lduser.html\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SLUser " } ], "releaseTag": "Public", "name": "SLUser", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!SLUser#email:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "email?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "email", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!SLUser#key:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "key?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "key", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!SLUser#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!StepConfig:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StepConfig " } ], "releaseTag": "Public", "name": "StepConfig", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!StepConfig#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!StepConfig#needs:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "needs?: " }, { "kind": "Reference", "text": "StepNeeds", "canonicalReference": "@samelogic/samelogic-js!StepNeeds:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "needs", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!StepConfig#props:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "props?: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "props", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!StepConfig#uses:member", "docComment": "/**\n * Can be the url of the package\n */\n", "excerptTokens": [ { "kind": "Content", "text": "uses: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "uses", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!StepNeeds:interface", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface StepNeeds " } ], "releaseTag": "Public", "name": "StepNeeds", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!StepNeeds#event:member", "docComment": "/**\n * if the dependency is a step, it should have an event\n */\n", "excerptTokens": [ { "kind": "Content", "text": "event?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "event", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!StepNeeds#name:member", "docComment": "/**\n * name of the trigger or step\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@samelogic/samelogic-js!TriggerConfig:type", "docComment": "/**\n * The configuration of a trigger.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type TriggerConfig = " }, { "kind": "Reference", "text": "TriggerEvents", "canonicalReference": "@samelogic/samelogic-js!TriggerEvents:type" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TriggerConfig", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!TriggerEventProps:interface", "docComment": "/**\n * The properties of an event.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface TriggerEventProps " } ], "releaseTag": "Public", "name": "TriggerEventProps", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!TriggerEventProps#event:member", "docComment": "/**\n * The event that determines what the rest of properties of this object should be.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "event: " }, { "kind": "Reference", "text": "TriggerEventType", "canonicalReference": "@samelogic/samelogic-js!TriggerEventType:type" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "event", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!TriggerEventProps#id:member", "docComment": "/**\n * The identifier of the trigger event for referencing event data published from the event.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@samelogic/samelogic-js!TriggerEvents:type", "docComment": "/**\n * The different trigger events that are supported. The properties of this object is dependent on the {@link @samelogic/samelogic-js#TriggerEventProps.event} property.\n *\n * @remarks\n *\n * When `event` is `ElementClick` or `ElementMouseOver`, the following properties are required:`{@link @samelogic/samelogic-js#ElementEventProps.cssSelector}`\n *\n * When `event` is `PageView`, the following properties are required:`{@link @samelogic/samelogic-js#PageEventProps.urlPattern}`\n *\n * See the references of each type for more details.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type TriggerEvents = " }, { "kind": "Reference", "text": "ElementEventProps", "canonicalReference": "@samelogic/samelogic-js!ElementEventProps:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "PageEventProps", "canonicalReference": "@samelogic/samelogic-js!PageEventProps:interface" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TriggerEvents", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "TypeAlias", "canonicalReference": "@samelogic/samelogic-js!TriggerEventType:type", "docComment": "/**\n * The type of event. This will determine what properties of {@link @samelogic/samelogic-js#TriggerEvents} are required.\n *\n * @remarks\n *\n * `ElementClick` refers to the click event on a DOM element, see {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/click_event}.\n *\n * `ElementMouseOver` refers to the mouseover event on a DOM element, see {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/mouseover_event}. note: This mouseover event will fire and bubble the event up the DOM, see {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/mouseenter_event}\n *\n * `PageView` matching occurs when the page is loaded or the url has changed.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare type TriggerEventType = " }, { "kind": "Content", "text": "'ElementClick' | 'ElementMouseOver' | 'PageView'" }, { "kind": "Content", "text": ";" } ], "releaseTag": "Public", "name": "TriggerEventType", "typeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "Interface", "canonicalReference": "@samelogic/samelogic-js!WorkflowConfig:interface", "docComment": "/**\n * This is the configuration of a workflow. Workflows are made up of steps and triggers. Triggers are events used to trigger the execution of steps.\n *\n * @remarks\n *\n * When the Samelogic SDK is initialized, the workflow configuration is loaded and executed immediately. This means that the trigger will be setup to listen for the configured events. When all of the event conditions are met, the workflow will execute the configured steps.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface WorkflowConfig " } ], "releaseTag": "Public", "name": "WorkflowConfig", "members": [ { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!WorkflowConfig#id:member", "docComment": "/**\n * Optional for identification\n */\n", "excerptTokens": [ { "kind": "Content", "text": "id?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "id", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!WorkflowConfig#identitySource:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "identitySource?: " }, { "kind": "Reference", "text": "IdentitySourceConfig", "canonicalReference": "@samelogic/samelogic-js!IdentitySourceConfig:interface" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "identitySource", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!WorkflowConfig#logEndpoint:member", "docComment": "/**\n * Endpoint where all triggers and events will be logged to\n */\n", "excerptTokens": [ { "kind": "Content", "text": "logEndpoint?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "logEndpoint", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!WorkflowConfig#name:member", "docComment": "/**\n * The name given to the workflow.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!WorkflowConfig#steps:member", "docComment": "/**\n * The configuration of all the steps to be executed when the trigger is fired.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "steps: " }, { "kind": "Reference", "text": "StepConfig", "canonicalReference": "@samelogic/samelogic-js!StepConfig:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": false, "releaseTag": "Public", "name": "steps", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@samelogic/samelogic-js!WorkflowConfig#triggers:member", "docComment": "/**\n * A list of events or conditions that needs to be met to trigger the execution of the steps. If this is not specified, the trigger will be executed immediately. The order of the trigger is not taken into account.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "triggers?: " }, { "kind": "Reference", "text": "TriggerConfig", "canonicalReference": "@samelogic/samelogic-js!TriggerConfig:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isOptional": true, "releaseTag": "Public", "name": "triggers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] } ] } ] }