ObjectStackObjectStack

Core Services

Core Services protocol schemas

Service Registry Protocol

Defines the standard built-in services that constitute the ObjectStack Kernel.

This registry is used by the ObjectKernel and HttpDispatcher to:

  1. Verify service availability.

  2. Route requests to the correct service handler.

  3. Type-check service interactions.

Source: packages/spec/src/system/core-services.zod.ts

TypeScript Usage

import { CoreServiceName, KernelServiceMap, ServiceConfig, ServiceCriticality, ServiceStatus } from '@objectstack/spec/system';
import type { CoreServiceName, KernelServiceMap, ServiceConfig, ServiceCriticality, ServiceStatus } from '@objectstack/spec/system';

// Validate data
const result = CoreServiceName.parse(data);

CoreServiceName

Allowed Values

  • metadata
  • data
  • auth
  • file-storage
  • search
  • cache
  • queue
  • automation
  • graphql
  • analytics
  • realtime
  • job
  • notification
  • ai
  • i18n
  • ui
  • workflow


ServiceConfig

Properties

PropertyTypeRequiredDescription
idstring
nameEnum<'metadata' | 'data' | 'auth' | 'file-storage' | 'search' | 'cache' | 'queue' | 'automation' | 'graphql' | 'analytics' | 'realtime' | 'job' | 'notification' | 'ai' | 'i18n' | 'ui' | 'workflow'>
optionsRecord<string, any>optional

ServiceCriticality

Allowed Values

  • required
  • core
  • optional

ServiceStatus

Properties

PropertyTypeRequiredDescription
nameEnum<'metadata' | 'data' | 'auth' | 'file-storage' | 'search' | 'cache' | 'queue' | 'automation' | 'graphql' | 'analytics' | 'realtime' | 'job' | 'notification' | 'ai' | 'i18n' | 'ui' | 'workflow'>
enabledboolean
statusEnum<'running' | 'stopped' | 'degraded' | 'initializing'>
versionstringoptional
providerstringoptionalImplementation provider (e.g. "s3" for storage)
featuresstring[]optionalList of supported sub-features

On this page