akanjs 2.0.7 → 2.1.0-rc.1

package/README.ko.md

@@ -50,7 +50,7 @@ akan start <app-name> --open
 가장 작은 앱은 설정이 거의 없어도 시작할 수 있습니다.
 
 ```ts
-import type { AppConfig } from "akanjs/devkit";
+import type { AppConfig } from "akanjs";
 
 const config: AppConfig = {};
 
@@ -161,9 +161,9 @@ UI barrel import를 leaf import로 다시 써서 클라이언트 번들을 작
 | `akanjs/client` | client routing, cookie, storage, locale, device, CSR type, page helper. |
 | `akanjs/client` | Akan page runtime에서 사용하는 client bootstrap과 location helper. |
 | `akanjs/server` | server app runtime, route composition, SSR/RSC artifact, proxy, sitemap, server type. |
-| `akanjs/devkit` | build runner, config loader, code generation, scanner, transform, CLI helper, tooling. |
+| `@akanjs/devkit` | build runner, config loader, code generation, scanner, transform, CLI helper, tooling. |
 | `akanjs/test` | test helper와 sample generation utility. |
-| `akanjs/cli` | programmatic CLI entrypoint. 실행 명령은 `akan`입니다. |
+| `@akanjs/cli` | programmatic CLI entrypoint. 실행 명령은 `akan`입니다. |
 
 특수 public surface:
 
@@ -202,7 +202,7 @@ akan update
 routes, domains, base paths, mobile settings로 확장됩니다.
 
 ```ts
