@stream-io/node-sdk 0.9.1 → 0.9.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/dist/index.cjs.js +173 -62
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.es.mjs +172 -61
- package/dist/index.es.mjs.map +1 -1
- package/dist/src/ApiClient.d.ts +1 -1
- package/dist/src/gen/chat/ChannelApi.d.ts +1 -0
- package/dist/src/gen/chat/ChatApi.d.ts +3 -1
- package/dist/src/gen/common/CommonApi.d.ts +4 -1
- package/dist/src/gen/feeds/FeedsApi.d.ts +1 -0
- package/dist/src/gen/models/index.d.ts +683 -17
- package/dist/src/gen/moderation/ModerationApi.d.ts +23 -1
- package/dist/src/utils/webhook.d.ts +15 -0
- package/index.ts +1 -0
- package/package.json +11 -11
- package/src/ApiClient.ts +5 -2
- package/src/gen/chat/ChannelApi.ts +1 -0
- package/src/gen/chat/ChatApi.ts +27 -0
- package/src/gen/common/CommonApi.ts +11 -2
- package/src/gen/feeds/FeedsApi.ts +2 -0
- package/src/gen/models/index.ts +772 -17
- package/src/gen/moderation/ModerationApi.ts +222 -0
- package/src/utils/webhook.ts +24 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { ApiClient, StreamResponse } from '../../gen-imports';
|
|
2
|
-
import { AnalyzeRequest, AnalyzeResponse, AppealRequest, AppealResponse, BanRequest, BulkActionAppealsRequest, BulkActionAppealsResponse, BulkDeleteActionConfigRequest, BulkDeleteActionConfigResponse, BulkImageModerationRequest, BulkImageModerationResponse, BulkUpsertActionConfigRequest, BulkUpsertActionConfigResponse, BypassRequest, BypassResponse, CheckRequest, CheckResponse, CheckS3AccessRequest, CheckS3AccessResponse, CreatePolicyTestSetRequest, CreateQueueRequest, CustomCheckRequest, CustomCheckResponse, DeleteActionConfigResponse, DeleteModerationConfigResponse, DeleteModerationRuleResponse, DeleteModerationTemplateResponse, DeleteQueueRequest, FlagItemResponse, FlagRequest, GetActionConfigResponse, GetAppealResponse, GetConfigResponse, GetFlagCountRequest, GetFlagCountResponse, GetModerationRuleResponse, GetReviewQueueItemResponse, GetSetupSessionResponse, InsertActionLogRequest, InsertActionLogResponse, LabelsRequest, LabelsResponse, ListQueuesResponse, ModerationBanResponse, MuteRequest, MuteResponse, PolicyTestRunResponse, PolicyTestSetListResponse, PolicyTestSetResponse, QueryAppealsRequest, QueryAppealsResponse, QueryFeedModerationTemplatesResponse, QueryLabelResultsRequest, QueryLabelResultsResponse, QueryModerationConfigsRequest, QueryModerationConfigsResponse, QueryModerationFeedbackRequest, QueryModerationFeedbackResponse, QueryModerationFlagsRequest, QueryModerationFlagsResponse, QueryModerationLogsRequest, QueryModerationLogsResponse, QueryModerationRulesRequest, QueryModerationRulesResponse, QueryReviewQueueRequest, QueryReviewQueueResponse, QueueResponse, Response, RevealMediaRequest, RevealMediaResponse, SubmitActionRequest, SubmitActionResponse, SubmitModerationFeedbackRequest, SubmitModerationFeedbackResponse, UnbanRequest, UnbanResponse, UnmuteRequest, UnmuteResponse, UpdateQueueRequest, UpsertActionConfigRequest, UpsertActionConfigResponse, UpsertConfigRequest, UpsertConfigResponse, UpsertModerationRuleRequest, UpsertModerationRuleResponse, UpsertModerationTemplateRequest, UpsertModerationTemplateResponse, UpsertSetupSessionRequest, UpsertSetupSessionResponse } from '../models';
|
|
2
|
+
import { AnalyzeRequest, AnalyzeResponse, AppealRequest, AppealResponse, BanRequest, BulkActionAppealsRequest, BulkActionAppealsResponse, BulkDeleteActionConfigRequest, BulkDeleteActionConfigResponse, BulkImageModerationRequest, BulkImageModerationResponse, BulkUpsertActionConfigRequest, BulkUpsertActionConfigResponse, BypassRequest, BypassResponse, CheckRequest, CheckResponse, CheckS3AccessRequest, CheckS3AccessResponse, CountReviewQueueRequest, CountReviewQueueResponse, CreatePolicyTestSetRequest, CreateQueueRequest, CustomCheckRequest, CustomCheckResponse, DeleteActionConfigResponse, DeleteModerationConfigResponse, DeleteModerationRuleResponse, DeleteModerationTemplateResponse, DeleteQueueRequest, FlagItemResponse, FlagRequest, GetActionConfigResponse, GetAgentReviewStatusResponse, GetAppealResponse, GetConfigResponse, GetConfigVersionResponse, GetFlagCountRequest, GetFlagCountResponse, GetModerationRuleResponse, GetReviewQueueItemResponse, GetSetupSessionResponse, InsertActionLogRequest, InsertActionLogResponse, LabelsRequest, LabelsResponse, ListAgentFeedbackResponse, ListConfigVersionsResponse, ListQueuesResponse, ModerationBanResponse, MuteRequest, MuteResponse, PolicyTestRunResponse, PolicyTestSetListResponse, PolicyTestSetResponse, PublishConfigVersionRequest, PublishConfigVersionResponse, QueryAppealsRequest, QueryAppealsResponse, QueryFeedModerationTemplatesResponse, QueryLabelResultsRequest, QueryLabelResultsResponse, QueryModerationConfigsRequest, QueryModerationConfigsResponse, QueryModerationFeedbackRequest, QueryModerationFeedbackResponse, QueryModerationFlagsRequest, QueryModerationFlagsResponse, QueryModerationLogsRequest, QueryModerationLogsResponse, QueryModerationRulesRequest, QueryModerationRulesResponse, QueryReviewQueueRequest, QueryReviewQueueResponse, QueueResponse, Response, RevealMediaRequest, RevealMediaResponse, SaveConfigVersionRequest, SaveConfigVersionResponse, SubmitActionRequest, SubmitActionResponse, SubmitAgentFeedbackRequest, SubmitAgentFeedbackResponse, SubmitModerationFeedbackRequest, SubmitModerationFeedbackResponse, UnbanRequest, UnbanResponse, UnmuteRequest, UnmuteResponse, UpdateQueueRequest, UpsertActionConfigRequest, UpsertActionConfigResponse, UpsertConfigRequest, UpsertConfigResponse, UpsertModerationRuleRequest, UpsertModerationRuleResponse, UpsertModerationTemplateRequest, UpsertModerationTemplateResponse, UpsertSetupSessionRequest, UpsertSetupSessionResponse } from '../models';
|
|
3
3
|
export declare class ModerationApi {
|
|
4
4
|
readonly apiClient: ApiClient;
|
|
5
5
|
constructor(apiClient: ApiClient);
|
|
@@ -18,6 +18,12 @@ export declare class ModerationApi {
|
|
|
18
18
|
user_id?: string;
|
|
19
19
|
}): Promise<StreamResponse<DeleteActionConfigResponse>>;
|
|
20
20
|
insertActionLog(request: InsertActionLogRequest): Promise<StreamResponse<InsertActionLogResponse>>;
|
|
21
|
+
listAgentFeedback(request?: {
|
|
22
|
+
limit?: number;
|
|
23
|
+
next?: string;
|
|
24
|
+
}): Promise<StreamResponse<ListAgentFeedbackResponse>>;
|
|
25
|
+
submitAgentFeedback(request: SubmitAgentFeedbackRequest): Promise<StreamResponse<SubmitAgentFeedbackResponse>>;
|
|
26
|
+
getAgentReviewStatus(): Promise<StreamResponse<GetAgentReviewStatusResponse>>;
|
|
21
27
|
analyze(request?: AnalyzeRequest): Promise<StreamResponse<AnalyzeResponse>>;
|
|
22
28
|
appeal(request: AppealRequest): Promise<StreamResponse<AppealResponse>>;
|
|
23
29
|
getAppeal(request: {
|
|
@@ -31,6 +37,7 @@ export declare class ModerationApi {
|
|
|
31
37
|
check(request: CheckRequest): Promise<StreamResponse<CheckResponse>>;
|
|
32
38
|
checkS3Access(request?: CheckS3AccessRequest): Promise<StreamResponse<CheckS3AccessResponse>>;
|
|
33
39
|
upsertConfig(request: UpsertConfigRequest): Promise<StreamResponse<UpsertConfigResponse>>;
|
|
40
|
+
saveConfigVersion(request: SaveConfigVersionRequest): Promise<StreamResponse<SaveConfigVersionResponse>>;
|
|
34
41
|
deleteConfig(request: {
|
|
35
42
|
key: string;
|
|
36
43
|
team?: string;
|
|
@@ -40,6 +47,19 @@ export declare class ModerationApi {
|
|
|
40
47
|
key: string;
|
|
41
48
|
team?: string;
|
|
42
49
|
}): Promise<StreamResponse<GetConfigResponse>>;
|
|
50
|
+
listConfigVersions(request: {
|
|
51
|
+
key: string;
|
|
52
|
+
team?: string;
|
|
53
|
+
}): Promise<StreamResponse<ListConfigVersionsResponse>>;
|
|
54
|
+
getConfigVersion(request: {
|
|
55
|
+
key: string;
|
|
56
|
+
version: number;
|
|
57
|
+
team?: string;
|
|
58
|
+
}): Promise<StreamResponse<GetConfigVersionResponse>>;
|
|
59
|
+
publishConfigVersion(request: PublishConfigVersionRequest & {
|
|
60
|
+
key: string;
|
|
61
|
+
version: number;
|
|
62
|
+
}): Promise<StreamResponse<PublishConfigVersionResponse>>;
|
|
43
63
|
queryModerationConfigs(request?: QueryModerationConfigsRequest): Promise<StreamResponse<QueryModerationConfigsResponse>>;
|
|
44
64
|
customCheck(request: CustomCheckRequest): Promise<StreamResponse<CustomCheckResponse>>;
|
|
45
65
|
queryModerationFeedback(request?: QueryModerationFeedbackRequest): Promise<StreamResponse<QueryModerationFeedbackResponse>>;
|
|
@@ -97,6 +117,7 @@ export declare class ModerationApi {
|
|
|
97
117
|
}): Promise<StreamResponse<QueueResponse>>;
|
|
98
118
|
revealMedia(request: RevealMediaRequest): Promise<StreamResponse<RevealMediaResponse>>;
|
|
99
119
|
queryReviewQueue(request?: QueryReviewQueueRequest): Promise<StreamResponse<QueryReviewQueueResponse>>;
|
|
120
|
+
countReviewQueue(request?: CountReviewQueueRequest): Promise<StreamResponse<CountReviewQueueResponse>>;
|
|
100
121
|
getReviewQueueItem(request: {
|
|
101
122
|
id: string;
|
|
102
123
|
}): Promise<StreamResponse<GetReviewQueueItemResponse>>;
|
|
@@ -108,6 +129,7 @@ export declare class ModerationApi {
|
|
|
108
129
|
target_user_id: string;
|
|
109
130
|
channel_cid?: string;
|
|
110
131
|
created_by?: string;
|
|
132
|
+
remove_future_channels_ban?: boolean;
|
|
111
133
|
}): Promise<StreamResponse<UnbanResponse>>;
|
|
112
134
|
unmute(request: UnmuteRequest): Promise<StreamResponse<UnmuteResponse>>;
|
|
113
135
|
}
|
|
@@ -25,6 +25,17 @@ export declare class InvalidWebhookError extends Error {
|
|
|
25
25
|
name: string;
|
|
26
26
|
constructor(message?: string);
|
|
27
27
|
}
|
|
28
|
+
/**
|
|
29
|
+
* Webhook helper settings.
|
|
30
|
+
*
|
|
31
|
+
* `maxPayloadBytes` caps the decompressed size of a gzip webhook body
|
|
32
|
+
* (default 10 MiB). {@link gunzipPayload} runs before the signature
|
|
33
|
+
* check, so without a cap an unsigned gzip bomb could exhaust memory.
|
|
34
|
+
* Raise it if your events are larger.
|
|
35
|
+
*/
|
|
36
|
+
export declare const webhookConfig: {
|
|
37
|
+
maxPayloadBytes: number;
|
|
38
|
+
};
|
|
28
39
|
/**
|
|
29
40
|
* Returns `body` as a `Buffer`, gzip-decompressed when its first two
|
|
30
41
|
* bytes match the gzip magic (`1f 8b`, per RFC 1952). When the body is
|
|
@@ -34,6 +45,10 @@ export declare class InvalidWebhookError extends Error {
|
|
|
34
45
|
* Magic-byte detection (rather than relying on a header) keeps the same
|
|
35
46
|
* handler correct when middleware - Express, Next.js, AWS Lambda -
|
|
36
47
|
* auto-decompresses the request before your code sees it.
|
|
48
|
+
*
|
|
49
|
+
* @throws {InvalidWebhookError} When the body has the gzip magic but is
|
|
50
|
+
* not valid gzip, or inflates to more than
|
|
51
|
+
* `webhookConfig.maxPayloadBytes`.
|
|
37
52
|
*/
|
|
38
53
|
export declare function gunzipPayload(rawBody: string | Buffer): Buffer;
|
|
39
54
|
/**
|
package/index.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stream-io/node-sdk",
|
|
3
|
-
"version": "0.9.
|
|
3
|
+
"version": "0.9.3",
|
|
4
4
|
"description": "",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": {
|
|
@@ -54,20 +54,20 @@
|
|
|
54
54
|
},
|
|
55
55
|
"devDependencies": {
|
|
56
56
|
"@eslint/js": "^10.0.1",
|
|
57
|
-
"@stream-io/openai-realtime-api": "~0.
|
|
58
|
-
"@types/node": "^22.20.
|
|
59
|
-
"dotenv": "^
|
|
60
|
-
"eslint": "^10.
|
|
57
|
+
"@stream-io/openai-realtime-api": "~0.4.2",
|
|
58
|
+
"@types/node": "^22.20.5",
|
|
59
|
+
"dotenv": "^18.0.10",
|
|
60
|
+
"eslint": "^10.14.0",
|
|
61
61
|
"eslint-config-prettier": "^10.1.8",
|
|
62
62
|
"eslint-plugin-unused-imports": "^4.4.1",
|
|
63
63
|
"husky": "^9.1.7",
|
|
64
|
-
"lint-staged": "^17.
|
|
65
|
-
"prettier": "^3.9.
|
|
64
|
+
"lint-staged": "^17.6.0",
|
|
65
|
+
"prettier": "^3.9.10",
|
|
66
66
|
"typescript": "~6.0.3",
|
|
67
|
-
"typescript-eslint": "^8.
|
|
68
|
-
"undici": "^7.30.
|
|
69
|
-
"vite": "^8.
|
|
70
|
-
"vitest": "~
|
|
67
|
+
"typescript-eslint": "^8.72.2",
|
|
68
|
+
"undici": "^7.30.2",
|
|
69
|
+
"vite": "^8.3.8",
|
|
70
|
+
"vitest": "~5.1.0"
|
|
71
71
|
},
|
|
72
72
|
"dependencies": {
|
|
73
73
|
"@types/jsonwebtoken": "^9.0.10",
|
package/src/ApiClient.ts
CHANGED
|
@@ -18,7 +18,7 @@ export class ApiClient {
|
|
|
18
18
|
sendRequest = async <T>(
|
|
19
19
|
method: string,
|
|
20
20
|
url: string,
|
|
21
|
-
pathParams?: Record<string, string>,
|
|
21
|
+
pathParams?: Record<string, string | number>,
|
|
22
22
|
queryParams?: Record<string, any>,
|
|
23
23
|
body?: any,
|
|
24
24
|
requestContentType?: string,
|
|
@@ -28,7 +28,10 @@ export class ApiClient {
|
|
|
28
28
|
const encodedParams = this.queryParamsStringify(queryParams);
|
|
29
29
|
if (pathParams) {
|
|
30
30
|
Object.keys(pathParams).forEach((paramName) => {
|
|
31
|
-
url = url.replace(
|
|
31
|
+
url = url.replace(
|
|
32
|
+
`{${paramName}}`,
|
|
33
|
+
encodeURIComponent(pathParams[paramName]),
|
|
34
|
+
);
|
|
32
35
|
});
|
|
33
36
|
}
|
|
34
37
|
|
package/src/gen/chat/ChatApi.ts
CHANGED
|
@@ -110,6 +110,8 @@ import {
|
|
|
110
110
|
Response,
|
|
111
111
|
RewindChannelRequest,
|
|
112
112
|
RewindChannelResponse,
|
|
113
|
+
SearchAllRequest,
|
|
114
|
+
SearchAllResponse,
|
|
113
115
|
SearchPayload,
|
|
114
116
|
SearchResponse,
|
|
115
117
|
SendEventRequest,
|
|
@@ -607,6 +609,7 @@ export class ChatApi {
|
|
|
607
609
|
messages_id_gt?: string;
|
|
608
610
|
messages_id_gte?: string;
|
|
609
611
|
messages_id_around?: string;
|
|
612
|
+
include_soft_deleted_channel?: boolean;
|
|
610
613
|
user_id?: string;
|
|
611
614
|
}): Promise<StreamResponse<ChannelStateResponse>> {
|
|
612
615
|
const queryParams = {
|
|
@@ -619,6 +622,7 @@ export class ChatApi {
|
|
|
619
622
|
messages_id_gt: request?.messages_id_gt,
|
|
620
623
|
messages_id_gte: request?.messages_id_gte,
|
|
621
624
|
messages_id_around: request?.messages_id_around,
|
|
625
|
+
include_soft_deleted_channel: request?.include_soft_deleted_channel,
|
|
622
626
|
user_id: request?.user_id,
|
|
623
627
|
};
|
|
624
628
|
const pathParams = {
|
|
@@ -2673,6 +2677,29 @@ export class ChatApi {
|
|
|
2673
2677
|
return response;
|
|
2674
2678
|
}
|
|
2675
2679
|
|
|
2680
|
+
async searchAll(
|
|
2681
|
+
request?: SearchAllRequest,
|
|
2682
|
+
): Promise<StreamResponse<SearchAllResponse>> {
|
|
2683
|
+
const body = {
|
|
2684
|
+
limit: request?.limit,
|
|
2685
|
+
query: request?.query,
|
|
2686
|
+
entities: request?.entities,
|
|
2687
|
+
next: request?.next,
|
|
2688
|
+
};
|
|
2689
|
+
|
|
2690
|
+
const response = await this.apiClient.sendRequest<SearchAllResponse>(
|
|
2691
|
+
'POST',
|
|
2692
|
+
'/api/v2/chat/search/all',
|
|
2693
|
+
undefined,
|
|
2694
|
+
undefined,
|
|
2695
|
+
body,
|
|
2696
|
+
);
|
|
2697
|
+
|
|
2698
|
+
decoders['SearchAllResponse']?.(response);
|
|
2699
|
+
|
|
2700
|
+
return response;
|
|
2701
|
+
}
|
|
2702
|
+
|
|
2676
2703
|
async createSegment(
|
|
2677
2704
|
request: CreateSegmentRequest,
|
|
2678
2705
|
): Promise<StreamResponse<CreateSegmentResponse>> {
|
|
@@ -200,6 +200,7 @@ export class CommonApi {
|
|
|
200
200
|
user_search_disallowed_roles: request?.user_search_disallowed_roles,
|
|
201
201
|
webhook_events: request?.webhook_events,
|
|
202
202
|
activity_metrics_config: request?.activity_metrics_config,
|
|
203
|
+
agent_review: request?.agent_review,
|
|
203
204
|
apn_config: request?.apn_config,
|
|
204
205
|
async_moderation_config: request?.async_moderation_config,
|
|
205
206
|
datadog_info: request?.datadog_info,
|
|
@@ -715,12 +716,20 @@ export class CommonApi {
|
|
|
715
716
|
return response;
|
|
716
717
|
}
|
|
717
718
|
|
|
718
|
-
async listImports(
|
|
719
|
+
async listImports(request?: {
|
|
720
|
+
limit?: number;
|
|
721
|
+
offset?: number;
|
|
722
|
+
}): Promise<StreamResponse<ListImportsResponse>> {
|
|
723
|
+
const queryParams = {
|
|
724
|
+
limit: request?.limit,
|
|
725
|
+
offset: request?.offset,
|
|
726
|
+
};
|
|
727
|
+
|
|
719
728
|
const response = await this.apiClient.sendRequest<ListImportsResponse>(
|
|
720
729
|
'GET',
|
|
721
730
|
'/api/v2/imports',
|
|
722
731
|
undefined,
|
|
723
|
-
|
|
732
|
+
queryParams,
|
|
724
733
|
);
|
|
725
734
|
|
|
726
735
|
decoders['ListImportsResponse']?.(response);
|
|
@@ -718,6 +718,7 @@ export class FeedsApi {
|
|
|
718
718
|
include_top_level_comment_count?: boolean;
|
|
719
719
|
include_soft_deleted_activities?: boolean;
|
|
720
720
|
include_moderated_activities?: boolean;
|
|
721
|
+
skip_viewer_visibility?: boolean;
|
|
721
722
|
}): Promise<StreamResponse<GetActivityResponse>> {
|
|
722
723
|
const queryParams = {
|
|
723
724
|
comment_sort: request?.comment_sort,
|
|
@@ -729,6 +730,7 @@ export class FeedsApi {
|
|
|
729
730
|
include_top_level_comment_count: request?.include_top_level_comment_count,
|
|
730
731
|
include_soft_deleted_activities: request?.include_soft_deleted_activities,
|
|
731
732
|
include_moderated_activities: request?.include_moderated_activities,
|
|
733
|
+
skip_viewer_visibility: request?.skip_viewer_visibility,
|
|
732
734
|
};
|
|
733
735
|
const pathParams = {
|
|
734
736
|
id: request?.id,
|