ampless 1.0.0-alpha.43 → 1.0.0-alpha.44

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -862,6 +862,16 @@ interface PluginPackageManifest {
862
862
  description?: LocalizedString;
863
863
  /** Optional docs / repo URL. */
864
864
  homepage?: string;
865
+ /**
866
+ * Subpath (relative to the plugin's package.json) of the editor
867
+ * module to auto-wire. `update-ampless` reads this to regenerate
868
+ * `app/(admin)/admin/_editor-bootstrap.tsx`. Absent = no editor
869
+ * extension (= plugin doesn't ship a tiptap Node).
870
+ *
871
+ * The referenced module must export `editorExtension` as a named
872
+ * symbol of type tiptap Extension.
873
+ */
874
+ editorExports?: string;
865
875
  }
866
876
  /**
867
877
  * Secret field types for `settings.secret`. Restricted to `text` /
@@ -777,25 +777,67 @@ runtime は `src` のホスト allowlist を強制しない。CSP はサイト
777
777
 
778
778
  ## 6d. Admin エディタ拡張の配線 (Phase 7)
779
779
 
780
- admin エディタに tiptap Node 拡張を提供するプラグインは、別途 `./editor` subpath の client-side エントリを出荷する。テンプレート側で `_editor-bootstrap.tsx` から配線する:
780
+ admin エディタに tiptap Node 拡張を提供するプラグインは、別途 `./editor` subpath の client-side エントリを出荷する。
781
+ `app/(admin)/admin/_editor-bootstrap.tsx` は `npm run update-ampless` によって**自動生成**される — 手動で編集してはならない。
782
+
783
+ ### プラグイン著者向け
784
+
785
+ `package.json#amplessPlugin` に `editorExports` を宣言する:
786
+
787
+ ```jsonc
788
+ // packages/plugin-youtube/package.json
789
+ "amplessPlugin": {
790
+ "apiVersion": 1,
791
+ "name": "youtube",
792
+ "trustLevel": "trusted",
793
+ "capabilities": ["contentFields"],
794
+ "editorExports": "./editor" // ← editor module のある subpath
795
+ }
796
+ ```
797
+
798
+ その subpath から `editorExtension` を named export する:
799
+
800
+ ```ts
801
+ // packages/plugin-youtube/src/editor.tsx
802
+ export const editorExtension = AmplessYoutubeNode // tiptap Node または Extension
803
+ ```
804
+
805
+ `package.json#exports` にも同 subpath を宣言すること(codegen がこれを検証する — 未宣言の場合は warning を出してそのプラグインをスキップする):
806
+
807
+ ```jsonc
808
+ "exports": {
809
+ ".": { "import": "./dist/index.js", "types": "./dist/index.d.ts" },
810
+ "./editor": { "import": "./dist/editor.js", "types": "./dist/editor.d.ts" }
811
+ }
812
+ ```
813
+
814
+ ### プラグインユーザー(サイトエンジニア)向け
815
+
816
+ 1. `npm i @ampless/plugin-youtube@alpha` — plugin を dependency として追加する。
817
+ 2. `cms.config.ts` に登録してサーバーサイド renderer を有効化する。
818
+ 3. `npm run update-ampless` — インストール済み plugin の manifest から `_editor-bootstrap.tsx` を自動再生成する。
819
+
820
+ 生成されたファイルはリポジトリにコミットされ、以下のような内容になる:
781
821
 
782
822
  ```tsx
783
- // templates/_shared/app/(admin)/admin/_editor-bootstrap.tsx
823
+ // app/(admin)/admin/_editor-bootstrap.tsx (AUTO-GENERATED — 編集不可)
784
824
  'use client'
825
+ // AUTO-GENERATED by `npm run update-ampless`. Do not edit — your changes
826
+ // will be overwritten on the next run.
785
827
  import { installAdminEditorExtensions } from '@ampless/admin/editor'
786
- import { youtubeEditor } from '@ampless/plugin-youtube/editor'
787
- import { tweetEditor } from '@ampless/plugin-x-embed/editor'
828
+ import { editorExtension as __ampless_plugin_x_embed_editor } from '@ampless/plugin-x-embed/editor'
829
+ import { editorExtension as __ampless_plugin_youtube_editor } from '@ampless/plugin-youtube/editor'
788
830
 
789
831
  export function EditorBootstrap({ children }: { children: React.ReactNode }) {
790
832
  installAdminEditorExtensions([
791
- youtubeEditor.extension,
792
- tweetEditor.extension,
833
+ __ampless_plugin_x_embed_editor,
834
+ __ampless_plugin_youtube_editor,
793
835
  ])
794
836
  return <>{children}</>
795
837
  }
796
838
  ```
797
839
 
798
- その上で layout に渡す:
840
+ このファイルは admin layout に渡される(テンプレートに既に組み込まれているので追加の作業は不要):
799
841
 
800
842
  ```tsx
801
843
  // templates/_shared/app/(admin)/admin/layout.tsx
@@ -806,6 +848,13 @@ export default createAdminLayout(admin, { editorBootstrap: EditorBootstrap })
806
848
 
807
849
  `installAdminEditorExtensions` は idempotent で、render 時に client component 内で呼ばれる。admin の `<TiptapEditor>` は毎回 render 時に登録済みリストを built-in extensions の末尾に spread する。
808
850
 
851
+ ### active source と完全無効化
852
+
853
+ **エディタ配線の active source は `package.json#dependencies`**(= `node_modules`)であり、`cms.config.ts` ではない。
854
+
855
+ - plugin を `cms.config.ts` から外しても `package.json` に dep が残っていれば、editor の paste rule は**有効のまま**になる。editor は tiptap document にそのノード型を挿入できるが、公開 renderer はレンダリングしない(不整合状態 — 避けること)。
856
+ - 完全に無効化するには: `cms.config.ts` から削除 **かつ** `npm uninstall @ampless/plugin-...` を実行し、`npm run update-ampless` で bootstrap ファイルを再生成する。
857
+
809
858
  ### エディタプレビューのパイプライン
810
859
 
811
860
  admin の edit / new post フォームは preview ペインを `<iframe sandbox="allow-scripts">` で表示する。`srcDoc` はテンプレート側 preview Route Handler が返す HTML。テンプレート scaffold は handler を `app/(admin)/admin/preview/route.tsx` に同梱する:
@@ -1026,26 +1026,72 @@ middleware. This is documented in each plugin's README.
1026
1026
  ## 6d. Admin editor extension wiring (Phase 7)
1027
1027
 
1028
1028
  Plugins that contribute tiptap Node extensions to the admin editor
1029
- ship a separate client-side entry under the `./editor` subpath. The
1030
- template wires it up in `_editor-bootstrap.tsx`:
1029
+ ship a separate client-side entry under the `./editor` subpath.
1030
+ `app/(admin)/admin/_editor-bootstrap.tsx` is **auto-generated** by
1031
+ `npm run update-ampless` — you should not edit it by hand.
1032
+
1033
+ ### For plugin authors
1034
+
1035
+ Declare `editorExports` in `package.json#amplessPlugin`:
1036
+
1037
+ ```jsonc
1038
+ // packages/plugin-youtube/package.json
1039
+ "amplessPlugin": {
1040
+ "apiVersion": 1,
1041
+ "name": "youtube",
1042
+ "trustLevel": "trusted",
1043
+ "capabilities": ["contentFields"],
1044
+ "editorExports": "./editor" // ← subpath where the editor module lives
1045
+ }
1046
+ ```
1047
+
1048
+ Export `editorExtension` as a named symbol from that subpath:
1049
+
1050
+ ```ts
1051
+ // packages/plugin-youtube/src/editor.tsx
1052
+ export const editorExtension = AmplessYoutubeNode // tiptap Node or Extension
1053
+ ```
1054
+
1055
+ The subpath must be declared in `package.json#exports` as well (the
1056
+ codegen validates this — a missing `exports` entry triggers a warning
1057
+ and the plugin is skipped):
1058
+
1059
+ ```jsonc
1060
+ "exports": {
1061
+ ".": { "import": "./dist/index.js", "types": "./dist/index.d.ts" },
1062
+ "./editor": { "import": "./dist/editor.js", "types": "./dist/editor.d.ts" }
1063
+ }
1064
+ ```
1065
+
1066
+ ### For plugin users (site engineers)
1067
+
1068
+ 1. `npm i @ampless/plugin-youtube@alpha` — add the plugin as a dependency.
1069
+ 2. Register it in `cms.config.ts` for the server-side renderer.
1070
+ 3. `npm run update-ampless` — regenerates `_editor-bootstrap.tsx`
1071
+ automatically from the installed plugin manifests.
1072
+
1073
+ The generated file is committed to your repo and looks like:
1031
1074
 
1032
1075
  ```tsx
1033
- // templates/_shared/app/(admin)/admin/_editor-bootstrap.tsx
1076
+ // app/(admin)/admin/_editor-bootstrap.tsx (AUTO-GENERATED — do not edit)
1034
1077
  'use client'
1078
+ // AUTO-GENERATED by `npm run update-ampless`. Do not edit — your changes
1079
+ // will be overwritten on the next run.
1035
1080
  import { installAdminEditorExtensions } from '@ampless/admin/editor'
1036
- import { youtubeEditor } from '@ampless/plugin-youtube/editor'
1037
- import { tweetEditor } from '@ampless/plugin-x-embed/editor'
1081
+ import { editorExtension as __ampless_plugin_x_embed_editor } from '@ampless/plugin-x-embed/editor'
1082
+ import { editorExtension as __ampless_plugin_youtube_editor } from '@ampless/plugin-youtube/editor'
1038
1083
 
1039
1084
  export function EditorBootstrap({ children }: { children: React.ReactNode }) {
1040
1085
  installAdminEditorExtensions([
1041
- youtubeEditor.extension,
1042
- tweetEditor.extension,
1086
+ __ampless_plugin_x_embed_editor,
1087
+ __ampless_plugin_youtube_editor,
1043
1088
  ])
1044
1089
  return <>{children}</>
1045
1090
  }
1046
1091
  ```
1047
1092
 
1048
- Then thread it into the layout:
1093
+ The file is then wired into the admin layout (already in the template — no
1094
+ extra work required):
1049
1095
 
1050
1096
  ```tsx
1051
1097
  // templates/_shared/app/(admin)/admin/layout.tsx
@@ -1058,6 +1104,19 @@ export default createAdminLayout(admin, { editorBootstrap: EditorBootstrap })
1058
1104
  inside a client component. The admin's `<TiptapEditor>` spreads the
1059
1105
  registered list onto its built-in extensions on every render.
1060
1106
 
1107
+ ### Active source and full disable
1108
+
1109
+ **The active source for editor wiring is `package.json#dependencies`**
1110
+ (= `node_modules`), not `cms.config.ts`. This means:
1111
+
1112
+ - Removing a plugin from `cms.config.ts` but keeping it in
1113
+ `package.json` leaves the editor paste rule active. The editor can
1114
+ still insert the node type into the tiptap document, but the public
1115
+ renderer won't render it (inconsistent state — avoid).
1116
+ - To fully disable a plugin's editor extension: remove it from
1117
+ `cms.config.ts` **and** run `npm uninstall @ampless/plugin-...`,
1118
+ then `npm run update-ampless` to regenerate the bootstrap file.
1119
+
1061
1120
  ### Editor preview pipeline
1062
1121
 
1063
1122
  The admin's edit / new post forms render the preview pane in an
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ampless",
3
- "version": "1.0.0-alpha.43",
3
+ "version": "1.0.0-alpha.44",
4
4
  "description": "Serverless CMS for AWS Amplify",
5
5
  "license": "MIT",
6
6
  "type": "module",