@vibexnpm/talkx 8.13.0 → 9.1.0

package/types/__typetests__/call.types.ts

@@ -0,0 +1,101 @@
+/**
+ * 화상통화 타입(v9.0.0) — docs/webrtc.md 의 흐름이 <b>실제로 컴파일되는지</b>.
+ *
+ * <p>jest 는 `.d.ts` 를 보지 않는다. 문서가 약속한 모양(걸기·받기·거절·끝내기, 이벤트 내용, 상태·사유 값)이 선언과 맞는지 tsc 로
+ * 고정한다. P2P 시절 메서드(endCall·toggleVideo·getLocalStream 등)는 없어야 한다.</p>
+ *
+ * <p>실행: {@code npm run typecheck}</p>
+ */
+import TalkFlowClient, { CallKind, CallState, CallEventTypes, ErrorTypes } from '../index';
+import type {
+    CallEndReason, CallStateValue, CurrentCall, IncomingCallEvent, CallTrackEvent, CallParticipation, RingingCall, WebRTCClient
+} from '../index';
+
+declare const talkflow: TalkFlowClient;
+
+// 1) 받는 쪽 — 울림 알림 → 받기/거절, 울림 정지
+talkflow.on('incomingCall', async (call: IncomingCallEvent) => {
+    if (call.kind === CallKind.DIRECT && talkflow.isInCall()) {
+        await talkflow.rejectCall(call.callRoomId, { reason: 'BUSY' });
+        return;
+    }
+    const callRoomId: string = await talkflow.acceptCall(call.callRoomId, { video: true });
+    void callRoomId;
+});
+talkflow.on('ringStopped', ({ callRoomId, reason }) => {
+    const known: boolean = reason === 'answered_elsewhere' || reason === 'timeout';
+    void callRoomId; void known;
+});
+
+// 2) 거는 쪽 — 1:1·그룹
+async function start(): Promise<void> {
+    const direct: string = await talkflow.callUser('user-1', { video: false });
+    const group: string = await talkflow.createGroupCall({ invitedUsers: ['a', 'b'], title: '주간 회의', maxParticipants: 8 });
+    void direct; void group;
+    await talkflow.cancelCall();
+}
+
+// 3) 상태·트랙·끝
+talkflow.on('callStateChanged', ({ state, reason }) => {
+    const s: CallStateValue = state;
+    if (s === CallState.ENDED) {
+        const r: CallEndReason | undefined = reason;
+        void r;
+    }
+});
+talkflow.on('trackSubscribed', (event: CallTrackEvent) => {
+    const source: 'camera' | 'microphone' | 'screen' | 'screen_audio' | 'unknown' = event.source;
+    void source;
+});
+// docs/webrtc.md «영상·음성 붙이기» 그대로 — 트랙을 화면에 붙이고 떼는 것이 공개 타입으로 컴파일된다.
+talkflow.on('trackSubscribed', ({ userId, track }) => {
+    const element = track.attach();
+    element.dataset.userId = userId;
+    document.getElementById('remote')?.appendChild(element);
+});
+talkflow.on('trackUnsubscribed', ({ track }) => {
+    track.detach().forEach(element => element.remove());
+});
+talkflow.on('localTrackPublished', ({ source, track }) => {
+    if (source === 'camera') {
+        document.getElementById('preview')?.appendChild(track.attach());
+        const video: HTMLMediaElement = track.attach(document.createElement('video'));
+        const detached: HTMLMediaElement = track.detach(video);
+        void detached;
+    }
+});
+talkflow.on('callEnded', ({ reason }) => {
+    const r: CallEndReason = reason;
+    void r;
+});
+talkflow.on('callError', ({ code }) => {
+    const denied: boolean = code === ErrorTypes.MEDIA_ACCESS_DENIED || code === ErrorTypes.CALL_ALREADY_ACTIVE;
+    void denied;
+});
+
+// 4) 미디어·장치·조회
+async function controls(webrtc: WebRTCClient): Promise<void> {
+    await webrtc.setCameraEnabled(false);
+    await webrtc.setMicrophoneEnabled(true);
+    await webrtc.startScreenShare();
+    await webrtc.stopScreenShare();
+    const cameras: MediaDeviceInfo[] = await webrtc.getDevices('videoinput');
+    const switched: boolean = await webrtc.switchDevice('videoinput', cameras[0].deviceId);
+    const current: CurrentCall | null = webrtc.getCurrentCall();
+    const ringing: RingingCall[] = webrtc.getRingingCalls();
+    const participation: CallParticipation = await webrtc.getParticipation('call-1');
+    const stillRinging: boolean = participation.ring === 'RINGING';
+    void switched; void current; void ringing; void stillRinging;
+    await webrtc.leaveCall();
+    await webrtc.endCallForAll();
+}
+
+// 5) 이벤트 종류 상수
+const invitation: 'call_invitation' = CallEventTypes.INVITATION;
+void invitation; void start; void controls;
+
+// 6) P2P 시절 메서드는 없다
+// @ts-expect-error — v9.0.0 에서 지웠다
+talkflow.endCall();
+// @ts-expect-error — v9.0.0 에서 지웠다
+talkflow.getLocalStream();

