chore: tidy generated outputs and brand readme

Author: hyochan

README.md

@@ -1,13 +1,23 @@
 # openiap-gql Code Generation Guide
 
-This repository is the single source of truth for the OpenIAP GraphQL schema.  The SDL
+<!-- markdownlint-disable MD033 -->
+<p align="center">
+  <img src="./logo.png" alt="OpenIAP GraphQL logo" width="320" />
+  <br />
+  <strong>OpenIAP meets GraphQL</strong>
+</p>
+<!-- markdownlint-enable MD033 -->
+
+_Unified schema and multiplatform codegen toolkit for OpenIAP._
+
+This repository is the single source of truth for the OpenIAP GraphQL schema. The SDL
 files live in `src/` and are split into common (`type.graphql`, `api.graphql`), error
 taxonomy (`error.graphql`), and platform-specific (`*-ios.graphql`, `*-android.graphql`)
 definitions.
 
 To keep every consumer in sync, code generation helpers are provided for
-TypeScript, Dart, Swift, and Kotlin.  Each section below explains the tooling,
-commands, and output locations.  Update the schema files first, then rerun the
+TypeScript, Dart, Swift, and Kotlin. Each section below explains the tooling,
+commands, and output locations. Update the schema files first, then rerun the
 appropriate generator for your target language.
 
 ---
