monday-sdk-js 0.1.6 → 0.2.1

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "monday-sdk-js",
-  "version": "0.1.6",
+  "version": "0.2.1",
   "private": false,
   "repository": "https://github.com/mondaycom/monday-sdk-js",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "author": "talharamati <tal@monday.com>",
   "license": "MIT",
   "files": [
@@ -11,10 +12,10 @@
     "README.md",
     "dist/",
     "src/",
+    "types/",
     "server-sdk.js"
   ],
   "dependencies": {
-    "@types/source-map": "^0.5.2",
     "node-fetch": "^2.6.0"
   },
   "devDependencies": {
@@ -34,7 +35,9 @@
     "sinon-chai": "^3.5.0",
     "webpack": "^4.38.0",
     "webpack-cli": "^3.3.6",
-    "webpack-dev-server": "^3.7.2"
+    "webpack-dev-server": "^3.7.2",
+    "@types/source-map": "^0.5.2",
+    "typescript": "^4.9.5"
   },
   "scripts": {
     "start": "webpack-dev-server",
@@ -43,6 +46,7 @@
     "test:watch": "mocha './src/**/*-test.js' --watch",
     "precommit": "yarn lint && yarn style-check",
     "lint": "eslint './src/**/*.*'",
-    "style-check": "prettier --check './src/**/*.js'"
+    "style-check": "prettier --check './src/**/*.js'",
+    "compile-types": "tsc --noEmit"
   }
 }

package/types/index.d.ts

