flowquery 1.0.5 → 1.0.7

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

@@ -1 +1 @@
-{"version":3,"file":"function_factory.js","sourceRoot":"","sources":["../../../src/parsing/functions/function_factory.ts"],"names":[],"mappings":";;;;;AAAA,gDAAwB;AACxB,wDAAgC;AAChC,gDAAwB;AACxB,oDAA4B;AAC5B,kDAA0B;AAC1B,oDAA4B;AAC5B,oDAA4B;AAC5B,kDAA0B;AAC1B,wDAA+B;AAC/B,wDAAgC;AAChC,4DAAoC;AACpC,kDAA0B;AAC1B,4DAAoC;AACpC,0DAAkC;AAClC,2DAK6B;AAa7B;;;;;;;;;;;GAWG;AACH,MAAM,eAAe;IAgBjB;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAY,EAAE,gBAA2D;QAC5F,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE,CAAC;YACzC,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;QAC7D,CAAC;aAAM,CAAC;YACJ,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC;YACjE,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,kCAC/B,gBAAgB,CAAC,QAAQ,KAC5B,IAAI,EAAE,SAAS,EACf,eAAe,EAAE,KAAK,IACxB,CAAC;QACP,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,IAAY;QACjC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC1C,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACI,MAAM,CAAC,qBAAqB,CAAC,IAAY,EAAE,iBAAmE;QACjH,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE,CAAC;YAC1C,eAAe,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;QACrE,CAAC;aAAM,CAAC;YACJ,eAAe,CAAC,cAAc,CAAC,GAAG,CAAC,SAAS,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;YAC1E,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,kCAC/B,iBAAiB,CAAC,QAAQ,KAC7B,IAAI,EAAE,SAAS,EACf,eAAe,EAAE,IAAI,IACvB,CAAC;QACP,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,uBAAuB,CAAC,IAAY;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,eAAe,CAAC,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACjD,eAAe,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACvC,OAAO,eAAe,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY;QACtC,OAAO,eAAe,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAClE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QAClC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,8BAA8B;QAC9B,IAAI,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1C,OAAO,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACnD,CAAC;QACD,iCAAiC;QACjC,OAAO,6CAAyB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,aAAa,CAAC,OAK3B;QACG,MAAM,MAAM,GAAuB,EAAE,CAAC;QACtC,MAAM,eAAe,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe,MAAK,KAAK,CAAC;QAE3D,yBAAyB;QACzB,IAAI,eAAe,EAAE,CAAC;YAClB,KAAK,MAAM,IAAI,IAAI,6CAAyB,EAAE,CAAC;gBAC3C,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;oBAAE,SAAS;gBACtE,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS;oBAAE,SAAS,CAAC,qBAAqB;gBACvD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;QACL,CAAC;QAED,uBAAuB;QACvB,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,eAAe,CAAC,QAAQ,EAAE,CAAC;YAClD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;gBAAE,SAAS;YACtE,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,KAAI,CAAC,IAAI,CAAC,eAAe;gBAAE,SAAS;YAC1D,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,IAAI,CAAC,eAAe;gBAAE,SAAS;YACxD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB;QAC3B,MAAM,YAAY,GAAG,6CAAyB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QAChE,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/D,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;QACrE,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,YAAY,EAAE,GAAG,WAAW,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM;QAChB,MAAM,SAAS,GAAG,eAAe,CAAC,aAAa,EAAE,CAAC;QAClD,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAa,CAAC;QAC5F,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,IAAY;QAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAErC,4DAA4D;QAC5D,IAAI,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YACzC,OAAO,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAE,EAAE,CAAC;QACrD,CAAC;QAED,QAAQ,SAAS,EAAE,CAAC;YAChB,KAAK,KAAK;gBACN,OAAO,IAAI,aAAG,EAAE,CAAC;YACrB,KAAK,SAAS;gBACV,OAAO,IAAI,iBAAO,EAAE,CAAC;YACzB,KAAK,KAAK;gBACN,OAAO,IAAI,aAAG,EAAE,CAAC;YACrB,KAAK,OAAO;gBACR,OAAO,IAAI,eAAK,EAAE,CAAC;YACvB,KAAK,MAAM;gBACP,OAAO,IAAI,cAAI,EAAE,CAAC;YACtB,KAAK,OAAO;gBACR,OAAO,IAAI,eAAK,EAAE,CAAC;YACvB,KAAK,OAAO;gBACR,OAAO,IAAI,eAAK,EAAE,CAAC;YACvB,KAAK,MAAM;gBACP,OAAO,IAAI,cAAI,EAAE,CAAC;YACtB,KAAK,QAAQ;gBACT,OAAO,IAAI,iBAAM,EAAE,CAAC;YACxB,KAAK,SAAS;gBACV,OAAO,IAAI,iBAAO,EAAE,CAAC;YACzB,KAAK,WAAW;gBACZ,OAAO,IAAI,mBAAS,EAAE,CAAC;YAC3B,KAAK,MAAM;gBACP,OAAO,IAAI,cAAI,EAAE,CAAC;YACtB,KAAK,WAAW;gBACZ,OAAO,IAAI,mBAAS,EAAE,CAAC;YAC3B;gBACI,OAAO,IAAI,kBAAQ,CAAC,IAAI,CAAC,CAAC;QAClC,CAAC;IACL,CAAC;;AAtPD;;GAEG;AACY,uBAAO,GAAiC,IAAI,GAAG,EAAE,CAAC;AAEjE;;GAEG;AACY,8BAAc,GAAmC,IAAI,GAAG,EAAE,CAAC;AAE1E;;GAEG;AACY,wBAAQ,GAAkC,IAAI,GAAG,EAAE,CAAC;AA4OvE,kBAAe,eAAe,CAAC"}
+{"version":3,"file":"function_factory.js","sourceRoot":"","sources":["../../../src/parsing/functions/function_factory.ts"],"names":[],"mappings":";;;;;AAAA,0DAAkC;AAClC,8EAAqD;AACrD,wEAAwE;AACxE,iBAAe;AACf,qBAAmB;AACnB,iBAAe;AACf,mBAAiB;AACjB,kBAAgB;AAChB,mBAAiB;AACjB,mBAAiB;AACjB,kBAAgB;AAChB,qBAAmB;AACnB,qBAAmB;AACnB,uBAAqB;AACrB,kBAAgB;AAChB,uBAAqB;AACrB,2BAAyB;AACzB,2DAO6B;AAK7B;;;;;;;;;;;;GAYG;AACH,MAAM,eAAe;IACjB;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAY;QACvC,OAAO,IAAA,8CAA0B,EAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY;QACtC,OAAO,IAAA,8CAA0B,EAAC,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,SAAS,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,WAAW,CAAC,IAAY;QAClC,OAAO,IAAA,uCAAmB,EAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACnD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,aAAa,CAAC,OAI3B;QACG,MAAM,MAAM,GAAuB,EAAE,CAAC;QAEtC,KAAK,MAAM,IAAI,IAAI,IAAA,iDAA6B,GAAE,EAAE,CAAC;YACjD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,IAAI,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ;gBAAE,SAAS;YACtE,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS,KAAI,IAAI,CAAC,QAAQ,KAAK,OAAO;gBAAE,SAAS;YAC9D,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,KAAI,IAAI,CAAC,QAAQ,KAAK,OAAO;gBAAE,SAAS;YAC7D,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtB,CAAC;QAED,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB;QAC3B,OAAO,IAAA,iDAA6B,GAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM;QAChB,MAAM,SAAS,GAAG,eAAe,CAAC,aAAa,EAAE,CAAC;QAClD,MAAM,UAAU,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAa,CAAC;QAC5F,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;IACrC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,MAAM,CAAC,IAAY;QAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAErC,oEAAoE;QACpE,MAAM,gBAAgB,GAAG,IAAA,gDAA4B,EAAC,SAAS,CAAC,CAAC;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACnB,OAAO,gBAAgB,EAAE,CAAC;QAC9B,CAAC;QAED,sDAAsD;QACtD,OAAO,IAAI,kBAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,eAAe,CAAC,IAAY;QACtC,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAErC,iDAAiD;QACjD,MAAM,gBAAgB,GAAG,IAAA,gDAA4B,EAAC,SAAS,EAAE,WAAW,CAAC,CAAC;QAC9E,IAAI,gBAAgB,EAAE,CAAC;YACnB,OAAO,gBAAgB,EAAE,CAAC;QAC9B,CAAC;QAED,yEAAyE;QACzE,OAAO,IAAI,4BAAiB,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;CACJ;AAED,kBAAe,eAAe,CAAC"}

