flowquery 1.0.6 → 1.0.8

package/dist/parsing/functions/function_metadata.js

@@ -4,24 +4,78 @@ exports.FunctionDef = FunctionDef;
 exports.getRegisteredFunctionMetadata = getRegisteredFunctionMetadata;
 exports.getRegisteredFunctionFactory = getRegisteredFunctionFactory;
 exports.getFunctionMetadata = getFunctionMetadata;
+exports.getRegisteredAsyncProvider = getRegisteredAsyncProvider;
 /**
- * Registry for function metadata collected via decorators.
+ * Centralized registry for function metadata, factories, and async providers.
+ * Encapsulates all registration logic for the @FunctionDef decorator.
  */
-const functionMetadataRegistry = new Map();
-/**
- * Registry for function factories collected via decorators.
- * Allows @FunctionDef to automatically register functions for instantiation.
- */
-const functionFactoryRegistry = new Map();
+class FunctionRegistry {
+    /** Derives a camelCase display name from a class name, removing 'Loader' suffix. */
+    static deriveDisplayName(className) {
+        const baseName = className.endsWith('Loader') ? className.slice(0, -6) : className;
+        return baseName.charAt(0).toLowerCase() + baseName.slice(1);
+    }
+    /** Registers an async data provider class. */
+    static registerAsync(constructor, options) {
+        const displayName = this.deriveDisplayName(constructor.name);
+        const registryKey = displayName.toLowerCase();
+        this.metadata.set(registryKey, Object.assign({ name: displayName }, options));
+        this.asyncProviders.set(registryKey, (...args) => new constructor().fetch(...args));
+    }
+    /** Registers a regular function class. */
+    static registerFunction(constructor, options) {
+        var _a;
+        const instance = new constructor();
+        const baseName = (((_a = instance.name) === null || _a === void 0 ? void 0 : _a.toLowerCase()) || constructor.name.toLowerCase());
+        const displayName = baseName.includes(':') ? baseName.split(':')[0] : baseName;
+        const registryKey = options.category ? `${displayName}:${options.category}` : displayName;
+        this.metadata.set(registryKey, Object.assign({ name: displayName }, options));
+        if (options.category !== 'predicate') {
+            this.factories.set(displayName, () => new constructor());
+        }
+        this.factories.set(registryKey, () => new constructor());
+    }
+    static getAllMetadata() {
+        return Array.from(this.metadata.values());
+    }
+    static getMetadata(name, category) {
+        const lowerName = name.toLowerCase();
+        if (category)
+            return this.metadata.get(`${lowerName}:${category}`);
+        for (const meta of this.metadata.values()) {
+            if (meta.name === lowerName)
+                return meta;
+        }
+        return undefined;
+    }
+    static getFactory(name, category) {
+        const lowerName = name.toLowerCase();
+        if (category)
+            return this.factories.get(`${lowerName}:${category}`);
+        return this.factories.get(lowerName);
+    }
+    static getAsyncProvider(name) {
+        return this.asyncProviders.get(name.toLowerCase());
+    }
+}
+FunctionRegistry.metadata = new Map();
+FunctionRegistry.factories = new Map();
+FunctionRegistry.asyncProviders = new Map();
 /**
  * Class decorator that registers function metadata.
- * The function name is derived from the class's constructor call to super().
+ * The function name is derived from the class's constructor call to super() for regular functions,
+ * or from the class name for async providers.
+ *
+ * For async providers (category: "async"), the class must have a `fetch` method that returns
+ * an AsyncGenerator. The function name is derived from the class name (removing 'Loader' suffix
+ * if present) and converted to camelCase.
  *
  * @param options - Function metadata (excluding name)
  * @returns Class decorator
  *
  * @example
  * ```typescript
+ * // Regular function
  * @FunctionDef({
  *     description: "Calculates the sum of numeric values",
  *     category: "aggregate",
@@ -30,80 +84,53 @@ const functionFactoryRegistry = new Map();
  *     examples: ["WITH [1, 2, 3] AS nums UNWIND nums AS n RETURN sum(n)"]
  * })
  * class Sum extends AggregateFunction { ... }
+ *
+ * // Async data provider
+ * @FunctionDef({
+ *     description: "Fetches random cat facts from the Cat Facts API",
+ *     category: "async",
+ *     parameters: [{ name: "count", description: "Number of facts", type: "number", required: false, default: 1 }],
+ *     output: { description: "Cat fact object", type: "object" },
+ *     examples: ["LOAD JSON FROM catFacts(5) AS fact RETURN fact.text"]
+ * })
+ * class CatFactsLoader {
+ *     async *fetch(count: number = 1): AsyncGenerator<any> { ... }
+ * }
  * ```
  */
 function FunctionDef(options) {
     return function (constructor) {
-        var _a;
-        // Create an instance to get the function name from super() call
-        const instance = new constructor();
-        const baseName = ((_a = instance.name) === null || _a === void 0 ? void 0 : _a.toLowerCase()) || constructor.name.toLowerCase();
-        // Use category-qualified key to avoid collisions (e.g., sum vs sum:predicate)
-        // but store the display name without the qualifier
-        const displayName = baseName.includes(':') ? baseName.split(':')[0] : baseName;
-        const registryKey = options.category ? `${displayName}:${options.category}` : displayName;
-        // Register metadata with display name but category-qualified key
-        const metadata = Object.assign({ name: displayName }, options);
-        functionMetadataRegistry.set(registryKey, metadata);
-        // Register factory function for automatic instantiation
-        // Only register to the simple name if no collision exists (predicate functions use qualified keys)
-        if (options.category !== 'predicate') {
-            functionFactoryRegistry.set(displayName, () => new constructor());
+        if (options.category === 'async') {
+            FunctionRegistry.registerAsync(constructor, options);
+        }
+        else {
+            FunctionRegistry.registerFunction(constructor, options);
         }
-        functionFactoryRegistry.set(registryKey, () => new constructor());
         return constructor;
     };
 }
 /**
  * Gets all registered function metadata from decorators.
- *
- * @returns Array of function metadata
  */
 function getRegisteredFunctionMetadata() {
-    return Array.from(functionMetadataRegistry.values());
+    return FunctionRegistry.getAllMetadata();
 }
 /**
  * Gets a registered function factory by name.
- * Used by FunctionFactory to instantiate decorator-registered functions.
- *
- * @param name - Function name (case-insensitive)
- * @param category - Optional category to disambiguate (e.g., 'predicate')
- * @returns Factory function or undefined
  */
 function getRegisteredFunctionFactory(name, category) {
-    const lowerName = name.toLowerCase();
-    // If category specified, look for exact match
-    if (category) {
-        return functionFactoryRegistry.get(`${lowerName}:${category}`);
-    }
-    // Try direct match first
-    if (functionFactoryRegistry.has(lowerName)) {
-        return functionFactoryRegistry.get(lowerName);
-    }
-    return undefined;
+    return FunctionRegistry.getFactory(name, category);
 }
 /**
  * Gets metadata for a specific function by name.
- * If multiple functions share the same name (e.g., aggregate vs predicate),
- * optionally specify the category to get the specific one.
- *
- * @param name - Function name (case-insensitive)
- * @param category - Optional category to disambiguate
- * @returns Function metadata or undefined
  */
 function getFunctionMetadata(name, category) {
-    const lowerName = name.toLowerCase();
-    // If category specified, look for exact match
-    if (category) {
-        return functionMetadataRegistry.get(`${lowerName}:${category}`);
-    }
-    // Otherwise, first try direct match (for functions without category conflicts)
-    // Then search for any function with matching name
-    for (const [key, meta] of functionMetadataRegistry) {
-        if (meta.name === lowerName) {
-            return meta;
-        }
-    }
-    return undefined;
+    return FunctionRegistry.getMetadata(name, category);
+}
+/**
+ * Gets a registered async data provider by name.
+ */
+function getRegisteredAsyncProvider(name) {
+    return FunctionRegistry.getAsyncProvider(name);
 }
 //# sourceMappingURL=function_metadata.js.map

package/dist/parsing/functions/function_metadata.js.map

@@ -1 +1 @@
-{"version":3,"file":"function_metadata.js","sourceRoot":"","sources":["../../../src/parsing/functions/function_metadata.ts"],"names":[],"mappings":";;AA6HA,kCA2BC;AAOD,sEAEC;AAUD,oEAcC;AAWD,kDAiBC;AA3HD;;GAEG;AACH,MAAM,wBAAwB,GAAkC,IAAI,GAAG,EAAE,CAAC;AAE1E;;;GAGG;AACH,MAAM,uBAAuB,GAA2B,IAAI,GAAG,EAAE,CAAC;AAOlE;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,WAAW,CAAC,OAA2B;IACnD,OAAO,UAAiD,WAAc;;QAClE,gEAAgE;QAChE,MAAM,QAAQ,GAAG,IAAI,WAAW,EAAE,CAAC;QACnC,MAAM,QAAQ,GAAG,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,WAAW,EAAE,KAAI,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAEhF,8EAA8E;QAC9E,mDAAmD;QACnD,MAAM,WAAW,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QAC/E,MAAM,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QAE1F,iEAAiE;QACjE,MAAM,QAAQ,mBACV,IAAI,EAAE,WAAW,IACd,OAAO,CACb,CAAC;QACF,wBAAwB,CAAC,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAEpD,wDAAwD;QACxD,mGAAmG;QACnG,IAAI,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;YACnC,uBAAuB,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC;QACtE,CAAC;QACD,uBAAuB,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC;QAElE,OAAO,WAAW,CAAC;IACvB,CAAC,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAgB,6BAA6B;IACzC,OAAO,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC;AACzD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,4BAA4B,CAAC,IAAY,EAAE,QAAiB;IACxE,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAErC,8CAA8C;IAC9C,IAAI,QAAQ,EAAE,CAAC;QACX,OAAO,uBAAuB,CAAC,GAAG,CAAC,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,yBAAyB;IACzB,IAAI,uBAAuB,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QACzC,OAAO,uBAAuB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAClD,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,mBAAmB,CAAC,IAAY,EAAE,QAAiB;IAC/D,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IAErC,8CAA8C;IAC9C,IAAI,QAAQ,EAAE,CAAC;QACX,OAAO,wBAAwB,CAAC,GAAG,CAAC,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,+EAA+E;IAC/E,kDAAkD;IAClD,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,wBAAwB,EAAE,CAAC;QACjD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QAChB,CAAC;IACL,CAAC;IAED,OAAO,SAAS,CAAC;AACrB,CAAC"}
+{"version":3,"file":"function_metadata.js","sourceRoot":"","sources":["../../../src/parsing/functions/function_metadata.ts"],"names":[],"mappings":";;AAkLA,kCASC;AAKD,sEAEC;AAKD,oEAEC;AAKD,kDAEC;AAKD,gEAEC;AA9ID;;;GAGG;AACH,MAAM,gBAAgB;IAKlB,oFAAoF;IAC5E,MAAM,CAAC,iBAAiB,CAAC,SAAiB;QAC9C,MAAM,QAAQ,GAAW,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3F,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC;IAED,8CAA8C;IAC9C,MAAM,CAAC,aAAa,CAAwC,WAAc,EAAE,OAA2B;QACnG,MAAM,WAAW,GAAW,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACrE,MAAM,WAAW,GAAW,WAAW,CAAC,WAAW,EAAE,CAAC;QAEtD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,kBAAI,IAAI,EAAE,WAAW,IAAK,OAAO,EAAG,CAAC;QAClE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/F,CAAC;IAED,0CAA0C;IAC1C,MAAM,CAAC,gBAAgB,CAAwC,WAAc,EAAE,OAA2B;;QACtG,MAAM,QAAQ,GAAQ,IAAI,WAAW,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAW,CAAC,CAAA,MAAA,QAAQ,CAAC,IAAI,0CAAE,WAAW,EAAE,KAAI,WAAW,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1F,MAAM,WAAW,GAAW,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;QACvF,MAAM,WAAW,GAAW,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC;QAElG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,WAAW,kBAAI,IAAI,EAAE,WAAW,IAAK,OAAO,EAAG,CAAC;QAElE,IAAI,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE,CAAC;YACnC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,CAAC,cAAc;QACjB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,IAAY,EAAE,QAAiB;QAC9C,MAAM,SAAS,GAAW,IAAI,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,QAAQ;YAAE,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC,CAAC;QACnE,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS;gBAAE,OAAO,IAAI,CAAC;QAC7C,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,CAAC,UAAU,CAAC,IAAY,EAAE,QAAiB;QAC7C,MAAM,SAAS,GAAW,IAAI,CAAC,WAAW,EAAE,CAAC;QAC7C,IAAI,QAAQ;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,SAAS,IAAI,QAAQ,EAAE,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,CAAC,gBAAgB,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACvD,CAAC;;AAvDc,yBAAQ,GAAkC,IAAI,GAAG,EAA4B,CAAC;AAC9E,0BAAS,GAA2B,IAAI,GAAG,EAAqB,CAAC;AACjE,+BAAc,GAAmC,IAAI,GAAG,EAA6B,CAAC;AA6DzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,SAAgB,WAAW,CAAC,OAA2B;IACnD,OAAO,UAAiD,WAAc;QAClE,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YAC/B,gBAAgB,CAAC,aAAa,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;aAAM,CAAC;YACJ,gBAAgB,CAAC,gBAAgB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,WAAW,CAAC;IACvB,CAAC,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAgB,6BAA6B;IACzC,OAAO,gBAAgB,CAAC,cAAc,EAAE,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,SAAgB,4BAA4B,CAAC,IAAY,EAAE,QAAiB;IACxE,OAAO,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CAAC,IAAY,EAAE,QAAiB;IAC/D,OAAO,gBAAgB,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;AACxD,CAAC;AAED;;GAEG;AACH,SAAgB,0BAA0B,CAAC,IAAY;IACnD,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;AACnD,CAAC"}