@giosg/types 6.5.0 → 7.0.1

package/CHANGELOG.md

@@ -4,17 +4,50 @@ Hint: use `git diff <commithash>..HEAD src/` to see changes
 
 ## x.x.x (Not published yet)
 
+## 7.0.1
+
+- Added interfaces for the brand editor
+
+## 7.0.0
+
+- Added support for CommonJS
+- Changed import paths by adding `cjs` and `esm` directories to the package - some imports in dependent projects may need to be updated.
+
+## 6.10.0
+
+- Added the `GiosgBrand` interface
+
+## 6.9.0
+
+- Removed Reporting Target
+
+## 6.8.0
+
+- Removed Cobrowse Reporting
+
+## 6.7.0
+
+- Added `is_user_deleted` field to `ChatMembershipUser` interface
+
+## 6.6.0
+
+- Added types for giosg Transparency&Consent API
+
 ## 6.5.0
+
 - Renamed `screen_sharing_state` field to `cobrowser_state` at `InCallStatus` interface
 
 ## 6.4.0
+
 - Modified types for call status
 - Added `screen_sharing_state` field to `InCallStatus` interface
 
 ## 6.3.0
+
 - Added type for call status
 
 ## 6.2.2
+
 - Fixed type of `brand` field in `PublicRoom` types
 - Chat button asset fields added to the `Brand` interface
 
@@ -48,12 +81,13 @@ Hint: use `git diff <commithash>..HEAD src/` to see changes
 - Add `ComposingStatus`, `ChatWithRoom`, `ChatMessageWithChat` and `RulePrediction`.
 - Correctly mark the domain on `NestedRoom` as a potentially `null` value.
 
-
 ## 4.6.0
+
 - Add `is_removed` field for `BarChats`.
 - ConditionHasChattedSettings type was removed
 
 ## 4.5.0
+
 - Add `is_available` field for `BarChats`.
 
 ## 4.4.5
@@ -98,7 +132,7 @@ Hint: use `git diff <commithash>..HEAD src/` to see changes
 
 ## 4.0.0
 
-### Breaking changes:
+### Breaking changes
 
 - Removed `unread_message_count` from `BarChat` interface.
 - Removed `is_participating` from `BarChat` interface.
@@ -140,7 +174,7 @@ Hint: use `git diff <commithash>..HEAD src/` to see changes
 - Added `sla` field to `StaffCustomership` and `StaffCustomershipPayload`.
 - Added `is_auto_tagging_enabled` boolean field to `OrganizationRoomSettings` and `OrganizationRoomSettingsPayload` interfaces.
 
-### Breaking changes:
+### Breaking changes
 
 - Merged `RoomVisitorVariable` and `ChatVisitorVariable` to `VisitorVariable`
 - Merged `RoomVisitorVariablePayload` and `ChatVisitorVariablePayload` to `VisitorVariablePayload`
@@ -153,8 +187,7 @@ Hint: use `git diff <commithash>..HEAD src/` to see changes
 
 - Added new interfaces `GiosgAppInstance`, `GiosgApp`, `GiosgAppPayload`, `InstalledGiosgApp`, `NestedGiosgApp`, `Brand`, `BrandPayload`, `PublicBrand`, `CannedAnswerIncrement`,`CannedAnswer`, `CannedAnswerPayload`, `ChatAssignment`, `LeadFormData`, `LeadFormDataPayload` `AppShare`, `AppSharePayload`, `ShoppingCartProduct`, `ShoppingCart`, `EndpointMethod` `Endpoint`, `Language`, `NestedTargetRule`, `NestedTargetConfig`, `TargetConfig`, `TargetExperiment`, `TargetedAction`, `TargetedActionPayload`, `VisitorPredictionList`, `VisitorPrediction`, `VisitorPredictionPayload`, `VisitorSessionPrediction`, `VisitorSessionPredictionPayload`, `RoomVisitorVariable`, `RoomVisitorVariablePayload`, `NestedWebhookChannelSubscription`, `NestedWebhookChannelSubscriptionPayload`, `WebhookRequestLogEntry`, `Webhook`, `WebhookPayload`
 
-
-### Breaking changes:
+### Breaking changes
 
 - Renamed `VisitorSessionId` to `VisitorSessionCid`.
 - Renamed `VisitorGlobalSessionId` to `VisitorSessionGid`.

package/lib/GiosgTCApi.d.ts

