Setup CI integration tests

.github/workflows/build-test.yml

@@ -0,0 +1,52 @@
+name: Build and test
+on: [push, pull_request]
+env:
+  CI: true
+jobs:
+  build:
+    name: Build, lint, and test on Node ${{ matrix.node }} and ${{ matrix.os }}
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        node: [20, 22]
+        os: [ubuntu-latest, macOS-latest]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Use Node ${{ matrix.node }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install pnpm
+        id: pnpm-install
+        uses: pnpm/action-setup@v3
+        with:
+          version: 9.3.0
+          run_install: false
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies and build
+        run: pnpm install --frozen-lockfile
+
+      - name: Lint
+        run: pnpm run lint:ci
+
+      - name: Test
+        run: pnpm run test:ci

.github/workflows/integration-test.yml

@@ -0,0 +1,53 @@
+name: Integration tests
+on: [pull_request]
+env:
+  CI: true
+jobs:
+  test:
+    name: Run integration tests
+    runs-on: ubuntu-latest
+
+    services:
+      ceramic:
+        image: public.ecr.aws/r5b3e0r5/3box/ceramic-one:latest
+        env:
+          CERAMIC_ONE_BIND_ADDRESS: 0.0.0.0:5001
+          CERAMIC_ONE_NETWORK: in-memory
+          CERAMIC_ONE_STORE_DIR: /
+        ports:
+          - 5001:5001
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install pnpm
+        id: pnpm-install
+        uses: pnpm/action-setup@v3
+        with:
+          version: 9.3.0
+          run_install: false
+
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: pnpm-store
+
+      - name: Install dependencies and build
+        run: pnpm install --frozen-lockfile
+
+      - name: Test
+        run: cd tests/c1-integration && pnpm run test

.gitignore

@@ -1,3 +1,5 @@
 node_modules
 dist
-.vscode
+coverage
+.vscode
+.turbo

.swcrc

@@ -1,8 +1,13 @@
 {
   "jsc": {
     "parser": {
-      "syntax": "typescript"
+      "syntax": "typescript",
+      "decorators": true
     },
-    "target": "es2022"
+    "target": "es2022",
+    "transform": {
+      "legacyDecorator": true,
+      "decoratorMetadata": true
+    }
   }
 }

biome.json

@@ -1,13 +1,13 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.7.1/schema.json",
+  "$schema": "https://biomejs.dev/schemas/1.8.0/schema.json",
   "organizeImports": {
     "enabled": true,
-    "ignore": ["lib/**"]
+    "ignore": []
   },
   "formatter": {
     "enabled": true,
     "formatWithErrors": false,
-    "ignore": ["lib/**"],
+    "ignore": [],
     "indentStyle": "space",
     "lineWidth": 80
   },
@@ -17,14 +17,19 @@
       "quoteProperties": "asNeeded",
       "quoteStyle": "single",
       "semicolons": "asNeeded",
-      "trailingComma": "all"
+      "trailingCommas": "all"
     }
   },
   "linter": {
     "enabled": true,
-    "ignore": ["lib/**"],
+    "ignore": [],
     "rules": {
       "recommended": true
     }
+  },
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
   }
 }

package.json

@@ -1,15 +1,29 @@
 {
   "name": "ceramic-sdk",
   "private": true,
+  "packageManager": "[email protected]",
   "scripts": {
-    "lint": "biome check --apply packages/*"
+    "build": "pnpm --filter \"@ceramic-sdk/*\" build:types && turbo run build:js",
+    "lint": "biome check --write packages/* tests/*",
+    "lint:ci": "biome ci packages/* tests/*",
+    "test": "turbo run test -- --passWithNoTests",
+    "test:ci": "turbo run test:ci -- --passWithNoTests"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.7.1",
-    "@swc/cli": "^0.3.12",
-    "@swc/core": "^1.5.0",
-    "@types/node": "^20.12.7",
+    "@biomejs/biome": "1.8.2",
+    "@jest/globals": "^29.7.0",
+    "@swc/cli": "^0.3.14",
+    "@swc/core": "^1.6.5",
+    "@swc/jest": "^0.2.36",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.14.8",
     "del-cli": "^5.1.0",
-    "typescript": "^5.4.5"
+    "jest": "^29.7.0",
+    "tsx": "^4.15.7",
+    "turbo": "^2.0.5",
+    "typescript": "^5.5.2"
+  },
+  "pnpm": {
+    "overrides": {}
   }
 }

packages/document-client/LICENSE-APACHE

@@ -0,0 +1,5 @@
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

packages/document-client/LICENSE-MIT

@@ -0,0 +1,19 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

packages/document-client/README.md

@@ -0,0 +1,5 @@
+# Ceramic Document stream client
+
+## License
+
+Dual licensed under MIT and Apache 2

packages/document-client/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@ceramic-sdk/document-client",
+  "version": "0.1.0",
+  "author": "3Box Labs",
+  "license": "(Apache-2.0 OR MIT)",
+  "keywords": ["ceramic", "stream", "document", "client"],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ceramicstudio/ceramic-sdk",
+    "directory": "packages/document-client"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": ["dist"],
+  "engines": {
+    "node": ">=20"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build:clean": "del dist",
+    "build:js": "swc src -d ./dist --config-file ../../.swcrc --strip-leading-paths",
+    "build:types": "tsc --project tsconfig.json --emitDeclarationOnly --skipLibCheck",
+    "build": "pnpm build:clean && pnpm build:types && pnpm build:js",
+    "lint": "eslint src --fix",
+    "test": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js",
+    "test:ci": "pnpm run test --ci --coverage",
+    "prepare": "pnpm build",
+    "prepublishOnly": "package-check"
+  },
+  "dependencies": {
+    "@ceramic-sdk/document-protocol": "workspace:^",
+    "@ceramic-sdk/events": "workspace:^",
+    "@didtools/codecs": "^3.0.0",
+    "fast-json-patch": "^3.1.1"
+  },
+  "devDependencies": {
+    "@ceramic-sdk/identifiers": "workspace:^",
+    "@ceramic-sdk/key-did": "workspace:^",
+    "dids": "^5.0.2",
+    "uint8arrays": "^5.1.0"
+  },
+  "jest": {
+    "extensionsToTreatAsEsm": [".ts"],
+    "moduleNameMapper": {
+      "^(\\.{1,2}/.*)\\.js$": "$1"
+    },
+    "transform": {
+      "^.+\\.(t|j)s$": [
+        "@swc/jest",
+        {
+          "root": "../.."
+        }
+      ]
+    }
+  }
+}