@auspex-ai/next 0.0.0-stage → 1.4.2

package/dist/config.d.cts

@@ -0,0 +1,54 @@
+import { NextConfig } from "next";
+//#region src/config.d.ts
+export interface WithAuspexOptions {
+  /** false でアイコン名を書き込まない(手書きの属性は消す。コンポーネント名を本番の HTML に出したくない場合)。既定 true。elementNames とは独立 */
+  iconNames?: boolean;
+  /**
+   * false で要素の参照(data-auspex-ref)を書き込まない(手書きの属性は消す)。既定 true。iconNames とは独立
+   * 名前が無いと、対象解決(PdM の言い回しから決定点を選ぶ)の手がかりが減る(Design Doc #43・#50)。
+   * ビルド鍵(環境変数 AUSPEX_BUILD_KEY)と登録の受け口 host が無いときも、参照は書かれない
+   */
+  elementNames?: boolean;
+  /**
+   * 'cli': ビルドの終わりの登録を hook ではなく CLI(`auspex-register-names`。`next build` の後に流す)で行う。
+   * runAfterProductionCompile が使えない Next で参照を書きたいときに指定する(Design Doc #50 の 3 節)
+   */
+  registerNames?: 'cli';
+  /** 登録の受け口(受信口と同じ origin。https)。無ければ環境変数 NEXT_PUBLIC_AUSPEX_HOST。環境変数 AUSPEX_INTERNAL_HOST(セルフホストの internal の面)があれば名前の登録だけそちらへ送る */
+  host?: string;
+}
+/** ビルド済みのローダー(dist/ に config と並べて置く) */
+export declare const ICON_NAME_LOADER: string;
+export declare const SVG_NAME_LOADER: string;
+type LoaderItem = string | {
+  loader: string;
+  options?: unknown;
+};
+type RuleItem = {
+  loaders: LoaderItem[];
+  [k: string]: unknown;
+};
+/** 顧客のプロジェクトの next のバージョン(取れなければ null) */
+export declare function nextVersion(): string | null;
+/** 顧客のプロジェクトの next のメジャーバージョン(取れなければ 0) */
+export declare function nextMajor(): number;
+/** 3 節の表(本番のビルドの行)。`turbopack` は Turbopack で動いているか */
+export type HookRow = 'usable' | 'turbopack-15' | 'unusable' | 'unknown';
+/** runAfterProductionCompile が使えるか(Design Doc #50 の 3 節の表。線は暫定)。数値で比べる */
+export declare function hookRow(version: string | null, turbopack: boolean): HookRow;
+/**
+ * 新しく作る JS/TS のルール。Next 16 以降は `condition: { not: 'foreign' }` で node_modules を
+ * ローダーに通さない(ファイルごとに Node のローダーを呼ぶコストを避ける)。それより前の Next の
+ * Turbopack には condition が無いので付けず、ローダーの中で node_modules を素通しする
+ */
+export declare function iconNameRule(major: number, loader?: LoaderItem): RuleItem;
+type ConfigFunction = (phase: string, ctx: {
+  defaultConfig: NextConfig;
+}) => NextConfig | Promise<NextConfig>;
+/**
+ * next.config を包む。戻り値の型は入力に合わせる(オブジェクトならオブジェクト、関数なら同じ引数で先に呼んで
+ * await してから包む async の関数)。できるだけ最も外側に置く(webpack・turbopack のキーを落とすプラグインが外側にあるとローダーが失われる)
+ */
+export declare function withAuspex(config?: NextConfig, options?: WithAuspexOptions): NextConfig;
+export declare function withAuspex(config: ConfigFunction, options?: WithAuspexOptions): ConfigFunction;
+//#endregion

package/dist/config.d.mts

@@ -0,0 +1,54 @@
+import { NextConfig } from "next";
+//#region src/config.d.ts
+export interface WithAuspexOptions {
+  /** false でアイコン名を書き込まない(手書きの属性は消す。コンポーネント名を本番の HTML に出したくない場合)。既定 true。elementNames とは独立 */
+  iconNames?: boolean;
+  /**
+   * false で要素の参照(data-auspex-ref)を書き込まない(手書きの属性は消す)。既定 true。iconNames とは独立
+   * 名前が無いと、対象解決(PdM の言い回しから決定点を選ぶ)の手がかりが減る(Design Doc #43・#50)。
+   * ビルド鍵(環境変数 AUSPEX_BUILD_KEY)と登録の受け口 host が無いときも、参照は書かれない
+   */
+  elementNames?: boolean;
+  /**
+   * 'cli': ビルドの終わりの登録を hook ではなく CLI(`auspex-register-names`。`next build` の後に流す)で行う。
+   * runAfterProductionCompile が使えない Next で参照を書きたいときに指定する(Design Doc #50 の 3 節)
+   */
+  registerNames?: 'cli';
+  /** 登録の受け口(受信口と同じ origin。https)。無ければ環境変数 NEXT_PUBLIC_AUSPEX_HOST。環境変数 AUSPEX_INTERNAL_HOST(セルフホストの internal の面)があれば名前の登録だけそちらへ送る */
+  host?: string;
+}
+/** ビルド済みのローダー(dist/ に config と並べて置く) */
+export declare const ICON_NAME_LOADER: string;
+export declare const SVG_NAME_LOADER: string;
+type LoaderItem = string | {
+  loader: string;
+  options?: unknown;
+};
+type RuleItem = {
+  loaders: LoaderItem[];
+  [k: string]: unknown;
+};
+/** 顧客のプロジェクトの next のバージョン(取れなければ null) */
+export declare function nextVersion(): string | null;
+/** 顧客のプロジェクトの next のメジャーバージョン(取れなければ 0) */
+export declare function nextMajor(): number;
+/** 3 節の表(本番のビルドの行)。`turbopack` は Turbopack で動いているか */
+export type HookRow = 'usable' | 'turbopack-15' | 'unusable' | 'unknown';
+/** runAfterProductionCompile が使えるか(Design Doc #50 の 3 節の表。線は暫定)。数値で比べる */
+export declare function hookRow(version: string | null, turbopack: boolean): HookRow;
+/**
+ * 新しく作る JS/TS のルール。Next 16 以降は `condition: { not: 'foreign' }` で node_modules を
+ * ローダーに通さない(ファイルごとに Node のローダーを呼ぶコストを避ける)。それより前の Next の
+ * Turbopack には condition が無いので付けず、ローダーの中で node_modules を素通しする
+ */
+export declare function iconNameRule(major: number, loader?: LoaderItem): RuleItem;
+type ConfigFunction = (phase: string, ctx: {
+  defaultConfig: NextConfig;
+}) => NextConfig | Promise<NextConfig>;
+/**
+ * next.config を包む。戻り値の型は入力に合わせる(オブジェクトならオブジェクト、関数なら同じ引数で先に呼んで
+ * await してから包む async の関数)。できるだけ最も外側に置く(webpack・turbopack のキーを落とすプラグインが外側にあるとローダーが失われる)
+ */
+export declare function withAuspex(config?: NextConfig, options?: WithAuspexOptions): NextConfig;
+export declare function withAuspex(config: ConfigFunction, options?: WithAuspexOptions): ConfigFunction;
+//#endregion