@@ -0,0 +1,113 @@
+export declare const supportedEventTypes: readonly ["tcChange"];
+export declare type EventType = typeof supportedEventTypes[number];
+export declare type TCEventListener = (consent: TCPreferences) => void;
+/**
+ * For further reading reagarding the different purposes https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/#A_Purposes.
+ */
+export declare enum Purpose {
+    AccessLocalOrSessionStorage = 1,
+    SelectBasicAds = 2,
+    CreatePersonalizedAdProfile = 3,
+    SelectPersonalizedAds = 4,
+    CreatePersonalizedContentProfile = 5,
+    SelectPersonalizedContent = 6,
+    MeasureAdPerformance = 7,
+    MeasureContentPerformance = 8,
+    ApplyMarketResearchToGenerateAudienceInsights = 9,
+    DevelopAndImproveProducts = 10
+}
+export interface TCPreferences {
+    purpose: {
+        consents: {
+            [purposeID: number]: boolean;
+        };
+        legitimateInterests: {
+            [purposeID: number]: boolean;
+        };
+    };
+    vendor: boolean;
+}
+export interface IGiosgTCApi {
+    /**
+     * Returns required purposes.
+     */
+    getRequiredTC(): Purpose[];
+    /**
+     * When a user defines their TC preferences for the site, the site calls this function to notify Giosg.
+     * Defaults to false.
+     */
+    setVisitorConsent(consent: TCPreferences): void;
+    /**
+     * Returns the visitorConsent value from the Giosg.
+     */
+    getVisitorConsent(): TCPreferences;
+    /**
+     * Registered callback function gets called if TC preference is changed by user interacting with Giosg products.
+     * Returns listener id.
+     */
+    addEventListener(eventType: EventType, cb: (consent: TCPreferences) => void): number | void;
+    /**
+     * Remove event listener for with given listenerID.
+     * Return boolean based on the success of removal.
+     */
+    removeEventListener(listenerID: number): boolean;
+}
+export interface ITCApi {
+    /**
+     * This is public only so that the this and customer facing modules can poke each
+     * other without hacks and hence the dunder naming.
+     * Saves new signal and calls all subscribers for new consent.
+     *
+     * @param newPreference New preference which all subscribers are notified with.
+     */
+    __notifyTCPreferenceChange(newPreference: TCPreferences): void;
+    /**
+     *
+     * @returns List of purposes which are required to run all current giosg services.
+     */
+    getRequiredTC(): Purpose[];
+    /**
+     *
+     * @returns Current visitor consent preferences.
+     */
+    getVisitorConsent(): TCPreferences;
+    /**
+     * Set given purposeIDs true in consent.
+     * @param purposeIDs Purposes to enable.
+     * @returns Returns boolean based on success.
+     */
+    enableVisitorConsent(purposeIDs: Purpose[]): boolean;
+    /**
+     *
+     * @returns Boolean based on is the IAB TC Framework active in site or not.
+     */
+    isTCFrameworkInUse(): boolean;
+    /**
+     * Sets the visitor consent preference to be the new provided one.
+     * Checks if the IAB TCF is not active and tries to set the consent.
+     * If IAB TCF found consents cant be modified and returns false.
+     * @param newPreference New visitor TC preference object.
+     * @returns Boolean based on was the action successful or not.
+     */
+    setVisitorConsent(newPreference: TCPreferences): boolean;
+    /**
+     * Adds a new event listener.
+     * @param eventType Event type to subscribe for.
+     * @param cb Callback to call when the event happens.
+     * @returns Listener ID as a string if event listener registered properly.
+     */
+    addEventListener(eventType: EventType, cb: (consent: TCPreferences) => void): string | never;
+    /**
+     * Removes event listener.
+     * @param listenerID Listener ID to be removed.
+     * @returns Boolean based on was the action successful
+     */
+    removeEventListener(listenerID: string): boolean;
+    /**
+     * Checks if visitor has given permission for given purposes.
+     * @param requiredPurposes List of purposes which needs to be true.
+     * @returns Boolean based on were all requiredPurposes set to true.
+     */
+    hasSufficientPermissions(requiredPurposes: Purpose[]): boolean;
+}
+//# sourceMappingURL=GiosgTCApi.d.ts.map

