@wundergraph/protographic 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,162 @@
+# Protographic
+
+A tool for converting GraphQL Schema Definition Language (SDL) to Protocol Buffers and mapping files.
+
+## Overview
+
+Protographic bridges GraphQL and Protocol Buffers (protobuf) ecosystems through two core functions:
+
+1. **GraphQL SDL to Protocol Buffer (Proto) Compiler**: Transforms GraphQL schemas into Proto3 format, allowing developers to write gRPC services using GraphQL SDL and integrate them seamlessly into the Cosmo Router as standard subgraphs. This is used at build-time.
+
+2. **GraphQL SDL to Mapping Compiler**: Creates mapping definitions that maintain the semantic relationships between GraphQL types while adapting them to Protocol Buffer's structural model. This is used by the Cosmo Router at runtime.
+
+## Key Features
+
+- Precise conversion of GraphQL types to Protocol Buffer messages
+- Consistent naming conventions across GraphQL and Proto definitions
+- Streamlined mapping of GraphQL operations to RPC methods
+- Robust handling of complex GraphQL features (unions, interfaces, directives)
+- First-class support for Federation entity mapping
+- Deterministic field ordering with proto.lock.json for backward compatibility
+
+## Installation
+
+```bash
+npm install @wundergraph/protographic
+```
+
+## Usage
+
+### Converting GraphQL SDL to Protocol Buffer
+
+```typescript
+import { compileGraphQLToProto } from '@wundergraph/protographic';
+
+const graphqlSchema = `
+type User {
+  id: ID!
+  name: String!
+}
+
+type Query {
+  user(id: ID!): User
+}
+`;
+
+const protoOutput = compileGraphQLToProto(
+  graphqlSchema, // String or GraphQLSchema object
+  {
+    serviceName: 'UserService', // Service name
+    packageName: 'user.v1', // Package name
+    goPackage: 'cosmo/pkg/my_package', // Go package name
+    lockFilePath: './proto.lock.json', // Optional: Path to proto.lock.json for deterministic field ordering
+  }
+);
+```
+
+### Using proto.lock.json for Deterministic Field Ordering
+
+Protographic supports deterministic field ordering for Protocol Buffer files through a lock file mechanism. This ensures backward compatibility across schema changes:
+
+```typescript
+import { compileGraphQLToProto } from '@wundergraph/protographic';
+
+// First generation with a new lock file
+const result1 = compileGraphQLToProto(initialSchema, {
+  serviceName: 'MyService',
+  lockFilePath: './proto.lock.json' // Creates lock file if it doesn't exist
+});
+
+// Later generation with schema changes but preserving field order
+const result2 = compileGraphQLToProto(updatedSchema, {
+  serviceName: 'MyService',
+  lockFilePath: './proto.lock.json' // Uses existing lock file
+});
+```
+
+When providing a `lockFilePath`, the function returns an object with both the proto definition and the lock data:
+
+```typescript
+const { proto, lockData } = compileGraphQLToProto(schema, { 
+  lockFilePath: './proto.lock.json' 
+});
+```
+
+If you prefer to manage the lock data directly without file I/O, you can use the lock data directly:
+
+```typescript
+import { compileGraphQLToProto, ProtoLock } from '@wundergraph/protographic';
+
+// First generation - creates initial lock data
+const result1 = compileGraphQLToProto(initialSchema, {
+  serviceName: 'MyService'
+});
+const proto1 = result1.proto;
+const lockData = result1.lockData;
+
+// Store the lock data however you want (database, state management, etc.)
+// ...
+
+// Later generation with the saved lock data
+const result2 = compileGraphQLToProto(updatedSchema, {
+  serviceName: 'MyService',
+  lockData: lockData // Use previously generated lock data
+});
+```
+
+The lock data records the order of:
+- Service methods
+- Message fields
+- Enum values
+- Implementers of interfaces
+- Members of unions
+
+New fields are always added at the end, maintaining backward compatibility with existing proto messages.
+
+### Generating Mapping Definitions
+
+```typescript
+import { compileGraphQLToMapping } from '@wundergraph/protographic';
+
+const graphqlSchema = `
+type Product @key(fields: "id") {
+  id: ID!
+  name: String!
+  price: Float!
+}
+
+type Query {
+  product(id: ID!): Product
+}
+`;
+
+const mappingOutput = compileGraphQLToMapping(
+  graphqlSchema, // String or GraphQLSchema object
+  'ProductService', // Service name
+);
+```
+
+## Conversion Rules
+
+Protographic follows a set of conventions when converting GraphQL SDL to Protocol Buffers. Please take a look at the following rules:
+
+1. GraphQL SDL to Mapping, see [SDL_MAPPING_RULES.md](SDL_MAPPING_RULES.md)
+2. GraphQL SDL to Proto, see [SDL_PROTO_RULES.md](SDL_PROTO_RULES.md)
+
+## Integration with graphql-go-tools
+
+Protographic generates a mapping file as well as a proto file that can be used with [graphql-go-tools](https://github.com/wundergraph/graphql-go-tools) to enable seamless GraphQL-to-gRPC translation. This integration allows you to:
+
+- Translate GraphQL queries to gRPC requests
+- Translate gRPC responses back to GraphQL format
+- Handle advanced GraphQL features (fragments, variables, aliases) within a gRPC context
+
+This bidirectional translation preserves type safety while combining the benefits of both GraphQL and gRPC ecosystems.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+This project is licensed under the Apache-2.0 License.

package/dist/src/index.d.ts

@@ -0,0 +1,37 @@
+import { GraphQLSchema } from 'graphql';
+import { GRPCMapping } from '@wundergraph/cosmo-connect/dist/node/v1/node_pb';
+import type { GraphQLToProtoTextVisitorOptions } from './sdl-to-proto-visitor.js';
+import type { ProtoLock } from './proto-lock.js';
+/**
+ * Compiles a GraphQL schema to a mapping structure
+ *
+ * @param schemaOrSDL GraphQL Schema object or SDL string
+ * @param serviceName Name of the Proto service to generate
+ * @returns Mapping structure
+ */
+export declare function compileGraphQLToMapping(schemaOrSDL: GraphQLSchema | string, serviceName?: string): GRPCMapping;
+/**
+ * Compiles a GraphQL schema directly to Protocol Buffer text definition
+ *
+ * @param schemaOrSDL GraphQL Schema object or SDL string
+ * @param options Optional configuration options
+ * @returns Protocol Buffer text definition and generated lock data
+ */
+export interface CompileGraphQLToProtoResult {
+    proto: string;
+    lockData: ProtoLock | null;
+}
+/**
+ * Compiles a GraphQL schema directly to Protocol Buffer text definition
+ *
+ * @param schemaOrSDL GraphQL Schema object or SDL string
+ * @param options Optional configuration options
+ * @returns Protocol Buffer text definition and lock data
+ */
+export declare function compileGraphQLToProto(schemaOrSDL: GraphQLSchema | string, options?: GraphQLToProtoTextVisitorOptions): CompileGraphQLToProtoResult;
+export * from './sdl-to-mapping-visitor.js';
+export { GraphQLToProtoTextVisitor } from './sdl-to-proto-visitor.js';
+export { ProtoLockManager } from './proto-lock.js';
+export type { GraphQLToProtoTextVisitorOptions } from './sdl-to-proto-visitor.js';
+export type { ProtoLock } from './proto-lock.js';
+export { GRPCMapping, OperationMapping, EntityMapping, TypeFieldMapping, FieldMapping, ArgumentMapping, EnumMapping, EnumValueMapping, OperationType, } from '@wundergraph/cosmo-connect/dist/node/v1/node_pb';

package/dist/src/index.js

@@ -0,0 +1,53 @@
+import { buildSchema } from 'graphql';
+import { GraphQLToProtoVisitor } from './sdl-to-mapping-visitor.js';
+import { GraphQLToProtoTextVisitor } from './sdl-to-proto-visitor.js';
+/**
+ * Compiles a GraphQL schema to a mapping structure
+ *
+ * @param schemaOrSDL GraphQL Schema object or SDL string
+ * @param serviceName Name of the Proto service to generate
+ * @returns Mapping structure
+ */
+export function compileGraphQLToMapping(schemaOrSDL, serviceName = 'DefaultService') {
+    // If a string was provided, build the schema
+    const schema = typeof schemaOrSDL === 'string'
+        ? buildSchema(schemaOrSDL, {
+            assumeValid: true, // Don't throw on unknown directives
+            assumeValidSDL: true, // Skip SDL validation
+        })
+        : schemaOrSDL;
+    // Create and run the visitor
+    const visitor = new GraphQLToProtoVisitor(schema, serviceName);
+    return visitor.visit();
+}
+/**
+ * Compiles a GraphQL schema directly to Protocol Buffer text definition
+ *
+ * @param schemaOrSDL GraphQL Schema object or SDL string
+ * @param options Optional configuration options
+ * @returns Protocol Buffer text definition and lock data
+ */
+export function compileGraphQLToProto(schemaOrSDL, options) {
+    // If a string was provided, build the schema
+    const schema = typeof schemaOrSDL === 'string'
+        ? buildSchema(schemaOrSDL, {
+            assumeValid: true, // Don't throw on unknown directives
+            assumeValidSDL: true, // Skip SDL validation
+        })
+        : schemaOrSDL;
+    // Create and run the visitor with lock data if available
+    const visitor = new GraphQLToProtoTextVisitor(schema, options);
+    const proto = visitor.visit();
+    // Get the generated lock data
+    const generatedLockData = visitor.getGeneratedLockData();
+    // Always return the object with both proto and lockData
+    return {
+        proto,
+        lockData: generatedLockData,
+    };
+}
+export * from './sdl-to-mapping-visitor.js';
+export { GraphQLToProtoTextVisitor } from './sdl-to-proto-visitor.js';
+export { ProtoLockManager } from './proto-lock.js';
+export { GRPCMapping, OperationMapping, EntityMapping, TypeFieldMapping, FieldMapping, ArgumentMapping, EnumMapping, EnumValueMapping, OperationType, } from '@wundergraph/cosmo-connect/dist/node/v1/node_pb';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAiB,MAAM,SAAS,CAAC;AAErD,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AAGtE;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACrC,WAAmC,EACnC,cAAsB,gBAAgB;IAEtC,6CAA6C;IAC7C,MAAM,MAAM,GACV,OAAO,WAAW,KAAK,QAAQ;QAC7B,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE;YACvB,WAAW,EAAE,IAAI,EAAE,oCAAoC;YACvD,cAAc,EAAE,IAAI,EAAE,sBAAsB;SAC7C,CAAC;QACJ,CAAC,CAAC,WAAW,CAAC;IAElB,6BAA6B;IAC7B,MAAM,OAAO,GAAG,IAAI,qBAAqB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC/D,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC;AACzB,CAAC;AAcD;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,WAAmC,EACnC,OAA0C;IAE1C,6CAA6C;IAC7C,MAAM,MAAM,GACV,OAAO,WAAW,KAAK,QAAQ;QAC7B,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE;YACvB,WAAW,EAAE,IAAI,EAAE,oCAAoC;YACvD,cAAc,EAAE,IAAI,EAAE,sBAAsB;SAC7C,CAAC;QACJ,CAAC,CAAC,WAAW,CAAC;IAElB,yDAAyD;IACzD,MAAM,OAAO,GAAG,IAAI,yBAAyB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE/D,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;IAE9B,8BAA8B;IAC9B,MAAM,iBAAiB,GAAG,OAAO,CAAC,oBAAoB,EAAE,CAAC;IAEzD,wDAAwD;IACxD,OAAO;QACL,KAAK;QACL,QAAQ,EAAE,iBAAiB;KAC5B,CAAC;AACJ,CAAC;AAED,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AAInD,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,WAAW,EACX,gBAAgB,EAChB,aAAa,GACd,MAAM,iDAAiD,CAAC"}

package/dist/src/naming-conventions.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Shared naming conventions for converting GraphQL to Protocol Buffers
+ *
+ * This utility file ensures consistent naming transformations between
+ * the Proto compiler and mapping compiler implementations.
+ */
+/**
+ * The names of the GraphQL operation types
+ */
+export type OperationTypeName = 'Query' | 'Mutation' | 'Subscription';
+/**
+ * Converts a GraphQL field name to a Protocol Buffer field name (snake_case)
+ */
+export declare function graphqlFieldToProtoField(fieldName: string): string;
+/**
+ * Converts a GraphQL argument name to a Protocol Buffer field name (snake_case)
+ */
+export declare function graphqlArgumentToProtoField(argName: string): string;
+/**
+ * Creates an operation method name from an operation type and field name
+ */
+export declare function createOperationMethodName(operationType: OperationTypeName, fieldName: string): string;
+/**
+ * Creates a request message name for an operation
+ */
+export declare function createRequestMessageName(methodName: string): string;
+/**
+ * Creates a response message name for an operation
+ */
+export declare function createResponseMessageName(methodName: string): string;
+/**
+ * Creates an entity lookup method name for an entity type
+ */
+export declare function createEntityLookupMethodName(typeName: string, keyField?: string): string;
+/**
+ * Creates a request message name for an entity lookup
+ */
+export declare function createEntityLookupRequestName(typeName: string, keyField?: string): string;
+/**
+ * Creates a response message name for an entity lookup
+ */
+export declare function createEntityLookupResponseName(typeName: string, keyField?: string): string;
+/**
+ * Converts a GraphQL enum value to a Protocol Buffer enum value
+ */
+export declare function graphqlEnumValueToProtoEnumValue(enumTypeName: string, enumValue: string): string;
+/**
+ * Creates a Proto enum unspecified value (required as first value in proto3)
+ */
+export declare function createEnumUnspecifiedValue(enumTypeName: string): string;

package/dist/src/naming-conventions.js

@@ -0,0 +1,62 @@
+import { camelCase, snakeCase, upperFirst } from 'lodash-es';
+/**
+ * Converts a GraphQL field name to a Protocol Buffer field name (snake_case)
+ */
+export function graphqlFieldToProtoField(fieldName) {
+    return snakeCase(fieldName);
+}
+/**
+ * Converts a GraphQL argument name to a Protocol Buffer field name (snake_case)
+ */
+export function graphqlArgumentToProtoField(argName) {
+    return snakeCase(argName);
+}
+/**
+ * Creates an operation method name from an operation type and field name
+ */
+export function createOperationMethodName(operationType, fieldName) {
+    return `${operationType}${upperFirst(camelCase(fieldName))}`;
+}
+/**
+ * Creates a request message name for an operation
+ */
+export function createRequestMessageName(methodName) {
+    return `${methodName}Request`;
+}
+/**
+ * Creates a response message name for an operation
+ */
+export function createResponseMessageName(methodName) {
+    return `${methodName}Response`;
+}
+/**
+ * Creates an entity lookup method name for an entity type
+ */
+export function createEntityLookupMethodName(typeName, keyField = 'id') {
+    return `Lookup${typeName}By${upperFirst(camelCase(keyField))}`;
+}
+/**
+ * Creates a request message name for an entity lookup
+ */
+export function createEntityLookupRequestName(typeName, keyField = 'id') {
+    return `Lookup${typeName}By${upperFirst(camelCase(keyField))}Request`;
+}
+/**
+ * Creates a response message name for an entity lookup
+ */
+export function createEntityLookupResponseName(typeName, keyField = 'id') {
+    return `Lookup${typeName}By${upperFirst(camelCase(keyField))}Response`;
+}
+/**
+ * Converts a GraphQL enum value to a Protocol Buffer enum value
+ */
+export function graphqlEnumValueToProtoEnumValue(enumTypeName, enumValue) {
+    return `${snakeCase(enumTypeName).toUpperCase()}_${enumValue}`;
+}
+/**
+ * Creates a Proto enum unspecified value (required as first value in proto3)
+ */
+export function createEnumUnspecifiedValue(enumTypeName) {
+    return `${snakeCase(enumTypeName).toUpperCase()}_UNSPECIFIED`;
+}
+//# sourceMappingURL=naming-conventions.js.map

package/dist/src/naming-conventions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"naming-conventions.js","sourceRoot":"","sources":["../../src/naming-conventions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAc7D;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,SAAiB;IACxD,OAAO,SAAS,CAAC,SAAS,CAAC,CAAC;AAC9B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,2BAA2B,CAAC,OAAe;IACzD,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,aAAgC,EAAE,SAAiB;IAC3F,OAAO,GAAG,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;AAC/D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CAAC,UAAkB;IACzD,OAAO,GAAG,UAAU,SAAS,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,yBAAyB,CAAC,UAAkB;IAC1D,OAAO,GAAG,UAAU,UAAU,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAAC,QAAgB,EAAE,WAAmB,IAAI;IACpF,OAAO,SAAS,QAAQ,KAAK,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,6BAA6B,CAAC,QAAgB,EAAE,WAAmB,IAAI;IACrF,OAAO,SAAS,QAAQ,KAAK,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC;AACxE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,8BAA8B,CAAC,QAAgB,EAAE,WAAmB,IAAI;IACtF,OAAO,SAAS,QAAQ,KAAK,UAAU,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,UAAU,CAAC;AACzE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gCAAgC,CAAC,YAAoB,EAAE,SAAiB;IACtF,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,IAAI,SAAS,EAAE,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAC,YAAoB;IAC7D,OAAO,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,cAAc,CAAC;AAChE,CAAC"}

package/dist/src/proto-lock.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Interface for Proto Lock file structure
+ */
+export interface ProtoLock {
+    version: string;
+    messages: Record<string, MessageLock>;
+    enums: Record<string, EnumLock>;
+}
+interface MessageLock {
+    fields: Record<string, number>;
+    reservedNumbers?: number[];
+}
+interface EnumLock {
+    fields: Record<string, number>;
+    reservedNumbers?: number[];
+}
+/**
+ * Class to manage proto lock data for deterministic field ordering
+ */
+export declare class ProtoLockManager {
+    private readonly lockData;
+    /**
+     * Create a new ProtoLockManager
+     *
+     * @param initialLockData - Initial lock data to use, if any
+     */
+    constructor(initialLockData?: ProtoLock);
+    /**
+     * Generic method to reconcile items and their numbers
+     *
+     * @param container - The container object (messages or enums)
+     * @param itemName - Name of the item (message or enum)
+     * @param availableItems - Available item names (fields or enum values)
+     * @returns Ordered array of item names
+     */
+    private reconcileItems;
+    /**
+     * Reconcile and get the ordered field names for a message
+     *
+     * @param messageName - Name of the message
+     * @param availableFields - Available field names (used when no lock exists)
+     * @returns Ordered array of field names
+     */
+    reconcileMessageFieldOrder(messageName: string, availableFields: string[]): string[];
+    /**
+     * Reconcile and get the ordered enum values
+     *
+     * @param enumName - Name of the enum
+     * @param availableValues - Available enum values (used when no lock exists)
+     * @returns Ordered array of enum values
+     */
+    reconcileEnumValueOrder(enumName: string, availableValues: string[]): string[];
+    /**
+     * Reconcile and get the ordered argument names for a field
+     *
+     * @param fieldPath - Path to the field in the format "TypeName.fieldName"
+     * @param availableArgs - Available argument names (used when no lock exists)
+     * @returns Ordered array of argument names
+     */
+    reconcileArgumentOrder(fieldPath: string, availableArgs: string[]): string[];
+    /**
+     * Get the current lock data
+     */
+    getLockData(): ProtoLock;
+}
+export {};