diff --git a/types/evernote/index.d.ts b/types/evernote/index.d.ts index 18e0e13e1c..6a28d2e627 100644 --- a/types/evernote/index.d.ts +++ b/types/evernote/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: Zachary Collins // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -import { Thrift } from "thrift"; +import * as Thrift from 'thrift'; declare namespace Evernote { interface Callback { diff --git a/types/thrift/index.d.ts b/types/thrift/index.d.ts index 3db53d91d9..ed3fb13659 100644 --- a/types/thrift/index.d.ts +++ b/types/thrift/index.d.ts @@ -1,280 +1,42 @@ -// Type definitions for thrift 0.9.2 +// Type definitions for thrift 0.10 // Project: https://www.npmjs.com/package/thrift -// Definitions by: Zachary Collins +// Definitions by: Kamek // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -/* - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. +export as namespace Thrift; + +export class TException {} + +/** + * Protocols and Transports */ +export class TBufferedTransport {} +export class TXHRTransport {} +export class TJSONProtocol {} +export class TBinaryProtocol {} -export declare module Thrift { - /** - * Thrift IDL type string to Id mapping. - * @property {number} STOP - End of a set of fields. - * @property {number} VOID - No value (only legal for return types). - * @property {number} BOOL - True/False integer. - * @property {number} BYTE - Signed 8 bit integer. - * @property {number} I08 - Signed 8 bit integer. - * @property {number} DOUBLE - 64 bit IEEE 854 floating point. - * @property {number} I16 - Signed 16 bit integer. - * @property {number} I32 - Signed 32 bit integer. - * @property {number} I64 - Signed 64 bit integer. - * @property {number} STRING - Array of bytes representing a string of characters. - * @property {number} UTF7 - Array of bytes representing a string of UTF7 encoded characters. - * @property {number} STRUCT - A multifield type. - * @property {number} MAP - A collection type (map/associative-array/dictionary). - * @property {number} SET - A collection type (unordered and without repeated values). - * @property {number} LIST - A collection type (unordered). - * @property {number} UTF8 - Array of bytes representing a string of UTF8 encoded characters. - * @property {number} UTF16 - Array of bytes representing a string of UTF16 encoded characters. - */ - interface Type { - 'STOP': number; - 'VOID': number; - 'BOOL': number; - 'BYTE': number; - 'I08': number; - 'DOUBLE': number; - 'I16': number; - 'I32': number; - 'I64': number; - 'STRING': number; - 'UTF7': number; - 'STRUCT': number; - 'MAP': number; - 'SET': number; - 'LIST': number; - 'UTF8': number; - 'UTF16': number; - } - var Type: Type; - - /** - * Thrift RPC message type string to Id mapping. - * @property {number} CALL - RPC call sent from client to server. - * @property {number} REPLY - RPC call normal response from server to client. - * @property {number} EXCEPTION - RPC call exception response from server to client. - * @property {number} ONEWAY - Oneway RPC call from client to server with no response. - */ - interface MessageType { - 'CALL': number; - 'REPLY': number; - 'EXCEPTION': number; - 'ONEWAY': number; - } - var MessageType: MessageType; - - /** - * Utility function returning the count of an object's own properties. - * @param {object} obj - Object to test. - * @returns {number} number of object's own properties - */ - function objectLength(obj: Object): number; - - /** - * Utility function to establish prototype inheritance. - * @param {function} constructor - Contstructor function to set as derived. - * @param {function} superConstructor - Contstructor function to set as base. - * @param {string} [name] - Type name to set as name property in derived prototype. - */ - function inherits(constructor: Function, superConstructor: Function, name?: string): void; - - /** - * TException is the base class for all Thrift exceptions types. - */ - class TException implements Error { - name: string; - message: string; - - /** - * Initializes a Thrift TException instance. - * @param {string} message - The TException message (distinct from the Error message). - */ - constructor(message: string); - - /** - * Returns the message set on the exception. - * @returns {string} exception message - */ - getMessage(): string; - } - - /** - * Thrift Application Exception type string to Id mapping. - * @property {number} UNKNOWN - Unknown/undefined. - * @property {number} UNKNOWN_METHOD - Client attempted to call a method unknown to the server. - * @property {number} INVALID_MESSAGE_TYPE - Client passed an unknown/unsupported MessageType. - * @property {number} WRONG_METHOD_NAME - Unused. - * @property {number} BAD_SEQUENCE_ID - Unused in Thrift RPC, used to flag proprietary sequence number errors. - * @property {number} MISSING_RESULT - Raised by a server processor if a handler fails to supply the required return result. - * @property {number} INTERNAL_ERROR - Something bad happened. - * @property {number} PROTOCOL_ERROR - The protocol layer failed to serialize or deserialize data. - * @property {number} INVALID_TRANSFORM - Unused. - * @property {number} INVALID_PROTOCOL - The protocol (or version) is not supported. - * @property {number} UNSUPPORTED_CLIENT_TYPE - Unused. - */ - interface TApplicationExceptionType { - 'UNKNOWN': number; - 'UNKNOWN_METHOD': number; - 'INVALID_MESSAGE_TYPE': number; - 'WRONG_METHOD_NAME': number; - 'BAD_SEQUENCE_ID': number; - 'MISSING_RESULT': number; - 'INTERNAL_ERROR': number; - 'PROTOCOL_ERROR': number; - 'INVALID_TRANSFORM': number; - 'INVALID_PROTOCOL': number; - 'UNSUPPORTED_CLIENT_TYPE': number; - } - var TApplicationExceptionType: TApplicationExceptionType; - - /** - * TApplicationException is the exception class used to propagate exceptions from an RPC server back to a calling client. - */ - class TApplicationException extends TException { - message: string; - code: number; - - /** - * Initializes a Thrift TApplicationException instance. - * @param {string} message - The TApplicationException message (distinct from the Error message). - * @param {Thrift.TApplicationExceptionType} [code] - The TApplicationExceptionType code. - */ - constructor(message: string, code?: number); - - /** - * Read a TApplicationException from the supplied protocol. - * @param {object} input - The input protocol to read from. - */ - read(input: Object): void; - - /** - * Write a TApplicationException to the supplied protocol. - * @param {object} output - The output protocol to write to. - */ - write(output: Object): void; - - /** - * Returns the application exception code set on the exception. - * @returns {Thrift.TApplicationExceptionType} exception code - */ - getCode(): number; - } - - /** - * The Apache Thrift Transport layer performs byte level I/O between RPC - * clients and servers. The JavaScript Transport object type uses Http[s]/XHR and is - * the sole browser based Thrift transport. Target servers must implement the http[s] - * transport (see: node.js example server). - */ - class TXHRTransport { - url: string; - wpos: number; - rpos: number; - useCORS: any; - send_buf: string; - recv_buf: string; - - /** - * If you do not specify a url then you must handle XHR operations on - * your own. This type can also be constructed using the Transport alias - * for backward compatibility. - * @param {string} [url] - The URL to connect to. - * @param {object} [options] - Options. - */ - constructor(url?: string, options?: Object); - - /** - * Gets the browser specific XmlHttpRequest Object. - * @returns {object} the browser XHR interface object - */ - getXmlHttpRequestObject(): Object; - - /** - * Sends the current XRH request if the transport was created with a URL and - * the async parameter if false. If the transport was not created with a URL - * or the async parameter is True or the URL is an empty string, the current - * send buffer is returned. - * @param {object} async - If true the current send buffer is returned. - * @param {function} callback - Optional async completion callback. - * @returns {undefined|string} Nothing or the current send buffer. - */ - flush(async: any, callback?: Function): string; - - /** - * Creates a jQuery XHR object to be used for a Thrift server call. - * @param {object} client - The Thrift Service client object generated by the IDL compiler. - * @param {object} postData - The message to send to the server. - * @param {function} args - The function to call if the request succeeds. - * @param {function} recv_method - The Thrift Service Client receive method for the call. - * @returns {object} A new jQuery XHR object. - */ - jqRequest(client: Object, postData: any, args: Function, recv_method: Function): Object; - - /** - * Sets the buffer to use when receiving server responses. - * @param {string} buf - The buffer to receive server responses. - */ - setRecvBuffer(buf: string): void; - - /** - * Returns true if the transport is open, in browser based JavaScript - * this function always returns true. - * @returns {boolean} Always True. - */ - isOpen(): boolean; - - /** - * Opens the transport connection, in browser based JavaScript - * this function is a nop. - */ - open(): void; - - /** - * Closes the transport connection, in browser based JavaScript - * this function is a nop. - */ - close(): void; - - /** - * Returns the specified number of characters from the response - * buffer. - * @param {number} len - The number of characters to return. - * @returns {string} Characters sent by the server. - */ - read(len: number): string; - - /** - * Returns the entire response buffer. - * @returns {string} Characters sent by the server. - */ - readAll(): string; - - /** - * Sets the send buffer to buf. - * @param {string} buf - The buffer to send. - */ - write(buf: string): void; - - /** - * Returns the send buffer. - * @returns {string} The send buffer. - */ - getSendBuffer(): string; - } +/** + * Server side + */ +export interface ThriftServer { + listen(port: number): any; } + +export function createServer(generatedService: any, serviceMethods: any): ThriftServer; + +/** + * Client side + */ +export type ConnexionEvent = 'open' | 'message' | 'close' | 'error'; + +export interface ClientConnectionParams { + transport: TJSONProtocol | TBinaryProtocol; + protocol: TBufferedTransport | TXHRTransport; +} + +export interface ClientConnection { + on(event: ConnexionEvent, callback: (...args: any[]) => void): void; +} + +export function createConnection(host: string, port: number, params: ClientConnectionParams): ClientConnection; +export function createClient(generatedService: any, connection: {}): any; diff --git a/types/thrift/thrift-tests.ts b/types/thrift/thrift-tests.ts index f437764bc9..98d3ab89a2 100644 --- a/types/thrift/thrift-tests.ts +++ b/types/thrift/thrift-tests.ts @@ -1,7 +1,10 @@ -// Currently, the thrift bindings are minimal just to support the thrift generated -// evernote bindings. Add more tests if you flesh out and plan to use the thrift -// bindings more deeply. +import * as Thrift from 'thrift'; -import evernote = require("evernote"); +const fakeGeneratedService: any = {}; +const fakeServiceMethods: any = {}; +const fakeConnectionParams: any = {}; -1 + 1; +Thrift.createServer(fakeGeneratedService, fakeServiceMethods); + +const clientConnection = Thrift.createConnection('0.0.0.0', 1234, fakeConnectionParams); +Thrift.createClient(fakeGeneratedService, clientConnection); diff --git a/types/thrift/tsconfig.json b/types/thrift/tsconfig.json index 714c4108e9..29562363f2 100644 --- a/types/thrift/tsconfig.json +++ b/types/thrift/tsconfig.json @@ -19,4 +19,4 @@ "index.d.ts", "thrift-tests.ts" ] -} \ No newline at end of file +} diff --git a/types/thrift/tslint.json b/types/thrift/tslint.json new file mode 100644 index 0000000000..f93cf8562a --- /dev/null +++ b/types/thrift/tslint.json @@ -0,0 +1,3 @@ +{ + "extends": "dtslint/dt.json" +}