@simtlix/simfinity-core 3.2.0

package/src/auth/index.js

@@ -0,0 +1,421 @@
+/**
+ * Simfinity GraphQL Authorization
+ *
+ * Production-grade centralized GraphQL authorization supporting:
+ * - RBAC / ABAC
+ * - Function-based rules
+ * - Declarative policy expressions (JSON AST)
+ * - Wildcard "*" permissions
+ * - Default allow/deny policies
+ *
+ * @example
+ * import { auth } from '@simtlix/simfinity-js';
+ * import { createYoga } from 'graphql-yoga';
+ *
+ * const { createAuthPlugin, requireAuth, requireRole } = auth;
+ *
+ * const permissions = {
+ *   Query: {
+ *     series: requireAuth(),
+ *     seasons: requireAuth(),
+ *   },
+ *   Mutation: {
+ *     deleteserie: requireRole('admin'),
+ *     deletestar: requireRole('admin'),
+ *   },
+ *   serie: {
+ *     '*': requireAuth(),
+ *   }
+ * };
+ *
+ * const authPlugin = createAuthPlugin(permissions, { defaultPolicy: 'ALLOW' });
+ * const yoga = createYoga({ schema, plugins: [authPlugin] });
+ */
+
+import { GraphQLObjectType, defaultFieldResolver } from 'graphql';
+import { UnauthenticatedError, ForbiddenError, createAuthError } from './errors.js';
+import { isPolicyExpression, createRuleFromExpression, evaluateExpression } from './expressions.js';
+import {
+  resolvePath,
+  requireAuth,
+  requireRole,
+  requirePermission,
+  composeRules,
+  anyRule,
+  isOwner,
+  createRule,
+  allow,
+  deny,
+} from './rules.js';
+
+// Re-export shared errors
+export { UnauthenticatedError, ForbiddenError, createAuthError } from './errors.js';
+
+// Re-export expression utilities
+export { evaluateExpression, isPolicyExpression, createRuleFromExpression } from './expressions.js';
+
+// Re-export rule helpers and utilities
+export {
+  resolvePath,
+  requireAuth,
+  requireRole,
+  requirePermission,
+  composeRules,
+  anyRule,
+  isOwner,
+  createRule,
+  allow,
+  deny,
+} from './rules.js';
+
+/**
+ * @typedef {'ALLOW' | 'DENY'} DefaultPolicy
+ */
+
+/**
+ * @typedef {Object} AuthMiddlewareOptions
+ * @property {DefaultPolicy} [defaultPolicy='DENY'] - Default policy when no rule matches
+ * @property {boolean} [debug=false] - Enable debug logging
+ */
+
+/**
+ * @typedef {Function} RuleFunction
+ * @param {*} parent - Parent resolver result
+ * @param {Object} args - GraphQL arguments
+ * @param {Object} ctx - GraphQL context
+ * @param {Object} info - GraphQL resolve info
+ * @returns {boolean|void|Promise<boolean|void>} - true/void to allow, false to deny
+ */
+
+/**
+ * @typedef {boolean|Object|RuleFunction|Array<Rule>} Rule
+ */
+
+/**
+ * @typedef {Object.<string, Rule>} TypePermissions
+ */
+
+/**
+ * @typedef {Object.<string, TypePermissions>} PermissionSchema
+ */
+
+/**
+ * Normalizes a rule to always be an array of functions
+ * @param {Rule} rule - The rule to normalize
+ * @returns {Function[]} Array of rule functions
+ */
+const normalizeRule = (rule) => {
+  if (typeof rule === 'function') {
+    return [rule];
+  }
+
+  if (Array.isArray(rule)) {
+    if (rule.length === 0 || Array.from(rule).some(r => r === undefined)) {
+      throw new TypeError('Authorization rule arrays must contain valid rules');
+    }
+    return rule.flatMap(r => normalizeRule(r));
+  }
+
+  if (isPolicyExpression(rule)) {
+    return [createRuleFromExpression(rule)];
+  }
+
+  throw new TypeError('Invalid authorization rule: expected a function, nonempty rule array, or policy expression');
+};
+
+const isPermissionMap = value => value !== null && typeof value === 'object'
+  && [Object.prototype, null].includes(Object.getPrototypeOf(value));
+
+const validateConfiguration = (permissions, defaultPolicy) => {
+  if (defaultPolicy !== 'ALLOW' && defaultPolicy !== 'DENY') {
+    throw new TypeError('defaultPolicy must be ALLOW or DENY');
+  }
+  if (!isPermissionMap(permissions)) {
+    throw new TypeError('Authorization permissions must be an object');
+  }
+  for (const [typeName, typePermissions] of Object.entries(permissions)) {
+    if (!isPermissionMap(typePermissions)) {
+      throw new TypeError(`Permissions for ${typeName} must be an object`);
+    }
+    for (const [fieldName, rule] of Object.entries(typePermissions)) {
+      try {
+        normalizeRule(rule);
+      } catch (error) {
+        throw new TypeError(`Invalid authorization rule for ${typeName}.${fieldName}: ${error.message}`);
+      }
+    }
+  }
+};
+
+/**
+ * Gets the rule for a specific field, with wildcard fallback
+ * @param {PermissionSchema} permissions - The permission schema
+ * @param {string} typeName - The GraphQL type name
+ * @param {string} fieldName - The field name
+ * @returns {Function[]|null} Array of rule functions or null if no rule found
+ */
+const getFieldRules = (permissions, typeName, fieldName) => {
+  if (!Object.hasOwn(permissions, typeName)) return null;
+  const typePerms = permissions[typeName];
+  if (!isPermissionMap(typePerms)) {
+    throw new TypeError(`Permissions for ${typeName} must be an object`);
+  }
+
+  // Check for exact field rule first
+  if (Object.hasOwn(typePerms, fieldName)) {
+    return normalizeRule(typePerms[fieldName]);
+  }
+
+  // Fallback to wildcard
+  if (Object.hasOwn(typePerms, '*')) {
+    return normalizeRule(typePerms['*']);
+  }
+
+  return null;
+};
+
+/**
+ * Executes a single rule
+ * @param {Function} rule - The rule function to execute
+ * @param {*} parent - Parent resolver result
+ * @param {Object} args - GraphQL arguments
+ * @param {Object} ctx - GraphQL context
+ * @param {Object} info - GraphQL resolve info
+ * @returns {Promise<boolean>} True if allowed, false if denied
+ */
+const executeRule = async (rule, parent, args, ctx, info) => {
+  const result = await rule(parent, args, ctx, info);
+
+  // void/undefined/true means allow
+  if (result === undefined || result === true) {
+    return true;
+  }
+
+  // false means deny
+  return false;
+};
+
+/**
+ * Creates a graphql-middleware compatible authorization middleware.
+ *
+ * @deprecated Use {@link createAuthPlugin} instead. `applyMiddleware` from graphql-middleware
+ * can cause duplicate-type errors when the schema contains custom introspection extensions.
+ *
+ * @param {PermissionSchema} permissions - The permission schema object
+ * @param {AuthMiddlewareOptions} [options={}] - Middleware options
+ * @returns {Function} A graphql-middleware compatible middleware function
+ */
+export const createAuthMiddleware = (permissions, options = {}) => {
+  const {
+    defaultPolicy = 'DENY',
+    debug = false,
+  } = options;
+
+  validateConfiguration(permissions, defaultPolicy);
+
+  const log = debug ? console.log.bind(console, '[auth]') : () => {};
+
+  /**
+   * The middleware generator function
+   * Returns a middleware object keyed by type name, each containing field resolvers
+   */
+  return async (resolve, parent, args, ctx, info) => {
+    const typeName = info.parentType.name;
+    const fieldName = info.fieldName;
+
+    log(`Checking ${typeName}.${fieldName}`);
+
+    // Get rules for this field
+    const rules = getFieldRules(permissions, typeName, fieldName);
+
+    // If no rules found, apply default policy
+    if (rules === null) {
+      log(`No rules for ${typeName}.${fieldName}, applying default policy: ${defaultPolicy}`);
+
+      if (defaultPolicy === 'DENY') {
+        throw new ForbiddenError(`Access denied to ${typeName}.${fieldName}`);
+      }
+
+      // ALLOW - proceed to resolver
+      return resolve(parent, args, ctx, info);
+    }
+
+    // Execute all rules (AND logic - all must pass)
+    for (const rule of rules) {
+      log(`Executing rule for ${typeName}.${fieldName}`);
+
+      const allowed = await executeRule(rule, parent, args, ctx, info);
+
+      if (!allowed) {
+        log(`Rule denied access to ${typeName}.${fieldName}`);
+        throw new ForbiddenError(`Access denied to ${typeName}.${fieldName}`);
+      }
+    }
+
+    log(`Access granted to ${typeName}.${fieldName}`);
+
+    // All rules passed - proceed to resolver
+    return resolve(parent, args, ctx, info);
+  };
+};
+
+/**
+ * Creates a field-level middleware object from a permission schema.
+ * This can be used with graphql-middleware's applyMiddleware.
+ *
+ * @deprecated Use {@link createAuthPlugin} instead. `applyMiddleware` from graphql-middleware
+ * can cause duplicate-type errors when the schema contains custom introspection extensions.
+ *
+ * @param {PermissionSchema} permissions - The permission schema
+ * @param {AuthMiddlewareOptions} [options={}] - Middleware options
+ * @returns {Object} Field middleware object compatible with graphql-middleware
+ */
+export const createFieldMiddleware = (permissions, options = {}) => {
+  const middleware = createAuthMiddleware(permissions, options);
+  const fieldMiddleware = {};
+
+  for (const typeName of Object.keys(permissions)) {
+    fieldMiddleware[typeName] = {};
+
+    const typePerms = permissions[typeName];
+    for (const fieldName of Object.keys(typePerms)) {
+      if (fieldName === '*') {
+        // Wildcard rules are handled by the middleware internally
+        continue;
+      }
+      fieldMiddleware[typeName][fieldName] = middleware;
+    }
+  }
+
+  return fieldMiddleware;
+};
+
+/**
+ * Creates an Envelop-compatible authorization plugin that wraps schema resolvers in-place.
+ *
+ * Unlike {@link createAuthMiddleware} (which requires graphql-middleware's `applyMiddleware`
+ * and rebuilds the schema), this plugin mutates resolvers directly on the existing schema,
+ * avoiding schema reconstruction and the duplicate-type errors it can cause.
+ *
+ * @param {PermissionSchema} permissions - The permission schema object
+ * @param {AuthMiddlewareOptions} [options={}] - Plugin options
+ * @returns {Object} An Envelop plugin with an `onSchemaChange` hook
+ *
+ * @example
+ * import { auth } from '@simtlix/simfinity-js';
+ * import { createYoga } from 'graphql-yoga';
+ *
+ * const permissions = {
+ *   Query: {
+ *     users: requireAuth(),
+ *     adminDashboard: requireRole('ADMIN')
+ *   },
+ *   User: {
+ *     '*': requireAuth(),
+ *     email: requireRole('ADMIN')
+ *   }
+ * };
+ *
+ * const authPlugin = auth.createAuthPlugin(permissions, { defaultPolicy: 'DENY' });
+ * const yoga = createYoga({ schema, plugins: [authPlugin] });
+ */
+export const createAuthPlugin = (permissions, options = {}) => {
+  const {
+    defaultPolicy = 'DENY',
+    debug = false,
+  } = options;
+
+  validateConfiguration(permissions, defaultPolicy);
+
+  const log = debug ? console.log.bind(console, '[auth]') : () => {};
+  const processedSchemas = new WeakSet();
+
+  const wrapSchemaResolvers = (schema) => {
+    if (processedSchemas.has(schema)) return;
+    validateConfiguration(permissions, defaultPolicy);
+
+    const typeMap = schema.getTypeMap();
+
+    for (const [typeName, type] of Object.entries(typeMap)) {
+      if (!(type instanceof GraphQLObjectType) || typeName.startsWith('__')) continue;
+
+      const fields = type.getFields();
+
+      for (const [fieldName, field] of Object.entries(fields)) {
+        const rules = getFieldRules(permissions, typeName, fieldName);
+        const originalResolve = field.resolve || defaultFieldResolver;
+
+        field.resolve = async (parent, args, ctx, info) => {
+          log(`Checking ${typeName}.${fieldName}`);
+
+          if (rules === null) {
+            log(`No rules for ${typeName}.${fieldName}, applying default policy: ${defaultPolicy}`);
+
+            if (defaultPolicy === 'DENY') {
+              throw new ForbiddenError(`Access denied to ${typeName}.${fieldName}`);
+            }
+
+            return originalResolve(parent, args, ctx, info);
+          }
+
+          for (const rule of rules) {
+            log(`Executing rule for ${typeName}.${fieldName}`);
+
+            const allowed = await executeRule(rule, parent, args, ctx, info);
+
+            if (!allowed) {
+              log(`Rule denied access to ${typeName}.${fieldName}`);
+              throw new ForbiddenError(`Access denied to ${typeName}.${fieldName}`);
+            }
+          }
+
+          log(`Access granted to ${typeName}.${fieldName}`);
+
+          return originalResolve(parent, args, ctx, info);
+        };
+      }
+    }
+
+    processedSchemas.add(schema);
+  };
+
+  return {
+    onSchemaChange({ schema }) {
+      wrapSchemaResolvers(schema);
+    },
+  };
+};
+
+// Default export with all auth utilities
+const auth = {
+  // Main factories
+  createAuthPlugin,
+  createAuthMiddleware,
+  createFieldMiddleware,
+
+  // Utilities
+  resolvePath,
+
+  // Rule helpers
+  requireAuth,
+  requireRole,
+  requirePermission,
+  composeRules,
+  anyRule,
+  isOwner,
+  createRule,
+  allow,
+  deny,
+
+  // Expression utilities
+  evaluateExpression,
+  isPolicyExpression,
+  createRuleFromExpression,
+
+  // Errors
+  UnauthenticatedError,
+  ForbiddenError,
+  createAuthError,
+};
+
+export default auth;

package/src/auth/object-id.js

@@ -0,0 +1,25 @@
+const objectIdTypes = new Map();
+const canonicalObjectId = /^[0-9a-f]{24}$/;
+
+/** Internal adapter hook; database facades register only their authentic ObjectId constructor. */
+export const registerObjectIdType = (ObjectId, toHexString) => {
+  if (typeof ObjectId !== 'function' || typeof toHexString !== 'function') {
+    throw new TypeError('ObjectId constructor and toHexString method are required');
+  }
+  if (!objectIdTypes.has(ObjectId)) objectIdTypes.set(ObjectId, toHexString);
+};
+
+/** Normalize only instances backed by a registered ObjectId implementation. */
+export const normalizeObjectId = (value) => {
+  for (const [ObjectId, toHexString] of objectIdTypes) {
+    if (!(value instanceof ObjectId)) continue;
+    try {
+      const normalized = toHexString.call(value);
+      return typeof normalized === 'string' && canonicalObjectId.test(normalized)
+        ? normalized : undefined;
+    } catch {
+      return undefined;
+    }
+  }
+  return undefined;
+};