@friggframework/schemas 2.0.0--canary.702.d5e6de1.0 → 2.0.0--canary.666.89f6545.0

package/README.md

@@ -172,9 +172,7 @@ Defines the structure for Frigg API modules.
 **Key Properties:**
 - `moduleName` (required): Module identifier
 - `getName` (required): Function returning module name
-- `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.
+- `requiredAuthMethods` (required): Authentication configuration
 - `env`: Environment variable configuration
 - `config`: Module-specific configuration
 

package/index.js

@@ -16,9 +16,6 @@ const {
     applyAppDefinitionDefaults,
     toAppDefinitionSchemaView,
 } = require('./app-definition');
-const {
-    toApiModuleDefinitionSchemaView,
-} = require('./api-module-definition');
 
 // Initialize AJV with formats
 const ajv = new Ajv({ 
@@ -102,18 +99,12 @@ function validateIntegrationDefinition(integrationDefinition) {
 }
 
 /**
- * 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
+ * Validate API Module Definition
+ * @param {object} apiModuleDefinition - API module definition object to validate  
  * @returns {object} - Validation result
  */
 function validateApiModuleDefinition(apiModuleDefinition) {
-    const result = validate(
-        'api-module-definition',
-        toApiModuleDefinitionSchemaView(apiModuleDefinition)
-    );
-    return { ...result, data: apiModuleDefinition };
+    return validate('api-module-definition', apiModuleDefinition);
 }
 
 /**
@@ -378,7 +369,6 @@ module.exports = {
     validateAppDefinition,
     applyAppDefinitionDefaults,
     toAppDefinitionSchemaView,
-    toApiModuleDefinitionSchemaView,
     validateIntegrationDefinition,
     validateApiModuleDefinition,
     validateServerlessConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@friggframework/schemas",
-  "version": "2.0.0--canary.702.d5e6de1.0",
+  "version": "2.0.0--canary.666.89f6545.0",
   "description": "Canonical JSON Schema definitions for Frigg Framework",
   "main": "index.js",
   "author": "",
@@ -40,8 +40,7 @@
     "mocks/",
     "middleware/",
     "app-definition.js",
-    "api-module-definition.js",
     "index.js"
   ],
-  "gitHead": "d5e6de1068aabce0dfa8965a93bce40e05f50b7e"
+  "gitHead": "89f6545362623128362b730cb02b286c8308c66e"
 }

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

@@ -27,13 +27,6 @@
       "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",
@@ -97,22 +90,6 @@
             "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

package/schemas/app-definition.schema.json

@@ -95,6 +95,39 @@
       },
       "default": []
     },
+    "adminScripts": {
+      "type": "array",
+      "description": "Admin script classes (extending AdminScriptBase from @friggframework/admin-scripts) served under /admin/scripts",
+      "items": {
+        "description": "Admin script class"
+      },
+      "default": []
+    },
+    "reports": {
+      "type": "array",
+      "description": "Report classes served by the admin report runner",
+      "items": {
+        "description": "Report class"
+      },
+      "default": []
+    },
+    "admin": {
+      "type": "object",
+      "description": "Admin script and report runner options",
+      "properties": {
+        "enableScheduling": {
+          "type": "boolean",
+          "description": "Provision the EventBridge Scheduler group and role so admin scripts and reports can run on a schedule",
+          "default": false
+        },
+        "includeBuiltinReports": {
+          "type": "boolean",
+          "description": "Serve the built-in reports alongside the app's own reports",
+          "default": false
+        }
+      },
+      "additionalProperties": false
+    },
     "user": {
       "type": "object",
       "description": "User management and authentication. Read by core when it loads the app definition; an omitted block gets the defaults below (ADR-051).",
@@ -158,7 +191,7 @@
           "properties": {
             "secret": {
               "type": "string",
-              "description": "JWT secret key for signature validation (should be set via environment variable)"
+              "description": "JWT secret key for signature validation, usually `process.env.JWT_SECRET`. Required when authModes.adopterJwt is true; `frigg validate` errors when the key is missing from the definition and warns when its value is empty in the shell that runs it (build and deploy validate before `.env` is loaded)."
             },
             "userIdClaim": {
               "type": "string",
@@ -177,7 +210,6 @@
               "default": "HS256"
             }
           },
-          "required": ["secret"],
           "additionalProperties": false
         },
         "fields": {
@@ -273,8 +305,8 @@
             },
             "management": {
               "type": "string",
-              "description": "How Frigg gets the Aurora cluster (ignored when managementMode is 'managed' or 'existing'). 'discover' (also when omitted): find one, else create one in the stack. 'managed': create it in the stack. 'use-existing': connect to `endpoint` without creating anything.",
-              "enum": ["discover", "managed", "use-existing"]
+              "description": "How Frigg gets the Aurora cluster (ignored when managementMode is 'managed' or 'existing'). 'discover' (also when omitted): find one, else create one in the stack. 'managed': create it in the stack. 'use-existing': connect to `endpoint` without creating anything. 'external': Frigg provisions and discovers no database (no RDS/Aurora, no VPC requirement); the app connects to any PostgreSQL through the DATABASE_URL environment variable.",
+              "enum": ["discover", "managed", "use-existing", "external"]
             },
             "endpoint": {
               "type": "string",
@@ -400,8 +432,8 @@
       "properties": {
         "fieldLevelEncryptionMethod": {
           "type": "string",
-          "description": "Field-level encryption key. 'kms': Frigg creates or discovers a KMS key and sets KMS_KEY_ARN. 'aes': the app supplies AES_KEY_ID and AES_KEY (list both in `environment`). Omitted: no key is provisioned and deployed stages store sensitive fields unencrypted (core logs a warning). Stages dev, test and local never encrypt.",
-          "enum": ["kms", "aes"]
+          "description": "Field-level encryption key. 'kms': Frigg creates or discovers a KMS key and sets KMS_KEY_ARN. 'aes': the app supplies AES_KEY_ID and AES_KEY (list both in `environment`). 'none': no field-level encryption, chosen explicitly; no key is provisioned and deployed stages store sensitive fields unencrypted. Omitted: no key is provisioned and deployed stages store sensitive fields unencrypted (core logs a warning). Stages dev, test and local never encrypt.",
+          "enum": ["kms", "aes", "none"]
         },
         "createResourceIfNoneFound": {
           "type": "boolean",

package/api-module-definition.js

@@ -1,93 +0,0 @@
-/**
- * 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,
-};