TypeScript SDK for Exosphere

.github/workflows/publish-typescript-sdk.yml

@@ -0,0 +1,183 @@
+name: Build & publish TypeScript SDK to npm
+
+on:
+ push: 
+ branches:
+ - main
+ paths:
+ - "typescript-sdk/**"
+ - ".github/workflows/publish-typescript-sdk.yml"
+ release:
+ types: [published]
+ workflow_dispatch:
+
+permissions:
+ contents: write
+ id-token: write
+jobs:
+ test:
+ runs-on: ubuntu-latest
+ defaults:
+ run:
+ working-directory: typescript-sdk
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: '20'
+ cache: 'npm'
+ cache-dependency-path: typescript-sdk/package-lock.json
+
+ - name: Install dependencies
+ run: npm ci
+
+ - name: Run TypeScript compilation
+ run: npm run build
+
+ - name: Run tests
+ run: npm run test:run
+
+ - name: Run test coverage
+ run: npm run test:coverage
+
+ - name: Upload coverage reports to Codecov
+ uses: codecov/codecov-action@v5
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
+ slug: exospherehost/exospherehost
+ files: typescript-sdk/coverage/lcov.info
+ flags: typescript-sdk-unittests
+ name: typescript-sdk-coverage-report
+ fail_ci_if_error: true
+
+ - name: Upload test results
+ uses: actions/upload-artifact@v4
+ if: always()
+ with:
+ name: typescript-sdk-test-results
+ path: typescript-sdk/coverage/
+ retention-days: 30
+
+ publish:
+ runs-on: ubuntu-latest
+ needs: test
+ defaults:
+ run:
+ working-directory: typescript-sdk
+ if: github.repository == 'exospherehost/exospherehost'
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: '20'
+ cache: 'npm'
+ cache-dependency-path: typescript-sdk/package-lock.json
+ registry-url: 'https://registry.npmjs.org'
+
+ - name: Install dependencies
+ run: npm ci
+
+ - name: Build package
+ run: npm run build
+
+ - name: Check version for beta indicator
+ run: |
+ VERSION=$(node -p "require('./package.json').version")
+ if [[ "$VERSION" == *"b"* ]]; then
+ echo "Version $VERSION contains beta indicator - publishing to npm with beta tag"
+ echo "NPM_TAG=beta" >> $GITHUB_ENV
+ else
+ echo "Version $VERSION does not contain beta indicator - publishing to npm with latest tag"
+ echo "NPM_TAG=latest" >> $GITHUB_ENV
+ fi
+
+ - name: Generate SBOM with CycloneDX
+ run: |
+ npm install -g @cyclonedx/cyclonedx-npm
+ cyclonedx-npm --output-file sbom-cyclonedx.json
+ echo "Generated CycloneDX SBOM in JSON format"
+
+ - name: Run npm audit
+ run: |
+ npm audit --audit-level=moderate --json > vulnerability-report.json || true
+ echo "Generated vulnerability report (non-blocking)"
+
+ - name: Publish to npm
+ run: npm publish --tag ${{ env.NPM_TAG }} --access public
+ env:
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+ - name: Upload SBOM artifacts
+ uses: actions/upload-artifact@v4
+ with:
+ name: sbom-artifacts-typescript-sdk-${{ github.sha }}
+ path: |
+ typescript-sdk/sbom-cyclonedx.json
+ typescript-sdk/vulnerability-report.json
+ retention-days: 30
+
+ release:
+ runs-on: ubuntu-latest
+ needs: [test, publish]
+ if: github.event_name == 'release' && github.event.action == 'published'
+ defaults:
+ run:
+ working-directory: typescript-sdk
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Set up Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: '20'
+ cache: 'npm'
+ cache-dependency-path: typescript-sdk/package-lock.json
+ registry-url: 'https://registry.npmjs.org'
+
+ - name: Install dependencies
+ run: npm ci
+
+ - name: Build package
+ run: npm run build
+
+ - name: Publish to npm with latest tag
+ run: npm publish --tag latest --access public
+ env:
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+ - name: Create GitHub Release
+ uses: actions/create-release@v1
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ with:
+ tag_name: ${{ github.event.release.tag_name }}
+ release_name: ${{ github.event.release.name }}
+ body: |
+ ## TypeScript SDK Release ${{ github.event.release.tag_name }}
+
+ This release includes the TypeScript SDK for ExosphereHost.
+
+ ### Installation
+ ```bash
+ npm install exospherehost@${{ github.event.release.tag_name }}
+ ```
+
+ ### Changes
+ ${{ github.event.release.body }}
+
+ ### Package Information
+ - **Package Name**: exospherehost
+ - **Version**: ${{ github.event.release.tag_name }}
+ - **Registry**: https://www.npmjs.com/package/exospherehost
+ draft: false
+ prerelease: ${{ contains(github.event.release.tag_name, 'beta') || contains(github.event.release.tag_name, 'alpha') || contains(github.event.release.tag_name, 'rc') }}

typescript-sdk/.gitignore

@@ -0,0 +1,15 @@
+node_modules
+Dist
+dist
+node_modules/
+dist/
+# build cache / type info
+*.tsbuildinfo
+# coverage / vitest
+coverage/
+.vitest/
+.vite/
+# logs & OS junk
+npm-debug.log*
+yarn-error.log*
+.DS_Store