@statsig/statsig-node-core 0.0.6-beta.2

package/index.d.ts

@@ -0,0 +1,166 @@
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+export declare class DynamicConfig {
+  name: string
+  value: Record<string, any>
+  ruleID: string
+  idType: string
+  get(paramName: string, fallback: any): any
+}
+
+export declare class Experiment {
+  name: string
+  value: Record<string, any>
+  ruleID: string
+  idType: string
+  groupName?: string
+  get(paramName: string, fallback: any): any
+}
+
+export declare class Layer {
+  name: string
+  ruleID: string
+  groupName?: string
+  get(paramName: string, fallback: any): any
+}
+
+export declare class Statsig {
+  constructor(sdkKey: string, options?: StatsigOptions | undefined | null)
+  initialize(): Promise<StatsigResult>
+  shutdown(): Promise<StatsigResult>
+  flushEvents(): Promise<StatsigResult>
+  logEvent(user: StatsigUser, eventName: string, value?: string | number | null, metadata?: Record<string, string> | undefined | null): void
+  checkGate(user: StatsigUser, gateName: string, options?: FeatureGateEvaluationOptions | undefined | null): boolean
+  getFeatureGate(user: StatsigUser, featureName: string, options?: FeatureGateEvaluationOptions | undefined | null): FeatureGate
+  getDynamicConfig(user: StatsigUser, configName: string, options?: DynamicConfigEvaluationOptions | undefined | null): DynamicConfig
+  getExperiment(user: StatsigUser, experimentName: string, options?: ExperimentEvaluationOptions | undefined | null): Experiment
+  getLayer(user: StatsigUser, layerName: string, options?: LayerEvaluationOptions | undefined | null): Layer
+  getClientInitializeResponse(user: StatsigUser, options?: ClientInitResponseOptions | undefined | null): string
+  manuallyLogFeatureGateExposure(user: StatsigUser, gateName: string): void
+  manuallyLogDynamicConfigExposure(user: StatsigUser, configName: string): void
+  manuallyLogExperimentExposure(user: StatsigUser, experimentName: string): void
+  manuallyLogLayerParamExposure(user: StatsigUser, layerName: string, paramName: string): void
+}
+
+export declare class StatsigUser {
+  constructor(args: StatsigUserArgs)
+  static withUserID(userId: string): StatsigUser
+  static withCustomIDs(customIds: Record<string, any>): StatsigUser
+  get customIDs(): Record<string, string> | null
+  set customIDs(value: Record<string, string> | null)
+  get custom(): Record<string, string> | null
+  set custom(value: Record<string, string | number | boolean | Array<string | number | boolean>> | null)
+  get privateAttributes(): Record<string, string> | null
+  set privateAttributes(value: Record<string, string | number | boolean | Array<string | number | boolean>> | null)
+  get userID(): string | null
+  set userID(value: any)
+  get email(): string | null
+  set email(value: any)
+  get ip(): string | null
+  set ip(value: any)
+  get userAgent(): string | null
+  set userAgent(value: any)
+  get country(): string | null
+  set country(value: any)
+  get locale(): string | null
+  set locale(value: any)
+  get appVersion(): string | null
+  set appVersion(value: any)
+}
+
+export declare function __internal__testDataStore(store: DataStore, path: string, value: string): Promise<[DataStoreResponse | undefined | null, boolean]>
+
+export declare function __internal__testObservabilityClient(client: ObservabilityClient, action: string, metricName: string, value: number, tags?: Record<string, string> | undefined | null): Promise<void>
+
+export interface ClientInitResponseOptions {
+  hashAlgorithm?: string
+  clientSdkKey?: string
+  includeLocalOverrides?: boolean
+}
+
+export interface DataStore {
+  initialize?: () => Promise<void>
+  shutdown?: () => Promise<void>
+  get?: (key: string) => Promise<DataStoreResponse>
+  set?: (key: string, value: string, time?: number) => Promise<void>
+  supportPollingUpdatesFor?: (key: string) => Promise<boolean>
+}
+
+export interface DataStoreResponse {
+  result?: string
+  time?: number
+}
+
+export interface DynamicConfigEvaluationOptions {
+  disableExposureLogging?: boolean
+}
+
+export interface ExperimentEvaluationOptions {
+  disableExposureLogging?: boolean
+}
+
+export interface FeatureGate {
+  name: string
+  value: boolean
+  ruleID: string
+  idType: string
+}
+
+export interface FeatureGateEvaluationOptions {
+  disableExposureLogging?: boolean
+}
+
+export interface LayerEvaluationOptions {
+  disableExposureLogging?: boolean
+}
+
+export interface ObservabilityClient {
+  initialize?: () => void
+  increment?: (metricName: string, value: number, tags: Record<string, string>) => void
+  gauge?: (metricName: string, value: number, tags: Record<string, string>) => void
+  dist?: (metricName: string, value: number, tags: Record<string, string>) => void
+}
+
+export interface SpecAdapterConfig {
+  adapterType: 'data_store' | 'network_grpc_websocket' | 'network_http'
+  specsUrl?: string
+  initTimeoutMs: number
+}
+
+export interface StatsigOptions {
+  dataStore?: DataStore
+  disableAllLogging?: boolean
+  enableIdLists?: boolean
+  environment?: string
+  eventLoggingFlushIntervalMs?: number
+  eventLoggingMaxQueueSize?: number
+  fallbackToStatsigApi?: boolean
+  idListsSyncIntervalMs?: number
+  idListsUrl?: string
+  initTimeoutMs?: number
+  logEventUrl?: string
+  observabilityClient?: ObservabilityClient
+  outputLogLevel?: 'none' | 'debug' | 'info' | 'warn' | 'error'
+  specAdaptersConfig?: Array<SpecAdapterConfig>
+  specsUrl?: string
+  specsSyncIntervalMs?: number
+  serviceName?: string
+}
+
+export interface StatsigResult {
+  isSuccess: boolean
+  error?: string
+}
+
+export interface StatsigUserArgs {
+  userID: string
+  customIDs: Record<string, string | number | number>
+  email?: string
+  ip?: string
+  userAgent?: string
+  country?: string
+  locale?: string
+  appVersion?: string
+  custom?: Record<string, string | number | boolean | Array<string | number | boolean>>
+  privateAttributes?: Record<string, string | number | boolean | Array<string | number | boolean>>
+}

