feat(swift): add snippets (#2705)

config/clients.config.json

@@ -329,6 +329,10 @@
     "tests": {
       "extension": "Tests.swift",
       "outputFolder": "Tests"
+    },
+    "snippets": {
+      "extension": ".swift",
+      "outputFolder": "Sources"
     }
   }
 }

config/generation.config.mjs

@@ -141,6 +141,9 @@ export const patterns = [
   '!clients/algoliasearch-client-scala/src/main/scala/algoliasearch/config/**',
 
   // Swift
+  '!snippets/swift/**',
+  'snippets/swift/Package.swift',
+  'snippets/swift/Sources/**',
   'clients/algoliasearch-client-swift/**',
   '!clients/algoliasearch-client-swift/*',
   'clients/algoliasearch-client-swift/AlgoliaSearchClient.podspec',

generators/src/main/java/com/algolia/codegen/cts/manager/SwiftCTSManager.java

@@ -32,4 +32,9 @@ public void addDataToBundle(Map<String, Object> bundle) throws GeneratorExceptio
         .collect(Collectors.toList())
     );
   }
+
+  @Override
+  public void addSnippetsSupportingFiles(List<SupportingFile> supportingFiles) {
+    supportingFiles.add(new SupportingFile("snippets/Package.mustache", "snippets/swift", "Package.swift"));
+  }
 }

scripts/formatter.ts

@@ -65,7 +65,7 @@ export async function formatter(language: string, cwd: string): Promise<void> {
       await run('sbt -Dsbt.server.forcestart=true scalafmtAll scalafmtSbt', { cwd, language });
       break;
     case 'swift':
-      if (cwd.includes('tests') || cwd.includes('snippets')) {
+      if (cwd.includes('tests')) {
         await run(`swiftformat Tests`, { cwd, language });
       } else {
         await run(`swiftformat Sources`, { cwd, language });

snippets/swift/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+/.build
+/Packages
+xcuserdata/
+DerivedData/
+.swiftpm/configuration/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc
+Package.resolved

templates/swift/snippets/Package.mustache

@@ -0,0 +1,34 @@
+// swift-tools-version: 5.9
+
+import PackageDescription
+
+let package = Package(
+  name: "AlgoliaSearchClientSnippets",
+  platforms: [
+    .iOS(.v13),
+    .macOS(.v10_15),
+    .tvOS(.v13),
+    .watchOS(.v6),
+  ],
+  products: [
+      .library(
+          name: "AlgoliaSearchClientSnippets",
+          targets: ["AlgoliaSearchClientSnippets"]),
+  ],
+  dependencies: [
+      .package(path: "../../clients/algoliasearch-client-swift"),
+      .package(url: "https://github.com/Flight-School/AnyCodable", .upToNextMajor(from: "0.6.1"))
+  ],
+  targets: [
+    .target(
+      name: "AlgoliaSearchClientSnippets",
+      dependencies: [
+        .product(name: "AnyCodable", package: "AnyCodable"),{{#packageList}}
+        .product(
+          name: "{{{.}}}",
+          package: "algoliasearch-client-swift"
+        ),{{/packageList}}
+      ]
+    )
+  ]
+)

templates/swift/snippets/method.mustache

@@ -0,0 +1,34 @@
+#if canImport(AnyCodable)
+import AnyCodable
+#endif
+
+import Core
+import {{import}}
+
+final class {{client}}Snippet {
+  {{#blocksRequests}}
+  {{#snippet}}
+  // Snippet for the {{method}} method.
+  //
+  // {{{description}}}
+  func snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}() async throws {
+    // Initialize the client
+    let client = try {{client}}(appId: "YOUR_APP_ID", apiKey: "YOUR_API_KEY"{{#hasRegionalHost}}, region: .{{defaultRegion}}{{/hasRegionalHost}})
+
+  {{#hasRequestOptions}}
+    let requestOptions = RequestOptions({{#requestOptions.headers.parametersWithDataType}}{{#-first}}
+      headers: [{{/-first}}
+    "{{key}}": {{> tests/paramValue }}{{^-last}}, {{/-last}}{{#-last}}
+      ]{{/-last}}{{/requestOptions.headers.parametersWithDataType}}{{#requestOptions.headers.parametersWithDataType}}{{#requestOptions.queryParameters.parametersWithDataType}},{{/requestOptions.queryParameters.parametersWithDataType}}{{/requestOptions.headers.parametersWithDataType}}{{#requestOptions.queryParameters.parametersWithDataType}}{{#-first}}
+      queryItems: APIHelper.mapValuesToQueryItems([{{/-first}}
+    "{{key}}": {{> tests/paramValue }}{{^-last}}, {{/-last}}{{#-last}}
+      ]){{/-last}}{{/requestOptions.queryParameters.parametersWithDataType}}
+    )
+  {{/hasRequestOptions}}
+
+    // Call the API
+    let _ = try await client.{{method}}({{#parametersWithDataType}}{{> tests/generateParams}}{{^-last}},{{/-last}}{{/parametersWithDataType}}{{#hasRequestOptions}}, requestOptions: requestOptions{{/hasRequestOptions}})
+  }
+  {{/snippet}}
+  {{/blocksRequests}}
+}

templates/swift/tests/Package.mustache

@@ -1,5 +1,4 @@
 // swift-tools-version: 5.9
-// {{{generationBanner}}}
 
 import PackageDescription