@wildix/stream-client 0.0.13 → 0.0.15

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SystemMessage = exports.SearchSort = exports.MessageUnsetFields = exports.MarkUnreadChannelsLimitReachedException = exports.MentionsFilter = exports.GroupChannelUnsetOptions = exports.FileNotFoundException = exports.FileCategory = exports.DownloadStrategy = exports.SectionNotFoundException = exports.MessageNotFoundException = exports.MemberNotFoundException = exports.SectionType = exports.TargetNotFoundException = exports.TargetNotEligibleException = exports.TargetNotEligibleReason = exports.MessageWhatsAppStatus = exports.MessageSmsStatus = exports.Element = exports.GroupChannelCreationEventType = exports.ChannelsFilter = exports.ChannelAlreadyExistException = exports.ChannelWhatsAppStatus = exports.MessageType = exports.ChannelContextSource = exports.ChannelContextEventAttendeeStatus = exports.ChannelType = exports.ChannelAccess = exports.AssignChannelVariant = exports.AssignChannelServiceRequest = exports.AssignChannelAssigneeRequest = exports.StreamServiceException = exports.MemberAlreadyExistException = exports.ChannelNotFoundException = exports.ChannelMemberRole = exports.ActionElement = exports.ButtonVariant = exports.ButtonHandler = exports.ValidationException = exports.UnauthorizedException = exports.RateLimitExceededException = exports.ForbiddenException = void 0;
+exports.SystemMessage = exports.SearchSort = exports.MessageUnsetFields = exports.MarkUnreadChannelsLimitReachedException = exports.MentionsFilter = exports.GroupChannelUnsetOptions = exports.FileNotFoundException = exports.FileCategory = exports.DownloadStrategy = exports.SectionNotFoundException = exports.MessageNotFoundException = exports.MemberNotFoundException = exports.SectionType = exports.TargetNotFoundException = exports.TargetNotEligibleException = exports.TargetNotEligibleReason = exports.MessageWhatsAppStatus = exports.MessageSmsStatus = exports.Element = exports.GroupChannelCreationEventType = exports.ChannelsFilter = exports.ChannelAlreadyExistException = exports.ChannelWhatsAppStatus = exports.MessageType = exports.ChannelContextSource = exports.ChannelContextEventAttendeeStatus = exports.ChannelType = exports.ChannelAccess = exports.AttachmentType = exports.AssignChannelVariant = exports.AssignChannelServiceRequest = exports.AssignChannelAssigneeRequest = exports.StreamServiceException = exports.MemberAlreadyExistException = exports.ChannelNotFoundException = exports.ChannelMemberRole = exports.ActionElement = exports.ButtonVariant = exports.ButtonHandler = exports.ValidationException = exports.UnauthorizedException = exports.RateLimitExceededException = exports.ForbiddenException = void 0;
 const StreamServiceServiceException_1 = require("./StreamServiceServiceException");
 class ForbiddenException extends StreamServiceServiceException_1.StreamServiceServiceException {
     name = "ForbiddenException";
@@ -153,6 +153,12 @@ exports.AssignChannelVariant = {
     SELECTED: "SELECTED",
     SKIP: "SKIP",
 };
+exports.AttachmentType = {
+    AUDIO: "audio",
+    FILE: "file",
+    IMAGE: "image",
+    VIDEO: "video",
+};
 exports.ChannelAccess = {
     PRIVATE: "private",
     PUBLIC: "public",

package/dist-cjs/protocols/Aws_restJson1.js

@@ -963,9 +963,12 @@ const se_SearchChannelsCommand = async (input, context) => {
     const query = (0, smithy_client_1.map)({
         [_c]: [, input[_cI]],
         [_uI]: [, input[_uI]],
-        [_q]: [, (0, smithy_client_1.expectNonNull)(input[_q], `q`)],
+        [_q]: [, input[_q]],
+        [_mI]: [, input[_mI]],
+        [_cT]: [, input[_cT]],
         [_si]: [() => input.size !== void 0, () => (input[_si].toString())],
         [_cu]: [, input[_cu]],
+        [_so]: [, input[_so]],
     });
     let body;
     b.m("GET")
@@ -982,8 +985,11 @@ const se_SearchMessagesCommand = async (input, context) => {
     const query = (0, smithy_client_1.map)({
         [_c]: [, input[_cI]],
         [_uI]: [, input[_uI]],
-        [_q]: [, (0, smithy_client_1.expectNonNull)(input[_q], `q`)],
+        [_q]: [, input[_q]],
         [_cIh]: [, input[_cIh]],
+        [_hA]: [() => input.hasAttachments !== void 0, () => (input[_hA].toString())],
+        [_aT]: [() => input.attachmentTypes !== void 0, () => ((input[_aT] || []))],
+        [_mT]: [() => input.mimeTypes !== void 0, () => ((input[_mT] || []))],
         [_si]: [() => input.size !== void 0, () => (input[_si].toString())],
         [_cu]: [, input[_cu]],
         [_so]: [, input[_so]],
@@ -2434,17 +2440,22 @@ const deserializeMetadata = (output) => ({
     cfId: output.headers["x-amz-cf-id"],
 });
 const collectBodyString = (streamBody, context) => (0, smithy_client_1.collectBody)(streamBody, context).then(body => context.utf8Encoder(body));
+const _aT = "attachmentTypes";
 const _c = "company";
 const _cI = "companyId";
 const _cIh = "channelId";
 const _cIl = "clientId";
+const _cT = "channelType";
 const _ca = "category";
 const _cu = "cursor";
 const _d = "download";
 const _f = "filter";
 const _fo = "force";
 const _fr = "from";
+const _hA = "hasAttachments";
 const _l = "limit";
+const _mI = "memberId";
+const _mT = "mimeTypes";
 const _o = "offset";
 const _q = "q";
 const _rA = "retryAfter";

package/dist-es/models/models_0.js

@@ -143,6 +143,12 @@ export const AssignChannelVariant = {
     SELECTED: "SELECTED",
     SKIP: "SKIP",
 };
+export const AttachmentType = {
+    AUDIO: "audio",
+    FILE: "file",
+    IMAGE: "image",
+    VIDEO: "video",
+};
 export const ChannelAccess = {
     PRIVATE: "private",
     PUBLIC: "public",

package/dist-es/protocols/Aws_restJson1.js

@@ -913,9 +913,12 @@ export const se_SearchChannelsCommand = async (input, context) => {
     const query = map({
         [_c]: [, input[_cI]],
         [_uI]: [, input[_uI]],
-        [_q]: [, __expectNonNull(input[_q], `q`)],
+        [_q]: [, input[_q]],
+        [_mI]: [, input[_mI]],
+        [_cT]: [, input[_cT]],
         [_si]: [() => input.size !== void 0, () => (input[_si].toString())],
         [_cu]: [, input[_cu]],
+        [_so]: [, input[_so]],
     });
     let body;
     b.m("GET")
@@ -931,8 +934,11 @@ export const se_SearchMessagesCommand = async (input, context) => {
     const query = map({
         [_c]: [, input[_cI]],
         [_uI]: [, input[_uI]],
-        [_q]: [, __expectNonNull(input[_q], `q`)],
+        [_q]: [, input[_q]],
         [_cIh]: [, input[_cIh]],
+        [_hA]: [() => input.hasAttachments !== void 0, () => (input[_hA].toString())],
+        [_aT]: [() => input.attachmentTypes !== void 0, () => ((input[_aT] || []))],
+        [_mT]: [() => input.mimeTypes !== void 0, () => ((input[_mT] || []))],
         [_si]: [() => input.size !== void 0, () => (input[_si].toString())],
         [_cu]: [, input[_cu]],
         [_so]: [, input[_so]],
@@ -2309,17 +2315,22 @@ const deserializeMetadata = (output) => ({
     cfId: output.headers["x-amz-cf-id"],
 });
 const collectBodyString = (streamBody, context) => collectBody(streamBody, context).then(body => context.utf8Encoder(body));
+const _aT = "attachmentTypes";
 const _c = "company";
 const _cI = "companyId";
 const _cIh = "channelId";
 const _cIl = "clientId";
+const _cT = "channelType";
 const _ca = "category";
 const _cu = "cursor";
 const _d = "download";
 const _f = "filter";
 const _fo = "force";
 const _fr = "from";
+const _hA = "hasAttachments";
 const _l = "limit";
+const _mI = "memberId";
+const _mT = "mimeTypes";
 const _o = "offset";
 const _q = "q";
 const _rA = "retryAfter";

package/dist-types/StreamService.d.ts

@@ -341,12 +341,14 @@ export interface StreamService {
     /**
      * @see {@link SearchChannelsCommand}
      */
+    searchChannels(): Promise<SearchChannelsCommandOutput>;
     searchChannels(args: SearchChannelsCommandInput, options?: __HttpHandlerOptions): Promise<SearchChannelsCommandOutput>;
     searchChannels(args: SearchChannelsCommandInput, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
     searchChannels(args: SearchChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
     /**
      * @see {@link SearchMessagesCommand}
      */
+    searchMessages(): Promise<SearchMessagesCommandOutput>;
     searchMessages(args: SearchMessagesCommandInput, options?: __HttpHandlerOptions): Promise<SearchMessagesCommandOutput>;
     searchMessages(args: SearchMessagesCommandInput, cb: (err: any, data?: SearchMessagesCommandOutput) => void): void;
     searchMessages(args: SearchMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchMessagesCommandOutput) => void): void;

package/dist-types/commands/CreateGroupChannelCommand.d.ts

@@ -107,6 +107,7 @@ declare const CreateGroupChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/CreateKiteChannelCommand.d.ts

@@ -195,6 +195,7 @@ declare const CreateKiteChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/GetChannelCommand.d.ts

@@ -56,6 +56,7 @@ declare const GetChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/GetInboxCommand.d.ts

@@ -56,6 +56,7 @@ declare const GetInboxCommand_base: {
  * //         userId: "STRING_VALUE", // required
  * //         messageType: "regular" || "system" || "deleted", // required
  * //         text: "STRING_VALUE",
+ * //         event: "STRING_VALUE",
  * //         createdAt: "STRING_VALUE", // required
  * //       },
  * //       company: "STRING_VALUE",

package/dist-types/commands/GetOrCreateDirectChannelCommand.d.ts

@@ -62,6 +62,7 @@ declare const GetOrCreateDirectChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/GetOrCreateSmsChannelCommand.d.ts

@@ -59,6 +59,7 @@ declare const GetOrCreateSmsChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/GetOrCreateTelephonyChannelCommand.d.ts

@@ -58,6 +58,7 @@ declare const GetOrCreateTelephonyChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/GetOrCreateWhatsAppChannelCommand.d.ts

@@ -59,6 +59,7 @@ declare const GetOrCreateWhatsAppChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/JoinChannelCommand.d.ts

@@ -57,6 +57,7 @@ declare const JoinChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/ListChannelsCommand.d.ts

@@ -59,6 +59,7 @@ declare const ListChannelsCommand_base: {
  * //         userId: "STRING_VALUE", // required
  * //         messageType: "regular" || "system" || "deleted", // required
  * //         text: "STRING_VALUE",
+ * //         event: "STRING_VALUE",
  * //         createdAt: "STRING_VALUE", // required
  * //       },
  * //       company: "STRING_VALUE",

package/dist-types/commands/PartialUpdateChannelCommand.d.ts

@@ -101,6 +101,7 @@ declare const PartialUpdateChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/commands/QueryChannelsCommand.d.ts

@@ -61,6 +61,7 @@ declare const QueryChannelsCommand_base: {
  * //         userId: "STRING_VALUE", // required
  * //         messageType: "regular" || "system" || "deleted", // required
  * //         text: "STRING_VALUE",
+ * //         event: "STRING_VALUE",
  * //         createdAt: "STRING_VALUE", // required
  * //       },
  * //       company: "STRING_VALUE",

package/dist-types/commands/SearchChannelsCommand.d.ts

@@ -23,7 +23,7 @@ export interface SearchChannelsCommandOutput extends SearchChannelsOutput, __Met
 }
 declare const SearchChannelsCommand_base: {
     new (input: SearchChannelsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchChannelsCommandInput, SearchChannelsCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: SearchChannelsCommandInput): import("@smithy/smithy-client").CommandImpl<SearchChannelsCommandInput, SearchChannelsCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [SearchChannelsCommandInput]): import("@smithy/smithy-client").CommandImpl<SearchChannelsCommandInput, SearchChannelsCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -37,9 +37,12 @@ declare const SearchChannelsCommand_base: {
  * const input = { // SearchChannelsInput
  *   companyId: "STRING_VALUE",
  *   userId: "STRING_VALUE",
- *   q: "STRING_VALUE", // required
+ *   q: "STRING_VALUE",
+ *   memberId: "STRING_VALUE",
+ *   channelType: "direct" || "group",
  *   size: Number("int"),
  *   cursor: "STRING_VALUE",
+ *   sort: "relevance" || "recency" || "recency_asc",
  * };
  * const command = new SearchChannelsCommand(input);
  * const response = await client.send(command);
@@ -60,6 +63,7 @@ declare const SearchChannelsCommand_base: {
  * //           userId: "STRING_VALUE", // required
  * //           messageType: "regular" || "system" || "deleted", // required
  * //           text: "STRING_VALUE",
+ * //           event: "STRING_VALUE",
  * //           createdAt: "STRING_VALUE", // required
  * //         },
  * //         company: "STRING_VALUE",

package/dist-types/commands/SearchMessagesCommand.d.ts

@@ -23,7 +23,7 @@ export interface SearchMessagesCommandOutput extends SearchMessagesOutput, __Met
 }
 declare const SearchMessagesCommand_base: {
     new (input: SearchMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<SearchMessagesCommandInput, SearchMessagesCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
-    new (__0_0: SearchMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<SearchMessagesCommandInput, SearchMessagesCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (...[input]: [] | [SearchMessagesCommandInput]): import("@smithy/smithy-client").CommandImpl<SearchMessagesCommandInput, SearchMessagesCommandOutput, StreamServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
@@ -37,8 +37,15 @@ declare const SearchMessagesCommand_base: {
  * const input = { // SearchMessagesInput
  *   companyId: "STRING_VALUE",
  *   userId: "STRING_VALUE",
- *   q: "STRING_VALUE", // required
+ *   q: "STRING_VALUE",
  *   channelId: "STRING_VALUE",
+ *   hasAttachments: true || false,
+ *   attachmentTypes: [ // AttachmentTypeList
+ *     "image" || "video" || "audio" || "file",
+ *   ],
+ *   mimeTypes: [ // MimeTypeList
+ *     "STRING_VALUE",
+ *   ],
  *   size: Number("int"),
  *   cursor: "STRING_VALUE",
  *   sort: "relevance" || "recency" || "recency_asc",

package/dist-types/commands/UpdateChannelCommand.d.ts

@@ -96,6 +96,7 @@ declare const UpdateChannelCommand_base: {
  * //       userId: "STRING_VALUE", // required
  * //       messageType: "regular" || "system" || "deleted", // required
  * //       text: "STRING_VALUE",
+ * //       event: "STRING_VALUE",
  * //       createdAt: "STRING_VALUE", // required
  * //     },
  * //     company: "STRING_VALUE",

package/dist-types/models/models_0.d.ts

@@ -441,6 +441,20 @@ export interface AssignChannelOutput {
     assigneeId?: string | undefined;
     serviceUri?: string | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const AttachmentType: {
+    readonly AUDIO: "audio";
+    readonly FILE: "file";
+    readonly IMAGE: "image";
+    readonly VIDEO: "video";
+};
+/**
+ * @public
+ */
+export type AttachmentType = typeof AttachmentType[keyof typeof AttachmentType];
 /**
  * @public
  * @enum
@@ -562,6 +576,11 @@ export interface LastMessagePreview {
      * @public
      */
     text?: string | undefined;
+    /**
+     * System event identifier for client rendering.
+     * @public
+     */
+    event?: string | undefined;
     /**
      * Creation timestamp of the message.
      * @public
@@ -3347,6 +3366,19 @@ export interface SearchChannelHit {
      */
     highlights?: (string)[] | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const SearchSort: {
+    readonly RECENCY: "recency";
+    readonly RECENCY_ASC: "recency_asc";
+    readonly RELEVANCE: "relevance";
+};
+/**
+ * @public
+ */
+export type SearchSort = typeof SearchSort[keyof typeof SearchSort];
 /**
  * @public
  */
@@ -3362,10 +3394,20 @@ export interface SearchChannelsInput {
      */
     userId?: string | undefined;
     /**
-     * Search text.
+     * Search text. Optional when `memberId` is provided (then lists shared channels).
      * @public
      */
-    q: string;
+    q?: string | undefined;
+    /**
+     * Restrict to channels that also contain this member. Combined with the caller, returns channels both users belong to.
+     * @public
+     */
+    memberId?: string | undefined;
+    /**
+     * Restrict results to this channel type.
+     * @public
+     */
+    channelType?: ChannelType | undefined;
     /**
      * Page size. Default 20, max 50.
      * @public
@@ -3376,6 +3418,11 @@ export interface SearchChannelsInput {
      * @public
      */
     cursor?: string | undefined;
+    /**
+     * Result ordering. `relevance` (default with `q`) or `recency` (newest activity first, default without `q`).
+     * @public
+     */
+    sort?: SearchSort | undefined;
 }
 /**
  * @public
@@ -3408,19 +3455,6 @@ export interface SearchMessageHit {
      */
     highlights?: (string)[] | undefined;
 }
-/**
- * @public
- * @enum
- */
-export declare const SearchSort: {
-    readonly RECENCY: "recency";
-    readonly RECENCY_ASC: "recency_asc";
-    readonly RELEVANCE: "relevance";
-};
-/**
- * @public
- */
-export type SearchSort = typeof SearchSort[keyof typeof SearchSort];
 /**
  * @public
  */
@@ -3436,15 +3470,30 @@ export interface SearchMessagesInput {
      */
     userId?: string | undefined;
     /**
-     * Search text.
+     * Search text. Optional when an attachment filter (`hasAttachments`/`attachmentTypes`/`mimeTypes`) is provided.
      * @public
      */
-    q: string;
+    q?: string | undefined;
     /**
      * When set, restricts the search to this channel (in-channel search).
      * @public
      */
     channelId?: string | undefined;
+    /**
+     * When true, matches only messages that have at least one attachment.
+     * @public
+     */
+    hasAttachments?: boolean | undefined;
+    /**
+     * Restrict to attachments of these coarse categories. `file` means any non-image/video/audio attachment.
+     * @public
+     */
+    attachmentTypes?: (AttachmentType)[] | undefined;
+    /**
+     * Restrict to attachments whose MIME type is one of these exact values.
+     * @public
+     */
+    mimeTypes?: (string)[] | undefined;
     /**
      * Page size. Default 20, max 50.
      * @public

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@wildix/stream-client",
     "description": "@wildix/stream-client client",
-    "version": "0.0.13",
+    "version": "0.0.15",
     "scripts": {
         "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
         "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -80,4 +80,4 @@
     "react-native": {
         "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.native"
     }
-}
+}