@notion-headless-cms/core 0.3.8 → 0.3.10

package/dist/cache-QrXdXYMs.d.mts

@@ -1,170 +0,0 @@
-import { a as CachedItemMeta, c as ContentBlock, i as CachedItemList, r as CachedItemContent, s as StorageBinary, t as BaseContentItem, u as ImageRef } from "./content-DyrOwjbA.mjs";
-
-//#region src/types/data-source.d.ts
-/**
- * Notion プロパティ1件の型情報とプロパティ名を保持する。
- * CLI が生成する `*Properties` オブジェクトの各要素の型。
- */
-interface PropertyDef {
-  type: "title" | "richText" | "select" | "multiSelect" | "date" | "number" | "checkbox" | "url";
-  /** Notion DB 上のプロパティ名（表示名）。 */
-  notion: string;
-}
-/** Notion DB のプロパティ一覧マップ。CLI 生成の `*Properties` の型。 */
-type PropertyMap = Record<string, PropertyDef>;
-/**
- * 無効化対象の粒度。
- * - "meta" — メタデータキャッシュのみ失効
- * - "content" — 本文キャッシュのみ失効（リスト次回読み出しで lazy 再生成）
- * - "all" — 両方（既定）
- */
-type InvalidateKind = "meta" | "content" | "all";
-/**
- * キャッシュ無効化のスコープ (DataSource 層で参照する形)。
- * `kind` を省略した場合は `"all"` 相当として扱う。
- */
-type InvalidateScope = "all" | {
-  collection: string;
-  kind?: InvalidateKind;
-} | {
-  collection: string;
-  slug: string;
-  kind?: InvalidateKind;
-};
-/**
- * Webhook 受信時の検証設定。
- */
-interface WebhookConfig {
-  /** 署名検証用シークレット。 */
-  secret?: string;
-}
-/**
- * コンテンツソースを抽象化する v1 インターフェース。
- *
- * ユーザーは直接実装しない。`notion-orm` 等の ORM パッケージが実装する。
- * core は Notion 固有の知識を持たず、このインターフェース経由でのみデータを扱う。
- * 将来 `googledocs-orm` 等の別ソースもこの I/F を満たせば差し替え可能。
- */
-interface DataSource<T extends BaseContentItem = BaseContentItem> {
-  /** ソース識別子 (ロギング・デバッグ用)。 */
-  readonly name: string;
-  /**
-   * CLI 生成の `*Properties` に対応するプロパティマップ。
-   * `properties` オプション経由で生成された DataSource のみ設定される。
-   * Core が `findByProp` の Notion プロパティ名解決に使用する。
-   */
-  readonly properties?: PropertyMap;
-  /** 公開済みアイテム一覧を取得する。 */
-  list(opts?: {
-    publishedStatuses?: readonly string[];
-  }): Promise<T[]>;
-  /**
-   * 指定した Notion プロパティ名と値で1件検索する。
-   * Core が slug フィールドのルックアップに使用する。
-   * `properties` オプション経由で生成された DataSource が実装する。
-   */
-  findByProp?(notionPropName: string, value: string): Promise<T | null>;
-  /** アイテム本文を ContentBlock 配列で返す。 */
-  loadBlocks(item: T): Promise<ContentBlock[]>;
-  /** アイテム本文を Markdown 文字列で返す (html() 生成の元ソース)。 */
-  loadMarkdown(item: T): Promise<string>;
-  /** SWR 鮮度判定用。item の最終更新タイムスタンプ。 */
-  getLastModified(item: T): string;
-  /** リスト全体のバージョン文字列 (例: 最新 last_edited_time)。 */
-  getListVersion(items: T[]): string;
-  /** 期限切れ画像 URL の再取得 (Notion の署名 URL 対応)。 */
-  resolveImageUrl?(ref: ImageRef): Promise<string>;
-  /**
-   * Webhook リクエストをパースして無効化スコープを返す。
-   * 実装していない場合は `$handler` が body の `{ slug }` にフォールバック。
-   */
-  parseWebhook?(req: Request, config: WebhookConfig): Promise<InvalidateScope>;
-}
-/**
- * `nhcSchema` の各コレクション設定エントリ。
- * ユーザーは CLI 生成の `nhcSchema` を渡すだけで、
- * この型は `createCMS` 内部で DataSource のファクトリに渡される。
- */
-interface CollectionConfig<T extends BaseContentItem = BaseContentItem> {
-  /** Notion データソース (database) ID。 */
-  databaseId: string;
-  /** スキーマ情報 (ORM が解釈する不透明データ)。 */
-  schema?: any;
-  /** 公開扱いするステータス値。 */
-  publishedStatuses?: string[];
-  /** アクセス許可するステータス値。 */
-  accessibleStatuses?: string[];
-  /** `T` を型レベルで持ち回るためのマーカー (ランタイム値なし)。 */
-  __itemType?: T;
-}
-/**
- * `nhc generate` が生成する `nhcSchema` の型。
- * コレクション名をキーとして、各コレクションの設定を保持する。
- */
-type CMSSchema = Record<string, CollectionConfig<any>>;
-/** `CollectionConfig<T>` から `T` を抽出するユーティリティ型。 */
-type InferCollectionItem<C> = C extends CollectionConfig<infer T> ? T : BaseContentItem;
-/**
- * DataSource を生成するファクトリ関数の型。
- * `createCMS` はコレクション名 → この関数 → DataSource の経路で組み立てる。
- *
- * ユーザーコードは直接呼ばない。`@notion-headless-cms/notion-orm` 等の
- * ORM パッケージが provide する。ORM 固有のオプション (Notion なら
- * `{ token }`、Google Docs なら `{ credentials }` 等) は `TOptions` の
- * generic で受け取る。
- *
- * @example
- * // notion-orm が DataSourceFactory<{ token: string }> として実装する
- * const factory: DataSourceFactory<{ token: string }> = ({ collection, config, options }) =>
- *   createNotionCollection({
- *     token: options.token,
- *     dataSourceId: config.databaseId,
- *     schema: config.schema,
- *   });
- */
-type DataSourceFactory<TOptions = unknown> = <T extends BaseContentItem>(args: {
-  collection: string;
-  config: CollectionConfig<T>;
-  options: TOptions;
-}) => DataSource<T>;
-//#endregion
-//#region src/types/cache.d.ts
-/**
- * ドキュメントキャッシュを抽象化するインターフェース。
- *
- * v0.4.0 で `getItem`/`setItem` を `getItemMeta`/`setItemMeta` +
- * `getItemContent`/`setItemContent` に分割した。
- * メタデータのみ取り出す軽量パスと、本文を遅延ロードするパスを分離するため。
- */
-interface DocumentCacheAdapter<T extends BaseContentItem = BaseContentItem> {
-  readonly name: string;
-  getList(): Promise<CachedItemList<T> | null>;
-  setList(data: CachedItemList<T>): Promise<void>;
-  getItemMeta(slug: string): Promise<CachedItemMeta<T> | null>;
-  setItemMeta(slug: string, data: CachedItemMeta<T>): Promise<void>;
-  getItemContent(slug: string): Promise<CachedItemContent | null>;
-  setItemContent(slug: string, data: CachedItemContent): Promise<void>;
-  /**
-   * 無効化。`scope.kind` で meta/content の粒度を指定できる。
-   * 省略時は両方失効させる。
-   */
-  invalidate?(scope: InvalidateScope): Promise<void>;
-}
-/** 画像キャッシュを抽象化するインターフェース。 */
-interface ImageCacheAdapter {
-  readonly name: string;
-  get(hash: string): Promise<StorageBinary | null>;
-  set(hash: string, data: ArrayBuffer, contentType: string): Promise<void>;
-}
-/**
- * キャッシュ設定。`"disabled"` を渡すと完全にキャッシュを無効化する。
- * オブジェクトの場合、document / image それぞれ独立したアダプタを差し込める。
- */
-type CacheConfig<T extends BaseContentItem = BaseContentItem> = "disabled" | {
-  document?: DocumentCacheAdapter<T>;
-  image?: ImageCacheAdapter; /** キャッシュの有効期間（ミリ秒）。未設定の場合はTTLなし。 */
-  ttlMs?: number;
-};
-//#endregion
-export { CollectionConfig as a, InferCollectionItem as c, PropertyDef as d, PropertyMap as f, CMSSchema as i, InvalidateKind as l, DocumentCacheAdapter as n, DataSource as o, WebhookConfig as p, ImageCacheAdapter as r, DataSourceFactory as s, CacheConfig as t, InvalidateScope as u };
-//# sourceMappingURL=cache-QrXdXYMs.d.mts.map