@youmind-openlab/rettiwt-api 1.0.0

package/dist/models/auth/AuthCookie.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthCookie = void 0;
+/**
+ * The cookie containing the tokens that are used to authenticate against Twitter.
+ *
+ * @internal
+ */
+class AuthCookie {
+    /* eslint-disable @typescript-eslint/naming-convention */
+    auth_token;
+    ct0;
+    kdt;
+    twid;
+    /* eslint-enable @typescript-eslint/naming-convention */
+    /**
+     * @param cookies - The cookie list obtained from the browser.
+     */
+    constructor(cookies) {
+        // Initializing defaults
+        this.auth_token = '';
+        this.ct0 = '';
+        this.kdt = '';
+        this.twid = '';
+        // Parsing the cookies
+        for (const cookie of cookies) {
+            if (cookie.name == 'kdt') {
+                this.kdt = cookie.value;
+            }
+            else if (cookie.name == 'twid') {
+                this.twid = cookie.value;
+            }
+            else if (cookie.name == 'ct0') {
+                this.ct0 = cookie.value;
+            }
+            else if (cookie.name == 'auth_token') {
+                this.auth_token = cookie.value;
+            }
+        }
+    }
+    /**
+     * @returns the string representation of 'this' object.
+     */
+    toString() {
+        /** The string representation of 'this' object. */
+        let outStr = '';
+        // Iterating through the (key, value) pairs of this cookie
+        for (const [key, value] of Object.entries(this)) {
+            outStr += `${key}=${value};`;
+        }
+        return outStr;
+    }
+}
+exports.AuthCookie = AuthCookie;
+//# sourceMappingURL=AuthCookie.js.map

package/dist/models/auth/AuthCookie.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthCookie.js","sourceRoot":"","sources":["../../../src/models/auth/AuthCookie.ts"],"names":[],"mappings":";;;AAIA;;;;GAIG;AACH,MAAa,UAAU;IACtB,yDAAyD;IAElD,UAAU,CAAS;IACnB,GAAG,CAAS;IACZ,GAAG,CAAS;IACZ,IAAI,CAAS;IAEpB,wDAAwD;IAExD;;OAEG;IACH,YAAmB,OAAiB;QACnC,wBAAwB;QACxB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QAEf,sBAAsB;QACtB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC9B,IAAI,MAAM,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC;gBAC1B,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC;YACzB,CAAC;iBAAM,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,EAAE,CAAC;gBAClC,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC;YAC1B,CAAC;iBAAM,IAAI,MAAM,CAAC,IAAI,IAAI,KAAK,EAAE,CAAC;gBACjC,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC;YACzB,CAAC;iBAAM,IAAI,MAAM,CAAC,IAAI,IAAI,YAAY,EAAE,CAAC;gBACxC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC;YAChC,CAAC;QACF,CAAC;IACF,CAAC;IAED;;OAEG;IACI,QAAQ;QACd,kDAAkD;QAClD,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,0DAA0D;QAC1D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,GAAG,GAAG,IAAI,KAAe,GAAG,CAAC;QACxC,CAAC;QAED,OAAO,MAAM,CAAC;IACf,CAAC;CACD;AAhDD,gCAgDC"}

package/dist/models/auth/AuthCredential.d.ts

@@ -0,0 +1,30 @@
+import { AxiosRequestHeaders } from 'axios';
+import { Cookie } from 'cookiejar';
+import { AuthenticationType } from '../../enums/Authentication';
+import { IAuthCredential } from '../../types/auth/AuthCredential';
+/**
+ * The credentials for authenticating against Twitter.
+ *
+ * Depending on which tokens are present, the authentication type is determined as follows:
+ * - authToken, guestToken =\> Guest authentication.
+ * - authToken, csrfToken, cookie =\> User authentication.
+ * - authToken, guestToken, cookie =\> Guest authentication while logging in.
+ *
+ * @internal
+ */
+export declare class AuthCredential implements IAuthCredential {
+    authToken?: string;
+    authenticationType?: AuthenticationType;
+    cookies?: string;
+    csrfToken?: string;
+    guestToken?: string;
+    /**
+     * @param cookies - The list of cookies to be used for authenticating against Twitter.
+     * @param guestToken - The guest token to be used to authenticate a guest session.
+     */
+    constructor(cookies?: Cookie[], guestToken?: string);
+    /**
+     * @returns The HTTP header representation of 'this' object.
+     */
+    toHeader(): AxiosRequestHeaders;
+}

package/dist/models/auth/AuthCredential.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthCredential = void 0;
+const axios_1 = require("axios");
+const Authentication_1 = require("../../enums/Authentication");
+const AuthCookie_1 = require("./AuthCookie");
+/**
+ * The credentials for authenticating against Twitter.
+ *
+ * Depending on which tokens are present, the authentication type is determined as follows:
+ * - authToken, guestToken =\> Guest authentication.
+ * - authToken, csrfToken, cookie =\> User authentication.
+ * - authToken, guestToken, cookie =\> Guest authentication while logging in.
+ *
+ * @internal
+ */
+class AuthCredential {
+    authToken;
+    authenticationType;
+    cookies;
+    csrfToken;
+    guestToken;
+    /**
+     * @param cookies - The list of cookies to be used for authenticating against Twitter.
+     * @param guestToken - The guest token to be used to authenticate a guest session.
+     */
+    constructor(cookies, guestToken) {
+        this.authToken =
+            'AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA';
+        // If guest credentials given
+        if (!cookies && guestToken) {
+            this.guestToken = guestToken;
+            this.authenticationType = Authentication_1.AuthenticationType.GUEST;
+        }
+        // If login credentials given
+        else if (cookies && guestToken) {
+            // Parsing the cookies
+            const parsedCookie = new AuthCookie_1.AuthCookie(cookies);
+            this.cookies = parsedCookie.toString();
+            this.guestToken = guestToken;
+            this.authenticationType = Authentication_1.AuthenticationType.LOGIN;
+        }
+        // If user credentials given
+        else if (cookies && !guestToken) {
+            // Parsing the cookies
+            const parsedCookie = new AuthCookie_1.AuthCookie(cookies);
+            this.cookies = parsedCookie.toString();
+            this.csrfToken = parsedCookie.ct0;
+            this.authenticationType = Authentication_1.AuthenticationType.USER;
+        }
+    }
+    /**
+     * @returns The HTTP header representation of 'this' object.
+     */
+    toHeader() {
+        const headers = new axios_1.AxiosHeaders();
+        /**
+         * Conditionally initializing only those data which are supplied.
+         *
+         * This is done to ensure that the data that is not supplied, is not included in output, not even undefined.
+         */
+        if (this.authToken) {
+            headers.set('authorization', `Bearer ${this.authToken}`);
+        }
+        if (this.guestToken) {
+            headers.set('x-guest-token', this.guestToken);
+        }
+        if (this.csrfToken) {
+            headers.set('x-csrf-token', this.csrfToken);
+        }
+        if (this.cookies) {
+            headers.set('cookie', this.cookies);
+        }
+        return headers;
+    }
+}
+exports.AuthCredential = AuthCredential;
+//# sourceMappingURL=AuthCredential.js.map

