@science-corporation/synapse 2.3.0 → 2.3.2

package/package.json

@@ -1,70 +1,70 @@
-{
-  "name": "@science-corporation/synapse",
-  "version": "2.3.0",
-  "description": "Client library and CLI for the Synapse API",
-  "license": "Apache-2.0",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
-    },
-    "./browser": {
-      "types": "./dist/browser.d.ts",
-      "default": "./dist/browser.js"
-    }
-  },
-  "files": [
-    "dist",
-    "scripts",
-    "src",
-    "synapse-api"
-  ],
-  "scripts": {
-    "build": "bash ./scripts/build.sh",
-    "clean": "rimraf dist src/api",
-    "dist": "npm run generate && npm run build",
-    "generate": "bash ./scripts/generate.sh",
-    "lint": "tsc --noEmit && eslint .",
-    "postinstall": "bash ./scripts/postinstall.sh && npm run dist",
-    "test": "tsc --noEmit && jest"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sciencecorp/synapse-typescript.git"
-  },
-  "author": {
-    "name": "Science Corporation",
-    "email": "team@science.xyz"
-  },
-  "bugs": {
-    "url": "https://github.com/sciencecorp/synapse-typescript/issues"
-  },
-  "homepage": "https://github.com/sciencecorp/synapse-typescript#readme",
-  "engines": {
-    "node": ">=18"
-  },
-  "devDependencies": {
-    "@eslint/compat": "^1.2.6",
-    "@types/jest": "^29.5.14",
-    "@typescript-eslint/eslint-plugin": "^8.23.0",
-    "@typescript-eslint/parser": "^8.23.0",
-    "eslint": "^9.5.0",
-    "eslint-import-resolver-typescript": "^3.7.0",
-    "eslint-plugin-import": "^2.31.0",
-    "jest": "^29.7.0",
-    "rimraf": "^5.0.5",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.5.2"
-  },
-  "dependencies": {
-    "@grpc/grpc-js": "^1.10.10",
-    "@grpc/proto-loader": "^0.7.13",
-    "google-protobuf": "^3.21.2",
-    "long": "^5.3.1",
-    "protobufjs-cli": "^1.1.3",
-    "tmp": "^0.2.5",
-    "yargs": "^17.7.2"
-  }
-}
+{
+  "name": "@science-corporation/synapse",
+  "version": "2.3.2",
+  "description": "Client library and CLI for the Synapse API",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./browser": {
+      "types": "./dist/browser.d.ts",
+      "default": "./dist/browser.js"
+    }
+  },
+  "files": [
+    "dist",
+    "scripts",
+    "src",
+    "synapse-api"
+  ],
+  "scripts": {
+    "build": "bash ./scripts/build.sh",
+    "clean": "rimraf dist src/api",
+    "dist": "npm run generate && npm run build",
+    "generate": "bash ./scripts/generate.sh",
+    "lint": "tsc --noEmit && eslint .",
+    "postinstall": "bash ./scripts/postinstall.sh && npm run dist",
+    "test": "tsc --noEmit && jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sciencecorp/synapse-typescript.git"
+  },
+  "author": {
+    "name": "Science Corporation",
+    "email": "team@science.xyz"
+  },
+  "bugs": {
+    "url": "https://github.com/sciencecorp/synapse-typescript/issues"
+  },
+  "homepage": "https://github.com/sciencecorp/synapse-typescript#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "devDependencies": {
+    "@eslint/compat": "^1.2.6",
+    "@types/jest": "^29.5.14",
+    "@typescript-eslint/eslint-plugin": "^8.23.0",
+    "@typescript-eslint/parser": "^8.23.0",
+    "eslint": "^9.5.0",
+    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-plugin-import": "^2.31.0",
+    "jest": "^29.7.0",
+    "rimraf": "^5.0.5",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.5.2"
+  },
+  "dependencies": {
+    "@grpc/grpc-js": "^1.10.10",
+    "@grpc/proto-loader": "^0.7.13",
+    "google-protobuf": "^3.21.2",
+    "long": "^5.3.1",
+    "protobufjs-cli": "^1.1.3",
+    "tmp": "^0.2.5",
+    "yargs": "^17.7.2"
+  }
+}