package/lib/GiosgTCApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GiosgTCApi.d.ts","sourceRoot":"","sources":["../src/GiosgTCApi.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,uBAAwB,CAAC;AACzD,oBAAY,SAAS,GAAG,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAC3D,oBAAY,eAAe,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,CAAC;AAE/D;;GAEG;AACH,oBAAY,OAAO;IACjB,2BAA2B,IAAI;IAC/B,cAAc,IAAI;IAClB,2BAA2B,IAAI;IAC/B,qBAAqB,IAAI;IACzB,gCAAgC,IAAI;IACpC,yBAAyB,IAAI;IAC7B,oBAAoB,IAAI;IACxB,yBAAyB,IAAI;IAC7B,6CAA6C,IAAI;IACjD,yBAAyB,KAAK;CAC/B;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE;QACP,QAAQ,EAAE;YAAE,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAC3C,mBAAmB,EAAE;YAAE,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACvD,CAAC;IACF,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,aAAa,IAAI,OAAO,EAAE,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAChD;;OAEG;IACH,iBAAiB,IAAI,aAAa,CAAC;IACnC;;;OAGG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAC5F;;;OAGG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;CAClD;AAED,MAAM,WAAW,MAAM;IACrB;;;;;;OAMG;IACH,0BAA0B,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/D;;;OAGG;IACH,aAAa,IAAI,OAAO,EAAE,CAAC;IAE3B;;;OAGG;IACH,iBAAiB,IAAI,aAAa,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAErD;;;OAGG;IACH,kBAAkB,IAAI,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,iBAAiB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC;IAEzD;;;;;OAKG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAE7F;;;;OAIG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjD;;;;OAIG;IACH,wBAAwB,CAAC,gBAAgB,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;CAChE"}

package/lib/GiosgTCApi.js

@@ -0,0 +1,17 @@
+export var supportedEventTypes = ["tcChange"];
+/**
+ * For further reading reagarding the different purposes https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/#A_Purposes.
+ */
+export var Purpose;
+(function (Purpose) {
+    Purpose[Purpose["AccessLocalOrSessionStorage"] = 1] = "AccessLocalOrSessionStorage";
+    Purpose[Purpose["SelectBasicAds"] = 2] = "SelectBasicAds";
+    Purpose[Purpose["CreatePersonalizedAdProfile"] = 3] = "CreatePersonalizedAdProfile";
+    Purpose[Purpose["SelectPersonalizedAds"] = 4] = "SelectPersonalizedAds";
+    Purpose[Purpose["CreatePersonalizedContentProfile"] = 5] = "CreatePersonalizedContentProfile";
+    Purpose[Purpose["SelectPersonalizedContent"] = 6] = "SelectPersonalizedContent";
+    Purpose[Purpose["MeasureAdPerformance"] = 7] = "MeasureAdPerformance";
+    Purpose[Purpose["MeasureContentPerformance"] = 8] = "MeasureContentPerformance";
+    Purpose[Purpose["ApplyMarketResearchToGenerateAudienceInsights"] = 9] = "ApplyMarketResearchToGenerateAudienceInsights";
+    Purpose[Purpose["DevelopAndImproveProducts"] = 10] = "DevelopAndImproveProducts";
+})(Purpose || (Purpose = {}));

package/lib/apps.js

@@ -1 +0,0 @@
-export {};

package/lib/assets.js

@@ -1 +0,0 @@
-export {};

package/lib/brands.js

@@ -1 +0,0 @@
-export {};

package/lib/call.js

@@ -1 +0,0 @@
-export {};

package/lib/canned_answers.js

@@ -1 +0,0 @@
-export {};

package/lib/chat.js

@@ -1 +0,0 @@
-export {};

package/lib/cjs/GiosgTCApi.d.ts

