@amityco/ts-sdk 7.26.0 → 7.26.1-0035cd08.0

package/dist/index.esm.js

@@ -306,6 +306,13 @@ var NotificationRolesFilterTypeEnum;
     NotificationRolesFilterTypeEnum["ONLY"] = "only";
 })(NotificationRolesFilterTypeEnum || (NotificationRolesFilterTypeEnum = {}));
 
+var AmityLiveViewerCountMode;
+(function (AmityLiveViewerCountMode) {
+    AmityLiveViewerCountMode["ALWAYS_SHOW"] = "always";
+    AmityLiveViewerCountMode["HIDE_ENTIRELY"] = "hidden";
+    AmityLiveViewerCountMode["SHOW_ABOVE_MINIMUM"] = "above-minimum";
+})(AmityLiveViewerCountMode || (AmityLiveViewerCountMode = {}));
+
 function getVersion() {
     try {
         // the string ''v7.26.0-esm'' should be replaced by actual value by @rollup/plugin-replace
@@ -777,6 +784,28 @@ class ASCConnectionError extends ASCError {
         this.event = event;
     }
 }
+/**
+ * Thrown when the network does not own a module the call needs. Raised from
+ * any module endpoint under `enforce` enforcement, mapped from app code
+ * `400325` — never from HTTP 403 alone, which already covers a role problem
+ * (`400300` / `400301`), a visitor (`403999`) and a bot (`403998`).
+ *
+ * `modules` carries **every** key the refusal named, as raw strings, so a
+ * caller can say which entitlement is absent without a second request.
+ *
+ * @category Errors
+ */
+class AmityModuleNotEntitledError extends ASCApiError {
+    /**
+     * @param message The server's message, e.g. `Module not entitled: chat, live`
+     * @param modules Every module key from the rejection's `data.modules`
+     */
+    constructor(message, modules = []) {
+        super(message, 400325 /* Amity.ServerError.MODULE_NOT_ENTITLED */, "error" /* Amity.ErrorLevel.ERROR */);
+        this.modules = modules;
+        this.type = 'AmityModuleNotEntitledError';
+    }
+}
 
 let activeClient = null;
 /**
@@ -1924,6 +1953,22 @@ function computeUrl(type, region) {
     return URLS[type].replace('{region}', region);
 }
 
+/**
+ * Reads the module keys a `MODULE_NOT_ENTITLED` rejection named.
+ *
+ * Every entry is kept, as a raw string: one call can need more than one
+ * module, and a key this build predates is still the only part of the
+ * payload a customer can act on.
+ *
+ * @category Transport
+ * @hidden
+ */
+const extractNotEntitledModules = (data) => {
+    const { modules } = data !== null && data !== void 0 ? data : {};
+    if (!Array.isArray(modules))
+        return [];
+    return modules.filter((module) => typeof module === 'string');
+};
 /**
  * Unwraps v3 server payload (for error handling and type extraction)
  *
@@ -1943,6 +1988,15 @@ const unwrapPayload = (response) => {
         throw new ASCUnknownError(response.code);
     }
     else if (response.status === 'error') {
+        /*
+         * An entitlement refusal must not arrive as a generic failure: a customer
+         * cannot then tell a module they have not bought from an outage. Keyed on
+         * the app code, never on the HTTP status, so a role or membership problem
+         * still maps to the generic error.
+         */
+        if (response.code === 400325 /* Amity.ServerError.MODULE_NOT_ENTITLED */) {
+            throw new AmityModuleNotEntitledError(response.message, extractNotEntitledModules(response.data));
+        }
         throw new ASCApiError(response.message, response.code, "error" /* Amity.ErrorLevel.ERROR */);
     }
     // unjust, but helps force uncast "T | undefined" to allow deconstruction without warnings
@@ -2433,10 +2487,11 @@ var MqttError;
     MqttError[MqttError["BAD_USERNAME_OR_PASSWORD"] = 134] = "BAD_USERNAME_OR_PASSWORD";
     MqttError[MqttError["NOT_AUTHORIZED"] = 135] = "NOT_AUTHORIZED";
 })(MqttError || (MqttError = {}));
