docs: Constrain Flutter SDK version (#4919)

Flagsmith · Dec 13, 2024 · aab7d31 · aab7d31
1 parent 4bdff0a
commit aab7d31
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 7 deletions.
diff --git a/docs/docs/clients/client-side/flutter.md b/docs/docs/clients/client-side/flutter.md
@@ -5,19 +5,21 @@ description: Manage your Feature Flags and Remote Config in your Flutter applica
 slug: /clients/flutter
 ---
 
+import CodeBlock from '@theme/CodeBlock'; import { FlutterVersion } from '@site/src/components/SdkVersions.js';
+
 This SDK can be used for Flutter applications. The source code for the client is available on
 [GitHub](https://github.com/flagsmith/flagsmith-flutter-client).
 
 The Flagsmith Flutter SDK supports iOS, Android and Web targets.
 
 ## Getting Started
 
-The client library is available from the [https://pub.dev/packages/flagsmith](https://pub.dev/packages/flagsmith):
+Install the [client library](https://pub.dev/packages/flagsmith) by adding it to your application's pubspec.yaml file:
 
-```dart
-dependencies:
-  flagsmith:
-```
+<CodeBlock>
+{`dependencies:
+    flagsmith: ^`}<FlutterVersion />
+</CodeBlock>
 
 ## Basic Usage
 

diff --git a/docs/plugins/flagsmith-versions/index.js b/docs/plugins/flagsmith-versions/index.js
@@ -4,6 +4,8 @@ const fetchJSON = async (url, options) => {
     return response.json();
 };
 
+const userAgent = 'Flagsmith-Docs <support@flagsmith.com>';
+
 const fallback = (value) => (promise) => {
     if (!process.env.CI)
         return promise.catch((e) => {
@@ -53,7 +55,7 @@ const fetchDotnetVersions = async () => {
 const fetchRustVersions = async () => {
     // https://crates.io/data-access#api
     const headers = new Headers({
-        'User-Agent': 'Flagsmith-Docs <support@flagsmith.com>',
+        'User-Agent': userAgent,
     });
     const data = await fetchJSON('https://crates.io/api/v1/crates/flagsmith', { headers });
     return data.versions.map((version) => version.num);
@@ -69,11 +71,21 @@ const fetchNpmVersions = async (pkg) => {
     return Object.keys(data.versions);
 };
 
+const fetchFlutterVersions = async () => {
+    const data = await fetchJSON('https://pub.dev/api/packages/flagsmith', {
+        headers: {
+            Accept: 'application/vnd.pub.v2+json',
+            'User-Agent': userAgent,
+        },
+    });
+    return data.versions.map((v) => v.version);
+};
+
 export default async function fetchFlagsmithVersions(context, options) {
     return {
         name: 'flagsmith-versions',
         async loadContent() {
-            const [js, nodejs, java, android, swiftpm, cocoapods, dotnet, rust, elixir] = await Promise.all(
+            const [js, nodejs, java, android, swiftpm, cocoapods, dotnet, rust, elixir, flutter] = await Promise.all(
                 [
                     fetchNpmVersions('flagsmith'),
                     fetchNpmVersions('flagsmith-nodejs'),
@@ -84,6 +96,7 @@ export default async function fetchFlagsmithVersions(context, options) {
                     fetchDotnetVersions(),
                     fetchRustVersions(),
                     fetchElixirVersions(),
+                    fetchFlutterVersions(),
                 ].map(fallback([])),
             );
             return {
@@ -96,6 +109,7 @@ export default async function fetchFlagsmithVersions(context, options) {
                 dotnet,
                 rust,
                 elixir,
+                flutter,
             };
         },
         async contentLoaded({ content, actions }) {

diff --git a/docs/src/components/SdkVersions.js b/docs/src/components/SdkVersions.js
@@ -28,3 +28,4 @@ export const ElixirVersion = ({ spec = '~2' }) => Version({ sdk: 'elixir', spec
 export const RustVersion = ({ spec = '~2' }) => Version({ sdk: 'rust', spec });
 export const JsVersion = ({ spec = '~7' }) => Version({ sdk: 'js', spec });
 export const NodejsVersion = ({ spec } = { spec: '~5' }) => Version({ sdk: 'nodejs', spec });
+export const FlutterVersion = ({ spec = '~6' }) => Version({ sdk: 'flutter', spec });