diff --git a/api/ts/README.md b/api/ts/README.md index e245da4..a85c22f 100644 --- a/api/ts/README.md +++ b/api/ts/README.md @@ -1,5 +1,7 @@ # Jetify API TypeScript Client +**Warning:** this client is currently in development and subject to change. + ## Usage ```bash diff --git a/api/ts/devbox.json b/api/ts/devbox.json index a8dfb96..49895d9 100644 --- a/api/ts/devbox.json +++ b/api/ts/devbox.json @@ -8,7 +8,12 @@ "scripts": { "build": "pnpm run build", "lint": "pnpm run lint", - "fmt": "pnpm run fmt" + "fmt": "pnpm run fmt", + "typecheck": "pnpm run typecheck", + // Run all checks before publishing the package + "check": "devbox run typecheck && devbox run lint && devbox run fmt", + // Publish the package to the npm registry. Access token is required. + "publish": "devbox run check && pnpm publish --access public $@", } } } diff --git a/api/ts/examples/create-sandbox/package.json b/api/ts/examples/create-sandbox/package.json index 70a5836..b63450a 100644 --- a/api/ts/examples/create-sandbox/package.json +++ b/api/ts/examples/create-sandbox/package.json @@ -14,6 +14,6 @@ "@bufbuild/protobuf": "^1.10.0", "@connectrpc/connect": "^1.4.0", "@connectrpc/connect-web": "^1.4.0", - "@jetify/client": "link:../../dist" + "@jetify/client": "0.1.0-dev" } } diff --git a/api/ts/examples/create-sandbox/pnpm-lock.yaml b/api/ts/examples/create-sandbox/pnpm-lock.yaml index 5b8696b..393648c 100644 --- a/api/ts/examples/create-sandbox/pnpm-lock.yaml +++ b/api/ts/examples/create-sandbox/pnpm-lock.yaml @@ -15,8 +15,8 @@ dependencies: specifier: ^1.4.0 version: 1.4.0(@bufbuild/protobuf@1.10.0)(@connectrpc/connect@1.4.0) '@jetify/client': - specifier: link:../../dist - version: link:../../dist + specifier: 0.1.0-dev + version: 0.1.0-dev packages: @@ -41,3 +41,12 @@ packages: dependencies: '@bufbuild/protobuf': 1.10.0 dev: false + + /@jetify/client@0.1.0-dev: + resolution: {integrity: sha512-DQfArQy3JwKWc83wL1ae1PvQfd6sSWGJmaEaFPNMwJHFJU3kY0+v/7JBln8SC4ISSUN0GblTISdvKSw9EB+W5A==} + engines: {node: '>=18'} + dependencies: + '@bufbuild/protobuf': 1.10.0 + '@connectrpc/connect': 1.4.0(@bufbuild/protobuf@1.10.0) + '@connectrpc/connect-web': 1.4.0(@bufbuild/protobuf@1.10.0)(@connectrpc/connect@1.4.0) + dev: false