@allyhub/sdk 0.8.0 → 0.9.0

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 (438) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/NOTICE +46 -49
  3. package/dist/dom.d.ts +1 -209
  4. package/dist/dom.js +1 -1
  5. package/dist/image.d.ts +2 -0
  6. package/dist/image.js +2 -0
  7. package/dist/index.d.ts +1 -21
  8. package/dist/index.js +1 -1
  9. package/dist/media.d.ts +1 -5
  10. package/dist/media.js +1 -1
  11. package/dist/node_modules/@allyhub/audio/dist/levels.d.ts +4 -5
  12. package/dist/node_modules/@allyhub/audio/dist/levels.js +1 -1
  13. package/dist/node_modules/@allyhub/audio/dist/node/ffmpeg.d.ts +1 -6
  14. package/dist/node_modules/@allyhub/audio/dist/node/ffmpeg.js +1 -1
  15. package/dist/node_modules/@allyhub/audio/package.json +1 -1
  16. package/dist/node_modules/@allyhub/chart/dist/chart-file.js +1 -1
  17. package/dist/node_modules/@allyhub/chart/dist/chart-xml.d.ts +1 -1
  18. package/dist/node_modules/@allyhub/chart/dist/chart-xml.js +2 -2
  19. package/dist/node_modules/@allyhub/chart/dist/chart.js +1 -1
  20. package/dist/node_modules/@allyhub/chart/package.json +1 -1
  21. package/dist/node_modules/@allyhub/diagnostics/LICENSE +241 -0
  22. package/dist/node_modules/@allyhub/diagnostics/dist/fact.d.ts +37 -0
  23. package/dist/node_modules/@allyhub/diagnostics/dist/fact.js +2 -0
  24. package/dist/node_modules/@allyhub/diagnostics/dist/index.d.ts +4 -0
  25. package/dist/node_modules/@allyhub/diagnostics/dist/index.js +2 -0
  26. package/dist/node_modules/@allyhub/diagnostics/dist/problem.d.ts +43 -0
  27. package/dist/node_modules/@allyhub/diagnostics/dist/problem.js +2 -0
  28. package/dist/node_modules/@allyhub/diagnostics/dist/rules.d.ts +30 -0
  29. package/dist/node_modules/@allyhub/diagnostics/dist/rules.js +2 -0
  30. package/dist/node_modules/@allyhub/diagnostics/package.json +14 -0
  31. package/dist/node_modules/@allyhub/formats/dist/contributed.d.ts +126 -0
  32. package/dist/node_modules/@allyhub/formats/dist/contributed.js +2 -0
  33. package/dist/node_modules/@allyhub/formats/dist/data/faces.d.ts +1 -1
  34. package/dist/node_modules/@allyhub/formats/dist/data/reference.d.ts +7 -12
  35. package/dist/node_modules/@allyhub/formats/dist/data/reference.js +1 -1
  36. package/dist/node_modules/@allyhub/formats/dist/data/script.d.ts +9 -4
  37. package/dist/node_modules/@allyhub/formats/dist/data/script.js +1 -1
  38. package/dist/node_modules/@allyhub/formats/dist/data/sheet.d.ts +20 -82
  39. package/dist/node_modules/@allyhub/formats/dist/data/sheet.js +1 -1
  40. package/dist/node_modules/@allyhub/formats/dist/data/slides.d.ts +96 -8
  41. package/dist/node_modules/@allyhub/formats/dist/data/slides.js +1 -1
  42. package/dist/node_modules/@allyhub/formats/dist/data/website.d.ts +2 -1
  43. package/dist/node_modules/@allyhub/formats/dist/data/website.js +1 -1
  44. package/dist/node_modules/@allyhub/formats/dist/data/work.d.ts +42 -0
  45. package/dist/node_modules/@allyhub/formats/dist/data/work.js +2 -0
  46. package/dist/node_modules/@allyhub/formats/dist/extension.d.ts +91 -0
  47. package/dist/node_modules/@allyhub/formats/dist/extension.js +2 -0
  48. package/dist/node_modules/@allyhub/formats/dist/files.d.ts +51 -0
  49. package/dist/node_modules/@allyhub/formats/dist/files.js +2 -0
  50. package/dist/node_modules/@allyhub/formats/dist/index.d.ts +5 -1
  51. package/dist/node_modules/@allyhub/formats/dist/index.js +1 -1
  52. package/dist/node_modules/@allyhub/formats/dist/items.d.ts +226 -90
  53. package/dist/node_modules/@allyhub/formats/dist/items.js +1 -1
  54. package/dist/node_modules/@allyhub/formats/dist/layout.d.ts +7 -1
  55. package/dist/node_modules/@allyhub/formats/dist/layout.js +1 -1
  56. package/dist/node_modules/@allyhub/formats/dist/schemas.d.ts +46 -42
  57. package/dist/node_modules/@allyhub/formats/dist/schemas.js +1 -1
  58. package/dist/node_modules/@allyhub/formats/package.json +1 -1
  59. package/dist/node_modules/@allyhub/image-draw/LICENSE +241 -0
  60. package/dist/node_modules/@allyhub/image-draw/dist/context.d.ts +5 -0
  61. package/dist/node_modules/@allyhub/image-draw/dist/context.js +2 -0
  62. package/dist/node_modules/@allyhub/image-draw/dist/contrast.d.ts +13 -0
  63. package/dist/node_modules/@allyhub/image-draw/dist/contrast.js +2 -0
  64. package/dist/node_modules/@allyhub/image-draw/dist/env.d.ts +112 -0
  65. package/dist/node_modules/@allyhub/image-draw/dist/env.js +2 -0
  66. package/dist/node_modules/@allyhub/image-draw/dist/errors.d.ts +20 -0
  67. package/dist/node_modules/@allyhub/image-draw/dist/errors.js +2 -0
  68. package/dist/node_modules/@allyhub/image-draw/dist/fonts.d.ts +110 -0
  69. package/dist/node_modules/@allyhub/image-draw/dist/fonts.js +2 -0
  70. package/dist/node_modules/@allyhub/image-draw/dist/guards.d.ts +32 -0
  71. package/dist/node_modules/@allyhub/image-draw/dist/guards.js +2 -0
  72. package/dist/node_modules/@allyhub/image-draw/dist/hash.d.ts +3 -0
  73. package/dist/node_modules/@allyhub/image-draw/dist/hash.js +2 -0
  74. package/dist/node_modules/@allyhub/image-draw/dist/inspect.d.ts +113 -0
  75. package/dist/node_modules/@allyhub/image-draw/dist/inspect.js +3 -0
  76. package/dist/node_modules/@allyhub/image-draw/dist/layer-style.d.ts +151 -0
  77. package/dist/node_modules/@allyhub/image-draw/dist/layer-style.js +2 -0
  78. package/dist/node_modules/@allyhub/image-draw/dist/paint.d.ts +29 -0
  79. package/dist/node_modules/@allyhub/image-draw/dist/paint.js +2 -0
  80. package/dist/node_modules/@allyhub/image-draw/dist/pictures.d.ts +39 -0
  81. package/dist/node_modules/@allyhub/image-draw/dist/pictures.js +2 -0
  82. package/dist/node_modules/@allyhub/image-draw/dist/plan.d.ts +52 -0
  83. package/dist/node_modules/@allyhub/image-draw/dist/plan.js +2 -0
  84. package/dist/node_modules/@allyhub/image-draw/dist/reads.d.ts +145 -0
  85. package/dist/node_modules/@allyhub/image-draw/dist/reads.js +2 -0
  86. package/dist/node_modules/@allyhub/image-draw/dist/shape-path.d.ts +26 -0
  87. package/dist/node_modules/@allyhub/image-draw/dist/shape-path.js +2 -0
  88. package/dist/node_modules/@allyhub/image-draw/dist/stage.d.ts +56 -0
  89. package/dist/node_modules/@allyhub/image-draw/dist/stage.js +2 -0
  90. package/dist/node_modules/@allyhub/image-draw/dist/styles.d.ts +35 -0
  91. package/dist/node_modules/@allyhub/image-draw/dist/styles.js +2 -0
  92. package/dist/node_modules/@allyhub/image-draw/dist/tone.d.ts +53 -0
  93. package/dist/node_modules/@allyhub/image-draw/dist/tone.js +2 -0
  94. package/dist/node_modules/@allyhub/image-draw/package.json +14 -0
  95. package/dist/node_modules/@allyhub/image-measure/LICENSE +241 -0
  96. package/dist/node_modules/@allyhub/image-measure/dist/contrast.d.ts +43 -0
  97. package/dist/node_modules/@allyhub/image-measure/dist/contrast.js +2 -0
  98. package/dist/node_modules/@allyhub/image-measure/dist/layout.d.ts +186 -0
  99. package/dist/node_modules/@allyhub/image-measure/dist/layout.js +5 -0
  100. package/dist/node_modules/@allyhub/image-measure/package.json +14 -0
  101. package/dist/node_modules/@allyhub/image-sdk/LICENSE +241 -0
  102. package/dist/node_modules/@allyhub/image-sdk/dist/adjustment.d.ts +13 -0
  103. package/dist/node_modules/@allyhub/image-sdk/dist/adjustment.js +2 -0
  104. package/dist/{define.d.ts → node_modules/@allyhub/image-sdk/dist/define.d.ts} +21 -4
  105. package/dist/node_modules/@allyhub/image-sdk/dist/define.js +2 -0
  106. package/dist/node_modules/@allyhub/image-sdk/dist/dom.d.ts +210 -0
  107. package/dist/node_modules/@allyhub/image-sdk/dist/dom.js +2 -0
  108. package/dist/node_modules/@allyhub/image-sdk/dist/fill.d.ts +21 -0
  109. package/dist/node_modules/@allyhub/image-sdk/dist/fill.js +2 -0
  110. package/dist/node_modules/@allyhub/image-sdk/dist/group.d.ts +17 -0
  111. package/dist/node_modules/@allyhub/image-sdk/dist/group.js +2 -0
  112. package/dist/node_modules/@allyhub/image-sdk/dist/index.d.ts +166 -0
  113. package/dist/node_modules/@allyhub/image-sdk/dist/index.js +2 -0
  114. package/dist/node_modules/@allyhub/image-sdk/dist/media.d.ts +6 -0
  115. package/dist/node_modules/@allyhub/image-sdk/dist/media.js +2 -0
  116. package/dist/{messages.d.ts → node_modules/@allyhub/image-sdk/dist/messages.d.ts} +1 -1
  117. package/dist/node_modules/@allyhub/image-sdk/dist/picture.d.ts +59 -0
  118. package/dist/node_modules/@allyhub/image-sdk/dist/picture.js +2 -0
  119. package/dist/{props.d.ts → node_modules/@allyhub/image-sdk/dist/props.d.ts} +4 -4
  120. package/dist/node_modules/@allyhub/image-sdk/dist/shape.d.ts +34 -0
  121. package/dist/node_modules/@allyhub/image-sdk/dist/shape.js +2 -0
  122. package/dist/node_modules/@allyhub/image-sdk/dist/stack.d.ts +16 -0
  123. package/dist/node_modules/@allyhub/image-sdk/dist/stack.js +2 -0
  124. package/dist/node_modules/@allyhub/image-sdk/dist/text-layer.d.ts +38 -0
  125. package/dist/node_modules/@allyhub/image-sdk/dist/text-layer.js +2 -0
  126. package/dist/{written.js → node_modules/@allyhub/image-sdk/dist/written.js} +1 -1
  127. package/dist/node_modules/@allyhub/image-sdk/package.json +19 -0
  128. package/dist/node_modules/@allyhub/measure/LICENSE +241 -0
  129. package/dist/node_modules/@allyhub/measure/dist/compare.d.ts +195 -0
  130. package/dist/node_modules/@allyhub/measure/dist/compare.js +2 -0
  131. package/dist/node_modules/@allyhub/measure/dist/grain.d.ts +8 -0
  132. package/dist/node_modules/@allyhub/measure/dist/grain.js +2 -0
  133. package/dist/node_modules/@allyhub/measure/dist/image.d.ts +16 -0
  134. package/dist/node_modules/@allyhub/measure/dist/image.js +2 -0
  135. package/dist/node_modules/@allyhub/measure/dist/index.d.ts +4 -0
  136. package/dist/node_modules/@allyhub/measure/dist/index.js +2 -0
  137. package/dist/node_modules/@allyhub/measure/package.json +13 -0
  138. package/dist/node_modules/@allyhub/ooxml/dist/generated/presets.d.ts +4 -1
  139. package/dist/node_modules/@allyhub/ooxml/dist/generated/presets.js +1 -1
  140. package/dist/node_modules/@allyhub/ooxml/dist/geometry/index.d.ts +15 -1
  141. package/dist/node_modules/@allyhub/ooxml/dist/geometry/index.js +1 -1
  142. package/dist/node_modules/@allyhub/ooxml/package.json +1 -1
  143. package/dist/node_modules/@allyhub/piece/LICENSE +241 -0
  144. package/dist/node_modules/@allyhub/{video-core → piece}/dist/anchors.d.ts +1 -9
  145. package/dist/node_modules/@allyhub/{video-core → piece}/dist/component.js +1 -1
  146. package/dist/node_modules/@allyhub/piece/dist/context.d.ts +39 -0
  147. package/dist/node_modules/@allyhub/piece/dist/context.js +2 -0
  148. package/dist/node_modules/@allyhub/{video-core → piece}/dist/contrast.d.ts +2 -2
  149. package/dist/node_modules/@allyhub/{video-core → piece}/dist/export.d.ts +27 -10
  150. package/dist/node_modules/@allyhub/piece/dist/export.js +2 -0
  151. package/dist/node_modules/@allyhub/{video-core → piece}/dist/formats.d.ts +12 -68
  152. package/dist/node_modules/@allyhub/piece/dist/formats.js +2 -0
  153. package/dist/node_modules/@allyhub/piece/dist/gen.d.ts +104 -0
  154. package/dist/node_modules/@allyhub/piece/dist/index.d.ts +26 -0
  155. package/dist/node_modules/@allyhub/piece/dist/index.js +2 -0
  156. package/dist/node_modules/@allyhub/piece/dist/layer-style.d.ts +1558 -0
  157. package/dist/node_modules/@allyhub/piece/dist/layer-style.js +2 -0
  158. package/dist/node_modules/@allyhub/piece/dist/layer.d.ts +389 -0
  159. package/dist/node_modules/@allyhub/piece/dist/layer.js +2 -0
  160. package/dist/node_modules/@allyhub/piece/dist/layout.d.ts +421 -0
  161. package/dist/node_modules/@allyhub/piece/dist/layout.js +2 -0
  162. package/dist/node_modules/@allyhub/{video-core → piece}/dist/look.d.ts +1 -1
  163. package/dist/node_modules/@allyhub/{video-core → piece}/dist/media.d.ts +39 -9
  164. package/dist/node_modules/@allyhub/{video-core → piece}/dist/media.js +1 -1
  165. package/dist/node_modules/@allyhub/{video-core → piece}/dist/messages.d.ts +6 -0
  166. package/dist/node_modules/@allyhub/piece/dist/names.d.ts +26 -0
  167. package/dist/node_modules/@allyhub/piece/dist/names.js +2 -0
  168. package/dist/node_modules/@allyhub/piece/dist/page/console.d.ts +21 -0
  169. package/dist/node_modules/@allyhub/piece/dist/page/console.js +2 -0
  170. package/dist/node_modules/@allyhub/piece/dist/page/index.d.ts +3 -0
  171. package/dist/node_modules/@allyhub/piece/dist/page/index.js +2 -0
  172. package/dist/node_modules/@allyhub/piece/dist/page/locate.d.ts +4 -0
  173. package/dist/node_modules/@allyhub/piece/dist/page/locate.js +2 -0
  174. package/dist/node_modules/@allyhub/piece/dist/picture.d.ts +62 -0
  175. package/dist/node_modules/@allyhub/piece/dist/picture.js +2 -0
  176. package/dist/node_modules/@allyhub/piece/dist/piece.d.ts +15 -0
  177. package/dist/node_modules/@allyhub/piece/dist/piece.js +2 -0
  178. package/dist/node_modules/@allyhub/{video-core → piece}/dist/script.d.ts +9 -4
  179. package/dist/node_modules/@allyhub/piece/dist/script.js +2 -0
  180. package/dist/node_modules/@allyhub/piece/dist/source.d.ts +131 -0
  181. package/dist/node_modules/@allyhub/piece/dist/stage.d.ts +285 -0
  182. package/dist/node_modules/@allyhub/piece/dist/stage.js +2 -0
  183. package/dist/node_modules/@allyhub/piece/dist/version.d.ts +15 -0
  184. package/dist/node_modules/@allyhub/piece/dist/version.js +2 -0
  185. package/dist/node_modules/@allyhub/{video-core → piece}/dist/voice.d.ts +1 -20
  186. package/dist/node_modules/@allyhub/piece/package.json +18 -0
  187. package/dist/node_modules/@allyhub/protocol/dist/account.d.ts +139 -0
  188. package/dist/node_modules/@allyhub/protocol/dist/account.js +1 -1
  189. package/dist/node_modules/@allyhub/protocol/dist/app.d.ts +3 -10
  190. package/dist/node_modules/@allyhub/protocol/dist/app.js +1 -1
  191. package/dist/node_modules/@allyhub/protocol/dist/cli.d.ts +12 -1
  192. package/dist/node_modules/@allyhub/protocol/dist/cli.js +1 -1
  193. package/dist/node_modules/@allyhub/protocol/dist/cloud.d.ts +2 -0
  194. package/dist/node_modules/@allyhub/protocol/dist/cloud.js +1 -1
  195. package/dist/node_modules/@allyhub/protocol/dist/editor.d.ts +232 -132
  196. package/dist/node_modules/@allyhub/protocol/dist/editor.js +1 -1
  197. package/dist/node_modules/@allyhub/protocol/dist/files.d.ts +2 -0
  198. package/dist/node_modules/@allyhub/protocol/dist/files.js +1 -1
  199. package/dist/node_modules/@allyhub/protocol/dist/frame.d.ts +22 -9
  200. package/dist/node_modules/@allyhub/protocol/dist/frame.js +1 -1
  201. package/dist/node_modules/@allyhub/protocol/dist/image.d.ts +8 -0
  202. package/dist/node_modules/@allyhub/protocol/dist/image.js +2 -0
  203. package/dist/node_modules/@allyhub/protocol/dist/index.d.ts +5 -0
  204. package/dist/node_modules/@allyhub/protocol/dist/index.js +1 -1
  205. package/dist/node_modules/@allyhub/protocol/dist/jobs.d.ts +6 -6
  206. package/dist/node_modules/@allyhub/protocol/dist/kinds.d.ts +98 -0
  207. package/dist/node_modules/@allyhub/protocol/dist/kinds.js +2 -0
  208. package/dist/node_modules/@allyhub/protocol/dist/mail.d.ts +273 -0
  209. package/dist/node_modules/@allyhub/protocol/dist/mail.js +2 -0
  210. package/dist/node_modules/@allyhub/protocol/dist/notes.d.ts +26 -0
  211. package/dist/node_modules/@allyhub/protocol/dist/notes.js +1 -1
  212. package/dist/node_modules/@allyhub/protocol/dist/peer.d.ts +59 -0
  213. package/dist/node_modules/@allyhub/protocol/dist/peer.js +2 -0
  214. package/dist/node_modules/@allyhub/protocol/dist/place.d.ts +21 -0
  215. package/dist/node_modules/@allyhub/protocol/dist/place.js +2 -0
  216. package/dist/node_modules/@allyhub/protocol/dist/presence.d.ts +125 -0
  217. package/dist/node_modules/@allyhub/protocol/dist/presence.js +2 -0
  218. package/dist/node_modules/@allyhub/protocol/dist/registry.d.ts +1 -1
  219. package/dist/node_modules/@allyhub/protocol/dist/routes.js +1 -1
  220. package/dist/node_modules/@allyhub/protocol/dist/shape.d.ts +35 -0
  221. package/dist/node_modules/@allyhub/protocol/dist/shape.js +2 -0
  222. package/dist/node_modules/@allyhub/protocol/dist/shares.d.ts +2 -8
  223. package/dist/node_modules/@allyhub/protocol/dist/shares.js +1 -1
  224. package/dist/node_modules/@allyhub/protocol/dist/snapshots.d.ts +70 -40
  225. package/dist/node_modules/@allyhub/protocol/dist/snapshots.js +1 -1
  226. package/dist/node_modules/@allyhub/protocol/dist/tools.d.ts +224 -177
  227. package/dist/node_modules/@allyhub/protocol/dist/tools.js +1 -1
  228. package/dist/node_modules/@allyhub/protocol/package.json +1 -1
  229. package/dist/node_modules/@allyhub/runtimes/dist/bundled.js +1 -1
  230. package/dist/node_modules/@allyhub/runtimes/dist/declared.d.ts +14 -0
  231. package/dist/node_modules/@allyhub/runtimes/dist/declared.js +2 -0
  232. package/dist/node_modules/@allyhub/runtimes/dist/ffmpeg.d.ts +15 -0
  233. package/dist/node_modules/@allyhub/runtimes/dist/ffmpeg.js +2 -0
  234. package/dist/node_modules/@allyhub/runtimes/dist/index.d.ts +2 -0
  235. package/dist/node_modules/@allyhub/runtimes/dist/index.js +1 -1
  236. package/dist/node_modules/@allyhub/runtimes/dist/packages.js +3 -3
  237. package/dist/node_modules/@allyhub/runtimes/dist/runtimes.d.ts +1 -0
  238. package/dist/node_modules/@allyhub/runtimes/dist/runtimes.js +1 -1
  239. package/dist/node_modules/@allyhub/runtimes/manifest.json +0 -82
  240. package/dist/node_modules/@allyhub/runtimes/package.json +1 -1
  241. package/dist/node_modules/@allyhub/scenery/dist/define.d.ts +2 -0
  242. package/dist/node_modules/@allyhub/scenery/dist/define.js +1 -1
  243. package/dist/node_modules/@allyhub/scenery/package.json +1 -1
  244. package/dist/node_modules/@allyhub/sheet/dist/api/capabilities.js +1 -1
  245. package/dist/node_modules/@allyhub/sheet/dist/api/code.d.ts +4 -4
  246. package/dist/node_modules/@allyhub/sheet/dist/api/code.js +1 -1
  247. package/dist/node_modules/@allyhub/sheet/dist/api/workbook.d.ts +15 -11
  248. package/dist/node_modules/@allyhub/sheet/dist/api/workbook.js +1 -1
  249. package/dist/node_modules/@allyhub/sheet/dist/calc/server.d.ts +1 -1
  250. package/dist/node_modules/@allyhub/sheet/dist/export.js +1 -1
  251. package/dist/node_modules/@allyhub/sheet/dist/file.d.ts +5 -0
  252. package/dist/node_modules/@allyhub/sheet/dist/file.js +1 -1
  253. package/dist/node_modules/@allyhub/sheet/dist/generated.d.ts +5 -19
  254. package/dist/node_modules/@allyhub/sheet/dist/generated.js +1 -1
  255. package/dist/node_modules/@allyhub/sheet/dist/import.d.ts +3 -1
  256. package/dist/node_modules/@allyhub/sheet/dist/import.js +1 -1
  257. package/dist/node_modules/@allyhub/sheet/dist/index.d.ts +3 -4
  258. package/dist/node_modules/@allyhub/sheet/dist/index.js +1 -1
  259. package/dist/node_modules/@allyhub/sheet/dist/inspect.d.ts +76 -1
  260. package/dist/node_modules/@allyhub/sheet/dist/patch.d.ts +1 -1
  261. package/dist/node_modules/@allyhub/sheet/dist/patch.js +1 -1
  262. package/dist/node_modules/@allyhub/sheet/dist/sdk.d.ts +2 -0
  263. package/dist/node_modules/@allyhub/sheet/dist/sdk.js +2 -0
  264. package/dist/node_modules/@allyhub/sheet/dist/workbook.d.ts +6 -6
  265. package/dist/node_modules/@allyhub/sheet/dist/workbook.js +1 -1
  266. package/dist/node_modules/@allyhub/sheet/dist/xlsx/import.d.ts +2 -0
  267. package/dist/node_modules/@allyhub/sheet/dist/xlsx/import.js +1 -1
  268. package/dist/node_modules/@allyhub/sheet/package.json +5 -1
  269. package/dist/node_modules/@allyhub/slides-core/dist/animation.d.ts +23 -7
  270. package/dist/node_modules/@allyhub/slides-core/dist/animation.js +1 -1
  271. package/dist/node_modules/@allyhub/slides-core/dist/api.d.ts +44 -4
  272. package/dist/node_modules/@allyhub/slides-core/dist/api.js +2 -2
  273. package/dist/node_modules/@allyhub/slides-core/dist/capabilities.js +1 -1
  274. package/dist/node_modules/@allyhub/slides-core/dist/chart-api.d.ts +18 -1
  275. package/dist/node_modules/@allyhub/slides-core/dist/chart-api.js +1 -1
  276. package/dist/node_modules/@allyhub/slides-core/dist/code.d.ts +1 -1
  277. package/dist/node_modules/@allyhub/slides-core/dist/connect.d.ts +62 -0
  278. package/dist/node_modules/@allyhub/slides-core/dist/connect.js +2 -0
  279. package/dist/node_modules/@allyhub/slides-core/dist/fact.d.ts +208 -0
  280. package/dist/node_modules/@allyhub/slides-core/dist/fact.js +2 -0
  281. package/dist/node_modules/@allyhub/slides-core/dist/file.d.ts +4 -4
  282. package/dist/node_modules/@allyhub/slides-core/dist/file.js +2 -2
  283. package/dist/node_modules/@allyhub/slides-core/dist/index.d.ts +2 -0
  284. package/dist/node_modules/@allyhub/slides-core/dist/index.js +1 -1
  285. package/dist/node_modules/@allyhub/slides-core/dist/measure.d.ts +4 -2
  286. package/dist/node_modules/@allyhub/slides-core/dist/measure.js +1 -1
  287. package/dist/node_modules/@allyhub/slides-core/dist/merge.d.ts +5 -5
  288. package/dist/node_modules/@allyhub/slides-core/dist/merge.js +1 -1
  289. package/dist/node_modules/@allyhub/slides-core/dist/model.d.ts +19 -2
  290. package/dist/node_modules/@allyhub/slides-core/dist/office.d.ts +1 -1
  291. package/dist/node_modules/@allyhub/slides-core/dist/path.d.ts +1 -1
  292. package/dist/node_modules/@allyhub/slides-core/dist/resolve.d.ts +17 -10
  293. package/dist/node_modules/@allyhub/slides-core/dist/resolve.js +1 -1
  294. package/dist/node_modules/@allyhub/slides-core/dist/sdk.d.ts +18 -0
  295. package/dist/node_modules/@allyhub/slides-core/dist/sdk.js +2 -0
  296. package/dist/node_modules/@allyhub/slides-core/dist/stage.d.ts +28 -11
  297. package/dist/node_modules/@allyhub/slides-core/dist/units.d.ts +3 -6
  298. package/dist/node_modules/@allyhub/slides-core/dist/units.js +1 -1
  299. package/dist/node_modules/@allyhub/slides-core/package.json +5 -1
  300. package/dist/node_modules/@allyhub/video-core/dist/audio-types.d.ts +1 -2
  301. package/dist/node_modules/@allyhub/video-core/dist/captions.d.ts +1 -10
  302. package/dist/node_modules/@allyhub/video-core/dist/captions.js +1 -1
  303. package/dist/node_modules/@allyhub/video-core/dist/check.d.ts +62 -0
  304. package/dist/node_modules/@allyhub/video-core/dist/check.js +2 -0
  305. package/dist/node_modules/@allyhub/video-core/dist/cut-report.d.ts +2 -2
  306. package/dist/node_modules/@allyhub/video-core/dist/cut-report.js +1 -1
  307. package/dist/node_modules/@allyhub/video-core/dist/edits.d.ts +3 -3
  308. package/dist/node_modules/@allyhub/video-core/dist/edits.js +1 -1
  309. package/dist/node_modules/@allyhub/video-core/dist/fact.d.ts +21 -762
  310. package/dist/node_modules/@allyhub/video-core/dist/fact.js +1 -1
  311. package/dist/node_modules/@allyhub/video-core/dist/footage-motion.d.ts +3 -2
  312. package/dist/node_modules/@allyhub/video-core/dist/footage-motion.js +1 -1
  313. package/dist/node_modules/@allyhub/video-core/dist/index.d.ts +3 -17
  314. package/dist/node_modules/@allyhub/video-core/dist/index.js +1 -1
  315. package/dist/node_modules/@allyhub/video-core/dist/measure.d.ts +72 -423
  316. package/dist/node_modules/@allyhub/video-core/dist/measure.js +1 -4
  317. package/dist/node_modules/@allyhub/video-core/dist/mix-plan.d.ts +44 -0
  318. package/dist/node_modules/@allyhub/video-core/dist/mix-plan.js +2 -0
  319. package/dist/node_modules/@allyhub/video-core/dist/motion.d.ts +1 -1
  320. package/dist/node_modules/@allyhub/video-core/dist/piece.d.ts +22 -430
  321. package/dist/node_modules/@allyhub/video-core/dist/piece.js +1 -1
  322. package/dist/node_modules/@allyhub/video-core/dist/placement.d.ts +1 -1
  323. package/dist/node_modules/@allyhub/video-core/dist/schema.d.ts +6 -12
  324. package/dist/node_modules/@allyhub/video-core/dist/schema.js +1 -1
  325. package/dist/node_modules/@allyhub/video-core/dist/script-edit.d.ts +11 -6
  326. package/dist/node_modules/@allyhub/video-core/dist/script-edit.js +1 -1
  327. package/dist/node_modules/@allyhub/video-core/dist/seams.d.ts +2 -3
  328. package/dist/node_modules/@allyhub/video-core/dist/sound-under.d.ts +2 -2
  329. package/dist/node_modules/@allyhub/video-core/dist/sound-under.js +1 -1
  330. package/dist/node_modules/@allyhub/video-core/dist/speech.d.ts +2 -4
  331. package/dist/node_modules/@allyhub/video-core/dist/speech.js +2 -2
  332. package/dist/node_modules/@allyhub/video-core/dist/stage.d.ts +52 -0
  333. package/dist/node_modules/@allyhub/video-core/dist/stage.js +2 -0
  334. package/dist/node_modules/@allyhub/video-core/dist/timeline.d.ts +18 -136
  335. package/dist/node_modules/@allyhub/video-core/dist/timeline.js +1 -1
  336. package/dist/node_modules/@allyhub/video-core/dist/timing.d.ts +3 -3
  337. package/dist/node_modules/@allyhub/video-core/dist/timing.js +1 -1
  338. package/dist/node_modules/@allyhub/video-core/dist/transcript.d.ts +2 -2
  339. package/dist/node_modules/@allyhub/video-core/dist/transcript.js +1 -1
  340. package/dist/node_modules/@allyhub/video-core/package.json +1 -1
  341. package/dist/node_modules/@allyhub/video-sdk/LICENSE +241 -0
  342. package/dist/node_modules/@allyhub/video-sdk/NOTICE +118 -0
  343. package/dist/{free.d.ts → node_modules/@allyhub/video-sdk/dist/free.d.ts} +14 -10
  344. package/dist/node_modules/@allyhub/video-sdk/dist/free.js +2 -0
  345. package/dist/node_modules/@allyhub/video-sdk/dist/index.d.ts +28 -0
  346. package/dist/node_modules/@allyhub/video-sdk/dist/index.js +2 -0
  347. package/dist/{input.d.ts → node_modules/@allyhub/video-sdk/dist/input.d.ts} +76 -22
  348. package/dist/node_modules/@allyhub/video-sdk/dist/input.js +2 -0
  349. package/dist/{module.d.ts → node_modules/@allyhub/video-sdk/dist/module.d.ts} +6 -4
  350. package/dist/node_modules/@allyhub/video-sdk/dist/module.js +2 -0
  351. package/dist/{parts.d.ts → node_modules/@allyhub/video-sdk/dist/parts.d.ts} +15 -6
  352. package/dist/node_modules/@allyhub/video-sdk/dist/parts.js +2 -0
  353. package/dist/{piece.d.ts → node_modules/@allyhub/video-sdk/dist/piece.d.ts} +26 -16
  354. package/dist/node_modules/@allyhub/video-sdk/dist/piece.js +2 -0
  355. package/dist/node_modules/@allyhub/video-sdk/dist/route.d.ts +46 -0
  356. package/dist/node_modules/@allyhub/video-sdk/dist/route.js +2 -0
  357. package/dist/node_modules/@allyhub/video-sdk/dist/scenery.d.ts +2 -0
  358. package/dist/node_modules/@allyhub/video-sdk/dist/scenery.js +2 -0
  359. package/dist/node_modules/@allyhub/video-sdk/package.json +19 -0
  360. package/dist/scenery.d.ts +1 -1
  361. package/dist/scenery.js +1 -1
  362. package/dist/sheets.d.ts +1 -1
  363. package/dist/sheets.js +1 -1
  364. package/dist/slides.d.ts +1 -9
  365. package/dist/slides.js +1 -1
  366. package/docs/README.md +8 -6
  367. package/docs/batches.md +5 -5
  368. package/docs/contract.md +2 -2
  369. package/docs/defaults.md +278 -20
  370. package/docs/docs.md +77 -63
  371. package/docs/footage.md +7 -7
  372. package/docs/image.md +165 -0
  373. package/docs/layers.md +22 -13
  374. package/docs/modeling.md +4 -4
  375. package/docs/pictures.md +65 -0
  376. package/docs/project.md +51 -31
  377. package/docs/scenery.md +11 -11
  378. package/docs/sheets.md +26 -25
  379. package/docs/slides.md +73 -65
  380. package/docs/sound.md +3 -3
  381. package/docs/speech.md +8 -8
  382. package/docs/video.md +16 -13
  383. package/docs/websites.md +4 -4
  384. package/package.json +7 -2
  385. package/dist/define.js +0 -2
  386. package/dist/free.js +0 -2
  387. package/dist/input.js +0 -2
  388. package/dist/module.js +0 -2
  389. package/dist/node_modules/@allyhub/formats/dist/data/comments.d.ts +0 -94
  390. package/dist/node_modules/@allyhub/formats/dist/data/comments.js +0 -2
  391. package/dist/node_modules/@allyhub/runtimes/pins/onnxruntime-node/package-lock.json +0 -227
  392. package/dist/node_modules/@allyhub/runtimes/pins/onnxruntime-node/package.json +0 -8
  393. package/dist/node_modules/@allyhub/runtimes/pins/sherpa-onnx-node/package-lock.json +0 -105
  394. package/dist/node_modules/@allyhub/runtimes/pins/sherpa-onnx-node/package.json +0 -8
  395. package/dist/node_modules/@allyhub/runtimes/pins/tesseract.js/package-lock.json +0 -128
  396. package/dist/node_modules/@allyhub/runtimes/pins/tesseract.js/package.json +0 -9
  397. package/dist/node_modules/@allyhub/video-core/dist/export.js +0 -2
  398. package/dist/node_modules/@allyhub/video-core/dist/formats.js +0 -2
  399. package/dist/node_modules/@allyhub/video-core/dist/gen.d.ts +0 -37
  400. package/dist/node_modules/@allyhub/video-core/dist/problem.d.ts +0 -278
  401. package/dist/node_modules/@allyhub/video-core/dist/problem.js +0 -2
  402. package/dist/node_modules/@allyhub/video-core/dist/script.js +0 -2
  403. package/dist/node_modules/@allyhub/video-core/dist/source.d.ts +0 -7
  404. package/dist/parts.js +0 -2
  405. package/dist/piece.js +0 -2
  406. /package/dist/node_modules/@allyhub/{sheet → formats}/dist/csv.d.ts +0 -0
  407. /package/dist/node_modules/@allyhub/{sheet → formats}/dist/csv.js +0 -0
  408. /package/dist/{fit.d.ts → node_modules/@allyhub/image-sdk/dist/fit.d.ts} +0 -0
  409. /package/dist/{fit.js → node_modules/@allyhub/image-sdk/dist/fit.js} +0 -0
  410. /package/dist/{messages.js → node_modules/@allyhub/image-sdk/dist/messages.js} +0 -0
  411. /package/dist/{props.js → node_modules/@allyhub/image-sdk/dist/props.js} +0 -0
  412. /package/dist/{text.d.ts → node_modules/@allyhub/image-sdk/dist/text.d.ts} +0 -0
  413. /package/dist/{text.js → node_modules/@allyhub/image-sdk/dist/text.js} +0 -0
  414. /package/dist/{written.d.ts → node_modules/@allyhub/image-sdk/dist/written.d.ts} +0 -0
  415. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/anchors.js +0 -0
  416. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/component.d.ts +0 -0
  417. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/console.d.ts +0 -0
  418. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/console.js +0 -0
  419. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/contrast.js +0 -0
  420. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/gen.js +0 -0
  421. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/look.js +0 -0
  422. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/marks.d.ts +0 -0
  423. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/marks.js +0 -0
  424. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/matrix.d.ts +0 -0
  425. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/matrix.js +0 -0
  426. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/messages.js +0 -0
  427. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/source.js +0 -0
  428. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/voice.js +0 -0
  429. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/words.d.ts +0 -0
  430. /package/dist/node_modules/@allyhub/{video-core → piece}/dist/words.js +0 -0
  431. /package/dist/{anim.d.ts → node_modules/@allyhub/video-sdk/dist/anim.d.ts} +0 -0
  432. /package/dist/{anim.js → node_modules/@allyhub/video-sdk/dist/anim.js} +0 -0
  433. /package/dist/{noise.d.ts → node_modules/@allyhub/video-sdk/dist/noise.d.ts} +0 -0
  434. /package/dist/{noise.js → node_modules/@allyhub/video-sdk/dist/noise.js} +0 -0
  435. /package/dist/{paths.d.ts → node_modules/@allyhub/video-sdk/dist/paths.d.ts} +0 -0
  436. /package/dist/{paths.js → node_modules/@allyhub/video-sdk/dist/paths.js} +0 -0
  437. /package/dist/{phone.d.ts → node_modules/@allyhub/video-sdk/dist/phone.d.ts} +0 -0
  438. /package/dist/{phone.js → node_modules/@allyhub/video-sdk/dist/phone.js} +0 -0