@@ -21,15 +31,15 @@ Uses [`@graphql-codegen/cli`](https://www.the-guild.dev/graphql/codegen).
 3. Generate types: `npm run generate`
 4. Generated output: `src/generated/types.ts`
 
-Configuration lives in `codegen.ts`.  The script merges every SDL file and
+Configuration lives in `codegen.ts`. The script merges every SDL file and
 emits a schema-first type layer that mirrors the documented shapes.
 
 ---
 
 ## Dart
 
 Uses [`graphql_codegen`](https://pub.dev/packages/graphql_codegen) with
-`build_runner`.  A ready-to-use package scaffold is located in
+`build_runner`. A ready-to-use package scaffold is located in
 `generators/dart/`.
 
 1. Install Dart 3.0+.
@@ -40,30 +50,30 @@ Uses [`graphql_codegen`](https://pub.dev/packages/graphql_codegen) with
 6. Generated output: `generators/dart/lib/generated/`
 
 The `pubspec.yaml` and `build.yaml` already point the generator at the shared
-schema files in `../src`.  Customize package name, output path, and scalars as
+schema files in `../src`. Customize package name, output path, and scalars as
 needed for your application.
 
 ---
 
 ## Swift
 
 Relies on the official [Apollo iOS CLI](https://www.apollographql.com/docs/ios/)
-for schema codegen.  A helper script is provided in `generators/swift/`.
+for schema codegen. A helper script is provided in `generators/swift/`.
 
 1. Install the CLI (one time): `brew install apollo-ios-cli`
 2. Run the helper: `generators/swift/generate-swift.sh`
 3. Generated output: `generators/swift/Generated/`
 
 The script passes every SDL file to the CLI and emits an embedded module named
-`OpenIAPGraphQL`.  Adjust the script flags to fit your Xcode project (e.g.
+`OpenIAPGraphQL`. Adjust the script flags to fit your Xcode project (e.g.
 `--module-type swiftPackage` or supply operation files via `--operation-paths`).
 
 ---
 
 ## Kotlin
 
 Recommended tooling is [Apollo Kotlin](https://www.apollographql.com/docs/kotlin).
-Use the Gradle plugin inside your Android project to consume the schema.  Add a
+Use the Gradle plugin inside your Android project to consume the schema. Add a
 codegen module (e.g. `:openiap-graphql`) and configure it as follows:
 
 ```kotlin
@@ -93,14 +103,14 @@ dependencies {
 ```
 
 Then run `./gradlew :openiap-graphql:generateApolloSources` to regenerate the
-models.  Keep your query/mutation documents under `src/main/graphql` inside that
+models. Keep your query/mutation documents under `src/main/graphql` inside that
 module.
 
 ---
 
 ## Workflow Tips
 
-- Treat the SDL files in `src/` as the canonical schema.  Commit schema updates
+- Treat the SDL files in `src/` as the canonical schema. Commit schema updates
   before shipping generated code.
 - Regenerate types whenever you change schema shape or add operations in your
   client projects.

logo.png

@@ -152,4 +152,6 @@ const wrapReturns = (interfaceName) => {
 wrapReturns('Query');
 wrapReturns('Mutation');
 
+content = content.replace(/^\s*_placeholder\??: [^;]+;\n/gm, '');
+
 writeFileSync(targetPath, content);

scripts/fix-generated-types.mjs

@@ -53,7 +53,16 @@ const dartKeywords = new Set([
   'yield',
 ]);
 
-const escapeDartName = (name) => (dartKeywords.has(name) ? `_${name}` : name);
+const dartKeywordOverrides = new Map([
+  ['deferred', 'deferred'],
+]);
+
+const escapeDartName = (name) => {
+  if (dartKeywordOverrides.has(name)) {
+    return dartKeywordOverrides.get(name);
+  }
+  return dartKeywords.has(name) ? `_${name}` : name;
+};
 
 const toCamelCase = (value, upper = false) => {
   const tokens = value
@@ -157,6 +166,8 @@ lines.push(
   "// Run `npm run generate` after updating any *.graphql schema file.",
   '// ============================================================================',
   '',
+  '// ignore_for_file: unused_element, unused_field',
+  '',
   "import 'dart:async';",
   '',
 );
@@ -253,7 +264,9 @@ const printOperationInterface = (operationType) => {
   const interfaceName = `${operationType.name}Resolver`;
   addDocComment(lines, operationType.description ?? `GraphQL root ${operationType.name.toLowerCase()} operations.`);
   lines.push(`abstract class ${interfaceName} {`);
-  const fields = Object.values(operationType.getFields()).sort((a, b) => a.name.localeCompare(b.name));
+  const fields = Object.values(operationType.getFields())
+    .filter((field) => field.name !== '_placeholder')
+    .sort((a, b) => a.name.localeCompare(b.name));
   for (const field of fields) {
     addDocComment(lines, field.description, '  ');
     const { type, nullable } = getDartType(field.type);

scripts/generate-dart-types.mjs

@@ -269,7 +269,9 @@ const printOperationInterface = (operationType) => {
   const interfaceName = `${operationType.name}Resolver`;
   addDocComment(lines, operationType.description ?? `GraphQL root ${operationType.name.toLowerCase()} operations.`);
   lines.push(`public interface ${interfaceName} {`);
-  const fields = Object.values(operationType.getFields()).sort((a, b) => a.name.localeCompare(b.name));
+  const fields = Object.values(operationType.getFields())
+    .filter((field) => field.name !== '_placeholder')
+    .sort((a, b) => a.name.localeCompare(b.name));
   for (const field of fields) {
     addDocComment(lines, field.description, '    ');
     const { type, nullable } = getKotlinType(field.type);

scripts/generate-kotlin-types.mjs

@@ -280,7 +280,9 @@ const printOperationProtocol = (operationType) => {
   const protocolName = `${operationType.name}Resolver`;
   addDocComment(lines, operationType.description ?? `GraphQL root ${operationType.name.toLowerCase()} operations.`);
   lines.push(`public protocol ${protocolName} {`);
-  const fields = Object.values(operationType.getFields()).sort((a, b) => a.name.localeCompare(b.name));
+  const fields = Object.values(operationType.getFields())
+    .filter((field) => field.name !== '_placeholder')
+    .sort((a, b) => a.name.localeCompare(b.name));
   if (fields.length === 0) {
     lines.push('    // No operations defined.');
   }

scripts/generate-swift-types.mjs

@@ -729,7 +729,6 @@ public sealed interface ReceiptValidationResult
  * GraphQL root mutation operations.
  */
 public interface MutationResolver {
-    suspend fun _placeholder(): Boolean?
     /**
      * Acknowledge a non-consumable purchase or subscription
      */
@@ -796,7 +795,6 @@ public interface MutationResolver {
  * GraphQL root query operations.
  */
 public interface QueryResolver {
-    suspend fun _placeholder(): Boolean?
     /**
      * Get current StoreKit 2 entitlements (iOS 15+)
      */
@@ -863,7 +861,6 @@ public interface QueryResolver {
  * GraphQL root subscription operations.
  */
 public interface SubscriptionResolver {
-    suspend fun _placeholder(): Boolean?
     /**
      * Fires when the App Store surfaces a promoted product (iOS only)
      */

src/generated/Types.kt

@@ -615,7 +615,6 @@ public enum ReceiptValidationResult {
 
 /// GraphQL root mutation operations.
 public protocol MutationResolver {
-    func _placeholder() async throws -> Bool?
     /// Acknowledge a non-consumable purchase or subscription
     func acknowledgePurchaseAndroid(purchaseToken: String) async throws -> VoidResult
     /// Initiate a refund request for a product (iOS 15+)
@@ -650,7 +649,6 @@ public protocol MutationResolver {
 
 /// GraphQL root query operations.
 public protocol QueryResolver {
-    func _placeholder() async throws -> Bool?
     /// Get current StoreKit 2 entitlements (iOS 15+)
     func currentEntitlementIOS(skus: [String]? = nil) async throws -> [EntitlementIOS]
     /// Retrieve products or subscriptions from the store
@@ -685,7 +683,6 @@ public protocol QueryResolver {
 
 /// GraphQL root subscription operations.
 public protocol SubscriptionResolver {
-    func _placeholder() async throws -> Bool?
     /// Fires when the App Store surfaces a promoted product (iOS only)
     func promotedProductIOS() async throws -> String
     /// Fires when a purchase fails or is cancelled

src/generated/Types.swift

@@ -3,6 +3,8 @@
 // Run `npm run generate` after updating any *.graphql schema file.
 // ============================================================================
 
+// ignore_for_file: unused_element, unused_field
+
 import 'dart:async';
 
 // MARK: - Enums
@@ -106,7 +108,7 @@ enum PurchaseState {
   purchased('PURCHASED'),
   failed('FAILED'),
   restored('RESTORED'),
-  _deferred('DEFERRED'),
+  deferred('DEFERRED'),
   unknown('UNKNOWN');
 
   const PurchaseState(this.value);
@@ -1088,7 +1090,6 @@ abstract class ReceiptValidationResult {}
 
 /// GraphQL root mutation operations.
 abstract class MutationResolver {
-  Future<bool?> _placeholder();
   /// Acknowledge a non-consumable purchase or subscription
   Future<VoidResult> acknowledgePurchaseAndroid({
     required String purchaseToken,
@@ -1138,7 +1139,6 @@ abstract class MutationResolver {
 
 /// GraphQL root query operations.
 abstract class QueryResolver {
-  Future<bool?> _placeholder();
   /// Get current StoreKit 2 entitlements (iOS 15+)
   Future<List<EntitlementIOS>> currentEntitlementIOS({
     List<String>? skus,
@@ -1193,7 +1193,6 @@ abstract class QueryResolver {
 
 /// GraphQL root subscription operations.
 abstract class SubscriptionResolver {
-  Future<bool?> _placeholder();
   /// Fires when the App Store surfaces a promoted product (iOS only)
   Future<String> promotedProductIOS();
   /// Fires when a purchase fails or is cancelled

src/generated/types.dart

@@ -138,7 +138,6 @@ export enum IapEvent {
 }
 
 export interface Mutation {
-  _placeholder?: (boolean | null);
   /** Acknowledge a non-consumable purchase or subscription */
   acknowledgePurchaseAndroid: Promise<VoidResult>;
   /** Initiate a refund request for a product (iOS 15+) */
@@ -480,7 +479,6 @@ export enum PurchaseState {
 }
 
 export interface Query {
-  _placeholder?: (boolean | null);
   /** Get current StoreKit 2 entitlements (iOS 15+) */
   currentEntitlementIOS: Promise<EntitlementIos[]>;
   /** Retrieve products or subscriptions from the store */
@@ -698,7 +696,6 @@ export interface RequestSubscriptionPropsByPlatforms {
 }
 
 export interface Subscription {
-  _placeholder?: (boolean | null);
   /** Fires when the App Store surfaces a promoted product (iOS only) */
   promotedProductIOS: string;
   /** Fires when a purchase fails or is cancelled */