package/dist/models/auth/AuthCredential.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthCredential.js","sourceRoot":"","sources":["../../../src/models/auth/AuthCredential.ts"],"names":[],"mappings":";;;AAAA,iCAA0D;AAI1D,+DAAgE;AAGhE,6CAA0C;AAE1C;;;;;;;;;GASG;AACH,MAAa,cAAc;IACnB,SAAS,CAAU;IACnB,kBAAkB,CAAsB;IACxC,OAAO,CAAU;IACjB,SAAS,CAAU;IACnB,UAAU,CAAU;IAE3B;;;OAGG;IACH,YAAmB,OAAkB,EAAE,UAAmB;QACzD,IAAI,CAAC,SAAS;YACb,0GAA0G,CAAC;QAC5G,6BAA6B;QAC7B,IAAI,CAAC,OAAO,IAAI,UAAU,EAAE,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,kBAAkB,GAAG,mCAAkB,CAAC,KAAK,CAAC;QACpD,CAAC;QACD,6BAA6B;aACxB,IAAI,OAAO,IAAI,UAAU,EAAE,CAAC;YAChC,sBAAsB;YACtB,MAAM,YAAY,GAAe,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;YAEzD,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;YAC7B,IAAI,CAAC,kBAAkB,GAAG,mCAAkB,CAAC,KAAK,CAAC;QACpD,CAAC;QACD,4BAA4B;aACvB,IAAI,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;YACjC,sBAAsB;YACtB,MAAM,YAAY,GAAe,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;YAEzD,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC;YAClC,IAAI,CAAC,kBAAkB,GAAG,mCAAkB,CAAC,IAAI,CAAC;QACnD,CAAC;IACF,CAAC;IAED;;OAEG;IACI,QAAQ;QACd,MAAM,OAAO,GAAG,IAAI,oBAAY,EAAE,CAAC;QAEnC;;;;WAIG;QACH,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,OAAO,CAAC,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,OAAO,CAAC;IAChB,CAAC;CACD;AAjED,wCAiEC"}

package/dist/models/data/Analytics.d.ts

@@ -0,0 +1,43 @@
+import { IAnalytics as IRawAnalytics } from '../../types/raw/base/Analytic';
+import type { IAnalytics } from '../../types/data/Analytics';
+import type { IAnalyticsMetric } from '../../types/raw/base/Analytic';
+/**
+ * The details of the analytic result of the connected User.
+ *
+ * @public
+ */
+export declare class Analytics implements IAnalytics {
+    /** The raw analytic details. */
+    private readonly _raw;
+    bookmarks: number;
+    createQuote: number;
+    createReply: number;
+    createTweets: number;
+    createdAt: string;
+    engagements: number;
+    followers: number;
+    follows: number;
+    impressions: number;
+    likes: number;
+    organicMetricsTimeSeries: IAnalyticsMetric[];
+    profileVisits: number;
+    replies: number;
+    retweets: number;
+    shares: number;
+    unfollows: number;
+    verifiedFollowers: number;
+    constructor(analytics: IRawAnalytics);
+    /** The raw analytic details. */
+    get raw(): IRawAnalytics;
+    /**
+     * Reduces the organic metrics time series to a total value for a specific metric type.
+     *
+     * @param metricType - metricType The type of metric to reduce.
+     * @returns the total value of the specified metric type across all time series.
+     */
+    private _reduceMetrics;
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): IAnalytics;
+}

