🧩 Backend Blocks

Backend Blocks is the SDK reference for reusable backend domains. Choose a domain below for its integration guide, then follow its feature, schema, route, and validator links to the exact contract you need. The catalogue reflects every current folder in this directory.

Start here

For a ready-made HTTP integration, begin with a domain's index.md page and its service setup. For a custom integration, start with its features.md page: features compose request schemas and route composers, while the service supplies the usual datastore, configuration, authentication, and optional driver context.

Not every domain is a service. Common, Mongo, Avatar, and File Storage are reusable building-block references; OAuth and Invitation are composed by authService rather than mounted as independent services.

Browse by responsibility

Foundation and shared contracts

Domain	Use it for	Available reference pages
🔄 Common	Cross-domain normalization, response helpers, schemas, and validators.	Blocks, schemas, validators
🗄️ Mongo	MongoDB query blocks and projections for custom or domain pipelines.	Blocks
📁 File Storage	Signed upload/download/delete URLs and file normalization.	Blocks, schemas
🖼️ Avatar	Stored avatar references, signed response URLs, and replacement cleanup.	Blocks, schemas

Identity, access, and user-facing state

Domain	Use it for	Available reference pages
🔐 Authentication	Credentials, tokens, MFA, email verification, and account lifecycle.	Blocks, features, handlers, routes, schemas, validators
🆔 Identity	Administrator identity management and identity lookup contracts.	Blocks, features, routes, schemas, validators
🔗 OAuth	Google, LINE, and Twitter browser OAuth flows composed by authService.	Blocks, features, routes, schemas
📧 Invitation	Administrator invitation flows composed by authService.	Features, handlers, routes, schemas
👥 Profile	Profiles, avatars, follows, organization follows, and product likes.	Blocks, features, handlers, routes, schemas, validators
🔔 Notification	Receiver-scoped notification listing and read-state operations.	Blocks, features, routes, schemas, validators

Application domains

Domain	Use it for	Available reference pages
🏠 Address	Authenticated Japanese postal-code lookup with a host-provided driver.	Blocks, features, routes, schemas, validators
🏷️ Attribute	Named groups of string key-value items.	Features, handlers, routes, schemas, validators
📂 Category	Public category reads and administrator category management.	Features, handlers, routes, schemas, validators
💬 Chat	HTTP and WebSocket channels, messages, attachments, templates, subscriptions, and read states.	Blocks, features, handlers, routes, schemas, validators
📍 Location	Hierarchical location reads and administrator management.	Blocks, features, routes, schemas, validators
🛒 Order	Authenticated order lifecycle and organization-scoped order listing.	Blocks, features, handlers, routes, schemas, validators
🏢 Organization	Organizations, memberships, hierarchy, change requests, uploads, and followers.	Blocks, features, handlers, routes, schemas, validators
🛍️ Product	Product listing, product and variant management, images, organizations, and likers.	Blocks, features, handlers, routes, schemas, validators

How the reference pages fit together

Page	What it documents	When to use it
index.md	Service or integration setup, dependencies, common workflows, and links to the domain reference.	Start here when mounting or choosing a domain.
blocks.md	Reusable operations, result/error types, constants, and helpers.	Reuse behavior in a custom pipeline.
schemas.md	Stored shapes and request validation contracts.	Construct a valid request or understand fields.
handlers.md	Route-pipeline operations and terminators.	Understand or reuse legacy pipeline behavior.
routes.md	Public route composers, HTTP methods, paths, access rules, statuses, and complete source.	Verify an endpoint's behavior.
features.md	Schema-to-route composers.	Assemble selected endpoint capabilities.
validators.md	Authentication, authorization, and domain validation composition.	Understand access control and validation order.

A domain omits a page when that layer has no relevant public export. Use its Reference map to see its exact set of pages.

Choose an integration path

Goal	Start with
Mount a complete SDK service	The relevant domain integration guide.
Add a few endpoints to an existing service	That domain's features.md, then its schemas.md and routes.md.
Reuse a database, storage, avatar, or normalization helper	Common, Mongo, File Storage, or Avatar.
Implement sign-in, invitation, or OAuth	Authentication; it composes Invitation and OAuth.