Merge pull request #1 from team-plain/clean-up

Add prettier, dependencies and various other clean-up

.github/workflows/lint.yaml

@@ -0,0 +1,48 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - uses: pnpm/action-setup@v2
+        name: Install pnpm
+        with:
+          version: 8
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - uses: actions/cache@v3
+        name: Setup pnpm cache
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Install deps
+        run: pnpm i
+
+      - name: Lint
+        run: pnpm run lint

.gitignore

@@ -0,0 +1,13 @@
+node_modules
+
+# Misc
+.DS_Store
+
+# Debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log
+
+# We use pnpm and not npm
+package-lock.json

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "printWidth": 100,
+  "trailingComma": "es5",
+  "singleQuote": true,
+  "tabWidth": 2
+}

_snippets/typescript-sdk/create-attachment-url-response.mdx

@@ -5,7 +5,11 @@
     "__typename": "Attachment",
     "id": "att_01H3970W7XG1716AVNGQ6FWYGD",
     "fileName": "the-filename.jpeg",
-    "fileSize": { "__typename": "FileSize", "kiloBytes": 32.32, "megaBytes": 0.03 },
+    "fileSize": {
+      "__typename": "FileSize",
+      "kiloBytes": 32.32,
+      "megaBytes": 0.03
+    },
     "fileExtension": null,
     "updatedAt": {
       "__typename": "DateTime",

_snippets/typescript-sdk/get-customer-by-id.mdx

@@ -3,7 +3,9 @@ const client = new PlainClient({
   apiKey: 'XXX',
 });
 
-const res = await client.getCustomerById({ customerId: 'c_01H14DFQ4PDYBH398J1E99TWSS' });
+const res = await client.getCustomerById({
+  customerId: 'c_01H14DFQ4PDYBH398J1E99TWSS',
+});
 
 if (res.error) {
   console.error(res.error);

_snippets/typescript-sdk/page-info-after.mdx

@@ -11,6 +11,9 @@ if (firstPage.error) {
   console.error(firstPage.error);
 } else {
   const { pageInfo } = firstPage.data;
-  const secondPage = await client.getCustomers({ after: pageInfo.endCursor, first: 50 });
+  const secondPage = await client.getCustomers({
+    after: pageInfo.endCursor,
+    first: 50,
+  });
 }
 ```

_snippets/typescript-sdk/remove-labels.mdx

@@ -3,7 +3,9 @@ import { PlainClient } from '@team-plain/typescript-sdk';
 
 const client = new PlainClient({ apiKey: 'plainApiKey_xxx' });
 
-const res = await client.removeLabels({ labelIds: ['l_01HD428Y1TREH5KTXP019K6FPK'] });
+const res = await client.removeLabels({
+  labelIds: ['l_01HD428Y1TREH5KTXP019K6FPK'],
+});
 
 if (res.error) {
   console.error(res.error);

_snippets/typescript-sdk/upsert-customer-response.mdx

@@ -7,7 +7,11 @@
     "fullName": "Donald Duck",
     "shortName": "Donald",
     "externalId": "c_123",
-    "email": { "email": "[email protected]", "isVerified": false, "verifiedAt": null },
+    "email": {
+      "email": "[email protected]",
+      "isVerified": false,
+      "verifiedAt": null
+    },
     "status": "IDLE",
     "statusChangedAt": {
       "__typename": "DateTime",

package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@team-plain/docs-mintlify",
+  "version": "1.0.0",
+  "description": "Documentation for plain.com",
+  "main": "index.js",
+  "engines": {
+    "node": "18.x",
+    "pnpm": "8.x"
+  },
+  "scripts": {
+    "dev": "mintlify dev",
+    "lint": "prettier --check './**/*.{js,ts,tsx,md,mdx}'"
+  },
+  "dependencies": {
+    "mintlify": "^4.0.58",
+    "prettier": "^3.1.0"
+  }
+}

pages/attachments.mdx

@@ -1,5 +1,5 @@
 ---
-title: "File Attachments"
+title: 'File Attachments'
 description: "When using Plain's API to send emails or [create threads](/graphql/threads/create), you can add file attachments."
 ---
 
@@ -25,18 +25,19 @@ To try this, you will need an [API key](/graphql/authentication/) with the follo
 
     <Tabs>
         <Tab title="Typescript SDK">
+
 ```typescript
 import { AttachmentType, PlainClient } from '@team-plain/typescript-sdk';
- 
+
 const client = new PlainClient({ apiKey: 'XXX' });
- 
+
 const res = await client.createAttachmentUploadUrl({
   customerId: 'c_XXXXXXXXXXXXXXXXXXXXXXXXXX',
   fileName: 'the-filename.jpeg',
   fileSizeBytes: 32318,
   attachmentType: AttachmentType.CustomTimelineEntry,
 });
- 
+
 if (res.error) {
   console.error(res.error);
 } else {
@@ -54,7 +55,11 @@ if (res.error) {
     "__typename": "Attachment",
     "id": "att_01H3970W7XG1716AVNGQ6FWYGD",
     "fileName": "the-filename.jpeg",
-    "fileSize": { "__typename": "FileSize", "kiloBytes": 32.32, "megaBytes": 0.03 },
+    "fileSize": {
+      "__typename": "FileSize",
+      "kiloBytes": 32.32,
+      "megaBytes": 0.03
+    },
     "fileExtension": null,
     "updatedAt": {
       "__typename": "DateTime",
@@ -101,6 +106,7 @@ if (res.error) {
   }
 }
 ```
+
         </Tab>
 
         <Tab title="GraphQL">
@@ -144,6 +150,7 @@ Variables
   }
 }
 ```
+
 ```json Response
 {
   "data": {
@@ -193,6 +200,7 @@ Variables
 
         </Tab>
     </Tabs>
+
   </Step>
   <Step title="Uploading the attachment">
     In the `AttachmentUploadUrl` we created in the previous step we get back 2 fields which are needed to actually upload our attachment:
@@ -206,6 +214,7 @@ Variables
 
     <Tabs>
         <Tab title="Browser">
+
 ```typescript
 /**
  * Upload an attachment.
@@ -219,12 +228,12 @@ function uploadAttachment(fileBlob, uploadFormUrl, uploadFormData) {
   uploadFormData.forEach(({ key, value }) => {
     form.append(key, value);
   });
- 
+
   const file = new File([fileBlob], 'file');
   form.append('file', file);
- 
+
   console.log(`Uploading attachment to ${uploadFormUrl}`);
- 
+
   fetch(uploadFormUrl, {
     method: 'POST',
     body: form,
@@ -240,12 +249,14 @@ function uploadAttachment(fileBlob, uploadFormUrl, uploadFormData) {
     });
 }
 ```
+
         </Tab>
         <Tab title="Node">
+
 ```typescript
 const axios = require('axios');
 const FormData = require('form-data');
- 
+
 /**
  * Upload an attachment.
  *
@@ -258,11 +269,11 @@ function uploadAttachment(fileBuffer, uploadFormUrl, uploadFormData) {
   uploadFormData.forEach(({ key, value }) => {
     form.append(key, value);
   });
- 
+
   form.append('file', fileBuffer, { filename: 'file' });
- 
+
   console.log(`Uploading attachment to ${uploadFormUrl}`);
- 
+
   axios
     .post(uploadFormUrl, form, {
       headers: {
@@ -281,12 +292,13 @@ function uploadAttachment(fileBuffer, uploadFormUrl, uploadFormData) {
     });
 }
 ```
+
         </Tab>
     </Tabs>
+
   </Step>
 </Steps>
 
-
 ## Limitations
 
 - On emails and custom timeline entries:

pages/contact-forms-setup.mdx

@@ -1,6 +1,6 @@
 ---
-title: "Contact forms"
-description: "Contact forms are the best way to offer support at scale. With contact forms, you can pre-triage every support request so that when you know exactly what to prioritize in Plain."
+title: 'Contact forms'
+description: 'Contact forms are the best way to offer support at scale. With contact forms, you can pre-triage every support request so that when you know exactly what to prioritize in Plain.'
 ---
 
 Plain **does not** provide any UI components or a drop-in script tag. Instead, you use your own UI components and then use Plain's API.

pages/customer-cards-setup.mdx

@@ -1,6 +1,6 @@
 ---
-title: "Customer Cards"
-description: "Customer Cards are a powerful feature in Plain that let you show information from your own systems while looking at a customer in Plain. This makes sure you always have important context when helping customers."
+title: 'Customer Cards'
+description: 'Customer Cards are a powerful feature in Plain that let you show information from your own systems while looking at a customer in Plain. This makes sure you always have important context when helping customers.'
 ---
 
 <Frame>

pages/customer-cards.mdx

@@ -1,7 +1,7 @@
 ---
-title: "Customer Cards"
-sidebarTitle: "Overview"
-description: "Customer Cards are a powerful feature in Plain that let you show information from your own systems while looking at a customer in Plain. This makes sure you always have important context when helping customers."
+title: 'Customer Cards'
+sidebarTitle: 'Overview'
+description: 'Customer Cards are a powerful feature in Plain that let you show information from your own systems while looking at a customer in Plain. This makes sure you always have important context when helping customers.'
 ---
 
 ## How it works

pages/customer-cards/documentation.mdx

@@ -1,6 +1,6 @@
 ---
-title: "Customer Cards Documentation"
-description: "This page is intended for a technical audience that will be implementing a Customer Card API."
+title: 'Customer Cards Documentation'
+description: 'This page is intended for a technical audience that will be implementing a Customer Card API.'
 ---
 
 Check out the [Customer Cards](/pages/customer-cards) page for an overview.

pages/customer-cards/examples.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Examples"
-icon: "link"
-url: "https://github.com/team-plain/example-customer-cards"
----
+title: 'Examples'
+icon: 'link'
+url: 'https://github.com/team-plain/example-customer-cards'
+---

pages/customer-cards/playground.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Playground"
-icon: "link"
-url: "https://app.plain.com/developer/customer-cards-playground/"
+title: 'Playground'
+icon: 'link'
+url: 'https://app.plain.com/developer/customer-cards-playground/'
 ---

pages/email-setup.mdx

@@ -1,14 +1,22 @@
 ---
-title: "Setting up email"
+title: 'Setting up email'
 ---
 
 Setting up email requires you to complete two steps:
 
 <CardGroup cols={2}>
-  <Card title="Receiving emails in Plain" icon="inbox-in" iconType="duotone" href="/pages/email-setup/receiving-emails">
-  </Card>
-  <Card title="Sending emails from Plain" icon="paper-plane-top" iconType="duotone" href="/pages/email-setup/sending-emails">
-  </Card>
+  <Card
+    title="Receiving emails in Plain"
+    icon="inbox-in"
+    iconType="duotone"
+    href="/pages/email-setup/receiving-emails"
+  ></Card>
+  <Card
+    title="Sending emails from Plain"
+    icon="paper-plane-top"
+    iconType="duotone"
+    href="/pages/email-setup/sending-emails"
+  ></Card>
 </CardGroup>
 
 If you follow this guide, bear in mind that: