https://github.com/featurevisor/featurevisor-kotlin
Kotlin SDK for Featurevisor (in progress)
https://github.com/featurevisor/featurevisor-kotlin
Last synced: 4 months ago
JSON representation
Kotlin SDK for Featurevisor (in progress)
- Host: GitHub
- URL: https://github.com/featurevisor/featurevisor-kotlin
- Owner: featurevisor
- License: mit
- Created: 2023-08-16T16:11:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-21T12:18:59.000Z (10 months ago)
- Last Synced: 2025-08-21T13:37:22.389Z (10 months ago)
- Language: Kotlin
- Size: 233 KB
- Stars: 3
- Watchers: 2
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# featurevisor-kotlin
This repository is a work in progress to port the [Featurevisor](https://featurevisor.com) JavaScript SDK to Kotlin for supporting Android apps.
We are not ready yet. Please come back later.
## Installation
If you are using groovy, build.gradle -
```
repositories {
mavenCentral()
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.featurevisor:featurevisor-kotlin:LATEST_VERSION'
}
```
If you are using Kotlin DSL, build.gradle.kts -
```
repositories {
mavenCentral()
maven("https://jitpack.io")
}
dependencies {
implementation("com.github.featurevisor:featurevisor-kotlin:LATEST_VERSION")
}
```
## Usage
...
## Development
We wish to reach feature parity with the existing JavaScript SDK: https://featurevisor.com/docs/sdks/
### Requirements
Install dependencies with Homebrew:
```
$ brew install openjdk
$ brew install gradle
```
### Running locally
```
$ gradle build
$ gradle test
```
### TODOs
- [ ] Add documentation in README for Installation and Usage sections
- [ ] Verify if `JavaLanguageVersion` set in `build.gradle.kt` is correct (set to `8` now)
- [x] Set up CI/CD pipeline
- [x] Publish as package
- [x] Find a compatible MurmurHash implementation for Kotlin/JVM
- [ ] Port the SDK API as defined below
### SDK API
We are breaking down the various parts that we need to migrate to Swift in the sections below:
| Section | Task | Status |
|---------------------|--------------------------------------------------|--------|
| Files | `@featurevisor/types` ➡️ `Types.kt` | ✅ |
| | SDK's `bucket.ts` ➡️ `Bucket.kt` | ✅ |
| | SDK's `conditions.ts` ➡️ `Conditions.kt` | ✅ |
| | SDK's `datafileReader.ts` ➡️ `DatafileReader.kt` | ✅ |
| | SDK's `emitter.ts` ➡️ `Emitter.kt` | ✅ |
| | SDK's `feature.ts` ➡️ `Instance+Feature.kt` | ✅ |
| | SDK's `instance.ts` ➡️ `Instance.kt` | ✅ |
| | SDK's `logger.ts` ➡️ `Logger.kt` | ✅ |
| | SDK's `segments.ts` ➡️ `Instance+Segments.kt` | ✅ |
| | | |
| Constructor options | `bucketKeySeparator` | |
| | `configureBucketKey` | |
| | `configureBucketValue` | |
| | `datafile` | |
| | `datafileUrl` | |
| | `handleDatafileFetch` | |
| | `initialFeatures` | |
| | `interceptContext` | |
| | `logger` | |
| | `onActivation` | |
| | `onReady` | |
| | `onRefresh` | |
| | `onUpdate` | |
| | `refreshInternal` | |
| | `stickyFeatures` | |
| | | |
| Instance methods | `constructor` missing fetch datafile content | |
| | `setDatafile` removed to workaround init issues | |
| | `setStickyFeatures` | |
| | `getRevision` | |
| | `getFeature` | |
| | `getBucketKey` | |
| | `getBucketValue` | |
| | `isReady` | |
| | `refresh` | |
| | `startRefreshing` | |
| | `stopRefreshing` | |
| | `evaluateFlag` | |
| | `isEnabled` | |
| | `evaluateVariation` | |
| | `getVariation` | |
| | `activate` | |
| | `evaluateVariable` | |
| | `getVariable` | |
| | `getVariableBoolean` | |
| | `getVariableString` | |
| | `getVariableInteger` | |
| | `getVariableDouble` | |
| | `getVariableArray` | |
| | `getVariableObject` | |
| | `getVariableJSON` | |
| | | |
| Functions | `createInstance` missing proper error handling | |
| | `fetchDatafileContent` | |
| | `getValueByType` | |
### Test runner
We should also have an executable as an output of this repository that can be used to run the test specs against the Kotlin SDK: https://featurevisor.com/docs/testing/
Example command:
```
$ cd path/to/featurevisor-project-with-yamls
$ featurevisor-kotlin test
```
## License
[MIT](./LICENSE)