@@ -0,0 +1,118 @@
+export declare const supportedEventTypes: readonly ["tcChange"];
+export declare type EventType = typeof supportedEventTypes[number];
+export declare type TCEventListener = (consent: TCPreferences) => void;
+/**
+ * For further reading reagarding the different purposes https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/#A_Purposes.
+ */
+export declare enum Purpose {
+    AccessLocalOrSessionStorage = 1,
+    SelectBasicAds = 2,
+    CreatePersonalizedAdProfile = 3,
+    SelectPersonalizedAds = 4,
+    CreatePersonalizedContentProfile = 5,
+    SelectPersonalizedContent = 6,
+    MeasureAdPerformance = 7,
+    MeasureContentPerformance = 8,
+    ApplyMarketResearchToGenerateAudienceInsights = 9,
+    DevelopAndImproveProducts = 10
+}
+export declare enum Service {
+    All = 0,
+    Chat = 1
+}
+export interface TCPreferences {
+    purpose: {
+        consents: {
+            [purposeID: number]: boolean;
+        };
+        legitimateInterests: {
+            [purposeID: number]: boolean;
+        };
+    };
+    vendor: boolean;
+}
+export interface IGiosgTCApi {
+    /**
+     * Returns required purposes.
+     */
+    getRequiredTC(): Purpose[];
+    /**
+     * When a user defines their TC preferences for the site, the site calls this function to notify Giosg.
+     * Defaults to false.
+     */
+    setVisitorConsent(consent: TCPreferences): void;
+    /**
+     * Returns the visitorConsent value from the Giosg.
+     */
+    getVisitorConsent(): TCPreferences;
+    /**
+     * Registered callback function gets called if TC preference is changed by user interacting with Giosg products.
+     * Returns listener id.
+     */
+    addEventListener(eventType: EventType, cb: (consent: TCPreferences) => void): number | void;
+    /**
+     * Remove event listener for with given listenerID.
+     * Return boolean based on the success of removal.
+     */
+    removeEventListener(listenerID: number): boolean;
+}
+export interface ITCApi {
+    /**
+     * This is public only so that the this and customer facing modules can poke each
+     * other without hacks and hence the dunder naming.
+     * Saves new signal and calls all subscribers for new consent.
+     *
+     * @param newPreference New preference which all subscribers are notified with.
+     */
+    __notifyTCPreferenceChange(newPreference: TCPreferences): void;
+    /**
+     * @param forService The Service which minimum required TC is requested.
+     *
+     * @returns List of purposes which are required to run the given giosg Service.
+     */
+    getRequiredTC(forService: Service): Purpose[];
+    /**
+     *
+     * @returns Current visitor consent preferences.
+     */
+    getVisitorConsent(): TCPreferences;
+    /**
+     * Set given purposeIDs true in consent.
+     * @param purposeIDs Purposes to enable.
+     * @returns Returns boolean based on success.
+     */
+    enableVisitorConsent(purposeIDs: Purpose[]): boolean;
+    /**
+     *
+     * @returns Boolean based on is the IAB TC Framework active in site or not.
+     */
+    isTCFrameworkInUse(): boolean;
+    /**
+     * Sets the visitor consent preference to be the new provided one.
+     * Checks if the IAB TCF is not active and tries to set the consent.
+     * If IAB TCF found consents cant be modified and returns false.
+     * @param newPreference New visitor TC preference object.
+     * @returns Boolean based on was the action successful or not.
+     */
+    setVisitorConsent(newPreference: TCPreferences): boolean;
+    /**
+     * Adds a new event listener.
+     * @param eventType Event type to subscribe for.
+     * @param cb Callback to call when the event happens.
+     * @returns Listener ID as a string if event listener registered properly.
+     */
+    addEventListener(eventType: EventType, cb: (consent: TCPreferences) => void): string | never;
+    /**
+     * Removes event listener.
+     * @param listenerID Listener ID to be removed.
+     * @returns Boolean based on was the action successful
+     */
+    removeEventListener(listenerID: string): boolean;
+    /**
+     * Checks if visitor has given permission for given purposes.
+     * @param requiredPurposes List of purposes which needs to be true.
+     * @returns Boolean based on were all requiredPurposes set to true.
+     */
+    hasSufficientPermissions(requiredPurposes: Purpose[]): boolean;
+}
+//# sourceMappingURL=GiosgTCApi.d.ts.map

package/lib/cjs/GiosgTCApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GiosgTCApi.d.ts","sourceRoot":"","sources":["../../src/GiosgTCApi.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,uBAAwB,CAAC;AACzD,oBAAY,SAAS,GAAG,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAC3D,oBAAY,eAAe,GAAG,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,CAAC;AAE/D;;GAEG;AACH,oBAAY,OAAO;IACjB,2BAA2B,IAAI;IAC/B,cAAc,IAAI;IAClB,2BAA2B,IAAI;IAC/B,qBAAqB,IAAI;IACzB,gCAAgC,IAAI;IACpC,yBAAyB,IAAI;IAC7B,oBAAoB,IAAI;IACxB,yBAAyB,IAAI;IAC7B,6CAA6C,IAAI;IACjD,yBAAyB,KAAK;CAC/B;AAED,oBAAY,OAAO;IACjB,GAAG,IAAA;IACH,IAAI,IAAA;CACL;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE;QACP,QAAQ,EAAE;YAAE,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAC3C,mBAAmB,EAAE;YAAE,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;KACvD,CAAC;IACF,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,aAAa,IAAI,OAAO,EAAE,CAAC;IAC3B;;;OAGG;IACH,iBAAiB,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAChD;;OAEG;IACH,iBAAiB,IAAI,aAAa,CAAC;IACnC;;;OAGG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAC5F;;;OAGG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;CAClD;AAED,MAAM,WAAW,MAAM;IACrB;;;;;;OAMG;IACH,0BAA0B,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAE/D;;;;OAIG;IACH,aAAa,CAAC,UAAU,EAAE,OAAO,GAAG,OAAO,EAAE,CAAC;IAE9C;;;OAGG;IACH,iBAAiB,IAAI,aAAa,CAAC;IAEnC;;;;OAIG;IACH,oBAAoB,CAAC,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAErD;;;OAGG;IACH,kBAAkB,IAAI,OAAO,CAAC;IAE9B;;;;;;OAMG;IACH,iBAAiB,CAAC,aAAa,EAAE,aAAa,GAAG,OAAO,CAAC;IAEzD;;;;;OAKG;IACH,gBAAgB,CAAC,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,aAAa,KAAK,IAAI,GAAG,MAAM,GAAG,KAAK,CAAC;IAE7F;;;;OAIG;IACH,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;IAEjD;;;;OAIG;IACH,wBAAwB,CAAC,gBAAgB,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;CAChE"}

