From 4f97ef87921c66cd0e6263fbcdcd542c0652fec5 Mon Sep 17 00:00:00 2001 From: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> Date: Fri, 27 Dec 2024 08:08:57 +0000 Subject: [PATCH] chore: update sdk readmes Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com> --- docs/reference/technologies/client/kotlin.mdx | 39 ++++++++++++++++--- docs/reference/technologies/client/swift.mdx | 2 +- .../technologies/client/web/angular.mdx | 2 +- .../technologies/client/web/index.mdx | 6 +-- .../technologies/client/web/react.mdx | 6 +-- docs/reference/technologies/server/dotnet.mdx | 2 +- docs/reference/technologies/server/go.mdx | 2 +- docs/reference/technologies/server/java.mdx | 2 +- .../technologies/server/javascript/index.mdx | 6 +-- .../technologies/server/javascript/nestjs.mdx | 2 +- docs/reference/technologies/server/php.mdx | 2 +- docs/reference/technologies/server/python.mdx | 2 +- docs/reference/technologies/server/ruby.mdx | 2 +- src/datasets/sdks/sdk-compatibility.json | 16 ++++---- 14 files changed, 59 insertions(+), 32 deletions(-) diff --git a/docs/reference/technologies/client/kotlin.mdx b/docs/reference/technologies/client/kotlin.mdx index ea6e98bd..7287adeb 100644 --- a/docs/reference/technologies/client/kotlin.mdx +++ b/docs/reference/technologies/client/kotlin.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from kotlin-sdk. Edits should be made here: https://github.com/open-feature/kotlin-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:57 GMT+0000 (Coordinated Universal Time) -->

@@ -18,8 +18,8 @@ Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time) Specification - - Release + + Release
@@ -45,7 +45,7 @@ Installation via Maven Central is preferred, using the following dependency: ```kotlin dependencies { - api("dev.openfeature:android-sdk:0.3.0") + api("dev.openfeature:android-sdk:0.3.2") } ``` @@ -65,15 +65,16 @@ coroutineScope.launch(Dispatchers.IO) { ## Features | Status | Features | Description | -| ------ | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +|--------|---------------------------------|------------------------------------------------------------------------------------------------------------------------------------| | ✅ | [Providers](#providers) | Integrate with a commercial, open source, or in-house feature management tool. | | ✅ | [Targeting](#targeting) | Contextually-aware flag evaluation using [evaluation context](/docs/reference/concepts/evaluation-context). | | ✅ | [Hooks](#hooks) | Add functionality to various stages of the flag evaluation life-cycle. | +| ✅ | [Tracking](#tracking) | Associate user actions with feature flag evaluations. | | ❌ | [Logging](#logging) | Integrate with popular logging packages. | | ❌ | [Named clients](#named-clients) | Utilize multiple providers in a single application. | | ✅ | [Eventing](#eventing) | React to state changes in the provider or flag management system. | | ✅ | [Shutdown](#shutdown) | Gracefully clean up a provider during application shutdown. | -| ⚠️ | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. | +| ⚠️ | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. | Implemented: ✅ | In-progress: ⚠️ | Not implemented yet: ❌ @@ -125,6 +126,32 @@ client.addHooks(listOf(ExampleHook())) val retval = client.getBooleanValue(flagKey, false, FlagEvaluationOptions(listOf(ExampleHook()))) ``` + +### Tracking + +The [tracking API](/specification/sections/tracking/) allows you to use +OpenFeature abstractions to associate user actions with feature flag evaluations. +This is essential for robust experimentation powered by feature flags. Note that, unlike methods +that handle feature flag evaluations, calling `track(...)` may throw an `IllegalArgumentException` +if an empty string is passed as the `trackingEventName`. + +Below is an example of how we can track a "Checkout" event with some `TrackingDetails`. + +```kotlin +OpenFeatureAPI.getClient().track( + "Checkout", + TrackingEventDetails( + 499.99, + ImmutableStructure( + "numberOfItems" to Value.Integer(4), + "timeInCheckout" to Value.String("PT3M20S") + ) + ) +) +``` + +Tracking is optionally implemented by Providers. + ### Logging Logging customization is not yet available in the Kotlin SDK. diff --git a/docs/reference/technologies/client/swift.mdx b/docs/reference/technologies/client/swift.mdx index 35bdfcd8..99c053d3 100644 --- a/docs/reference/technologies/client/swift.mdx +++ b/docs/reference/technologies/client/swift.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from swift-sdk. Edits should be made here: https://github.com/open-feature/swift-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:40 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:57 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/client/web/angular.mdx b/docs/reference/technologies/client/web/angular.mdx index 5d38c8b9..f813c55e 100644 --- a/docs/reference/technologies/client/web/angular.mdx +++ b/docs/reference/technologies/client/web/angular.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:40 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:57 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/client/web/index.mdx b/docs/reference/technologies/client/web/index.mdx index 0a13f3f0..688db3a7 100644 --- a/docs/reference/technologies/client/web/index.mdx +++ b/docs/reference/technologies/client/web/index.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:56 GMT+0000 (Coordinated Universal Time) -->

@@ -18,8 +18,8 @@ Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time) Specification - - Release + + Release
diff --git a/docs/reference/technologies/client/web/react.mdx b/docs/reference/technologies/client/web/react.mdx index e574f906..b94419e0 100644 --- a/docs/reference/technologies/client/web/react.mdx +++ b/docs/reference/technologies/client/web/react.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:57 GMT+0000 (Coordinated Universal Time) -->

