@notion-headless-cms/core 0.1.2 → 0.2.0

package/dist/content-Biqf0l_o.d.ts

@@ -1,51 +0,0 @@
-/**
- * ライブラリが動作するために必須なフィールド。
- * 利用者はこのインターフェースを拡張して独自のコンテンツ型を定義する。
- *
- * @example
- * interface Post extends BaseContentItem {
- *   title: string;
- *   author: string;
- * }
- * createCMS<Post>({ source: notionAdapter({ ... }) })
- */
-interface BaseContentItem {
-    /** Notion ページ ID（変更検知に必須）。 */
-    id: string;
-    /** URL キー（必須）。 */
-    slug: string;
-    /** 最終更新タイムスタンプ（変更検知に必須）。 */
-    updatedAt: string;
-    /** コンテンツのステータス。ステータスのない DB では省略可能。 */
-    status?: string;
-    /** 公開日時。日付プロパティのない DB では省略可能。 */
-    publishedAt?: string;
-}
-/** ストレージにキャッシュされたレンダリング済みコンテンツ。 */
-interface CachedItem<T extends BaseContentItem = BaseContentItem> {
-    html: string;
-    item: T;
-    notionUpdatedAt: string;
-    cachedAt: number;
-}
-/** ストレージにキャッシュされたコンテンツ一覧。 */
-interface CachedItemList<T extends BaseContentItem = BaseContentItem> {
-    items: T[];
-    cachedAt: number;
-}
-/** ストレージから取得したバイナリオブジェクト。 */
-interface StorageBinary {
-    data: ArrayBuffer;
-    contentType?: string;
-}
-/** Notionのプロパティ名マッピング（すべてオプション）。 */
-interface CMSSchemaProperties {
-    /** Notionのスラッグプロパティ名。デフォルト: 'Slug' */
-    slug?: string;
-    /** Notionのステータスプロパティ名。デフォルト: 'Status' */
-    status?: string;
-    /** Notionの公開日プロパティ名。デフォルト: 'CreatedAt' */
-    date?: string;
-}
-
-export type { BaseContentItem as B, CMSSchemaProperties as C, StorageBinary as S, CachedItem as a, CachedItemList as b };

package/dist/errors.d.ts

@@ -1,30 +0,0 @@
-type BuiltInCMSErrorCode = "core/config_invalid" | "core/schema_invalid" | "source/fetch_items_failed" | "source/fetch_item_failed" | "source/load_markdown_failed" | "cache/io_failed" | "cache/image_fetch_failed" | "renderer/failed";
-/**
- * CMS エラーコード。
- * `BuiltInCMSErrorCode` のリテラル補完を維持しつつ、
- * サードパーティアダプタが独自コードを定義できるよう `string & {}` で拡張可能にする。
- */
-type CMSErrorCode = BuiltInCMSErrorCode | (string & {});
-interface CMSErrorContext {
-    operation: string;
-    slug?: string;
-    dataSourceId?: string;
-    pageId?: string;
-    [key: string]: string | number | boolean | null | undefined;
-}
-declare class CMSError extends Error {
-    readonly code: CMSErrorCode;
-    readonly cause?: unknown;
-    readonly context: CMSErrorContext;
-    constructor(params: {
-        code: CMSErrorCode;
-        message: string;
-        cause?: unknown;
-        context: CMSErrorContext;
-    });
-}
-declare function isCMSError(error: unknown): error is CMSError;
-/** エラーコードが特定の名前空間に属するかを判定する（例: "source/"）。 */
-declare function isCMSErrorInNamespace(error: unknown, namespace: string): error is CMSError;
-
-export { CMSError, type CMSErrorCode, type CMSErrorContext, isCMSError, isCMSErrorInNamespace };

package/dist/errors.js

@@ -1,11 +0,0 @@
-import {
-  CMSError,
-  isCMSError,
-  isCMSErrorInNamespace
-} from "./chunk-V6ML4QE5.js";
-export {
-  CMSError,
-  isCMSError,
-  isCMSErrorInNamespace
-};
-//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/hooks-B83RUclt.d.ts