package/lib/cjs/GiosgTCApi.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Service = exports.Purpose = exports.supportedEventTypes = void 0;
+exports.supportedEventTypes = ["tcChange"];
+/**
+ * For further reading reagarding the different purposes https://iabeurope.eu/iab-europe-transparency-consent-framework-policies/#A_Purposes.
+ */
+var Purpose;
+(function (Purpose) {
+    Purpose[Purpose["AccessLocalOrSessionStorage"] = 1] = "AccessLocalOrSessionStorage";
+    Purpose[Purpose["SelectBasicAds"] = 2] = "SelectBasicAds";
+    Purpose[Purpose["CreatePersonalizedAdProfile"] = 3] = "CreatePersonalizedAdProfile";
+    Purpose[Purpose["SelectPersonalizedAds"] = 4] = "SelectPersonalizedAds";
+    Purpose[Purpose["CreatePersonalizedContentProfile"] = 5] = "CreatePersonalizedContentProfile";
+    Purpose[Purpose["SelectPersonalizedContent"] = 6] = "SelectPersonalizedContent";
+    Purpose[Purpose["MeasureAdPerformance"] = 7] = "MeasureAdPerformance";
+    Purpose[Purpose["MeasureContentPerformance"] = 8] = "MeasureContentPerformance";
+    Purpose[Purpose["ApplyMarketResearchToGenerateAudienceInsights"] = 9] = "ApplyMarketResearchToGenerateAudienceInsights";
+    Purpose[Purpose["DevelopAndImproveProducts"] = 10] = "DevelopAndImproveProducts";
+})(Purpose = exports.Purpose || (exports.Purpose = {}));
+var Service;
+(function (Service) {
+    Service[Service["All"] = 0] = "All";
+    Service[Service["Chat"] = 1] = "Chat";
+})(Service = exports.Service || (exports.Service = {}));

package/lib/cjs/actions.d.ts

@@ -0,0 +1,72 @@
+import { UserUid } from "./types";
+export declare const ActionTypes: {
+    /** value: autosuggest message as a string, settings: ActionShowAutosuggestSettings*/
+    readonly SEND_AUTOSUGGEST: 1;
+    /** value: array of room unique identifiers, settings: none */
+    readonly JOIN_ROOMS: 2;
+    /** value: none, settings: none */
+    readonly NO_CHATBUTTON: 5;
+    /** value: none, settings: none */
+    readonly NO_AUTOSUGGEST: 6;
+    /** value: JavaScript expression as a string, settings:none */
+    readonly RUN_JAVASCRIPT: 7;
+    /** value: none, settings: none */
+    readonly ENABLE_CHATBUTTON: 8;
+    /** value: CSS selector as a string, settings: none */
+    readonly SHOW_ELEMENTS: 9;
+    /** value: CSS selector as a string, settings: none */
+    readonly HIDE_ELEMENTS: 10;
+    /** value: URL as a string, settings: none */
+    readonly REDIRECT: 11;
+    /** value: lead form unique identifier, settings: none */
+    readonly LOAD_LEAD_FORM: 13;
+    /** value: button text as a string, settings: none */
+    readonly CHANGE_CB_TEXT: 14;
+    /** value: room unique identifier, settings: none */
+    readonly CHANGE_CB_TARGET: 15;
+    /** value: language as a RFC 3066 code, settings: none */
+    readonly CHANGE_LANGUAGE: 16;
+    /** value: lead form unique identifier, settings: none */
+    readonly SHOW_LEAD_FORM: 17;
+    /** value: lead form processor unique identifier, settings: none */
+    readonly SET_LEAD_FORM_PROCESSOR: 18;
+    /** value: button unique identifier, settings: none */
+    readonly SHOW_BUTTON: 19;
+    /** value: unique identifier of the parent room of the window, settings: none */
+    readonly SHOW_CHAT_DIALOG: 20;
+    /** value: priority as an integer [1 - 10], settings: none */
+    readonly SET_VISITOR_PRIORITY: 21;
+    /** value: none , settings: none */
+    readonly DISABLE_CAPACITY_CHECK: 22;
+    /** value: CSS code as a string, settings: none */
+    readonly INJECT_CSS: 23;
+    /** value: message as a string, settings: ActionSendChatMessageSettings */
+    readonly SEND_SYSTEM_MESSAGE: 25;
+    /** value: interactionUuid, settings: none */
+    readonly LOAD_INTERACTION: 26;
+    /** value: asset unique identifier, settings: ActionSendInteractionToChatSettings */
+    readonly SEND_INTERACTION_TO_CHAT: 27;
+};
+export declare type ActionType = typeof ActionTypes[keyof typeof ActionTypes];
+export declare type ActionTypeString = keyof typeof ActionTypes;
+export declare const ACTION_TYPES: ("SEND_AUTOSUGGEST" | "JOIN_ROOMS" | "NO_CHATBUTTON" | "NO_AUTOSUGGEST" | "RUN_JAVASCRIPT" | "ENABLE_CHATBUTTON" | "SHOW_ELEMENTS" | "HIDE_ELEMENTS" | "REDIRECT" | "LOAD_LEAD_FORM" | "CHANGE_CB_TEXT" | "CHANGE_CB_TARGET" | "CHANGE_LANGUAGE" | "SHOW_LEAD_FORM" | "SET_LEAD_FORM_PROCESSOR" | "SHOW_BUTTON" | "SHOW_CHAT_DIALOG" | "SET_VISITOR_PRIORITY" | "DISABLE_CAPACITY_CHECK" | "INJECT_CSS" | "SEND_SYSTEM_MESSAGE" | "LOAD_INTERACTION" | "SEND_INTERACTION_TO_CHAT")[];
+export interface ActionShowAutosuggestSettings {
+    /** Unique identifier of the user from whom the message shall be sent */
+    autosuggest_user_id: UserUid;
+    /** Delay before the chat window will be closed in seconds */
+    close_delay: number;
+}
+export interface ActionSendChatMessageSettings {
+    /** Name of the sender */
+    sender_public_name: string;
+}
+export interface ActionSendInteractionToChatSettings {
+    /** Name of the sender */
+    sender_public_name: string;
+    /** Optional message to send alongside of the interaction */
+    message?: string;
+}
+export declare type ActionSettingsType = ActionShowAutosuggestSettings | ActionSendChatMessageSettings | ActionSendInteractionToChatSettings | {};
+export declare const ACTION_STYLES: readonly ["primary", "secondary", "info", "success", "warning", "danger", "link", "brand_primary", "brand_secondary"];
+export declare type ActionStyle = typeof ACTION_STYLES[number];
+//# sourceMappingURL=actions.d.ts.map

