diff --git a/types/custom-function-runtime/custom-function-runtime-tests.ts b/types/custom-function-runtime/custom-function-runtime-tests.ts new file mode 100644 index 0000000000..d23e2e60e6 --- /dev/null +++ b/types/custom-function-runtime/custom-function-runtime-tests.ts @@ -0,0 +1,32 @@ +function ADD10(n: number) { + return n + 10; +} + +declare const CustomFunctionMappings: { + "addTen": ADD10(); +}; + +async function getStockValues(ticker: string, handler: CustomFunctions.StreamingHandler) { + const dollars = await (await fetch(`myService.com/prices/${ticker}`)).json(); + handler.setResult(dollars) +} + +async function getStockValuesOneTime(ticker: string, handler: CustomFunctions.CancelableHandler) { + var shouldStop = false; + handler.onCanceled = () => shouldStop = true; + await pause(1000); + + if (shouldStop) { + return null; + } + + const dollars = await (await fetch(`myService.com/prices/${ticker}`)).json(); + return dollars; +} + +async function getStockValuesNowWithNoCancelling(ticker: string) { + const dollars = await (await fetch(`myService.com/prices/${ticker}`)).json(); + return dollars; +} + +declare function pause(ms: number): Promise diff --git a/types/custom-function-runtime/index.d.ts b/types/custom-function-runtime/index.d.ts new file mode 100644 index 0000000000..3bab36de3c --- /dev/null +++ b/types/custom-function-runtime/index.d.ts @@ -0,0 +1,30 @@ +// Type definitions for Custom Functions +// Project: http://dev.office.com +// Definitions by: OfficeDev , Michael Zlatkovsky , Michelle Scharlock +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.4 + +/* +office-js +Copyright (c) Microsoft Corporation +*/ + +declare const CustomFunctionMappings: { [key: string]: Function }; + +declare namespace CustomFunctions { + interface StreamingHandler extends CancelableHandler { + /* + * Sets the returned result for a streaming custom function. + * @beta + */ + setResult: (value: T) => void; + } + + interface CancelableHandler { + /* + * Handles what should occur when a custom function is canceled. + * @beta + */ + onCanceled: () => void; + } +} diff --git a/types/custom-function-runtime/tsconfig.json b/types/custom-function-runtime/tsconfig.json new file mode 100644 index 0000000000..5c54e3ed5b --- /dev/null +++ b/types/custom-function-runtime/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "target": "es6", + }, + "files": [ + "index.d.ts", + "office-runtime-tests.ts" + ] +} \ No newline at end of file diff --git a/types/custom-function-runtime/tslint.json b/types/custom-function-runtime/tslint.json new file mode 100644 index 0000000000..5c50b51e66 --- /dev/null +++ b/types/custom-function-runtime/tslint.json @@ -0,0 +1,79 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "adjacent-overload-signatures": false, + "array-type": false, + "arrow-return-shorthand": false, + "ban-types": false, + "callable-types": false, + "comment-format": false, + "dt-header": false, + "eofline": false, + "export-just-namespace": false, + "import-spacing": false, + "interface-name": false, + "interface-over-type-literal": false, + "jsdoc-format": false, + "max-line-length": false, + "member-access": false, + "new-parens": false, + "no-any-union": false, + "no-boolean-literal-compare": false, + "no-conditional-assignment": false, + "no-consecutive-blank-lines": false, + "no-construct": false, + "no-declare-current-package": false, + "no-duplicate-imports": false, + "no-duplicate-variable": false, + "no-empty-interface": false, + "no-for-in-array": false, + "no-inferrable-types": false, + "no-internal-module": false, + "no-irregular-whitespace": false, + "no-mergeable-namespace": false, + "no-misused-new": false, + "no-namespace": false, + "no-object-literal-type-assertion": false, + "no-padding": false, + "no-redundant-jsdoc": false, + "no-redundant-jsdoc-2": false, + "no-redundant-undefined": false, + "no-reference-import": false, + "no-relative-import-in-test": false, + "no-self-import": false, + "no-single-declare-module": false, + "no-string-throw": false, + "no-unnecessary-callback-wrapper": false, + "no-unnecessary-class": false, + "no-unnecessary-generics": false, + "no-unnecessary-qualifier": false, + "no-unnecessary-type-assertion": false, + "no-useless-files": false, + "no-var-keyword": false, + "no-var-requires": false, + "no-void-expression": false, + "no-trailing-whitespace": false, + "object-literal-key-quotes": false, + "object-literal-shorthand": false, + "one-line": false, + "one-variable-per-declaration": false, + "only-arrow-functions": false, + "prefer-conditional-expression": false, + "prefer-const": false, + "prefer-declare-function": false, + "prefer-for-of": false, + "prefer-method-signature": false, + "prefer-template": false, + "radix": false, + "semicolon": false, + "space-before-function-paren": false, + "space-within-parens": false, + "strict-export-declare-modifiers": false, + "trim-file": false, + "triple-equals": false, + "typedef-whitespace": false, + "unified-signatures": false, + "void-return": false, + "whitespace": false + } +} \ No newline at end of file diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 99d7ddac1b..024a72f6e9 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -17198,9 +17198,12 @@ declare namespace OfficeExtension { //////////////////////////////////////////////////////////////// + //////////////////////////////////////////////////////////////// + +//////////////////////////////////////////////////////////////// //////////////////////////////////////////////////////////////// ////////////////////// Begin OfficeCore //////////////////////// //////////////////////////////////////////////////////////////// diff --git a/types/office-runtime/index.d.ts b/types/office-runtime/index.d.ts new file mode 100644 index 0000000000..103ce050ea --- /dev/null +++ b/types/office-runtime/index.d.ts @@ -0,0 +1,154 @@ +// Type definitions for office-runtime +// Project: http://dev.office.com/ +// Definitions by: Michael Zlatskovsky , Michelle Scharlock +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// Typescript Version: 2.4 + +/* +office-runtime +Copyright (c) Microsoft Corporation +*/ + +/* +OfficeRuntime defines a new runtime which can be used by Excel custom functions. +*/ +declare namespace OfficeRuntime { + /* + A function which allows you to use a dialog box in Office Runtime, which can be used by Excel custom functions. + */ + function displayWebDialog(url: string, options: DisplayWebDialogOptions): Promise; + + /* + * Defines the AsyncStorage constant which allows asynchronous, global, and persistent key-value storage which can be used by Excel custom functions. + */ + + const AsyncStorage: AsyncStorage; + + /* + * Asynchronous, global, and persistent key-value storage that can be used by Excel custom functions. + * @beta + * + * @remarks + * Each add-in instance has its own storage partition, unique to a user and their device. + * + * The default amount of total storage allowed per add-in is 5MB. + * + * Each method listed below returns a Promise object. + * + */ + interface AsyncStorage { + /* + * @beta + * Retrieves an object based on a key and invokes a callback when finished. Returns a Promise. + * + */ + getItem(key: string, callback?: (error?: Error, result?: string) => void): Promise; + /* + * @beta + * Assigns the value for a key-value pair and invokes a callback when finished. Returns a Promise. + * + */ + setItem(key: string, value: string, callback?: (error?: Error) => void): Promise; + /* + * @beta + * Removes an item for specified key and invokes a callback when finished. Returns a Promise. + * + * + */ + removeItem(key: string, callback?: (error?: Error) => void): Promise; + /* + * @beta + * Erases all AsyncStorage. Returns a Promise. + * + */ + clear(callback?: (error?: Error) => void): Promise; + /* + * @beta + * Returns a Promise with all keys for your custom function. + * + */ + getAllKeys(callback?: (error?: Error, keys?: string[]) => void): Promise; + /* + * @beta + * Stores multiple key-value pairs in one batch. Returns a Promise. When a key doesn't exist, returns null. + * + */ + multiSet(keyValuePairs: string[][], callback?: (errors?: Error[]) => void): Promise; + /* + * @beta + * Deletes a batch of keys, specified in the `keys` array. + * + */ + multiRemove(keys: string[], callback?: (errors?: Error[]) => void): Promise;/** + /* + * @beta + * Fetches a batch of keys, specified in the `keys` array. When a key doesn't exist, returns null. + * + */ + multiGet(keys: string[], callback?: (errors?: Error[], result?: string[][]) => void): Promise; + } + + /* + * @beta + * Object representing the dialog box. + * + */ + interface Dialog { + /* + * @beta + * Method that closes a dialog box. + */ + close(): Promise; + } + + /* + * + * Provides options for how a dialog is displayed. + * + */ + interface DisplayWebDialogOptions { + /* + * @beta + * Determines whether the dialog box displays as a popup (false) or within an IFrame (true). This setting is only applicable to custom functions running on Excel Online. + * + */ + displayInIFrame?: boolean; + /* + * @beta + * Defines the height of the dialog box as a percentage of the current display. + * + */ + height?: string; + + /* + * @beta + * Defines the width of the dialog box as a percentage of the current display. + * + */ + width?: string; + + /* + * @beta + * Callback that is run when the dialog box sends a message to its parent. + * + * + */ + onMessage?: (message: string, dialog?: Dialog) => void; + + /* + * @beta + * Callback that is run when the dialog box is closed. + * + * + */ + onClose?: () => void; + + /* + * @beta + * Callback that is run when the dialog box sends an error. + * + * + */ + onRuntimeError?: (error: Error, dialog?: Dialog) => void; + } + } diff --git a/types/office-runtime/office-runtime-tests.ts b/types/office-runtime/office-runtime-tests.ts new file mode 100644 index 0000000000..5cd093aca5 --- /dev/null +++ b/types/office-runtime/office-runtime-tests.ts @@ -0,0 +1,77 @@ +/* +office-runtime +Copyright (c) Microsoft Corporation +*/ + +OfficeRuntime.AsyncStorage.getItem("foo", () => { + //perform an action +}) +OfficeRuntime.AsyncStorage.getItem("foo").then(value => console.log(value)) + +OfficeRuntime.AsyncStorage.setItem("foo", "bar"); +OfficeRuntime.AsyncStorage.setItem("foo", "bar").then(error => console.log(error)) + +OfficeRuntime.AsyncStorage.removeItem("foo"); +OfficeRuntime.AsyncStorage.removeItem("foo", () => { + //perform an action +}) + +OfficeRuntime.AsyncStorage.clear(); +OfficeRuntime.AsyncStorage.clear(() => { + //perform an action +}) + +OfficeRuntime.AsyncStorage.getAllKeys().then(keys => { + keys.forEach(item => console.log(item)); +}) +OfficeRuntime.AsyncStorage.getAllKeys((error, keys) => { + if (error) { + console.error(error); + } else { + keys.forEach(item => console.log(item)); + } +}) + +OfficeRuntime.AsyncStorage.multiSet( + [["username", "foo"], ["yearOfBirth", "2001"]], + errors => { + errors.filter(error => error != null).forEach(error => console.log(error)); + } +) + +OfficeRuntime.AsyncStorage.multiRemove(["foo", "bar"]); +OfficeRuntime.AsyncStorage.multiRemove(["foo", "bar"]).then(value => console.log(value)) + +OfficeRuntime.AsyncStorage.multiGet(["username", "yearOfBirth"]).then( + values => { + console.log(values[0][1]) + console.log(values[1][1]) + } +) + + +OfficeRuntime.displayWebDialog("https://localhost:3000", { + height: '50', + width: '50%', + displayInIFrame: false, + hideTitle: true, +     onMessage: (message, dialog) => { +         console.log(message); +             dialog.close(); +  } + } +) + + +OfficeRuntime.displayWebDialog("https://localhost:3000", { + onClose: () => { + console.log("closed"); + } +}) + +OfficeRuntime.displayWebDialog("https://localhost:3000", { + onRuntimeError: (error, dialog) => { + console.log(error); + dialog.close(); + } +}) diff --git a/types/office-runtime/tsconfig.json b/types/office-runtime/tsconfig.json new file mode 100644 index 0000000000..5c54e3ed5b --- /dev/null +++ b/types/office-runtime/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "target": "es6", + }, + "files": [ + "index.d.ts", + "office-runtime-tests.ts" + ] +} \ No newline at end of file diff --git a/types/office-runtime/tslint.json b/types/office-runtime/tslint.json new file mode 100644 index 0000000000..5c50b51e66 --- /dev/null +++ b/types/office-runtime/tslint.json @@ -0,0 +1,79 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "adjacent-overload-signatures": false, + "array-type": false, + "arrow-return-shorthand": false, + "ban-types": false, + "callable-types": false, + "comment-format": false, + "dt-header": false, + "eofline": false, + "export-just-namespace": false, + "import-spacing": false, + "interface-name": false, + "interface-over-type-literal": false, + "jsdoc-format": false, + "max-line-length": false, + "member-access": false, + "new-parens": false, + "no-any-union": false, + "no-boolean-literal-compare": false, + "no-conditional-assignment": false, + "no-consecutive-blank-lines": false, + "no-construct": false, + "no-declare-current-package": false, + "no-duplicate-imports": false, + "no-duplicate-variable": false, + "no-empty-interface": false, + "no-for-in-array": false, + "no-inferrable-types": false, + "no-internal-module": false, + "no-irregular-whitespace": false, + "no-mergeable-namespace": false, + "no-misused-new": false, + "no-namespace": false, + "no-object-literal-type-assertion": false, + "no-padding": false, + "no-redundant-jsdoc": false, + "no-redundant-jsdoc-2": false, + "no-redundant-undefined": false, + "no-reference-import": false, + "no-relative-import-in-test": false, + "no-self-import": false, + "no-single-declare-module": false, + "no-string-throw": false, + "no-unnecessary-callback-wrapper": false, + "no-unnecessary-class": false, + "no-unnecessary-generics": false, + "no-unnecessary-qualifier": false, + "no-unnecessary-type-assertion": false, + "no-useless-files": false, + "no-var-keyword": false, + "no-var-requires": false, + "no-void-expression": false, + "no-trailing-whitespace": false, + "object-literal-key-quotes": false, + "object-literal-shorthand": false, + "one-line": false, + "one-variable-per-declaration": false, + "only-arrow-functions": false, + "prefer-conditional-expression": false, + "prefer-const": false, + "prefer-declare-function": false, + "prefer-for-of": false, + "prefer-method-signature": false, + "prefer-template": false, + "radix": false, + "semicolon": false, + "space-before-function-paren": false, + "space-within-parens": false, + "strict-export-declare-modifiers": false, + "trim-file": false, + "triple-equals": false, + "typedef-whitespace": false, + "unified-signatures": false, + "void-return": false, + "whitespace": false + } +} \ No newline at end of file