Merge pull request #1 from ably/refactor/major-ui-overhaul

Refactor/major UI overhaul

Author: splindsay-92

.env.example

@@ -0,0 +1 @@
+VITE_ABLY_API_KEY=

.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    labels: [ ] # prevent the default `dependencies` label from being added to pull requests
+    groups:
+      simple:
+        applies-to: version-updates
+        update-types:
+          - "minor"
+          - "patch"
+      upgrades:
+        applies-to: version-updates
+        update-types:
+          - "major"
+      securityUpdates:
+        applies-to: security-updates
+        update-types:
+          - "minor"
+          - "major"
+          - "patch"

.github/workflows/dev.yml

@@ -0,0 +1,88 @@
+name: Build and test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+env:
+  BASE_NODE_VERSION: 24
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ env.BASE_NODE_VERSION }}
+      - run: npm ci
+      - run: npm audit --production
+  format-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ env.BASE_NODE_VERSION }}
+      - run: npm ci
+      - run: npm run format:check
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ env.BASE_NODE_VERSION }}
+      - run: npm ci
+      - run: npm run lint
+  test-typescript:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ env.BASE_NODE_VERSION }}
+      - run: npm ci
+      - run: npm run test:typescript
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [18, 20, 22, 24]
+    name: test node ${{ matrix.node-version }}
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run test
+        name: test
+        if: ${{ matrix.node-version != env.BASE_NODE_VERSION }}
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ env.BASE_NODE_VERSION }}
+      - run: npm ci
+      - run: npm run build

.github/workflows/release.yml

@@ -0,0 +1,27 @@
+name: Release packages
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: 'write'
+      id-token: 'write'
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: true
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '20.10.0'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies and publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          npm ci
+          npm run build
+          npm publish --provenance --access public

.gitignore

@@ -7,7 +7,11 @@ yarn-debug.log*
 yarn-error.log*
 /.pnp
 .pnp.js
+.env
 
 .vscode/*
 /.idea/
 /dist/
+
+*storybook.log
+storybook-static

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "ably-common"]
+	path = ably-common
+	url = [email protected]:ably/ably-common.git

.storybook/main.ts

@@ -0,0 +1,34 @@
+import type { StorybookConfig } from '@storybook/react-vite';
+import * as path from 'node:path';
+
+const config: StorybookConfig = {
+  stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
+  addons: ['@storybook/addon-onboarding', '@storybook/addon-docs'],
+  framework: {
+    name: '@storybook/react-vite',
+    options: {},
+  },
+  typescript: {
+    reactDocgen: 'react-docgen-typescript',
+    reactDocgenTypescriptOptions: {
+      shouldExtractLiteralValuesFromEnum: true,
+      propFilter: (prop) => (prop.parent ? !/node_modules/.test(prop.parent.fileName) : true),
+    },
+  },
+  docs: {
+    docsMode: true,
+  },
+  async viteFinal(originalConfig) {
+    return {
+      ...originalConfig,
+      resolve: {
+        ...originalConfig.resolve,
+        alias: {
+          ...(originalConfig.resolve?.alias ?? {}),
+          '@ably/chat/react': path.resolve(__dirname, 'mocks/mock-ably-chat.ts'),
+        },
+      },
+    };
+  },
+};
+export default config;