package/scripts/generate.sh

@@ -5,6 +5,16 @@ PROTOS=$(find ${PROTO_DIR} -name '*.proto' | sed "s|${PROTO_DIR}/||")
 
 mkdir -p ${PROTO_OUT_DIR}
 
+# Mirror synapse-api/VERSION into src/api_version.ts so the protocol
+# version is available as a constant in both node and browser builds.
+if [ -f "${PROTO_DIR}/VERSION" ]; then
+    SYNAPSE_API_VERSION=$(tr -d '[:space:]' < ${PROTO_DIR}/VERSION)
+    cat > ./src/api_version.ts <<EOF
+// Generated from synapse-api/VERSION by scripts/generate.sh. Do not edit.
+export const SYNAPSE_API_VERSION = "${SYNAPSE_API_VERSION}";
+EOF
+fi
+
 pbjs \
     -t json \
     -w es6 \

package/scripts/postinstall.sh

@@ -1,185 +1,185 @@
-#!/bin/bash
-
-# Platform detection
-IS_WINDOWS=false
-if [ "$OS" = "Windows_NT" ] || [ "$OSTYPE" = "msys" ] || [ "$OSTYPE" = "cygwin" ]; then
-    IS_WINDOWS=true
-fi
-
-# If running on Windows, ensure we're using bash
-if [ "$IS_WINDOWS" = true ]; then
-    if ! command -v bash >/dev/null 2>&1; then
-        echo "Error: bash is required to run this script on Windows"
-        exit 1
-    fi
-fi
-
-echo "Postinstall - downloading synapse-api"
-
-# If synapse-api directory already exists, skip download
-if [ -d "synapse-api" ]; then
-    echo " - synapse-api directory already exists, skipping download"
-    exit 0
-fi
-
-# If we have git, try to update the submodule
-HAS_GIT=false
-if command -v git >/dev/null 2>&1 && git rev-parse --git-dir >/dev/null 2>&1; then
-    HAS_GIT=true
-    echo " - Git detected, attempting to update submodule..."
-
-    if git submodule update --init synapse-api; then
-        echo " - Successfully updated synapse-api submodule"
-        exit 0
-    else
-        echo " - Failed to update submodule, falling back to download..."
-    fi
-fi
-
-# Else, fallback to downloading from github
-echo "Downloading synapse-api..."
-
-# Resolve which synapse-typescript ref to ask the GitHub API about, in order
-# of decreasing fidelity:
-#   1. git HEAD when there's a real working tree (most accurate).
-#   2. The SHA in $npm_package_resolved — npm exports this during install
-#      lifecycle scripts as `git+ssh://...#<sha>`. This is the one that
-#      makes `npm install git://...#<sha>` actually work, since during
-#      pacote's prepare phase the .git dir has been moved away and the
-#      package.json gitHead field has not yet been injected.
-#   3. package.json#gitHead — npm writes this after prepare completes, so
-#      it's available for downstream consumers reading an already-installed
-#      package, just not during the prepare phase itself.
-#   4. v$version tag, as a last resort for vanilla tarball installs after a
-#      release has tagged the version.
-REF_LIB=""
-if [ "$HAS_GIT" = true ]; then
-    REF_LIB=$(git rev-parse HEAD)
-fi
-
-if [ -z "$REF_LIB" ] && [ -n "$npm_package_resolved" ]; then
-    # Strip everything up to and including the last '#' to get the SHA.
-    CANDIDATE="${npm_package_resolved##*#}"
-    # Only accept if it looks like a SHA (40 hex chars). Anything else is
-    # probably a URL with no fragment, which would leave the var untouched.
-    if [ "${#CANDIDATE}" = 40 ] && [ -z "${CANDIDATE//[0-9a-f]/}" ]; then
-        REF_LIB="$CANDIDATE"
-        echo " - Using npm_package_resolved SHA for ref lookup"
-    fi
-fi
-
-if [ -z "$REF_LIB" ]; then
-    REF_LIB=$(node -e "const p=require('./package.json'); if (p.gitHead) process.stdout.write(p.gitHead);" 2>/dev/null)
-    if [ -n "$REF_LIB" ]; then
-        echo " - Using package.json gitHead for ref lookup"
-    fi
-fi
-
-if [ -z "$REF_LIB" ]; then
-    PKG_VERSION=$(node -p "require('./package.json').version")
-    if [ -z "$PKG_VERSION" ]; then
-        echo " - Failed to get version from package.json"
-        exit 1
-    fi
-    REF_LIB=v$PKG_VERSION
-fi
-
-echo "- Looking up synapse-api ref for synapse-typescript ref $REF_LIB"
-
-CURL_OPTS=()
-CURL_OPTS+=(-H "Accept: application/vnd.github+json")
-CURL_OPTS+=(-H "X-GitHub-Api-Version: 2022-11-28")
-if [ -n "$SCIENCE_CORPORATION_SYNAPSE_TOKEN" ]; then
-    echo " - Using GitHub token for authentication"
-    CURL_OPTS+=(-H "Authorization: Bearer $SCIENCE_CORPORATION_SYNAPSE_TOKEN")
-fi
-
-fetch_synapse_api_sha() {
-    local use_auth="$1"
-    local opts=(-H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28")
-    if [ "$use_auth" = "true" ] && [ -n "$SCIENCE_CORPORATION_SYNAPSE_TOKEN" ]; then
-        opts+=(-H "Authorization: Bearer $SCIENCE_CORPORATION_SYNAPSE_TOKEN")
-    fi
-    curl -s "${opts[@]}" "https://api.github.com/repos/sciencecorp/synapse-typescript/contents/synapse-api?ref=$REF_LIB"
-}
-
-echo " - Fetching synapse-api submodule info..."
-CURL_RESULT=$(fetch_synapse_api_sha "true")
-
-# Check for auth failure and retry without auth
-if echo "$CURL_RESULT" | grep -q '"Bad credentials"'; then
-    echo "   - Auth failed, retrying without authentication..."
-    CURL_RESULT=$(fetch_synapse_api_sha "false")
-fi
-
-if [ -z "$CURL_RESULT" ]; then
-    echo "   - Failed to fetch from GitHub API"
-    exit 1
-fi
-
-echo "   - Parsing SHA from response..."
-GREP_RESULT=$(echo "$CURL_RESULT" | grep -o '"sha":\s*"[^"]*"')
-if [ -z "$GREP_RESULT" ]; then
-    echo "   - Failed to find SHA in API response"
-    echo "   - API response: $CURL_RESULT"
-    exit 1
-fi
-
-REF_API=$(echo "${GREP_RESULT#*:}" | tr -d '[:space:]"')
-if [ -z "$REF_API" ]; then
-    echo "   - Failed to parse SHA from API response"
-    echo "   - API response: $CURL_RESULT"
-    exit 1
-fi
-
-echo "- Found synapse-api ref \"$REF_API\""
-
-# Create temp directory in a cross-platform way
-if [ "$IS_WINDOWS" = true ]; then
-    # Use a more reliable temp directory path on Windows
-    TMP_DIR="C:\\Users\\$USERNAME\\AppData\\Local\\Temp\\synapse-api-temp"
-    mkdir -p "$TMP_DIR"
-else
-    TMP_DIR=$(mktemp -d)
-fi
-
-# Download using curl or fallback to PowerShell on Windows if curl fails
-if ! curl -s -L "https://github.com/sciencecorp/synapse-api/archive/${REF_API}.zip" -o "$TMP_DIR/synapse-api.zip"; then
-    if [ "$IS_WINDOWS" = true ]; then
-        echo " - Curl failed, attempting download with PowerShell..."
-        powershell -Command "Invoke-WebRequest -Uri 'https://github.com/sciencecorp/synapse-api/archive/${REF_API}.zip' -OutFile '$TMP_DIR\\synapse-api.zip'"
-    else
-        echo " - Failed to download synapse-api"
-        exit 1
-    fi
-fi
-
-# Unzip in a cross-platform way
-if [ "$IS_WINDOWS" = true ]; then
-    if ! unzip -q "$TMP_DIR/synapse-api.zip" -d "$TMP_DIR" 2>/dev/null; then
-        echo " - Unzip failed, attempting with PowerShell..."
-        powershell -Command "Expand-Archive -Path '$TMP_DIR\\synapse-api.zip' -DestinationPath '$TMP_DIR' -Force"
-    fi
-else
-    if ! unzip -q "$TMP_DIR/synapse-api.zip" -d "$TMP_DIR"; then
-        echo " - Failed to unzip synapse-api"
-        exit 1
-    fi
-fi
-
-# Create directory and copy files in a cross-platform way
-mkdir -p synapse-api
-if [ "$IS_WINDOWS" = true ]; then
-    powershell -Command "Copy-Item -Path \"$TMP_DIR\\synapse-api-${REF_API}\\*\" -Destination \"synapse-api\\\" -Recurse -Force"
-else
-    cp -r "$TMP_DIR/synapse-api-${REF_API}/"* synapse-api/
-fi
-
-# Clean up temp files
-rm -rf "$TMP_DIR"
-
-if [ ! -f "synapse-api/README.md" ] || [ ! -f "synapse-api/COPYRIGHT" ] || [ ! -d "synapse-api/api" ]; then
-    echo " - Failed to download synapse-api - missing required files"
-    exit 1
-fi
-echo " - Successfully downloaded synapse-api ref \"$REF_API\""
+#!/bin/bash
+
+# Platform detection
+IS_WINDOWS=false
+if [ "$OS" = "Windows_NT" ] || [ "$OSTYPE" = "msys" ] || [ "$OSTYPE" = "cygwin" ]; then
+    IS_WINDOWS=true
+fi
+
+# If running on Windows, ensure we're using bash
+if [ "$IS_WINDOWS" = true ]; then
+    if ! command -v bash >/dev/null 2>&1; then
+        echo "Error: bash is required to run this script on Windows"
+        exit 1
+    fi
+fi
+
+echo "Postinstall - downloading synapse-api"
+
+# If synapse-api directory already exists, skip download
+if [ -d "synapse-api" ]; then
+    echo " - synapse-api directory already exists, skipping download"
+    exit 0
+fi
+
+# If we have git, try to update the submodule
+HAS_GIT=false
+if command -v git >/dev/null 2>&1 && git rev-parse --git-dir >/dev/null 2>&1; then
+    HAS_GIT=true
+    echo " - Git detected, attempting to update submodule..."
+
+    if git submodule update --init synapse-api; then
+        echo " - Successfully updated synapse-api submodule"
+        exit 0
+    else
+        echo " - Failed to update submodule, falling back to download..."
+    fi
+fi
+
+# Else, fallback to downloading from github
+echo "Downloading synapse-api..."
+
+# Resolve which synapse-typescript ref to ask the GitHub API about, in order
+# of decreasing fidelity:
+#   1. git HEAD when there's a real working tree (most accurate).
+#   2. The SHA in $npm_package_resolved — npm exports this during install
+#      lifecycle scripts as `git+ssh://...#<sha>`. This is the one that
+#      makes `npm install git://...#<sha>` actually work, since during
+#      pacote's prepare phase the .git dir has been moved away and the
+#      package.json gitHead field has not yet been injected.
+#   3. package.json#gitHead — npm writes this after prepare completes, so
+#      it's available for downstream consumers reading an already-installed
+#      package, just not during the prepare phase itself.
+#   4. v$version tag, as a last resort for vanilla tarball installs after a
+#      release has tagged the version.
+REF_LIB=""
+if [ "$HAS_GIT" = true ]; then
+    REF_LIB=$(git rev-parse HEAD)
+fi
+
+if [ -z "$REF_LIB" ] && [ -n "$npm_package_resolved" ]; then
+    # Strip everything up to and including the last '#' to get the SHA.
+    CANDIDATE="${npm_package_resolved##*#}"
+    # Only accept if it looks like a SHA (40 hex chars). Anything else is
+    # probably a URL with no fragment, which would leave the var untouched.
+    if [ "${#CANDIDATE}" = 40 ] && [ -z "${CANDIDATE//[0-9a-f]/}" ]; then
+        REF_LIB="$CANDIDATE"
+        echo " - Using npm_package_resolved SHA for ref lookup"
+    fi
+fi
+
+if [ -z "$REF_LIB" ]; then
+    REF_LIB=$(node -e "const p=require('./package.json'); if (p.gitHead) process.stdout.write(p.gitHead);" 2>/dev/null)
+    if [ -n "$REF_LIB" ]; then
+        echo " - Using package.json gitHead for ref lookup"
+    fi
+fi
+
+if [ -z "$REF_LIB" ]; then
+    PKG_VERSION=$(node -p "require('./package.json').version")
+    if [ -z "$PKG_VERSION" ]; then
+        echo " - Failed to get version from package.json"
+        exit 1
+    fi
+    REF_LIB=v$PKG_VERSION
+fi
+
+echo "- Looking up synapse-api ref for synapse-typescript ref $REF_LIB"
+
+CURL_OPTS=()
+CURL_OPTS+=(-H "Accept: application/vnd.github+json")
+CURL_OPTS+=(-H "X-GitHub-Api-Version: 2022-11-28")
+if [ -n "$SCIENCE_CORPORATION_SYNAPSE_TOKEN" ]; then
+    echo " - Using GitHub token for authentication"
+    CURL_OPTS+=(-H "Authorization: Bearer $SCIENCE_CORPORATION_SYNAPSE_TOKEN")
+fi
+
+fetch_synapse_api_sha() {
+    local use_auth="$1"
+    local opts=(-H "Accept: application/vnd.github+json" -H "X-GitHub-Api-Version: 2022-11-28")
+    if [ "$use_auth" = "true" ] && [ -n "$SCIENCE_CORPORATION_SYNAPSE_TOKEN" ]; then
+        opts+=(-H "Authorization: Bearer $SCIENCE_CORPORATION_SYNAPSE_TOKEN")
+    fi
+    curl -s "${opts[@]}" "https://api.github.com/repos/sciencecorp/synapse-typescript/contents/synapse-api?ref=$REF_LIB"
+}
+
+echo " - Fetching synapse-api submodule info..."
+CURL_RESULT=$(fetch_synapse_api_sha "true")
+
+# Check for auth failure and retry without auth
+if echo "$CURL_RESULT" | grep -q '"Bad credentials"'; then
+    echo "   - Auth failed, retrying without authentication..."
+    CURL_RESULT=$(fetch_synapse_api_sha "false")
+fi
+
+if [ -z "$CURL_RESULT" ]; then
+    echo "   - Failed to fetch from GitHub API"
+    exit 1
+fi
+
+echo "   - Parsing SHA from response..."
+GREP_RESULT=$(echo "$CURL_RESULT" | grep -o '"sha":\s*"[^"]*"')
+if [ -z "$GREP_RESULT" ]; then
+    echo "   - Failed to find SHA in API response"
+    echo "   - API response: $CURL_RESULT"
+    exit 1
+fi
+
+REF_API=$(echo "${GREP_RESULT#*:}" | tr -d '[:space:]"')
+if [ -z "$REF_API" ]; then
+    echo "   - Failed to parse SHA from API response"
+    echo "   - API response: $CURL_RESULT"
+    exit 1
+fi
+
+echo "- Found synapse-api ref \"$REF_API\""
+
+# Create temp directory in a cross-platform way
+if [ "$IS_WINDOWS" = true ]; then
+    # Use a more reliable temp directory path on Windows
+    TMP_DIR="C:\\Users\\$USERNAME\\AppData\\Local\\Temp\\synapse-api-temp"
+    mkdir -p "$TMP_DIR"
+else
+    TMP_DIR=$(mktemp -d)
+fi
+
+# Download using curl or fallback to PowerShell on Windows if curl fails
+if ! curl -s -L "https://github.com/sciencecorp/synapse-api/archive/${REF_API}.zip" -o "$TMP_DIR/synapse-api.zip"; then
+    if [ "$IS_WINDOWS" = true ]; then
+        echo " - Curl failed, attempting download with PowerShell..."
+        powershell -Command "Invoke-WebRequest -Uri 'https://github.com/sciencecorp/synapse-api/archive/${REF_API}.zip' -OutFile '$TMP_DIR\\synapse-api.zip'"
+    else
+        echo " - Failed to download synapse-api"
+        exit 1
+    fi
+fi
+
+# Unzip in a cross-platform way
+if [ "$IS_WINDOWS" = true ]; then
+    if ! unzip -q "$TMP_DIR/synapse-api.zip" -d "$TMP_DIR" 2>/dev/null; then
+        echo " - Unzip failed, attempting with PowerShell..."
+        powershell -Command "Expand-Archive -Path '$TMP_DIR\\synapse-api.zip' -DestinationPath '$TMP_DIR' -Force"
+    fi
+else
+    if ! unzip -q "$TMP_DIR/synapse-api.zip" -d "$TMP_DIR"; then
+        echo " - Failed to unzip synapse-api"
+        exit 1
+    fi
+fi
+
+# Create directory and copy files in a cross-platform way
+mkdir -p synapse-api
+if [ "$IS_WINDOWS" = true ]; then
+    powershell -Command "Copy-Item -Path \"$TMP_DIR\\synapse-api-${REF_API}\\*\" -Destination \"synapse-api\\\" -Recurse -Force"
+else
+    cp -r "$TMP_DIR/synapse-api-${REF_API}/"* synapse-api/
+fi
+
+# Clean up temp files
+rm -rf "$TMP_DIR"
+
+if [ ! -f "synapse-api/README.md" ] || [ ! -f "synapse-api/COPYRIGHT" ] || [ ! -d "synapse-api/api" ]; then
+    echo " - Failed to download synapse-api - missing required files"
+    exit 1
+fi
+echo " - Successfully downloaded synapse-api ref \"$REF_API\""

package/src/api_version.ts

@@ -0,0 +1,2 @@
+// Generated from synapse-api/VERSION by scripts/generate.sh. Do not edit.
+export const SYNAPSE_API_VERSION = "2.4.1";

package/src/browser.ts

@@ -1,4 +1,6 @@
 // Browser-safe exports (types and enums only)
 export type { CallOptions } from "./utils/client";
 export { IStatus, Status, StatusCode } from "./utils/status";
+export { SYNAPSE_API_VERSION } from "./api_version";
+export { decodeSynapseVersion } from "./utils/version";
 export * from "./api/api";

package/src/index.ts

@@ -2,6 +2,8 @@ export { default as Config } from "./config";
 export { default as Device } from "./device";
 export * from "./nodes";
 export { IStatus, Status, StatusCode } from "./utils/status";
+export { SYNAPSE_API_VERSION } from "./api_version";
+export { decodeSynapseVersion } from "./utils/version";
 
 export type { CallOptions } from "./utils/client";
 export * from "./api/api";

package/src/utils/version.ts

@@ -0,0 +1,12 @@
+// Decode a Synapse API version uint32 into a "major.minor.patch" string.
+//
+// Encoding (see synapse-api device.proto, DeviceInfo.synapse_version):
+//   bits [31:24] major (0-255)
+//   bits [23:16] minor (0-255)
+//   bits [15:0]  patch (0-65535)
+export function decodeSynapseVersion(v: number): string {
+  const major = (v >>> 24) & 0xff;
+  const minor = (v >>> 16) & 0xff;
+  const patch = v & 0xffff;
+  return `${major}.${minor}.${patch}`;
+}

package/synapse-api/README.md

@@ -1,4 +1,4 @@
-# Synapse API 2.1.0
+# Synapse API
 
 The Synapse Protocol defines a standard interface for interacting with a wide range of possible neural interface devices.
 

package/synapse-api/VERSION

@@ -0,0 +1 @@
+2.4.1

package/synapse-api/api/query.proto

@@ -14,6 +14,7 @@ message SampleQuery {
 
 message ImpedanceQuery {
   repeated uint32 electrode_ids = 1;
+  uint32 peripheral_id = 2;
 }
 
 message SelfTestQuery {