@@ -0,0 +1,320 @@
+// Original Definitions were contributed by: Josh Parnham <https://github.com/josh->
+
+export as namespace mondaySdk;
+
+interface APIOptions {
+    /**
+     * Access token for the API
+     * If not set, will use the credentials of the current user (client only)
+     */
+    token?: string | undefined;
+
+    /**
+     * An object containing GraphQL query variables
+     */
+    variables?: object | undefined;
+}
+
+type SubscribableEvents = 'context' | 'settings' | 'itemIds' | 'events';
+
+interface OAuthOptions {
+    /**
+     * The OAuth client ID of the requesting application
+     * Defaults to your client ID
+     */
+    clientId?: string | undefined;
+
+    /**
+     * The URL of the monday OAuth endpoint
+     */
+    mondayOauthUrl?: string | undefined;
+}
+
+interface GetResponse {
+    value: any;
+    version: any;
+}
+
+interface SetResponse {
+    success: boolean;
+    reason?: string | undefined;
+}
+
+interface MondayClientSdk {
+    /**
+     * Used for querying the monday.com GraphQL API seamlessly on behalf of the connected user, or using a provided API token.
+     * For more information about the GraphQL API and all queries and mutations possible, read the [API Documentation](https://monday.com/developers/v2)
+     * @param query A [GraphQL](https://graphql.org/) query, can be either a query (retrieval operation) or a mutation (creation/update/deletion operation).
+     * Placeholders may be used, which will be substituted by the variables object passed within the options.
+     * @param options
+     */
+    api(query: string, options?: APIOptions): Promise<{ data: object }>;
+
+    /**
+     * Instead of passing the API token to the `api()` method on each request, you can set the API token once using:
+     * @param token Access token for the API
+     */
+    setToken(token: string): void;
+
+    /**
+     * Used for retrieving data from the parent monday.com application where your app is currently running.
+     * This object can only be used when your app is running inside an `iframe`. This can only be used in client-side apps.
+     * @param type The type of requested information (available values below)
+     * - `'context'` Information about where this app is currently displayed, depending on the type of feature
+     * - `'settings'` The application settings as configured by the user that installed the app
+     * - `'itemIds'` The list of item IDs that are filtered in the current board (or all items if no filters are applied)
+     * - `'sessionToken'` A JWT token which is decoded with your app's secret and can be used as a session token between your app's frontend & backend
+     * @param params Reserved for future use
+     */
+    get(type: 'context' | 'settings' | 'itemIds' | 'sessionToken', params?: object): Promise<any>;
+
+    /**
+     * Creates a listener which allows subscribing to certain types of client-side events.
+     * @param typeOrTypes The type, or array of types, of events to subscribe to
+     * @param callback A callback function that is fired when the listener is triggered by a client-side event
+     * @param params Reserved for future use
+     */
+    listen(
+        typeOrTypes: SubscribableEvents | ReadonlyArray<SubscribableEvents>,
+        callback: (res: { data: object }) => void,
+        params?: object,
+    ): void;
+
+    /**
+     * Opens a popup card with information from the selected item
+     * @param type Which action to perform
+     * @param params Optional parameters for the action
+     */
+    execute(
+        type: 'openItemCard',
+        params: {
+            /**
+             * The ID of the item to open
+             */
+            itemId: number;
+
+            /**
+             * On which view to open the item card.
+             * Can be "updates" / "columns"
+             * Defaults to "columns"
+             */
+            kind?: 'updates' | 'columns' | undefined;
+        },
+    ): Promise<any>;
+    /**
+     * Opens a confirmation dialog to the user **type** `'confirm'`
+     * @param type Which action to perform
+     * @param params Optional parameters for the action
+     */
+    execute(
+        type: 'confirm',
+        params: {
+            /**
+             * The message to display in the dialog
+             */
+            message: string;
+
+            /**
+             * The text for the confirmation button
+             * Defaults to "OK"
+             */
+            confirmButton?: string | undefined;
+
+            /**
+             * The text for the cancel button
+             * Defaults to "Cancel"
+             */
+            cancelButton?: string | undefined;
+
+            /**
+             * Either to exclude the cancel button
+             * Defaults to `false`
+             */
+            excludeCancelButton?: boolean | undefined;
+        },
+    ): Promise<{ data: { confirm: boolean } }>;
+    /**
+     * Display a message at the top of the user's page. Useful for success, error & general messages.
+     * @param type Which action to perform
+     * @param params Optional parameters for the action
+     */
+    execute(
+        type: 'notice',
+        params: {
+            /**
+             * The message to display
+             */
+            message: string;
+
+            /**
+             * The type of message to display. Can be "success" (green), "error" (red) or "info" (blue)
+             * Defaults to "info"
+             */
+            type?: 'success' | 'error' | 'info' | undefined;
+
+            /**
+             * The number of milliseconds to show the message until it closes
+             * Defaults to 5000
+             */
+            timeout?: number | undefined;
+        },
+    ): Promise<any>;
+    /**
+     * Opens a modal with the preview of an asset
+     * @param type Which action to perform
+     * @param params Optional parameters for the action
+     */
+    execute(
+        type: 'openFilesDialog',
+        params: {
+            /**
+             * The ID of the board
+             */
+            boardId: number;
+
+            /**
+             * The ID of the item, which contains an asset
+             */
+            itemId: number;
+
+            /**
+             * The ID of the column, which contains an asset
+             */
+            columnId: string;
+
+            /**
+             * The ID of the asset to open
+             */
+            assetId: number;
+        },
+    ): Promise<any>;
+    /**
+     * Opens a modal to let the current user upload a file to a specific file column.
+     *
+     * Returns a promise. In case of error, the promise is rejected
+     *
+     * After the file is successfully uploaded, the "change_column_value" event will be triggered. See the {@link listen} method to subscribe to these events.
+     *
+     * _Requires boards:write scope_
+     * @param type Which action to perform
+     * @param params Optional parameters for the action
+     */
+    execute(
+        type: 'triggerFilesUpload',
+        params: {
+            /**
+             * The ID of the board
+             */
+            boardId: number;
+
+            /**
+             * The ID of the item, which contains an asset
+             */
+            itemId: number;
+
+            /**
+             * The ID of the file column, where file should be uploaded
+             */
+            columnId: string;
+        },
+    ): Promise<any>;
+    /**
+     * Opens a new modal window as an iFrame.
+     * @param type Which action to perform
+     * @param params Optional parameters for the action
+     */
+    execute(
+        type: 'openAppFeatureModal',
+        params: {
+            /**
+             * The URL of the page displayed in the modal
+             * Defaults to current iFrame's URL
+             */
+            url?: string;
+
+            /**
+             * Subdirectory or path of the URL to open
+             */
+            urlPath?: string;
+
+            /**
+             * Query parameters for the URL
+             */
+            urlParams?: Record<string, string>;
+
+            /**
+             * The width of the modal
+             * Defaults to "0px"
+             */
+            width?: string;
+
+            /**
+             * The height of the modal
+             * Defaults to "0px"
+             */
+            height?: string;
+        },
+    ): Promise<{ data: any }>;
+    /**
+     * Closes the modal window.
+     * @param type Which action to perform
+     * @param params Optional parameters for the action
+     */
+    execute(type: 'closeAppFeatureModal'): Promise<{ data: any }>;
+
+    /**
+     * Performs a client-side redirection of the user to the monday OAuth screen with your client ID embedded in the URL,
+     * sin order to get their approval to generate a temporary OAuth token based on your requested permission scopes.
+     * @param object An object with options
+     */
+    oauth(object?: OAuthOptions): void;
+
+    /**
+     * The Storage API is in early beta stages, its API is likely to change
+     *
+     * The monday apps infrastructure includes a persistent, key-value database storage that developers
+     * can leverage to store data without having to create their own backend and maintain their own database.
+     *
+     * The database currently offers instance-level storage only, meaning that each application instance (i.e. a single board view or a dashboard widget) maintains its own storage.
+     * Apps cannot share storage across accounts or even across apps installed in the same location.
+     */
+    storage: {
+        instance: {
+            /**
+             * Returns a stored value from the database under `key`
+             * @param key
+             */
+            getItem(key: string): Promise<{ data: GetResponse }>;
+
+            /**
+             * Stores `value` under `key` in the database
+             * @param key
+             * @param value
+             */
+            setItem(key: string, value: any): Promise<SetResponse>;
+        };
+    };
+}
+
+interface MondayServerSdk {
+    setToken(token: string): void;
+
+    api(query: string, options?: Partial<{ token: string, variables: object } >): Promise<any>;
+
+    oauthToken(code: string, clientId: string, clientSecret: string): Promise<any>;
+}
+
+declare function init(
+    config?: Partial<{
+        clientId: string;
+        apiToken: string;
+    }>,
+): MondayClientSdk;
+
+declare function init(
+    config?: Partial<{
+        token: string;
+    }>,
+): MondayServerSdk;
+
+export = init;