@imgly/codesign-mcp 0.3.1 → 0.3.2-canary.20260907135136.gb5be8d7

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.
Files changed (242) hide show
  1. package/README.md +52 -3
  2. package/assets/ai-plugins/apps.mjs +5 -5
  3. package/assets/ai-plugins/version.json +1 -1
  4. package/assets/docs/api/SKILL.md +131 -29
  5. package/assets/docs/api/signatures-extended.d.ts +788 -0
  6. package/assets/docs/api/signatures.d.ts +2110 -0
  7. package/assets/docs/brand/SKILL.md +67 -72
  8. package/assets/docs/brand/reference/asset-loading.md +37 -30
  9. package/assets/docs/create/SKILL.md +2 -2
  10. package/assets/docs/guide/SKILL.md +3 -3
  11. package/assets/docs/guide/animation/create.md +1 -1
  12. package/assets/docs/guide/animation/types.md +3 -3
  13. package/assets/docs/guide/api/AssetAPI.md +10 -6
  14. package/assets/docs/guide/api/BlockAPI.md +14 -4
  15. package/assets/docs/guide/api/EditorAPI.md +8 -4
  16. package/assets/docs/guide/api/SceneAPI.md +3 -0
  17. package/assets/docs/guide/api/node/classes/assetapi.md +13 -9
  18. package/assets/docs/guide/api/node/classes/blockapi.md +16 -6
  19. package/assets/docs/guide/api/node/classes/editorapi.md +10 -6
  20. package/assets/docs/guide/api/node/classes/engineactions.md +3 -3
  21. package/assets/docs/guide/api/node/classes/sceneapi.md +4 -0
  22. package/assets/docs/guide/api/node/interfaces/settings.md +1 -0
  23. package/assets/docs/guide/api/node/type-aliases/exportoptions.md +2 -0
  24. package/assets/docs/guide/api/node/type-aliases/videomimetype.md +1 -1
  25. package/assets/docs/guide/automation/overview.md +1 -1
  26. package/assets/docs/guide/colors/conversion.md +1 -1
  27. package/assets/docs/guide/colors/extract-colors.md +2 -2
  28. package/assets/docs/guide/concepts/architecture.md +2 -2
  29. package/assets/docs/guide/concepts/error-catalog.md +8 -1
  30. package/assets/docs/guide/concepts/scenes.md +1 -1
  31. package/assets/docs/guide/concepts/templating.md +1 -1
  32. package/assets/docs/guide/conversion/to-pdf.md +1 -1
  33. package/assets/docs/guide/create-audio/audio/add-music.md +2 -2
  34. package/assets/docs/guide/create-audio/audio/loop.md +1 -1
  35. package/assets/docs/guide/create-composition/add-background.md +12 -19
  36. package/assets/docs/guide/create-composition/layout.md +4 -0
  37. package/assets/docs/guide/create-composition/multi-page.md +4 -0
  38. package/assets/docs/guide/create-composition/overview.md +1 -1
  39. package/assets/docs/guide/create-composition/programmatic.md +1 -1
  40. package/assets/docs/guide/create-templates/overview.md +2 -2
  41. package/assets/docs/guide/edit-image/overview.md +1 -1
  42. package/assets/docs/guide/edit-image/remove-bg.md +2 -0
  43. package/assets/docs/guide/edit-image/transform/scale.md +2 -2
  44. package/assets/docs/guide/edit-video/add-captions.md +2 -2
  45. package/assets/docs/guide/edit-video/add-watermark.md +1 -1
  46. package/assets/docs/guide/edit-video/transform/flip.md +5 -5
  47. package/assets/docs/guide/edit-video/transform/move.md +1 -1
  48. package/assets/docs/guide/edit-video/transform/resize.md +1 -1
  49. package/assets/docs/guide/edit-video/transform/rotate.md +1 -1
  50. package/assets/docs/guide/edit-video/transform/scale.md +1 -1
  51. package/assets/docs/guide/edit-video/trim.md +1 -1
  52. package/assets/docs/guide/engine-interface.md +1 -1
  53. package/assets/docs/guide/export-save-publish/create-thumbnail.md +2 -0
  54. package/assets/docs/guide/export-save-publish/export/overview.md +2 -1
  55. package/assets/docs/guide/export-save-publish/export/partial-export.md +1 -1
  56. package/assets/docs/guide/export-save-publish/export/size-limits.md +3 -3
  57. package/assets/docs/guide/export-save-publish/export/to-pdf.md +80 -13
  58. package/assets/docs/guide/export-save-publish/export.md +1 -0
  59. package/assets/docs/guide/export-save-publish/for-social-media.md +1 -1
  60. package/assets/docs/guide/export-save-publish/thumbnail-previews.md +389 -0
  61. package/assets/docs/guide/file-format-support.md +5 -1
  62. package/assets/docs/guide/import-media/content-json-schema.md +1 -1
  63. package/assets/docs/guide/import-media/default-assets.md +5 -5
  64. package/assets/docs/guide/import-media/file-format-support.md +7 -7
  65. package/assets/docs/guide/import-media/from-remote-source/remote-asset.md +1 -1
  66. package/assets/docs/guide/insert-media/shapes-or-stickers.md +1 -1
  67. package/assets/docs/guide/insert-media/videos.md +1 -0
  68. package/assets/docs/guide/key-capabilities.md +3 -3
  69. package/assets/docs/guide/open-the-editor/from-image.md +1 -1
  70. package/assets/docs/guide/open-the-editor/from-video.md +4 -4
  71. package/assets/docs/guide/open-the-editor/import-design/from-indesign.md +2 -0
  72. package/assets/docs/guide/open-the-editor/import-design/from-photoshop.md +5 -3
  73. package/assets/docs/guide/open-the-editor/import-design.md +2 -2
  74. package/assets/docs/guide/open-the-editor/load-scene.md +5 -3
  75. package/assets/docs/guide/open-the-editor/uri-resolver.md +5 -9
  76. package/assets/docs/guide/outlines/shadows-and-glows.md +337 -79
  77. package/assets/docs/guide/performance.md +7 -1
  78. package/assets/docs/guide/plugins/print-ready-pdf.md +4 -2
  79. package/assets/docs/guide/security.md +4 -4
  80. package/assets/docs/guide/text/emojis.md +3 -3
  81. package/assets/docs/guide/text/language-support.md +3 -3
  82. package/assets/docs/guide/text/text-designs.md +1 -1
  83. package/assets/docs/guide/use-templates/programmatic.md +2 -2
  84. package/assets/docs/handbook/SKILL.md +298 -243
  85. package/assets/docs/handbook/design-rules.md +20 -93
  86. package/assets/docs/handbook/fonts.md +77 -0
  87. package/assets/docs/handbook/quirks.md +20 -19
  88. package/assets/docs/judge/SKILL.md +8 -8
  89. package/assets/docs/localize/SKILL.md +67 -86
  90. package/assets/docs/localize/reference/arabic.md +2 -2
  91. package/assets/docs/localize/reference/cjk.md +2 -2
  92. package/assets/docs/localize/reference/font-loading.md +17 -17
  93. package/assets/docs/localize/reference/language-rules.md +5 -4
  94. package/assets/docs/localize/reference/latin-expansion.md +1 -1
  95. package/assets/docs/localize/reference/vietnamese.md +1 -1
  96. package/assets/docs/onboard/SKILL.md +2 -2
  97. package/assets/docs/resize/SKILL.md +93 -76
  98. package/dist/assets/inline.generated.d.ts.map +1 -1
  99. package/dist/assets/inline.generated.js +96 -93
  100. package/dist/assets/inline.generated.js.map +1 -1
  101. package/dist/cli/release-flags.generated.d.ts +1 -0
  102. package/dist/cli/release-flags.generated.d.ts.map +1 -1
  103. package/dist/cli/release-flags.generated.js +2 -0
  104. package/dist/cli/release-flags.generated.js.map +1 -1
  105. package/dist/cli/stdio.d.ts +8 -1
  106. package/dist/cli/stdio.d.ts.map +1 -1
  107. package/dist/cli/stdio.js +9 -3
  108. package/dist/cli/stdio.js.map +1 -1
  109. package/dist/cli/trial-license.generated.d.ts +1 -1
  110. package/dist/cli/trial-license.generated.js +1 -1
  111. package/dist/cli/trial-license.generated.js.map +1 -1
  112. package/dist/codesign-prompt.d.ts +8 -0
  113. package/dist/codesign-prompt.d.ts.map +1 -0
  114. package/dist/codesign-prompt.js +84 -0
  115. package/dist/codesign-prompt.js.map +1 -0
  116. package/dist/config.d.ts +25 -0
  117. package/dist/config.d.ts.map +1 -1
  118. package/dist/config.js +29 -0
  119. package/dist/config.js.map +1 -1
  120. package/dist/design/attach.d.ts +8 -0
  121. package/dist/design/attach.d.ts.map +1 -0
  122. package/dist/design/attach.js +18 -0
  123. package/dist/design/attach.js.map +1 -0
  124. package/dist/design/capabilities.generated.d.ts +4 -0
  125. package/dist/design/capabilities.generated.d.ts.map +1 -0
  126. package/dist/design/capabilities.generated.js +241 -0
  127. package/dist/design/capabilities.generated.js.map +1 -0
  128. package/dist/design/dialect.d.ts +6 -0
  129. package/dist/design/dialect.d.ts.map +1 -0
  130. package/dist/design/dialect.js +302 -0
  131. package/dist/design/dialect.js.map +1 -0
  132. package/dist/design/doc-markers.d.ts +12 -0
  133. package/dist/design/doc-markers.d.ts.map +1 -0
  134. package/dist/design/doc-markers.js +12 -0
  135. package/dist/design/doc-markers.js.map +1 -0
  136. package/dist/design/facade.d.ts +182 -0
  137. package/dist/design/facade.d.ts.map +1 -0
  138. package/dist/design/facade.js +2652 -0
  139. package/dist/design/facade.js.map +1 -0
  140. package/dist/design/lint.d.ts +28 -0
  141. package/dist/design/lint.d.ts.map +1 -0
  142. package/dist/design/lint.js +171 -0
  143. package/dist/design/lint.js.map +1 -0
  144. package/dist/design/props.generated.d.ts +10 -0
  145. package/dist/design/props.generated.d.ts.map +1 -0
  146. package/dist/design/props.generated.js +441 -0
  147. package/dist/design/props.generated.js.map +1 -0
  148. package/dist/diagnostics/status.d.ts +15 -7
  149. package/dist/diagnostics/status.d.ts.map +1 -1
  150. package/dist/diagnostics/status.js +7 -1
  151. package/dist/diagnostics/status.js.map +1 -1
  152. package/dist/diagnostics/tool.d.ts +2 -7
  153. package/dist/diagnostics/tool.d.ts.map +1 -1
  154. package/dist/diagnostics/tool.js.map +1 -1
  155. package/dist/features.d.ts.map +1 -1
  156. package/dist/features.js +4 -2
  157. package/dist/features.js.map +1 -1
  158. package/dist/flags/channel.d.ts +3 -0
  159. package/dist/flags/channel.d.ts.map +1 -0
  160. package/dist/flags/channel.js +11 -0
  161. package/dist/flags/channel.js.map +1 -0
  162. package/dist/flags/help.d.ts +3 -0
  163. package/dist/flags/help.d.ts.map +1 -0
  164. package/dist/flags/help.js +32 -0
  165. package/dist/flags/help.js.map +1 -0
  166. package/dist/flags/manifest.d.ts +29 -0
  167. package/dist/flags/manifest.d.ts.map +1 -0
  168. package/dist/flags/manifest.js +65 -0
  169. package/dist/flags/manifest.js.map +1 -0
  170. package/dist/instructions.d.ts.map +1 -1
  171. package/dist/instructions.js +9 -7
  172. package/dist/instructions.js.map +1 -1
  173. package/dist/onboard-jobs.d.ts +2 -0
  174. package/dist/onboard-jobs.d.ts.map +1 -0
  175. package/dist/onboard-jobs.js +12 -0
  176. package/dist/onboard-jobs.js.map +1 -0
  177. package/dist/revisions/checklists.d.ts +27 -0
  178. package/dist/revisions/checklists.d.ts.map +1 -0
  179. package/dist/revisions/checklists.js +66 -0
  180. package/dist/revisions/checklists.js.map +1 -0
  181. package/dist/revisions/store.d.ts +11 -1
  182. package/dist/revisions/store.d.ts.map +1 -1
  183. package/dist/revisions/store.js +23 -0
  184. package/dist/revisions/store.js.map +1 -1
  185. package/dist/revisions/types.d.ts +25 -0
  186. package/dist/revisions/types.d.ts.map +1 -1
  187. package/dist/revisions/types.js.map +1 -1
  188. package/dist/server.d.ts.map +1 -1
  189. package/dist/server.js +18 -18
  190. package/dist/server.js.map +1 -1
  191. package/dist/skill-tool.d.ts +30 -2
  192. package/dist/skill-tool.d.ts.map +1 -1
  193. package/dist/skill-tool.js +148 -10
  194. package/dist/skill-tool.js.map +1 -1
  195. package/dist/telemetry/engine-sink.d.ts +89 -9
  196. package/dist/telemetry/engine-sink.d.ts.map +1 -1
  197. package/dist/telemetry/engine-sink.js +95 -14
  198. package/dist/telemetry/engine-sink.js.map +1 -1
  199. package/dist/tools/checklist.d.ts +7 -0
  200. package/dist/tools/checklist.d.ts.map +1 -0
  201. package/dist/tools/checklist.js +152 -0
  202. package/dist/tools/checklist.js.map +1 -0
  203. package/dist/tools/edit-render.d.ts +43 -0
  204. package/dist/tools/edit-render.d.ts.map +1 -0
  205. package/dist/tools/edit-render.js +123 -0
  206. package/dist/tools/edit-render.js.map +1 -0
  207. package/dist/tools/edit.d.ts +2 -0
  208. package/dist/tools/edit.d.ts.map +1 -1
  209. package/dist/tools/edit.js +272 -10
  210. package/dist/tools/edit.js.map +1 -1
  211. package/dist/tools/engine.d.ts +3 -2
  212. package/dist/tools/engine.d.ts.map +1 -1
  213. package/dist/tools/engine.js +27 -3
  214. package/dist/tools/engine.js.map +1 -1
  215. package/dist/tools/errors.d.ts +1 -1
  216. package/dist/tools/errors.d.ts.map +1 -1
  217. package/dist/tools/errors.js +2 -0
  218. package/dist/tools/errors.js.map +1 -1
  219. package/dist/tools/export.d.ts.map +1 -1
  220. package/dist/tools/export.js +53 -2
  221. package/dist/tools/export.js.map +1 -1
  222. package/dist/tools/index.d.ts.map +1 -1
  223. package/dist/tools/index.js +2 -0
  224. package/dist/tools/index.js.map +1 -1
  225. package/package.json +16 -19
  226. package/assets/docs/api/index.d.ts +0 -11177
  227. package/dist/create-prompt.d.ts +0 -4
  228. package/dist/create-prompt.d.ts.map +0 -1
  229. package/dist/create-prompt.js +0 -68
  230. package/dist/create-prompt.js.map +0 -1
  231. package/dist/diagnostics/prompt.d.ts +0 -3
  232. package/dist/diagnostics/prompt.d.ts.map +0 -1
  233. package/dist/diagnostics/prompt.js +0 -21
  234. package/dist/diagnostics/prompt.js.map +0 -1
  235. package/dist/onboard-prompt.d.ts +0 -10
  236. package/dist/onboard-prompt.d.ts.map +0 -1
  237. package/dist/onboard-prompt.js +0 -75
  238. package/dist/onboard-prompt.js.map +0 -1
  239. package/dist/skill-prompts.d.ts +0 -4
  240. package/dist/skill-prompts.d.ts.map +0 -1
  241. package/dist/skill-prompts.js +0 -93
  242. package/dist/skill-prompts.js.map +0 -1
