SK-2778: Add contract testing via api-extractor snapshot

.github/workflows/contract-tests.yml

@@ -0,0 +1,41 @@
+name: Contract Tests
+
+on:
+  pull_request:
+    branches:
+      - main
+      - release/*
+
+jobs:
+  contract-tests:
+    name: Contract Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      # Builds the project, extracts every exported type/interface/class/method
+      # signature from the compiled .d.ts files, and compares against the
+      # committed snapshot in temp/skyflow-node.api.md.
+      # Fails if anything in the public API surface has changed — renamed class,
+      # renamed method, changed parameter type, removed export, etc.
+      - name: Verify API surface snapshot
+        run: npm run contract-snapshot-verify
+
+      - name: Upload API surface report on failure
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: api-surface-report
+          path: api-report/skyflow-node.api.md
+          retention-days: 7

api-extractor.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+  "projectFolder": ".",
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
+  "bundledPackages": [],
+  "compiler": {
+    "tsconfigFilePath": "<projectFolder>/tsconfig.json"
+  },
+  "apiReport": {
+    "enabled": true,
+    "reportFolder": "<projectFolder>/api-report/",
+    "reportTempFolder": "<projectFolder>/api-report/",
+    "reportFileName": "<unscopedPackageName>.api.md"
+  },
+  "docModel": {
+    "enabled": false
+  },
+  "dtsRollup": {
+    "enabled": false
+  },
+  "tsdocMetadata": {
+    "enabled": false
+  },
+  "messages": {
+    "compilerMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      }
+    },
+    "extractorMessageReporting": {
+      "default": {
+        "logLevel": "warning"
+      },
+      "ae-missing-release-tag": {
+        "logLevel": "none"
+      }
+    }
+  }
+}