package/index.js

@@ -0,0 +1,373 @@
+// prettier-ignore
+/* eslint-disable */
+// @ts-nocheck
+/* auto-generated by NAPI-RS */
+
+const { createRequire } = require('node:module')
+require = createRequire(__filename)
+
+const { readFileSync } = require('node:fs')
+let nativeBinding = null
+const loadErrors = []
+
+const isMusl = () => {
+  let musl = false
+  if (process.platform === 'linux') {
+    musl = isMuslFromFilesystem()
+    if (musl === null) {
+      musl = isMuslFromReport()
+    }
+    if (musl === null) {
+      musl = isMuslFromChildProcess()
+    }
+  }
+  return musl
+}
+
+const isFileMusl = (f) => f.includes('libc.musl-') || f.includes('ld-musl-')
+
+const isMuslFromFilesystem = () => {
+  try {
+    return readFileSync('/usr/bin/ldd', 'utf-8').includes('musl')
+  } catch {
+    return null
+  }
+}
+
+const isMuslFromReport = () => {
+  const report = typeof process.report.getReport === 'function' ? process.report.getReport() : null
+  if (!report) {
+    return null
+  }
+  if (report.header && report.header.glibcVersionRuntime) {
+    return false
+  }
+  if (Array.isArray(report.sharedObjects)) {
+    if (report.sharedObjects.some(isFileMusl)) {
+      return true
+    }
+  }
+  return false
+}
+
+const isMuslFromChildProcess = () => {
+  try {
+    return require('child_process').execSync('ldd --version', { encoding: 'utf8' }).includes('musl')
+  } catch (e) {
+    // If we reach this case, we don't know if the system is musl or not, so is better to just fallback to false
+    return false
+  }
+}
+
+function requireNative() {
+  if (process.platform === 'android') {
+    if (process.arch === 'arm64') {
+      try {
+        return require('./statsig-node-core.android-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-android-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'arm') {
+      try {
+        return require('./statsig-node-core.android-arm-eabi.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-android-arm-eabi')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Android ${process.arch}`))
+    }
+  } else if (process.platform === 'win32') {
+    if (process.arch === 'x64') {
+      try {
+        return require('./statsig-node-core.win32-x64-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-win32-x64-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'ia32') {
+      try {
+        return require('./statsig-node-core.win32-ia32-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-win32-ia32-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./statsig-node-core.win32-arm64-msvc.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-win32-arm64-msvc')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Windows: ${process.arch}`))
+    }
+  } else if (process.platform === 'darwin') {
+    try {
+        return require('./statsig-node-core.darwin-universal.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-darwin-universal')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    if (process.arch === 'x64') {
+      try {
+        return require('./statsig-node-core.darwin-x64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-darwin-x64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./statsig-node-core.darwin-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-darwin-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on macOS: ${process.arch}`))
+    }
+  } else if (process.platform === 'freebsd') {
+    if (process.arch === 'x64') {
+      try {
+        return require('./statsig-node-core.freebsd-x64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-freebsd-x64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 'arm64') {
+      try {
+        return require('./statsig-node-core.freebsd-arm64.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-freebsd-arm64')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on FreeBSD: ${process.arch}`))
+    }
+  } else if (process.platform === 'linux') {
+    if (process.arch === 'x64') {
+      if (isMusl()) {
+        try {
+        return require('./statsig-node-core.linux-x64-musl.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-x64-musl')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
+        return require('./statsig-node-core.linux-x64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-x64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      }
+    } else if (process.arch === 'arm64') {
+      if (isMusl()) {
+        try {
+        return require('./statsig-node-core.linux-arm64-musl.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-arm64-musl')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
+        return require('./statsig-node-core.linux-arm64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-arm64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      }
+    } else if (process.arch === 'arm') {
+      if (isMusl()) {
+        try {
+        return require('./statsig-node-core.linux-arm-musleabihf.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-arm-musleabihf')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
+        return require('./statsig-node-core.linux-arm-gnueabihf.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-arm-gnueabihf')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      }
+    } else if (process.arch === 'riscv64') {
+      if (isMusl()) {
+        try {
+        return require('./statsig-node-core.linux-riscv64-musl.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-riscv64-musl')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      } else {
+        try {
+        return require('./statsig-node-core.linux-riscv64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-riscv64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+      }
+    } else if (process.arch === 'ppc64') {
+      try {
+        return require('./statsig-node-core.linux-ppc64-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-ppc64-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else if (process.arch === 's390x') {
+      try {
+        return require('./statsig-node-core.linux-s390x-gnu.node')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+      try {
+        return require('@statsig/statsig-node-core-linux-s390x-gnu')
+      } catch (e) {
+        loadErrors.push(e)
+      }
+
+    } else {
+      loadErrors.push(new Error(`Unsupported architecture on Linux: ${process.arch}`))
+    }
+  } else {
+    loadErrors.push(new Error(`Unsupported OS: ${process.platform}, architecture: ${process.arch}`))
+  }
+}
+
+nativeBinding = requireNative()
+
+if (!nativeBinding || process.env.NAPI_RS_FORCE_WASI) {
+  try {
+    nativeBinding = require('./statsig-node-core.wasi.cjs')
+  } catch (err) {
+    if (process.env.NAPI_RS_FORCE_WASI) {
+      loadErrors.push(err)
+    }
+  }
+  if (!nativeBinding) {
+    try {
+      nativeBinding = require('@statsig/statsig-node-core-wasm32-wasi')
+    } catch (err) {
+      if (process.env.NAPI_RS_FORCE_WASI) {
+        loadErrors.push(err)
+      }
+    }
+  }
+}
+
+if (!nativeBinding) {
+  if (loadErrors.length > 0) {
+    // TODO Link to documentation with potential fixes
+    //  - The package owner could build/publish bindings for this arch
+    //  - The user may need to bundle the correct files
+    //  - The user may need to re-install node_modules to get new packages
+    throw new Error('Failed to load native binding', { cause: loadErrors })
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+module.exports.DynamicConfig = nativeBinding.DynamicConfig
+module.exports.Experiment = nativeBinding.Experiment
+module.exports.Layer = nativeBinding.Layer
+module.exports.Statsig = nativeBinding.Statsig
+module.exports.StatsigUser = nativeBinding.StatsigUser
+module.exports.__internal__testDataStore = nativeBinding.__internal__testDataStore
+module.exports.__internal__testObservabilityClient = nativeBinding.__internal__testObservabilityClient

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@statsig/statsig-node-core",
+  "version": "0.0.6-beta.2",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest --colors",
+    "build": "napi build --platform --js index.js --dts index.d.ts --output-dir ./build --strip"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "devDependencies": {
+    "@mongodb-js/zstd": "^2.0.0",
+    "@napi-rs/cli": "^3.0.0-alpha.62",
+    "@types/compression": "^1.7.5",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.10",
+    "compression": "^1.7.4",
+    "express": "^4.21.2",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3"
+  },
+  "engines": {
+    "node": ">= 6.14.2 < 7 || >= 8.11.2 < 9 || >= 9.11.0 < 10 || >= 10.0.0"
+  },
+  "napi": {
+    "binaryName": "statsig-node-core",
+    "targets": [
+      "aarch64-apple-darwin",
+      "aarch64-unknown-linux-gnu",
+      "aarch64-unknown-linux-musl",
+      "i686-pc-windows-msvc",
+      "x86_64-apple-darwin",
+      "x86_64-pc-windows-msvc",
+      "x86_64-unknown-linux-gnu",
+      "x86_64-unknown-linux-musl"
+    ]
+  },
+  "optionalDependencies": {
+    "@statsig/statsig-node-core-win32-x64-msvc": "0.0.6-beta.2",
+    "@statsig/statsig-node-core-win32-ia32-msvc": "0.0.6-beta.2",
+    "@statsig/statsig-node-core-linux-x64-musl": "0.0.6-beta.2",
+    "@statsig/statsig-node-core-linux-x64-gnu": "0.0.6-beta.2",
+    "@statsig/statsig-node-core-linux-arm64-musl": "0.0.6-beta.2",
+    "@statsig/statsig-node-core-linux-arm64-gnu": "0.0.6-beta.2",
+    "@statsig/statsig-node-core-darwin-x64": "0.0.6-beta.2",
+    "@statsig/statsig-node-core-darwin-arm64": "0.0.6-beta.2"
+  }
+}