@stackwright-pro/launch-stackwright-pro 0.4.0-alpha.9 → 0.4.0-alpha.94

package/templates/pro/scripts/pro-content-plugin.js

@@ -0,0 +1,99 @@
+// packages/launch-stackwright-pro/templates/pro/scripts/pro-content-plugin.js
+//
+// Pro content type plugin for @stackwright/build-scripts.
+//
+// CONFIRMED CASE B (@stackwright/build-scripts@0.5.0-alpha.0 / types@1.2.0-alpha.0):
+//   The currently shipped version of build-scripts does NOT read
+//   `contentItemSchemas` or `knownContentTypeKeys` from plugin objects.
+//   Those fields first appear in @stackwright/types@1.4.0+ and will be
+//   consumed by build-scripts@0.7.0 when that release ships.
+//
+// CURRENT BEHAVIOUR (pre-0.7.0):
+//   `unknownContentTypes: 'warn'` in prebuild.js already prevents hard failures
+//   for unrecognised content types. The `beforeBuild` stub below ensures this
+//   plugin is a syntactically valid, callable plugin (not silently ignored by
+//   the plugin runner) even though there is no side-effect to execute yet.
+//
+// TODO(@stackwright/build-scripts@0.7.0): Once 0.7.0 is the resolved floor,
+//   remove the `beforeBuild` stub — `contentItemSchemas` and
+//   `knownContentTypeKeys` will be consumed natively by the runtime and the
+//   plugin will suppress "unknown content type" warnings automatically.
+
+'use strict';
+
+const { z } = require('zod');
+
+const PRO_CONTENT_TYPE_KEYS = [
+  // @stackwright-pro/display-components
+  'metric_card',
+  'status_badge',
+  'stat_bar',
+  'sparkline',
+  'activity_feed',
+  'dashboard_grid',
+  'data_table',
+  'json_viewer',
+  'action_bar',
+  'section',
+  'collection_listing',
+  // @stackwright-pro/pulse
+  'pulse_provider',
+  'metric_card_pulse',
+  'data_table_pulse',
+  'status_badge_pulse',
+  'stats_grid',
+  'alert_banner',
+  // @stackwright-pro/workflow-components
+  'workflow_mount',
+  // @stackwright-pro/display-components — navigation
+  'breadcrumb',
+  'page_header_bar',
+];
+
+// OSS content types that Pro otters augment with extra fields (e.g. `theme:`,
+// `auth:`). The strict OSS Zod schemas reject unknown properties, so we
+// register passthrough variants here. When build-scripts@0.7.0+ evaluates
+// the union [contentItemSchema, ...extraSchemas], the strict OSS schema
+// fails on the extra field and falls through to our passthrough version.
+const OSS_TYPES_WITH_PRO_EXTENSIONS = [
+  'text_block',
+  'alert',
+  'grid',
+  'main',
+  'collection_list',
+];
+
+const proContentPlugin = {
+  name: 'pro-content',
+
+  // --- Fields read by build-scripts@0.7.0+ (types@1.4.0+) ---
+  // Passthrough schemas — let each component handle its own prop validation
+  // at runtime. Registered here so the prebuild content-item validator
+  // accepts pro types without errors.
+  contentItemSchemas: [
+    // Pro-only types — fully passthrough (no OSS schema exists)
+    ...PRO_CONTENT_TYPE_KEYS.map((type) =>
+      z.object({ type: z.literal(type) }).passthrough()
+    ),
+    // OSS types with Pro extensions (theme:, auth:, etc.) — passthrough
+    // variants so the extra fields don't fail strict OSS validation.
+    ...OSS_TYPES_WITH_PRO_EXTENSIONS.map((type) =>
+      z.object({ type: z.literal(type) }).passthrough()
+    ),
+  ],
+  // String keys so the prebuild skips "unknown content type" warnings.
+  knownContentTypeKeys: [...PRO_CONTENT_TYPE_KEYS, ...OSS_TYPES_WITH_PRO_EXTENSIONS],
+
+  // --- Stub lifecycle hook (required for build-scripts@0.5.x / types@1.2.x) ---
+  // build-scripts@0.5.x only calls plugins that have beforeBuild or afterBuild.
+  // Without this stub the plugin object is accepted but never invoked, making
+  // the whole registration a silent no-op. The stub has no side-effects; its
+  // only purpose is to keep the plugin in the active lifecycle.
+  //
+  // Remove this stub when build-scripts@0.7.0 is the resolved floor (the
+  // 0.7.x runner calls plugins purely for their schema/key registration,
+  // not via beforeBuild/afterBuild).
+  beforeBuild: () => {},
+};
+
+module.exports = { proContentPlugin };