package/dist/models/data/Analytics.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Analytics = void 0;
+const Analytics_1 = require("../../enums/raw/Analytics");
+/**
+ * The details of the analytic result of the connected User.
+ *
+ * @public
+ */
+class Analytics {
+    /** The raw analytic details. */
+    _raw;
+    bookmarks;
+    createQuote;
+    createReply;
+    createTweets;
+    createdAt;
+    engagements;
+    followers;
+    follows;
+    impressions;
+    likes;
+    organicMetricsTimeSeries;
+    profileVisits;
+    replies;
+    retweets;
+    shares;
+    unfollows;
+    verifiedFollowers;
+    constructor(analytics) {
+        this._raw = { ...analytics };
+        this.organicMetricsTimeSeries = analytics.organic_metrics_time_series;
+        this.createdAt = new Date().toISOString();
+        this.followers = analytics.relationship_counts.followers;
+        this.verifiedFollowers = parseInt(analytics.verified_follower_count, 10);
+        this.impressions = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.IMPRESSIONS);
+        this.profileVisits = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.PROFILE_VISITS);
+        this.engagements = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.ENGAGEMENTS);
+        this.follows = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.FOLLOWS);
+        this.replies = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.REPLIES);
+        this.likes = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.LIKES);
+        this.retweets = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.RETWEETS);
+        this.bookmarks = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.BOOKMARK);
+        this.shares = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.SHARE);
+        this.createTweets = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.CREATE_TWEET);
+        this.createQuote = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.CREATE_QUOTE);
+        this.createReply = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.CREATE_REPLY);
+        this.unfollows = this._reduceMetrics(Analytics_1.RawAnalyticsMetric.UNFOLLOWS);
+    }
+    /** The raw analytic details. */
+    get raw() {
+        return { ...this._raw };
+    }
+    /**
+     * Reduces the organic metrics time series to a total value for a specific metric type.
+     *
+     * @param metricType - metricType The type of metric to reduce.
+     * @returns the total value of the specified metric type across all time series.
+     */
+    _reduceMetrics(metricType) {
+        return this.organicMetricsTimeSeries.reduce((acc, metric) => {
+            const metricValue = metric.metric_values.find((m) => m.metric_type === metricType);
+            return acc + (metricValue ? metricValue.metric_value : 0);
+        }, 0);
+    }
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            createdAt: this.createdAt,
+            followers: this.followers,
+            verifiedFollowers: this.verifiedFollowers,
+            impressions: this.impressions,
+            profileVisits: this.profileVisits,
+            engagements: this.engagements,
+            follows: this.follows,
+            replies: this.replies,
+            likes: this.likes,
+            retweets: this.retweets,
+            bookmarks: this.bookmarks,
+            shares: this.shares,
+            createTweets: this.createTweets,
+            createQuote: this.createQuote,
+            unfollows: this.unfollows,
+            createReply: this.createReply,
+            organicMetricsTimeSeries: this.organicMetricsTimeSeries,
+        };
+    }
+}
+exports.Analytics = Analytics;
+//# sourceMappingURL=Analytics.js.map

package/dist/models/data/Analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Analytics.js","sourceRoot":"","sources":["../../../src/models/data/Analytics.ts"],"names":[],"mappings":";;;AAAA,yDAA+D;AAM/D;;;;GAIG;AACH,MAAa,SAAS;IACrB,gCAAgC;IACf,IAAI,CAAgB;IAE9B,SAAS,CAAS;IAClB,WAAW,CAAS;IACpB,WAAW,CAAS;IACpB,YAAY,CAAS;IACrB,SAAS,CAAS;IAClB,WAAW,CAAS;IACpB,SAAS,CAAS;IAClB,OAAO,CAAS;IAChB,WAAW,CAAS;IACpB,KAAK,CAAS;IACd,wBAAwB,CAAqB;IAC7C,aAAa,CAAS;IACtB,OAAO,CAAS;IAChB,QAAQ,CAAS;IACjB,MAAM,CAAS;IACf,SAAS,CAAS;IAClB,iBAAiB,CAAS;IAEjC,YAAmB,SAAwB;QAC1C,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;QAC7B,IAAI,CAAC,wBAAwB,GAAG,SAAS,CAAC,2BAA2B,CAAC;QACtE,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC,mBAAmB,CAAC,SAAS,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAAC,SAAS,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,WAAW,CAAC,CAAC;QACvE,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,OAAO,CAAC,CAAC;QAC/D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,KAAK,CAAC,CAAC;QAC3D,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,QAAQ,CAAC,CAAC;QACjE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,QAAQ,CAAC,CAAC;QAClE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,YAAY,CAAC,CAAC;QACzE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,YAAY,CAAC,CAAC;QACxE,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,YAAY,CAAC,CAAC;QACxE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,8BAAkB,CAAC,SAAS,CAAC,CAAC;IACpE,CAAC;IAED,gCAAgC;IAChC,IAAW,GAAG;QACb,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACK,cAAc,CAAC,UAA8B;QACpD,OAAO,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YAC3D,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAM,UAAqB,CAAC,CAAC;YAC/F,OAAO,GAAG,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3D,CAAC,EAAE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,wBAAwB,EAAE,IAAI,CAAC,wBAAwB;SACvD,CAAC;IACH,CAAC;CACD;AArFD,8BAqFC"}

