@apick/types

Shared TypeScript type definitions for APICK — a pure headless CMS built TypeScript-first.

Install

npm install @apick/types

Type Namespaces

| Namespace | Description | |-----------|-------------| | Core | Core framework types (Apick, Server, Config, Registry) | | UID | UID string types (ContentType, Service, Controller) | | Schema | Content type schema types (Attribute, ContentType, Component) | | Modules | Module-specific types (document service, query engine) | | Data | Data shape types (request/response bodies) | | Struct | Structural utility types | | Config | Configuration file types (ServerConfig, DatabaseConfig, etc.) |

Usage

import type { Core, UID, Schema } from '@apick/types';

function getArticles(apick: Core.Apick): Promise<any[]> {
  const uid: UID.ContentType = 'api::article.article';
  return apick.documents(uid).findMany();
}

Related Packages

• @apick/core -- Framework kernel
• @apick/utils -- Error classes, env helpers, utilities
• @apick/cli -- CLI tool

License

MIT