@sitecoreai-labs/sitecoreai-cli 0.0.4
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/AGENTS.md +67 -0
- package/LICENSE +21 -0
- package/README.md +357 -0
- package/bin/sitecoreai-cli +3 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +358 -0
- package/dist/commands/config.d.ts +3 -0
- package/dist/commands/config.d.ts.map +1 -0
- package/dist/commands/config.js +27 -0
- package/dist/commands/deploy/deployments.d.ts +3 -0
- package/dist/commands/deploy/deployments.d.ts.map +1 -0
- package/dist/commands/deploy/deployments.js +58 -0
- package/dist/commands/deploy/editing-host.d.ts +3 -0
- package/dist/commands/deploy/editing-host.d.ts.map +1 -0
- package/dist/commands/deploy/editing-host.js +49 -0
- package/dist/commands/deploy/environments/deployments.d.ts +3 -0
- package/dist/commands/deploy/environments/deployments.d.ts.map +1 -0
- package/dist/commands/deploy/environments/deployments.js +28 -0
- package/dist/commands/deploy/environments/index.d.ts +3 -0
- package/dist/commands/deploy/environments/index.d.ts.map +1 -0
- package/dist/commands/deploy/environments/index.js +29 -0
- package/dist/commands/deploy/environments/mutations.d.ts +9 -0
- package/dist/commands/deploy/environments/mutations.d.ts.map +1 -0
- package/dist/commands/deploy/environments/mutations.js +103 -0
- package/dist/commands/deploy/environments/queries.d.ts +7 -0
- package/dist/commands/deploy/environments/queries.d.ts.map +1 -0
- package/dist/commands/deploy/environments/queries.js +56 -0
- package/dist/commands/deploy/environments/variables.d.ts +3 -0
- package/dist/commands/deploy/environments/variables.d.ts.map +1 -0
- package/dist/commands/deploy/environments/variables.js +40 -0
- package/dist/commands/deploy/environments.d.ts +2 -0
- package/dist/commands/deploy/environments.d.ts.map +1 -0
- package/dist/commands/deploy/environments.js +17 -0
- package/dist/commands/deploy/index.d.ts +3 -0
- package/dist/commands/deploy/index.d.ts.map +1 -0
- package/dist/commands/deploy/index.js +26 -0
- package/dist/commands/deploy/logs.d.ts +3 -0
- package/dist/commands/deploy/logs.d.ts.map +1 -0
- package/dist/commands/deploy/logs.js +39 -0
- package/dist/commands/deploy/organizations.d.ts +3 -0
- package/dist/commands/deploy/organizations.d.ts.map +1 -0
- package/dist/commands/deploy/organizations.js +29 -0
- package/dist/commands/deploy/projects.d.ts +3 -0
- package/dist/commands/deploy/projects.d.ts.map +1 -0
- package/dist/commands/deploy/projects.js +74 -0
- package/dist/commands/deploy/shared.d.ts +3 -0
- package/dist/commands/deploy/shared.d.ts.map +1 -0
- package/dist/commands/deploy/shared.js +12 -0
- package/dist/commands/deploy/site.d.ts +10 -0
- package/dist/commands/deploy/site.d.ts.map +1 -0
- package/dist/commands/deploy/site.js +36 -0
- package/dist/commands/deploy/source-control.d.ts +3 -0
- package/dist/commands/deploy/source-control.d.ts.map +1 -0
- package/dist/commands/deploy/source-control.js +89 -0
- package/dist/commands/deploy.d.ts +2 -0
- package/dist/commands/deploy.d.ts.map +1 -0
- package/dist/commands/deploy.js +5 -0
- package/dist/commands/history.d.ts +3 -0
- package/dist/commands/history.d.ts.map +1 -0
- package/dist/commands/history.js +88 -0
- package/dist/commands/init.d.ts +3 -0
- package/dist/commands/init.d.ts.map +1 -0
- package/dist/commands/init.js +32 -0
- package/dist/commands/login.d.ts +3 -0
- package/dist/commands/login.d.ts.map +1 -0
- package/dist/commands/login.js +21 -0
- package/dist/commands/logout.d.ts +3 -0
- package/dist/commands/logout.d.ts.map +1 -0
- package/dist/commands/logout.js +18 -0
- package/dist/commands/recipe/index.d.ts +3 -0
- package/dist/commands/recipe/index.d.ts.map +1 -0
- package/dist/commands/recipe/index.js +158 -0
- package/dist/commands/serialization/index.d.ts +3 -0
- package/dist/commands/serialization/index.d.ts.map +1 -0
- package/dist/commands/serialization/index.js +89 -0
- package/dist/commands/serialization/package.d.ts +3 -0
- package/dist/commands/serialization/package.d.ts.map +1 -0
- package/dist/commands/serialization/package.js +36 -0
- package/dist/commands/shared.d.ts +21 -0
- package/dist/commands/shared.d.ts.map +1 -0
- package/dist/commands/shared.js +82 -0
- package/dist/commands/shell.d.ts +10 -0
- package/dist/commands/shell.d.ts.map +1 -0
- package/dist/commands/shell.js +155 -0
- package/dist/commands/status.d.ts +3 -0
- package/dist/commands/status.d.ts.map +1 -0
- package/dist/commands/status.js +15 -0
- package/dist/commands/telemetry.d.ts +3 -0
- package/dist/commands/telemetry.d.ts.map +1 -0
- package/dist/commands/telemetry.js +28 -0
- package/dist/config/env-overrides.d.ts +4 -0
- package/dist/config/env-overrides.d.ts.map +1 -0
- package/dist/config/env-overrides.js +199 -0
- package/dist/config/index.d.ts +5 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +13 -0
- package/dist/config/modules.d.ts +4 -0
- package/dist/config/modules.d.ts.map +1 -0
- package/dist/config/modules.js +152 -0
- package/dist/config/paths.d.ts +2 -0
- package/dist/config/paths.d.ts.map +1 -0
- package/dist/config/paths.js +39 -0
- package/dist/config/root-config.d.ts +10 -0
- package/dist/config/root-config.d.ts.map +1 -0
- package/dist/config/root-config.js +159 -0
- package/dist/config/schema.json +278 -0
- package/dist/config/serialization-module.schema.json +127 -0
- package/dist/config/telemetry.schema.json +21 -0
- package/dist/config/types.d.ts +245 -0
- package/dist/config/types.d.ts.map +1 -0
- package/dist/config/types.js +19 -0
- package/dist/config/validation.d.ts +10 -0
- package/dist/config/validation.d.ts.map +1 -0
- package/dist/config/validation.js +43 -0
- package/dist/deploy/api/common/headers.d.ts +2 -0
- package/dist/deploy/api/common/headers.d.ts.map +1 -0
- package/dist/deploy/api/common/headers.js +10 -0
- package/dist/deploy/api/common/index.d.ts +4 -0
- package/dist/deploy/api/common/index.d.ts.map +1 -0
- package/dist/deploy/api/common/index.js +19 -0
- package/dist/deploy/api/common/request.d.ts +9 -0
- package/dist/deploy/api/common/request.d.ts.map +1 -0
- package/dist/deploy/api/common/request.js +253 -0
- package/dist/deploy/api/common/types.d.ts +44 -0
- package/dist/deploy/api/common/types.d.ts.map +1 -0
- package/dist/deploy/api/common/types.js +5 -0
- package/dist/deploy/api/common.d.ts +2 -0
- package/dist/deploy/api/common.d.ts.map +1 -0
- package/dist/deploy/api/common.js +17 -0
- package/dist/deploy/api/deployment-logs.d.ts +2 -0
- package/dist/deploy/api/deployment-logs.d.ts.map +1 -0
- package/dist/deploy/api/deployment-logs.js +23 -0
- package/dist/deploy/api/deployments.d.ts +9 -0
- package/dist/deploy/api/deployments.d.ts.map +1 -0
- package/dist/deploy/api/deployments.js +61 -0
- package/dist/deploy/api/environments.d.ts +21 -0
- package/dist/deploy/api/environments.d.ts.map +1 -0
- package/dist/deploy/api/environments.js +67 -0
- package/dist/deploy/api/index.d.ts +9 -0
- package/dist/deploy/api/index.d.ts.map +1 -0
- package/dist/deploy/api/index.js +24 -0
- package/dist/deploy/api/logs.d.ts +8 -0
- package/dist/deploy/api/logs.d.ts.map +1 -0
- package/dist/deploy/api/logs.js +29 -0
- package/dist/deploy/api/organizations.d.ts +6 -0
- package/dist/deploy/api/organizations.d.ts.map +1 -0
- package/dist/deploy/api/organizations.js +18 -0
- package/dist/deploy/api/projects.d.ts +13 -0
- package/dist/deploy/api/projects.d.ts.map +1 -0
- package/dist/deploy/api/projects.js +42 -0
- package/dist/deploy/api/source-control.d.ts +15 -0
- package/dist/deploy/api/source-control.d.ts.map +1 -0
- package/dist/deploy/api/source-control.js +71 -0
- package/dist/deploy/api.d.ts +2 -0
- package/dist/deploy/api.d.ts.map +1 -0
- package/dist/deploy/api.js +17 -0
- package/dist/deploy/tasks/deployment-result.d.ts +6 -0
- package/dist/deploy/tasks/deployment-result.d.ts.map +1 -0
- package/dist/deploy/tasks/deployment-result.js +36 -0
- package/dist/deploy/tasks/deployments.d.ts +10 -0
- package/dist/deploy/tasks/deployments.d.ts.map +1 -0
- package/dist/deploy/tasks/deployments.js +201 -0
- package/dist/deploy/tasks/editing-host.d.ts +28 -0
- package/dist/deploy/tasks/editing-host.d.ts.map +1 -0
- package/dist/deploy/tasks/editing-host.js +216 -0
- package/dist/deploy/tasks/environments.d.ts +20 -0
- package/dist/deploy/tasks/environments.d.ts.map +1 -0
- package/dist/deploy/tasks/environments.js +364 -0
- package/dist/deploy/tasks/index.d.ts +10 -0
- package/dist/deploy/tasks/index.d.ts.map +1 -0
- package/dist/deploy/tasks/index.js +25 -0
- package/dist/deploy/tasks/logs.d.ts +5 -0
- package/dist/deploy/tasks/logs.d.ts.map +1 -0
- package/dist/deploy/tasks/logs.js +56 -0
- package/dist/deploy/tasks/organizations.d.ts +6 -0
- package/dist/deploy/tasks/organizations.d.ts.map +1 -0
- package/dist/deploy/tasks/organizations.js +51 -0
- package/dist/deploy/tasks/projects.d.ts +11 -0
- package/dist/deploy/tasks/projects.d.ts.map +1 -0
- package/dist/deploy/tasks/projects.js +246 -0
- package/dist/deploy/tasks/shared.d.ts +63 -0
- package/dist/deploy/tasks/shared.d.ts.map +1 -0
- package/dist/deploy/tasks/shared.js +261 -0
- package/dist/deploy/tasks/site-bind.d.ts +21 -0
- package/dist/deploy/tasks/site-bind.d.ts.map +1 -0
- package/dist/deploy/tasks/site-bind.js +142 -0
- package/dist/deploy/tasks/site.d.ts +14 -0
- package/dist/deploy/tasks/site.d.ts.map +1 -0
- package/dist/deploy/tasks/site.js +29 -0
- package/dist/deploy/tasks/source-control.d.ts +14 -0
- package/dist/deploy/tasks/source-control.d.ts.map +1 -0
- package/dist/deploy/tasks/source-control.js +173 -0
- package/dist/deploy/tasks/types.d.ts +204 -0
- package/dist/deploy/tasks/types.d.ts.map +1 -0
- package/dist/deploy/tasks/types.js +7 -0
- package/dist/deploy/tasks.d.ts +3 -0
- package/dist/deploy/tasks.d.ts.map +1 -0
- package/dist/deploy/tasks.js +18 -0
- package/dist/recipe/api/auth.d.ts +9 -0
- package/dist/recipe/api/auth.d.ts.map +1 -0
- package/dist/recipe/api/auth.js +12 -0
- package/dist/recipe/api/authoring-client.d.ts +37 -0
- package/dist/recipe/api/authoring-client.d.ts.map +1 -0
- package/dist/recipe/api/authoring-client.js +495 -0
- package/dist/recipe/api/client.d.ts +99 -0
- package/dist/recipe/api/client.d.ts.map +1 -0
- package/dist/recipe/api/client.js +17 -0
- package/dist/recipe/api/graphql.d.ts +15 -0
- package/dist/recipe/api/graphql.d.ts.map +1 -0
- package/dist/recipe/api/graphql.js +38 -0
- package/dist/recipe/api/ref-encoding.d.ts +38 -0
- package/dist/recipe/api/ref-encoding.d.ts.map +1 -0
- package/dist/recipe/api/ref-encoding.js +160 -0
- package/dist/recipe/api/site-discovery.d.ts +49 -0
- package/dist/recipe/api/site-discovery.d.ts.map +1 -0
- package/dist/recipe/api/site-discovery.js +127 -0
- package/dist/recipe/api/sites-client.d.ts +48 -0
- package/dist/recipe/api/sites-client.d.ts.map +1 -0
- package/dist/recipe/api/sites-client.js +19 -0
- package/dist/recipe/cache.d.ts +36 -0
- package/dist/recipe/cache.d.ts.map +1 -0
- package/dist/recipe/cache.js +114 -0
- package/dist/recipe/compile/component-section.d.ts +46 -0
- package/dist/recipe/compile/component-section.d.ts.map +1 -0
- package/dist/recipe/compile/component-section.js +143 -0
- package/dist/recipe/compile/component-template.d.ts +34 -0
- package/dist/recipe/compile/component-template.d.ts.map +1 -0
- package/dist/recipe/compile/component-template.js +709 -0
- package/dist/recipe/compile/content-item.d.ts +31 -0
- package/dist/recipe/compile/content-item.d.ts.map +1 -0
- package/dist/recipe/compile/content-item.js +189 -0
- package/dist/recipe/compile/content-template.d.ts +18 -0
- package/dist/recipe/compile/content-template.d.ts.map +1 -0
- package/dist/recipe/compile/content-template.js +52 -0
- package/dist/recipe/compile/enumeration.d.ts +59 -0
- package/dist/recipe/compile/enumeration.d.ts.map +1 -0
- package/dist/recipe/compile/enumeration.js +236 -0
- package/dist/recipe/compile/page-design.d.ts +22 -0
- package/dist/recipe/compile/page-design.d.ts.map +1 -0
- package/dist/recipe/compile/page-design.js +93 -0
- package/dist/recipe/compile/parameters-template.d.ts +14 -0
- package/dist/recipe/compile/parameters-template.d.ts.map +1 -0
- package/dist/recipe/compile/parameters-template.js +92 -0
- package/dist/recipe/compile/partial-design.d.ts +18 -0
- package/dist/recipe/compile/partial-design.d.ts.map +1 -0
- package/dist/recipe/compile/partial-design.js +76 -0
- package/dist/recipe/compile/section-definition.d.ts +18 -0
- package/dist/recipe/compile/section-definition.d.ts.map +1 -0
- package/dist/recipe/compile/section-definition.js +26 -0
- package/dist/recipe/compile/shared.d.ts +442 -0
- package/dist/recipe/compile/shared.d.ts.map +1 -0
- package/dist/recipe/compile/shared.js +843 -0
- package/dist/recipe/compile/site-template.d.ts +52 -0
- package/dist/recipe/compile/site-template.d.ts.map +1 -0
- package/dist/recipe/compile/site-template.js +140 -0
- package/dist/recipe/compile/site.d.ts +44 -0
- package/dist/recipe/compile/site.d.ts.map +1 -0
- package/dist/recipe/compile/site.js +127 -0
- package/dist/recipe/compile.d.ts +93 -0
- package/dist/recipe/compile.d.ts.map +1 -0
- package/dist/recipe/compile.js +741 -0
- package/dist/recipe/execute.d.ts +119 -0
- package/dist/recipe/execute.d.ts.map +1 -0
- package/dist/recipe/execute.js +273 -0
- package/dist/recipe/guids.d.ts +400 -0
- package/dist/recipe/guids.d.ts.map +1 -0
- package/dist/recipe/guids.js +488 -0
- package/dist/recipe/index.d.ts +32 -0
- package/dist/recipe/index.d.ts.map +1 -0
- package/dist/recipe/index.js +156 -0
- package/dist/recipe/io.d.ts +21 -0
- package/dist/recipe/io.d.ts.map +1 -0
- package/dist/recipe/io.js +147 -0
- package/dist/recipe/ir/operations.d.ts +692 -0
- package/dist/recipe/ir/operations.d.ts.map +1 -0
- package/dist/recipe/ir/operations.js +347 -0
- package/dist/recipe/ir/sitecore-templates.d.ts +455 -0
- package/dist/recipe/ir/sitecore-templates.d.ts.map +1 -0
- package/dist/recipe/ir/sitecore-templates.js +465 -0
- package/dist/recipe/layout/emit.d.ts +101 -0
- package/dist/recipe/layout/emit.d.ts.map +1 -0
- package/dist/recipe/layout/emit.js +127 -0
- package/dist/recipe/layout/templates-mapping.d.ts +28 -0
- package/dist/recipe/layout/templates-mapping.d.ts.map +1 -0
- package/dist/recipe/layout/templates-mapping.js +29 -0
- package/dist/recipe/plan.d.ts +134 -0
- package/dist/recipe/plan.d.ts.map +1 -0
- package/dist/recipe/plan.js +565 -0
- package/dist/recipe/policy.d.ts +43 -0
- package/dist/recipe/policy.d.ts.map +1 -0
- package/dist/recipe/policy.js +75 -0
- package/dist/recipe/rollback.d.ts +72 -0
- package/dist/recipe/rollback.d.ts.map +1 -0
- package/dist/recipe/rollback.js +130 -0
- package/dist/recipe/schema/field-types.d.ts +72 -0
- package/dist/recipe/schema/field-types.d.ts.map +1 -0
- package/dist/recipe/schema/field-types.js +118 -0
- package/dist/recipe/schema/recipe.d.ts +1545 -0
- package/dist/recipe/schema/recipe.d.ts.map +1 -0
- package/dist/recipe/schema/recipe.js +1175 -0
- package/dist/recipe/schema/source-fields.d.ts +48 -0
- package/dist/recipe/schema/source-fields.d.ts.map +1 -0
- package/dist/recipe/schema/source-fields.js +79 -0
- package/dist/recipe/tasks/compile.d.ts +14 -0
- package/dist/recipe/tasks/compile.d.ts.map +1 -0
- package/dist/recipe/tasks/compile.js +89 -0
- package/dist/recipe/tasks/diff.d.ts +17 -0
- package/dist/recipe/tasks/diff.d.ts.map +1 -0
- package/dist/recipe/tasks/diff.js +6 -0
- package/dist/recipe/tasks/index.d.ts +9 -0
- package/dist/recipe/tasks/index.d.ts.map +1 -0
- package/dist/recipe/tasks/index.js +13 -0
- package/dist/recipe/tasks/placeholder-allow.d.ts +53 -0
- package/dist/recipe/tasks/placeholder-allow.d.ts.map +1 -0
- package/dist/recipe/tasks/placeholder-allow.js +218 -0
- package/dist/recipe/tasks/plan.d.ts +11 -0
- package/dist/recipe/tasks/plan.d.ts.map +1 -0
- package/dist/recipe/tasks/plan.js +72 -0
- package/dist/recipe/tasks/prune-defaults.d.ts +90 -0
- package/dist/recipe/tasks/prune-defaults.d.ts.map +1 -0
- package/dist/recipe/tasks/prune-defaults.js +184 -0
- package/dist/recipe/tasks/push.d.ts +18 -0
- package/dist/recipe/tasks/push.d.ts.map +1 -0
- package/dist/recipe/tasks/push.js +417 -0
- package/dist/recipe/tasks/shared.d.ts +152 -0
- package/dist/recipe/tasks/shared.d.ts.map +1 -0
- package/dist/recipe/tasks/shared.js +94 -0
- package/dist/recipe/validate.d.ts +103 -0
- package/dist/recipe/validate.d.ts.map +1 -0
- package/dist/recipe/validate.js +297 -0
- package/dist/serialization/commands.d.ts +48 -0
- package/dist/serialization/commands.d.ts.map +1 -0
- package/dist/serialization/commands.js +175 -0
- package/dist/serialization/compare.d.ts +29 -0
- package/dist/serialization/compare.d.ts.map +1 -0
- package/dist/serialization/compare.js +124 -0
- package/dist/serialization/field-filter.d.ts +7 -0
- package/dist/serialization/field-filter.d.ts.map +1 -0
- package/dist/serialization/field-filter.js +20 -0
- package/dist/serialization/filesystem-store/constants.d.ts +3 -0
- package/dist/serialization/filesystem-store/constants.d.ts.map +1 -0
- package/dist/serialization/filesystem-store/constants.js +5 -0
- package/dist/serialization/filesystem-store/index.d.ts +4 -0
- package/dist/serialization/filesystem-store/index.d.ts.map +1 -0
- package/dist/serialization/filesystem-store/index.js +15 -0
- package/dist/serialization/filesystem-store/items.d.ts +10 -0
- package/dist/serialization/filesystem-store/items.d.ts.map +1 -0
- package/dist/serialization/filesystem-store/items.js +64 -0
- package/dist/serialization/filesystem-store/roles.d.ts +6 -0
- package/dist/serialization/filesystem-store/roles.d.ts.map +1 -0
- package/dist/serialization/filesystem-store/roles.js +46 -0
- package/dist/serialization/filesystem-store/users.d.ts +6 -0
- package/dist/serialization/filesystem-store/users.d.ts.map +1 -0
- package/dist/serialization/filesystem-store/users.js +46 -0
- package/dist/serialization/filesystem-store/utils.d.ts +2 -0
- package/dist/serialization/filesystem-store/utils.d.ts.map +1 -0
- package/dist/serialization/filesystem-store/utils.js +17 -0
- package/dist/serialization/filesystem-store.d.ts +2 -0
- package/dist/serialization/filesystem-store.d.ts.map +1 -0
- package/dist/serialization/filesystem-store.js +17 -0
- package/dist/serialization/item-path.d.ts +32 -0
- package/dist/serialization/item-path.d.ts.map +1 -0
- package/dist/serialization/item-path.js +123 -0
- package/dist/serialization/path-provider.d.ts +12 -0
- package/dist/serialization/path-provider.d.ts.map +1 -0
- package/dist/serialization/path-provider.js +271 -0
- package/dist/serialization/signature.d.ts +4 -0
- package/dist/serialization/signature.d.ts.map +1 -0
- package/dist/serialization/signature.js +71 -0
- package/dist/serialization/sitecore-api/auth.d.ts +31 -0
- package/dist/serialization/sitecore-api/auth.d.ts.map +1 -0
- package/dist/serialization/sitecore-api/auth.js +319 -0
- package/dist/serialization/sitecore-api/graphql.d.ts +12 -0
- package/dist/serialization/sitecore-api/graphql.d.ts.map +1 -0
- package/dist/serialization/sitecore-api/graphql.js +20 -0
- package/dist/serialization/sitecore-api/history.d.ts +9 -0
- package/dist/serialization/sitecore-api/history.d.ts.map +1 -0
- package/dist/serialization/sitecore-api/history.js +36 -0
- package/dist/serialization/sitecore-api/index.d.ts +7 -0
- package/dist/serialization/sitecore-api/index.d.ts.map +1 -0
- package/dist/serialization/sitecore-api/index.js +22 -0
- package/dist/serialization/sitecore-api/items.d.ts +8 -0
- package/dist/serialization/sitecore-api/items.d.ts.map +1 -0
- package/dist/serialization/sitecore-api/items.js +132 -0
- package/dist/serialization/sitecore-api/publish.d.ts +14 -0
- package/dist/serialization/sitecore-api/publish.d.ts.map +1 -0
- package/dist/serialization/sitecore-api/publish.js +43 -0
- package/dist/serialization/sitecore-api/roles.d.ts +9 -0
- package/dist/serialization/sitecore-api/roles.d.ts.map +1 -0
- package/dist/serialization/sitecore-api/roles.js +42 -0
- package/dist/serialization/sitecore-api/users.d.ts +9 -0
- package/dist/serialization/sitecore-api/users.d.ts.map +1 -0
- package/dist/serialization/sitecore-api/users.js +62 -0
- package/dist/serialization/sitecore-api.d.ts +2 -0
- package/dist/serialization/sitecore-api.d.ts.map +1 -0
- package/dist/serialization/sitecore-api.js +17 -0
- package/dist/serialization/tasks/diff.d.ts +3 -0
- package/dist/serialization/tasks/diff.d.ts.map +1 -0
- package/dist/serialization/tasks/diff.js +109 -0
- package/dist/serialization/tasks/env/constants.d.ts +2 -0
- package/dist/serialization/tasks/env/constants.d.ts.map +1 -0
- package/dist/serialization/tasks/env/constants.js +4 -0
- package/dist/serialization/tasks/env/deploy-token.d.ts +3 -0
- package/dist/serialization/tasks/env/deploy-token.d.ts.map +1 -0
- package/dist/serialization/tasks/env/deploy-token.js +128 -0
- package/dist/serialization/tasks/env/index.d.ts +5 -0
- package/dist/serialization/tasks/env/index.d.ts.map +1 -0
- package/dist/serialization/tasks/env/index.js +11 -0
- package/dist/serialization/tasks/env/init/auth.d.ts +24 -0
- package/dist/serialization/tasks/env/init/auth.d.ts.map +1 -0
- package/dist/serialization/tasks/env/init/auth.js +122 -0
- package/dist/serialization/tasks/env/init/deploy-lookup.d.ts +22 -0
- package/dist/serialization/tasks/env/init/deploy-lookup.d.ts.map +1 -0
- package/dist/serialization/tasks/env/init/deploy-lookup.js +244 -0
- package/dist/serialization/tasks/env/init.d.ts +3 -0
- package/dist/serialization/tasks/env/init.d.ts.map +1 -0
- package/dist/serialization/tasks/env/init.js +253 -0
- package/dist/serialization/tasks/env/logout.d.ts +3 -0
- package/dist/serialization/tasks/env/logout.d.ts.map +1 -0
- package/dist/serialization/tasks/env/logout.js +61 -0
- package/dist/serialization/tasks/env/status.d.ts +3 -0
- package/dist/serialization/tasks/env/status.d.ts.map +1 -0
- package/dist/serialization/tasks/env/status.js +149 -0
- package/dist/serialization/tasks/env.d.ts +2 -0
- package/dist/serialization/tasks/env.d.ts.map +1 -0
- package/dist/serialization/tasks/env.js +17 -0
- package/dist/serialization/tasks/helpers/collect.d.ts +8 -0
- package/dist/serialization/tasks/helpers/collect.d.ts.map +1 -0
- package/dist/serialization/tasks/helpers/collect.js +29 -0
- package/dist/serialization/tasks/helpers/commands.d.ts +5 -0
- package/dist/serialization/tasks/helpers/commands.d.ts.map +1 -0
- package/dist/serialization/tasks/helpers/commands.js +14 -0
- package/dist/serialization/tasks/helpers/filesystem.d.ts +6 -0
- package/dist/serialization/tasks/helpers/filesystem.d.ts.map +1 -0
- package/dist/serialization/tasks/helpers/filesystem.js +27 -0
- package/dist/serialization/tasks/helpers/index.d.ts +6 -0
- package/dist/serialization/tasks/helpers/index.d.ts.map +1 -0
- package/dist/serialization/tasks/helpers/index.js +13 -0
- package/dist/serialization/tasks/helpers/items.d.ts +3 -0
- package/dist/serialization/tasks/helpers/items.d.ts.map +1 -0
- package/dist/serialization/tasks/helpers/items.js +5 -0
- package/dist/serialization/tasks/helpers/sitecore.d.ts +5 -0
- package/dist/serialization/tasks/helpers/sitecore.d.ts.map +1 -0
- package/dist/serialization/tasks/helpers/sitecore.js +109 -0
- package/dist/serialization/tasks/helpers.d.ts +2 -0
- package/dist/serialization/tasks/helpers.d.ts.map +1 -0
- package/dist/serialization/tasks/helpers.js +17 -0
- package/dist/serialization/tasks/index.d.ts +8 -0
- package/dist/serialization/tasks/index.d.ts.map +1 -0
- package/dist/serialization/tasks/index.js +19 -0
- package/dist/serialization/tasks/info.d.ts +4 -0
- package/dist/serialization/tasks/info.d.ts.map +1 -0
- package/dist/serialization/tasks/info.js +82 -0
- package/dist/serialization/tasks/package.d.ts +4 -0
- package/dist/serialization/tasks/package.d.ts.map +1 -0
- package/dist/serialization/tasks/package.js +171 -0
- package/dist/serialization/tasks/pull.d.ts +3 -0
- package/dist/serialization/tasks/pull.d.ts.map +1 -0
- package/dist/serialization/tasks/pull.js +82 -0
- package/dist/serialization/tasks/push.d.ts +3 -0
- package/dist/serialization/tasks/push.d.ts.map +1 -0
- package/dist/serialization/tasks/push.js +101 -0
- package/dist/serialization/tasks/roles.d.ts +6 -0
- package/dist/serialization/tasks/roles.d.ts.map +1 -0
- package/dist/serialization/tasks/roles.js +103 -0
- package/dist/serialization/tasks/shared.d.ts +19 -0
- package/dist/serialization/tasks/shared.d.ts.map +1 -0
- package/dist/serialization/tasks/shared.js +59 -0
- package/dist/serialization/tasks/types.d.ts +73 -0
- package/dist/serialization/tasks/types.d.ts.map +1 -0
- package/dist/serialization/tasks/types.js +8 -0
- package/dist/serialization/tasks/users.d.ts +5 -0
- package/dist/serialization/tasks/users.d.ts.map +1 -0
- package/dist/serialization/tasks/users.js +90 -0
- package/dist/serialization/tasks/validate.d.ts +5 -0
- package/dist/serialization/tasks/validate.d.ts.map +1 -0
- package/dist/serialization/tasks/validate.js +50 -0
- package/dist/serialization/tasks/watch.d.ts +3 -0
- package/dist/serialization/tasks/watch.d.ts.map +1 -0
- package/dist/serialization/tasks/watch.js +75 -0
- package/dist/serialization/tasks.d.ts +4 -0
- package/dist/serialization/tasks.d.ts.map +1 -0
- package/dist/serialization/tasks.js +19 -0
- package/dist/serialization/tree-spec.d.ts +51 -0
- package/dist/serialization/tree-spec.d.ts.map +1 -0
- package/dist/serialization/tree-spec.js +241 -0
- package/dist/serialization/types.d.ts +75 -0
- package/dist/serialization/types.d.ts.map +1 -0
- package/dist/serialization/types.js +2 -0
- package/dist/serialization/wildcard.d.ts +3 -0
- package/dist/serialization/wildcard.d.ts.map +1 -0
- package/dist/serialization/wildcard.js +24 -0
- package/dist/serialization/yaml.d.ts +9 -0
- package/dist/serialization/yaml.d.ts.map +1 -0
- package/dist/serialization/yaml.js +307 -0
- package/dist/shared/browser.d.ts +2 -0
- package/dist/shared/browser.d.ts.map +1 -0
- package/dist/shared/browser.js +36 -0
- package/dist/shared/cli-options.d.ts +17 -0
- package/dist/shared/cli-options.d.ts.map +1 -0
- package/dist/shared/cli-options.js +8 -0
- package/dist/shared/cli-tasks.d.ts +38 -0
- package/dist/shared/cli-tasks.d.ts.map +1 -0
- package/dist/shared/cli-tasks.js +108 -0
- package/dist/shared/config-template.d.ts +23 -0
- package/dist/shared/config-template.d.ts.map +1 -0
- package/dist/shared/config-template.js +38 -0
- package/dist/shared/env.d.ts +28 -0
- package/dist/shared/env.d.ts.map +1 -0
- package/dist/shared/env.js +38 -0
- package/dist/shared/errors.d.ts +21 -0
- package/dist/shared/errors.d.ts.map +1 -0
- package/dist/shared/errors.js +59 -0
- package/dist/shared/graphql.d.ts +76 -0
- package/dist/shared/graphql.d.ts.map +1 -0
- package/dist/shared/graphql.js +222 -0
- package/dist/shared/history.d.ts +12 -0
- package/dist/shared/history.d.ts.map +1 -0
- package/dist/shared/history.js +62 -0
- package/dist/shared/keychain.d.ts +15 -0
- package/dist/shared/keychain.d.ts.map +1 -0
- package/dist/shared/keychain.js +177 -0
- package/dist/shared/logger.d.ts +24 -0
- package/dist/shared/logger.d.ts.map +1 -0
- package/dist/shared/logger.js +157 -0
- package/dist/shared/output.d.ts +7 -0
- package/dist/shared/output.d.ts.map +1 -0
- package/dist/shared/output.js +21 -0
- package/dist/shared/prompt.d.ts +5 -0
- package/dist/shared/prompt.d.ts.map +1 -0
- package/dist/shared/prompt.js +87 -0
- package/dist/shared/redact.d.ts +3 -0
- package/dist/shared/redact.d.ts.map +1 -0
- package/dist/shared/redact.js +47 -0
- package/dist/shared/spinner.d.ts +5 -0
- package/dist/shared/spinner.d.ts.map +1 -0
- package/dist/shared/spinner.js +89 -0
- package/dist/shared/style.d.ts +2 -0
- package/dist/shared/style.d.ts.map +1 -0
- package/dist/shared/style.js +61 -0
- package/dist/shared/telemetry.d.ts +21 -0
- package/dist/shared/telemetry.d.ts.map +1 -0
- package/dist/shared/telemetry.js +226 -0
- package/dist/shared/validate.d.ts +3 -0
- package/dist/shared/validate.d.ts.map +1 -0
- package/dist/shared/validate.js +32 -0
- package/dist/sites/api/collections.d.ts +25 -0
- package/dist/sites/api/collections.d.ts.map +1 -0
- package/dist/sites/api/collections.js +21 -0
- package/dist/sites/api/index.d.ts +26 -0
- package/dist/sites/api/index.d.ts.map +1 -0
- package/dist/sites/api/index.js +55 -0
- package/dist/sites/api/jobs.d.ts +31 -0
- package/dist/sites/api/jobs.d.ts.map +1 -0
- package/dist/sites/api/jobs.js +10 -0
- package/dist/sites/api/languages.d.ts +22 -0
- package/dist/sites/api/languages.d.ts.map +1 -0
- package/dist/sites/api/languages.js +18 -0
- package/dist/sites/api/request.d.ts +24 -0
- package/dist/sites/api/request.d.ts.map +1 -0
- package/dist/sites/api/request.js +99 -0
- package/dist/sites/api/sites.d.ts +53 -0
- package/dist/sites/api/sites.d.ts.map +1 -0
- package/dist/sites/api/sites.js +41 -0
- package/dist/sites/api/types.d.ts +29 -0
- package/dist/sites/api/types.d.ts.map +1 -0
- package/dist/sites/api/types.js +4 -0
- package/package.json +109 -0
|
@@ -0,0 +1,465 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* Sitecore built-in template GUIDs that recipe-emitted items conform to.
|
|
4
|
+
*
|
|
5
|
+
* Sourced from `plans/sitecore-relationships.md` (orchestrator repo) — the
|
|
6
|
+
* inventory document built from the xmcloud-starter-js Button bundle.
|
|
7
|
+
* These are baked into Sitecore and are stable across tenants.
|
|
8
|
+
*
|
|
9
|
+
* Format: lowercase hex with hyphens, no curly braces. The reference
|
|
10
|
+
* encoding (`{...}` curly form vs bare) is decided per-field at the IR
|
|
11
|
+
* executor layer.
|
|
12
|
+
*/
|
|
13
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
14
|
+
exports.ENUMERATION_ICON = exports.FOLDER_ICON = exports.DEFAULT_ICON = exports.DEFAULT_VERSION = exports.DEFAULT_LANGUAGE = exports.SECTION_DEFINITION_FIELDS = exports.DICTIONARY_ENTRY_FIELDS = exports.RENDERING_FIELDS = exports.DEFAULT_DEVICE_ID = exports.COMPOSITION_FIELDS = exports.SITE_FIELDS = exports.SITE_TEMPLATE_FIELDS = exports.LAYOUT_FIELDS = exports.TEMPLATE_FIELD_FIELDS = exports.SYSTEM_FIELDS = exports.SXA_HEADLESS_PARAMS_BASE_TEMPLATES = exports.STANDARD_TEMPLATE_ID = exports.SXA_COMPONENT_BASE_TEMPLATES = exports.PLACEHOLDER_FIELDS = exports.PLACEHOLDER_TEMPLATE_ID = exports.AVAILABLE_RENDERINGS_FIELDS = exports.SITECORE_TEMPLATES = void 0;
|
|
15
|
+
exports.SITECORE_TEMPLATES = {
|
|
16
|
+
/** Item conforms to this when it *is* a data template. */
|
|
17
|
+
TEMPLATE: "ab86861a-6030-46c5-b394-e8f99e8b87db",
|
|
18
|
+
/** Item conforms to this when it is a section within a template. */
|
|
19
|
+
TEMPLATE_SECTION: "e269fbb5-3750-427a-9149-7aa950b49301",
|
|
20
|
+
/** Item conforms to this when it is a field within a section. */
|
|
21
|
+
TEMPLATE_FIELD: "455a3e98-a627-4b40-8035-e683a0331ac7",
|
|
22
|
+
/**
|
|
23
|
+
* Item conforms to this when it is a rendering. The relationship inventory
|
|
24
|
+
* groups View Rendering and JSON Rendering under one ID; differentiation
|
|
25
|
+
* may be needed in later phases for headless-only tenants.
|
|
26
|
+
*/
|
|
27
|
+
RENDERING: "04646a89-996f-4ee7-878a-ffdbf1f0ef0d",
|
|
28
|
+
/**
|
|
29
|
+
* Sitecore Folder template. Used in Phase 1 Variants Lite for both the
|
|
30
|
+
* `<Rendering>/Variants` folder and each Variant item — bare items, no
|
|
31
|
+
* SXA-specific structure. Phase 2+ should switch to the SXA Variant
|
|
32
|
+
* Definition template once the GUID is sandbox-validated.
|
|
33
|
+
*/
|
|
34
|
+
FOLDER: "a87a00b1-e6db-45ab-8b54-636fec3b5523",
|
|
35
|
+
/**
|
|
36
|
+
* Sitecore "Template Folder" template — the conventional template for
|
|
37
|
+
* organisational folders inside the templates tree (sections,
|
|
38
|
+
* Component Folders, Presentation Parameters subfolders, Content
|
|
39
|
+
* Models groups). Distinct from the generic FOLDER above (which is
|
|
40
|
+
* what the renderings tree uses). GUID is the well-known Sitecore
|
|
41
|
+
* built-in:
|
|
42
|
+
* `/sitecore/templates/System/Templates/Template folder` →
|
|
43
|
+
* {0437FEE2-44C9-46A6-ABE9-28858D9FEE8C}.
|
|
44
|
+
*/
|
|
45
|
+
TEMPLATE_FOLDER: "0437fee2-44c9-46a6-abe9-28858d9fee8c",
|
|
46
|
+
/**
|
|
47
|
+
* SXA Partial Design item template. Items conforming to this carry
|
|
48
|
+
* SXA partial-design semantics: their layout XML is composed into
|
|
49
|
+
* page designs via the `PartialDesigns` field.
|
|
50
|
+
*
|
|
51
|
+
* Verified against sandbox tenant (`xmc-lizsitecore088b-...`) on
|
|
52
|
+
* 2026-04-30 via Authoring API introspection — the template lives at
|
|
53
|
+
* `/sitecore/templates/Foundation/JSS Experience Accelerator/Presentation/Partial Design`.
|
|
54
|
+
*/
|
|
55
|
+
PARTIAL_DESIGN: "fd2059fd-6043-4dfe-8c04-e2437ce87634",
|
|
56
|
+
/**
|
|
57
|
+
* SXA Page Design item template. Items conforming to this carry the
|
|
58
|
+
* `PartialDesigns` field (pipe-separated GUIDs) and may carry their
|
|
59
|
+
* own layout XML.
|
|
60
|
+
*
|
|
61
|
+
* Verified against sandbox tenant on 2026-04-30 via Authoring API
|
|
62
|
+
* introspection — `/sitecore/templates/Foundation/JSS Experience
|
|
63
|
+
* Accelerator/Presentation/Page Design`. The earlier documented value
|
|
64
|
+
* `1105b8f8-1d40-4278-98ff-4e8b5b262af7` was wrong (close but
|
|
65
|
+
* incorrect on the last 24 chars).
|
|
66
|
+
*/
|
|
67
|
+
PAGE_DESIGN: "1105b8f8-1e00-426b-bf1f-c840742d827b",
|
|
68
|
+
/**
|
|
69
|
+
* SXA "Solution template" — what the SXA Site Wizard treats as a
|
|
70
|
+
* Site Template. New sites are cloned from items conforming to this
|
|
71
|
+
* template; the Sites API `createSite` flow references one by ID.
|
|
72
|
+
*
|
|
73
|
+
* Verified against sandbox tenant on 2026-05-01 via Authoring API
|
|
74
|
+
* introspection. Built-in SXA Solution Templates live under
|
|
75
|
+
* `/sitecore/system/Settings/Foundation/JSS Experience Accelerator/Scaffolding/Templates`
|
|
76
|
+
* (e.g. "Empty Site"). Recipe-emitted SiteTemplates land in the same
|
|
77
|
+
* area or a tenant-specific Scaffolding/Templates folder.
|
|
78
|
+
*
|
|
79
|
+
* Note: this template's fields (Site Modules, Tenant Modules, Name,
|
|
80
|
+
* Description, Content, etc. — see SITE_TEMPLATE_FIELDS below) are
|
|
81
|
+
* about MODULE composition, not direct page-template / page-design
|
|
82
|
+
* lists. SXA's brand-shape model is module-based: a Solution template
|
|
83
|
+
* lists modules, and modules carry the actual brand structure. Our
|
|
84
|
+
* SiteTemplateRecipe schema (pageTemplates, pageDesigns,
|
|
85
|
+
* insertOptionsMatrix, templatesToDesigns, dictionary, taxonomy) does
|
|
86
|
+
* NOT map 1:1 to this — see the design-gap note in
|
|
87
|
+
* `compileSiteTemplateRecipe`'s JSDoc.
|
|
88
|
+
*/
|
|
89
|
+
SITE_TEMPLATE: "1b2dfd3b-f2f2-4f40-a75c-f6c2490919c4",
|
|
90
|
+
/**
|
|
91
|
+
* SXA `Rendering Folder` template — the conventional template for
|
|
92
|
+
* organisational folders inside the renderings tree (sections,
|
|
93
|
+
* Component Folders, Variants groupings). Distinct from the generic
|
|
94
|
+
* FOLDER template; SXA's editor UI looks for this template when
|
|
95
|
+
* walking the rendering tree.
|
|
96
|
+
*
|
|
97
|
+
* Verified against sandbox tenant `xmc-lizsitecore7e03-...` on
|
|
98
|
+
* 2026-05-02 via Authoring API introspection — every section folder
|
|
99
|
+
* under `/sitecore/layout/Renderings/Project/<site>/` conforms to
|
|
100
|
+
* this template.
|
|
101
|
+
*/
|
|
102
|
+
RENDERING_FOLDER: "7ee0975b-0698-493e-b3a2-0b2ef33d0522",
|
|
103
|
+
/**
|
|
104
|
+
* SXA `HeadlessVariantsGrouping` template — the top-level "Headless
|
|
105
|
+
* Variants" folder under a site's `Presentation/` content tree.
|
|
106
|
+
* Recipe-emitted variant trees use this for the root grouping AND
|
|
107
|
+
* any section-level groupings under it (mirrors the templates tree's
|
|
108
|
+
* section folders).
|
|
109
|
+
*
|
|
110
|
+
* Verified against sandbox tenant 2026-05-02:
|
|
111
|
+
* `/sitecore/content/<siteCollection>/<site>/Presentation/Headless Variants`
|
|
112
|
+
* conforms to this template.
|
|
113
|
+
*/
|
|
114
|
+
HEADLESS_VARIANTS_GROUPING: "da26c636-96e1-45e4-88d6-3fcec70d5699",
|
|
115
|
+
/**
|
|
116
|
+
* SXA `HeadlessVariants` template — the per-rendering folder that
|
|
117
|
+
* groups all variant definitions for a single rendering.
|
|
118
|
+
*
|
|
119
|
+
* Verified against sandbox tenant 2026-05-02:
|
|
120
|
+
* `/sitecore/content/<siteCollection>/<site>/Presentation/Headless Variants/<RenderingName>/`
|
|
121
|
+
* conforms to this template (e.g. Accordion, FeatureBanner, Promo).
|
|
122
|
+
*/
|
|
123
|
+
HEADLESS_VARIANTS: "49c111d0-6867-4798-a724-1f103166e6e9",
|
|
124
|
+
/**
|
|
125
|
+
* SXA Headless `Variant Definition` template — each individual
|
|
126
|
+
* rendering variant (e.g. `default`, `outline`, `BoxedAccordion`).
|
|
127
|
+
*
|
|
128
|
+
* Verified against sandbox tenant 2026-05-02 — every leaf item under
|
|
129
|
+
* a `HeadlessVariants` rendering folder conforms to this template.
|
|
130
|
+
* Replaces scai's earlier use of generic `FOLDER` for variant items,
|
|
131
|
+
* which left the SXA editor unable to recognise them as variants.
|
|
132
|
+
*/
|
|
133
|
+
VARIANT_DEFINITION: "4d50cdae-c2d9-4de8-b080-8f992bfb1b55",
|
|
134
|
+
/**
|
|
135
|
+
* SXA `Available Renderings Folder` — the parent grouping at
|
|
136
|
+
* `/sitecore/content/<siteCollection>/<site>/Presentation/Available Renderings`.
|
|
137
|
+
* Each child item conforms to `AVAILABLE_RENDERINGS` (below) and
|
|
138
|
+
* lists a section's renderings via the `RENDERINGS` field.
|
|
139
|
+
*
|
|
140
|
+
* Verified against sandbox tenant 2026-05-02.
|
|
141
|
+
*/
|
|
142
|
+
AVAILABLE_RENDERINGS_FOLDER: "26ec1d18-11b2-4dd9-8326-f6115f4fd7eb",
|
|
143
|
+
/**
|
|
144
|
+
* SXA `Available Renderings` — each section's whitelist of
|
|
145
|
+
* renderings the SXA editor offers when composing pages. Stores
|
|
146
|
+
* a pipe-separated list of rendering itemIds in the `RENDERINGS`
|
|
147
|
+
* field (see `AVAILABLE_RENDERINGS_FIELDS.RENDERINGS`).
|
|
148
|
+
*
|
|
149
|
+
* Verified against sandbox tenant 2026-05-02 — `Page Content`,
|
|
150
|
+
* `Forms`, `Navigation`, etc. under the site's
|
|
151
|
+
* `Presentation/Available Renderings/` all conform to this.
|
|
152
|
+
*/
|
|
153
|
+
AVAILABLE_RENDERINGS: "76da0a8d-fc7e-42b2-af1e-205b49e43f98",
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* Fields of the SXA `Available Renderings` template. The `RENDERINGS`
|
|
157
|
+
* field is a multilist whose value is a pipe-separated string of
|
|
158
|
+
* Sitecore-formatted itemIds (`{GUID}|{GUID}|{GUID}`). Each id points
|
|
159
|
+
* at a rendering item — for our recipe-set, the renderings emitted
|
|
160
|
+
* by every component-template recipe in the same `section`.
|
|
161
|
+
*
|
|
162
|
+
* Verified against sandbox tenant 2026-05-02 by introspecting the
|
|
163
|
+
* `Page Content` Available Renderings item's own field.
|
|
164
|
+
*/
|
|
165
|
+
exports.AVAILABLE_RENDERINGS_FIELDS = {
|
|
166
|
+
RENDERINGS: "715ae6c0-71c8-4744-ab4f-65362d20ad65",
|
|
167
|
+
};
|
|
168
|
+
/**
|
|
169
|
+
* Sitecore `Placeholder` template (`/sitecore/templates/System/Layout/Placeholder`).
|
|
170
|
+
* A Placeholder Settings item is the gate for "what renderings can
|
|
171
|
+
* appear in this placeholder slot". Items conforming to this template
|
|
172
|
+
* are leaves under a `Placeholder Settings Folder`; recipes target
|
|
173
|
+
* them by their `Placeholder Key` field value (e.g. `headless-main`,
|
|
174
|
+
* `sxa-footer`), not by their item name.
|
|
175
|
+
*
|
|
176
|
+
* Verified against sandbox tenant 2026-05-02 — every placeholder under
|
|
177
|
+
* `/sitecore/content/<site>/Presentation/Placeholder Settings/...`
|
|
178
|
+
* conforms to this template.
|
|
179
|
+
*/
|
|
180
|
+
exports.PLACEHOLDER_TEMPLATE_ID = "d2a6884c-04d5-4089-a64e-d27ca9d68d4c";
|
|
181
|
+
/**
|
|
182
|
+
* Fields of the Sitecore `Placeholder` template that recipes interact
|
|
183
|
+
* with:
|
|
184
|
+
*
|
|
185
|
+
* - `PLACEHOLDER_KEY` (`Placeholder Key`) — identifying string used
|
|
186
|
+
* in layout XML / page-design slot definitions. Recipe `placeholders`
|
|
187
|
+
* entries match against this value.
|
|
188
|
+
* - `ALLOWED_CONTROLS` (`Allowed Controls`) — pipe-separated multilist
|
|
189
|
+
* of rendering itemIds. Pages reads this when offering renderings
|
|
190
|
+
* for the placeholder; without our renderings on this list, the
|
|
191
|
+
* user can't add the component to the slot.
|
|
192
|
+
*
|
|
193
|
+
* Verified against sandbox tenant 2026-05-02 by introspecting
|
|
194
|
+
* `/sitecore/content/starters/e2e/Presentation/Placeholder Settings/Partial Design/Footer`.
|
|
195
|
+
*/
|
|
196
|
+
exports.PLACEHOLDER_FIELDS = {
|
|
197
|
+
PLACEHOLDER_KEY: "7256bdab-1fd2-49dd-b205-cb4873d2917c",
|
|
198
|
+
ALLOWED_CONTROLS: "e391b526-d0c5-439d-803e-17512eae6222",
|
|
199
|
+
};
|
|
200
|
+
/**
|
|
201
|
+
* SXA Foundation base templates that every component-template recipe
|
|
202
|
+
* (Phase 1 component template + standard values) must inherit so the
|
|
203
|
+
* SXA editor framework recognises the item as a component:
|
|
204
|
+
*
|
|
205
|
+
* - `_PerSiteStandardValues` ({44A022DB-56D3-419A-B43B-E27E4D8E9C41})
|
|
206
|
+
* wires the per-site standard-values mechanism.
|
|
207
|
+
* - `_HorizonDatasourceGrouping` ({D0F6BE14-2A2D-4C56-ACB5-80CAA573B8E2})
|
|
208
|
+
* exposes datasource grouping/defaults to the Pages (Horizon) editor.
|
|
209
|
+
* - `_PublishingGroupingTemplate` ({8BA7DAC6-32ED-4378-BD9E-5DA5B0F9848D})
|
|
210
|
+
* wires the publishing/release grouping that SXA editors expect.
|
|
211
|
+
*
|
|
212
|
+
* Verified by introspecting `AccordionBlock` (and other components)
|
|
213
|
+
* in tenant `xmc-lizsitecore7e03-...` on 2026-05-02. Content-template
|
|
214
|
+
* (datasource-only) recipes deliberately exclude these — they're
|
|
215
|
+
* datasource items, not full SXA components.
|
|
216
|
+
*/
|
|
217
|
+
exports.SXA_COMPONENT_BASE_TEMPLATES = [
|
|
218
|
+
"44a022db-56d3-419a-b43b-e27e4d8e9c41",
|
|
219
|
+
"d0f6be14-2a2d-4c56-acb5-80caa573b8e2",
|
|
220
|
+
"8ba7dac6-32ed-4378-bd9e-5da5b0f9848d",
|
|
221
|
+
];
|
|
222
|
+
/**
|
|
223
|
+
* Sitecore Standard Template — the implicit base of every template that
|
|
224
|
+
* doesn't declare its own `__Base template`.
|
|
225
|
+
*/
|
|
226
|
+
exports.STANDARD_TEMPLATE_ID = "1930bbeb-7805-471a-a3be-4858ac7cf696";
|
|
227
|
+
/**
|
|
228
|
+
* SXA Headless params-template bases — what every Pages-renderable
|
|
229
|
+
* rendering-parameters template must inherit so the editor recognises
|
|
230
|
+
* the template as a parameters shape and populates the rendering
|
|
231
|
+
* parameters dialog with its fields.
|
|
232
|
+
*
|
|
233
|
+
* Verified by introspecting the working `LinkList` params template in
|
|
234
|
+
* tenant `xmc-lizsitecore7e03-...` on 2026-05-03 — its `__Base templates`
|
|
235
|
+
* field carried exactly these three GUIDs:
|
|
236
|
+
*
|
|
237
|
+
* - `4247AAD4-EBDE-4994-998F-E067A51B1FE4` — `BaseRenderingParameters`
|
|
238
|
+
* at `/sitecore/templates/Foundation/JSS Experience Accelerator/
|
|
239
|
+
* Presentation/Rendering Parameters/BaseRenderingParameters`. The
|
|
240
|
+
* SXA Headless analog of vanilla Sitecore's "Standard Rendering
|
|
241
|
+
* Parameters" — chains in `IStyling`, `IComponentVariant`, and
|
|
242
|
+
* other facets the SXA editor scans for.
|
|
243
|
+
* - `44A022DB-56D3-419A-B43B-E27E4D8E9C41` — `_PerSiteStandardValues`
|
|
244
|
+
* (also part of `SXA_COMPONENT_BASE_TEMPLATES`). Wires the per-site
|
|
245
|
+
* standard-values mechanism so per-site SV inheritance works for
|
|
246
|
+
* params items too.
|
|
247
|
+
* - `3DB3EB10-F8D0-4CC9-BE26-18CE7B139EC8` — additional SXA Headless
|
|
248
|
+
* base (purpose not yet pinned, but consistently present on
|
|
249
|
+
* working SXA Headless params templates; safer to mirror than
|
|
250
|
+
* omit).
|
|
251
|
+
*
|
|
252
|
+
* Vanilla Sitecore "Standard Rendering Parameters"
|
|
253
|
+
* (`8CA06D6A-B353-44E8-BC31-B528C7306971`) is *not* used by SXA Headless
|
|
254
|
+
* — confirmed via the introspected LinkList template, which doesn't
|
|
255
|
+
* inherit it. Earlier emission attempted to use it and the params
|
|
256
|
+
* dialog stayed empty in Pages.
|
|
257
|
+
*/
|
|
258
|
+
exports.SXA_HEADLESS_PARAMS_BASE_TEMPLATES = [
|
|
259
|
+
"4247aad4-ebde-4994-998f-e067a51b1fe4",
|
|
260
|
+
"44a022db-56d3-419a-b43b-e27e4d8e9c41",
|
|
261
|
+
"3db3eb10-f8d0-4cc9-be26-18ce7b139ec8",
|
|
262
|
+
];
|
|
263
|
+
/**
|
|
264
|
+
* Stable system-field GUIDs that recipes need to write.
|
|
265
|
+
* Auto-generated metadata fields (__Created, __Updated, __Revision, __Owner)
|
|
266
|
+
* are deliberately omitted — Sitecore writes those.
|
|
267
|
+
*/
|
|
268
|
+
exports.SYSTEM_FIELDS = {
|
|
269
|
+
ICON: "06d5295c-ed2f-4a54-9bf2-26228d113318",
|
|
270
|
+
BASE_TEMPLATE: "12c33f3f-86c5-43a5-aeb4-5598cec45116",
|
|
271
|
+
STANDARD_VALUES: "f7d48a55-2158-4f02-9356-756654404f73",
|
|
272
|
+
SORT_ORDER: "ba3f86a2-4a1c-4d78-b63d-91c2779c1b5e",
|
|
273
|
+
DISPLAY_NAME: "b5e02ad9-d56f-4c41-a065-a133db87bdeb",
|
|
274
|
+
/**
|
|
275
|
+
* `__Masters` — the field that backs the CMS "Insert Options" UI.
|
|
276
|
+
* Set on the standard-values item to a pipe-separated list of allowed
|
|
277
|
+
* child template GUIDs. GUID verified against sandbox tenant
|
|
278
|
+
* (`xmc-lizsitecore088b-...`) on 2026-04-30 via Authoring API
|
|
279
|
+
* `templateField.templateFieldId` introspection.
|
|
280
|
+
*/
|
|
281
|
+
INSERT_OPTIONS: "1172f251-dad4-4efb-a329-0c63500e4f1e",
|
|
282
|
+
};
|
|
283
|
+
/** Field-definition shared fields on a Template Field item. */
|
|
284
|
+
exports.TEMPLATE_FIELD_FIELDS = {
|
|
285
|
+
TYPE: "ab162cc0-dc80-4abf-8871-998ee5d7ba32",
|
|
286
|
+
SOURCE: "1eb8ae32-e190-44a6-968d-ed904c794ebf",
|
|
287
|
+
TITLE: "19a69332-a23e-4e70-8d16-b2640cb24cc8",
|
|
288
|
+
/**
|
|
289
|
+
* `Shared` toggle on a Template Field — `"1"` makes the field's
|
|
290
|
+
* value shared across all language versions and numeric versions of
|
|
291
|
+
* any item conforming to the template. Verified against the canonical
|
|
292
|
+
* `click-click-launch/Presentation/Enumeration/Enumeration/Value`
|
|
293
|
+
* field item, where the enumeration `Value` field is shared (per-item
|
|
294
|
+
* value, not per-language). GUID is the well-known Sitecore built-in.
|
|
295
|
+
*/
|
|
296
|
+
SHARED: "be351a73-fcb0-4213-93fa-c302d8ab4f51",
|
|
297
|
+
};
|
|
298
|
+
/**
|
|
299
|
+
* Sitecore layout fields. `__Renderings` carries the shared layout
|
|
300
|
+
* (applies across all language versions); `__Final Renderings` carries
|
|
301
|
+
* the per-version final layout. Recipe-emitted partial designs and page
|
|
302
|
+
* designs write their layout XML to `__Renderings` (shared, since these
|
|
303
|
+
* are reusable design artifacts that don't vary per language version).
|
|
304
|
+
*
|
|
305
|
+
* Phase 4 page placements (PageRecipe, deferred) will write to
|
|
306
|
+
* `__Final Renderings` so authors can override per-version.
|
|
307
|
+
*/
|
|
308
|
+
exports.LAYOUT_FIELDS = {
|
|
309
|
+
RENDERINGS: "f1a1fe9e-a60c-4ddb-a3a0-bb5b29fe732e",
|
|
310
|
+
FINAL_RENDERINGS: "04bf00db-f5fb-41f7-8ab7-22408372a981",
|
|
311
|
+
};
|
|
312
|
+
/**
|
|
313
|
+
* Field GUIDs on the SXA `Solution template` (= Site Template) item.
|
|
314
|
+
* Verified against sandbox on 2026-05-01 by inspecting the built-in
|
|
315
|
+
* "Empty Site" template at `/sitecore/system/Settings/Foundation/JSS
|
|
316
|
+
* Experience Accelerator/Scaffolding/Templates/Empty Site`.
|
|
317
|
+
*
|
|
318
|
+
* `SITE_MODULES` / `TENANT_MODULES` carry pipe-separated GUIDs of
|
|
319
|
+
* *Module* items — the SXA model is "templates list modules; modules
|
|
320
|
+
* hold the brand structure." Our `SiteTemplateRecipe` schema doesn't
|
|
321
|
+
* model SXA modules yet; mapping is open work (see
|
|
322
|
+
* `compileSiteTemplateRecipe` JSDoc).
|
|
323
|
+
*
|
|
324
|
+
* `BUILT_IN_TEMPLATE` is `"1"` on the SXA-shipped templates and `"0"`
|
|
325
|
+
* on tenant-authored ones. Recipe-emitted templates set it to `"0"`.
|
|
326
|
+
*
|
|
327
|
+
* `CONTENT` is a JSON description of what the template includes
|
|
328
|
+
* ("Pages: Home", "Components: SXA", etc.) — mostly for the Sites API
|
|
329
|
+
* UI's preview pane. Recipes can leave it empty without breaking
|
|
330
|
+
* createSite.
|
|
331
|
+
*/
|
|
332
|
+
exports.SITE_TEMPLATE_FIELDS = {
|
|
333
|
+
SITE_MODULES: "c262443b-653d-461d-96c8-7cfaa0ef2b2d",
|
|
334
|
+
TENANT_MODULES: "41ac536a-923a-43f9-ac87-f3993f638125",
|
|
335
|
+
NAME: "82e64b52-0b8a-4a38-8c78-530c5493814e",
|
|
336
|
+
DESCRIPTION: "9f437e68-a84d-48ae-8ce1-a3e26c0b5e64",
|
|
337
|
+
ENABLED: "0d21f818-1938-4cd8-b0a8-a44f73d69367",
|
|
338
|
+
BUILT_IN_TEMPLATE: "a13aae24-a295-4cc3-b188-dfa59e2172a9",
|
|
339
|
+
CONTENT: "da855368-e5f2-4932-ae55-7f8b08a5a205",
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* Per-site `SiteTemplate` field on a Headless Site item — points at
|
|
343
|
+
* the SXA Site Template (Solution template) item the site was cloned
|
|
344
|
+
* from. Captured on the sandbox in 2026-05-01 introspection.
|
|
345
|
+
*/
|
|
346
|
+
exports.SITE_FIELDS = {
|
|
347
|
+
SITE_TEMPLATE: "e2bf3c8d-a12e-45f4-98d6-a37f13bcf375",
|
|
348
|
+
MODULES: "1230d2cb-4948-4d43-8a3b-b39978f6f1b3",
|
|
349
|
+
NAME: "85a7501a-86d9-4243-9075-0b727c3a6db4",
|
|
350
|
+
SITE_MEDIA_LIBRARY: "33d9005e-1f71-415f-b107-53b965c3b037",
|
|
351
|
+
SITEMAP_MEDIA_ITEMS: "2b2fe9fd-78a6-40eb-b9f9-28409d8d3700",
|
|
352
|
+
};
|
|
353
|
+
/**
|
|
354
|
+
* SXA-specific fields on partial-design and page-design items, plus the
|
|
355
|
+
* Page Designs root's templates-to-designs mapping field.
|
|
356
|
+
*
|
|
357
|
+
* Verified against sandbox tenant (`xmc-lizsitecore088b-...`) on
|
|
358
|
+
* 2026-04-30 via Authoring API introspection — both prior documented
|
|
359
|
+
* values were wrong:
|
|
360
|
+
* PARTIAL_DESIGNS: was 1f57aae2-da42-49d7-bfaa-b4c4d8398eb4
|
|
361
|
+
* TEMPLATES_MAPPING: was 1aa90e5a-4f5b-43c9-b78b-d28a5beae65a
|
|
362
|
+
*
|
|
363
|
+
* `PartialDesigns` is defined on the SXA Page Design template's base
|
|
364
|
+
* inheritance chain (section "Designing"); `TemplatesMapping` is
|
|
365
|
+
* defined on the "Page Designs" folder template (the parent item that
|
|
366
|
+
* owns the field, not on individual page-design items).
|
|
367
|
+
*/
|
|
368
|
+
exports.COMPOSITION_FIELDS = {
|
|
369
|
+
/** On a Page Design item: pipe-separated GUIDs of partial designs to inject. */
|
|
370
|
+
PARTIAL_DESIGNS: "0966b999-0d0e-4278-acc9-9da69d461fe6",
|
|
371
|
+
/** On the Page Designs root: URL-encoded {tplGuid}={designGuid}&… mapping. */
|
|
372
|
+
TEMPLATES_MAPPING: "ba1f60d6-3deb-40cc-bb61-eec772279ee1",
|
|
373
|
+
};
|
|
374
|
+
/**
|
|
375
|
+
* Sitecore Default Device — the device GUID layout XML wraps with.
|
|
376
|
+
* `<r><d id="{DEFAULT_DEVICE}">…<r .../>…</d></r>`.
|
|
377
|
+
*/
|
|
378
|
+
exports.DEFAULT_DEVICE_ID = "fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3";
|
|
379
|
+
/** Rendering-definition shared fields on a Rendering item. */
|
|
380
|
+
exports.RENDERING_FIELDS = {
|
|
381
|
+
COMPONENT_NAME: "037fe404-dd19-4bf7-8e30-4dadf68b27b0",
|
|
382
|
+
DATASOURCE_TEMPLATE: "1a7c85e5-dc0b-490d-9187-bb1dbcb4c72f",
|
|
383
|
+
DATASOURCE_LOCATION: "b5b27af1-25ef-405c-87ce-369b3a004016",
|
|
384
|
+
PARAMETERS_TEMPLATE: "a77e8568-1ab3-44f1-a664-b7c37ec7810d",
|
|
385
|
+
OPEN_PROPERTIES_AFTER_ADD: "7d8ae35f-9ed1-43b5-96a2-0a5f040d4e4e",
|
|
386
|
+
OTHER_PROPERTIES: "e829c217-5e94-4306-9c48-2634b094fdc2",
|
|
387
|
+
};
|
|
388
|
+
/**
|
|
389
|
+
* Sitecore Dictionary Entry template fields. Used by SiteRecipe's
|
|
390
|
+
* `dictionaryOverrides` — each phrase override SetFields the Phrase
|
|
391
|
+
* value on an existing `<site>/Dictionary/<phraseName>` item that
|
|
392
|
+
* SXA's Site Wizard materialises from the SiteTemplate's defaults.
|
|
393
|
+
*
|
|
394
|
+
* TODO (sandbox-verify): the PHRASE GUID below is the standard
|
|
395
|
+
* Sitecore Dictionary Entry "Phrase" field. Validate via Authoring
|
|
396
|
+
* API introspection during the first integration test push and
|
|
397
|
+
* update if the SXA-shipped Dictionary Entry template diverges.
|
|
398
|
+
*/
|
|
399
|
+
exports.DICTIONARY_ENTRY_FIELDS = {
|
|
400
|
+
/** Field ID for "Phrase" — the translated string value on a Dictionary Entry. */
|
|
401
|
+
PHRASE: "580c75a8-c01a-4580-83cb-987776ceb3af",
|
|
402
|
+
};
|
|
403
|
+
/**
|
|
404
|
+
* Available Rendering Section Definition template fields. The
|
|
405
|
+
* `AVAILABLE_RENDERINGS` field is the multi-list that gates which
|
|
406
|
+
* renderings show up in the section's group inside the Pages
|
|
407
|
+
* "Toolbox" experience. Recipe `availableIn` bindings emit
|
|
408
|
+
* `AppendToMultiList` ops against this field.
|
|
409
|
+
*
|
|
410
|
+
* TODO (sandbox-verify): the GUID below is a placeholder until we
|
|
411
|
+
* inspect an XM Cloud Headless tenant. The executor matches by
|
|
412
|
+
* `fieldName` ("Available Renderings") when the IR carries one, so
|
|
413
|
+
* the placeholder GUID is only load-bearing for ref-encoding round-
|
|
414
|
+
* trip; mismatches are tolerated. Update once verified.
|
|
415
|
+
*/
|
|
416
|
+
exports.SECTION_DEFINITION_FIELDS = {
|
|
417
|
+
AVAILABLE_RENDERINGS: "f56cab12-7f96-4a90-b0fa-e3b6f70b14db",
|
|
418
|
+
};
|
|
419
|
+
exports.DEFAULT_LANGUAGE = "en";
|
|
420
|
+
exports.DEFAULT_VERSION = 1;
|
|
421
|
+
/**
|
|
422
|
+
* Default icon for component-shaped recipe items — SXA Headless's
|
|
423
|
+
* built-in component icon. Verified against live tenant 2026-05-02:
|
|
424
|
+
* real component templates and rendering items in healthy SXA sites
|
|
425
|
+
* (e.g. `AccordionBlock`, `Accordion`) carry this value on `__Icon`.
|
|
426
|
+
*
|
|
427
|
+
* Used for: component templates, parameters templates, rendering
|
|
428
|
+
* items, and (as the fallback) any other recipe-emitted item that
|
|
429
|
+
* doesn't override.
|
|
430
|
+
*/
|
|
431
|
+
exports.DEFAULT_ICON = "office/32x32/elements3.png";
|
|
432
|
+
/**
|
|
433
|
+
* Icon for folder-shaped recipe items — Sitecore's standard folder
|
|
434
|
+
* icon. Real SXA tenants leave the icon blank on per-site folders
|
|
435
|
+
* (Components, Renderings, Variants groupings) and inherit the
|
|
436
|
+
* underlying template's icon, but recipe-emitted items don't have
|
|
437
|
+
* that template inheritance set up the same way, so we stamp this
|
|
438
|
+
* explicitly to give the SXA editor's tree a usable icon for every
|
|
439
|
+
* recipe-created folder.
|
|
440
|
+
*
|
|
441
|
+
* Applied to: Components/<section> templates folder, Component
|
|
442
|
+
* Folders bucket, Presentation Parameters bucket, renderings-tree
|
|
443
|
+
* section folder, Headless Variants section grouping, per-rendering
|
|
444
|
+
* Headless Variants folder.
|
|
445
|
+
*
|
|
446
|
+
* NOT applied to Available Renderings section items — those use the
|
|
447
|
+
* SXA `Available Renderings` template (not a Folder template), and
|
|
448
|
+
* its template-level icon shows through correctly without an explicit
|
|
449
|
+
* `__Icon` override.
|
|
450
|
+
*/
|
|
451
|
+
exports.FOLDER_ICON = "office/16x16/folder.png";
|
|
452
|
+
/**
|
|
453
|
+
* Icon stamped on the per-site `Enumerations Folder` and `Enumeration`
|
|
454
|
+
* templates emitted by `ensureEnumerationTemplates`. Matches the icon
|
|
455
|
+
* SXA Headless's OOTB Enumeration templates carry on starter sites
|
|
456
|
+
* (verified 2026-05-03 against
|
|
457
|
+
* `/sitecore/templates/Project/click-click-launch/Presentation/Enumeration`),
|
|
458
|
+
* so the SXA editor recognises enum items as enumeration entries — not
|
|
459
|
+
* generic folders — and the content tree renders the "E" key glyph.
|
|
460
|
+
*
|
|
461
|
+
* Applied at the template level, NOT on individual value items: value
|
|
462
|
+
* items conform to the per-site `Enumeration` template and inherit the
|
|
463
|
+
* icon through template-level inheritance.
|
|
464
|
+
*/
|
|
465
|
+
exports.ENUMERATION_ICON = "office/32x32/keyboard_key_e.png";
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Emit a Sitecore layout XML string from a structural `Layout` shape.
|
|
3
|
+
*
|
|
4
|
+
* Sitecore stores layout as a single XML string in the `__Renderings`
|
|
5
|
+
* (shared) or `__Final Renderings` (versioned) field on any item that
|
|
6
|
+
* holds a layout — pages, partial designs, page designs. This emitter
|
|
7
|
+
* is the single seam that turns recipe-level structural layout into
|
|
8
|
+
* that wire form. The output is deterministic given the same inputs:
|
|
9
|
+
* placement UIDs derive from the parent item ID + placeholder + index +
|
|
10
|
+
* componentHandle, so re-pushes produce identical XML.
|
|
11
|
+
*
|
|
12
|
+
* Wire format:
|
|
13
|
+
*
|
|
14
|
+
* <r xmlns:xsd="..." xmlns:xsi="...">
|
|
15
|
+
* <d id="{deviceGuid}">
|
|
16
|
+
* <r id="{renderingId}" placeh="/header" ds="{datasourceId}"
|
|
17
|
+
* par="FieldNames=default&Size=lg" uid="{placementUid}" />
|
|
18
|
+
* ...
|
|
19
|
+
* </d>
|
|
20
|
+
* </r>
|
|
21
|
+
*
|
|
22
|
+
* Recipe → wire mapping:
|
|
23
|
+
*
|
|
24
|
+
* componentHandle → id (renderingId(handle), curly-uppercase)
|
|
25
|
+
* placeholder key (dict key) → placeh
|
|
26
|
+
* datasourceRef.kind=shared → ds (contentItemId(handle), curly-uppercase)
|
|
27
|
+
* datasourceRef.kind=scoped → REJECTED for partial/page designs
|
|
28
|
+
* (no host page to resolve against)
|
|
29
|
+
* datasourceRef.kind=none → no ds attribute
|
|
30
|
+
* variant → par (FieldNames=<variant>, URL-encoded)
|
|
31
|
+
* params → par (key=value pairs, URL-encoded)
|
|
32
|
+
* (parentItemId, placeholder, index, componentHandle) → uid (uuidv5)
|
|
33
|
+
*/
|
|
34
|
+
export interface ComponentPlacementInput {
|
|
35
|
+
componentHandle: string;
|
|
36
|
+
variant?: string;
|
|
37
|
+
params?: Record<string, string>;
|
|
38
|
+
datasourceRef?: {
|
|
39
|
+
kind: "shared";
|
|
40
|
+
handle: string;
|
|
41
|
+
} | {
|
|
42
|
+
kind: "scoped";
|
|
43
|
+
slot: string;
|
|
44
|
+
} | {
|
|
45
|
+
kind: "none";
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
export interface LayoutInput {
|
|
49
|
+
placeholders: Record<string, readonly ComponentPlacementInput[]>;
|
|
50
|
+
}
|
|
51
|
+
export interface LayoutEmitContext {
|
|
52
|
+
/**
|
|
53
|
+
* The Sitecore item ID this layout will live on (partial-design or
|
|
54
|
+
* page-design item). Seeds deterministic placement UIDs.
|
|
55
|
+
*/
|
|
56
|
+
parentItemId: string;
|
|
57
|
+
/** Sitecore device GUID. Caller passes `DEFAULT_DEVICE_ID` from sitecore-templates.ts. */
|
|
58
|
+
deviceId: string;
|
|
59
|
+
/** Maps a component recipe handle to its rendering item GUID. */
|
|
60
|
+
renderingIdFor: (handle: string) => string;
|
|
61
|
+
/** Maps a content-item recipe handle to its content item GUID. */
|
|
62
|
+
contentItemIdFor: (handle: string) => string;
|
|
63
|
+
/**
|
|
64
|
+
* Whether `kind: "scoped"` datasource refs are permitted. False for
|
|
65
|
+
* partial-design and page-design layouts (they don't have a host page
|
|
66
|
+
* to resolve scoped refs against). True will be set by Phase 5
|
|
67
|
+
* `PageRecipe` compilation when scoped refs become meaningful.
|
|
68
|
+
*/
|
|
69
|
+
allowScoped: boolean;
|
|
70
|
+
/**
|
|
71
|
+
* Wire form for the emitted XML.
|
|
72
|
+
*
|
|
73
|
+
* - `"canonical"` (default) — `<r xmlns:xsd=… xmlns:xsi=…><d><r id placeh
|
|
74
|
+
* ds par uid /></d></r>`. What our recipe inputs naturally describe.
|
|
75
|
+
* Page Design items round-trip this byte-for-byte.
|
|
76
|
+
*
|
|
77
|
+
* - `"delta"` — SXA Partial Design wire form: `<r xmlns:p xmlns:s
|
|
78
|
+
* p:p="1"><d><p:da name="l"/><r uid p:before|p:after s:placeh s:ds
|
|
79
|
+
* s:id s:par /></d></r>`. The Partial Design Layout pipeline
|
|
80
|
+
* normalizes canonical input INTO this form on first write, so
|
|
81
|
+
* emitting it directly means the first push round-trips and
|
|
82
|
+
* converges in one cycle. Page Design layouts must NOT use this
|
|
83
|
+
* mode (they preserve canonical and would diverge).
|
|
84
|
+
*/
|
|
85
|
+
mode?: "canonical" | "delta";
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* Emit the layout XML for a `Layout` block. Returns an empty string
|
|
89
|
+
* when the layout has no placements — caller decides whether to write
|
|
90
|
+
* an empty `__Renderings` field or skip it.
|
|
91
|
+
*
|
|
92
|
+
* Mode selection (see `LayoutEmitContext.mode` JSDoc):
|
|
93
|
+
* - `"canonical"` (default) — what page-design items round-trip cleanly.
|
|
94
|
+
* - `"delta"` — SXA partial-design wire form so first push converges.
|
|
95
|
+
*
|
|
96
|
+
* Throws when a `kind: "scoped"` datasourceRef appears and
|
|
97
|
+
* `ctx.allowScoped` is false — partial designs and page designs reject
|
|
98
|
+
* scoped refs because they lack a host page.
|
|
99
|
+
*/
|
|
100
|
+
export declare function emitLayoutXml(layout: LayoutInput, ctx: LayoutEmitContext): string;
|
|
101
|
+
//# sourceMappingURL=emit.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"emit.d.ts","sourceRoot":"","sources":["../../../src/recipe/layout/emit.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,MAAM,WAAW,uBAAuB;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,aAAa,CAAC,EACV;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAClC;QAAE,IAAI,EAAE,QAAQ,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,GAChC;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IAC1B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,uBAAuB,EAAE,CAAC,CAAC;CAClE;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,0FAA0F;IAC1F,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;IAC3C,kEAAkE;IAClE,gBAAgB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;IAC7C;;;;;OAKG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;CAC9B;AAgFD;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,iBAAiB,GAAG,MAAM,CAYjF"}
|