package/dist/models/data/BookmarkFolder.d.ts

@@ -0,0 +1,31 @@
+import { IBookmarkFolder } from '../../types/data/BookmarkFolder';
+import { IBookmarkFolder as IRawBookmarkFolder } from '../../types/raw/base/BookmarkFolder';
+/**
+ * The details of a single Bookmark Folder.
+ *
+ * @public
+ */
+export declare class BookmarkFolder implements IBookmarkFolder {
+    /** The raw bookmark folder details. */
+    private readonly _raw;
+    id: string;
+    name: string;
+    /**
+     * @param folder - The raw bookmark folder details.
+     */
+    constructor(folder: IRawBookmarkFolder);
+    /** The raw bookmark folder details. */
+    get raw(): IRawBookmarkFolder;
+    /**
+     * Extracts and deserializes bookmark folders from the given raw response data.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The deserialized list of bookmark folders.
+     */
+    static list(response: NonNullable<unknown>): BookmarkFolder[];
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): IBookmarkFolder;
+}

package/dist/models/data/BookmarkFolder.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BookmarkFolder = void 0;
+const Logging_1 = require("../../enums/Logging");
+const LogService_1 = require("../../services/internal/LogService");
+/**
+ * The details of a single Bookmark Folder.
+ *
+ * @public
+ */
+class BookmarkFolder {
+    /** The raw bookmark folder details. */
+    _raw;
+    id;
+    name;
+    /**
+     * @param folder - The raw bookmark folder details.
+     */
+    constructor(folder) {
+        this._raw = { ...folder };
+        this.id = folder.id;
+        this.name = folder.name;
+    }
+    /** The raw bookmark folder details. */
+    get raw() {
+        return { ...this._raw };
+    }
+    /**
+     * Extracts and deserializes bookmark folders from the given raw response data.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The deserialized list of bookmark folders.
+     */
+    static list(response) {
+        const folders = [];
+        // Extract items from the response structure
+        const items = response?.data?.viewer?.user_results?.result
+            ?.bookmark_collections_slice?.items;
+        if (!items || !Array.isArray(items)) {
+            return folders;
+        }
+        // Deserialize valid folders
+        for (const item of items) {
+            if (item && item.id) {
+                // Logging
+                LogService_1.LogService.log(Logging_1.LogActions.DESERIALIZE, { id: item.id });
+                folders.push(new BookmarkFolder(item));
+            }
+        }
+        return folders;
+    }
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON() {
+        return {
+            id: this.id,
+            name: this.name,
+        };
+    }
+}
+exports.BookmarkFolder = BookmarkFolder;
+//# sourceMappingURL=BookmarkFolder.js.map