package/lib/cjs/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../src/actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,eAAO,MAAM,WAAW;IACtB,qFAAqF;;IAGrF,8DAA8D;;IAG9D,kCAAkC;;IAGlC,kCAAkC;;IAGlC,8DAA8D;;IAG9D,kCAAkC;;IAGlC,sDAAsD;;IAGtD,sDAAsD;;IAGtD,6CAA6C;;IAG7C,yDAAyD;;IAGzD,qDAAqD;;IAGrD,oDAAoD;;IAGpD,yDAAyD;;IAGzD,yDAAyD;;IAGzD,mEAAmE;;IAGnE,sDAAsD;;IAGtD,gFAAgF;;IAGhF,6DAA6D;;IAG7D,mCAAmC;;IAGnC,kDAAkD;;IAGlD,0EAA0E;;IAG1E,6CAA6C;;IAG7C,oFAAoF;;CAE5E,CAAC;AACX,oBAAY,UAAU,GAAG,OAAO,WAAW,CAAC,MAAM,OAAO,WAAW,CAAC,CAAC;AACtE,oBAAY,gBAAgB,GAAG,MAAM,OAAO,WAAW,CAAC;AACxD,eAAO,MAAM,YAAY,sdAAiD,CAAC;AAE3E,MAAM,WAAW,6BAA6B;IAC5C,wEAAwE;IACxE,mBAAmB,EAAE,OAAO,CAAC;IAE7B,6DAA6D;IAC7D,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,MAAM,WAAW,6BAA6B;IAC5C,yBAAyB;IACzB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,mCAAmC;IAClD,yBAAyB;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,4DAA4D;IAC5D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oBAAY,kBAAkB,GAC1B,6BAA6B,GAC7B,6BAA6B,GAC7B,mCAAmC,GACnC,EAAE,CAAC;AAEP,eAAO,MAAM,aAAa,uHAUhB,CAAC;AACX,oBAAY,WAAW,GAAG,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC"}