@@ -18,8 +18,8 @@ Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time) Specification - - Release + + Release
diff --git a/docs/reference/technologies/server/dotnet.mdx b/docs/reference/technologies/server/dotnet.mdx index 32414728..2ec5ec61 100644 --- a/docs/reference/technologies/server/dotnet.mdx +++ b/docs/reference/technologies/server/dotnet.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from dotnet-sdk. Edits should be made here: https://github.com/open-feature/dotnet-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:56 GMT+0000 (Coordinated Universal Time) --> [![Specification](https://img.shields.io/static/v1?label=specification&message=v0.7.0&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.7.0) diff --git a/docs/reference/technologies/server/go.mdx b/docs/reference/technologies/server/go.mdx index 2a7d29c0..46180252 100644 --- a/docs/reference/technologies/server/go.mdx +++ b/docs/reference/technologies/server/go.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from go-sdk. Edits should be made here: https://github.com/open-feature/go-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:56 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/java.mdx b/docs/reference/technologies/server/java.mdx index 03af3400..9d884231 100644 --- a/docs/reference/technologies/server/java.mdx +++ b/docs/reference/technologies/server/java.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from java-sdk. Edits should be made here: https://github.com/open-feature/java-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:37 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:55 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/javascript/index.mdx b/docs/reference/technologies/server/javascript/index.mdx index 64dea493..2d9a6446 100644 --- a/docs/reference/technologies/server/javascript/index.mdx +++ b/docs/reference/technologies/server/javascript/index.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:56 GMT+0000 (Coordinated Universal Time) -->

@@ -18,8 +18,8 @@ Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time) Specification - - Release + + Release
diff --git a/docs/reference/technologies/server/javascript/nestjs.mdx b/docs/reference/technologies/server/javascript/nestjs.mdx index be706a0b..3f2df0af 100644 --- a/docs/reference/technologies/server/javascript/nestjs.mdx +++ b/docs/reference/technologies/server/javascript/nestjs.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk. Edits should be made here: https://github.com/open-feature/js-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:38 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:56 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/php.mdx b/docs/reference/technologies/server/php.mdx index 17b29e9f..99528f2c 100644 --- a/docs/reference/technologies/server/php.mdx +++ b/docs/reference/technologies/server/php.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from php-sdk. Edits should be made here: https://github.com/open-feature/php-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:56 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/python.mdx b/docs/reference/technologies/server/python.mdx index 3b881b8e..ac1a2da3 100644 --- a/docs/reference/technologies/server/python.mdx +++ b/docs/reference/technologies/server/python.mdx @@ -9,7 +9,7 @@ This content has been automatically generated from python-sdk. Edits should be made here: https://github.com/open-feature/python-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:39 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:56 GMT+0000 (Coordinated Universal Time) -->

diff --git a/docs/reference/technologies/server/ruby.mdx b/docs/reference/technologies/server/ruby.mdx index 01da6c96..1cf2a7cb 100644 --- a/docs/reference/technologies/server/ruby.mdx +++ b/docs/reference/technologies/server/ruby.mdx @@ -10,7 +10,7 @@ This content has been automatically generated from ruby-sdk. Edits should be made here: https://github.com/open-feature/ruby-sdk Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs -Last updated at Tue Dec 17 2024 08:10:40 GMT+0000 (Coordinated Universal Time) +Last updated at Fri Dec 27 2024 08:08:57 GMT+0000 (Coordinated Universal Time) -->

diff --git a/src/datasets/sdks/sdk-compatibility.json b/src/datasets/sdks/sdk-compatibility.json index 28901d6a..41a5910e 100644 --- a/src/datasets/sdks/sdk-compatibility.json +++ b/src/datasets/sdks/sdk-compatibility.json @@ -60,8 +60,8 @@ "path": "/docs/reference/technologies/server/javascript", "category": "Server", "release": { - "href": "https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.16.2", - "version": "1.16.2", + "href": "https://github.com/open-feature/js-sdk/releases/tag/server-sdk-v1.17.0", + "version": "1.17.0", "stable": true }, "spec": { @@ -340,8 +340,8 @@ "path": "/docs/reference/technologies/client/web", "category": "Client", "release": { - "href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.3.2", - "version": "1.3.2", + "href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.4.0", + "version": "1.4.0", "stable": true }, "spec": { @@ -392,8 +392,8 @@ "path": "/docs/reference/technologies/client/kotlin", "category": "Client", "release": { - "href": "https://github.com/open-feature/kotlin-sdk/releases/tag/v0.3.0", - "version": "0.3.0", + "href": "https://github.com/open-feature/kotlin-sdk/releases/tag/v0.3.2", + "version": "0.3.2", "stable": false }, "spec": { @@ -426,8 +426,8 @@ "path": "/docs/reference/technologies/client/kotlin#eventing" }, "Tracking": { - "status": "❓", - "path": "/docs/reference/technologies/client/kotlin" + "status": "✅", + "path": "/docs/reference/technologies/client/kotlin#tracking" }, "Shutdown": { "status": "✅",