DX-1239 Autoformat code on commit

Author: janza

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn format

.prettierignore

@@ -0,0 +1,2 @@
+dist
+docs-out

package.json

@@ -13,7 +13,8 @@
     "build": "turbo run build",
     "dev": "turbo run dev",
     "test": "turbo run test",
-    "format": "prettier -w ./packages"
+    "format": "prettier -w ./packages",
+    "prepare": "husky install"
   },
   "author": "",
   "license": "MIT",
@@ -28,6 +29,7 @@
     "@types/jest": "^28.1.7",
     "esbuild": "^0.15.5",
     "esbuild-jest": "^0.5.0",
+    "husky": "^8.0.1",
     "turbo": "^1.4.5"
   }
 }

packages/typescript-node/docs-theme/index.tsx

@@ -50,7 +50,7 @@ export class MiroThemeContext extends DefaultThemeRenderContext {
           title: 'Options',
           url: 'classes/index.Options.html',
         },
-        { title: 'Storage' },
+        {title: 'Storage'},
       ]
 
       const Navigation = ({items}: {items: Item[]}) => {

packages/typescript-node/docs/implementing-storage.md

@@ -13,7 +13,6 @@ In this example we implement a storage that is using Redis as a backend. We use
 const redis = require('redis')
 
 class RedisStorage {
-
   // This method will initiate a connection to redis
   // On subsequent calls it will return the same redis connection
   async _getClient() {
@@ -51,7 +50,7 @@ This class can then be used in the Miro constructor by passing it as a parameter
 
 ```javascript
 const miro = new Miro({
-  storage: new RedisStorage()
+  storage: new RedisStorage(),
 })
 ```
 
@@ -63,13 +62,10 @@ When using express framework with the session middleware, we can reuse the sessi
 // Setup session middlware before: app.use(session({...}))
 
 app.use((req, res, next) => {
-
   // Create a separate Miro instance for each request
   req.miro = new Miro({
-
     // Define storage implementation inline
     storage: {
-
       // Load Miro state from the session object (if any)
       get(_userId) {
         return req.session.state
@@ -78,8 +74,8 @@ app.use((req, res, next) => {
       // Store Miro state in the session object
       set(_userId, state) {
         req.session.state = state
-      }
-    }
+      },
+    },
   })
 
   next()

packages/typescript-node/docs/quickstart-auth.md

@@ -1,35 +1,38 @@
+# Miro Node.js client quick start guide with OAuth 2.0 and Express
+
+Build a simple app based on the Miro Node.js client library, the OAuth 2.0 code grant flow, and the Express JavaScript web framework.
+
 ## Goal
 
 This quick start guide helps you familiarize yourself with the [Miro REST API 2.0](https://developers.miro.com/reference/api-reference) and the [OAuth 2.0 authorization code grant flow](https://www.oauth.com/oauth2-servers/server-side-apps/authorization-code/) by building a simple app that uses the Miro Node.js client library.
 
 The guide also walks you through setting up a web server based on the [Express](https://expressjs.com/) framework. Express uses the Miro Node.js client library to implement authorization and token management for users.
 
-At the end of the guide, you'll have built a simple app that prompts users for installation (this triggers the OAuth authorization flow), and then prints a list of all the boards the current user has access to.
+At the end of the guide, you'll have built a simple app that prompts users for installation )this triggers the OAuth authorization flow), and then prints a list of all the boards the current user has access to.
 
 ## Prerequisites
 
 Before you begin, make sure that:
 
 - You have a [Miro account](https://miro.com/signup/).
 - You're [signed in to Miro](https://miro.com/login/).
-- Your Miro account has a [Developer team](https://developers.miro.com/docs/create-a-developer-team).
+- Your Miro account has a [Developer team](https://developers.miro.com/docs/rest-api-build-your-first-hello-world-app#step-1-create-a-developer-team-in-miro).
 - Your development environment includes [Node.js 14.15 or a later version](https://nodejs.org/en/download/). \
   To check the Node.js version on your system:
   1. Open a terminal session.
   2. In the terminal, run `node --version`.
 
-It's a good idea to already go through the following steps in your Miro account settings:
+It's a good to already go through the following steps in your Miro account settings:
 
-1. [Create your app in Miro](https://developers.miro.com/docs/rest-api-build-your-first-hello-world-app#step-1-create-your-app-in-miro)
-2. [Configure your app in Miro](https://developers.miro.com/docs/rest-api-build-your-first-hello-world-app#step-2-configure-your-app-in-miro)
+1. [Create your app in Miro](https://developers.miro.com/docs/rest-api-build-your-first-hello-world-app#step-2-create-your-app-in-miro)
+2. [Configure your app in Miro](https://developers.miro.com/docs/rest-api-build-your-first-hello-world-app#step-3-configure-your-app-in-miro)
 3. In your app settings, go to **Redirect URI for OAuth2.0**; in the input field, enter the following URL: `http://127.0.0.1:4000/auth/miro/callback`; click **Add** to add it to the app [redirect URI list](https://www.oauth.com/oauth2-servers/redirect-uris/).
 4. In your app settings, go to **App Credentials**, and save the values assigned to **Client ID** and **Client secret**. \
    You'll need to use these values later.
 
 ## Build the app
 
 After configuring the options in the previous section, you can start building the app.
-
 ### Step 1: create the project directory
 
 1. Open a terminal session.
@@ -54,14 +57,14 @@ npm init -y
 Install the Miro Node.js client library, the Express web framework, and its dependencies:
 
 ```bash
-npm install @mirohq/miro-api express express-session
+npm install @mirohq/miro-node express express-session
 ```
 
 ### Step 4: import and initialize dependencies
 
 Now it's time to take care of the initial setup of your project:
 
-- Create an `index.js` file.
+- Create the `index.js` file.
 - Import the dependencies that the app needs to run.
 - Initialize the imported resources.
 
@@ -70,7 +73,7 @@ Now it's time to take care of the initial setup of your project:
 To work with the Miro Node.js client library and the Express web framework, you need to import and initialize the corresponding libraries:
 
 ```javascript
-const {Miro} = require('@mirohq/miro-api')
+const {Miro} = require('@mirohq/miro-node')
 const express = require('express')
 const session = require('express-session')
 ```
@@ -100,14 +103,10 @@ app.use(
 )
 ```
 
-> 🚧
->
-> In production deployments, replace the secret with a randomly generated string.
+⚠️ In production deployments, replace the secret with a randomly generated string. ⚠️
 
-> 📘
->
-> For the sake of simplicity, the quick start guide identifies users with session IDs.
-> In production deployments, use actual user IDs, separate from session IDs. This avoids repeatedly prompting users to reinstall the app that they already installed in a previous, different session.
+ℹ️ For the sake of simplicity, the quick start guide identifies users with session IDs. \
+In production deployments, use actual user IDs, separate from session IDs. This avoids repeatedly prompting users to reinstall the app that they already installed in a previous, different session. ℹ️
 
 ### Step 5: redirect new users to the authorization page
 
@@ -203,13 +202,13 @@ Then, execute `index.js` with Node.js to start the app:
 node index.js
 ```
 
-To verify that the app is running, open [http://127.0.0.1:4000](http://127.0.0.1:4000) in a web browser.
+To verify that the app is running, open http://127.0.0.1:4000 in a web browser.
 
 ## Complete example
 
 ```javascript
 const express = require('express')
-const {Miro} = require('@mirohq/miro-api')
+const {Miro} = require('@mirohq/miro-node')
 const session = require('express-session')
 
 const miro = new Miro()
@@ -249,9 +248,3 @@ app.get('/auth/miro/callback', async (req, res) => {
 
 app.listen(4000, () => console.log('Started server on http://127.0.0.1:4000'))
 ```
-
-## See also
-
-- [`Miro` object reference documentation](https://miroapp.github.io/api-clients/classes/index.Miro.html)
-- [`MiroApi` object reference documentation](https://miroapp.github.io/api-clients/classes/index.MiroApi.html)
-- [`Storage` interface reference documentation](https://miroapp.github.io/api-clients/interfaces/index._internal_.Storage.html)

packages/typescript-node/index.ts

@@ -1,7 +1,7 @@
 import assert from 'assert'
 import fetch from 'node-fetch'
 import {HttpError, Logger, MiroApi as MiroLowlevelApi} from './api'
-import { InMemoryStorage, Storage } from './storage'
+import {InMemoryStorage, Storage} from './storage'
 
 const defaultBasePath = 'https://api.miro.com'
 

packages/typescript-node/storage.ts

@@ -1,4 +1,4 @@
-import { ExternalUserId } from './index'
+import {ExternalUserId} from './index'
 
 export type Awaitable<T> = Promise<T> | T
 
@@ -15,7 +15,7 @@ export interface Storage {
 }
 
 export class InMemoryStorage implements Storage {
-  storage: Record<string, State|undefined>
+  storage: Record<string, State | undefined>
 
   constructor() {
     this.storage = {}
@@ -25,8 +25,7 @@ export class InMemoryStorage implements Storage {
     return this.storage[userId]
   }
 
-  async set(userId: ExternalUserId, state: State|undefined) {
+  async set(userId: ExternalUserId, state: State | undefined) {
     this.storage[userId] = state
   }
 }
-

yarn.lock

@@ -2622,6 +2622,11 @@ human-signals@^2.1.0:
   resolved "https://registry.yarnpkg.com/human-signals/-/human-signals-2.1.0.tgz#dc91fcba42e4d06e4abaed33b3e7a3c02f514ea0"
   integrity sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==
 
+husky@^8.0.1:
+  version "8.0.1"
+  resolved "https://registry.yarnpkg.com/husky/-/husky-8.0.1.tgz#511cb3e57de3e3190514ae49ed50f6bc3f50b3e9"
+  integrity sha512-xs7/chUH/CKdOCs7Zy0Aev9e/dKOMZf3K1Az1nar3tzlv0jfqnYtu235bstsWTmXOR0EfINrPa97yy4Lz6RiKw==
+
 [email protected], iconv-lite@^0.4.24:
   version "0.4.24"
   resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b"