-import type { AppConfig } from "akanjs/devkit";
+import type { AppConfig } from "akanjs";
 
 const config: AppConfig = {
   routes: [

package/README.md

@@ -49,7 +49,7 @@ akan start <app-name> --open
 A minimal app can start with almost no configuration:
 
 ```ts
-import type { AppConfig } from "akanjs/devkit";
+import type { AppConfig } from "akanjs";
 
 const config: AppConfig = {};
 
@@ -159,9 +159,9 @@ frontend build to rewrite UI barrel imports into leaf imports.
 | `akanjs/client` | Client routing, cookies, storage, locale, device, CSR types, and page helpers. |
 | `akanjs/client` | Client bootstrapping and location helpers used by Akan page runtimes. |
 | `akanjs/server` | Server app runtime, route composition, SSR/RSC artifacts, proxying, sitemap, and server types. |
-| `akanjs/devkit` | Build runners, config loaders, code generation, scanners, transforms, CLI helpers, and tooling. |
+| `@akanjs/devkit` | Build runners, config loaders, code generation, scanners, transforms, CLI helpers, and tooling. |
 | `akanjs/test` | Test helpers and sample generation utilities. |
-| `akanjs/cli` | Programmatic CLI entrypoint. The executable command is `akan`. |
+| `@akanjs/cli` | Programmatic CLI entrypoint. The executable command is `akan`. |
 
 Special public surfaces:
 
@@ -200,7 +200,7 @@ Common areas:
 grow only when the app needs routes, domains, base paths, or mobile settings.
 
 ```ts
-import type { AppConfig } from "akanjs/devkit";
+import type { AppConfig } from "akanjs";
 
 const config: AppConfig = {
   routes: [

package/client/router.ts

@@ -62,6 +62,8 @@ function getServerRequestContext() {
 
 const getConfiguredBasePaths = () => new Set(parseBasePaths(process.env.AKAN_PUBLIC_BASE_PATHS));
 
+const shouldExposeBasePath = () => getEnv().operationMode === "local";
+
 const getServerBasePath = (reqPathname: string, lang: string, headerBasePath: string | undefined, fallback: string) => {
   return (
     getBasePathFromPathname(reqPathname, {
@@ -131,14 +133,16 @@ class Router {
       push: (href: string, routeOptions) => {
         const router = options.router;
         const pathInfo = this.#getPathInfo(href);
+        const navigationPathInfo = this.#getNavigationPathInfo(href);
         this.#postPathChange(pathInfo);
-        router.push(pathInfo.href, routeOptions);
+        router.push(navigationPathInfo.href, routeOptions);
       },
       replace: (href: string, routeOptions) => {
         const router = options.router;
         const pathInfo = this.#getPathInfo(href);
+        const navigationPathInfo = this.#getNavigationPathInfo(href);
         this.#postPathChange(pathInfo);
-        router.replace(pathInfo.href, routeOptions);
+        router.replace(navigationPathInfo.href, routeOptions);
       },
       back: () => {
         const router = options.router;
@@ -188,6 +192,9 @@ class Router {
   #getPathInfo(href: string, prefix = this.#prefix) {
     return getPathInfo(href, this.#lang, prefix);
   }
+  #getNavigationPathInfo(href: string) {
+    return this.#getPathInfo(href, shouldExposeBasePath() ? this.#prefix : "");
+  }
   #postPathChange({ path, pathname, hash }: { path: string; pathname: string; hash: string }) {
     Logger.log(`pathChange-start:${path}${hash ? `#${hash}` : ""}`);
     window.parent.postMessage({ type: "pathChange", path, pathname, hash }, "*");
@@ -224,7 +231,7 @@ class Router {
       const langFromPath = reqPathname.split("/").filter(Boolean)[0];
       const lang = (h.get("x-locale") ?? langFromPath ?? this.#lang) as string;
       const basePath = getServerBasePath(reqPathname, lang, h.get("x-base-path") ?? undefined, this.#prefix);
-      const { pathname, href: fullHref } = getPathInfo(href, lang, basePath);
+      const { pathname, href: fullHref } = getPathInfo(href, lang, shouldExposeBasePath() ? basePath : "");
       Logger.log(`redirect to:${pathname}`);
       throw new AkanRedirectError(fullHref, "replace");
     } else {

package/document/documentSchema.ts

@@ -13,6 +13,14 @@ export interface DocumentIndexDescriptor {
   where?: DocumentQuery;
 }
 
+export interface DocumentIndexBuilder<Schema> {
+  path(path: string, order?: 1 | -1): DocumentIndexBuilder<Schema>;
+  text(path: string): DocumentIndexBuilder<Schema>;
+  unique(): DocumentIndexBuilder<Schema>;
+  where(where: DocumentQuery | ((q: DocumentQueryHelper) => DocumentQuery)): DocumentIndexBuilder<Schema>;
+  done(): Schema;
+}
+
 export type DocumentSaveHook<Doc = unknown> = (
   this: Doc,
   next?: () => void,
@@ -58,7 +66,7 @@ export class DocumentSchema<Doc = unknown> {
     return this;
   }
 
-  createIndex(name: string) {
+  createIndex(name: string): DocumentIndexBuilder<this> {
     const schema = this;
     const descriptor: DocumentIndexDescriptor = { name, fields: {} };
     const api = {

package/index.ts

@@ -0,0 +1,187 @@
+import type { AkanI18nConfig } from "akanjs/common";
+import type { AkanImageConfig } from "akanjs/server";
+
+export const archs = ["amd64", "arm64"] as const;
+export type Arch = (typeof archs)[number];
+
+export interface DockerConfig {
+  content: string;
+  image: string | { [key in Arch]?: string };
+  preRuns: (string | { [key in Arch]?: string })[];
+  postRuns: (string | { [key in Arch]?: string })[];
+  command: string[];
+}
+
+export interface AkanRouteDomains {
+  main?: string[];
+  develop?: string[];
+  debug?: string[];
+  [branch: string]: string[] | undefined;
+}
+
+export interface AkanRouteConfig {
+  basePath?: string;
+  domains: AkanRouteDomains;
+}
+
+export type DatabaseMode = "single" | "multiple" | "cluster";
+export type MobileEnv = "local" | "debug" | "develop" | "main";
+export type MobilePermission = "camera" | "contacts" | "location" | "push";
+
+export interface AkanMobileTargetAssets {
+  icon?: string;
+  splash?: string;
+}
+
+export interface AkanMobileTargetLinks {
+  schemes?: string[];
+  associatedDomains?: string[];
+  androidHosts?: string[];
+}
+
+export interface AkanMobileTargetFiles {
+  ios?: Record<string, string>;
+  android?: Record<string, string>;
+}
+
+export interface AkanCapacitorLikeConfig {
+  plugins?: Record<string, unknown>;
+  android?: Record<string, unknown>;
+  ios?: Record<string, unknown>;
+  [key: string]: unknown;
+}
+
+export interface AkanMobileTargetConfig extends AkanCapacitorLikeConfig {
+  name: string;
+  basePath?: string;
+  appName: string;
+  appId: string;
+  version: string;
+  buildNum: number;
+  assets?: AkanMobileTargetAssets;
+  permissions?: MobilePermission[];
+  links?: AkanMobileTargetLinks;
+  files?: AkanMobileTargetFiles;
+}
+
+export interface AkanMobileConfig extends AkanCapacitorLikeConfig {
+  appName: string;
+  appId: string;
+  version: string;
+  buildNum: number;
+  targets: Record<string, AkanMobileTargetConfig>;
+}
+
+export interface AppConfigResult {
+  docker: DockerConfig;
+  defaultDatabaseMode: DatabaseMode;
+  routes?: AkanRouteConfig[];
+  externalLibs: string[];
+  barrelImports: string[];
+  optimizeImports: string[];
+  images: AkanImageConfig;
+  i18n: AkanI18nConfig;
+  publicEnv: string[];
+  mobile: AkanMobileConfig;
+}
+
+export interface LibConfigResult {
+  externalLibs: string[];
+}
+
+export type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends unknown[] ? T[P] : T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+
+export interface AppConfigContext {
+  readonly name: string;
+  readonly type: "app";
+}
+
+export interface LibConfigContext {
+  readonly name: string;
+  readonly type: "lib";
+}
+
+export type AppConfig = DeepPartial<AppConfigResult> | ((app: AppConfigContext) => DeepPartial<AppConfigResult>);
+export type LibConfig = DeepPartial<LibConfigResult> | ((lib: LibConfigContext) => DeepPartial<LibConfigResult>);
+export type AkanConfigFile = object;
+
+export interface FileConventionScanResult {
+  constant: { databases: string[]; scalars: string[] };
+  dictionary: { databases: string[]; services: string[]; scalars: string[] };
+  document: { databases: string[]; scalars: string[] };
+  service: { databases: string[]; services: string[] };
+  signal: { databases: string[]; services: string[] };
+  store: { databases: string[]; services: string[] };
+  template: { databases: string[]; services: string[]; scalars: string[] };
+  unit: { databases: string[]; services: string[]; scalars: string[] };
+  util: { databases: string[]; services: string[]; scalars: string[] };
+  view: { databases: string[]; services: string[]; scalars: string[] };
+  zone: { databases: string[]; services: string[]; scalars: string[] };
+}
+
+export interface ScanResult {
+  name: string;
+  type: "app" | "lib";
+  repoName: string;
+  serveDomain: string;
+  files: FileConventionScanResult;
+  libDeps: string[];
+  pkgDeps: string[];
+  dependencies: string[];
+  devDependencies: string[];
+}
+
+export interface AppScanResult extends ScanResult {
+  akanConfig: AppConfigResult;
+  routes: string[];
+}
+
+export interface LibScanResult extends ScanResult {
+  akanConfig: LibConfigResult;
+}
+
+export interface PkgScanResult {
+  name: string;
+  pkgDeps: string[];
+  dependencies: string[];
+}
+
+export interface WorkspaceScanResult {
+  appNames: string[];
+  libNames: string[];
+  pkgNames: string[];
+  apps: { [key: string]: AppScanResult };
+  libs: { [key: string]: LibScanResult };
+  pkgs: { [key: string]: PkgScanResult };
+}
+
+export interface AppInfo {
+  readonly name: string;
+  readonly type: "app";
+  readonly database: Map<string, Set<string>>;
+  readonly service: Map<string, Set<string>>;
+  readonly scalar: Map<string, Set<string>>;
+  readonly file: FileConventionScanResult;
+  getLibs(): string[];
+  getLibInfos(): Map<string, LibInfo>;
+  getDatabaseModules(): string[];
+  getScalarModules(): string[];
+  getServiceModules(): string[];
+}
+
+export interface LibInfo {
+  readonly name: string;
+  readonly type: "lib";
+  readonly database: Map<string, Set<string>>;
+  readonly service: Map<string, Set<string>>;
+  readonly scalar: Map<string, Set<string>>;
+  readonly file: FileConventionScanResult;
+  getLibs(): string[];
+  getLibInfos(): Map<string, LibInfo>;
+  getLibInfo(libName: string): LibInfo | undefined;
+  getDatabaseModules(): string[];
+  getScalarModules(): string[];
+  getServiceModules(): string[];
+}

package/package.json

@@ -1,12 +1,8 @@
 {
   "name": "akanjs",
-  "version": "2.0.7",
+  "version": "2.1.0-rc.1",
   "sourceType": "module",
   "type": "module",
-  "bin": {
-    "akan": "./cli/index.js",
-    "akan2": "./cli/index.js"
-  },
   "publishConfig": {
     "access": "public"
   },
@@ -24,11 +20,6 @@
       "default": "./index.ts"
     },
     "./package.json": "./package.json",
-    "./capacitor.base.config": {
-      "types": "./types/devkit/capacitor.base.config.d.ts",
-      "import": "./devkit/capacitor.base.config.ts",
-      "default": "./devkit/capacitor.base.config.ts"
-    },
     "./base": {
       "types": "./types/base/index.d.ts",
       "import": "./base/index.ts",
@@ -139,21 +130,11 @@
       "import": "./dictionary/index.ts",
       "default": "./dictionary/index.ts"
     },
-    "./devkit": {
-      "types": "./types/devkit/index.d.ts",
-      "import": "./devkit/index.ts",
-      "default": "./devkit/index.ts"
-    },
     "./test": {
       "types": "./types/test/index.d.ts",
       "import": "./test/index.ts",
       "default": "./test/index.ts"
     },
-    "./cli": {
-      "types": "./types/cli/index.d.ts",
-      "import": "./cli/index.ts",
-      "default": "./cli/index.ts"
-    },
     "./ui/styles.css": "./ui/styles.css",
     "./server/rsc-worker": {
       "types": "./types/server/rscWorker.d.ts",
@@ -162,27 +143,10 @@
     }
   },
   "dependencies": {
-    "@inquirer/prompts": "^8.4.3",
-    "@langchain/core": "^1.1.47",
-    "@langchain/deepseek": "^1.0.26",
-    "@langchain/openai": "^1.4.6",
-    "@trapezedev/project": "^7.1.4",
-    "chalk": "^5.6.2",
     "clsx": "^2.1.1",
-    "commander": "^14.0.3",
     "dayjs": "^1.11.20",
-    "fontaine": "^0.8.0",
-    "fonteditor-core": "^2.6.3",
-    "ignore": "^7.0.5",
     "immer": "^11.1.8",
-    "ink": "^6.8.0",
-    "js-yaml": "^4.1.1",
-    "ora": "^9.4.0",
-    "qrcode": "^1.5.4",
-    "sharp": "^0.34.5",
-    "ssh2": "^1.17.0",
-    "subset-font": "^2.5.0",
-    "tailwindcss": "^4.3.0"
+    "sharp": "^0.34.5"
   },
   "peerDependencies": {
     "@capacitor-community/contacts": "^7.2.0",
@@ -190,7 +154,6 @@
     "@capacitor/app": "^8.1.0",
     "@capacitor/browser": "^8.0.3",
     "@capacitor/camera": "^8.2.0",
-    "@capacitor/cli": "^8.3.4",
     "@capacitor/core": "^8.3.4",
     "@capacitor/device": "^8.0.2",
     "@capacitor/geolocation": "^8.2.0",
@@ -202,7 +165,7 @@
     "@libsql/client": "^0.17.3",
     "@playwright/test": "^1.60.0",
     "@radix-ui/react-dialog": "^1.1.15",
-    "@react-spring/web": "^9.7.5",
+    "@react-spring/web": "^10.1.0",
     "@use-gesture/react": "^10.3.1",
     "bullmq": "^5.76.10",
     "capacitor-plugin-safe-area": "^5.0.0",
@@ -211,27 +174,23 @@
     "croner": "^10.0.1",
     "daisyui": "^5.5.20",
     "file-saver": "^2.0.5",
-    "fontaine": "^0.8.0",
-    "fonteditor-core": "^2.6.3",
     "ioredis": "^5.10.1",
     "mermaid": "^11.15.0",
     "postgres": "^3.4.9",
     "protobufjs": "^8.4.0",
-    "react": "19.2.4",
+    "react": "19.2.6",
     "react-copy-to-clipboard": "^5.1.1",
     "react-datepicker": "^9.1.0",
     "react-device-detect": "^2.2.3",
-    "react-dom": "19.2.4",
+    "react-dom": "19.2.6",
     "react-icons": "^5.6.0",
     "react-refresh": "^0.18.0",
     "react-server-dom-webpack": "^19.2.6",
     "react-simple-pull-to-refresh": "^1.3.4",
-    "react-spring": "^9.7.5",
+    "react-spring": "^10.0.4",
     "scheduler": "^0.27.0",
     "sharp": "^0.34.5",
-    "subset-font": "^2.5.0",
     "tailwind-scrollbar": "^4.0.2",
-    "tailwindcss": "^4.3.0",
     "typescript": "^6.0.3"
   },
   "peerDependenciesMeta": {
@@ -250,9 +209,6 @@
     "@capacitor/camera": {
       "optional": true
     },
-    "@capacitor/cli": {
-      "optional": true
-    },
     "@capacitor/core": {
       "optional": true
     },

package/server/akanApp.ts

@@ -3,6 +3,7 @@ import path from "node:path";
 import { Logger } from "akanjs/common";
 import type { AkanChildRole, AkanChildStatus, AkanIpcMessage, AkanMetricsReport, AkanUpstream } from "akanjs/service";
 import { isTraceEnabled } from "akanjs/signal";
+import { makeAkanChildProxyHeaders } from "./akanAppHeaders";
 import type { BuilderMessage, BuilderReq, BuilderRes } from "./artifact";
 import { RotatingLogWriter } from "./logging/rotatingLogWriter";
 import { ProcessMetricsCollector } from "./processMetricsCollector";
@@ -60,16 +61,6 @@ export class AkanApp {
   static readonly #childRestartBaseDelayMs = 1_000;
   static readonly #childRestartMaxDelayMs = 30_000;
   static readonly #childRestartGraceMs = 5_000;
-  static readonly #hopByHopHeaders = new Set([
-    "connection",
-    "keep-alive",
-    "proxy-authenticate",
-    "proxy-authorization",
-    "te",
-    "trailer",
-    "transfer-encoding",
-    "upgrade",
-  ]);
 
   readonly logger = new Logger("AkanApp");
   readonly #serverPath: string;
@@ -679,20 +670,7 @@ export class AkanApp {
   }
 
   #makeProxyHeaders(req: Request, childIdx: number) {
-    const headers = new Headers(req.headers);
-    for (const key of AkanApp.#hopByHopHeaders) headers.delete(key);
-    const forwardedFor = headers.get("x-forwarded-for");
-    const clientAddress = headers.get("x-real-ip") ?? "127.0.0.1";
-    const host = headers.get("host");
-    headers.set("x-forwarded-for", forwardedFor ? `${forwardedFor}, ${clientAddress}` : clientAddress);
-    headers.set("x-forwarded-host", host ?? new URL(req.url).host);
-    headers.set("x-forwarded-proto", req.url.startsWith("https:") ? "https" : "http");
-    headers.set("x-akan-child-idx", String(childIdx));
-    if (!headers.has("x-request-id") && process.env.AKAN_BENCH_SKIP_REQUEST_ID !== "1") {
-      headers.set("x-request-id", crypto.randomUUID());
-    }
-    headers.set("host", "akan-child");
-    return headers;
+    return makeAkanChildProxyHeaders(req, childIdx);
   }
 
   #invalidateFederationChildCache() {

package/server/akanAppHeaders.ts

@@ -0,0 +1,30 @@
+const HOP_BY_HOP_HEADERS = new Set([
+  "connection",
+  "keep-alive",
+  "proxy-authenticate",
+  "proxy-authorization",
+  "te",
+  "trailer",
+  "transfer-encoding",
+  "upgrade",
+]);
+
+export function makeAkanChildProxyHeaders(req: Request, childIdx: number): Headers {
+  const headers = new Headers(req.headers);
+  for (const key of HOP_BY_HOP_HEADERS) headers.delete(key);
+  const forwardedFor = headers.get("x-forwarded-for");
+  const clientAddress = headers.get("x-real-ip") ?? "127.0.0.1";
+  const host = headers.get("host");
+  headers.set("x-forwarded-for", forwardedFor ? `${forwardedFor}, ${clientAddress}` : clientAddress);
+  headers.set("x-forwarded-host", headers.get("x-forwarded-host") ?? host ?? new URL(req.url).host);
+  headers.set(
+    "x-forwarded-proto",
+    headers.get("x-forwarded-proto") ?? (req.url.startsWith("https:") ? "https" : "http"),
+  );
+  headers.set("x-akan-child-idx", String(childIdx));
+  if (!headers.has("x-request-id") && process.env.AKAN_BENCH_SKIP_REQUEST_ID !== "1") {
+    headers.set("x-request-id", crypto.randomUUID());
+  }
+  headers.set("host", "akan-child");
+  return headers;
+}

package/server/di/predefinedAdaptor.ts

@@ -1,4 +1,4 @@
-import type { DatabaseMode } from "akanjs/base";
+import type { DatabaseMode } from "akanjs";
 import {
   type AdaptorCls,
   BlobStorage,

package/types/dictionary/base.dictionary.d.ts

@@ -1 +1 @@
-export declare const baseDictionary: import("./dictInfo.d.ts").ServiceDictInfo<[string, string], string, never, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">;
+export declare const baseDictionary: import("./dictInfo.d.ts").ServiceDictInfo<[string, string], string, never, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">;

package/types/dictionary/dictionary.d.ts

@@ -1,11 +1,11 @@
 import type { BaseEndpoint } from "akanjs/signal";
 export declare const dictionary: {
-    base: import("./locale.d.ts").DictModule<import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, never>;
+    base: import("./locale.d.ts").DictModule<import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, never>;
 };
-export declare const Err: import("./trans.d.ts").ErrConstructor<never>, translate: (lang: "en" | "ko" | "zhChs" | "zhCht" | "ja", key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, data?: import("./trans.d.ts").TranslationData) => string, msg: {
-    info: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
-    success: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
-    error: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
-    warning: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
-    loading: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
-}, getDictionary: (lang: "en" | "ko" | "zhChs" | "zhCht" | "ja") => object, getAllDictionary: () => import("./trans.d.ts").RootDictionary, __Dict_Key__: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "edit" | "view" | "success" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, __Error_Key__: never;
+export declare const Err: import("./trans.d.ts").ErrConstructor<never>, translate: (lang: "en" | "ko" | "zhChs" | "zhCht" | "ja", key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, data?: import("./trans.d.ts").TranslationData) => string, msg: {
+    info: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
+    success: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
+    error: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
+    warning: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
+    loading: (key: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, option?: import("./trans.d.ts").TransMessageOption) => void;
+}, getDictionary: (lang: "en" | "ko" | "zhChs" | "zhCht" | "ja") => object, getAllDictionary: () => import("./trans.d.ts").RootDictionary, __Dict_Key__: import("./locale.d.ts").ServiceTranslatorKey<"base", BaseEndpoint, "error" | "save" | "password" | "remove" | "failed" | "ok" | "connecting" | "success" | "edit" | "view" | "somethingWrong" | "connected" | "serverDisconnected" | "refreshing" | "tryReconnecting" | "serverHasProblem" | "checkServerStatus" | "processing" | "processed" | "noData" | "invalidValueError" | "emailInvalidError" | "phoneInvalidError" | "cancel" | "unauthorized" | "confirmClose" | "textTooShortError" | "textTooLongError" | "selectTooShortError" | "selectTooLongError" | "numberTooSmallError" | "numberTooBigError" | "passwordNotMatchError" | "selectDateError" | "priceUnit" | "passwordConfirm" | "noOptions" | "addModel" | "createModel" | "createSuccess" | "updateModel" | "removeModel" | "updateSuccess" | "removeSuccess" | "sureToRemove" | "irreversibleOps" | "typeNameToRemove" | "yesRemove" | "removeMsg" | "confirmMsg" | "perPage" | "actions" | "new">, __Error_Key__: never;

package/types/document/documentSchema.d.ts

@@ -0,0 +1,33 @@
+import type { PromiseOrObject } from "akanjs/base";
+import type { DocumentQuery, DocumentQueryHelper } from "./documentQuery.d.ts";
+import type { CRUDEventType, SaveEventType } from "./into.d.ts";
+export type DocumentHookName = `before${Capitalize<SaveEventType>}` | `after${Capitalize<SaveEventType>}`;
+export interface DocumentIndexDescriptor {
+    name?: string;
+    fields: Record<string, 1 | -1 | "text" | boolean>;
+    unique?: boolean;
+    text?: boolean;
+    where?: DocumentQuery;
+}
+export interface DocumentIndexBuilder<Schema> {
+    path(path: string, order?: 1 | -1): DocumentIndexBuilder<Schema>;
+    text(path: string): DocumentIndexBuilder<Schema>;
+    unique(): DocumentIndexBuilder<Schema>;
+    where(where: DocumentQuery | ((q: DocumentQueryHelper) => DocumentQuery)): DocumentIndexBuilder<Schema>;
+    done(): Schema;
+}
+export type DocumentSaveHook<Doc = unknown> = (this: Doc, next?: () => void, type?: CRUDEventType) => PromiseOrObject<void>;
+export declare class DocumentSchema<Doc = unknown> {
+    readonly preHooks: Map<SaveEventType, DocumentSaveHook<Doc>[]>;
+    readonly postHooks: Map<SaveEventType, DocumentSaveHook<Doc>[]>;
+    readonly indexes: DocumentIndexDescriptor[];
+    pre<HookDoc = Doc>(type: SaveEventType, hook: DocumentSaveHook<HookDoc>): this;
+    post<HookDoc = Doc>(type: SaveEventType, hook: DocumentSaveHook<HookDoc>): this;
+    hook(type: DocumentHookName, hook: DocumentSaveHook<Doc>): this;
+    index(fields: DocumentIndexDescriptor["fields"], options?: Omit<DocumentIndexDescriptor, "fields">): this;
+    text(...fields: string[]): this;
+    createIndex(name: string): DocumentIndexBuilder<this>;
+}
+export type SchemaOf<Mdl = unknown, Doc = unknown> = DocumentSchema<Doc> & {
+    readonly __model?: Mdl;
+};