@allyhub/sdk 0.5.0 → 0.7.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.
- package/dist/define.d.ts +4 -0
- package/dist/define.js +1 -1
- package/dist/node_modules/@allyhub-next/audio/dist/node/index.d.ts +1 -1
- package/dist/node_modules/@allyhub-next/audio/dist/node/index.js +1 -1
- package/dist/node_modules/@allyhub-next/audio/dist/node/master.d.ts +4 -0
- package/dist/node_modules/@allyhub-next/audio/dist/node/master.js +1 -1
- package/dist/node_modules/@allyhub-next/audio/package.json +1 -1
- package/dist/node_modules/@allyhub-next/chart/dist/chart-xml.js +2 -2
- package/dist/node_modules/@allyhub-next/chart/dist/chart.d.ts +14 -5
- package/dist/node_modules/@allyhub-next/chart/dist/chart.js +1 -1
- package/dist/node_modules/@allyhub-next/chart/package.json +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/data/deck-code.d.ts +205 -0
- package/dist/node_modules/@allyhub-next/formats/dist/data/deck-code.js +2 -0
- package/dist/node_modules/@allyhub-next/formats/dist/data/script.d.ts +4 -1
- package/dist/node_modules/@allyhub-next/formats/dist/data/script.js +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/data/sheet.d.ts +248 -18
- package/dist/node_modules/@allyhub-next/formats/dist/data/sheet.js +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/data/slides.d.ts +1114 -91
- package/dist/node_modules/@allyhub-next/formats/dist/data/slides.js +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/data/website.d.ts +20 -0
- package/dist/node_modules/@allyhub-next/formats/dist/data/website.js +2 -0
- package/dist/node_modules/@allyhub-next/formats/dist/index.d.ts +4 -0
- package/dist/node_modules/@allyhub-next/formats/dist/index.js +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/items.d.ts +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/items.js +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/media-type.d.ts +3 -0
- package/dist/node_modules/@allyhub-next/formats/dist/media-type.js +2 -0
- package/dist/node_modules/@allyhub-next/formats/dist/schemas.d.ts +625 -30
- package/dist/node_modules/@allyhub-next/formats/dist/schemas.js +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/strict.d.ts +2 -0
- package/dist/node_modules/@allyhub-next/formats/dist/strict.js +1 -1
- package/dist/node_modules/@allyhub-next/formats/dist/zip.d.ts +17 -0
- package/dist/node_modules/@allyhub-next/formats/dist/zip.js +2 -0
- package/dist/node_modules/@allyhub-next/formats/package.json +2 -1
- package/dist/node_modules/@allyhub-next/ooxml/LICENSE +241 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/brightness.d.ts +31 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/brightness.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/color.d.ts +33 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/color.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/enums.d.ts +13 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/enums.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/ext.d.ts +79 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/ext.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/generated/enums.d.ts +132 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/generated/enums.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/generated/presets.d.ts +28 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/generated/presets.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/generated/spec.d.ts +4708 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/generated/spec.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/geometry/index.d.ts +57 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/geometry/index.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/index.d.ts +10 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/index.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/mce.d.ts +12 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/mce.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/node.d.ts +111 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/node.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/ns.d.ts +45 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/ns.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/opc.d.ts +48 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/opc.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/report.d.ts +45 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/report.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/xml.d.ts +28 -0
- package/dist/node_modules/@allyhub-next/ooxml/dist/xml.js +2 -0
- package/dist/node_modules/@allyhub-next/ooxml/package.json +26 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/account.d.ts +338 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/account.js +2 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/auth.d.ts +12 -13
- package/dist/node_modules/@allyhub-next/protocol/dist/auth.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/blobs.d.ts +35 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/blobs.js +2 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/cloud.d.ts +101 -32
- package/dist/node_modules/@allyhub-next/protocol/dist/cloud.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/editor.d.ts +89 -5
- package/dist/node_modules/@allyhub-next/protocol/dist/editor.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/files.d.ts +2 -2
- package/dist/node_modules/@allyhub-next/protocol/dist/index.d.ts +6 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/index.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/notes.d.ts +23 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/notes.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/open.d.ts +13 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/open.js +2 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/registry.d.ts +73 -59
- package/dist/node_modules/@allyhub-next/protocol/dist/registry.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/routes.d.ts +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/routes.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/shares.d.ts +115 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/shares.js +2 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/sites.d.ts +293 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/sites.js +2 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/snapshots.d.ts +377 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/snapshots.js +2 -0
- package/dist/node_modules/@allyhub-next/protocol/dist/teams.d.ts +27 -9
- package/dist/node_modules/@allyhub-next/protocol/dist/teams.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/dist/tools.d.ts +53 -14
- package/dist/node_modules/@allyhub-next/protocol/dist/tools.js +1 -1
- package/dist/node_modules/@allyhub-next/protocol/package.json +2 -1
- package/dist/node_modules/@allyhub-next/runtimes/package.json +1 -1
- package/dist/node_modules/@allyhub-next/runtimes/schemas/runtimes.schema.json +25 -5
- package/dist/node_modules/@allyhub-next/scenery/package.json +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/api/capabilities.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/api/index.d.ts +1 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/api/index.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/api/page.d.ts +83 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/api/page.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/api/workbook.d.ts +40 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/api/workbook.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/analyse.d.ts +9 -3
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/analyse.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/coerce.d.ts +5 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/coerce.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/engine.d.ts +60 -13
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/engine.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/aggregate.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/convert.d.ts +4 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/convert.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/criteria.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/database.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/date.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/define.d.ts +27 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/define.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/delimiters.d.ts +16 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/delimiters.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/dynamic.d.ts +18 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/dynamic.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/finance.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/index.d.ts +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/index.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/info.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/kernels.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/logical.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/lookup.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/maths.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/modern.d.ts +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/modern.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/functions/text.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/graph.d.ts +38 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/graph.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/indexes.d.ts +19 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/indexes.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/remote.d.ts +49 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/remote.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/server.d.ts +82 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/server.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/types.d.ts +6 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/calc/types.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/chart.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/check.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/diff.d.ts +15 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/diff.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/export.d.ts +29 -8
- package/dist/node_modules/@allyhub-next/sheet/dist/export.js +3 -4
- package/dist/node_modules/@allyhub-next/sheet/dist/file.js +2 -2
- package/dist/node_modules/@allyhub-next/sheet/dist/format.d.ts +8 -2
- package/dist/node_modules/@allyhub-next/sheet/dist/format.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/html.d.ts +52 -4
- package/dist/node_modules/@allyhub-next/sheet/dist/html.js +43 -11
- package/dist/node_modules/@allyhub-next/sheet/dist/index.d.ts +7 -3
- package/dist/node_modules/@allyhub-next/sheet/dist/index.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/inspect.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/paginate.d.ts +98 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/paginate.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/structure.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/table-style.d.ts +32 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/table-style.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/table-styles.d.ts +3 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/table-styles.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/values.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/workbook.d.ts +10 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/workbook.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/charts.d.ts +12 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/charts.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/formula.d.ts +14 -4
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/formula.js +2 -2
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/functions.d.ts +11 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/functions.js +36 -16
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/import.d.ts +6 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/import.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/read.d.ts +44 -2
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/read.js +2 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/sax.d.ts +23 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/sax.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/styles.d.ts +2 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/styles.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/write.d.ts +6 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/write.js +1 -1
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/zip.d.ts +40 -0
- package/dist/node_modules/@allyhub-next/sheet/dist/xlsx/zip.js +2 -0
- package/dist/node_modules/@allyhub-next/sheet/package.json +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/animation.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/api.d.ts +121 -44
- package/dist/node_modules/@allyhub-next/slides-core/dist/api.js +2 -2
- package/dist/node_modules/@allyhub-next/slides-core/dist/capabilities.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/chart-api.d.ts +50 -13
- package/dist/node_modules/@allyhub-next/slides-core/dist/chart-api.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/chart-file.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/check.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/code.d.ts +33 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/code.js +2 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/components.d.ts +31 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/components.js +2 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/enums.d.ts +188 -5
- package/dist/node_modules/@allyhub-next/slides-core/dist/enums.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/file.d.ts +43 -21
- package/dist/node_modules/@allyhub-next/slides-core/dist/file.js +3 -3
- package/dist/node_modules/@allyhub-next/slides-core/dist/identity.d.ts +17 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/identity.js +2 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/index.d.ts +5 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/index.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/lang.d.ts +6 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/lang.js +2 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/measure.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/merge.d.ts +58 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/merge.js +2 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/model.d.ts +38 -4
- package/dist/node_modules/@allyhub-next/slides-core/dist/office.d.ts +27 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/office.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/resolve.d.ts +26 -5
- package/dist/node_modules/@allyhub-next/slides-core/dist/resolve.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/script.d.ts +18 -16
- package/dist/node_modules/@allyhub-next/slides-core/dist/script.js +2 -2
- package/dist/node_modules/@allyhub-next/slides-core/dist/stage.d.ts +51 -53
- package/dist/node_modules/@allyhub-next/slides-core/dist/strict.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/units.d.ts +27 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/units.js +1 -1
- package/dist/node_modules/@allyhub-next/slides-core/dist/values.d.ts +7 -0
- package/dist/node_modules/@allyhub-next/slides-core/dist/values.js +2 -0
- package/dist/node_modules/@allyhub-next/slides-core/package.json +1 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/captions.js +6 -6
- package/dist/node_modules/@allyhub-next/video-core/dist/fact.d.ts +47 -8
- package/dist/node_modules/@allyhub-next/video-core/dist/fact.js +1 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/index.d.ts +1 -0
- package/dist/node_modules/@allyhub-next/video-core/dist/index.js +1 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/marks.d.ts +14 -0
- package/dist/node_modules/@allyhub-next/video-core/dist/marks.js +1 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/music.d.ts +2 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/piece.d.ts +11 -2
- package/dist/node_modules/@allyhub-next/video-core/dist/problem.d.ts +4 -0
- package/dist/node_modules/@allyhub-next/video-core/dist/problem.js +1 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/schema.d.ts +2 -2
- package/dist/node_modules/@allyhub-next/video-core/dist/schema.js +1 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/script.d.ts +2 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/script.js +1 -1
- package/dist/node_modules/@allyhub-next/video-core/dist/source.d.ts +7 -0
- package/dist/node_modules/@allyhub-next/video-core/dist/source.js +2 -0
- package/dist/node_modules/@allyhub-next/video-core/dist/timeline.d.ts +10 -33
- package/dist/node_modules/@allyhub-next/video-core/package.json +1 -1
- package/dist/sheets.d.ts +1 -1
- package/dist/sheets.js +1 -1
- package/dist/slides.d.ts +3 -1
- package/dist/slides.js +1 -1
- package/docs/README.md +1 -0
- package/docs/contract.md +1 -1
- package/docs/defaults.md +25 -2
- package/docs/layers.md +1 -1
- package/docs/project.md +3 -1
- package/docs/sheets.md +29 -3
- package/docs/slides.md +18 -14
- package/docs/sound.md +1 -1
- package/docs/websites.md +57 -0
- package/package.json +3 -1
package/docs/slides.md
CHANGED
|
@@ -88,7 +88,7 @@ slides:
|
|
|
88
88
|
|
|
89
89
|
## `presentation()`
|
|
90
90
|
|
|
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`).
|
|
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`.
|
|
92
92
|
|
|
93
93
|
| Option | Default | What it is |
|
|
94
94
|
| ------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -103,13 +103,13 @@ python-pptx opens these from a template; here code makes them.
|
|
|
103
103
|
- `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
104
|
- `master.slide_layouts.add(name)`: a layout; its name is what `slides.yaml`'s slides name, unique in the deck.
|
|
105
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`, `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.
|
|
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.
|
|
107
107
|
- 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
|
-
- 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`. 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.
|
|
108
|
+
- 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
109
|
|
|
110
110
|
## Components
|
|
111
111
|
|
|
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. `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)`.
|
|
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)`.
|
|
113
113
|
|
|
114
114
|
## Generators
|
|
115
115
|
|
|
@@ -124,8 +124,9 @@ python-pptx opens these from a template; here code makes them.
|
|
|
124
124
|
| `slides[].generate` | One of the deck's generators: its slides stand here |
|
|
125
125
|
| `slides[].hidden` | `true`: left out when presenting and exporting; a block's: a list of its slides' ids |
|
|
126
126
|
| `slides[].shapes` | Its shapes by name: what it changes of its layout's placeholders, and its own |
|
|
127
|
+
| `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) |
|
|
127
128
|
|
|
128
|
-
A shape there changes a placeholder of the slide's layout (or a generated shape) with `frame` (`{ x, y, w, h }` in points), `text` (`size` in points, `bold`, `color`, `font`, a family, `align`: `l`, `ctr`, `r`, `just`,
|
|
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.
|
|
129
130
|
|
|
130
131
|
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:
|
|
131
132
|
|
|
@@ -144,7 +145,7 @@ A video on a slide plays from when its shape comes on, to its end, when presenti
|
|
|
144
145
|
|
|
145
146
|
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`.
|
|
146
147
|
|
|
147
|
-
A shape's `chart` is PowerPoint's own chart, with its numbers in a workbook a person opens with Edit Data. `type` is python-pptx's, in lower case: `column-clustered`, `column-stacked`, `column-stacked-100`, the same three of `bar`, `line`, `line-markers`, `area`, `area-stacked`, `area-stacked-100`, `pie`, `doughnut
|
|
148
|
+
A shape's `chart` is PowerPoint's own chart, with its numbers in a workbook a person opens with Edit Data. `type` is python-pptx's, in lower case: `column-clustered`, `column-stacked`, `column-stacked-100`, the same three of `bar`, `line`, `line-markers`, `area`, `area-stacked`, `area-stacked-100`, `pie`, `doughnut`, and XY's `scatter`, `scatter-lines` and `scatter-smooth`, each series with an `x` beside its `values`, or with `data`, `categories` naming the column across. There is no 3D, bubble, radar or second axis. Its numbers are written in it, or read from a project file, so a slide shows what the sheet says:
|
|
148
149
|
|
|
149
150
|
```yaml
|
|
150
151
|
revenue:
|
|
@@ -171,29 +172,32 @@ Without `data`, `categories` is a list of names and each series has its `values`
|
|
|
171
172
|
| `size`, `title_size`, `color` | 12, 14.4, `dk1` | Its text's points, its title's, and their colour |
|
|
172
173
|
| a series' `color`, `format`, `smooth`, `line_width`, `marker_size` | the accents in turn, `General`, off, 2.25, 5 | |
|
|
173
174
|
|
|
174
|
-
In code, `shapes.add_chart(XL_CHART_TYPE.X, left, top, width, height, chart_data)` makes one from a `CategoryChartData`, 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.
|
|
175
|
+
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.
|
|
175
176
|
|
|
176
|
-
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.
|
|
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.
|
|
177
178
|
|
|
178
179
|
## The script
|
|
179
180
|
|
|
180
|
-
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
|
|
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.
|
|
181
182
|
|
|
182
183
|
## What a person changes in the editor
|
|
183
184
|
|
|
184
|
-
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, the
|
|
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.
|
|
185
186
|
|
|
186
187
|
## Importing a PowerPoint file
|
|
187
188
|
|
|
188
|
-
`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
|
|
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.
|
|
190
|
+
|
|
191
|
+
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.
|
|
189
192
|
|
|
190
193
|
## Measuring a deck
|
|
191
194
|
|
|
192
|
-
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
|
|
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:
|
|
193
196
|
|
|
194
197
|
- `text-overflow`: a shape's text past its box, by its lines' glyphs.
|
|
198
|
+
- `text-off-slide`: a shape's text the slide's edge cuts, how far and the share outside.
|
|
195
199
|
- `shape-off-slide`, `shape-overlap`, `shape-hidden`: a shape past the slide's edge, two over each other (what shows of each: a filled shape or a picture whole, a text's glyphs), one covered whole.
|
|
196
|
-
- `near-alignment`: edges and centres of two shapes, or of a shape and the slide's centre, nearly in line and not (`allyhub inspect layout --within <pt>`).
|
|
200
|
+
- `near-alignment`: edges and centres of two shapes, or of a shape and the slide's centre, nearly in line and not: where each line is, whether it is a frame or a text's glyphs, and the frame's `x` or `y` that aligns them (`allyhub inspect layout --within <pt>`).
|
|
197
201
|
- `placement-drift`: a shape of one name at different places on slides of one layout (`--drift <pt>`).
|
|
198
202
|
- `type-in-use`, `read-size`, `words-on-slide`: the sizes and weights in use, each text's size on a phone (with `--room`, on a room's screen too), the words on each slide.
|
|
199
203
|
- `picture-resolution`: a picture drawn larger than its pixels, or stretched.
|
|
@@ -206,7 +210,7 @@ The check measures every slide as the stage draws it, and `allyhub inspect` list
|
|
|
206
210
|
|
|
207
211
|
| Type | What it is |
|
|
208
212
|
| ------------------- | --------------------------------------------------------- |
|
|
209
|
-
| `pdf` (the default) | A page per slide, the slide's size, the text kept as text |
|
|
213
|
+
| `pdf` (the default) | A page per slide, the slide's size, the text kept as text and a link a link; titled as the deck, an outline entry per slide by its title; the same bytes every time (no date in it unless `SOURCE_DATE_EPOCH` is set) |
|
|
210
214
|
| `png` | A picture per slide, numbered from 1 |
|
|
211
215
|
| `pptx` | PowerPoint's own file: the deck's theme, masters with their text styles, layouts with their placeholders, each slide's placeholders, text, shapes, pictures, videos and notes, editable as any deck. A component (or a coded video) is a picture of it as drawn. `--param pptx=picture` makes each slide a picture instead |
|
|
212
216
|
|
package/docs/sound.md
CHANGED
|
@@ -68,7 +68,7 @@ A path written as a string (the music's file, a sound's) is relative to the modu
|
|
|
68
68
|
|
|
69
69
|
- `file`: the music, or one per language (`{ en: a, "zh-cn": b }`); a language without an entry has none.
|
|
70
70
|
- `from`: where in the file it starts, seconds; default 0.
|
|
71
|
-
- `play`: stretches of the file, `[{ from, to }]`, back to back; each place in seconds, `{ beat: n }` or `{ bar: n }
|
|
71
|
+
- `play`: stretches of the file, `[{ from, to }]`, back to back; each place in seconds, `{ beat: n }` or `{ bar: n }`, and no `to` runs to the file's end. The film moves on by each stretch's exact length, so stretches cut on the beat keep the beat. Default the file from `from` to its end.
|
|
72
72
|
- `loop`: `true` plays the whole file again and again, each seam crossed over 0.25 s; `{ from, to }` plays that stretch again and again after `play`. Default false: it plays once.
|
|
73
73
|
- `seam`: each seam's equal-power cross-fade, seconds, before the join, so a downbeat there is heard whole; default 0.03 (0.25 with `loop: true`).
|
|
74
74
|
- `bpm`: beats per minute, for `snap`, beats and bars; default the tempo the build measured.
|
package/docs/websites.md
ADDED
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# Websites
|
|
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`.
|
|
4
|
+
|
|
5
|
+
```json
|
|
6
|
+
{
|
|
7
|
+
"$schema": "https://allyhub.com/schemas/website.schema.json",
|
|
8
|
+
"dev": "astro dev --port $PORT --host $HOST --ignore-lock",
|
|
9
|
+
"build": "astro build",
|
|
10
|
+
"output": "dist"
|
|
11
|
+
}
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
| Field | Required | What |
|
|
15
|
+
| --- | --- | --- |
|
|
16
|
+
| `dev` | no | The command that serves the website while it is made, run by a shell in the website's folder. None: `output` is served as it is |
|
|
17
|
+
| `build` | no | The command that builds it into `output`. None: it is not built |
|
|
18
|
+
| `output` | yes | The built website's folder, from the website's folder; `.` for a site of plain files |
|
|
19
|
+
|
|
20
|
+
## Previewing
|
|
21
|
+
|
|
22
|
+
Studio runs `dev` by a shell in the website's folder, with its `node_modules/.bin` on the PATH as `npm run` does (after `npm install`, when it has a `package.json` and no `node_modules`), with these variables set, and shows the page it serves:
|
|
23
|
+
|
|
24
|
+
| Variable | What |
|
|
25
|
+
| --- | --- |
|
|
26
|
+
| `PORT` | The port to listen on. A dev server that listens elsewhere is never reached |
|
|
27
|
+
| `HOST` | `127.0.0.1`, the address to listen on (a server on `localhost` may listen on `::1` alone) |
|
|
28
|
+
| `ALLYHUB_PREVIEW_HOSTS` | The hosts a request may name, comma-separated: in a cloud Studio, the sandbox's and the gateway's for that port. A dev server that checks the `Host` header must allow them (Next.js: `allowedDevOrigins`) |
|
|
29
|
+
| `__VITE_ADDITIONAL_SERVER_ALLOWED_HOSTS` | The same hosts, as Vite reads them: Vite's and every framework on it (Astro, SvelteKit, Nuxt, VitePress) allow them with no configuration |
|
|
30
|
+
|
|
31
|
+
`dev` must use `$PORT` and `$HOST` itself, as Vercel's development command uses `$PORT`: AllyHub adds no arguments of its own, since each framework names them differently. Studio's server runs beside any you start yourself in the same folder: a dev server that refuses to start beside another must be told to (Astro's `--ignore-lock`).
|
|
32
|
+
|
|
33
|
+
## Videos and stills in a page
|
|
34
|
+
|
|
35
|
+
A page shows a project's video as any page shows a video: from its files. `allyhub render launch/film --type mp4,vtt,cover --out site/public --name film` makes them (the video, its WebVTT captions, its poster) in the website's public folder and prints where each went; the page uses `<video>` with a `<track>`, or any player. Render again when the video changes.
|
|
36
|
+
|
|
37
|
+
## Checking and building
|
|
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>`.
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
## Hosting on AllyHub
|
|
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.
|
|
45
|
+
|
|
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 Update in Studio. A site's first publish is always confirmed in their browser. Taking a site offline is theirs alone, in Studio.
|
|
47
|
+
|
|
48
|
+
A hosted site is static files, `index.html` at the root of `output`:
|
|
49
|
+
|
|
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.
|
|
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.
|
|
53
|
+
- A file is at most 1 GiB, a version 20,000 files and 5 GiB. `Range` works, so video plays from a page.
|
|
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
|
+
- A site stays out of search engines until the person allows it.
|
|
56
|
+
|
|
57
|
+
`build` is the website's own; its `output` is a standard static folder that deploys anywhere (Vercel, Netlify, Cloudflare). Check it with the industry's tools: lychee for links, Lighthouse CI for search, accessibility and performance, and the framework's own check.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@allyhub/sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0",
|
|
4
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.",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
6
6
|
"homepage": "https://allyhub.com",
|
|
@@ -52,12 +52,14 @@
|
|
|
52
52
|
"dependencies": {
|
|
53
53
|
"@formulajs/formulajs": "4.6.1",
|
|
54
54
|
"dequal": "2.0.3",
|
|
55
|
+
"diff": "9.0.0",
|
|
55
56
|
"env-paths": "4.0.0",
|
|
56
57
|
"fast-xml-parser": "^5.11.2",
|
|
57
58
|
"fflate": "^0.8.3",
|
|
58
59
|
"jsonc-parser": "^3.3.1",
|
|
59
60
|
"numfmt": "4.1.1",
|
|
60
61
|
"proper-lockfile": "4.1.2",
|
|
62
|
+
"saxes": "^6.0.0",
|
|
61
63
|
"tar": "^7.5.2",
|
|
62
64
|
"yaml": "^2.9.1",
|
|
63
65
|
"yauzl": "^3.2.0",
|