uc-apx shape

Two modes:

Without —type: scans all components of the given kind in the loaded app and reports the union of all property names, block names (with dot-notation paths), and child kinds observed. Requires —app-dir.

With —type <subtype>: returns an embedded APEXlang reference template for that kind/type combination — a complete real-world example. Region references are extracted from the bundled example apps; column and page-item references are hand-curated. No app loading required. Matching is separator/case-insensitive (content-row == contentRow).

Use —list-types to see which subtypes have reference templates for a given kind. Use —json-pretty or —toon for readable output when inspecting the apexlang field.

Usage

uc-apx shape <kind> [flags]

Flags

Flag	Type	Default	Description
--list-types			List all subtypes available for the given kind
--type	string		Return the APEXlang reference template for this subtype (e.g. interactiveGrid, textField, selectList)

Global Flags

Flag	Type	Default	Description
--app-dir	string	.	Path to the APEX application directory
--json-pretty			Output in pretty-printed JSON (human-readable) instead of minified JSON
--toon			Output in TOON format (human-readable, token-efficient) instead of JSON

Examples (from help)

# Reference template for an interactive grid
  uc-apx shape region --type interactiveGrid --json-pretty

  # List available subtypes for regions
  uc-apx shape region --list-types

  # Text-field column reference
  uc-apx shape column --type textField

  # Select-list page item reference
  uc-apx shape page-item --type selectList

  # Observational union (requires --app-dir)
  uc-apx shape region
  uc-apx shape pageItem
  uc-apx shape lov
  uc-apx shape process

Example Output

Running against examples/brookstrut:

uc-apx --app-dir examples/brookstrut shape region

kind: region
instanceCount: 142
properties[2]{name,count}:
  name,142
  type,142
childKinds[8]{name,count}:
  action,4
  axis,1
  column,36
  facet,5
  filter,3
  layer,1
  savedReport,17
  series,1
blockProperties[86]{name,count}:
  accessibility.landmarkType,4
  actionsMenu.savePublicReport,12
  advanced.excludeTitleFromTranslation,5
  advanced.htmlDomId,16
  advanced.regionDisplaySelector,28
  advanced.savedReportMappingIdentifier,17
  appearance.cssClasses,6
  appearance.renderComponents,1
  appearance.template,139
  appearance.templateOptions,139
  attributes.messagesPosition,1
  chart.type,1
  chartLayout.height,1
  comments.comments,1
  componentAdvanced.stripHtml,1
  componentAppearance.breadcrumbTemplate,42
  componentAppearance.display,4
  componentAppearance.listTemplate,6
  componentAppearance.showNullValuesAs,13
  componentAppearance.template,15
  componentAppearance.templateOptions,63
  controls.options,1
  download.formats,12
  entityTitle.plural,1
  entityTitle.singular,1
  image.fileUrl,3
  layout.parentRegion,9
  layout.sequence,142
  layout.slot,142
  layout.startNewRow,1
  legend.show,1
  messages.whenMoreDataFound,14
  messages.whenNoDataFound,16
  page.borderColor,6
  page.borderWidth,6
  pageHeader.pageHeaderText,5
  pagination.entitiesPerPage,3
  pagination.initialEntitiesCount,1
  pagination.showTotalCount,1
  pagination.type,23
  performance.lazyLoading,2
  performance.maxRowsToProcess,16
  plugin-avatar.icon,3
  plugin-badge.columnWidth,1
  plugin-badge.label,4
  plugin-badge.state,1
  plugin-badge.value,4
  reportLayout.numberOfRows,9
  security.escapeSpecialChars,1
  serverSideCondition.language,1
  serverSideCondition.sqlExpression,1
  serverSideCondition.type,1
  settings.additionalCalendarViews,3
  settings.compactNosThreshold,8
  settings.currentFacetsSelector,4
  settings.description,4
  settings.displayAvatar,3
  settings.displayBadge,4
  settings.displayChartForTopNValues,5
  settings.displayColumn,3
  settings.export,2
  settings.maxEventsDay,1
  settings.miscellaneous,4
  settings.outputAs,1
  settings.overline,1
  settings.showCurrentFacets,4
  settings.startDateColumn,3
  settings.supplementalInfo,1
  settings.timeAxisType,1
  settings.title,4
  settings.viewEditLink.action,1
  settings.viewEditLink.clearCache,1
  settings.viewEditLink.items.P18_ID,1
  settings.viewEditLink.page,1
  settings.zoomAndScroll,1
  source.breadcrumb,42
  source.filteredRegion,8
  source.htmlCode,7
  source.list,6
  source.location,41
  source.plsqlCode,2
  source.plsqlFunctionBody,12
  source.sqlQuery,41
  source.type,41
  title.title,1
  toolbar.controls,1