package/lib/cjs/actions.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACTION_STYLES = exports.ACTION_TYPES = exports.ActionTypes = void 0;
+exports.ActionTypes = {
+    /** value: autosuggest message as a string, settings: ActionShowAutosuggestSettings*/
+    SEND_AUTOSUGGEST: 1,
+    /** value: array of room unique identifiers, settings: none */
+    JOIN_ROOMS: 2,
+    /** value: none, settings: none */
+    NO_CHATBUTTON: 5,
+    /** value: none, settings: none */
+    NO_AUTOSUGGEST: 6,
+    /** value: JavaScript expression as a string, settings:none */
+    RUN_JAVASCRIPT: 7,
+    /** value: none, settings: none */
+    ENABLE_CHATBUTTON: 8,
+    /** value: CSS selector as a string, settings: none */
+    SHOW_ELEMENTS: 9,
+    /** value: CSS selector as a string, settings: none */
+    HIDE_ELEMENTS: 10,
+    /** value: URL as a string, settings: none */
+    REDIRECT: 11,
+    /** value: lead form unique identifier, settings: none */
+    LOAD_LEAD_FORM: 13,
+    /** value: button text as a string, settings: none */
+    CHANGE_CB_TEXT: 14,
+    /** value: room unique identifier, settings: none */
+    CHANGE_CB_TARGET: 15,
+    /** value: language as a RFC 3066 code, settings: none */
+    CHANGE_LANGUAGE: 16,
+    /** value: lead form unique identifier, settings: none */
+    SHOW_LEAD_FORM: 17,
+    /** value: lead form processor unique identifier, settings: none */
+    SET_LEAD_FORM_PROCESSOR: 18,
+    /** value: button unique identifier, settings: none */
+    SHOW_BUTTON: 19,
+    /** value: unique identifier of the parent room of the window, settings: none */
+    SHOW_CHAT_DIALOG: 20,
+    /** value: priority as an integer [1 - 10], settings: none */
+    SET_VISITOR_PRIORITY: 21,
+    /** value: none , settings: none */
+    DISABLE_CAPACITY_CHECK: 22,
+    /** value: CSS code as a string, settings: none */
+    INJECT_CSS: 23,
+    /** value: message as a string, settings: ActionSendChatMessageSettings */
+    SEND_SYSTEM_MESSAGE: 25,
+    /** value: interactionUuid, settings: none */
+    LOAD_INTERACTION: 26,
+    /** value: asset unique identifier, settings: ActionSendInteractionToChatSettings */
+    SEND_INTERACTION_TO_CHAT: 27,
+};
+exports.ACTION_TYPES = Object.keys(exports.ActionTypes);
+exports.ACTION_STYLES = [
+    "primary",
+    "secondary",
+    "info",
+    "success",
+    "warning",
+    "danger",
+    "link",
+    "brand_primary",
+    "brand_secondary",
+];

package/lib/cjs/apps.d.ts