package/docs/slides.md CHANGED
@@ -1,14 +1,16 @@
1
1
  # Slides
2
2
 
3
- A deck is PowerPoint's model, made by code with python-pptx's API. An item whose entry is `slides.ts` holds:
3
+ A deck is PowerPoint's model, made by code with python-pptx's API: a module listed in `allyhub.yaml` as `kind: slides` ([project.md](project.md#items)), and the two files it names in `presentation({ slides, script })`, each from the module's folder:
4
4
 
5
- - `slides.ts`: the presentation's slide masters, layouts and placeholders, components and generators.
6
- - `slides.yaml`: the slides in order, each on a layout, and what a person (or you) placed or changed on a slide. A value there overrides the layout's, as a placeholder moved on a slide does in PowerPoint.
7
- - `script.<locale>.yaml`: each slide's words, by shape name, and its speaker notes, a file per language.
5
+ - its module (`deck.ts`): the presentation's slide masters, layouts and placeholders, components and generators.
6
+ - its slides file (`slides: "./deck.yaml"`): the slides in order, each on a layout, and what a person (or you) placed or changed on a slide. A value there overrides the layout's, as a placeholder moved on a slide does in PowerPoint.
7
+ - its script (`script: "./deck.{locale}.yaml"`): each slide's words, by shape name, and its speaker notes, a file per language: `{locale}` once in the file's name stands for each (`deck.en.yaml`, `deck.zh-cn.yaml`).
8
+
9
+ A deck that names no slides file or no script is AK-M011. Two decks in one folder share a file only when both name it.
8
10
 
9
11
  The API is python-pptx 1.0.2's, by its names and behaviour; its documentation (python-pptx.readthedocs.io) is the reference. `allyhub slides capabilities` lists which of its classes, names and enumerations are held, where they differ, and what is added. A name that is not held throws where it is written, naming what its class holds. This page is what is AllyHub's own.
10
12
 
11
- ```ts file=launch/deck/slides.ts
13
+ ```ts file=launch/deck/deck.ts
12
14
  import {
13
15
  Inches,
14
16
  MSO_ANCHOR,
@@ -17,51 +19,54 @@ import {
17
19
  presentation,
18
20
  } from "@allyhub/sdk/slides";
19
21
 
20
- export default presentation({ size: "16:9" }, (prs) => {
21
- prs.theme.colors = { accent1: "#2F5BEA" };
22
- const master = prs.slide_masters.add("Brand");
23
- const title = master.placeholders.add(
24
- PP_PLACEHOLDER.TITLE,
25
- Inches(0.6),
26
- Inches(0.4),
27
- Inches(12),
28
- Inches(1.2),
29
- );
30
- title.text_frame.vertical_anchor = MSO_ANCHOR.MIDDLE;
31
- title.text_frame.list_style[0].font.size = Pt(40);
32
- master.placeholders.add(
33
- PP_PLACEHOLDER.BODY,
34
- Inches(0.6),
35
- Inches(1.8),
36
- Inches(12),
37
- Inches(5),
38
- );
39
- master.shapes.add_picture(
40
- "../../../assets/media/logo.png",
41
- Inches(12.2),
42
- Inches(6.9),
43
- Inches(0.9),
44
- Inches(0.4),
45
- ).name = "logo";
46
-
47
- const cover = master.slide_layouts.add("Title Slide");
48
- cover.placeholders.add(
49
- PP_PLACEHOLDER.CENTER_TITLE,
50
- Inches(1),
51
- Inches(2.5),
52
- Inches(11.3),
53
- Inches(1.5),
54
- );
55
- cover.placeholders.add(PP_PLACEHOLDER.SUBTITLE);
56
-
57
- const content = master.slide_layouts.add("Title and Content");
58
- content.placeholders.add(PP_PLACEHOLDER.TITLE);
59
- content.placeholders.add(PP_PLACEHOLDER.BODY);
60
- });
22
+ export default presentation(
23
+ { slides: "./deck.yaml", script: "./deck.{locale}.yaml", size: "16:9" },
24
+ (prs) => {
25
+ prs.theme.colors = { accent1: "#2F5BEA" };
26
+ const master = prs.slide_masters.add("Brand");
27
+ const title = master.placeholders.add(
28
+ PP_PLACEHOLDER.TITLE,
29
+ Inches(0.6),
30
+ Inches(0.4),
31
+ Inches(12),
32
+ Inches(1.2),
33
+ );
34
+ title.text_frame.vertical_anchor = MSO_ANCHOR.MIDDLE;
35
+ title.text_frame.list_style[0].font.size = Pt(40);
36
+ master.placeholders.add(
37
+ PP_PLACEHOLDER.BODY,
38
+ Inches(0.6),
39
+ Inches(1.8),
40
+ Inches(12),
41
+ Inches(5),
42
+ );
43
+ master.shapes.add_picture(
44
+ "../../../assets/media/logo.png",
45
+ Inches(12.2),
46
+ Inches(6.9),
47
+ Inches(0.9),
48
+ Inches(0.4),
49
+ ).name = "logo";
50
+
51
+ const cover = master.slide_layouts.add("Title Slide");
52
+ cover.placeholders.add(
53
+ PP_PLACEHOLDER.CENTER_TITLE,
54
+ Inches(1),
55
+ Inches(2.5),
56
+ Inches(11.3),
57
+ Inches(1.5),
58
+ );
59
+ cover.placeholders.add(PP_PLACEHOLDER.SUBTITLE);
60
+
61
+ const content = master.slide_layouts.add("Title and Content");
62
+ content.placeholders.add(PP_PLACEHOLDER.TITLE);
63
+ content.placeholders.add(PP_PLACEHOLDER.BODY);
64
+ },
65
+ );
61
66
  ```
62
67
 
63
68
  ```yaml
64
- # launch/deck/slides.yaml
69
+ # launch/deck/deck.yaml
65
70
  slides:
66
71
  - id: cover
67
72
  layout: Title Slide
@@ -74,7 +79,7 @@ slides:
74
79
  ```
75
80
 
76
81
  ```yaml
77
- # launch/deck/script.en.yaml
82
+ # launch/deck/deck.en.yaml
78
83
  title: Launch deck
79
84
  slides:
80
85
  - id: cover
@@ -88,11 +93,13 @@ slides:
88
93
 
89
94
  ## `presentation()`
90
95
 
91
- `presentation(options, (prs) => { … })` is the default export of an item's `slides.ts`; its function is given python-pptx's `Presentation` and makes the deck's masters, layouts, components and generators. Paths are from the module's folder; lengths are EMU (`Inches`, `Pt`, `Cm`, `Mm`, `Emu`), each python-pptx's Length: a number that also says itself in `.emu`, `.inches`, `.cm`, `.mm`, `.pt`, `.centipoints` and `.twips`, as what a length reads does (`shape.width.inches`). Arithmetic on Lengths gives a plain number; two Lengths of one value are `===`, and one is compared with a plain number by its `.emu`.
96
+ `presentation(options, (prs) => { … })` is the default export of a deck's module; its function is given python-pptx's `Presentation` and makes the deck's masters, layouts, components and generators. Paths are from the module's folder; lengths are EMU (`Inches`, `Pt`, `Cm`, `Mm`, `Emu`), each python-pptx's Length: a number that also says itself in `.emu`, `.inches`, `.cm`, `.mm`, `.pt`, `.centipoints` and `.twips`, as what a length reads does (`shape.width.inches`). Arithmetic on Lengths gives a plain number; two Lengths of one value are `===`, and one is compared with a plain number by its `.emu`.
92
97
 
93
98
  | Option | Default | What it is |
94
99
  | ------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
95
- | `size` | `"16:9"` | A slide size by name (`16:9`, `16:10`, `4:3` as PowerPoint's; `a4`, `a4-portrait`, `letter`, `letter-portrait` the paper's own; `1:1`, `4:5`, `9:16`) or `{ width, height }` in EMU |
100
+ | `slides` | none | Its slides file (YAML), from the module's folder: the slides in order and what was placed or changed on each. Paths in it are from the module's folder too |
101
+ | `script` | none | Its script, from the module's folder, with `{locale}` once in its name for each language (`./deck.{locale}.yaml`) |
102
+ | `size` | `"16:9"` | A slide size by name (`16:9`, `16:10`, `4:3` as PowerPoint's; `a4`, `a4-portrait`, `letter`, `letter-portrait` the paper's own; a carousel is an image, [image.md](image.md)) or `{ width, height }` in EMU |
96
103
  | `title` | none | Its name for people, what lists show it by |
97
104
  | `theme` | the project's look's colours, standard fonts | `{ colors, fonts }`: theme colours by PresentationML's names (`dk1`, `lt1`, `dk2`, `lt2`, `accent1`…`accent6`, `hlink`, `folHlink`), over the project's look (`dk1` its foreground, `lt1` its background, `accent1` its accent); fonts (`major`, `minor`, `major_east_asian`, `minor_east_asian`, and `code`, Courier New unless set, which the script's `` `code` `` is set in: PowerPoint's theme has no such font, so in the file it is a run's own), Arial and Microsoft YaHei unless set: fonts every PowerPoint, Keynote and Google Slides has, drawn here by fonts of the same metrics (Arimo, Noto Sans SC), so a line breaks in the file where it breaks here. Any other font the config's `fonts` lists goes in the PowerPoint file, a face each for regular, bold, italic and bold italic, unless its own licence bits (`fsType`) forbid it or it is a variable font; `allyhub render` says what did not go in. An app that does not read a file's fonts replaces them, and its lines may break elsewhere. A font named with no file the stage has is AK-L006 |
98
105
 
@@ -101,21 +108,21 @@ slides:
101
108
  python-pptx opens these from a template; here code makes them.
102
109
 
103
110
  - `prs.slide_masters.add(name)`: a master, with PowerPoint's Office text styles (`master.text_styles.title_style`, `body_style`, `other_style`, nine levels each) and no placeholders yet.
104
- - `master.slide_layouts.add(name)`: a layout; its name is what `slides.yaml`'s slides name, unique in the deck.
105
- - `placeholders.add(PP_PLACEHOLDER.X, left, top, width, height, { name })` on a master or a layout. A layout's placeholder given no frame takes its master's of its base type, as python-pptx reads it (a centre title the title's, a subtitle, picture, media or object the body's). Its name is its type's (`title`, `subtitle`, `body`, `picture`, `content`…) unless given: `slides.yaml` and the script name it. Its idx is PowerPoint's: a title 0, a date, footer and slide number 10, 11 and 12, the rest from 1.
106
- - Beyond python-pptx's `add_shape` and `add_connector` (`MSO_CONNECTOR.STRAIGHT`, `ELBOW`, `CURVE`, or a connector's preset by name, `straightConnector1`, `bentConnector2` to `5`, `curvedConnector2` to `5`; an elbow's middle is its `adjustments[0]`), `shapes.build_freeform()` draws an outline (`add_line_segments`, `move_to`, `convert_to_shape`, and `add_curve_segment`, a cubic curve python-pptx lacks); `line.dash_style` takes `MSO_LINE`, and `line.begin_arrow` and `end_arrow` take `MSO_ARROWHEAD`; `shapes.add_group_shape()` groups what is added to its `.shapes`, and a group is its shapes, listed and drawn as they are, holding no group; `shapes.add_table(rows, cols, left, top, width, height).table` has `cell(r, c)` with `text`, `text_frame`, `fill`, `borders` (`{ bottom: { color, width } }`), `merge`, margins and `vertical_anchor`. `layout.display_master_shapes = false` hides its master's shapes.
111
+ - `master.slide_layouts.add(name)`: a layout; its name is what the slides file's slides name, unique in the deck.
112
+ - `placeholders.add(PP_PLACEHOLDER.X, left, top, width, height, { name })` on a master or a layout. A layout's placeholder given no frame takes its master's of its base type, as python-pptx reads it (a centre title the title's, a subtitle, picture, media or object the body's). Its name is its type's (`title`, `subtitle`, `body`, `picture`, `content`…) unless given: the slides file and the script name it. Its idx is PowerPoint's: a title 0, a date, footer and slide number 10, 11 and 12, the rest from 1.
113
+ - Beyond python-pptx's `add_shape` and `add_connector` (`MSO_CONNECTOR.STRAIGHT`, `ELBOW`, `CURVE`, or a connector's preset by name, `straightConnector1`, `bentConnector2` to `5`, `curvedConnector2` to `5`; an elbow's middle is its `adjustments[0]`; `begin_connect(shape, site)` and `end_connect` glue its ends to a shape of the same slide, layout or master, at a site of the shape's geometry, a rectangle's 0 top, 1 left, 2 bottom, 3 right, and its ends then follow the shape; `begin_x`, `begin_y`, `end_x` and `end_y` read and move them), `shapes.build_freeform()` draws an outline (`add_line_segments`, `move_to`, `convert_to_shape`, and `add_curve_segment`, a cubic curve python-pptx lacks); `line.dash_style` takes `MSO_LINE`, and `line.begin_arrow` and `end_arrow` take `MSO_ARROWHEAD`; `shapes.add_group_shape()` groups what is added to its `.shapes`, and a group is its shapes, listed and drawn as they are, holding no group; `shapes.add_table(rows, cols, left, top, width, height).table` has `cell(r, c)` with `text`, `text_frame`, `fill`, `borders` (`{ bottom: { color, width } }`), `merge`, margins and `vertical_anchor`. `layout.display_master_shapes = false` hides its master's shapes.
107
114
  - A placeholder shrinks its text to fit its frame unless told not to (`MSO_AUTO_SIZE.TEXT_TO_FIT_SHAPE`, as PowerPoint's Office master's do; `text_frame.auto_size = MSO_AUTO_SIZE.NONE` keeps its sizes), and the type in use shows what it shrank to. A text box `add_textbox` makes does not wrap and grows to its text, as python-pptx's; a shape `add_shape` makes starts with one centred paragraph, and `text_frame.text` replaces it with paragraphs aligned as the text style says (left), as python-pptx's.
108
115
  - A text style is a list style's level, `ListLevel`: `alignment`, `line_spacing`, `space_before`, `space_after`, `font` (with `font.spacing`, the space between letters, a length, negative to tighten, which python-pptx has no name for), `bullet` (a character, or `null` for none), `bullet_font`, `margin_left`, `indent`. No bullet keeps the level's `margin_left` and `indent`, as PowerPoint's `a:buNone` does: Office's body levels hang their wrapped lines a quarter inch in, so text with no bullets sets both to `0` to stand flush. A placeholder's `text_frame.list_style[n]` is what the text a slide gives it takes at level n, over its master's placeholder and its master's text style for its type.
109
116
 
110
117
  ## Components
111
118
 
112
- `prs.components.add(name, { props, layers })` is a shape drawn by code: `layers(props, { width, height, slide })` returns layers of the layer contract ([layers.md](layers.md): `custom()`, a component), laid out in the shape's frame; `width` and `height` are the frame's size in the slide's pixels (a 16:9 slide is drawn 1920 × 1080, 2 px a point). Its `render(t)` is given seconds into the slide; a still of the slide is drawn when what moves has settled. Its colours and fonts follow the deck's theme by the CSS variables the slide sets: `var(--ak-theme-<colour>)` for each theme colour (`--ak-theme-dk1`, `--ak-theme-lt1`, `--ak-theme-accent1`…`--ak-theme-folHlink`), `var(--ak-theme-major)` and `var(--ak-theme-minor)` for its fonts (`--ak-theme-major-ea`, `--ak-theme-minor-ea` for East Asian text). The look's `var(--ak-color-*)` and `var(--ak-font-*)` are the project's, which the theme starts from but does not follow once `prs.theme` sets its own. `props` lists the props a person may change in the editor, by the prop types (`text()`, `number()`…); `slides.yaml` places it as `{ component: name, props, frame }`, or code with `shapes.add_component(name, left, top, width, height, props)`. `add` also takes what `defineComponent` makes ([layers.md](layers.md#layers-in-a-frame)). A shape may name a component by its module instead, without registering it: `component: ../../components/ui.ts#ShareDialog` (its path from the deck's folder and its export; `#default` may be left out). A component shape's props are fields in the editor's Format inspector, a field per prop type; what a person types is written to `props` in `slides.yaml` as its type (a number, a list).
119
+ `prs.components.add(name, { props, layers })` is a shape drawn by code: `layers(props, { width, height, slide })` returns layers of the layer contract ([layers.md](layers.md): `custom()`, a component), laid out in the shape's frame; `width` and `height` are the frame's size in the slide's pixels (a 16:9 slide is drawn 1920 × 1080, 2 px a point). Its `render(t)` is given seconds into the slide; a still of the slide is drawn when what moves has settled. Its colours and fonts follow the deck's theme by the CSS variables the slide sets: `var(--ak-theme-<colour>)` for each theme colour (`--ak-theme-dk1`, `--ak-theme-lt1`, `--ak-theme-accent1`…`--ak-theme-folHlink`), `var(--ak-theme-major)` and `var(--ak-theme-minor)` for its fonts (`--ak-theme-major-ea`, `--ak-theme-minor-ea` for East Asian text). The look's `var(--ak-color-*)` and `var(--ak-font-*)` are the project's, which the theme starts from but does not follow once `prs.theme` sets its own. `props` lists the props a person may change in the editor, by the prop types (`text()`, `number()`…); the slides file places it as `{ component: name, props, frame }`, or code with `shapes.add_component(name, left, top, width, height, props)`. It moves for 4 seconds from when it comes on (`SLIDE_SECONDS`) unless its `dur` says how long, in seconds (`{ component: name, dur: 15 }`, or `add_component`'s last argument, `{ dur: 15 }`): its step rests no sooner, its still is drawn once it has, and a PowerPoint file's video of it is that long. `add` also takes what `defineComponent` makes ([layers.md](layers.md#layers-in-a-frame)). A shape may name a component by its module instead, without registering it: `component: ../../components/ui.ts#ShareDialog` (its path from the module's folder and its export; `#default` may be left out). A component shape's props are fields in the editor's Format inspector, a field per prop type; what a person types is written to `props` in the slides file as its type (a number, a list).
113
120
 
114
121
  ## Generators
115
122
 
116
- `prs.generators.add(name, (g) => { … })` makes slides from data: `g.data(path)` reads a data file (CSV rows, YAML, JSON) from the deck's folder; `g.slides.add_slide(layout, id)` adds a slide on a layout (an object, or a name) with its id in the block, and the slide is python-pptx's (`shapes.title`, `placeholders[idx]`, `shapes.add_*`, `notes_slide.notes_text_frame.text`). A generated slide's words are its code's (from its data), not the script's. `slides.yaml` places the block as `- id: stories, generate: name`; its slide is `stories/<id>`, hidden by `hidden: [<id>]`, and a shape on it is changed as `shapes: { <id>/<shape>: … }`.
123
+ `prs.generators.add(name, (g) => { … })` makes slides from data: `g.data(path)` reads a data file (CSV rows, YAML, JSON) from the module's folder; `g.slides.add_slide(layout, id)` adds a slide on a layout (an object, or a name) with its id in the block, and the slide is python-pptx's (`shapes.title`, `placeholders[idx]`, `shapes.add_*`, `notes_slide.notes_text_frame.text`). A generated slide's words are its code's (from its data), not the script's. The slides file places the block as `- id: stories, generate: name`; its slide is `stories/<id>`, hidden by `hidden: [<id>]`, and a shape on it is changed as `shapes: { <id>/<shape>: … }`.
117
124
 
118
- ## slides.yaml
125
+ ## The slides file
119
126
 
120
127
  | Field | What it is |
121
128
  | ------------------- | ------------------------------------------------------------------------------------ |
@@ -126,7 +133,7 @@ python-pptx opens these from a template; here code makes them.
126
133
  | `slides[].shapes` | Its shapes by name: what it changes of its layout's placeholders, and its own |
127
134
  | `slides[].background` | Its own background over its layout's: one of `fill` (a colour), `gradient` (as a shape's) or `picture` (a file, stretched over the slide) |
128
135
 
129
- A shape there changes a placeholder of the slide's layout (or a generated shape) with `frame` (`{ x, y, w, h }` in points), `text` (on all of its text, every level, as PowerPoint sets a selected shape's: `size` in points, `bold`, `italic`, `underline`, `strike`, `color`, `font`, a family, `align`: `l`, `ctr`, `r`, `just`, `line_spacing`, a multiple of single spacing, `1.5`, `space_before` and `space_after` in points, `anchor`, where the text stands in its shape: `t`, `ctr`, `b`, `bullet`, a character, `"•"`, or `false` for none, `numbered`, its paragraphs counted in place of a bullet: `arabicPeriod`, `arabicParenR`, `alphaLcPeriod`, `alphaUcPeriod`, `romanLcPeriod`, `romanUcPeriod`; given both, `numbered` stands; a bullet or a number in text with no indent hangs as PowerPoint's does), `fill` (a colour, or `none`), `fill_transparency` (a share that shows through), `gradient` (`angle`, degrees clockwise from left to right, and `stops`, each `at`, a share of the way, `color` and `transparency`), `shadow` (`blur` and `distance` in points, `angle`, `color`, `transparency`), `line` (its outline: a colour, or `none`), `line_width` in points, `line_dash` (`solid`, `sysDash`, `sysDot`, `dash`, `dashDot`, `lgDash`, `lgDashDot`, `lgDashDotDot`), `line_begin` and `line_end` (`none`, `triangle`, `arrow`, `stealth`, `diamond`, `oval`), `rotation` (degrees clockwise about its centre, 0 up to 360, python-pptx's `rotation`), `flip_h` and `flip_v` (`true`: mirrored left to right, top to bottom; a line runs from its frame's other corner; its text reads as it is), `z`; or is the slide's own with one of `textbox: true` (its words are the script's; it wraps and grows to its text), `picture`, `movie` (a file, or a video item's folder), `geometry` (any of PowerPoint's 187 preset shapes by its `prst` name, ECMA-376's `ST_ShapeType`: `rect`, `roundRect`, `ellipse`, `triangle`, `star5`, `chevron`, `rightArrow`, `wedgeRectCallout`, `heart`, `cloud`, `donut`, `flowChartProcess`…, drawn from ECMA-376's preset shape definitions as PowerPoint draws them; a connector, `line`, `straightConnector1`, `bentConnector2` to `5` or `curvedConnector2` to `5`, has the connector's line, no fill and no text, and its `line_begin` and `line_end` face along its path; with `adjustments`, its handles' values in the definition's order as python-pptx's `adjustments` has them, a share each: `roundRect`'s `[0.1]` is a corner of a tenth of its shorter side), `path` (a freeform: `{ w, h, d }`, its outline in a box of `w` × `h` units stretched to its frame, `d` in SVG's `M`, `L`, `C` and `Z`, absolute, so a logo or a cursor is a real shape), `table` (`columns`, widths in points, and `rows`, each a `height` with its `fill`, `text` and `line`, a rule at its foot; stretched to its frame, its words the script's, a list of rows, each a list of cells) or `component` (with `props`), and a `frame`. `group`, a name a slide's own shapes share, makes them one group in PowerPoint, standing together where the topmost of them stands. A table here has no style of its own, unlike python-pptx's: its look is what its rows and cells say. A picture or a movie put in a picture, media or object placeholder fills it. Colours are the theme's (`accent1`…); the theme's lighter or darker, in PowerPoint's words (`accent1 lighter 40%`, `dk1 darker 25%`, a share over 0 up to 100 %), which follows a change of theme as PowerPoint's picker's tints and shades do; or `#RRGGBB`. In code a colour (`ColorFormat`) has python-pptx's `brightness`, -1 to 1 (`0.4` is lighter 40 %), on a theme colour only. `z` orders a shape among the slide's shapes and placeholders, so a negative `z` puts one under a placeholder's words. Paths are from the deck's folder.
136
+ A shape there changes a placeholder of the slide's layout (or a generated shape) with `frame` (`{ x, y, w, h }` in points), `text` (on all of its text, every level, as PowerPoint sets a selected shape's: `size` in points, `bold`, `italic`, `underline`, `strike`, `color`, `font`, a family, `align`: `l`, `ctr`, `r`, `just`, `line_spacing`, a multiple of single spacing, `1.5`, `space_before` and `space_after` in points, `anchor`, where the text stands in its shape: `t`, `ctr`, `b`, `bullet`, a character, `"•"`, or `false` for none, `numbered`, its paragraphs counted in place of a bullet: `arabicPeriod`, `arabicParenR`, `alphaLcPeriod`, `alphaUcPeriod`, `romanLcPeriod`, `romanUcPeriod`; given both, `numbered` stands; a bullet or a number in text with no indent hangs as PowerPoint's does), `fill` (a colour, or `none`), `fill_transparency` (a share that shows through), `gradient` (`angle`, degrees clockwise from left to right, and `stops`, each `at`, a share of the way, `color` and `transparency`), `shadow` (`blur` and `distance` in points, `angle`, `color`, `transparency`), `line` (its outline: a colour, or `none`), `line_width` in points, `line_dash` (`solid`, `sysDash`, `sysDot`, `dash`, `dashDot`, `lgDash`, `lgDashDot`, `lgDashDotDot`), `line_begin` and `line_end` (`none`, `triangle`, `arrow`, `stealth`, `diamond`, `oval`), `rotation` (degrees clockwise about its centre, 0 up to 360, python-pptx's `rotation`), `flip_h` and `flip_v` (`true`: mirrored left to right, top to bottom; a line runs from its frame's other corner; its text reads as it is), `crop` (a picture's: `left`, `top`, `right` and `bottom`, the share of it cut from each side, PowerPoint's `a:srcRect`; a negative share is space left beside it; the editor's Crop menu writes Fill and Fit, [pictures.md](pictures.md#a-decks-pictures)), `z`; or is the slide's own with one of `textbox: true` (its words are the script's; it wraps and grows to its text), `picture`, `movie` (a video file of the project; a video item goes on a slide as its render, `allyhub render`), `geometry` (any of PowerPoint's 187 preset shapes by its `prst` name, ECMA-376's `ST_ShapeType`: `rect`, `roundRect`, `ellipse`, `triangle`, `star5`, `chevron`, `rightArrow`, `wedgeRectCallout`, `heart`, `cloud`, `donut`, `flowChartProcess`…, drawn from ECMA-376's preset shape definitions as PowerPoint draws them; a connector, `line`, `straightConnector1`, `bentConnector2` to `5` or `curvedConnector2` to `5`, has the connector's line, no fill and no text, and its `line_begin` and `line_end` face along its path, and `connect: { begin: { shape, site }, end: { shape, site } }` glues its ends to shapes of the slide by name, at sites of their geometries (a rectangle's 0 top, 1 left, 2 bottom, 3 right; PowerPoint's `a:stCxn` and `a:endCxn`): its frame is then where its ends sit, and they follow the shapes; `none` lets go of an end the code glued, as dragging the end off its shape does; with `adjustments`, its handles' values in the definition's order as python-pptx's `adjustments` has them, a share each: `roundRect`'s `[0.1]` is a corner of a tenth of its shorter side), `path` (a freeform: `{ w, h, d }`, its outline in a box of `w` × `h` units stretched to its frame, `d` in SVG's `M`, `L`, `C` and `Z`, absolute, so a logo or a cursor is a real shape), `table` (`columns`, widths in points, and `rows`, each a `height` with its `fill`, `text` and `line`, a rule at its foot; stretched to its frame, its words the script's, a list of rows, each a list of cells) or `component` (with `props`, and `dur`, how long it moves), and a `frame`. `group`, a name a slide's own shapes share, makes them one group in PowerPoint, standing together where the topmost of them stands. A table here has no style of its own, unlike python-pptx's: its look is what its rows and cells say. A picture or a movie put in a picture, media or object placeholder fills it. Colours are the theme's (`accent1`…); the theme's lighter or darker, in PowerPoint's words (`accent1 lighter 40%`, `dk1 darker 25%`, a share over 0 up to 100 %), which follows a change of theme as PowerPoint's picker's tints and shades do; or `#RRGGBB`. In code a colour (`ColorFormat`) has python-pptx's `brightness`, -1 to 1 (`0.4` is lighter 40 %), on a theme colour only. `z` orders a shape among the slide's shapes and placeholders, so a negative `z` puts one under a placeholder's words. Paths are from the deck's module's folder.
130
137
 
131
138
  A slide's `animations` are PowerPoint's Animation Pane, in order, each on one of the slide's own shapes (`shape`, by name; in a block, `<slide>/<shape>`), or one `paragraph` of its text, from 0:
132
139
 
@@ -141,7 +148,7 @@ A slide's `animations` are PowerPoint's Animation Pane, in order, each on one of
141
148
 
142
149
  Each click is a step: its still, a page of a PDF, is drawn once what it started has ended, and `allyhub frames` has a tile for each. What a shape comes on by an entrance is not drawn before it. A component's `render(t)` is given the seconds since its shape came on, and a step that brings one on rests once it has settled. A PowerPoint file has them as PowerPoint's own. A generated slide adds them with `slide.animations.add(shape, effect, options)`.
143
150
 
144
- A video on a slide plays from when its shape comes on, to its end, when presenting. In a PowerPoint file a component that moves is a video of what its code draws, from when its shape comes on, for 4 seconds, which plays as it comes on (as the slide opens, if it has no entrance); one that does not move is a picture.
151
+ A video on a slide plays from when its shape comes on, to its end, when presenting. In a PowerPoint file a component that moves is a video of what its code draws, from when its shape comes on, for as long as it moves (its `dur`, 4 seconds when absent), which plays as it comes on (as the slide opens, if it has no entrance); one that does not move is a picture.
145
152
 
146
153
  A slide's `transition` is how it comes on from the slide before: `type` (`fade`, `push`, `wipe`, or `morph`), `direction` for a push or a wipe (`from-right` unless said), `duration` in seconds (0.7 for a fade, 1 for a push or a wipe, 2 for a morph). What is on the slide starts when it is over, and presenting plays it. A morph moves each shape the two slides share by name from the one's place and size to the other's, as PowerPoint's Morph; what only one has fades. So name a shape the same on both slides to carry it across. A PowerPoint file has them as its own, with a fade for a PowerPoint too old for Morph. A generated slide sets `slide.transition`.
147
154
 
@@ -152,7 +159,7 @@ revenue:
152
159
  frame: { x: 80, y: 120, w: 640, h: 340 }
153
160
  chart:
154
161
  type: column-clustered
155
- data: ../sales#revenue # from the deck's folder: a sheet's table (<sheet>#<table>), a CSV, or a data file of rows
162
+ data: ../sales/sales.yaml#revenue # from the module's folder: a sheet's table (<sheet>#<table>), a CSV, or a data file of rows
156
163
  categories: Quarter # the column of names
157
164
  series: [Revenue, { name: Cost, color: accent3 }] # the columns of numbers
158
165
  legend: bottom
@@ -167,6 +174,7 @@ Without `data`, `categories` is a list of names and each series has its `values`
167
174
  | `labels.position` | a clustered bar's `outEnd`, a stacked bar's and a pie's `ctr`, a line's `t` | `outEnd` (clustered bars and pies), `inEnd`, `ctr`, `inBase` (bars), `t`, `b`, `l`, `r` (lines). An area and a doughnut have none: a position a chart's kind cannot have is AK-M011, since PowerPoint would repair the file |
168
175
  | `gap_width`, `overlap` | 150; 0 (stacked 100) | Bars: the gap as a share of a bar's width, how far one covers the next, in % |
169
176
  | `vary_by_categories` | a pie's and a doughnut's | A colour per category |
177
+ | `category_colors` | the accents in turn | Where it varies by categories, each category's colour in order (a slice's): a theme colour or `#RRGGBB`. In code, a series' `points[i].format.fill`, as python-pptx's |
170
178
  | `hole_size` | 50 | A doughnut's, in % |
171
179
  | `value_axis`, `category_axis` | automatic | `min`, `max`, `major`, `gridlines` (the value axis's are on), `visible`, `format` (Excel's), `reverse`, `gridline_color`, `line_color` |
172
180
  | `size`, `title_size`, `color` | 12, 14.4, `dk1` | Its text's points, its title's, and their colour |
@@ -174,25 +182,25 @@ Without `data`, `categories` is a list of names and each series has its `values`
174
182
 
175
183
  In code, `shapes.add_chart(XL_CHART_TYPE.X, left, top, width, height, chart_data)` makes one from a `CategoryChartData`, or an `XyChartData` (`add_series(name)`, `add_data_point(x, y)`), as python-pptx's does, with its `.chart`. A scale left automatic is PowerPoint's in the file and drawn here by the same rules, so a number a person changes moves it; set `min`, `max` and `major` to fix it. Where the plot sits is written in the file, so every app puts it where the stage does. `allyhub inspect --kind chart-data` lists each chart's numbers and the file they came from.
176
184
 
177
- What `slides.yaml` names that the deck does not have (a layout, a generator, a component or its prop, a shape to change or animate, a file) is AK-M011, at its line; an exception in a generator, at the line of `slides.ts` that threw it. A slide that is not the format is left out, so one check finds every problem.
185
+ What the slides file names that the deck does not have (a layout, a generator, a component or its prop, a shape to change or animate, a file) is AK-M011, at its line; an exception in a generator, at the line of the deck's module that threw it. A slide that is not the format is left out, so one check finds every problem.
178
186
 
179
187
  ## The script
180
188
 
181
- A deck's script has a row per slide under `slides`: its `text` by shape name (a placeholder's or a text box's; a list is paragraphs, a list in it a level deeper; `**bold**`, `*italic*`, `` `code` ``, in the theme's `code` font, `<span color="accent1" font="Inter Tight">words</span>`, in a colour as `slides.yaml` writes one (`accent1`, `accent1 lighter 40%`, `#RRGGBB`), a font of their own, or both, are runs, as in a doc; a span also takes `size="24"`, in points, `bold="false"` and `italic="false"`, plain words in a bold or italic level, `underline="true"`, `link="https://…"`, `strike="true"`, `highlight="#FFFF00"` and `baseline="0.3"`, raised or, below 0, lowered, a share of the size. A slide number placeholder writes its own text, a number PowerPoint keeps up to date) its `alt`, each picture's or shape's alternative text by name (what a screen reader says, PowerPoint's Alt Text), and its `notes`. A key is `<prefix>.<slide>.<shape>` (the prefix is the deck's id with `/` as `.`), `<prefix>.<slide>.alt.<shape>`, `<prefix>.<slide>.notes`. A placeholder with no words in the script is empty, and an empty placeholder is not drawn. A layout's date, footer and slide number placeholders are on a slide only where it names them in `slides.yaml` (`slide-number: {}`), as PowerPoint's Header & Footer and python-pptx's `add_slide` have it. Words are in the script's language, and in Japanese where they have kana, Korean where they have hangul, on the stage and in an exported file: Han characters take that language's forms.
189
+ A deck's script has a row per slide under `slides`: its `text` by shape name (a placeholder's or a text box's; a list is paragraphs, a list in it a level deeper; `**bold**`, `*italic*`, `` `code` ``, in the theme's `code` font, `<span color="accent1" font="Inter Tight">words</span>`, in a colour as the slides file writes one (`accent1`, `accent1 lighter 40%`, `#RRGGBB`), a font of their own, or both, are runs, as in a doc; a span also takes `size="24"`, in points, `bold="false"` and `italic="false"`, plain words in a bold or italic level, `underline="true"`, `link="https://…"`, `strike="true"`, `highlight="#FFFF00"` and `baseline="0.3"`, raised or, below 0, lowered, a share of the size. A slide number placeholder writes its own text, a number PowerPoint keeps up to date) its `alt`, each picture's or shape's alternative text by name (what a screen reader says, PowerPoint's Alt Text), and its `notes`. A key is `<prefix>.<slide>.<shape>` (the prefix is the deck's id with `/` as `.`), `<prefix>.<slide>.alt.<shape>`, `<prefix>.<slide>.notes`. A placeholder with no words in the script is empty, and an empty placeholder is not drawn. A layout's date, footer and slide number placeholders are on a slide only where it names them in the slides file (`slide-number: {}`), as PowerPoint's Header & Footer and python-pptx's `add_slide` have it. Words are in the script's language, and in Japanese where they have kana, Korean where they have hangul, on the stage and in an exported file: Han characters take that language's forms.
182
190
 
183
191
  ## What a person changes in the editor
184
192
 
185
- The slides' order, a slide's layout, hidden, added, duplicated or removed; text typed in place and the notes; a shape moved and sized, brought forward or sent back, removed; a text box, picture, video or basic shape placed; a theme colour for a fill or a text, a text's size, bold and alignment; a shape reset to its layout. Every one of these is an edit of `slides.yaml` or the script; everything else (masters, layouts, components, generators, style beyond these) is yours, in `slides.ts`. When you and the person change these files at once, both changes stand: a frame, a shape and an animation merge field by field, the slides' order and a shape's paragraphs line by line, and where you both changed one value the person's stands; a slide or shape one of you removed while the other changed it stays, changed. The person keeps or undoes each of your changes. A slide the person adds is `slide-` and four letters (`slide-k3f9`), so give yours ids by what they are.
193
+ The slides' order, a slide's layout, hidden, added, duplicated or removed; text typed in place and the notes; a shape moved and sized, brought forward or sent back, removed; a text box, picture, video or basic shape placed; a theme colour for a fill or a text, a text's size, bold and alignment; a shape reset to its layout. Every one of these is an edit of the slides file or the script; everything else (masters, layouts, components, generators, style beyond these) is yours, in the deck's module. When you and the person change these files at once, both changes stand: a frame, a shape and an animation merge field by field, the slides' order and a shape's paragraphs line by line, and where you both changed one value the person's stands; a slide or shape one of you removed while the other changed it stays, changed. The person keeps or undoes each of your changes. A slide the person adds is `slide-` and four letters (`slide-k3f9`), so give yours ids by what they are.
186
194
 
187
195
  ## Importing a PowerPoint file
188
196
 
189
- `allyhub slides import <file.pptx> --to <folder>` makes a deck of a PowerPoint file: its masters and layouts as `slides.ts` (python-pptx's calls, only what differs from Office's text styles), its slides on their layouts as `slides.yaml` (what each moves, its own shapes, pictures, videos, tables, charts and lines, their rotation, flips and groups, its background, animations and transition), each slide's words, alternative text and notes as the script (bold and italic as `**…**` and `*…*`, a run's own bold or italic off as `bold="false"` or `italic="false"`, a link, a highlight, a baseline, a colour, a font, a size, an underline or a strike of their own as spans, what all of a shape's text has as its `text` in `slides.yaml`, a deeper level as a list in the list), its pictures and videos in `media/`, by their files' names. A slide's and a shape's name is kept where it is a name (letters, digits, `_`, `-`), so a deck AllyHub wrote reads back with its own. A table's style is resolved into its rows' fills, text and rules; a theme colour lightened or darkened as PowerPoint's picker does it is that theme colour (`accent1 lighter 40%`), one changed otherwise the colour it makes.
197
+ `allyhub slides import <file.pptx> --to reviews/q3.ts` makes a deck of a PowerPoint file: its masters and layouts as the deck's module, `reviews/q3.ts` (python-pptx's calls, only what differs from Office's text styles; by default the file's name, `.ts`), its slides on their layouts as its slides file, `reviews/q3.yaml` (what each moves, its own shapes, pictures, videos, tables, charts and lines, their rotation, flips and groups, its background, animations and transition), each slide's words, alternative text and notes as the script, `reviews/q3.<lang>.yaml` (bold and italic as `**…**` and `*…*`, a run's own bold or italic off as `bold="false"` or `italic="false"`, a link, a highlight, a baseline, a colour, a font, a size, an underline or a strike of their own as spans, what all of a shape's text has as its `text` in the slides file, a deeper level as a list in the list), its pictures and videos beside them, by their files' names (another where a file there has it). A slide's and a shape's name is kept where it is a name (letters, digits, `_`, `-`), so a deck AllyHub wrote reads back with its own. A table's style is resolved into its rows' fills, text and rules; a theme colour lightened or darkened as PowerPoint's picker does it is that theme colour (`accent1 lighter 40%`), one changed otherwise the colour it makes.
190
198
 
191
199
  Everything the file holds that the deck does not carry over as it is is reported, grouped (what, why, how many, where), all of it with `--json`: what nothing read, an extension of Office's, a part, what the deck cannot hold, what is held another way, what is missing from the file. Nothing is dropped without a line. `--lang` names the script's language.
192
200
 
193
201
  ## Measuring a deck
194
202
 
195
- The check measures every slide as the stage draws it, and `allyhub inspect` lists what it found as facts: numbers for you to judge, never problems, every length in points as `slides.yaml` writes them. Text the slide's edge cuts at every build that shows it is AK-L002, an error that stops a render. A deck has:
203
+ The check measures every slide as the stage draws it, and `allyhub inspect` lists what it found as facts: numbers for you to judge, never problems, every length in points as the slides file writes them. Text the slide's edge cuts at every build that shows it is AK-L002, an error that stops a render. A deck has:
196
204
 
197
205
  - `text-overflow`: a shape's text past its box, by its lines' glyphs.
198
206
  - `text-off-slide`: a shape's text the slide's edge cuts, how far and the share outside.
@@ -206,7 +214,7 @@ The check measures every slide as the stage draws it, and `allyhub inspect` list
206
214
 
207
215
  ## What a deck renders to
208
216
 
209
- `allyhub render` makes a deck's files in `.allyhub/out/<piece>/` (`slides.<combo key>.<ext>`), each slide drawn at its still, hidden ones left out; `allyhub help render` lists the options.
217
+ `allyhub render` makes a deck's files in `.allyhub/out/`, named by its id (`reviews/q3.<combo key>.<ext>`), each slide drawn at its still, hidden ones left out; `allyhub help render` lists the options.
210
218
 
211
219
  | Type | What it is |
212
220
  | ------------------- | --------------------------------------------------------- |
package/docs/sound.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Nothing makes a sound unless the piece puts it there: each part's speech ([speech.md](speech.md)), the music, footage with `audio: true` and the sound effects a part places. Each stem is shaped, levelled to a loudness, the music dips under speech, and the sum is mastered. The render's mix and the preview's are the same computation, sample by sample. This file covers music, sound effects, the mix, the master and how the voice was recorded.
4
4
 
5
- ```ts file=launch/film/video.ts
5
+ ```ts file=launch/film.ts
6
6
  import { part, take, video } from "@allyhub/sdk";
7
7
 
8
8
  import chime from "./sfx/chime.wav";
@@ -123,7 +123,7 @@ The values are `MIX_DEFAULTS`. A part's own speech level is `speechGainDb` ([spe
123
123
 
124
124
  ## The master
125
125
 
126
- `video({ master })`: a loudness in LUFS (−70 to 0), `{ lufs?, truePeak? }` (`truePeak` −9 to 0 dBTP), or `false`. The default is the format's platform profile's loudness, else −14 LUFS, with a −3 dBTP true peak (`MASTER_DEFAULTS`).
126
+ `video({ master })`: a loudness in LUFS (−70 to 0), `{ lufs?, truePeak? }` (`truePeak` −9 to 0 dBTP), or `false`. The default is −14 LUFS, with a −3 dBTP true peak (`MASTER_DEFAULTS`).
127
127
 
128
128
  The mix's integrated loudness is measured and one gain brings it to `lufs`; a limiter at 4 times the sample rate holds the true peak; what came out is measured again and the gain corrected by what the limiter took, at most 4 times, until within 0.1 LU (`MASTER_MECHANICS`). Nothing rides the level over time: the mix keeps its loudness range. `false` (or `lufs: false`) keeps the mix's own level and only limits its peaks.
129
129
 
@@ -137,7 +137,7 @@ The mix's integrated loudness is measured and one gain brings it to `lufs`; a li
137
137
  - A setup by name: `"studio"`, `"phone"` (a phone held in front, a little below the face: two omni microphones, its band, its automatic gain, a small dead room and its room tone), `"lav"` (a clip-on on the chest, in a dead room, finished). Their values are `SETUP_PRESETS`, the rooms' `ROOM_PRESETS` and the finishing's `POST_PRESETS` ([defaults.md](defaults.md)).
138
138
  - Any value of a setup changes:
139
139
 
140
- ```ts file=talk/video.ts
140
+ ```ts file=talk/talk.ts
141
141
  import { part, video } from "@allyhub/sdk";
142
142
 
143
143
  export default video({
package/docs/speech.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  What a part says: a recording (`take()`), text to speech (`say()`) or a stretch of another video item (`take(piece)`). Its words time the part, place its layers and sounds, duck the music and make the captions. This file covers those, word references, anchors, shown-and-said text, captions and the words and edits files.
4
4
 
5
- ```ts file=launch/film/video.ts
5
+ ```ts file=launch/film.ts
6
6
  import { part, say, take, video } from "@allyhub/sdk";
7
7
 
8
8
  import vo from "./vo/en.mp3";
@@ -66,7 +66,7 @@ The values are `ROOM_MATCH` ([defaults.md](defaults.md)). `allyhub inspect timel
66
66
 
67
67
  A stretch of another video item of the project, imported, with a clock of its own:
68
68
 
69
- ```ts file=scene/video.ts
69
+ ```ts file=scene/scene.ts
70
70
  import { part, video } from "@allyhub/sdk";
71
71
 
72
72
  export default video({
@@ -78,10 +78,10 @@ export default video({
78
78
  });
79
79
  ```
80
80
 
81
- ```ts file=short/video.ts
81
+ ```ts file=short/short.ts
82
82
  import { footage, part, take, video } from "@allyhub/sdk";
83
83
 
84
- import scene from "../scene/video.ts";
84
+ import scene from "../scene/scene.ts";
85
85
 
86
86
  export default video({
87
87
  format: "9x16",
@@ -103,8 +103,8 @@ export default video({
103
103
 
104
104
  Text to speech. `allyhub voice` makes the missing files with the cloud voice tool, each in `assets/media/gen/say/<hash>` with its words and its record (each tool's description says what it costs). A `say` without its file is AK-T002; until it has one, the part lasts about as long as the line takes to say (`SPEECH_RATE_DEFAULTS`: 0.38 s a word, 0.22 s a Chinese, Japanese or Korean character; at least 1 s), and its anchors are placed in proportion along the line.
105
105
 
106
- - `voice`: the voice tool's voice id; default the tool's own.
107
- - `tool`: the voice tool; default `"speech-elevenlabs-multilingual-v2"` (`allyhub help ai <tool>` lists its input).
106
+ - `voice`: the voice tool's voice id (`allyhub ai-media find-voices` finds them); default the tool's own.
107
+ - `tool`: the voice tool; default `"speak"` (`"speak-like"` speaks in the voice of a recording you give in `params`; `allyhub help ai-media <tool>` lists its input).
108
108
  - `params`: more input for the tool, plain JSON: fields its schema has besides the text and voice (`text` and `voiceId` throw).
109
109
  - `speed`: 0.5 to 2, default 1: plays the file faster or slower, pitch kept, as `.speed()` does. Not sent to the tool, so the same file.
110
110
 
@@ -126,7 +126,7 @@ A reference may be a phrase; case and punctuation are ignored. With `say` or `sa
126
126
 
127
127
  ## Anchors
128
128
 
129
- An anchor is a name written in the line a part says, in each language's script (`script.<lang>.yaml`, [project.md](project.md)). The code refers to the name, so a reworded or translated line keeps what hangs on it.
129
+ An anchor is a name written in the line a part says, in each language's script ([project.md](project.md#scripts)). The code refers to the name, so a reworded or translated line keeps what hangs on it.
130
130
 
131
131
  ```yaml
132
132
  parts:
@@ -264,7 +264,7 @@ Subtitle files (`allyhub render --type srt,vtt`) come from each voiced part's li
264
264
 
265
265
  ## Edits files
266
266
 
267
- A take's cut list, a JSON file named by `.edits("./edits/<name>.json")`. It removes exactly what it lists, without touching the recording; `{ "version": 1 }` removes nothing. Which words are fillers, retakes or false starts is the agent's to decide.
267
+ A take's cut list, a JSON file named by `.edits("./edits/<name>.json")`. It removes exactly what it lists, without touching the recording; `{ "version": 1 }` removes nothing. Which words are fillers, retakes or false starts is the agent's to decide. A person cuts words and keeps them again in the video editor's script, which writes this file's `remove` alone, and only where the code names the file: a take without `.edits()` is read only there.
268
268
 
269
269
  ```json
270
270
  {
package/docs/video.md CHANGED
@@ -1,12 +1,13 @@
1
1
  # Videos
2
2
 
3
- A video is the default export of an item's `video.ts`: `video({ …, parts })`, its parts in order, each with its speech (or a length) and its layers. Here: `video()`, formats, `part()`, layers and their stacking, transitions, the look, the camera filming the picture, post.
3
+ A video is the default export of a module listed in `allyhub.yaml` as `kind: video` ([project.md](project.md#items)): `video({ …, parts })`, its parts in order, each with its speech (or a length) and its layers. Here: `video()`, formats, `part()`, layers and their stacking, transitions, the look, the camera filming the picture, post.
4
4
 
5
- ```ts file=launch/film/video.ts
5
+ ```ts file=launch/film.ts
6
6
  import { part, say, video } from "@allyhub/sdk";
7
7
 
8
8
  export default video({
9
9
  format: "16x9",
10
+ script: "./film.{locale}.yaml",
10
11
  parts: ({ s }) => [
11
12
  part({ key: "intro", dur: 3 }),
12
13
  part({ key: "pitch", speech: say(s("launch.film.pitch.say")) }),
@@ -22,7 +23,7 @@ Every piece, a video or a deck, has:
22
23
 
23
24
  | Field | Type | Default | What it is |
24
25
  | --- | --- | --- | --- |
25
- | `id` | string | the item's folder, from the project's root | A stable identity ([project.md](project.md)) |
26
+ | `id` | string | the item's id: its file without its extension, from the project's root | A stable identity ([project.md](project.md)) |
26
27
  | `title` | string, or by language | the script's `title` (`<prefix>.title`), else the file name | The name people see |
27
28
  | `format` | `FormatEntry` | `allyhub.config.ts` `defaults.format`, else `"16x9"` | What it is rendered as: one format ([Formats](#formats)) |
28
29
  | `matrix` | `Matrix` | the project's languages | Dimensions and slots: which combos are made ([batches.md](batches.md)) |
@@ -33,6 +34,7 @@ A video adds:
33
34
  | Field | Type | Default | What it is |
34
35
  | --- | --- | --- | --- |
35
36
  | `parts` | `(ctx) => PartSpec[]`, or a promise | required | The parts, in order |
37
+ | `script` | string | none | Its script, from the module's folder, `{locale}` once in its name for each language (`./film.{locale}.yaml` is `film.en.yaml`, `film.zh-cn.yaml`); without it, it has no words of its own ([project.md](project.md#scripts)) |
36
38
  | `covers` | `(ctx) => PartSpec[]` | none | Parts without speech, each drawn at its `still` for the cover image (`allyhub render --type cover`); their layers mount on elements of their own |
37
39
  | `fps` | number or string | 30 | A whole number from 1 to 120, or an NTSC rate: `23.976`, `29.97`, `47.952`, `59.94`, `119.88`, or `"24000/1001"` … |
38
40
  | `transparent` | boolean | false | No background: mov, webm and png keep the alpha; mp4 and gif show black where nothing is drawn |
@@ -40,7 +42,7 @@ A video adds:
40
42
  | `defaults` | `{ part?: { dur?, lead?, tail? } }` | the project's, over `PART_DEFAULTS` | This video's part defaults |
41
43
  | `music` | media, or `MusicOptions` | none | [sound.md](sound.md) |
42
44
  | `mix` | `MixOptions` | `MIX_DEFAULTS` | The stems' loudness, the music's ducking and fades ([sound.md](sound.md)) |
43
- | `master` | LUFS, `{ lufs, truePeak }`, or `false` | the profile's loudness, else −14 LUFS; −3 dBTP | What the sound is mastered to ([sound.md](sound.md)) |
45
+ | `master` | LUFS, `{ lufs, truePeak }`, or `false` | −14 LUFS; −3 dBTP | What the sound is mastered to ([sound.md](sound.md)) |
44
46
  | `mic` | a setup's name, its options, or `false` | `"studio"` | How the speech was recorded ([sound.md](sound.md)) |
45
47
  | `capture` | `CaptureOptions` | none | A camera filming the picture ([The camera](#the-camera-filming-the-picture)) |
46
48
  | `post` | `{ filter?, lut? }` | none | An ffmpeg filter chain and a `.cube` LUT over the frames ([Post](#post)) |
@@ -67,11 +69,12 @@ A video adds:
67
69
 
68
70
  A piece has one format. Another format is another item that imports what it shares:
69
71
 
70
- ```ts file=launch/film-vertical/video.ts
72
+ ```ts file=launch/vertical/film.ts
71
73
  import { video } from "@allyhub/sdk";
72
- import film from "../film/video.ts";
74
+ import film from "../film.ts";
73
75
 
74
- export default video({ ...film, id: "launch/film-vertical", format: "9x16" });
76
+ // Its id is launch/vertical/film.
77
+ export default video({ ...film, format: "9x16" });
75
78
  ```
76
79
 
77
80
  A path written as a string (a take's, footage's, a sound's, `music`, `post.lut`) is relative to the module that wrote it, also once spread into another piece; a field the new piece writes again is relative to the new piece.
@@ -81,21 +84,20 @@ A path written as a string (a take's, footage's, a sound's, `music`, `post.lut`)
81
84
  | Format | Pixels | Covered edges |
82
85
  | --- | --- | --- |
83
86
  | `16x9`, `9x16`, `1x1`, `4x5` | 1920 × 1080, 1080 × 1920, 1080 × 1080, 1080 × 1350 | the preset's (`PRESETS`) |
84
- | a platform profile | the platform's | the platform's interface |
85
87
  | `WIDTHxHEIGHT` | each side 64 to 8192, even for a video | none |
86
88
  | `a4`, `letter` (slides only) | at 150 dpi | none |
87
89
 
88
- The **platform profiles** (`PROFILES`) are `tiktok`, `reels`, `shorts`, `meta-feed`, `amazon` and `linkedin`: a frame with the edges the platform's interface covers, its longest video (AK-F001), the loudness the sound is mastered to when the video sets no `master`, and how `allyhub render` encodes an mp4 for it. Every preset's and profile's numbers: [defaults.md](defaults.md). Any other format is AK-G001.
90
+ Every preset's numbers: [defaults.md](defaults.md). Any other format is AK-G001.
89
91
 
90
- A format can change its numbers with a `FormatSpec`; its name stays the format's own (combos and file names use it):
92
+ A format can change its covered edges with a `FormatSpec`; its name stays the format's own (combos and file names use it):
91
93
 
92
94
  ```ts fragment
93
- format: { format: "tiktok", safe: { bottom: 520 }, maxDuration: 60, loudness: -16 }
95
+ format: { format: "9x16", safe: { bottom: 520 } }
94
96
  ```
95
97
 
96
- `safe` (whole pixels per edge, any format; edges not given keep the format's) changes the covered edges; `maxDuration` (seconds) and `loudness` (LUFS) belong to a platform profile only.
98
+ `safe` is whole pixels per edge; edges not given keep the format's.
97
99
 
98
- A layer reads `ctx.format` (the name) and `ctx.dims`: `{ width, height, orient, safe, profile? }`, `orient` `"landscape"`, `"portrait"` or `"square"`, `safe` the covered edges in pixels. Lay out by `ctx.dims` or `layout(ctx)` ([layers.md](layers.md#the-content-box)), not by the name: a custom `WxH` or a changed `safe` has none of its own.
100
+ A layer reads `ctx.format` (the name) and `ctx.dims`: `{ width, height, orient, safe }`, `orient` `"landscape"`, `"portrait"` or `"square"`, `safe` the covered edges in pixels. Lay out by `ctx.dims` or `layout(ctx)` ([layers.md](layers.md#the-content-box)), not by the name: a custom `WxH` or a changed `safe` has none of its own.
99
101
 
100
102
  ## Parts
101
103
 
@@ -181,6 +183,7 @@ Parts join with cuts. A part comes in with a transition only when it says so: `t
181
183
  Every type takes `dur` (over 0, up to 10 s; default 0.4), `ease` (`"linear"`, `"in"`, `"out"`, `"in-out"`; default `"linear"` for fade, dip and custom, `"in-out"` for the others) and `split` (0 to 1, the share of the window before the join; default 0.5). Defaults: `TRANSITION_DEFAULTS`.
182
184
 
183
185
  - Parts keep their lengths and places: the window lies across the join. Outside its own time a part's graphics hold its first or last frame and its footage runs on in its file.
186
+ - The incoming part's clock starts at the join, inside the window: an entrance timed from 0 plays during the transition. A layer reads the window as `ctx.enter` (and the next one as `ctx.exit`); the starter components' entrances wait for its end unless told not to.
184
187
  - The whole picture transitions, footage and graphics together. In a `transparent` video a fade adds the two pictures, weighted.
185
188
  - Sound is not changed: place a sound on the join with `sounds`.
186
189
  - The first part's transition is ignored, and so is a deck's.
package/docs/websites.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Websites
2
2
 
3
- A website is any web project in an item's folder, made with the tools the agent chooses (Astro, Vite, Next.js, VitePress, plain HTML). Its entry file, `website.json`, says how it is served while it is made, how it is built and where the built site is, as `vercel.json`'s `devCommand`, `buildCommand` and `outputDirectory` do. Its JSON Schema is `https://allyhub.com/schemas/website.schema.json`.
3
+ A website is any web project in a folder, made with the tools the agent chooses (Astro, Vite, Next.js, VitePress, plain HTML). Its file, a JSON file in that folder listed in `allyhub.yaml` as `kind: website` ([project.md](project.md#items)), says how it is served while it is made, how it is built and where the built site is, as `vercel.json`'s `devCommand`, `buildCommand` and `outputDirectory` do. Its JSON Schema is `https://allyhub.com/schemas/website.schema.json`.
4
4
 
5
5
  ```json
6
6
  {
@@ -36,12 +36,12 @@ A page shows a project's video as any page shows a video: from its files. `allyh
36
36
 
37
37
  ## Checking and building
38
38
 
39
- `allyhub check` reports AK-M013 for a `website.json` that is not JSON or does not match the format. To see a page as Studio shows it, run `dev` with `PORT` and `HOST=127.0.0.1` set, then `allyhub frames web http://127.0.0.1:<port>/<path> --wait <ms>`.
39
+ `allyhub check` reports AK-M013 for a website's file that is not JSON or does not match the format. To see a page as Studio shows it, run `dev` with `PORT` and `HOST=127.0.0.1` set, then `allyhub frames web http://127.0.0.1:<port>/<path> --wait <ms>`.
40
40
 
41
41
 
42
42
  ## Hosting on AllyHub
43
43
 
44
- `allyhub site deploy` runs `build` here and uploads `output` as a private version of the website's site, sending only the files AllyHub lacks. The first deploy writes `site` into `website.json`, so the folder publishes to the same site from any computer. `allyhub site status` lists versions.
44
+ `allyhub site deploy` runs `build` here and uploads `output` as a private version of the website's site, sending only the files AllyHub lacks. The first deploy writes `site` into the website's file, so the folder publishes to the same site from any computer. `allyhub site status` lists versions.
45
45
 
46
46
  Going public is the person's to say. `--live` and `allyhub site live <version>` move the site only if they have let the agent update it; otherwise they answer `live: false` and `confirm`, a page for the person to say yes on: give it to them, or ask them to press Publish in Studio (Update once the site is live; for an earlier version, its row in the website's settings). A site's first publish is always confirmed in their browser. Taking a site offline is theirs alone, in Studio.
47
47
 
@@ -49,7 +49,7 @@ A hosted site is static files, `index.html` at the root of `output`:
49
49
 
50
50
  - `/about` serves `about.html`, `/pricing/` serves `pricing/index.html`, and each page's other addresses redirect to that one. The nearest `404.html` answers a page not found, with status 404: nothing to configure.
51
51
  - `_redirects` and `_headers` at the root of `output` work as on Netlify: a real file wins over a rule that does not end in `!`, the default status is 301, `/* /index.html 200` makes a single-page app, and a 200 rule stays inside the site. A site cannot set cookies, or the headers that are the platform's.
52
- - Never published: dotfiles other than `.well-known/`, `node_modules`, `website.json`, `package.json` and lockfiles. A link in `output` is refused.
52
+ - Never published: dotfiles other than `.well-known/`, `node_modules`, the website's file, `package.json` and lockfiles. A link in `output` is refused.
53
53
  - A file is at most 1 GiB, a version 20,000 files and 5 GiB. `Range` works, so video plays from a page, Safari's included.
54
54
  - Every file is revalidated by its digest. Files a framework names by their bytes are kept by browsers only if `_headers` says so: `/_astro/*` then ` Cache-Control: public, max-age=31536000, immutable` (or `/assets/*` for Vite, `/_next/static/*` for Next.js).
55
55
  - A site stays out of search engines until the person allows it.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@allyhub/sdk",
3
- "version": "0.8.0",
4
- "description": "What an agent writes videos, decks and workbooks with: video() and slides(), parts with their speech, footage and sounds, defineComponent() and custom() layers, the layout, motion and input helpers, the scenery() layer's options, and openpyxl's API for a sheet. Nothing a host needs.",
3
+ "version": "0.9.0",
4
+ "description": "What an agent writes videos, decks and workbooks with: each built-in kind's authoring API, re-exported from its extension. The root, /dom, /media and /scenery are the video's: video(), parts with their speech, footage and sounds, defineComponent() and custom() layers, the layout, motion and input helpers, the scenery() layer's options; /slides is the deck's, python-pptx's API; /image is the image's, its boards each its own size; /sheets is the sheet's, openpyxl's API. Nothing a host needs.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "homepage": "https://allyhub.com",
7
7
  "bugs": {
@@ -36,6 +36,10 @@
36
36
  "./sheets": {
37
37
  "types": "./dist/sheets.d.ts",
38
38
  "default": "./dist/sheets.js"
39
+ },
40
+ "./image": {
41
+ "types": "./dist/image.d.ts",
42
+ "default": "./dist/image.js"
39
43
  }
40
44
  },
41
45
  "sideEffects": false,
@@ -59,6 +63,7 @@
59
63
  "fflate": "^0.8.3",
60
64
  "jsonc-parser": "^3.3.1",
61
65
  "numfmt": "4.1.1",
66
+ "pngjs": "^7.0.0",
62
67
  "proper-lockfile": "4.1.2",
63
68
  "saxes": "^6.0.0",
64
69
  "tar": "^7.5.2",
package/dist/define.js DELETED
@@ -1,2 +0,0 @@
1
- /*! AllyHub. Copyright (c) 2026 AllyHub, Inc. All rights reserved. Use is subject to LICENSE.md. */
2
- import{LAYER_BRAND as d,isGraphicLayer as h}from"@allyhub/video-core";export const LAYER_OPTIONS=["at","until","dur","z"];export function timeShape(e){const s=t=>{if(t.type==="time")return!0;if(t.type==="list")return s(t.of);if(t.type==="object")return timeShape(t.fields)},n={};for(const[t,r]of Object.entries(e)){const o=r?s(r):void 0;o!==void 0&&(n[t]=o)}return Object.keys(n).length>0?n:void 0}export function splitLayer(e){const{at:s,until:n,dur:t,z:r,...o}=e;return[{...s===void 0?{}:{at:s},...n===void 0?{}:{until:n},...t===void 0?{}:{dur:t},...r===void 0?{}:{z:r}},o]}export function defineComponent(e){const s=[...Object.keys(e.props??{}),...Object.keys(e.defaults??{}),...Object.values(e.examples??{}).flatMap(i=>Object.keys(i))],n=[...new Set(s.filter(i=>LAYER_OPTIONS.includes(i)))];if(n.length>0)throw new Error(`${e.name}: ${n.join(", ")} is a layer option, not a prop name`);const t=timeShape(e.props??{}),r="layers"in e?b(e):e,o=i=>{const[p,c]=splitLayer(i??{}),u={...e.defaults,...c};return{[d]:"graphic",...p,component:e.name,props:u,...t?{times:t}:{},mount:(m,l,y)=>{r.mount(m,l,y)},render:(m,l,y,f)=>{r.render(m,l,y,f)},unmount:(m,l,y)=>{r.unmount?.(m,l,y)}}},a={name:e.name,label:e.label??e.name,...e.summary===void 0?{}:{summary:e.summary},props:Object.fromEntries(Object.entries(e.props??{}).filter(i=>i[1]!==void 0)),examples:e.examples??{},hidden:e.hidden??!1};return Object.assign(o,{componentName:e.name,info:a,..."layers"in e?{layersIn:(i,p)=>e.layers({...e.defaults,...i},p)}:{}})}function b(e){const s=new WeakMap;return{mount(n,t,r){const o=e.layers(t,{width:r.dims.width,height:r.dims.height}),a=[];for(const[i,p]of o.entries()){if(!h(p))throw new Error(`${e.name}'s layers: item ${String(i+1)} is not a graphic layer (custom() or a component).`);const c=p,u=document.createElement("div");u.style.position="absolute",u.style.inset="0px",n.append(u),c.mount(u,c.props,r),a.push({layer:c,el:u})}s.set(n,a)},render(n,t,r,o){for(const a of s.get(n)??[])a.layer.render(a.el,t,a.layer.props,o)},unmount(n,t,r){for(const o of s.get(n)??[])o.layer.unmount?.(o.el,o.layer.props,r);s.delete(n)}}}export function custom(e){const[s]=splitLayer(e);return{[d]:"graphic",...s,component:"custom",props:{},mount:(n,t,r)=>{e.mount?.(n,r)},render:(n,t,r,o)=>{e.render(n,t,o)},unmount:(n,t,r)=>{e.unmount?.(n,r)}}}
package/dist/free.js DELETED
@@ -1,2 +0,0 @@
1
- /*! AllyHub. Copyright (c) 2026 AllyHub, Inc. All rights reserved. Use is subject to LICENSE.md. */
2
- export{clamp,ease,fitText,lerp,progress,rand,stagger,tween}from"./anim.js";export{noise2D,noise3D,noise4D}from"./noise.js";export{drag,fittsTime,INPUT_DEFAULTS,pointer,reach,scroll,tap,typing}from"./input.js";export{aimed}from"@allyhub/scenery";export{drawOn,interpolatePath,normalizePath,pathLength,pointAtLength,tangentAtLength,trimPath}from"./paths.js";export{FIT_LINES_PRECISION,fitLines,textLines}from"./dom.js";export{custom,defineComponent,LAYER_OPTIONS}from"./define.js";export{say}from"./parts.js";export{defineConfig,definePiece,paged}from"./piece.js";export{asset,boolean,color,list,number,object,text,time}from"./props.js";export{countText,splitText}from"./text.js";export{markRuns,readMarks,withoutMarks}from"@allyhub/video-core";
package/dist/input.js DELETED
@@ -1,2 +0,0 @@
1
- /*! AllyHub. Copyright (c) 2026 AllyHub, Inc. All rights reserved. Use is subject to LICENSE.md. */
2
- import{aimAt as q,aimShape as E,bandNoise as I,unit3 as v}from"@allyhub/scenery";export const INPUT_DEFAULTS={reach:{overshoot:.06,peak:.38,vary:.5,fitts:{a:.2,b:.15},scatter:.1,jitter:.02,bow:.06,tremor:{px:.3,frequency:9},seed:1},size:40,dwell:.12,hold:.1,drag:{settle:.08,release:.06,fitts:{a:.25,b:.2},tremor:{px:.8,frequency:8}},tap:{slide:1.2,grow:.03},wheel:{notch:100,animate:.15,interval:.05,pause:.25,burst:4},flick:{contact:.12,decay:.4995,band:800,spring:.12},typing:{cps:9,spread:.35,word:1.5,mark:2,think:{chance:.08,seconds:.35},notice:.3,backspace:.07,seed:1}};function z(t,o=INPUT_DEFAULTS.reach){return{...o,...t,fitts:{...o.fitts,...t?.fitts},tremor:{...o.tremor,...t?.tremor}}}const w=(t,o,r)=>2*v(t,o,r)-1,M=(t,o,r)=>Math.sqrt(-2*Math.log(v(t,o,r)))*Math.cos(2*Math.PI*v(t^625341585,o,r));export function reachProblem(t,o){const r=[["scatter",t.scatter],["jitter",t.jitter],["bow",t.bow],["vary",t.vary],["fitts.a",t.fitts?.a],["fitts.b",t.fitts?.b],["tremor.px",t.tremor?.px],["tremor.frequency",t.tremor?.frequency]];for(const[n,c]of r)if(c!==void 0&&!(Number.isFinite(c)&&c>=0))return`${o}'s ${n} is a number from 0, not ${String(c)}`;if(t.overshoot!==void 0&&!(t.overshoot>=-.5&&t.overshoot<=1))return`${o}'s overshoot is a share from -0.5 to 1, not ${String(t.overshoot)}`;if(t.peak!==void 0&&!(t.peak>=.15&&t.peak<=.6))return`${o}'s peak is a share from 0.15 to 0.6, not ${String(t.peak)}`;if(t.seed!==void 0&&!Number.isInteger(t.seed))return`${o}'s seed is a whole number, not ${String(t.seed)}`}export function fittsTime(t,o,r={}){const n={...INPUT_DEFAULTS.reach.fitts,...r};return n.a+n.b*Math.log2(1+t/Math.max(1,o))}export function reach(t,o,r,n={}){const c=reachProblem(n,"reach");if(c)throw new Error(c);const a=z(n),f=r.index??0,h=r.size??INPUT_DEFAULTS.size,y=[o[0]+a.scatter*h*M(a.seed,f,11),o[1]+a.scatter*h*M(a.seed,f,12)],m=y[0]-t[0],s=y[1]-t[1],u=Math.hypot(m,s),d=Math.max(.05,(r.duration??fittsTime(u,h,a.fitts))*(1+.15*a.vary*w(a.seed,f,13))),e=r.end+a.jitter*M(a.seed,f,14),i=e-d,x=E({overshoot:a.overshoot,peak:a.peak,vary:a.vary,seed:a.seed,index:f}),l=a.bow*w(a.seed,f,15);return{start:i,end:e,from:t,to:y,bow:l,progress:b=>q(x,b),at(b){if(b<=i)return t;if(b>=e)return y;const p=(b-i)/d,k=q(x,p),g=l*Math.sin(Math.PI*Math.min(1,p));return[t[0]+m*k-s*g,t[1]+s*k+m*g]}}}function S(t,o,r){if(r.px<=0)return()=>[0,0];const n={center:r.frequency,spread:r.frequency/5},c=I(t+o*31,101,n),a=I(t+o*31,102,n);return f=>[r.px*c(f),r.px*a(f)]}export function pointer(t){const o=reachProblem(t,"pointer");if(o)throw new Error(o);const r=z(t),n=t.dwell??INPUT_DEFAULTS.dwell,c=t.hold??INPUT_DEFAULTS.hold,a=[],f=[];let h=t.from;for(const[m,s]of t.steps.entries()){const u=s.press?(s.dwell??n)*(1+.4*r.vary*w(r.seed,m,21)):0,d=reach(h,s.to,{end:s.at-u,...s.duration===void 0?{}:{duration:s.duration},size:s.size??INPUT_DEFAULTS.size,index:m},t);if(a.push(d),s.press){const e=(s.hold??c)*(1+.4*r.vary*w(r.seed,m,22));f.push({down:s.at,up:s.at+e,at:d.to})}h=d.to}const y=S(r.seed,0,r.tremor);return{moves:a,presses:f,at(m){let s=t.from;for(const e of a)m>=e.start&&(s=e.at(m));const[u,d]=y(m);return{x:s[0]+u,y:s[1]+d,down:f.some(e=>m>=e.down&&m<e.up)}}}}export function tap(t){const o=t.seed??INPUT_DEFAULTS.reach.seed,r=t.index??0,n=t.size??INPUT_DEFAULTS.size,c=t.scatter??INPUT_DEFAULTS.reach.scatter,a=t.slide??INPUT_DEFAULTS.tap.slide,f=t.grow??INPUT_DEFAULTS.tap.grow,h=(t.hold??INPUT_DEFAULTS.hold)*(1+.3*w(o,r,31)),y=t.to[0]+c*n*M(o,r,32),m=t.to[1]+c*n*M(o,r,33),s=2*Math.PI*v(o,r,34),u=t.at,d=u+h;return{down:u,up:d,at(e){const i=Math.min(1,Math.max(0,(e-u)/h)),x=a*(i*i*(3-2*i)),l=e>=u&&e<d,b=l?Math.min(1,(e-u)/f,(d-e)/f):0;return{x:y+x*Math.cos(s),y:m+x*Math.sin(s),down:l,contact:b}}}}export function drag(t){const o=reachProblem(t,"drag");if(o)throw new Error(o);const r=INPUT_DEFAULTS.drag,n=z(t,{...INPUT_DEFAULTS.reach,fitts:r.fitts,tremor:r.tremor}),c=t.index??0,a=(t.settle??r.settle)*(1+.4*n.vary*w(n.seed,c,41)),f=(t.release??r.release)*(1+.4*n.vary*w(n.seed,c,42)),h=t.size??INPUT_DEFAULTS.size,y=Math.hypot(t.to[0]-t.from[0],t.to[1]-t.from[1]),m=t.duration??fittsTime(y,h,n.fitts),s=reach(t.from,t.to,{end:t.at+a+m,duration:m,size:h,index:c},{...n,jitter:0}),u=S(n.seed,c+1e3,n.tremor),d=s.end+f;return{down:t.at,start:s.start,end:s.end,up:d,to:s.to,at(e){const i=s.at(e),x=e>=t.at&&e<d,l=x?Math.min(1,(e-t.at)/.05,(d-e)/.05):0,[b,p]=u(e);return{x:i[0]+l*b,y:i[1]+l*p,down:x}}}}export function scroll(t){const o=t.seed??INPUT_DEFAULTS.reach.seed,r=t.index??0,n=t.by<0?-1:1;if((t.kind??"flick")==="wheel"){const e={...INPUT_DEFAULTS.wheel,...t.wheel},i=Math.max(1,Math.round(Math.abs(t.by)/e.notch)),x=t.by/i,l=[];let b=t.at;for(let k=0;k<i;k++){l.push(b);const g=(k+1)%Math.max(1,e.burst)===0?e.pause:e.interval;b+=g*(1+.4*w(o,r*997+k,51))}const p=k=>1-(1-k)**3;return{start:t.at,end:(l.at(-1)??t.at)+e.animate,at(k){let g=0;for(const $ of l)k>$&&(g+=x*p(Math.min(1,(k-$)/e.animate)));return g}}}const c={...INPUT_DEFAULTS.flick,...t.flick},a=c.contact*(1+.3*w(o,r,52)),f=Math.abs(t.by)/(a/2+c.decay),h=f*a/2,y=t.at+a,m=e=>{if(e<=t.at)return 0;if(e<=y){const i=(e-t.at)/a;return h*i*i}return h+f*c.decay*(1-Math.exp(-(e-y)/c.decay))},s=t.limit===void 0?1/0:Math.abs(t.limit);let u=1/0;Math.abs(t.by)>s&&(s<=h?u=t.at+a*Math.sqrt(s/h):u=y-c.decay*Math.log(1-(s-h)/(f*c.decay)));const d=e=>(1-1/(e*.55/c.band+1))*c.band;return{start:t.at,end:y+c.decay*5,at(e){const i=m(e);if(i<=s)return n*i;const x=Math.max(0,e-u),l=(1+x/c.spring)*Math.exp(-x/c.spring);return n*(s+d(i-s)*l)}}}const j=t=>t!==void 0&&/[\p{L}\p{N}]/u.test(t);export function typing(t,o){const r=INPUT_DEFAULTS.typing,n={...r,...o,think:{...r.think,...o.think}};if(!(n.cps>0))throw new Error(`typing's cps is above 0, not ${String(n.cps)}`);const c=Array.from(t),a=[],f=[];let h=n.at,y=0;const m=(d,e)=>{const i=1/n.cps,x=n.spread,l=M(n.seed,y,61);let b=i*Math.exp(x*l-x*x/2);return!j(d)&&j(e)&&(b*=n.word,v(n.seed,y,62)<n.think.chance&&(b+=n.think.seconds)),d!==void 0&&/[.,;:!?。,、!?]/u.test(d)&&(b*=n.mark),b},s=(d,e,i)=>{a.length>0&&(h+=i??m(d,e)),a.push({t:h,key:e}),y++};let u;for(const[d,e]of c.entries()){for(const i of n.mistakes??[]){if(i.at!==d)continue;const x=Array.from(i.typed);for(const l of x)s(u,l),u=l;h+=n.notice*(1+.3*w(n.seed,y,63));for(let l=0;l<x.length;l++)s(u,"Backspace",l===0?0:n.backspace);u=c[d-1]}s(u,e),f[d]=h,u=e}return{keys:a,times:f,end:h,text(d){let e=[];for(const i of a){if(i.t>d)break;i.key==="Backspace"?e=e.slice(0,-1):e.push(i.key)}return e.join("")}}}
package/dist/module.js DELETED
@@ -1,2 +0,0 @@
1
- /*! AllyHub. Copyright (c) 2026 AllyHub, Inc. All rights reserved. Use is subject to LICENSE.md. */
2
- import*as e from"./free.js";import{footageFor as a,partFor as f,takeFor as i}from"./parts.js";import{videoFor as n}from"./piece.js";import{writtenIn as p}from"./written.js";export const BOUND=["video","part","take","footage"];export function sdkFor(t){const o=p(t),r={video:n(o),part:f(o),take:i(o),footage:a(o)};return{...e,...r}}