-// MQTT 5 session expiry, in seconds. 0xFFFFFFFF keeps the session alive
-// indefinitely, matching the previous 3.1.1 `clean: false` behaviour where the
-// broker retained the session (and its subscriptions) across disconnects.
-const SESSION_EXPIRY_INTERVAL = 0xffffffff;
+// MQTT 5 session expiry, in seconds. Under MQTT 3.1.1 the broker capped
+// retained sessions at ~30 min; under MQTT 5 the client's value wins, so an
+// unbounded value ("never") left disconnected sessions piling up on the broker.
+// 1800s matches the previous 3.1.1 cap.
+const SESSION_EXPIRY_INTERVAL = 1800;
 function getMqttOptions(params) {
     return Object.assign({ clean: false, clientId: `mqttjs_ + ${Math.random().toString(16).substring(2, 10)}`, protocolId: 'MQTT', protocolVersion: 5, reconnectPeriod: RETRY_BASE_TIMEOUT, resubscribe: true, 
         // The broker/LB drops idle sockets at ~60s. mqtt.js v5 sends its first
@@ -2538,8 +2593,16 @@ const createMqttTransport = (endpoint) => {
     }
     return {
         connect,
-        async disconnect() {
+        async disconnect(options) {
             if (this.connected) {
+                // On logout we want the broker to release the session immediately
+                // instead of keeping it around for SESSION_EXPIRY_INTERVAL. mqtt.js
+                // only sends a DISCONNECT packet when `force` is false; force=true
+                // just tears the socket down and the broker keeps the session until
+                // it expires on its own.
+                if (options === null || options === void 0 ? void 0 : options.endSession) {
+                    return new Promise(resolve => mqttClient === null || mqttClient === void 0 ? void 0 : mqttClient.end(false, { reasonCode: 0, properties: { sessionExpiryInterval: 0 } }, () => resolve()));
+                }
                 return new Promise(resolve => mqttClient === null || mqttClient === void 0 ? void 0 : mqttClient.end(true, undefined, () => resolve()));
             }
         },
@@ -5021,6 +5084,51 @@ const getCoreUserSettings = async () => {
     return data;
 };
 
+const DEFAULT_CONFIG = {
+    mode: AmityLiveViewerCountMode.ALWAYS_SHOW,
+    threshold: 50,
+};
+const isValidMode = (value) => value === AmityLiveViewerCountMode.ALWAYS_SHOW ||
+    value === AmityLiveViewerCountMode.HIDE_ENTIRELY ||
+    value === AmityLiveViewerCountMode.SHOW_ABOVE_MINIMUM;
+const isValidThreshold = (value) => typeof value === 'number' && Number.isInteger(value) && value >= 1 && value <= 1000;
+/**
+ * ```js
+ * import { getLiveViewerCountConfig } from '@amityco/ts-sdk'
+ * const config = await getLiveViewerCountConfig()
+ * ```
+ *
+ * Fetches the network-level {@link Amity.LiveViewerCountConfig} governing
+ * how the live viewer count is displayed to viewers on a livestream.
+ *
+ * Cold-read — no observable, no cache. Call once per livestream mount /
+ * rejoin. Admin-driven config changes take effect on the next join, not
+ * mid-stream.
+ *
+ * On a malformed payload (unknown mode, out-of-range or missing threshold)
+ * the SDK falls open to `{ mode: ALWAYS_SHOW, threshold: 50 }` and logs a
+ * warning. Network errors reject.
+ *
+ * @returns A Promise of {@link Amity.LiveViewerCountConfig}
+ *
+ * @category Client API
+ * @async
+ */
+/* begin_public_function id: client.getLiveViewerCountConfig */
+const getLiveViewerCountConfig = async () => {
+    var _a, _b;
+    const client = getActiveClient();
+    const { data } = await client.http.get('/api/v3/network-settings/video-streaming');
+    const mode = (_a = data === null || data === void 0 ? void 0 : data.videoStreaming) === null || _a === void 0 ? void 0 : _a.viewerCountDisplayMode;
+    const threshold = (_b = data === null || data === void 0 ? void 0 : data.videoStreaming) === null || _b === void 0 ? void 0 : _b.viewerCountDisplayMinimum;
+    if (!isValidMode(mode) || !isValidThreshold(threshold)) {
+        client.log('client/getLiveViewerCountConfig', 'malformed videoStreaming settings, falling back to default', { mode, threshold });
+        return DEFAULT_CONFIG;
+    }
+    return { mode, threshold };
+};
+/* end_public_function */
+
 /* begin_public_function
   id: client.getProductCatalogueSetting
 */
@@ -5071,6 +5179,95 @@ const getForYouFeedSetting = async () => {
 };
 /* end_public_function */
 
+const ENFORCEMENT_MODES = ['off', 'shadow', 'enforce'];
+/**
+ * An unrecognised mode decodes to `off`, and so does an absent one. A mode
+ * this build does not know must not withhold anything — defaulting to
+ * `enforce` would let a server-side rename black out a customer's app.
+ *
+ * @category private
+ */
+const parseEnforcement = (mode) => {
+    const match = ENFORCEMENT_MODES.find(value => value === mode);
+    return match !== null && match !== void 0 ? match : 'off';
+};
+const parseGrants = (modules) => {
+    const grants = {};
+    Object.entries(modules !== null && modules !== void 0 ? modules : {}).forEach(([key, granted]) => {
+        grants[key] = granted === true;
+    });
+    return grants;
+};
+/**
+ * Every catalog entry survives, including one whose key this build has never
+ * heard of, so a module added server-side is still listable.
+ *
+ * @category private
+ */
+const parseCatalog = (catalog) => {
+    const parsed = {};
+    Object.entries(catalog !== null && catalog !== void 0 ? catalog : {}).forEach(([key, definition]) => {
+        const rawRequires = definition === null || definition === void 0 ? void 0 : definition.requires;
+        const requires = Array.isArray(rawRequires)
+            ? rawRequires.filter((entry) => typeof entry === 'string')
+            : [];
+        parsed[key] = {
+            label: typeof (definition === null || definition === void 0 ? void 0 : definition.label) === 'string' ? definition.label : key,
+            kind: (definition === null || definition === void 0 ? void 0 : definition.kind) === 'setting' ? 'setting' : 'api',
+            requires,
+        };
+    });
+    return parsed;
+};
+/**
+ * Decodes `GET /api/v3/network-settings/modules`. Nothing is trimmed: the
+ * catalog is the dependency table callers resolve against, and a client that
+ * cannot see it has to hardcode one.
+ *
+ * @category private
+ */
+const parseModuleSettings = (raw) => {
+    var _a;
+    return ({
+        enforcement: parseEnforcement((_a = raw === null || raw === void 0 ? void 0 : raw.enforcement) !== null && _a !== void 0 ? _a : raw === null || raw === void 0 ? void 0 : raw.mode),
+        modules: parseGrants(raw === null || raw === void 0 ? void 0 : raw.modules),
+        catalog: parseCatalog(raw === null || raw === void 0 ? void 0 : raw.catalog),
+    });
+};
+
+/* begin_public_function
+  id: client.getModuleSettings
+*/
+/**
+ * ```js
+ * import { Client } from '@amityco/ts-sdk'
+ * const moduleSettings = await Client.getModuleSettings()
+ * ```
+ *
+ * Fetches the network's module entitlements: which modules the network was
+ * granted, whether core is enforcing those grants, and the catalog of all
+ * modules with their dependency chains.
+ *
+ * The payload is returned whole — `catalog` is the dependency table
+ * {@link resolveModuleAvailability} reads, and a client that cannot see it has
+ * to hardcode one.
+ *
+ * The read is **advisory**. It tells a host what to offer; under `enforce` the
+ * backend refuses a call to an unowned module regardless of what was resolved
+ * here, and that refusal arrives as `AmityModuleNotEntitledError`.
+ *
+ * @returns A Promise of {@link Amity.ModuleSettings} object
+ *
+ * @category Client API
+ * @async
+ */
+const getModuleSettings = async () => {
+    const client = getActiveClient();
+    const { data } = await client.http.get(`/api/v3/network-settings/modules`);
+    return parseModuleSettings(data);
+};
+/* end_public_function */
+
 const checkUserPermission = (userId, permission) => {
     var _a;
     const user = (_a = pullFromCache(['user', 'get', userId])) === null || _a === void 0 ? void 0 : _a.data;
@@ -5387,7 +5584,7 @@ const logout = async () => {
     const client = getActiveClient();
     client.log('client/api/disconnectClient');
     if (client.mqtt && client.mqtt.connected) {
-        client.mqtt.disconnect();
+        await client.mqtt.disconnect({ endSession: true });
     }
     /*
      * for cases when session state is terminated (example on ban) or token expired,
@@ -8470,6 +8667,7 @@ const createClient = (apiKey, apiRegion = API_REGIONS.SG, { debugSession = DEFAU
         getCoreUserSettings,
         getSocialSettings,
         getChatSettings,
+        getLiveViewerCountConfig,
         getVisitorDeviceId: getDeviceId,
         getMessagePreviewSetting: getMessagePreviewSetting$1,
         use: () => setActiveClient(client),
@@ -8478,6 +8676,7 @@ const createClient = (apiKey, apiRegion = API_REGIONS.SG, { debugSession = DEFAU
         getMarkerSyncConsistentMode,
         getProductCatalogueSetting,
         getForYouFeedSetting,
+        getModuleSettings,
         /**
          * Prefix for the deviceId key in the local storage or async storage.
          * This is allow user to have multiple SDK client and Mqtt client within the same app.
@@ -9531,6 +9730,92 @@ const getUserUnread = (callback) => {
     };
 };
 
+/**
+ * ```js
+ * import { Client, resolveModuleAvailability } from '@amityco/ts-sdk'
+ *
+ * const moduleSettings = await Client.getModuleSettings()
+ *
+ * if (resolveModuleAvailability(moduleSettings, 'live').isAvailable) {
+ *   // offer the Live entry point
+ * }
+ * ```
+ *
+ * The SDK does not hold the settings — the caller keeps what it fetched and
+ * resolves against it. With no settings at all (a fetch that never succeeded)
+ * the caller reads that as every module available: under `enforce` the backend
+ * refuses the calls anyway, so the exposure is a screen that offers too much,
+ * not one that withholds what a customer paid for.
+ *
+ * Resolves whether one module is usable on this network.
+ *
+ * Availability is a function of all three fields of
+ * {@link Amity.ModuleSettings} — the enforcement mode, the module's own grant,
+ * and its prerequisite chain — combined in that order. Reading `modules`
+ * directly contradicts the mode: staging answers `mode: 'off'` with
+ * `modules: {}`, and every module still works.
+ *
+ * The dependency table comes from the payload's `catalog`, never from a
+ * hardcoded copy, so a chain the backend changes takes effect without an SDK
+ * release.
+ *
+ * @param moduleSettings The network's module settings
+ * @param moduleKey The module to resolve — an {@link Amity.ModuleKey}, so the
+ * 15 keys this build knows complete and type-check while a catalog entry it
+ * does not know still resolves.
+ * @returns An {@link Amity.ModuleAvailability} answer
+ *
+ * @category Client API
+ */
+const resolveModuleAvailability = (moduleSettings, moduleKey, seen = new Set()) => {
+    var _a, _b, _c, _d, _e;
+    const isGranted = (_a = moduleSettings.modules[moduleKey]) !== null && _a !== void 0 ? _a : false;
+    /*
+     * Not enforcing: nothing is withheld, and no graph walk is needed. This has
+     * to come first — `off` and `shadow` resolve available whatever the grant
+     * says, and a cycle would otherwise return unavailable under `off` too.
+     */
+    if (moduleSettings.enforcement !== 'enforce') {
+        return { moduleKey, isAvailable: true, isGranted };
+    }
+    // A cycle in `requires` resolves unavailable rather than recursing.
+    if (seen.has(moduleKey)) {
+        return {
+            moduleKey,
+            isAvailable: false,
+            isGranted,
+            reason: 'prerequisiteUnavailable',
+            unsatisfied: (_c = (_b = moduleSettings.catalog[moduleKey]) === null || _b === void 0 ? void 0 : _b.requires) !== null && _c !== void 0 ? _c : [],
+        };
+    }
+    // The module's own grant is evaluated before its prerequisites, so
+    // `notGranted` is reported in preference when both hold.
+    if (!isGranted) {
+        return { moduleKey, isAvailable: false, isGranted, reason: 'notGranted' };
+    }
+    const requires = (_e = (_d = moduleSettings.catalog[moduleKey]) === null || _d === void 0 ? void 0 : _d.requires) !== null && _e !== void 0 ? _e : [];
+    if (requires.length === 0)
+        return { moduleKey, isAvailable: true, isGranted };
+    // `requires` is satisfied by any one entry, transitively.
+    const isSatisfied = requires.some(dependency => resolveModuleAvailability(moduleSettings, dependency, new Set([...seen, moduleKey]))
+        .isAvailable);
+    if (isSatisfied)
+        return { moduleKey, isAvailable: true, isGranted };
+    /*
+     * `unsatisfied` carries the whole `requires` list rather than one entry. Any
+     * one of them would have satisfied the requirement, so naming a single
+     * module misdirects: telling a Community-only customer "Comment needs post"
+     * hides that Story would also have done.
+     */
+    return {
+        moduleKey,
+        isAvailable: false,
+        isGranted,
+        reason: 'prerequisiteUnavailable',
+        unsatisfied: requires,
+    };
+};
+
 var index$s = /*#__PURE__*/Object.freeze({
     __proto__: null,
     getActiveClient: getActiveClient,
@@ -9554,6 +9839,7 @@ var index$s = /*#__PURE__*/Object.freeze({
     getShareableLinkConfiguration: getShareableLinkConfiguration,
     getProductCatalogueSetting: getProductCatalogueSetting,
     getForYouFeedSetting: getForYouFeedSetting,
+    getModuleSettings: getModuleSettings,
     loginAsVisitor: loginAsVisitor,
     loginAsBot: loginAsBot,
     getCurrentUser: getCurrentUser,
@@ -9561,6 +9847,7 @@ var index$s = /*#__PURE__*/Object.freeze({
     setCurrentUserType: setCurrentUserType,
     setAccessTokenHandler: setAccessTokenHandler,
     getChatSettings: getChatSettings,
+    getLiveViewerCountConfig: getLiveViewerCountConfig,
     getCoreUserSettings: getCoreUserSettings,
     notifications: notifications,
     enableAutoSubscriptions: enableAutoSubscriptions,
@@ -9580,7 +9867,8 @@ var index$s = /*#__PURE__*/Object.freeze({
     startMarkerSync: startMarkerSync,
     startUnreadSync: startUnreadSync,
     stopUnreadSync: stopUnreadSync,
-    getMarkerSyncConsistentMode: getMarkerSyncConsistentMode
+    getMarkerSyncConsistentMode: getMarkerSyncConsistentMode,
+    resolveModuleAvailability: resolveModuleAvailability
 });
 
 /* begin_public_function
@@ -12477,7 +12765,7 @@ const getWatchSessionStorage = () => {
     return storageInstance;
 };
 
-const privateKey = "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDHo80SecH7FuF2\nhFYnb+l26/VN8UMLXAQFLnxciNTEwkGVFMpdezlH8rU2HtUJL4RETogbAOLVY0XM\njs6sPn8G1nALmh9qeDpUtVqFOVtBHxEZ910TLOtQiunjqJKO5nWdqZ71EC3OFluR\niGQkO84BiIFbv37ub7xl3S8XarbtKoLcyVpkDHi+1wx1pgCAn6gtBUgckPL5NR8j\nLseabl3HAXQfhTCKo4tmOFM2Dxwl1IUMmIJrJg/aIU/U0tj/1Eoo7mG0JcNWX19l\nW3EecCbi0ncCJOrkUdwlBrcjaMayaX/ubEwyUeTGiLdyc4L3GRLHjyK8xgVNXRMH\nbZWJ2a5NAgMBAAECggEASxuE+35zTFO/XydKgmvIGcWL9FbgMlXb7Vcf0nBoG945\nbiz0NVc2paraIhJXc608xbYF3qLmtAE1MVBI0ORyRdBHNxY024l/6H6SH60Ed+uI\nM4ysp5ourY6Vj+DLwpdRiI9YDjqYAQDIUmhNxJP7XPhOMoZI6st+xZQBM34ic/bv\nAMSJm9OZphSp3+qXVkFZztr2mxD2EZSJJLYxi8BCdgM2qhazalbcJ6zDKHCZWVWm\n8RRxDGldyMb/237JxETzP40tAlzOZDmBAbUgEnurDJ93RVDIE3rbZUshwgeQd18a\nem096mWgvB1AIKYgsTAR3pw+V19YWAjq/glP6fz8wQKBgQD/oQq+ukKF0PRgBeM5\ngeTjSwsdGppQLmf5ndujvoiz/TpdjDEPu6R8kigQr1rG2t4K/yfdZoI8RdmJD1al\n3Q7N9hofooSy4rj6E3txzWZCHJjHad2cnCp/O26HiReGAl7wTcfTmNdiFHhZQzm5\nJBkvWAiwuvQMNfEbnXxw6/vIDwKBgQDH7fX8gsc77JLvAWgp1MaQN/sbqVb6JeT1\nFQfR8E/WFCSmzQBtNzd5KgYuCeelwr/8DyYytvN2BzCYZXp73gI1jF3YlW5jVn74\nOY6TwQ095digwo6Z0yuxopdIOApKgAkL9PRKgNrqAf3NAyMua6lOGifzjDojC3KU\nfylQmxMn4wKBgHp2B9O/H0dEBw5JQ8W0+JX6yWQz7mEjGiR2/1W+XXb8hQ1zr709\nw1r6Gb+EghRpnZ3fBpYGGbYOMFx8wKHM+N6qW3F0ReX8v2juFGE8aRSa5oYBrWzt\nU16Idjbv8hj84cZ1PJmdyvDtpYn9rpWHOZl4rxEbPvbqkIsOMyNVqdT5AoGAOSge\nmwIIU2le2FVeohbibXiToWTYKMuMmURZ5/r72AgKMmWJKbAPe+Q3wBG01/7FRBpQ\noU8Ma0HC8s6QJbliiEyIx9JwrJWd1vkdecBHONrtA4ibm/5zD2WcOllLF+FitLhi\n3qnX6+6F0IaFGFBPJrTzlv0P4dTz/OAdv52V7GECgYEA2TttOKBAqWllgOaZOkql\nLVMJVmgR7s6tLi1+cEP8ZcapV9aRbRzTAKXm4f8AEhtlG9F9kCOvHYCYGi6JaiWJ\nZkHjeex3T+eE6Di6y5Bm/Ift5jtVhJ4jCVwHOKTMej79NPUFTJfv8hCo29haBDv6\nRXFrv+T21KCcw8k3sJeJWWQ=\n-----END PRIVATE KEY-----";
+const privateKey = "MIIEpQIBAAKCAQEAwAEc/oZgYIvKSUG/C3mONYLR4ZPgAjMEX4bJ+xqqakUDRtqlNO+eZs2blQ1Ko0DBkqPExyQezvjibH5W2UZBV5RaBTlTcNVKTToMBEGesAfaEcM3qUyQHxdbFYZv6P4sb14dcwxTQ8usmaV8ooiR1Fcaso5ZWYcZ8Hb46FbQ7OoVumsBtPWwfZ4f003o5VCl6AIM6lcLv9UDLlFVYhE+PeXpRHtfWlGqxMvqC9oinlwhL6nWv6VjQXW4nhcib72dPBzfHT7k/PMKto2SxALYdb68ENiAGuJLWi3AUHSyYCJK2w7wIlWfJUAI0v26ub10IpExr6D5QuW2577jjP93iwIDAQABAoIBAFWfqXhwIIatkFY+9Z1+ZcbDQimgsmMIsUiQaX6Lk7e0cxOj6czDlxYtVtaPiNtow2pLkjNkjkCqiP7tEHnwdK9DvylZOTa2R15NJpK3WLcTqVIGhsn/FL5owfvFah6zSsmXZParZm5zY9NZE03ALZhOB9/cz0e3kf/EbpfeL2mW7MApyiUt5i09ycchroOpcWp73ipIxvgigtZyUGFmsQicWhUs28F0D7w4Qfk76yG3nqXeb+BAMhCaIaa/k/aAxhiZG/ygEQWQrcC8gfe+jyicMAQPDEVS9YuUMGsLjIjKuVLZzp2xirQnhc2i2zVNEIvG6soprPOBEMQugzrtX5ECgYEA3b7KAbBIbDl1e4ZSCWhHdHkiWVZHaopsR/LhqDDNhXjWjq3AesgV6k0j9EdziMn/HmmOso0bz99GTV3JZf4A9ztTLumJlkHbdVtlgOqSjrFLj12rH9KXTheyIhWSpUmm8+WB1xasFbqpvJaGo7F3pd2Fqj1XR4mp5BO7c/t7LJ0CgYEA3aouEzXQ9THRKYocdfY69EI1Il1t/d/RSqqd9BxEjxBgxkM13ZiYIn/R4WW/nCUrlmhxG44Aa2Gob4Ahfsui2xKTg/g/3Zk/rAxAEGkfOLGoenaJMD41fH4wUq3FRYwkvnaMb9Hd6f/TlBHslIRa2NN58bSBGJCyBP2b59+2+EcCgYEAixDVRXvV37GlYUOa/XVdosk5Zoe6oDGRuQm0xbNdoUBoZvDHDvme7ONWEiQha/8qtVsD+CyQ7awcPfb8kK9c0bBt+bTS6d4BkTcxkEkMgtrkBVR8Nqfu5jXsLH4VCv4G61zbMhZw8+ut+az5YX2yCN7Frj9sFlxapMRPQmzMEe0CgYEAumsAzM8ZqNv4mAK65Mnr0rhLj1cbxcKRdUYACOgtEFQpzxN/HZnTeFAe5nx3pI3uFlRHq3DFEYnT6dHMWaJQmAULYpVIwMi9L6gtyJ9fzoI6uqMtxRDMUqKdaSsTGOY/kJ6KhQ/unXi1K3XXjR+yd1+C0q+HUm1+CYxvrZYLfskCgYEArsEy+IQOiqniJ0NE2vVUF+UK/IRZaic9YKcpov5Ot7Vvzm/MnnW4N1ljVskocETBWMmPUvNSExVjPebi+rxd8fa5kY8BJScPTzMFbunZn/wjtGdcM10qdlVQ9doG61A/9P3ezFKCfS4AvF/H/59LcSx2Bh28fp3/efiVIOpVd4Y=";
 /*
  * The crypto algorithm used for importing key and signing string
  */
@@ -12905,6 +13193,21 @@ const productTagLinkedObject = (productTag) => {
     return Object.assign(Object.assign({}, productTag), { product: internalProduct ? productLinkedObject(internalProduct) : undefined });
 };
 
+const fileLinkedObject = (file) => {
+    var _a, _b, _c;
+    if (!file)
+        return file;
+    if (file.type === 'video') {
+        const video = (_b = (_a = file.attributes) === null || _a === void 0 ? void 0 : _a.metadata) === null || _b === void 0 ? void 0 : _b.video;
+        return Object.assign(Object.assign({}, file), { getWidth: () => { var _a; return (_a = video === null || video === void 0 ? void 0 : video.width) !== null && _a !== void 0 ? _a : 0; }, getHeight: () => { var _a; return (_a = video === null || video === void 0 ? void 0 : video.height) !== null && _a !== void 0 ? _a : 0; }, getRotation: () => { var _a; return (_a = video === null || video === void 0 ? void 0 : video.rotation) !== null && _a !== void 0 ? _a : 0; } });
+    }
+    if (file.type === 'image') {
+        const metadata = (_c = file.attributes) === null || _c === void 0 ? void 0 : _c.metadata;
+        return Object.assign(Object.assign({}, file), { getWidth: () => { var _a; return (_a = metadata === null || metadata === void 0 ? void 0 : metadata.width) !== null && _a !== void 0 ? _a : 0; }, getHeight: () => { var _a; return (_a = metadata === null || metadata === void 0 ? void 0 : metadata.height) !== null && _a !== void 0 ? _a : 0; } });
+    }
+    return file;
+};
+
 const postLinkedObject = (post) => {
     return shallowClone(post, {
         childrenPosts: post.children
@@ -12962,19 +13265,19 @@ const postLinkedObject = (post) => {
         getImageInfo() {
             var _a, _b;
             return isAmityImagePost(post)
-                ? (_b = pullFromCache(['file', 'get', (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.fileId])) === null || _b === void 0 ? void 0 : _b.data
+                ? fileLinkedObject((_b = pullFromCache(['file', 'get', (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.fileId])) === null || _b === void 0 ? void 0 : _b.data)
                 : undefined;
         },
         getVideoInfo() {
             var _a, _b, _c;
             return isAmityVideoPost(post)
-                ? (_c = pullFromCache(['file', 'get', (_b = (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.videoFileId) === null || _b === void 0 ? void 0 : _b.original])) === null || _c === void 0 ? void 0 : _c.data
+                ? fileLinkedObject((_c = pullFromCache(['file', 'get', (_b = (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.videoFileId) === null || _b === void 0 ? void 0 : _b.original])) === null || _c === void 0 ? void 0 : _c.data)
                 : undefined;
         },
         getVideoThumbnailInfo() {
             var _a, _b;
             return isAmityVideoPost(post)
-                ? (_b = pullFromCache(['file', 'get', (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.thumbnailFileId])) === null || _b === void 0 ? void 0 : _b.data
+                ? fileLinkedObject((_b = pullFromCache(['file', 'get', (_a = post === null || post === void 0 ? void 0 : post.data) === null || _a === void 0 ? void 0 : _a.thumbnailFileId])) === null || _b === void 0 ? void 0 : _b.data)
                 : undefined;
         },
         getFileInfo() {
@@ -13965,6 +14268,7 @@ const eventLinkedObject = (event) => {
 };
 
 const LinkedObject = {
+    file: fileLinkedObject,
     ad: adLinkedObject,
     comment: commentLinkedObject,
     post: postLinkedObject,
@@ -15128,10 +15432,58 @@ class SearchUserLiveCollectionController extends LiveCollectionController {
     }
 }
 
+/* begin_public_function
+  id: user.searchUsers
+*/
+/**
+ * ```js
+ * import { UserRepository } from '@amityco/ts-sdk'
+ *
+ * let users = []
+ * const unsub = UserRepository.searchUsers(
+ *   { displayName: 'jack', searchBy: [SearchUsersByEnum.DISPLAY_NAME] },
+ *   response => merge(users, response.data),
+ * )
+ * ```
+ *
+ * Observe all mutations on a list of {@link Amity.InternalUser}s.
+ *
+ * Pass `searchBy` in `params` to restrict which user fields are matched
+ * (e.g. `[SearchUsersByEnum.DISPLAY_NAME]`). When omitted, the backend
+ * default (both `displayName` and `userId`) applies.
+ *
+ * @param params for searching users
+ * @param callback the function to call when new data are available
+ * @param config the configuration for the live collection
+ * @returns An {@link Amity.Unsubscriber} function to run when willing to stop observing the users
+ *
+ * @category Category Live Collection
+ */
+const searchUsers = (params, callback, config) => {
+    const { log, cache } = getActiveClient();
+    if (!cache) {
+        // eslint-disable-next-line no-console
+        console.log(ENABLE_CACHE_MESSAGE);
+    }
+    const timestamp = Date.now();
+    log(`liveSearchUsers(tmpid: ${timestamp}) > listen`);
+    const searchUsersLiveCollection = new SearchUserLiveCollectionController(params, callback);
+    const disposers = searchUsersLiveCollection.startSubscription();
+    const cacheKey = searchUsersLiveCollection.getCacheKey();
+    disposers.push(() => dropFromCache(cacheKey));
+    return () => {
+        log(`liveSearchUsers(tmpid: ${timestamp}) > dispose`);
+        disposers.forEach(fn => fn());
+    };
+};
+/* end_public_function */
+
 /* begin_public_function
   id: user.search
 */
 /**
+ * @deprecated Use {@link searchUsers} instead. `searchUserByDisplayName` will be removed in a future major version.
+ *
  * ```js
  * import { UserRepository } from '@amityco/ts-sdk'
  *
@@ -15280,6 +15632,7 @@ var index$q = /*#__PURE__*/Object.freeze({
     getUsers: getUsers,
     getBlockedUsers: getBlockedUsers,
     getBlockingUsers: getBlockingUsers,
+    searchUsers: searchUsers,
     searchUserByDisplayName: searchUserByDisplayName,
     getReachedUsers: getReachedUsers,
     get AmityUserSearchMatchType () { return AmityUserSearchMatchType; }
@@ -15312,7 +15665,7 @@ const getFile = async (fileId) => {
     if (client.cache)
         ingestInCache({ files: [data] }, { cachedAt });
     return {
-        data,
+        data: fileLinkedObject(data),
         cachedAt,
     };
 };
@@ -15339,7 +15692,7 @@ getFile.locally = (fileId) => {
     if (!cached)
         return;
     return {
-        data: cached.data,
+        data: fileLinkedObject(cached.data),
         cachedAt: cached.cachedAt,
     };
 };
@@ -15476,7 +15829,7 @@ const uploadVideo = async (formData, feedType, onProgress) => {
     if (client.cache)
         ingestInCache({ files: data }, { cachedAt });
     return {
-        data,
+        data: data.map(file => fileLinkedObject(file)),
         cachedAt,
     };
 };
@@ -15537,7 +15890,7 @@ const uploadImage = async (formData, onProgress, altText) => {
     if (client.cache)
         ingestInCache({ files: data }, { cachedAt });
     return {
-        data,
+        data: data.map(file => fileLinkedObject(file)),
         cachedAt,
     };
 };
@@ -35494,4 +35847,4 @@ class AmityAttachmentProductTags {
     }
 }
 
-export { API_REGIONS, index$5 as AdRepository, AmityAttachmentProductTags, AmityAutoSubscription, AmityChannelNotificationModeEnum, AmityCommunityType, AmityEventOrderOption, AmityEventOriginType, AmityEventResponseStatus, AmityEventSortOption, AmityEventStatus, AmityEventType, AmitySharableContentType, AnalyticsSourceTypeEnum, index$f as CategoryRepository, index$j as ChannelRepository, index$s as Client, index$e as CommentRepository, CommunityNotificationEventNameEnum, CommunityPostSettingMaps, CommunityPostSettings, index$g as CommunityRepository, ContentFeedType, ContentFlagReasonEnum, DefaultCommunityPostSetting, index$1 as EventRepository, FeedDataTypeEnum, index$d as FeedRepository, FeedSortByEnum, FeedSourceEnum, FeedTypeEnum, FileAccessTypeEnum, index$p as FileRepository, FileType, GET_WATCHER_URLS, index$3 as InvitationRepository, InvitationSortByEnum, InvitationStatusEnum, InvitationTargetTypeEnum, InvitationTypeEnum, JoinRequestStatusEnum, JoinResultStatusEnum, index$2 as LiveReactionRepository, index$7 as LiveStreamPlayer, MembershipAcceptanceTypeEnum, MessageContentType, index$n as MessageRepository, NotificationRolesFilterTypeEnum, NotificationSettingsLevelEnum, index$8 as PollRepository, PostContentType, index$b as PostRepository, PostStructureType, index as ProductRepository, index$o as ReactionRepository, index$9 as RoomPresenceRepository, index$c as RoomRepository, SearchUsersByEnum, index$6 as StoryRepository, index$a as StreamRepository, index$m as SubChannelRepository, SubscriptionLevels, UserNotificationModuleNameEnum, UserReportTypeEnum, index$q as UserRepository, UserTypeEnum, VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, backupCache, createQuery, createReport, createUserToken, deleteReport, disableCache, dropFromCache, enableCache, exceedsUntilAtBoundary, filterByChannelMembership, filterByCommunityMembership, filterByFeedType, filterByPostDataTypes, filterByPropEquality, filterByPropInclusion, filterByPropIntersection, filterBySearchTerm, filterByStringComparePartially, filterByUntilAt, filterCommentsByBlockUsers, filterPostsByBlockUsers, getBlockUsersId, getChannelTopic, getCommentTopic, getCommunityStoriesTopic, getCommunityTopic, getLiveReactionTopic, getLiveStreamTopic, getMarkedMessageTopic, getMarkerUserFeedTopic, getMessageTopic, getMyFollowersTopic, getMyFollowingsTopic, getNetworkId, getNetworkTopic, getPostTopic, getRole, getRoomStreamerTopic, getRoomWatcherTopic, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStoryTopic, getSubChannelTopic, getUserTopic, isAfterBefore, isAfterBeforeRaw, isCachable, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkip, mergeInCache, index$4 as notificationTray, onChannelMarkerFetched, onFeedMarkerFetched, onFeedMarkerUpdated, onMessageMarked, onMessageMarkerFetched, onSubChannelMarkerFetched, onSubChannelMarkerUpdated, onUserMarkerFetched, onUserMarkerFetchedLegacy, pullFromCache, pushToCache, queryCache, queryOptions, queryRoles, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByFirstUpdated, sortByLastActivity, sortByLastCreated, sortByLastUpdated, sortByLocalSortingDate, sortByName, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, upsertInCache, validateUntilAt, wipeCache };
+export { API_REGIONS, index$5 as AdRepository, AmityAttachmentProductTags, AmityAutoSubscription, AmityChannelNotificationModeEnum, AmityCommunityType, AmityEventOrderOption, AmityEventOriginType, AmityEventResponseStatus, AmityEventSortOption, AmityEventStatus, AmityEventType, AmityLiveViewerCountMode, AmityModuleNotEntitledError, AmitySharableContentType, AnalyticsSourceTypeEnum, index$f as CategoryRepository, index$j as ChannelRepository, index$s as Client, index$e as CommentRepository, CommunityNotificationEventNameEnum, CommunityPostSettingMaps, CommunityPostSettings, index$g as CommunityRepository, ContentFeedType, ContentFlagReasonEnum, DefaultCommunityPostSetting, index$1 as EventRepository, FeedDataTypeEnum, index$d as FeedRepository, FeedSortByEnum, FeedSourceEnum, FeedTypeEnum, FileAccessTypeEnum, index$p as FileRepository, FileType, GET_WATCHER_URLS, index$3 as InvitationRepository, InvitationSortByEnum, InvitationStatusEnum, InvitationTargetTypeEnum, InvitationTypeEnum, JoinRequestStatusEnum, JoinResultStatusEnum, index$2 as LiveReactionRepository, index$7 as LiveStreamPlayer, MembershipAcceptanceTypeEnum, MessageContentType, index$n as MessageRepository, NotificationRolesFilterTypeEnum, NotificationSettingsLevelEnum, index$8 as PollRepository, PostContentType, index$b as PostRepository, PostStructureType, index as ProductRepository, index$o as ReactionRepository, index$9 as RoomPresenceRepository, index$c as RoomRepository, SearchUsersByEnum, index$6 as StoryRepository, index$a as StreamRepository, index$m as SubChannelRepository, SubscriptionLevels, UserNotificationModuleNameEnum, UserReportTypeEnum, index$q as UserRepository, UserTypeEnum, VERSION, VideoResolution, VideoSize, VideoTranscodingStatus, backupCache, createQuery, createReport, createUserToken, deleteReport, disableCache, dropFromCache, enableCache, exceedsUntilAtBoundary, filterByChannelMembership, filterByCommunityMembership, filterByFeedType, filterByPostDataTypes, filterByPropEquality, filterByPropInclusion, filterByPropIntersection, filterBySearchTerm, filterByStringComparePartially, filterByUntilAt, filterCommentsByBlockUsers, filterPostsByBlockUsers, getBlockUsersId, getChannelTopic, getCommentTopic, getCommunityStoriesTopic, getCommunityTopic, getLiveReactionTopic, getLiveStreamTopic, getMarkedMessageTopic, getMarkerUserFeedTopic, getMessageTopic, getMyFollowersTopic, getMyFollowingsTopic, getNetworkId, getNetworkTopic, getPostTopic, getRole, getRoomStreamerTopic, getRoomWatcherTopic, getSmartFeedChannelTopic, getSmartFeedMessageTopic, getSmartFeedSubChannelTopic, getStoryTopic, getSubChannelTopic, getUserTopic, isAfterBefore, isAfterBeforeRaw, isCachable, isFetcher, isFresh, isLocal, isMutator, isOffline, isPaged, isReportedByMe, isSkip, mergeInCache, index$4 as notificationTray, onChannelMarkerFetched, onFeedMarkerFetched, onFeedMarkerUpdated, onMessageMarked, onMessageMarkerFetched, onSubChannelMarkerFetched, onSubChannelMarkerUpdated, onUserMarkerFetched, onUserMarkerFetchedLegacy, pullFromCache, pushToCache, queryCache, queryOptions, queryRoles, resolveModuleAvailability, restoreCache, runQuery, sortByChannelSegment, sortByDisplayName, sortByFirstCreated, sortByFirstUpdated, sortByLastActivity, sortByLastCreated, sortByLastUpdated, sortByLocalSortingDate, sortByName, sortBySegmentNumber, subscribeTopic, toPage, toPageRaw, toToken, upsertInCache, validateUntilAt, wipeCache };