JSON output

{
  "kind": "region",
  "instanceCount": 142,
  "properties": [
    {
      "name": "name",
      "count": 142
    },
    {
      "name": "type",
      "count": 142
    }
  ],
  "childKinds": [
    {
      "name": "action",
      "count": 4
    },
    {
      "name": "axis",
      "count": 1
    },
    {
      "name": "column",
      "count": 36
    },
    {
      "name": "facet",
      "count": 5
    },
    {
      "name": "filter",
      "count": 3
    },
    {
      "name": "layer",
      "count": 1
    },
    {
      "name": "savedReport",
      "count": 17
    },
    {
      "name": "series",
      "count": 1
    }
  ],
  "blockProperties": [
    {
      "name": "accessibility.landmarkType",
      "count": 4
    },
    {
      "name": "actionsMenu.savePublicReport",
      "count": 12
    },
    {
      "name": "advanced.excludeTitleFromTranslation",
      "count": 5
    },
    {
      "name": "advanced.htmlDomId",
      "count": 16
    },
    {
      "name": "advanced.regionDisplaySelector",
      "count": 28
    },
    {
      "name": "advanced.savedReportMappingIdentifier",
      "count": 17
    },
    {
      "name": "appearance.cssClasses",
      "count": 6
    },
    {
      "name": "appearance.renderComponents",
      "count": 1
    },
    {
      "name": "appearance.template",
      "count": 139
    },
    {
      "name": "appearance.templateOptions",
      "count": 139
    },
    {
      "name": "attributes.messagesPosition",
      "count": 1
    },
    {
      "name": "chart.type",
      "count": 1
    },
    {
      "name": "chartLayout.height",
      "count": 1
    },
    {
      "name": "comments.comments",
      "count": 1
    },
    {
      "name": "componentAdvanced.stripHtml",
      "count": 1
    },
    {
      "name": "componentAppearance.breadcrumbTemplate",
      "count": 42
    },
    {
      "name": "componentAppearance.display",
      "count": 4
    },
    {
      "name": "componentAppearance.listTemplate",
      "count": 6
    },
    {
      "name": "componentAppearance.showNullValuesAs",
      "count": 13
    },
    {
      "name": "componentAppearance.template",
      "count": 15
    },
    {
      "name": "componentAppearance.templateOptions",
      "count": 63
    },
    {
      "name": "controls.options",
      "count": 1
    },
    {
      "name": "download.formats",
      "count": 12
    },
    {
      "name": "entityTitle.plural",
      "count": 1
    },
    {
      "name": "entityTitle.singular",
      "count": 1
    },
    {
      "name": "image.fileUrl",
      "count": 3
    },
    {
      "name": "layout.parentRegion",
      "count": 9
    },
    {
      "name": "layout.sequence",
      "count": 142
    },
    {
      "name": "layout.slot",
      "count": 142
    },
    {
      "name": "layout.startNewRow",
      "count": 1
    },
    {
      "name": "legend.show",
      "count": 1
    },
    {
      "name": "messages.whenMoreDataFound",
      "count": 14
    },
    {
      "name": "messages.whenNoDataFound",
      "count": 16
    },
    {
      "name": "page.borderColor",
      "count": 6
    },
    {
      "name": "page.borderWidth",
      "count": 6
    },
    {
      "name": "pageHeader.pageHeaderText",
      "count": 5
    },
    {
      "name": "pagination.entitiesPerPage",
      "count": 3
    },
    {
      "name": "pagination.initialEntitiesCount",
      "count": 1
    },
    {
      "name": "pagination.showTotalCount",
      "count": 1
    },
    {
      "name": "pagination.type",
      "count": 23
    },
    {
      "name": "performance.lazyLoading",
      "count": 2
    },
    {
      "name": "performance.maxRowsToProcess",
      "count": 16
    },
    {
      "name": "plugin-avatar.icon",
      "count": 3
    },
    {
      "name": "plugin-badge.columnWidth",
      "count": 1
    },
    {
      "name": "plugin-badge.label",
      "count": 4
    },
    {
      "name": "plugin-badge.state",
      "count": 1
    },
    {
      "name": "plugin-badge.value",
      "count": 4
    },
    {
      "name": "reportLayout.numberOfRows",
      "count": 9
    },
    {
      "name": "security.escapeSpecialChars",
      "count": 1
    },
    {
      "name": "serverSideCondition.language",
      "count": 1
    },
    {
      "name": "serverSideCondition.sqlExpression",
      "count": 1
    },
    {
      "name": "serverSideCondition.type",
      "count": 1
    },
    {
      "name": "settings.additionalCalendarViews",
      "count": 3
    },
    {
      "name": "settings.compactNosThreshold",
      "count": 8
    },
    {
      "name": "settings.currentFacetsSelector",
      "count": 4
    },
    {
      "name": "settings.description",
      "count": 4
    },
    {
      "name": "settings.displayAvatar",
      "count": 3
    },
    {
      "name": "settings.displayBadge",
      "count": 4
    },
    {
      "name": "settings.displayChartForTopNValues",
      "count": 5
    },
    {
      "name": "settings.displayColumn",
      "count": 3
    },
    {
      "name": "settings.export",
      "count": 2
    },
    {
      "name": "settings.maxEventsDay",
      "count": 1
    },
    {
      "name": "settings.miscellaneous",
      "count": 4
    },
    {
      "name": "settings.outputAs",
      "count": 1
    },
    {
      "name": "settings.overline",
      "count": 1
    },
    {
      "name": "settings.showCurrentFacets",
      "count": 4
    },
    {
      "name": "settings.startDateColumn",
      "count": 3
    },
    {
      "name": "settings.supplementalInfo",
      "count": 1
    },
    {
      "name": "settings.timeAxisType",
      "count": 1
    },
    {
      "name": "settings.title",
      "count": 4
    },
    {
      "name": "settings.viewEditLink.action",
      "count": 1
    },
    {
      "name": "settings.viewEditLink.clearCache",
      "count": 1
    },
    {
      "name": "settings.viewEditLink.items.P18_ID",
      "count": 1
    },
    {
      "name": "settings.viewEditLink.page",
      "count": 1
    },
    {
      "name": "settings.zoomAndScroll",
      "count": 1
    },
    {
      "name": "source.breadcrumb",
      "count": 42
    },
    {
      "name": "source.filteredRegion",
      "count": 8
    },
    {
      "name": "source.htmlCode",
      "count": 7
    },
    {
      "name": "source.list",
      "count": 6
    },
    {
      "name": "source.location",
      "count": 41
    },
    {
      "name": "source.plsqlCode",
      "count": 2
    },
    {
      "name": "source.plsqlFunctionBody",
      "count": 12
    },
    {
      "name": "source.sqlQuery",
      "count": 41
    },
    {
      "name": "source.type",
      "count": 41
    },
    {
      "name": "title.title",
      "count": 1
    },
    {
      "name": "toolbar.controls",
      "count": 1
    }
  ]
}