package/dist/parsing/functions/function_metadata.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Category types for functions.
+ * Core categories: scalar, aggregate, predicate, async
+ * Additional categories for organization: string, math, data, etc.
+ */
+export type FunctionCategory = "scalar" | "aggregate" | "predicate" | "async" | string;
 /**
  * Schema definition for function arguments and outputs.
  * Compatible with JSON Schema for LLM consumption.
@@ -45,39 +51,94 @@ export interface FunctionMetadata {
     name: string;
     /** Human-readable description of what the function does */
     description: string;
-    /** Category for grouping functions (e.g., "aggregation", "string", "data") */
-    category?: string;
+    /** Category that determines function type and behavior */
+    category: FunctionCategory;
     /** Array of parameter schemas */
     parameters: ParameterSchema[];
     /** Output schema */
     output: OutputSchema;
     /** Example usage in FlowQuery syntax */
     examples?: string[];
-    /** Whether this is an async data provider for LOAD operations */
-    isAsyncProvider?: boolean;
     /** Additional notes or caveats */
     notes?: string;
 }
 /**
- * Options for registering a sync function with metadata.
+ * Type for async data provider functions used in LOAD operations.
  */
-export interface RegisterFunctionOptions {
-    /** Factory function that creates the Function instance */
-    factory: () => any;
-    /** Function metadata for documentation */
-    metadata: FunctionMetadata;
-}
+export type AsyncDataProvider = (...args: any[]) => AsyncGenerator<any, void, unknown> | Promise<any>;
 /**
- * Options for registering an async data provider with metadata.
+ * Decorator options - metadata without the name (derived from class).
  */
