@databricks/zerobus-ingest-sdk 1.0.2 → 1.2.0

package/utils/descriptor.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Options for loading a descriptor from a FileDescriptorSet.
+ */
+export interface LoadDescriptorOptions {
+    /**
+     * Path to the descriptor file generated by protoc.
+     * Example: 'schemas/my_schema_descriptor.pb'
+     */
+    descriptorPath: string;
+
+    /**
+     * Name of the proto file within the FileDescriptorSet.
+     * This should match the filename in your .proto file.
+     * Example: 'schemas/air_quality.proto' or 'air_quality.proto'
+     */
+    protoFileName: string;
+
+    /**
+     * Name of the message type to extract.
+     * Example: 'AirQuality'
+     */
+    messageName: string;
+}
+
+/**
+ * Loads a specific message's DescriptorProto from a FileDescriptorSet.
+ *
+ * @param options - Configuration specifying which message to extract
+ * @returns Base64-encoded DescriptorProto string for the specified message
+ * @throws Error if the descriptor file, proto file, or message cannot be found
+ */
+export function loadDescriptorProto(options: LoadDescriptorOptions): string;

package/utils/descriptor.js

@@ -0,0 +1,55 @@
+"use strict";
+
+/**
+ * Utility functions for working with Protocol Buffer descriptors.
+ *
+ * These utilities help extract message descriptors from FileDescriptorSets
+ * generated by protoc, providing flexibility in choosing which message to use.
+ */
+
+const fs = require("fs");
+const descriptor = require("protobufjs/ext/descriptor");
+
+/**
+ * Loads a specific message's DescriptorProto from a FileDescriptorSet.
+ *
+ * @param {object} options
+ * @param {string} options.descriptorPath Path to the descriptor file generated by protoc.
+ * @param {string} options.protoFileName Name of the proto file within the FileDescriptorSet.
+ * @param {string} options.messageName Name of the message type to extract.
+ * @returns {string} Base64-encoded DescriptorProto string for the specified message.
+ */
+function loadDescriptorProto(options) {
+    const { descriptorPath, protoFileName, messageName } = options;
+
+    const descriptorBytes = fs.readFileSync(descriptorPath);
+    const fileDescriptorSet = descriptor.FileDescriptorSet.decode(descriptorBytes);
+    const fileDescriptor = fileDescriptorSet.file.find((file) =>
+        file.name === protoFileName ||
+        file.name.endsWith("/" + protoFileName)
+    );
+
+    if (!fileDescriptor) {
+        throw new Error(
+            `Proto file '${protoFileName}' not found in descriptor. Available files: ${
+                fileDescriptorSet.file.map((file) => file.name).join(", ")
+            }`
+        );
+    }
+
+    const messageType = fileDescriptor.messageType?.find((message) => message.name === messageName);
+
+    if (!messageType) {
+        const availableMessages = fileDescriptor.messageType?.map((message) => message.name).join(", ") || "none";
+        throw new Error(
+            `Message '${messageName}' not found in ${protoFileName}. Available messages: ${availableMessages}`
+        );
+    }
+
+    const descriptorProtoBytes = descriptor.DescriptorProto.encode(messageType).finish();
+    return Buffer.from(descriptorProtoBytes).toString("base64");
+}
+
+module.exports = {
+    loadDescriptorProto,
+};

package/utils/descriptor.ts

@@ -49,7 +49,7 @@ export interface LoadDescriptorOptions {
  *
  * @example
  * ```typescript
- * import { loadDescriptorProto } from '@databricks/zerobus-sdk/utils/descriptor';
+ * import { loadDescriptorProto } from '@databricks/zerobus-ingest-sdk/utils/descriptor.js';
  *
  * const descriptorBase64 = loadDescriptorProto({
  *     descriptorPath: 'schemas/air_quality_descriptor.pb',
@@ -74,7 +74,7 @@ export function loadDescriptorProto(options: LoadDescriptorOptions): string {
 
     // Find the file descriptor matching the proto file name
     const fileDescriptor = fileDescriptorSet.file.find((f: any) =>
-        f.name === protoFileName || f.name.endsWith('/' + protoFileName) || f.name.endsWith(protoFileName)
+        f.name === protoFileName || f.name.endsWith('/' + protoFileName)
     );
 
     if (!fileDescriptor) {