package/dist/models/data/BookmarkFolder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BookmarkFolder.js","sourceRoot":"","sources":["../../../src/models/data/BookmarkFolder.ts"],"names":[],"mappings":";;;AAAA,iDAAiD;AACjD,mEAAgE;AAKhE;;;;GAIG;AACH,MAAa,cAAc;IAC1B,uCAAuC;IACtB,IAAI,CAAqB;IAEnC,EAAE,CAAS;IACX,IAAI,CAAS;IAEpB;;OAEG;IACH,YAAmB,MAA0B;QAC5C,IAAI,CAAC,IAAI,GAAG,EAAE,GAAG,MAAM,EAAE,CAAC;QAC1B,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,uCAAuC;IACvC,IAAW,GAAG;QACb,OAAO,EAAE,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,QAA8B;QAChD,MAAM,OAAO,GAAqB,EAAE,CAAC;QAErC,4CAA4C;QAC5C,MAAM,KAAK,GAAI,QAAyC,EAAE,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;YAC3F,EAAE,0BAA0B,EAAE,KAAK,CAAC;QAErC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACrC,OAAO,OAAO,CAAC;QAChB,CAAC;QAED,4BAA4B;QAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YAC1B,IAAI,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;gBACrB,UAAU;gBACV,uBAAU,CAAC,GAAG,CAAC,oBAAU,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;gBAExD,OAAO,CAAC,IAAI,CAAC,IAAI,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;YACxC,CAAC;QACF,CAAC;QAED,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,MAAM;QACZ,OAAO;YACN,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;CACD;AA7DD,wCA6DC"}

package/dist/models/data/Conversation.d.ts

@@ -0,0 +1,93 @@
+import { IConversation } from '../../types/data/Conversation';
+import { IConversationTimelineResponse } from '../../types/raw/dm/Conversation';
+import { IInboxInitialResponse, Conversation as RawConversation } from '../../types/raw/dm/InboxInitial';
+import { IInboxTimelineResponse } from '../../types/raw/dm/InboxTimeline';
+import { DirectMessage } from './DirectMessage';
+/**
+ * The details of a single conversation.
+ *
+ * @public
+ */
+export declare class Conversation implements IConversation {
+    /** The raw conversation details. */
+    private readonly _raw;
+    avatarUrl?: string;
+    hasMore: boolean;
+    id: string;
+    lastActivityAt: string;
+    lastMessageId?: string;
+    messages: DirectMessage[];
+    muted: boolean;
+    name?: string;
+    notificationsDisabled: boolean;
+    participants: string[];
+    trusted: boolean;
+    type: 'ONE_TO_ONE' | 'GROUP_DM';
+    /**
+     * @param conversation - The raw conversation details from the API response.
+     * @param messages - Array of messages in this conversation.
+     */
+    constructor(conversation: unknown, messages?: DirectMessage[]);
+    /** The raw conversation details. */
+    get raw(): RawConversation;
+    /**
+     * Parse avatar URL from conversation data
+     */
+    private _parseAvatarUrl;
+    /**
+     * Parse conversation type with proper fallback
+     */
+    private _parseConversationType;
+    /**
+     * Parse participants array with type safety
+     */
+    private _parseParticipants;
+    /**
+     * Parse timestamp with proper fallback
+     */
+    private _parseTimestamp;
+    /**
+     * Extracts a single conversation from conversation timeline response.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The deserialized conversation with full message history.
+     */
+    static fromConversationTimeline(response: IConversationTimelineResponse): Conversation | undefined;
+    /**
+     * Extracts conversations from inbox initial state response.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The deserialized list of conversations with their preview messages.
+     */
+    static listFromInboxInitial(response: IInboxInitialResponse): Conversation[];
+    /**
+     * Extracts conversations from inbox timeline response.
+     *
+     * @param response - The raw response data.
+     *
+     * @returns The deserialized list of conversations with their messages.
+     */
+    static listFromInboxTimeline(response: IInboxTimelineResponse): Conversation[];
+    /**
+     * Generic method to extract conversations from any supported response type
+     */
+    static listFromResponse(response: IConversationTimelineResponse | IInboxInitialResponse | IInboxTimelineResponse): Conversation[];
+    /**
+     * Get the other participant's ID (only for one-to-one conversations)
+     */
+    getOtherParticipant(currentUserId: string): string | undefined;
+    /**
+     * Check if this conversation is a group DM
+     */
+    isGroupDM(): boolean;
+    /**
+     * Check if this conversation is one-to-one
+     */
+    isOneToOne(): boolean;
+    /**
+     * @returns A serializable JSON representation of `this` object.
+     */
+    toJSON(): IConversation;
+}