From 809afb6ed26ba907f7cd7869071070b2e10b696e Mon Sep 17 00:00:00 2001 From: mmartinsky Date: Thu, 13 Aug 2020 09:52:50 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Merge=20PR=20#46630=20feat(symph?= =?UTF-8?q?ony-api-client-node):=20new=20type=20definition=20by=20@mmartin?= =?UTF-8?q?sky?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- types/symphony-api-client-node/index.d.ts | 219 ++++++++++++++++++ .../symphony-api-client-node-tests.ts | 9 + types/symphony-api-client-node/tsconfig.json | 24 ++ types/symphony-api-client-node/tslint.json | 1 + 4 files changed, 253 insertions(+) create mode 100644 types/symphony-api-client-node/index.d.ts create mode 100644 types/symphony-api-client-node/symphony-api-client-node-tests.ts create mode 100644 types/symphony-api-client-node/tsconfig.json create mode 100644 types/symphony-api-client-node/tslint.json diff --git a/types/symphony-api-client-node/index.d.ts b/types/symphony-api-client-node/index.d.ts new file mode 100644 index 0000000000..b53c905475 --- /dev/null +++ b/types/symphony-api-client-node/index.d.ts @@ -0,0 +1,219 @@ +// Type definitions for symphony-api-client-node 1.1 +// Project: https://github.com/SymphonyPlatformSolutions/symphony-api-client-node +// Definitions by: Mike Martinsky +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 + +export interface AuthInfo { + sessionAuthToken: string; + kmAuthToken: string; +} + +export const MESSAGEML_FORMAT: string; + +export const PRESENTATIONML_FORMAT: string; + +export const sessionToken: string; + +export function acceptConnectionRequest(userId: any, sessionToken: string): void; + +export function activateRoom(streamId: any): void; + +export function addMemberToRoom(streamId: any, userId: any): any; + +export function adminListEnterpriseStreamsV2( + streamTypes: any, + scope: any, + origin: any, + privacy: any, + status: any, + startDate: any, + endDate: any, + skip: any, + limit: any, +): any; + +export function authenticateBot(SymConfig: any): any; + +export function authenticateExtApp(): any; + +export function authenticateOboApp(): any; + +export function createRoom( + room: any, + description?: any, + keywords?: any, + membersCanInvite?: any, + discoverable?: any, + anyoneCanJoin?: any, + readOnly?: any, + copyProtected?: any, + crossPod?: any, + viewHistory?: any, +): any; + +export function createSignal(name: any, query: any, visibleOnProfile: any, companyWide: any, sessionToken: string): any; + +export function deactivateRoom(streamId: any): void; + +export function deleteSignal(id: any, sessionToken: string): void; + +export function demoteUserFromOwner(streamId: any, userId: any): any; + +export function formBuilder(formId: any): any; + +export function forwardMessage(conversationId: any, message: any, data: any): any; + +export function getAcceptedConnections(sessionToken: string): void; + +export function getAllConnections(sessionToken: string): void; + +export function getAttachment(streamId: any, attachmentId: any, messageId: any): any; + +export function getBotUser(): void; + +export function getCashtags(message: any): any; + +export function getConnectionRequestStatus(userId: any, sessionToken: string): void; + +export function getConnections(status: any, userIds: any, sessionToken: string): void; + +export function getDatafeedEventsService(options: any): any; + +export function getFirehoseEventsService(subscriberCallback: any): void; + +export function getHashtags(message: any): any; + +export function getInboundPendingConnections(sessionToken: string): void; + +export function getMentions(message: any): any; + +export function getMessage(messageId: any): void; + +export function getMessages(streamId: any, since: any, skip: any, limit: any): void; + +export function getPendingConnections(sessionToken: string): void; + +export function getRejectedConnections(sessionToken: string): void; + +export function getRoomInfo(streamId: any): void; + +export function getRoomMembers(streamId: any): void; + +export function getSignal(id: any, sessionToken: string): void; + +export function getSignalSubscribers(id: any, skip: any, limit: any, sessionToken: string): void; + +export function getUser(id: any): void; + +export function getUserFromEmail(email: any, local: any): void; + +export function getUserFromUsername(username: any): void; + +export function getUserIMStreamId(userIDs: any): void; + +export function getUserPresence(userId: any, local: any): void; + +export function getUserStreams(skip: any, limit: any, streamTypes: any, includeInactiveStreams: any): any; + +export function getUsersFromEmailList(email: any, local: any): void; + +export function getUsersFromIdList(id: any, local: any): void; + +export function importMessages(messageList: any): any; + +export function initBot(pathToConfigFile: string, pathToLoadBalancerConfigFile?: string): Promise; + +export function listSignals(skip: any, limit: any, sessionToken: string): void; + +export function listUsers(skip: any, limit: any): void; + +export function oboAuthenticateByUserId(userId: any): any; + +export function oboGetAllConnections(status: any): void; + +export function oboGetConnection(userId: any): void; + +export function oboGetUserIMStreamId(userToken: any, userIds: any): void; + +export function oboSendMessage(userToken: any, conversationId: any, message: any, data: any, format: any): any; + +export function promoteUserToOwner(streamId: any, userId: any): any; + +export function registerInterestExtUser(): void; + +export function rejectConnectionRequest(userId: any, sessionToken: string): void; + +export function removeConnection(userId: any, sessionToken: string): void; + +export function removeMemberFromRoom(streamId: any, userId: any): any; + +export function searchRooms( + skip?: any, + limit?: any, + query?: any, + labels?: any, + active?: any, + includePrivateRooms?: any, + creator?: any, + owner?: any, + member?: any, + sortOrder?: any, +): any; + +export function searchUsers(query: any, local?: any, skip?: any, limit?: any, filter?: any): any; + +export function sendConnectionRequest(userId: any, sessionToken: string): void; + +export function sendMessage(conversationId: any, message: any, data: any, format: any, sessionToken: string): any; + +export function sendMessageWithAttachment( + conversationId: any, + message: any, + data: any, + fileName: any, + fileType: any, + fileContent: any, + format: any, +): any; + +export function setDebugMode(mode: any): void; + +export function setPresence(status: any): any; + +export function stopDatafeedEventsService(): void; + +export function stopFirehoseEventsService(): void; + +export function streamMembers(id: any, skip: any, limit: any): void; + +export function subscribeSignal(id: any, userIds: any, userCanUnsubscribe: any, sessionToken: string): void; + +export function suppressMessage(id: any): void; + +export function unsubscribeSignal(id: any, userIds: any, sessionToken: string): void; + +export function updateRoom( + streamId: any, + room: any, + description?: any, + keywords?: any, + membersCanInvite?: any, + discoverable?: any, + anyoneCanJoin?: any, + readOnly?: any, + copyProtected?: any, + crossPod?: any, + viewHistory?: any, +): any; + +export function updateSignal( + id: any, + name?: any, + query?: any, + visibleOnProfile?: any, + companyWide?: any, + sessionToken?: any, +): any; + +export function verifyJwt(jwt: any): any; diff --git a/types/symphony-api-client-node/symphony-api-client-node-tests.ts b/types/symphony-api-client-node/symphony-api-client-node-tests.ts new file mode 100644 index 0000000000..af54ad3ea2 --- /dev/null +++ b/types/symphony-api-client-node/symphony-api-client-node-tests.ts @@ -0,0 +1,9 @@ +import * as Symphony from 'symphony-api-client-node'; + +Symphony.initBot('/config.json') + .then((authTokens: Symphony.AuthInfo) => { + console.log(authTokens); + }) + .catch((err: any) => { + console.error(err); + }); diff --git a/types/symphony-api-client-node/tsconfig.json b/types/symphony-api-client-node/tsconfig.json new file mode 100644 index 0000000000..67de0c41fd --- /dev/null +++ b/types/symphony-api-client-node/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "DOM" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "symphony-api-client-node-tests.ts" + ] +} diff --git a/types/symphony-api-client-node/tslint.json b/types/symphony-api-client-node/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/symphony-api-client-node/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }