From 09d89f88d5aff8d402ceedd8035934fcec2b7e74 Mon Sep 17 00:00:00 2001 From: Zita Szupera Date: Wed, 4 Dec 2024 13:49:50 +0100 Subject: [PATCH] chore: make JavaScript links internal --- copy-generated-component-docs.ts | 3 ++ copy-generated-service-docs.ts | 2 + .../src/lib/attachment.service.ts | 2 +- .../channel-header.component.ts | 2 +- .../src/lib/channel-query.ts | 2 +- .../src/lib/channel.service.ts | 44 +++++++++---------- .../src/lib/channel/channel.component.ts | 2 +- .../src/lib/chat-client.service.ts | 14 +++--- .../src/lib/custom-templates.service.ts | 2 +- .../message-actions-box.component.ts | 2 +- .../message-input-config.service.ts | 2 +- .../message-input/message-input.component.ts | 6 +-- .../message-list/message-list.component.ts | 2 +- .../message-reactions-selector.component.ts | 2 +- .../src/lib/message-reactions.service.ts | 8 ++-- .../message-reactions.component.ts | 4 +- .../src/lib/message.service.ts | 2 +- .../src/lib/message/message.component.ts | 4 +- .../src/lib/thread/thread.component.ts | 2 +- projects/stream-chat-angular/src/lib/types.ts | 2 +- 20 files changed, 57 insertions(+), 52 deletions(-) diff --git a/copy-generated-component-docs.ts b/copy-generated-component-docs.ts index b6c537ce..0b6f8e37 100644 --- a/copy-generated-component-docs.ts +++ b/copy-generated-component-docs.ts @@ -32,6 +32,9 @@ const insertGeneratedParts = ( fileContent: string, generatedContent: string[] ) => { + generatedContent = generatedContent.map((l) => + l.replace(/•\s/g, '').replace(/▸\s/g, '') + ); const lines: string[] = fileContent.split('\n'); const startOfGeneratedContentLineNumber = lines.indexOf( startOfGeneratedContentMark diff --git a/copy-generated-service-docs.ts b/copy-generated-service-docs.ts index 51154d34..f4006499 100644 --- a/copy-generated-service-docs.ts +++ b/copy-generated-service-docs.ts @@ -46,6 +46,8 @@ fs.readdir(sourcePath, (err: any, files: string[]) => { /\b(?!README)(\w+)\.md\b/g, '/chat/docs/sdk/angular/services/$1' ) + .replace(/•\s/g, '') + .replace(/▸\s/g, '') .replace('', '') .replace('\\', ''); diff --git a/projects/stream-chat-angular/src/lib/attachment.service.ts b/projects/stream-chat-angular/src/lib/attachment.service.ts index 98d7f2ec..a4ce4e6a 100644 --- a/projects/stream-chat-angular/src/lib/attachment.service.ts +++ b/projects/stream-chat-angular/src/lib/attachment.service.ts @@ -23,7 +23,7 @@ import { MessageService } from './message.service'; /** * The `AttachmentService` manages the uploads of a message input. * - * You can read more about [uploads](https://getstream.io/chat/docs/javascript/file_uploads/?language=javascript&q=size) in the Stream API documentation. You can use Stream's API or the dashboard to customize the [file](https://getstream.io/chat/docs/javascript/app_setting_overview/?language=javascript&q=size#file-uploads) and [image upload](https://getstream.io/chat/docs/javascript/app_setting_overview/?language=javascript&q=size#image-uploads) configuration. + * You can read more about [uploads](/chat/docs/javascript/file_uploads/) in the Stream API documentation. You can use Stream's API or the dashboard to customize the [file](/chat/docs/javascript/app_setting_overview/#file-uploads) and [image upload](/chat/docs/javascript/app_setting_overview/#image-uploads) configuration. */ @Injectable({ providedIn: 'root', diff --git a/projects/stream-chat-angular/src/lib/channel-header/channel-header.component.ts b/projects/stream-chat-angular/src/lib/channel-header/channel-header.component.ts index 5dbccb45..6c2540c5 100644 --- a/projects/stream-chat-angular/src/lib/channel-header/channel-header.component.ts +++ b/projects/stream-chat-angular/src/lib/channel-header/channel-header.component.ts @@ -18,7 +18,7 @@ import { } from '../types'; /** - * The `ChannelHeader` component displays the avatar and name of the currently active channel along with member and watcher information. You can read about [the difference between members and watchers](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript#watchers-vs-members) in the platform documentation. Please note that number of watchers is only displayed if the user has [`connect-events` capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) + * The `ChannelHeader` component displays the avatar and name of the currently active channel along with member and watcher information. You can read about [the difference between members and watchers](/chat/docs/javascript/watch_channel/#watchers-vs-members) in the platform documentation. Please note that number of watchers is only displayed if the user has [`connect-events` capability](/chat/docs/javascript/channel_capabilities/) */ @Component({ selector: 'stream-channel-header', diff --git a/projects/stream-chat-angular/src/lib/channel-query.ts b/projects/stream-chat-angular/src/lib/channel-query.ts index 5a25e694..382e31c5 100644 --- a/projects/stream-chat-angular/src/lib/channel-query.ts +++ b/projects/stream-chat-angular/src/lib/channel-query.ts @@ -24,7 +24,7 @@ export class ChannelQuery< * * The method will be called with the result of the latest channel query. * - * You can return either an offset, or a filter using the [`$lte`/`$gte` operator](https://getstream.io/chat/docs/javascript/query_syntax_operators/). If you return a filter, it will be merged with the filter provided for the `init` method. + * You can return either an offset, or a filter using the [`$lte`/`$gte` operator](/chat/docs/javascript/query_syntax_operators/). If you return a filter, it will be merged with the filter provided for the `init` method. */ customPaginator?: (channelQueryResult: Channel[]) => NextPageConfiguration; private nextPageConfiguration?: NextPageConfiguration; diff --git a/projects/stream-chat-angular/src/lib/channel.service.ts b/projects/stream-chat-angular/src/lib/channel.service.ts index 2b7cf181..723e8664 100644 --- a/projects/stream-chat-angular/src/lib/channel.service.ts +++ b/projects/stream-chat-angular/src/lib/channel.service.ts @@ -57,7 +57,7 @@ export class ChannelService< */ hasMoreChannels$: Observable; /** - * Emits the currently loaded and [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel list. + * Emits the currently loaded and [watched](/chat/docs/javascript/watch_channel/) channel list. * * :::important * If you want to subscribe to channel events, you need to manually reenter Angular's change detection zone, our [Change detection guide](/chat/docs/sdk/angular/concepts/change-detection/) explains this in detail. @@ -119,7 +119,7 @@ export class ChannelService< */ latestMessageDateByUserByChannels$: Observable<{ [key: string]: Date }>; /** - * If you're using [semantic filters for moderation](https://getstream.io/automated-moderation/docs/automod_configuration/?q=semantic%20filters) you can set up rules for bouncing messages. + * If you're using [semantic filters for moderation](/moderation/docs/) you can set up rules for bouncing messages. * * If a message is bounced, it will be emitted via this `Observable`. The built-in [`MessageBouncePrompt` component](/chat/docs/sdk/angular/components/MessageBouncePromptComponent/) will display the bounce option to the user if a bounced message is clicked. */ @@ -139,7 +139,7 @@ export class ChannelService< /** * Custom event handler to call if a new message received from a channel that is not being watched, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/) * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customNewMessageNotificationHandler?: ( clientEvent: ClientEvent, @@ -151,7 +151,7 @@ export class ChannelService< /** * Custom event handler to call when the user is added to a channel, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/). * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customAddedToChannelNotificationHandler?: ( clientEvent: ClientEvent, @@ -163,7 +163,7 @@ export class ChannelService< /** * Custom event handler to call when the user is removed from a channel, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/). * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customRemovedFromChannelNotificationHandler?: ( clientEvent: ClientEvent, @@ -175,7 +175,7 @@ export class ChannelService< /** * Custom event handler to call when a channel is deleted, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/). * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customChannelDeletedHandler?: ( event: Event, @@ -191,7 +191,7 @@ export class ChannelService< /** * Custom event handler to call when a channel is updated, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/). * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customChannelUpdatedHandler?: ( event: Event, @@ -207,7 +207,7 @@ export class ChannelService< /** * Custom event handler to call when a channel is truncated, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/). * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customChannelTruncatedHandler?: ( event: Event, @@ -223,7 +223,7 @@ export class ChannelService< /** * Custom event handler to call when a channel becomes hidden, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/). * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customChannelHiddenHandler?: ( event: Event, @@ -239,7 +239,7 @@ export class ChannelService< /** * Custom event handler to call when a channel becomes visible, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/). * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customChannelVisibleHandler?: ( event: Event, @@ -255,7 +255,7 @@ export class ChannelService< /** * Custom event handler to call if a new message received from a channel that is being watched, provide an event handler if you want to override the [default channel list ordering](/chat/docs/sdk/angular/services/ChannelService/#channels/). * - * If you're adding a new channel, make sure that it's a [watched](https://getstream.io/chat/docs/javascript/watch_channel/?language=javascript) channel. + * If you're adding a new channel, make sure that it's a [watched](/chat/docs/javascript/watch_channel/) channel. */ customNewMessageHandler?: ( event: Event, @@ -542,7 +542,7 @@ export class ChannelService< * * The method will be called with the result of the latest channel query. * - * You can return either an offset, or a filter using the [`$lte`/`$gte` operator](https://getstream.io/chat/docs/javascript/query_syntax_operators/). If you return a filter, it will be merged with the filter provided for the `init` method. + * You can return either an offset, or a filter using the [`$lte`/`$gte` operator](/chat/docs/javascript/query_syntax_operators/). If you return a filter, it will be merged with the filter provided for the `init` method. */ set customPaginator( paginator: @@ -652,7 +652,7 @@ export class ChannelService< } /** - * Loads the next page of messages of the active channel. The page size can be set in the [query option](https://getstream.io/chat/docs/javascript/query_channels/?language=javascript#query-options) object. + * Loads the next page of messages of the active channel. The page size can be set in the [query option](/chat/docs/javascript/query_channels/#query-options) object. * @param direction */ loadMoreMessages(direction: 'older' | 'newer' = 'older') { @@ -691,7 +691,7 @@ export class ChannelService< } /** - * Loads the next page of messages of the active thread. The page size can be set in the [query option](https://getstream.io/chat/docs/javascript/query_channels/?language=javascript#query-options) object. + * Loads the next page of messages of the active thread. The page size can be set in the [query option](/chat/docs/javascript/query_channels/#query-options) object. * @param direction */ loadMoreThreadReplies(direction: 'older' | 'newer' = 'older') { @@ -720,7 +720,7 @@ export class ChannelService< } /** - * Queries the channels with the given filters, sorts and options. More info about [channel querying](https://getstream.io/chat/docs/javascript/query_channels/?language=javascript) can be found in the platform documentation. By default the first channel in the list will be set as active channel and will be marked as read. + * Queries the channels with the given filters, sorts and options. More info about [channel querying](/chat/docs/javascript/query_channels/) can be found in the platform documentation. By default the first channel in the list will be set as active channel and will be marked as read. * @param filters * @param sort * @param options @@ -756,7 +756,7 @@ export class ChannelService< } /** - * Queries the channels with the given query function. More info about [channel querying](https://getstream.io/chat/docs/javascript/query_channels/?language=javascript) can be found in the platform documentation. + * Queries the channels with the given query function. More info about [channel querying](/chat/docs/javascript/query_channels/) can be found in the platform documentation. * @param query * @param options * @param options.shouldSetActiveChannel The `shouldSetActiveChannel` specifies if the first channel in the result should be selected as the active channel or not. Default is `true`. @@ -791,7 +791,7 @@ export class ChannelService< } /** - * Loads the next page of channels. The page size can be set in the [query option](https://getstream.io/chat/docs/javascript/query_channels/?language=javascript#query-options) object. + * Loads the next page of channels. The page size can be set in the [query option](/chat/docs/javascript/query_channels/#query-options) object. */ async loadMoreChannels() { await this.queryChannels(false, 'next-page'); @@ -960,7 +960,7 @@ export class ChannelService< } /** - * Uploads files to the channel. If you want to know more about [file uploads](https://getstream.io/chat/docs/javascript/file_uploads/?language=javascript) check out the platform documentation. + * Uploads files to the channel. If you want to know more about [file uploads](/chat/docs/javascript/file_uploads/) check out the platform documentation. * @param uploads the attachments to upload (output of the [`AttachmentService`](/chat/docs/sdk/angular/services/AttachmentService/)) * @returns the result of file upload requests */ @@ -1041,7 +1041,7 @@ export class ChannelService< } /** - * Deletes an uploaded file by URL. If you want to know more about [file uploads](https://getstream.io/chat/docs/javascript/file_uploads/?language=javascript) check out the platform documentation + * Deletes an uploaded file by URL. If you want to know more about [file uploads](/chat/docs/javascript/file_uploads/) check out the platform documentation * @param attachmentUpload Attachment to be deleted (output of the [`AttachmentService`](/chat/docs/sdk/angular/services/AttachmentService/)) */ async deleteAttachment(attachmentUpload: AttachmentUpload) { @@ -1056,7 +1056,7 @@ export class ChannelService< } /** - * Returns the autocomplete options for current channel members. If the channel has less than 100 members, it returns the channel members, otherwise sends a [search request](https://getstream.io/chat/docs/javascript/query_members/?language=javascript#pagination-and-ordering) with the given search term. + * Returns the autocomplete options for current channel members. If the channel has less than 100 members, it returns the channel members, otherwise sends a [search request](/chat/docs/javascript/query_members/#pagination-and-ordering) with the given search term. * @param searchTerm Text to search for in the names of members * @returns The list of members matching the search filter */ @@ -1642,8 +1642,8 @@ export class ChannelService< } /** - * Get the last 1200 reactions of a message in the current active channel. If you need to fetch more reactions please use the [following endpoint](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript#paginating-reactions). - * @deprecated use [`messageReactionsService.queryReactions()`](https://getstream.io/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions) instead + * Get the last 1200 reactions of a message in the current active channel. If you need to fetch more reactions please use the [following endpoint](/chat/docs/javascript/send_reaction/#paginating-reactions). + * @deprecated use [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions) instead * @param messageId * @returns all reactions of a message */ diff --git a/projects/stream-chat-angular/src/lib/channel/channel.component.ts b/projects/stream-chat-angular/src/lib/channel/channel.component.ts index 2a266846..cb7a6f94 100644 --- a/projects/stream-chat-angular/src/lib/channel/channel.component.ts +++ b/projects/stream-chat-angular/src/lib/channel/channel.component.ts @@ -6,7 +6,7 @@ import { ThemeService } from '../theme.service'; import { CustomTemplatesService } from '../custom-templates.service'; /** - * The `Channel` component is a container component that displays the [`ChannelHeader`](/chat/docs/sdk/angular/components/ChannelHeaderComponent/), [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent), [`NotificationList`](/chat/docs/sdk/angular/components/NotificationListComponent/) and [`MessageInput`](/chat/docs/sdk/angular/components/MessageInputComponent/) components. You can also provide the [`Thread`](/chat/docs/sdk/angular/components/ThreadComponent/) component to use message [threads](https://getstream.io/chat/docs/javascript/threads/?language=javascript). + * The `Channel` component is a container component that displays the [`ChannelHeader`](/chat/docs/sdk/angular/components/ChannelHeaderComponent/), [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent), [`NotificationList`](/chat/docs/sdk/angular/components/NotificationListComponent/) and [`MessageInput`](/chat/docs/sdk/angular/components/MessageInputComponent/) components. You can also provide the [`Thread`](/chat/docs/sdk/angular/components/ThreadComponent/) component to use message [threads](/chat/docs/javascript/threads/). */ @Component({ selector: 'stream-channel', diff --git a/projects/stream-chat-angular/src/lib/chat-client.service.ts b/projects/stream-chat-angular/src/lib/chat-client.service.ts index d9d62f61..ac3cf6a4 100644 --- a/projects/stream-chat-angular/src/lib/chat-client.service.ts +++ b/projects/stream-chat-angular/src/lib/chat-client.service.ts @@ -37,14 +37,14 @@ export class ChatClientService< */ chatClient!: StreamChat; /** - * Emits [`ClientEvent`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/chat-client.service.ts) events. The platform documentation covers [the list of client, user presence and notification events](https://getstream.io/chat/docs/javascript/event_object/?language=javascript). + * Emits [`ClientEvent`](https://github.com/GetStream/stream-chat-angular/blob/master/projects/stream-chat-angular/src/lib/chat-client.service.ts) events. The platform documentation covers [the list of client, user presence and notification events](/chat/docs/javascript/event_object/). * :::important * For performance reasons this Observable operates outside of the Angular change detection zone. If you subscribe to it, you need to manually reenter Angular's change detection zone, our [Change detection guide](/chat/docs/sdk/angular/concepts/change-detection/) explains this in detail. * ::: */ events$: Observable>; /** - * Emits the current [application settings](https://getstream.io/chat/docs/javascript/app_setting_overview/?language=javascript). Since getting the application settings is an expensive API call and we don't always need the result, this is not initialized by default, you need to call `getApplicationSettings` to load them. + * Emits the current [application settings](/chat/docs/javascript/app_setting_overview/). Since getting the application settings is an expensive API call and we don't always need the result, this is not initialized by default, you need to call `getApplicationSettings` to load them. */ appSettings$: Observable; /** @@ -84,14 +84,14 @@ export class ChatClientService< } /** - * Creates a [`StreamChat`](https://github.com/GetStream/stream-chat-js/blob/668b3e5521339f4e14fc657834531b4c8bf8176b/src/client.ts#L124) instance using the provided `apiKey`, and connects a user with the given meta data and token. More info about [connecting users](https://getstream.io/chat/docs/javascript/init_and_users/?language=javascript) can be found in the platform documentation. + * Creates a [`StreamChat`](https://github.com/GetStream/stream-chat-js/blob/668b3e5521339f4e14fc657834531b4c8bf8176b/src/client.ts#L124) instance using the provided `apiKey`, and connects a user with the given meta data and token. More info about [connecting users](/chat/docs/javascript/init_and_users/) can be found in the platform documentation. * @param apiKey * @param userOrId you can emit this for anonymous logins * @param userTokenOrProvider You can provide:
    *
  • a token,
  • *
  • a token provider, a method that returns `Promise`, which can be called when the previous token expires (recommended setup for production applications)
  • - *
  • the keyword 'guest' to connect as [guest user](https://getstream.io/chat/docs/javascript/authless_users/?language=javascript#guest-users)
  • - *
  • the keyword 'anonymous' to connect as [anonymous user](https://getstream.io/chat/docs/javascript/authless_users/?language=javascript#anonymous-users)
  • + *
  • the keyword 'guest' to connect as [guest user](/chat/docs/javascript/authless_users/#guest-users)
  • + *
  • the keyword 'anonymous' to connect as [anonymous user](/chat/docs/javascript/authless_users/#anonymous-users)
  • *
* @param clientOptions Setting to provide to the Stream client instance */ @@ -193,7 +193,7 @@ export class ChatClientService< } /** - * Loads the current [application settings](https://getstream.io/chat/docs/javascript/app_setting_overview/?language=javascript), if the application settings have already been loaded, it does nothing. + * Loads the current [application settings](/chat/docs/javascript/app_setting_overview/), if the application settings have already been loaded, it does nothing. */ async getAppSettings() { if (this.appSettingsPromise) { @@ -211,7 +211,7 @@ export class ChatClientService< } /** - * Flag the message with the given ID. If you want to know [more about flags](https://getstream.io/chat/docs/javascript/moderation/?language=javascript) check out the platform documentation. + * Flag the message with the given ID. If you want to know [more about flags](/chat/docs/javascript/moderation/) check out the platform documentation. * @param messageId */ async flagMessage(messageId: string) { diff --git a/projects/stream-chat-angular/src/lib/custom-templates.service.ts b/projects/stream-chat-angular/src/lib/custom-templates.service.ts index 64af6e67..b71e024d 100644 --- a/projects/stream-chat-angular/src/lib/custom-templates.service.ts +++ b/projects/stream-chat-angular/src/lib/custom-templates.service.ts @@ -280,7 +280,7 @@ export class CustomTemplatesService< TemplateRef | undefined >(undefined); /** - * The template used to display [system messages](https://getstream.io/chat/docs/javascript/silent_messages/?language=javascript&q=system) indise the [message component](/chat/docs/sdk/angular/components/MessageComponent/) + * The template used to display [system messages](/chat/docs/javascript/silent_messages/) indise the [message component](/chat/docs/sdk/angular/components/MessageComponent/) */ systemMessageTemplate$ = new BehaviorSubject< TemplateRef | undefined diff --git a/projects/stream-chat-angular/src/lib/message-actions-box/message-actions-box.component.ts b/projects/stream-chat-angular/src/lib/message-actions-box/message-actions-box.component.ts index bc3dd31e..3006b79a 100644 --- a/projects/stream-chat-angular/src/lib/message-actions-box/message-actions-box.component.ts +++ b/projects/stream-chat-angular/src/lib/message-actions-box/message-actions-box.component.ts @@ -44,7 +44,7 @@ export class MessageActionsBoxComponent */ @Input() messageTextHtmlElement: HTMLElement | undefined; /** - * The list of [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) that are enabled for the current user, the list of [supported interactions](/chat/docs/sdk/angular/concepts/message-interactions) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI. + * The list of [channel capabilities](/chat/docs/javascript/channel_capabilities/) that are enabled for the current user, the list of [supported interactions](/chat/docs/sdk/angular/concepts/message-interactions) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI. */ @Input() enabledActions: string[] = []; messageActionItemTemplate: diff --git a/projects/stream-chat-angular/src/lib/message-input/message-input-config.service.ts b/projects/stream-chat-angular/src/lib/message-input/message-input-config.service.ts index 76c7c963..1d1734d6 100644 --- a/projects/stream-chat-angular/src/lib/message-input/message-input-config.service.ts +++ b/projects/stream-chat-angular/src/lib/message-input/message-input-config.service.ts @@ -11,7 +11,7 @@ import { CustomAutocomplete } from '../types'; }) export class MessageInputConfigService { /** - * If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript). + * If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](/chat/docs/javascript/channel_capabilities/). */ isFileUploadEnabled: boolean | undefined = true; /** diff --git a/projects/stream-chat-angular/src/lib/message-input/message-input.component.ts b/projects/stream-chat-angular/src/lib/message-input/message-input.component.ts index ec111f52..f248720e 100644 --- a/projects/stream-chat-angular/src/lib/message-input/message-input.component.ts +++ b/projects/stream-chat-angular/src/lib/message-input/message-input.component.ts @@ -47,7 +47,7 @@ import { VoiceRecorderService } from './voice-recorder.service'; import { AudioRecorderService } from '../voice-recorder/audio-recorder.service'; /** - * The `MessageInput` component displays an input where users can type their messages and upload files, and sends the message to the active channel. The component can be used to compose new messages or update existing ones. To send messages, the chat user needs to have the necessary [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript). + * The `MessageInput` component displays an input where users can type their messages and upload files, and sends the message to the active channel. The component can be used to compose new messages or update existing ones. To send messages, the chat user needs to have the necessary [channel capability](/chat/docs/javascript/channel_capabilities/). */ @Component({ selector: 'stream-message-input', @@ -59,7 +59,7 @@ export class MessageInputComponent implements OnInit, OnChanges, OnDestroy, AfterViewInit { /** - * If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript). If no value is provided, it is set from the [`MessageInputConfigService`](/chat/docs/sdk/angular/services/MessageInputConfigService/). + * If file upload is enabled, the user can open a file selector from the input. Please note that the user also needs to have the necessary [channel capability](/chat/docs/javascript/channel_capabilities/). If no value is provided, it is set from the [`MessageInputConfigService`](/chat/docs/sdk/angular/services/MessageInputConfigService/). */ @Input() isFileUploadEnabled: boolean | undefined; /** @@ -71,7 +71,7 @@ export class MessageInputComponent */ @Input() mentionScope: 'channel' | 'application' | undefined; /** - * Determines if the message is being dispalyed in a channel or in a [thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript). + * Determines if the message is being dispalyed in a channel or in a [thread](/chat/docs/javascript/threads/). */ @Input() mode: 'thread' | 'main' = 'main'; /** diff --git a/projects/stream-chat-angular/src/lib/message-list/message-list.component.ts b/projects/stream-chat-angular/src/lib/message-list/message-list.component.ts index 53e9dbf7..3ca00963 100644 --- a/projects/stream-chat-angular/src/lib/message-list/message-list.component.ts +++ b/projects/stream-chat-angular/src/lib/message-list/message-list.component.ts @@ -58,7 +58,7 @@ export class MessageListComponent implements AfterViewChecked, OnChanges, OnInit, OnDestroy, AfterViewInit { /** - * Determines if the message list should display channel messages or [thread messages](https://getstream.io/chat/docs/javascript/threads/?language=javascript). + * Determines if the message list should display channel messages or [thread messages](/chat/docs/javascript/threads/). */ @Input() mode: 'main' | 'thread' = 'main'; /** diff --git a/projects/stream-chat-angular/src/lib/message-reactions-selector/message-reactions-selector.component.ts b/projects/stream-chat-angular/src/lib/message-reactions-selector/message-reactions-selector.component.ts index d607d407..3cecf3fb 100644 --- a/projects/stream-chat-angular/src/lib/message-reactions-selector/message-reactions-selector.component.ts +++ b/projects/stream-chat-angular/src/lib/message-reactions-selector/message-reactions-selector.component.ts @@ -13,7 +13,7 @@ import { MessageReactionsService } from '../message-reactions.service'; import { Subscription } from 'rxjs'; /** - * The `MessageReactionsSelectorComponent` makes it possible for users to react to a message, the reaction options can be set using the [`MessageReactionsService`](/chat/docs/sdk/angular/services/MessageReactionsService/). You can read more about [message reactions](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript) in the platform documentation. + * The `MessageReactionsSelectorComponent` makes it possible for users to react to a message, the reaction options can be set using the [`MessageReactionsService`](/chat/docs/sdk/angular/services/MessageReactionsService/). You can read more about [message reactions](/chat/docs/javascript/send_reaction/) in the platform documentation. */ @Component({ selector: 'stream-message-reactions-selector', diff --git a/projects/stream-chat-angular/src/lib/message-reactions.service.ts b/projects/stream-chat-angular/src/lib/message-reactions.service.ts index 752d9df4..5fd4edf0 100644 --- a/projects/stream-chat-angular/src/lib/message-reactions.service.ts +++ b/projects/stream-chat-angular/src/lib/message-reactions.service.ts @@ -5,7 +5,7 @@ import { ChatClientService } from './chat-client.service'; import { NotificationService } from './notification.service'; /** - * The `MessageReactionsService` provides customization options to message [reactions](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript). + * The `MessageReactionsService` provides customization options to message [reactions](/chat/docs/javascript/send_reaction/). * */ @Injectable({ @@ -13,7 +13,7 @@ import { NotificationService } from './notification.service'; }) export class MessageReactionsService { /** - * The enabled [reactions](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript) and the associated emoji + * The enabled [reactions](/chat/docs/javascript/send_reaction/) and the associated emoji * * You can provide any string as a reaction. The emoji can be provided as a string, if you want to use custom images for reactions you have to provide a [custom reactions UI](/chat/docs/sdk/angular/services/CustomTemplatesService/#messagereactionstemplate/) */ @@ -27,7 +27,7 @@ export class MessageReactionsService { /** * By default the [`MessageReactionsComponent`](/chat/docs/sdk/angular/components/MessageReactionsComponent/) will display the reacting users when a reaction is clicked. You can override this with your own UI by providing a custom event handler. * - * The event handler can retrieve all reactions of a message using the [`messageReactionsService.queryReactions()`](https://getstream.io/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions) + * The event handler can retrieve all reactions of a message using the [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions) */ customReactionClickHandler?: (details: MessageReactionClickDetails) => void; @@ -51,7 +51,7 @@ export class MessageReactionsService { } /** - * Query reactions of a specific message, more info in the [API documentation](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript#query-reactions) + * Query reactions of a specific message, more info in the [API documentation](/chat/docs/javascript/send_reaction/#query-reactions) * @param messageId * @param type * @param next diff --git a/projects/stream-chat-angular/src/lib/message-reactions/message-reactions.component.ts b/projects/stream-chat-angular/src/lib/message-reactions/message-reactions.component.ts index 73a5c1e2..6267e063 100644 --- a/projects/stream-chat-angular/src/lib/message-reactions/message-reactions.component.ts +++ b/projects/stream-chat-angular/src/lib/message-reactions/message-reactions.component.ts @@ -21,7 +21,7 @@ import { CustomTemplatesService } from '../custom-templates.service'; import { Subscription } from 'rxjs'; /** - * The `MessageReactions` component displays the reactions of a message. You can read more about [message reactions](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript) in the platform documentation. + * The `MessageReactions` component displays the reactions of a message. You can read more about [message reactions](/chat/docs/javascript/send_reaction/) in the platform documentation. */ @Component({ selector: 'stream-message-reactions', @@ -48,7 +48,7 @@ export class MessageReactionsComponent {}; /** * List of reactions of a [message](/chat/docs/sdk/angular/types/stream-message/), used to display the users of a reaction type. - * @deprecated you can fetch the reactions using [`messageReactionsService.queryReactions()`](https://getstream.io/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions) + * @deprecated you can fetch the reactions using [`messageReactionsService.queryReactions()`](/chat/docs/sdk/angular/services/MessageReactionsService/#queryreactions) */ @Input() latestReactions: ReactionResponse[] = []; /** diff --git a/projects/stream-chat-angular/src/lib/message.service.ts b/projects/stream-chat-angular/src/lib/message.service.ts index 9427f382..c0175d9d 100644 --- a/projects/stream-chat-angular/src/lib/message.service.ts +++ b/projects/stream-chat-angular/src/lib/message.service.ts @@ -15,7 +15,7 @@ export class MessageService< * Decides if the message content should be formatted as text or HTML * * If you display messages as text the following parts are still be displayed as HTML: - * - user mentions -> you can customize this with your own template using the [`customTemplatesService.mentionTemplate$`](https://getstream.io/chat/docs/sdk/angular/services/CustomTemplatesService/#mentiontemplate) + * - user mentions -> you can customize this with your own template using the [`customTemplatesService.mentionTemplate$`](/chat/docs/sdk/angular/services/CustomTemplatesService/#mentiontemplate) * - links -> you can customize this by providing you own [`customLinkRenderer`](#customlinkrenderer) method */ displayAs: 'text' | 'html' = 'text'; diff --git a/projects/stream-chat-angular/src/lib/message/message.component.ts b/projects/stream-chat-angular/src/lib/message/message.component.ts index 65015cc1..d2309b37 100644 --- a/projects/stream-chat-angular/src/lib/message/message.component.ts +++ b/projects/stream-chat-angular/src/lib/message/message.component.ts @@ -64,7 +64,7 @@ export class MessageComponent */ @Input() message: StreamMessage | undefined; /** - * The list of [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript) that are enabled for the current user, the list of [supported interactions](/chat/docs/sdk/angular/concepts/message-interactions/) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI. The [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent/) component automatically sets this based on [channel capabilities](https://getstream.io/chat/docs/javascript/channel_capabilities/?language=javascript). + * The list of [channel capabilities](/chat/docs/javascript/channel_capabilities/) that are enabled for the current user, the list of [supported interactions](/chat/docs/sdk/angular/concepts/message-interactions/) can be found in our message interaction guide. Unathorized actions won't be displayed on the UI. The [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent/) component automatically sets this based on [channel capabilities](/chat/docs/javascript/channel_capabilities/). */ @Input() enabledMessageActions: string[] = []; /** @@ -72,7 +72,7 @@ export class MessageComponent */ @Input() isLastSentMessage: boolean | undefined; /** - * Determines if the message is being dispalyed in a channel or in a [thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript). + * Determines if the message is being dispalyed in a channel or in a [thread](/chat/docs/javascript/threads/). */ @Input() mode: 'thread' | 'main' = 'main'; /** diff --git a/projects/stream-chat-angular/src/lib/thread/thread.component.ts b/projects/stream-chat-angular/src/lib/thread/thread.component.ts index c9f71564..c930186b 100644 --- a/projects/stream-chat-angular/src/lib/thread/thread.component.ts +++ b/projects/stream-chat-angular/src/lib/thread/thread.component.ts @@ -12,7 +12,7 @@ import { } from '../types'; /** - * The `Thread` component represents a [message thread](https://getstream.io/chat/docs/javascript/threads/?language=javascript), it is a container component that displays a thread with a header, [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent) and [`MessageInput`](/chat/docs/sdk/angular/components/MessageInputComponent/) components. + * The `Thread` component represents a [message thread](/chat/docs/javascript/threads/), it is a container component that displays a thread with a header, [`MessageList`](/chat/docs/sdk/angular/components/MessageListComponent) and [`MessageInput`](/chat/docs/sdk/angular/components/MessageInputComponent/) components. */ @Component({ selector: 'stream-thread', diff --git a/projects/stream-chat-angular/src/lib/types.ts b/projects/stream-chat-angular/src/lib/types.ts index 89ff5126..615b1099 100644 --- a/projects/stream-chat-angular/src/lib/types.ts +++ b/projects/stream-chat-angular/src/lib/types.ts @@ -319,7 +319,7 @@ export type MessageReactionsContext = { messageId: string | undefined; /** @deprecated use `messageReactionGroups` */ messageReactionCounts: { [key in MessageReactionType]?: number }; - /** @deprecated you can fetch the reactions using [`chatService.chatClient.queryReactions()`](https://getstream.io/chat/docs/javascript/send_reaction/?language=javascript&q=queryReactions#query-reactions) */ + /** @deprecated you can fetch the reactions using [`chatService.chatClient.queryReactions()`](/chat/docs/javascript/send_reaction/&q=queryReactions#query-reactions) */ latestReactions: ReactionResponse[]; ownReactions: ReactionResponse[]; messageReactionGroups: {