package/types/__typetests__/scheduledReports.types.ts

@@ -0,0 +1,138 @@
+/**
+ * 예약 보고 타입 — docs/scheduled-reports.md 예제가 <b>실제로 컴파일되는지</b>.
+ *
+ * <p>jest 는 `.d.ts` 를 보지 않는다. 문서가 약속한 모양(반환은 데이터만 · `spec` 은 `kind` 로 가른다 ·
+ * 주기는 `type` 으로 가른다 · 멱등 키는 필수 · 응답의 칸을 그대로 고치기에 다시 보낼 수 있다)이 선언과 맞는지 여기서 본다.</p>
+ *
+ * <p>실행: {@code npm run typecheck}</p>
+ */
+import TalkFlowClient from '../index';
+import type {
+    ChatRoomTypeValue,
+    CreateScheduledReportData,
+    ScheduledReport,
+    ScheduledReportDetail,
+    ScheduledReportRoomOption,
+    ScheduledReportRun,
+    ScheduledReportSpec,
+    ScheduledTaskKind,
+} from '../index';
+
+declare const talkflow: TalkFlowClient;
+declare const key: string;
+
+// 1) 작업 칸은 kind 로 가른다 — 갈래마다 그 종류의 칸만 보이고, 빠진 갈래는 컴파일에서 막힌다.
+function describeSpec(spec: ScheduledReportSpec): string {
+    switch (spec.kind) {
+        case 'RESEARCH':
+            return spec.instruction;
+        case 'ROOM_DIGEST':
+            return `${spec.sourceRoomId} ${spec.period} ${spec.format} ${spec.focus ?? ''}`;
+        default: {
+            const unreachable: never = spec;
+            return unreachable;
+        }
+    }
+}
+
+// 2) 문서의 만들기 흐름 — 종류 → 원천 방 → 보낼 방 → 만들기 → 전용 방 초대. 반환은 데이터만이다.
+async function createDigest(): Promise<ScheduledReport | null> {
+    const kinds: ScheduledTaskKind[] = await talkflow.getScheduledReportKinds();
+    if (!kinds.includes('ROOM_DIGEST')) {
+        return null;
+    }
+    const sources: ScheduledReportRoomOption[] = await talkflow.getScheduledReportSourceRooms();
+    const sourceRoomId = sources[0].roomId;
+    const label: string = sources[0].name ?? sourceRoomId;
+    const roomType: ChatRoomTypeValue | undefined = sources[0].roomType;
+    const targets = await talkflow.getScheduledReportDeliveryRooms({ kind: 'ROOM_DIGEST', sourceRoomId });
+    const form: CreateScheduledReportData = {
+        title: '개발팀 주간 정리',
+        spec: { kind: 'ROOM_DIGEST', sourceRoomId, period: 'LAST_7_DAYS', format: 'MINUTES', focus: '결정 사항' },
+        cadence: { type: 'WEEKLY', days: ['MONDAY', 'THURSDAY'], time: '09:00', zoneId: 'Asia/Seoul' },
+        deliveryRoomIds: targets.map((room) => room.roomId),
+    };
+    const report = await talkflow.createScheduledReport(form, { idempotencyKey: key });
+    await talkflow.inviteToGroupRoom(report.homeRoomId, ['user-id']);
+    void [label, roomType];
+    return report;
+}
+
+// 3) 자료조사 — 보낼 방은 생략할 수 있고, 매일·평일 주기는 요일이 없다.
+async function createResearch(): Promise<ScheduledReport> {
+    const targets = await talkflow.getScheduledReportDeliveryRooms({ kind: 'RESEARCH' });
+    void targets;
+    return talkflow.createScheduledReport({
+        title: '아침 시장 조사',
+        spec: { kind: 'RESEARCH', instruction: '전기차 시장 소식 정리' },
+        cadence: { type: 'WEEKDAYS', time: '08:30' },
+    }, { idempotencyKey: key });
+}
+
+// 4) 고치기 — 고칠 칸만 보낸다. 응답의 작업 칸·주기를 그대로 다시 보낼 수 있고, 고치기 화면의 보낼 방은 예약 id 로 고른다.
+async function edit(report: ScheduledReport): Promise<void> {
+    await talkflow.updateScheduledReport(report.id, { status: 'PAUSED' });
+    await talkflow.updateScheduledReport(report.id, { status: 'ACTIVE' });
+    await talkflow.updateScheduledReport(report.id, { title: '새 제목', deliveryRoomIds: [] });
+    await talkflow.updateScheduledReport(report.id, { spec: report.spec, cadence: report.cadence });
+    await talkflow.updateScheduledReport(report.id, { cadence: { ...report.cadence, time: '10:00' } });
+    const rooms = await talkflow.getScheduledReportDeliveryRooms({ reportId: report.id });
+    const done: void = await talkflow.deleteScheduledReport(report.id);
+    void [rooms, done];
+}
+
+// 5) 예약 목록과 상세 — 응답의 주기는 요일·시간대가 늘 있고, 회차의 사유·결과는 비어 있을 수 있다.
+async function show(): Promise<string[]> {
+    const reports: ScheduledReport[] = await talkflow.getScheduledReports();
+    const detail: ScheduledReportDetail = await talkflow.getScheduledReport(reports[0].id);
+    const zoneId: string = detail.report.cadence.zoneId;
+    const days: number = detail.report.cadence.days.length;
+    const pauseReason: string = detail.report.pauseReason ?? '';
+    const next: string = detail.report.nextRunAt;
+    void [zoneId, days, pauseReason, next];
+    return detail.recentRuns.map((run: ScheduledReportRun) => {
+        const reason: string = run.endReason ?? '';
+        const kind: string = run.resultKind ?? '';
+        const skipped = run.deliveries.filter((delivery) => delivery.state === 'SKIPPED').map((delivery) => delivery.skipReason ?? '');
+        return `${run.scheduledAt} ${run.state} ${reason} ${kind} ${run.resultMessageId ?? ''} ${skipped.join(',')}`;
+    });
+}
+
+// 6) 잘못된 칸 조합은 컴파일에서 막힌다.
+async function rejected(sourceRoomId: string): Promise<void> {
+    const cadence = { type: 'DAILY', time: '09:00' } as const;
+
+    // @ts-expect-error — 멱등 키는 필수다. SDK 가 대신 만들지 않는다.
+    await talkflow.createScheduledReport({ title: 't', spec: { kind: 'RESEARCH', instruction: 'i' }, cadence });
+
+    // @ts-expect-error — 방 정리에는 원천 방이 있어야 한다.
+    const noSource: ScheduledReportSpec = { kind: 'ROOM_DIGEST', period: 'LAST_24_HOURS', format: 'SHORT' };
+
+    // @ts-expect-error — 자료조사에는 원천 방 칸이 없다.
+    const researchSource: ScheduledReportSpec = { kind: 'RESEARCH', instruction: 'i', sourceRoomId };
+
+    // @ts-expect-error — 형식은 공용 요약 형식 다섯 개뿐이다.
+    const wrongFormat: ScheduledReportSpec = { kind: 'ROOM_DIGEST', sourceRoomId, period: 'LAST_7_DAYS', format: 'BRIEF' };
+
+    // @ts-expect-error — 기간은 지난 24시간·지난 7일뿐이다.
+    const wrongPeriod: ScheduledReportSpec = { kind: 'ROOM_DIGEST', sourceRoomId, period: 'LAST_30_DAYS', format: 'SHORT' };
+
+    // @ts-expect-error — 없는 종류.
+    await talkflow.getScheduledReportDeliveryRooms({ kind: 'WEBPAGE_DIGEST' });
+
+    // @ts-expect-error — 방 정리의 보낼 방은 원천 방이 있어야 고른다.
+    await talkflow.getScheduledReportDeliveryRooms({ kind: 'ROOM_DIGEST' });
+
+    // @ts-expect-error — 주간은 요일이 있어야 한다.
+    await talkflow.updateScheduledReport('id', { cadence: { type: 'WEEKLY', time: '09:00' } });
+
+    // @ts-expect-error — 매일은 요일을 받지 않는다.
+    await talkflow.updateScheduledReport('id', { cadence: { type: 'DAILY', days: ['MONDAY'], time: '09:00' } });
+
+    // @ts-expect-error — 상태는 ACTIVE·PAUSED 뿐이다.
+    await talkflow.updateScheduledReport('id', { status: 'DELETED' });
+
+    void [noSource, researchSource, wrongFormat, wrongPeriod];
+}
+
+void [describeSpec, createDigest, createResearch, edit, show, rejected];