@@ -1,41 +0,0 @@
-import { B as BaseContentItem, a as CachedItem } from './content-Biqf0l_o.js';
-
-type MaybePromise<T> = T | Promise<T>;
-interface CMSHooks<T extends BaseContentItem = BaseContentItem> {
-    beforeCache?: (item: CachedItem<T>) => MaybePromise<CachedItem<T>>;
-    afterRender?: (html: string, item: T) => MaybePromise<string>;
-    onCacheHit?: (slug: string, item: CachedItem<T>) => void;
-    onCacheMiss?: (slug: string) => void;
-    onListCacheHit?: (items: T[], cachedAt: number) => void;
-    onListCacheMiss?: () => void;
-    onError?: (error: Error) => void;
-    onRenderStart?: (slug: string) => void;
-    onRenderEnd?: (slug: string, durationMs: number) => void;
-}
-
-interface Logger {
-    debug?: (message: string, context?: Record<string, unknown>) => void;
-    info?: (message: string, context?: Record<string, unknown>) => void;
-    warn?: (message: string, context?: Record<string, unknown>) => void;
-    error?: (message: string, context?: Record<string, unknown>) => void;
-}
-
-interface CMSPlugin<T extends BaseContentItem = BaseContentItem> {
-    name: string;
-    hooks?: CMSHooks<T>;
-    logger?: Partial<Logger>;
-}
-declare function definePlugin<T extends BaseContentItem>(plugin: CMSPlugin<T>): CMSPlugin<T>;
-
-/**
- * プラグイン配列とダイレクトフックを合成して単一の CMSHooks を返す。
- * beforeCache / afterRender はパイプライン（前の出力が次の入力）。
- * onCacheHit などオブザーバー系は全員に同じ値を渡し、例外は logger に流して握りつぶす。
- */
-declare function mergeHooks<T extends BaseContentItem>(plugins: CMSPlugin<T>[], directHooks?: CMSHooks<T>, logger?: Logger): CMSHooks<T>;
-/** プラグイン配列とダイレクトロガーを合成して単一の Logger を返す。 */
-declare function mergeLoggers(plugins: Array<{
-    logger?: Partial<Logger>;
-}>, directLogger?: Logger): Logger | undefined;
-
-export { type CMSHooks as C, type Logger as L, type MaybePromise as M, type CMSPlugin as a, mergeLoggers as b, definePlugin as d, mergeHooks as m };

package/dist/hooks.d.ts

@@ -1,2 +0,0 @@
-import './content-Biqf0l_o.js';
-export { m as mergeHooks, b as mergeLoggers } from './hooks-B83RUclt.js';

package/dist/hooks.js

@@ -1,9 +0,0 @@
-import {
-  mergeHooks,
-  mergeLoggers
-} from "./chunk-4KGKWKKI.js";
-export {
-  mergeHooks,
-  mergeLoggers
-};
-//# sourceMappingURL=hooks.js.map

package/dist/hooks.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/index.d.ts