package/README.md CHANGED
@@ -66,9 +66,9 @@ top-level key differ. Cursor (`.cursor/mcp.json`) and Windsurf
66
66
  sessions.
67
67
  - **An embedded handbook.** A single `skill` tool reads and searches a bundled
68
68
  catalog — handbook, API reference, guides, plus task skills for brand,
69
- localization, resizing, format conversion and design review. Each is also
70
- surfaced as an MCP prompt, so hosts expose them as slash commands (`/create`
71
- and friends).
69
+ localization, resizing, format conversion and design review. One MCP
70
+ prompt, `/codesign`, loads the whole design context in a single message
71
+ (optionally with a brief) so a session needs no reference reads.
72
72
  - **Import and export.** `import` opens Photoshop (`.psd`/`.psb`), InDesign
73
73
  (`.idml`), PowerPoint (`.pptx`), PDF, plain images and SVG as a new design;
74
74
  `export` writes PDF, print-ready PDF/X, PNG, JPEG, WebP, SVG, HTML and the
@@ -118,6 +118,55 @@ codesign-mcp --help
118
118
 
119
119
  Questions, bug reports and licensing: [img.ly/support](https://img.ly/support).
120
120
 
121
+ ## Release channels
122
+
123
+ Three npm dist-tags, from the same source:
124
+
125
+ | Channel | Install | Engine | Video |
126
+ | -------- | -------------------------------- | --------------------- | ------ |
127
+ | `latest` | `npx @imgly/codesign-mcp` | WASM | off |
128
+ | `next` | `npx @imgly/codesign-mcp@next` | WASM | off |
129
+ | `canary` | `npx @imgly/codesign-mcp@canary` | **native (required)** | **on** |
130
+
131
+ `next` is the tip of `main`, published on every push. `canary` is the **same
132
+ commit** built with the native engine and the video surface on — it exists so the
133
+ native engine gets real usage before it becomes everyone's default.
134
+
135
+ Two things to know before installing `canary`:
136
+
137
+ - It **requires** `@cesdk/node-native` and refuses to start without it, rather than
138
+ quietly falling back to WASM. A canary that silently ran WASM would tell you
139
+ nothing about the thing it exists to test.
140
+ - There is no native binary for **linux-arm64**, so `canary` cannot run there —
141
+ including Docker on Apple Silicon. Use `next` or `latest` on those hosts.
142
+
143
+ ## Environment knobs
144
+
145
+ <!-- flags:start -->
146
+
147
+ | Variable | Meaning |
148
+ | ------------------------------- | -------------------------------------------------------------------------- |
149
+ | `IMGLY_CESDK_ENGINE` | engine flavor: wasm \| native (default: wasm, or native when video is on). |
150
+ | `IMGLY_FEATURE_VIDEO` | on \| off — video export and video/audio import (default: off). |
151
+ | `IMGLY_TELEMETRY` | on \| off — usage telemetry (default: on). |
152
+ | `IMGLY_DIAGNOSTICS_FILE` | false stops local diagnostics logging (default: true). |
153
+ | `IMGLY_DIAGNOSTICS_TOOL` | false hides the diagnostics tool (default: true). |
154
+ | `IMGLY_DIAGNOSTICS_DIR` | where diagnostics logs are written (default: the platform state dir). |
155
+ | `IMGLY_GATEWAY_API_KEY` | AI gateway key; an alternative to signing in with the login tool. |
156
+ | `IMGLY_GATEWAY_BASE_URL` | AI gateway endpoint (default: IMG.LY hosted). |
157
+ | `IMGLY_AUTH_ISSUER` | override the built-in sign-in endpoints — set both together, or neither. |
158
+ | `IMGLY_AUTH_CLIENT_ID` | see IMGLY_AUTH_ISSUER. |
159
+ | `IMGLY_DEFAULT_ASSETS_BASE_URL` | manifest root for the default asset sources (default: IMG.LY CDN). |
160
+ | `IMGLY_DEMO_ASSETS_BASE_URL` | manifest root for the demo asset sources (default: IMG.LY CDN). |
161
+ | `IMGLY_GFONTS_CONTENT_URL` | Google Fonts content root (default: IMG.LY CDN). |
162
+
163
+ These are a development surface: a published build **deletes** every `IMGLY_*` /
164
+ `CESDK_*` / `CODESIGN_*` variable at startup except the licence, workspace,
165
+ engine-sizing and gateway-credential ones — see `src/cli/frozen-env.ts`. Setting
166
+ one on a released build has no effect and reports no error.
167
+
168
+ <!-- flags:end -->
169
+
121
170
  ## License and terms
122
171
 
123
172
  Use of CoDesign is governed by the