-export interface RegisterAsyncProviderOptions {
-    /** Async generator or function that returns data */
-    provider: (...args: any[]) => AsyncGenerator<any, void, unknown> | Promise<any>;
-    /** Function metadata for documentation */
-    metadata: FunctionMetadata;
-}
+export type FunctionDefOptions = Omit<FunctionMetadata, 'name'>;
+/**
+ * Class decorator that registers function metadata.
+ * 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",
+ *     parameters: [{ name: "value", description: "Numeric value to sum", type: "number" }],
+ *     output: { description: "Sum of all values", type: "number", example: 150 },
+ *     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> { ... }
+ * }
+ * ```
+ */
+export declare function FunctionDef(options: FunctionDefOptions): <T extends new (...args: any[]) => any>(constructor: T) => T;
+/**
+ * Gets all registered function metadata from decorators.
+ *
+ * @returns Array of function metadata
+ */
+export declare function getRegisteredFunctionMetadata(): FunctionMetadata[];
+/**
+ * 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
+ */
+export declare function getRegisteredFunctionFactory(name: string, category?: string): (() => any) | undefined;
+/**
+ * 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
+ */
+export declare function getFunctionMetadata(name: string, category?: string): FunctionMetadata | undefined;
 /**
- * Built-in function metadata definitions.
+ * Gets a registered async data provider by name.
+ * Used by FunctionFactory to get decorator-registered async providers.
+ *
+ * @param name - Function name (case-insensitive)
+ * @returns Async data provider or undefined
  */
-export declare const BUILTIN_FUNCTION_METADATA: FunctionMetadata[];
+export declare function getRegisteredAsyncProvider(name: string): AsyncDataProvider | undefined;
 //# sourceMappingURL=function_metadata.d.ts.map

package/dist/parsing/functions/function_metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"function_metadata.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/function_metadata.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,qEAAqE;IACrE,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7E,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,sCAAsC;IACtC,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;IAC/D,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IACxE,6BAA6B;IAC7B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,oBAAoB;IACpB,OAAO,CAAC,EAAE,GAAG,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7E,sCAAsC;IACtC,KAAK,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;IAC1C,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IACxE,2BAA2B;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,8EAA8E;IAC9E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,oBAAoB;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,iEAAiE;IACjE,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACpC,0DAA0D;IAC1D,OAAO,EAAE,MAAM,GAAG,CAAC;IACnB,0CAA0C;IAC1C,QAAQ,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IACzC,oDAAoD;IACpD,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IAChF,0CAA0C;IAC1C,QAAQ,EAAE,gBAAgB,CAAC;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,gBAAgB,EAuJvD,CAAC"}
+{"version":3,"file":"function_metadata.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/function_metadata.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,MAAM,CAAC;AAEvF;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,qEAAqE;IACrE,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7E,wDAAwD;IACxD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,OAAO,CAAC,EAAE,GAAG,CAAC;IACd,sCAAsC;IACtC,KAAK,CAAC,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC,CAAC;IAC/D,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IACxE,6BAA6B;IAC7B,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;IACb,oBAAoB;IACpB,OAAO,CAAC,EAAE,GAAG,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,uBAAuB;IACvB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;IAC7E,sCAAsC;IACtC,KAAK,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;IAC1C,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;IACxE,2BAA2B;IAC3B,OAAO,CAAC,EAAE,GAAG,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,0DAA0D;IAC1D,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,iCAAiC;IACjC,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,oBAAoB;IACpB,MAAM,EAAE,YAAY,CAAC;IACrB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAaD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;AAOtG;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;AAEhE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,kBAAkB,IAClC,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,eAAe,CAAC,KAAG,CAAC,CAoD7E;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,IAAI,gBAAgB,EAAE,CAElE;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,CAAC,GAAG,SAAS,CAcrG;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAiBjG;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,MAAM,GAAG,iBAAiB,GAAG,SAAS,CAEtF"}

package/dist/parsing/functions/function_metadata.js

@@ -1,159 +1,161 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BUILTIN_FUNCTION_METADATA = void 0;
+exports.FunctionDef = FunctionDef;
+exports.getRegisteredFunctionMetadata = getRegisteredFunctionMetadata;
+exports.getRegisteredFunctionFactory = getRegisteredFunctionFactory;
+exports.getFunctionMetadata = getFunctionMetadata;
+exports.getRegisteredAsyncProvider = getRegisteredAsyncProvider;
 /**
- * Built-in function metadata definitions.
+ * Registry for function metadata collected via decorators.
  */
-exports.BUILTIN_FUNCTION_METADATA = [
-    {
-        name: "sum",
-        description: "Calculates the sum of numeric values across grouped rows",
-        category: "aggregation",
-        parameters: [
-            { name: "value", description: "Numeric value to sum", type: "number" }
-        ],
-        output: { description: "Sum of all values", type: "number", example: 150 },
-        examples: ["WITH [1, 2, 3] AS nums UNWIND nums AS n RETURN sum(n)"]
-    },
-    {
-        name: "avg",
-        description: "Calculates the average of numeric values across grouped rows",
-        category: "aggregation",
-        parameters: [
-            { name: "value", description: "Numeric value to average", type: "number" }
-        ],
-        output: { description: "Average of all values", type: "number", example: 50 },
-        examples: ["WITH [10, 20, 30] AS nums UNWIND nums AS n RETURN avg(n)"]
-    },
-    {
-        name: "collect",
-        description: "Collects values into an array across grouped rows",
-        category: "aggregation",
-        parameters: [
-            { name: "value", description: "Value to collect", type: "any" }
-        ],
-        output: { description: "Array of collected values", type: "array", example: [1, 2, 3] },
-        examples: ["WITH [1, 2, 3] AS nums UNWIND nums AS n RETURN collect(n)"]
-    },
-    {
-        name: "range",
-        description: "Generates an array of sequential integers",
-        category: "generator",
-        parameters: [
-            { name: "start", description: "Starting number (inclusive)", type: "number" },
-            { name: "end", description: "Ending number (inclusive)", type: "number" }
-        ],
-        output: { description: "Array of integers from start to end", type: "array", items: { type: "number" }, example: [1, 2, 3, 4, 5] },
-        examples: ["WITH range(1, 5) AS nums RETURN nums"]
-    },
-    {
-        name: "rand",
-        description: "Generates a random number between 0 and 1",
-        category: "generator",
-        parameters: [],
-        output: { description: "Random number between 0 and 1", type: "number", example: 0.7234 },
-        examples: ["WITH rand() AS r RETURN r"]
-    },
-    {
-        name: "round",
-        description: "Rounds a number to the nearest integer",
-        category: "math",
-        parameters: [
-            { name: "value", description: "Number to round", type: "number" }
-        ],
-        output: { description: "Rounded integer", type: "number", example: 4 },
-        examples: ["WITH 3.7 AS n RETURN round(n)"]
-    },
-    {
-        name: "split",
-        description: "Splits a string into an array by a delimiter",
-        category: "string",
-        parameters: [
-            { name: "text", description: "String to split", type: "string" },
-            { name: "delimiter", description: "Delimiter to split by", type: "string" }
-        ],
-        output: { description: "Array of string parts", type: "array", items: { type: "string" }, example: ["a", "b", "c"] },
-        examples: ["WITH 'a,b,c' AS s RETURN split(s, ',')"]
-    },
-    {
-        name: "join",
-        description: "Joins an array of strings with a delimiter",
-        category: "string",
-        parameters: [
-            { name: "array", description: "Array of values to join", type: "array" },
-            { name: "delimiter", description: "Delimiter to join with", type: "string" }
-        ],
-        output: { description: "Joined string", type: "string", example: "a,b,c" },
-        examples: ["WITH ['a', 'b', 'c'] AS arr RETURN join(arr, ',')"]
-    },
-    {
-        name: "replace",
-        description: "Replaces occurrences of a pattern in a string",
-        category: "string",
-        parameters: [
-            { name: "text", description: "Source string", type: "string" },
-            { name: "pattern", description: "Pattern to find", type: "string" },
-            { name: "replacement", description: "Replacement string", type: "string" }
-        ],
-        output: { description: "String with replacements", type: "string", example: "hello world" },
-        examples: ["WITH 'hello there' AS s RETURN replace(s, 'there', 'world')"]
-    },
-    {
-        name: "stringify",
-        description: "Converts a value to its JSON string representation",
-        category: "conversion",
-        parameters: [
-            { name: "value", description: "Value to stringify", type: "any" }
-        ],
-        output: { description: "JSON string", type: "string", example: "{\"a\":1}" },
-        examples: ["WITH {a: 1} AS obj RETURN stringify(obj)"]
-    },
-    {
-        name: "tojson",
-        description: "Parses a JSON string into an object",
-        category: "conversion",
-        parameters: [
-            { name: "text", description: "JSON string to parse", type: "string" }
-        ],
-        output: { description: "Parsed object or array", type: "object", example: { a: 1 } },
-        examples: ["WITH '{\"a\": 1}' AS s RETURN tojson(s)"]
-    },
-    {
-        name: "size",
-        description: "Returns the length of an array or string",
-        category: "utility",
-        parameters: [
-            { name: "value", description: "Array or string to measure", type: "array" }
-        ],
-        output: { description: "Length of the input", type: "number", example: 3 },
-        examples: ["WITH [1, 2, 3] AS arr RETURN size(arr)"]
-    },
-    {
-        name: "functions",
-        description: "Lists all registered functions with their metadata. Useful for discovering available functions and their documentation. Results include name, description, parameters, output schema, and usage examples.",
-        category: "introspection",
-        parameters: [
-            { name: "category", description: "Optional category to filter by (e.g., 'aggregation', 'string', 'math')", type: "string", required: false }
-        ],
-        output: {
-            description: "Array of function metadata objects",
-            type: "array",
-            items: {
-                type: "object",
-                properties: {
-                    name: { description: "Function name", type: "string" },
-                    description: { description: "What the function does", type: "string" },
-                    category: { description: "Function category", type: "string" },
-                    parameters: { description: "Array of parameter definitions", type: "array" },
-                    output: { description: "Output schema", type: "object" },
-                    examples: { description: "Usage examples", type: "array" }
-                }
+const functionMetadataRegistry = new Map();
+/**
+ * Registry for function factories collected via decorators.
+ * Allows @FunctionDef to automatically register functions for instantiation.
+ */
+const functionFactoryRegistry = new Map();
+/**
+ * Registry for async data providers collected via decorators.
+ */
+const asyncProviderRegistry = new Map();
+/**
+ * Class decorator that registers function metadata.
+ * 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",
+ *     parameters: [{ name: "value", description: "Numeric value to sum", type: "number" }],
+ *     output: { description: "Sum of all values", type: "number", example: 150 },
+ *     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;
+        // Handle async providers differently
+        if (options.category === 'async') {
+            // Derive the function name from the class name
+            // Remove 'Loader' suffix if present and convert to lowercase for registry
+            let baseName = constructor.name;
+            if (baseName.endsWith('Loader')) {
+                baseName = baseName.slice(0, -6);
             }
-        },
-        examples: [
-            "WITH functions() AS funcs RETURN funcs",
-            "WITH functions('aggregation') AS funcs UNWIND funcs AS f RETURN f.name, f.description"
-        ]
+            // Keep display name in camelCase, but use lowercase for registry keys
+            const displayName = baseName.charAt(0).toLowerCase() + baseName.slice(1);
+            const registryKey = displayName.toLowerCase();
+            // Register metadata with display name
+            const metadata = Object.assign({ name: displayName }, options);
+            functionMetadataRegistry.set(registryKey, metadata);
+            // Register the async provider (wraps the class's fetch method)
+            asyncProviderRegistry.set(registryKey, (...args) => new constructor().fetch(...args));
+            return constructor;
+        }
+        // Regular function handling
+        // 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());
+        }
+        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());
+}
+/**
+ * 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;
+}
+/**
+ * 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;
+}
+/**
+ * Gets a registered async data provider by name.
+ * Used by FunctionFactory to get decorator-registered async providers.
+ *
+ * @param name - Function name (case-insensitive)
+ * @returns Async data provider or undefined
+ */
+function getRegisteredAsyncProvider(name) {
+    return asyncProviderRegistry.get(name.toLowerCase());
+}
 //# 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":";;;AAmFA;;GAEG;AACU,QAAA,yBAAyB,GAAuB;IACzD;QACI,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,0DAA0D;QACvE,QAAQ,EAAE,aAAa;QACvB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,sBAAsB,EAAE,IAAI,EAAE,QAAQ,EAAE;SACzE;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;QAC1E,QAAQ,EAAE,CAAC,uDAAuD,CAAC;KACtE;IACD;QACI,IAAI,EAAE,KAAK;QACX,WAAW,EAAE,8DAA8D;QAC3E,QAAQ,EAAE,aAAa;QACvB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,0BAA0B,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC7E;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE;QAC7E,QAAQ,EAAE,CAAC,0DAA0D,CAAC;KACzE;IACD;QACI,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,mDAAmD;QAChE,QAAQ,EAAE,aAAa;QACvB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,IAAI,EAAE,KAAK,EAAE;SAClE;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,2BAA2B,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE;QACvF,QAAQ,EAAE,CAAC,2DAA2D,CAAC;KAC1E;IACD;QACI,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,2CAA2C;QACxD,QAAQ,EAAE,WAAW;QACrB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC7E,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,2BAA2B,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC5E;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,qCAAqC,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE;QAClI,QAAQ,EAAE,CAAC,sCAAsC,CAAC;KACrD;IACD;QACI,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,2CAA2C;QACxD,QAAQ,EAAE,WAAW;QACrB,UAAU,EAAE,EAAE;QACd,MAAM,EAAE,EAAE,WAAW,EAAE,+BAA+B,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE;QACzF,QAAQ,EAAE,CAAC,2BAA2B,CAAC;KAC1C;IACD;QACI,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,wCAAwC;QACrD,QAAQ,EAAE,MAAM;QAChB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE;SACpE;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE;QACtE,QAAQ,EAAE,CAAC,+BAA+B,CAAC;KAC9C;IACD;QACI,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,8CAA8C;QAC3D,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE;YAChE,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC9E;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,uBAAuB,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE;QACpH,QAAQ,EAAE,CAAC,wCAAwC,CAAC;KACvD;IACD;QACI,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,4CAA4C;QACzD,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,yBAAyB,EAAE,IAAI,EAAE,OAAO,EAAE;YACxE,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,wBAAwB,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC/E;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE;QAC1E,QAAQ,EAAE,CAAC,mDAAmD,CAAC;KAClE;IACD;QACI,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,+CAA+C;QAC5D,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC9D,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE;YACnE,EAAE,IAAI,EAAE,aAAa,EAAE,WAAW,EAAE,oBAAoB,EAAE,IAAI,EAAE,QAAQ,EAAE;SAC7E;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,0BAA0B,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE;QAC3F,QAAQ,EAAE,CAAC,6DAA6D,CAAC;KAC5E;IACD;QACI,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,oDAAoD;QACjE,QAAQ,EAAE,YAAY;QACtB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,oBAAoB,EAAE,IAAI,EAAE,KAAK,EAAE;SACpE;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE;QAC5E,QAAQ,EAAE,CAAC,0CAA0C,CAAC;KACzD;IACD;QACI,IAAI,EAAE,QAAQ;QACd,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE,YAAY;QACtB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,sBAAsB,EAAE,IAAI,EAAE,QAAQ,EAAE;SACxE;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,wBAAwB,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE;QACpF,QAAQ,EAAE,CAAC,yCAAyC,CAAC;KACxD;IACD;QACI,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,0CAA0C;QACvD,QAAQ,EAAE,SAAS;QACnB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,4BAA4B,EAAE,IAAI,EAAE,OAAO,EAAE;SAC9E;QACD,MAAM,EAAE,EAAE,WAAW,EAAE,qBAAqB,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE;QAC1E,QAAQ,EAAE,CAAC,wCAAwC,CAAC;KACvD;IACD;QACI,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,2MAA2M;QACxN,QAAQ,EAAE,eAAe;QACzB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,wEAAwE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;SAC/I;QACD,MAAM,EAAE;YACJ,WAAW,EAAE,oCAAoC;YACjD,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACR,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACtD,WAAW,EAAE,EAAE,WAAW,EAAE,wBAAwB,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACtE,QAAQ,EAAE,EAAE,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC9D,UAAU,EAAE,EAAE,WAAW,EAAE,gCAAgC,EAAE,IAAI,EAAE,OAAO,EAAE;oBAC5E,MAAM,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxD,QAAQ,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE;iBAC7D;aACJ;SACJ;QACD,QAAQ,EAAE;YACN,wCAAwC;YACxC,uFAAuF;SAC1F;KACJ;CACJ,CAAC"}
+{"version":3,"file":"function_metadata.js","sourceRoot":"","sources":["../../../src/parsing/functions/function_metadata.ts"],"names":[],"mappings":";;AAmIA,kCAqDC;AAOD,sEAEC;AAUD,oEAcC;AAWD,kDAiBC;AASD,gEAEC;AA5LD;;GAEG;AACH,MAAM,wBAAwB,GAAkC,IAAI,GAAG,EAAE,CAAC;AAE1E;;;GAGG;AACH,MAAM,uBAAuB,GAA2B,IAAI,GAAG,EAAE,CAAC;AAOlE;;GAEG;AACH,MAAM,qBAAqB,GAAmC,IAAI,GAAG,EAAE,CAAC;AAOxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,SAAgB,WAAW,CAAC,OAA2B;IACnD,OAAO,UAAiD,WAAc;;QAClE,qCAAqC;QACrC,IAAI,OAAO,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;YAC/B,+CAA+C;YAC/C,0EAA0E;YAC1E,IAAI,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC;YAChC,IAAI,QAAQ,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC9B,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;YACrC,CAAC;YACD,sEAAsE;YACtE,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACzE,MAAM,WAAW,GAAG,WAAW,CAAC,WAAW,EAAE,CAAC;YAE9C,sCAAsC;YACtC,MAAM,QAAQ,mBACV,IAAI,EAAE,WAAW,IACd,OAAO,CACb,CAAC;YACF,wBAAwB,CAAC,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAEpD,+DAA+D;YAC/D,qBAAqB,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,IAAI,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YAE7F,OAAO,WAAW,CAAC;QACvB,CAAC;QAED,4BAA4B;QAC5B,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;AAED;;;;;;GAMG;AACH,SAAgB,0BAA0B,CAAC,IAAY;IACnD,OAAO,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AACzD,CAAC"}

package/dist/parsing/functions/functions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/functions.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAC;AAGlC;;;;;;;;;;;;;GAaG;AACH,cAAM,SAAU,SAAQ,QAAQ;;IAMrB,KAAK,IAAI,GAAG;CAiBtB;AAED,eAAe,SAAS,CAAC"}
+{"version":3,"file":"functions.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/functions.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,YAAY,CAAC;AAIlC;;;;;;;;;;;;;GAaG;AACH,cA0BM,SAAU,SAAQ,QAAQ;;IAMrB,KAAK,IAAI,GAAG;CAiBtB;AAED,eAAe,SAAS,CAAC"}

package/dist/parsing/functions/functions.js

@@ -1,10 +1,17 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const function_1 = __importDefault(require("./function"));
 const function_factory_1 = __importDefault(require("./function_factory"));
+const function_metadata_1 = require("./function_metadata");
 /**
  * Built-in function that lists all registered functions with their metadata.
  *
@@ -19,7 +26,7 @@ const function_factory_1 = __importDefault(require("./function_factory"));
  * RETURN func.name, func.description
  * ```
  */
-class Functions extends function_1.default {
+let Functions = class Functions extends function_1.default {
     constructor() {
         super("functions");
         this._expectedParameterCount = null; // 0 or 1 parameter
@@ -42,6 +49,34 @@ class Functions extends function_1.default {
             throw new Error("functions() takes 0 or 1 parameters");
         }
     }
-}
+};
+Functions = __decorate([
+    (0, function_metadata_1.FunctionDef)({
+        description: "Lists all registered functions with their metadata. Useful for discovering available functions and their documentation. Results include name, description, parameters, output schema, and usage examples.",
+        category: "scalar",
+        parameters: [
+            { name: "category", description: "Optional category to filter by (e.g., 'aggregation', 'string', 'math')", type: "string", required: false }
+        ],
+        output: {
+            description: "Array of function metadata objects",
+            type: "array",
+            items: {
+                type: "object",
+                properties: {
+                    name: { description: "Function name", type: "string" },
+                    description: { description: "What the function does", type: "string" },
+                    category: { description: "Function category", type: "string" },
+                    parameters: { description: "Array of parameter definitions", type: "array" },
+                    output: { description: "Output schema", type: "object" },
+                    examples: { description: "Usage examples", type: "array" }
+                }
+            }
+        },
+        examples: [
+            "WITH functions() AS funcs RETURN funcs",
+            "WITH functions('aggregation') AS funcs UNWIND funcs AS f RETURN f.name, f.description"
+        ]
+    })
+], Functions);
 exports.default = Functions;
 //# sourceMappingURL=functions.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../../src/parsing/functions/functions.ts"],"names":[],"mappings":";;;;;AAAA,0DAAkC;AAClC,0EAAiD;AAEjD;;;;;;;;;;;;;GAaG;AACH,MAAM,SAAU,SAAQ,kBAAQ;IAC5B;QACI,KAAK,CAAC,WAAW,CAAC,CAAC;QACnB,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,CAAC,mBAAmB;IAC5D,CAAC;IAEM,KAAK;QACR,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAEpC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,uBAAuB;YACvB,OAAO,0BAAe,CAAC,aAAa,EAAE,CAAC;QAC3C,CAAC;aAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,qBAAqB;YACrB,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YACrC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,0BAAe,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACvD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvE,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;CACJ;AAED,kBAAe,SAAS,CAAC"}
+{"version":3,"file":"functions.js","sourceRoot":"","sources":["../../../src/parsing/functions/functions.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,0DAAkC;AAClC,0EAAiD;AACjD,2DAAkD;AAElD;;;;;;;;;;;;;GAaG;AA2BH,IAAM,SAAS,GAAf,MAAM,SAAU,SAAQ,kBAAQ;IAC5B;QACI,KAAK,CAAC,WAAW,CAAC,CAAC;QACnB,IAAI,CAAC,uBAAuB,GAAG,IAAI,CAAC,CAAC,mBAAmB;IAC5D,CAAC;IAEM,KAAK;QACR,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QAEpC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxB,uBAAuB;YACvB,OAAO,0BAAe,CAAC,aAAa,EAAE,CAAC;QAC3C,CAAC;aAAM,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/B,qBAAqB;YACrB,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YACrC,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;gBAC/B,OAAO,0BAAe,CAAC,aAAa,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;YACvD,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACvE,CAAC;aAAM,CAAC;YACJ,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QAC3D,CAAC;IACL,CAAC;CACJ,CAAA;AAvBK,SAAS;IA1Bd,IAAA,+BAAW,EAAC;QACT,WAAW,EAAE,2MAA2M;QACxN,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE;YACR,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,wEAAwE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE;SAC/I;QACD,MAAM,EAAE;YACJ,WAAW,EAAE,oCAAoC;YACjD,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACR,IAAI,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACtD,WAAW,EAAE,EAAE,WAAW,EAAE,wBAAwB,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACtE,QAAQ,EAAE,EAAE,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC9D,UAAU,EAAE,EAAE,WAAW,EAAE,gCAAgC,EAAE,IAAI,EAAE,OAAO,EAAE;oBAC5E,MAAM,EAAE,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxD,QAAQ,EAAE,EAAE,WAAW,EAAE,gBAAgB,EAAE,IAAI,EAAE,OAAO,EAAE;iBAC7D;aACJ;SACJ;QACD,QAAQ,EAAE;YACN,wCAAwC;YACxC,uFAAuF;SAC1F;KACJ,CAAC;GACI,SAAS,CAuBd;AAED,kBAAe,SAAS,CAAC"}

package/dist/parsing/functions/join.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"join.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/join.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,aAAa,CAAC;AAClC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAGlC,cAAM,IAAK,SAAQ,QAAQ;;IAKvB,IAAW,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAKrC;IACM,KAAK,IAAI,GAAG;CAQtB;AAED,eAAe,IAAI,CAAC"}
+{"version":3,"file":"join.d.ts","sourceRoot":"","sources":["../../../src/parsing/functions/join.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,aAAa,CAAC;AAClC,OAAO,QAAQ,MAAM,YAAY,CAAC;AAIlC,cAUM,IAAK,SAAQ,QAAQ;;IAKvB,IAAW,UAAU,CAAC,KAAK,EAAE,OAAO,EAAE,EAKrC;IACM,KAAK,IAAI,GAAG;CAQtB;AAED,eAAe,IAAI,CAAC"}