@@ -1,278 +0,0 @@
-export { MemoryDocumentCacheOptions, MemoryImageCacheOptions, memoryCache, memoryDocumentCache, memoryImageCache } from './cache/memory.js';
-export { noopDocumentCache, noopImageCache } from './cache/noop.js';
-import { B as BaseContentItem, C as CMSSchemaProperties, a as CachedItem, S as StorageBinary } from './content-Biqf0l_o.js';
-export { b as CachedItemList } from './content-Biqf0l_o.js';
-import { PluggableList } from '@notion-headless-cms/renderer';
-import { C as CacheConfig } from './cache-DvbyemBK.js';
-export { D as DocumentCacheAdapter, I as ImageCacheAdapter } from './cache-DvbyemBK.js';
-import { C as CMSHooks, a as CMSPlugin, L as Logger } from './hooks-B83RUclt.js';
-export { M as MaybePromise, d as definePlugin, m as mergeHooks, b as mergeLoggers } from './hooks-B83RUclt.js';
-export { CMSError, CMSErrorCode, CMSErrorContext, isCMSError, isCMSErrorInNamespace } from './errors.js';
-
-/** 文字列をSHA-256でハッシュ化し、16進数文字列として返す。画像キーの生成に使用。 */
-declare function sha256Hex(input: string): Promise<string>;
-/**
- * キャッシュが有効期限切れかどうかを判定する。
- * ttlMs が未指定の場合は常に false（無期限有効）を返す。
- */
-declare function isStale(cachedAt: number, ttlMs?: number): boolean;
-
-/** ソース側クエリのフィルタ・ソート条件。 */
-interface SourceQueryOptions {
-    filter?: {
-        statuses?: string[];
-        tags?: string[];
-        [key: string]: unknown;
-    };
-    sort?: {
-        property: string;
-        direction: "asc" | "desc";
-    }[];
-    pageSize?: number;
-    cursor?: string;
-}
-/** ソース側クエリの結果。 */
-interface SourceQueryResult<T> {
-    items: T[];
-    hasMore: boolean;
-    nextCursor?: string;
-}
-/**
- * コンテンツソース（Notion など）を抽象化するインターフェース。
- * core は Notion の知識を持たず、DataSourceAdapter 経由でのみデータを取得する。
- */
-interface DataSourceAdapter<T extends BaseContentItem = BaseContentItem> {
-    readonly name: string;
-    readonly publishedStatuses?: readonly string[];
-    readonly accessibleStatuses?: readonly string[];
-    list(opts?: {
-        publishedStatuses?: readonly string[];
-    }): Promise<T[]>;
-    findBySlug(slug: string): Promise<T | null>;
-    loadMarkdown(item: T): Promise<string>;
-    /** Notion 側でフィルタ・ソートを行うクエリ（オプション）。 */
-    query?(opts: SourceQueryOptions): Promise<SourceQueryResult<T>>;
-}
-
-/**
- * render() オプション。core は renderer の実装を知らず、この型だけを扱う。
- * @notion-headless-cms/renderer の renderMarkdown() はこのシグネチャと構造的に互換。
- */
-interface RenderOptions {
-    imageProxyBase?: string;
-    cacheImage?: (url: string) => Promise<string>;
-    remarkPlugins?: PluggableList;
-    rehypePlugins?: PluggableList;
-}
-/** カスタムレンダラー関数の型。デフォルトは @notion-headless-cms/renderer の renderMarkdown。 */
-type RendererFn = (markdown: string, opts?: RenderOptions) => Promise<string>;
-/** スキーマ設定。公開ステータスのフィルタやプロパティ名マッピングを制御する。 */
-interface SchemaConfig<T extends BaseContentItem = BaseContentItem> {
-    /** list() で返す「公開済み」ステータス値の配列。デフォルト: [] （全件返す） */
-    publishedStatuses?: string[];
-    /** findBySlug() でアクセス可能なステータス値の配列。デフォルト: [] （全件許可） */
-    accessibleStatuses?: string[];
-    /** mapItem 未使用時のプロパティ名マッピング。source-notion 経由で渡す場合は不要。 */
-    properties?: CMSSchemaProperties;
-}
-/** レンダリング・コンテンツ処理設定。 */
-interface ContentConfig {
-    /** 画像プロキシのベースURL。デフォルト: '/api/images' */
-    imageProxyBase?: string;
-    /** 追加する remark プラグイン。 */
-    remarkPlugins?: PluggableList;
-    /** 追加する rehype プラグイン。 */
-    rehypePlugins?: PluggableList;
-}
-/** レートリミット・リトライ設定。 */
-interface RateLimiterConfig {
-    /** 同時実行数の上限。デフォルト: 3 */
-    maxConcurrent?: number;
-    /** リトライ対象の HTTP ステータスコード。デフォルト: [429, 502, 503] */
-    retryOn?: number[];
-    /** 最大リトライ回数。デフォルト: 4 */
-    maxRetries?: number;
-    /** リトライ時の基準待機時間（ミリ秒）。デフォルト: 1000 */
-    baseDelayMs?: number;
-}
-/**
- * createCMS() に渡すオプション。
- * ジェネリクス型 T にカスタムコンテンツ型を指定できる（デフォルト: BaseContentItem）。
- */
-interface CreateCMSOptions<T extends BaseContentItem = BaseContentItem> {
-    /** データソースアダプタ（Notion など）。 */
-    source: DataSourceAdapter<T>;
-    /** レンダラー関数。未指定時は @notion-headless-cms/renderer の renderMarkdown を使用。 */
-    renderer?: RendererFn;
-    /** キャッシュ設定。未設定時はキャッシュなし。 */
-    cache?: CacheConfig<T>;
-    /** スキーマ・ステータス設定。 */
-    schema?: SchemaConfig<T>;
-    /** レンダリング・コンテンツ処理設定。 */
-    content?: ContentConfig;
-    /** Cloudflare Workers の waitUntil に相当する非同期処理の登録関数。 */
-    waitUntil?: (p: Promise<unknown>) => void;
-    /** ライフサイクルフック。 */
-    hooks?: CMSHooks<T>;
-    /** プラグイン配列。フックとロガーを組み合わせて提供できる。 */
-    plugins?: CMSPlugin<T>[];
-    /** ロガー。 */
-    logger?: Logger;
-    /** レートリミット・リトライ設定。 */
-    rateLimiter?: RateLimiterConfig;
-}
-
-interface QueryResult<T> {
-    items: T[];
-    total: number;
-    page: number;
-    perPage: number;
-    hasNext: boolean;
-    hasPrev: boolean;
-}
-declare class QueryBuilder<T extends BaseContentItem> {
-    private readonly source;
-    private readonly defaultStatuses;
-    private _statuses;
-    private _tags;
-    private _predicate;
-    private _sortField;
-    private _sortDir;
-    private _page;
-    private _perPage;
-    constructor(source: DataSourceAdapter<T>, defaultStatuses?: string[]);
-    status(s: string | string[]): this;
-    tag(t: string | string[]): this;
-    where(predicate: (item: T) => boolean): this;
-    sortBy(field: keyof T & string, dir?: "asc" | "desc"): this;
-    paginate(opts: {
-        page: number;
-        perPage: number;
-    }): this;
-    execute(): Promise<QueryResult<T>>;
-    executeOne(): Promise<T | null>;
-    /** 前後アイテムを返す。sortBy() で指定したソート順を適用する。 */
-    adjacent(slug: string): Promise<{
-        prev: T | null;
-        next: T | null;
-    }>;
-    /** 最初の 1 件を返す。`.paginate({ page: 1, perPage: 1 }).executeOne()` の短縮形。 */
-    first(): Promise<T | null>;
-}
-
-/** キャッシュ系の公開名前空間。SWR 読み取りとキャッシュ管理を統合する。 */
-interface CacheAccessor<T extends BaseContentItem> {
-    /** キャッシュ優先でコンテンツ一覧を返す（SWR）。 */
-    getList(): Promise<{
-        items: T[];
-        isStale: boolean;
-        cachedAt: number;
-    }>;
-    /** キャッシュ優先で単一コンテンツを返す（SWR）。HTML 付きの CachedItem を返す。 */
-    get(slug: string): Promise<CachedItem<T> | null>;
-    /** 全コンテンツを事前レンダリングしてキャッシュに保存する。 */
-    prefetchAll(opts?: {
-        concurrency?: number;
-        onProgress?: (done: number, total: number) => void;
-    }): Promise<{
-        ok: number;
-        failed: number;
-    }>;
-    /** 指定スコープのキャッシュを無効化する。 */
-    revalidate(scope?: "all" | {
-        slug: string;
-    }): Promise<void>;
-    /** Webhook ペイロードを元にキャッシュを同期する。 */
-    sync(payload?: {
-        slug?: string;
-    }): Promise<{
-        updated: string[];
-    }>;
-    /** リスト全体の変更を検知する。version はリスト取得時の buildListVersion の値。 */
-    checkList(version: string): Promise<{
-        changed: false;
-    } | {
-        changed: true;
-        items: T[];
-    }>;
-    /** 単一アイテムの変更を検知し、変更があれば再レンダリングしてキャッシュを更新する。 */
-    checkItem(slug: string, lastEdited: string): Promise<{
-        changed: false;
-    } | {
-        changed: true;
-        html: string;
-        item: T;
-        notionUpdatedAt: string;
-    }>;
-}
-/**
- * Notion をバックエンドとして使う汎用ヘッドレス CMS クラス。
- *
- * @example
- * const cms = createCMS({
- *   source: notionAdapter({ token: '...', dataSourceId: '...' }),
- * });
- * const items = await cms.list();
- * const entry = await cms.cache.get('my-post');
- */
-declare class CMS<T extends BaseContentItem = BaseContentItem> {
-    private readonly source;
-    private readonly docCache;
-    private readonly imgCache;
-    private readonly hasImageCache;
-    private readonly ttlMs;
-    private readonly publishedStatuses;
-    private readonly accessibleStatuses;
-    private readonly imageProxyBase;
-    private readonly contentConfig;
-    private readonly rendererFn;
-    private readonly waitUntil;
-    private readonly hooks;
-    private readonly logger;
-    private readonly retryConfig;
-    private readonly maxConcurrent;
-    readonly cache: CacheAccessor<T>;
-    constructor(opts: CreateCMSOptions<T>);
-    /** 公開済みコンテンツ一覧をソースから直接取得する。 */
-    list(): Promise<T[]>;
-    /** スラッグでコンテンツをソースから直接取得する。 */
-    find(slug: string): Promise<T | null>;
-    /** 複数スラッグをまとめてソースから直接取得する。accessibleStatuses フィルタを適用する。 */
-    findMany(slugs: string[]): Promise<Map<string, T>>;
-    /** アイテムが publishedStatuses に含まれるステータスかどうかを返す。 */
-    isPublished(item: T): boolean;
-    /** コンテンツを Markdown → HTML にレンダリングし、CachedItem として返す。キャッシュには保存しない。 */
-    render(item: T): Promise<CachedItem<T>>;
-    /** QueryBuilder を返す。ステータス・タグ・ページネーションなどを連鎖で指定できる。 */
-    query(): QueryBuilder<T>;
-    /** 静的生成用のスラッグ一覧を返す。 */
-    getStaticSlugs(): Promise<string[]>;
-    /** ハッシュキーでキャッシュ画像を取得する。 */
-    getCachedImage(hash: string): Promise<StorageBinary | null>;
-    /** ハッシュキーでキャッシュ画像を Response として返す。 */
-    createCachedImageResponse(hash: string): Promise<Response | null>;
-    private cachedList;
-    private cachedGet;
-    private prefetchAll;
-    private revalidate;
-    private syncFromWebhook;
-    private checkListUpdate;
-    private checkItemUpdate;
-    private buildCachedItem;
-}
-/** 設定済みの CMS インスタンスを生成するファクトリ関数。 */
-declare function createCMS<T extends BaseContentItem = BaseContentItem>(opts: CreateCMSOptions<T>): CMS<T>;
-
-interface RetryConfig {
-    retryOn: number[];
-    maxRetries: number;
-    baseDelayMs: number;
-    /** true のとき指数バックオフにランダムジッターを加える（Thundering Herd 対策）。デフォルト: true */
-    jitter?: boolean;
-    onRetry?: (attempt: number, status: number) => void;
-}
-declare const DEFAULT_RETRY_CONFIG: RetryConfig;
-/** 指数バックオフ（オプションでジッター付き）でリトライする。retryOn に含まれる HTTP エラーのみ対象。 */
-declare function withRetry<T>(fn: () => Promise<T>, config: RetryConfig): Promise<T>;
-
-export { BaseContentItem, CMS, CMSHooks, CMSPlugin, CMSSchemaProperties, type CacheAccessor, CacheConfig, CachedItem, type ContentConfig, type CreateCMSOptions, DEFAULT_RETRY_CONFIG, type DataSourceAdapter, Logger, QueryBuilder, type QueryResult, type RateLimiterConfig, type RenderOptions, type RendererFn, type RetryConfig, type SchemaConfig, type SourceQueryOptions, type SourceQueryResult, StorageBinary, createCMS, isStale, sha256Hex, withRetry };