@@ -0,0 +1,99 @@
+import { NestedOrganization } from "./customer";
+import { NestedUser } from "./customer";
+import { PublicNestedAsset } from "./assets";
+import { GiosgAppUid, OrganizationUid, UserUid, AssetUid, GiosgAppInstanceUid, UserPermissionScope } from "./types";
+/** TODO: Add jsdocs and check nullability of fields */
+export interface GiosgAppInstance {
+    id: GiosgAppInstanceUid;
+    app_id: GiosgAppUid;
+    app: NestedGiosgApp;
+    organization_id: OrganizationUid;
+    organization: NestedOrganization;
+    created_at: string;
+    updated_at: string;
+    app_user_id: UserUid | null;
+    app_user: NestedUser | null;
+    allowed_scopes: UserPermissionScope[];
+    is_disabled: boolean;
+}
+export declare type GiosgAppTriggerCondition = "chat_start" | "chat_end" | "chat_end_with_msgs" | "chat_open" | "chat_close" | "chat_focus" | "console_load" | "setup" | "install" | "uninstall" | "manual_dialog" | "manual_nav";
+/** TODO: Add jsdocs and check nullability of fields */
+export interface GiosgApp {
+    id: GiosgAppUid;
+    name: string;
+    description: string;
+    icon_asset_id: AssetUid | null;
+    icon_asset: PublicNestedAsset | null;
+    owned_by_organization_id: OrganizationUid;
+    owned_by_organization: NestedOrganization;
+    secret: string;
+    is_available_to_anyone: boolean;
+    is_available_to_partners: boolean;
+    is_app_user_required: boolean;
+    app_user_default_first_name: string | null;
+    app_user_default_last_name: string | null;
+    app_user_default_alias: string | null;
+    terms_of_service_url: string;
+    privacy_policy_url: string;
+    trigger_url: string | null;
+    trigger_conditions: GiosgAppTriggerCondition[];
+    required_scopes: UserPermissionScope[];
+    allowed_redirect_uris: string[];
+    installation_count: number;
+    created_at: string;
+    updated_at: string;
+    created_by_user_id: UserUid;
+    created_by_user: NestedUser;
+    updated_by_user_id: UserUid;
+    updated_by_user: NestedUser;
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface GiosgAppPayload {
+    name: string;
+    description: string;
+    icon_asset_id?: AssetUid | null;
+    is_available_to_anyone?: boolean;
+    is_available_to_partners?: boolean;
+    is_app_user_required: boolean;
+    app_user_default_first_name?: string | null;
+    app_user_default_last_name?: string | null;
+    app_user_default_alias?: string | null;
+    terms_of_service_url: string;
+    privacy_policy_url: string;
+    trigger_url?: string | null;
+    trigger_conditions?: GiosgAppTriggerCondition[];
+    required_scopes?: UserPermissionScope[];
+    allowed_redirect_uris?: string[];
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface InstalledGiosgApp {
+    id: GiosgAppUid;
+    name: string;
+    description: string;
+    icon_asset_id: AssetUid;
+    icon_asset: PublicNestedAsset;
+    owned_by_organization_id: OrganizationUid;
+    owned_by_organization: NestedOrganization;
+    is_app_user_required: boolean;
+    installation_count: number;
+    created_at: string;
+    updated_at: string;
+    trigger_conditions: GiosgAppTriggerCondition[];
+    is_disabled: boolean;
+}
+/** TODO: Add jsdocs and check nullability of fields */
+export interface NestedGiosgApp {
+    id: GiosgAppUid;
+    name: string;
+    description: string;
+    icon_asset_id: AssetUid;
+    icon_asset: PublicNestedAsset;
+    owned_by_organization_id: OrganizationUid;
+    owned_by_organization: NestedOrganization;
+    is_app_user_required: boolean;
+    required_scopes: UserPermissionScope[];
+    installation_count: number;
+    created_at: string;
+    updated_at: string;
+}
+//# sourceMappingURL=apps.d.ts.map

package/lib/cjs/apps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apps.d.ts","sourceRoot":"","sources":["../../src/apps.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC7C,OAAO,EACL,WAAW,EACX,eAAe,EACf,OAAO,EACP,QAAQ,EACR,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,SAAS,CAAC;AAEjB,uDAAuD;AACvD,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,mBAAmB,CAAC;IACxB,MAAM,EAAE,WAAW,CAAC;IACpB,GAAG,EAAE,cAAc,CAAC;IACpB,eAAe,EAAE,eAAe,CAAC;IACjC,YAAY,EAAE,kBAAkB,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,QAAQ,EAAE,UAAU,GAAG,IAAI,CAAC;IAC5B,cAAc,EAAE,mBAAmB,EAAE,CAAC;IACtC,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,oBAAY,wBAAwB,GAChC,YAAY,GACZ,UAAU,GACV,oBAAoB,GACpB,WAAW,GACX,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,OAAO,GACP,SAAS,GACT,WAAW,GACX,eAAe,GACf,YAAY,CAAC;AAEjB,uDAAuD;AACvD,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,WAAW,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC/B,UAAU,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACrC,wBAAwB,EAAE,eAAe,CAAC;IAC1C,qBAAqB,EAAE,kBAAkB,CAAC;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB,EAAE,OAAO,CAAC;IAChC,wBAAwB,EAAE,OAAO,CAAC;IAClC,oBAAoB,EAAE,OAAO,CAAC;IAC9B,2BAA2B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IACtC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,kBAAkB,EAAE,wBAAwB,EAAE,CAAC;IAC/C,eAAe,EAAE,mBAAmB,EAAE,CAAC;IACvC,qBAAqB,EAAE,MAAM,EAAE,CAAC;IAChC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,UAAU,CAAC;IAC5B,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,UAAU,CAAC;CAC7B;AAED,uDAAuD;AACvD,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IAChC,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,oBAAoB,EAAE,OAAO,CAAC;IAC9B,2BAA2B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5C,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,kBAAkB,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAChD,eAAe,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACxC,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;CAClC;AAED,uDAAuD;AACvD,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,WAAW,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,QAAQ,CAAC;IACxB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,wBAAwB,EAAE,eAAe,CAAC;IAC1C,qBAAqB,EAAE,kBAAkB,CAAC;IAC1C,oBAAoB,EAAE,OAAO,CAAC;IAC9B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,wBAAwB,EAAE,CAAC;IAC/C,WAAW,EAAE,OAAO,CAAC;CACtB;AAED,uDAAuD;AACvD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,WAAW,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,QAAQ,CAAC;IACxB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,wBAAwB,EAAE,eAAe,CAAC;IAC1C,qBAAqB,EAAE,kBAAkB,CAAC;IAC1C,oBAAoB,EAAE,OAAO,CAAC;IAC9B,eAAe,EAAE,mBAAmB,EAAE,CAAC;IACvC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB"}

package/lib/cjs/apps.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });