@friggframework/schemas 2.0.0--canary.666.abcf913.0 → 2.0.0--canary.701.3b01ea3.0

package/README.md

@@ -172,7 +172,9 @@ Defines the structure for Frigg API modules.
 **Key Properties:**
 - `moduleName` (required): Module identifier
 - `getName` (required): Function returning module name
-- `requiredAuthMethods` (required): Authentication configuration
+- `requiredAuthMethods` (required): Authentication configuration (includes optional `getAuthorizationRequirements` and `setAuthParams` for API-key modules)
+- `modelName`: Entity/credential model name used by the Module runtime
+- Real Definitions (classes/functions) are accepted by `validateApiModuleDefinition` via a schema view.
 - `env`: Environment variable configuration
 - `config`: Module-specific configuration
 

package/api-module-definition.js

@@ -0,0 +1,93 @@
+/**
+ * API module definition helpers shared by validators and the frigg CLI.
+ * Real Definitions carry classes and functions that JSON Schema cannot
+ * describe; validators check the serialisable view produced here.
+ */
+
+function isPlainObject(value) {
+    if (value === null || typeof value !== 'object') return false;
+    const proto = Object.getPrototypeOf(value);
+    return proto === Object.prototype || proto === null;
+}
+
+/**
+ * Schema descriptor for a JavaScript function (see api-module-definition
+ * schema: `{ type: "function", async?: boolean }`).
+ *
+ * @param {Function} fn
+ * @returns {{ type: 'function', async?: boolean }}
+ */
+function toFunctionDescriptor(fn) {
+    const descriptor = { type: 'function' };
+    if (fn && fn.constructor && fn.constructor.name === 'AsyncFunction') {
+        descriptor.async = true;
+    }
+    return descriptor;
+}
+
+/**
+ * JSON Schema cannot describe a JavaScript class or function. Validators
+ * therefore check this serialisable view: the API class becomes an empty
+ * object, functions become `{ type: "function" }` descriptors, and
+ * `undefined` env values are dropped (unset `process.env.*` entries).
+ *
+ * @param {object} definition the `Definition` exported by an API module
+ * @returns {object} a view suitable for the api-module-definition schema
+ */
+function toApiModuleDefinitionSchemaView(definition) {
+    if (!isPlainObject(definition)) return definition;
+
+    const view = { ...definition };
+
+    if (typeof view.API === 'function') {
+        view.API = {};
+    }
+
+    if (typeof view.getName === 'function') {
+        view.getName = toFunctionDescriptor(view.getName);
+    }
+
+    if (isPlainObject(view.requiredAuthMethods)) {
+        const methods = { ...view.requiredAuthMethods };
+        for (const [key, value] of Object.entries(methods)) {
+            if (typeof value === 'function') {
+                methods[key] = toFunctionDescriptor(value);
+            }
+        }
+        view.requiredAuthMethods = methods;
+    }
+
+    if (isPlainObject(view.env)) {
+        const env = {};
+        for (const [key, value] of Object.entries(view.env)) {
+            if (value !== undefined) env[key] = value;
+        }
+        view.env = env;
+    }
+
+    if (isPlainObject(view.manager)) {
+        const manager = { ...view.manager };
+        for (const key of ['Entity', 'Credential']) {
+            if (typeof manager[key] === 'function') {
+                manager[key] = {};
+            }
+        }
+        if (isPlainObject(manager.methods)) {
+            const methods = { ...manager.methods };
+            for (const [key, value] of Object.entries(methods)) {
+                if (typeof value === 'function') {
+                    methods[key] = {};
+                }
+            }
+            manager.methods = methods;
+        }
+        view.manager = manager;
+    }
+
+    return view;
+}
+
+module.exports = {
+    toApiModuleDefinitionSchemaView,
+    toFunctionDescriptor,
+};

package/index.js

@@ -16,6 +16,9 @@ const {
     applyAppDefinitionDefaults,
     toAppDefinitionSchemaView,
 } = require('./app-definition');
+const {
+    toApiModuleDefinitionSchemaView,
+} = require('./api-module-definition');
 
 // Initialize AJV with formats
 const ajv = new Ajv({ 
@@ -99,12 +102,18 @@ function validateIntegrationDefinition(integrationDefinition) {
 }
 
 /**
- * Validate API Module Definition
- * @param {object} apiModuleDefinition - API module definition object to validate  
+ * Validate API Module Definition.
+ * Real Definitions carry classes and functions; validate the serialisable
+ * view and return the original definition (same pattern as validateAppDefinition).
+ * @param {object} apiModuleDefinition - API module definition object to validate
  * @returns {object} - Validation result
  */
 function validateApiModuleDefinition(apiModuleDefinition) {
-    return validate('api-module-definition', apiModuleDefinition);
+    const result = validate(
+        'api-module-definition',
+        toApiModuleDefinitionSchemaView(apiModuleDefinition)
+    );
+    return { ...result, data: apiModuleDefinition };
 }
 
 /**
@@ -369,6 +378,7 @@ module.exports = {
     validateAppDefinition,
     applyAppDefinitionDefaults,
     toAppDefinitionSchemaView,
+    toApiModuleDefinitionSchemaView,
     validateIntegrationDefinition,
     validateApiModuleDefinition,
     validateServerlessConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friggframework/schemas",
-  "version": "2.0.0--canary.666.abcf913.0",
+  "version": "2.0.0--canary.701.3b01ea3.0",
   "description": "Canonical JSON Schema definitions for Frigg Framework",
   "main": "index.js",
   "author": "",
@@ -40,7 +40,8 @@
     "mocks/",
     "middleware/",
     "app-definition.js",
+    "api-module-definition.js",
     "index.js"
   ],
-  "gitHead": "abcf913cf7580597fd286b2f5b93d3ccf4609ef6"
+  "gitHead": "3b01ea3abd65f1771e9bb1f143168da6acff4125"
 }

package/schemas/api-module-definition.schema.json

@@ -27,6 +27,13 @@
       "minLength": 1,
       "maxLength": 100
     },
+    "modelName": {
+      "type": "string",
+      "description": "Entity/credential model name used by the Module runtime (e.g. 'Fathom'). Distinct from moduleName, which is the package identifier.",
+      "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$",
+      "minLength": 1,
+      "maxLength": 100
+    },
     "requiredAuthMethods": {
       "type": "object",
       "description": "Required authentication methods and configuration",
@@ -90,6 +97,22 @@
             "type": {"type": "string", "enum": ["function"]},
             "async": {"type": "boolean", "default": true}
           }
+        },
+        "getAuthorizationRequirements": {
+          "type": "object",
+          "description": "Method that returns the authorization requirements (type, jsonSchema/uiSchema) for non-OAuth flows such as API key",
+          "properties": {
+            "type": {"type": "string", "enum": ["function"]},
+            "async": {"type": "boolean", "default": true}
+          }
+        },
+        "setAuthParams": {
+          "type": "object",
+          "description": "Method that applies authorization parameters (e.g. API key) to the API instance",
+          "properties": {
+            "type": {"type": "string", "enum": ["function"]},
+            "async": {"type": "boolean", "default": true}
+          }
         }
       },
       "additionalProperties": false