@ankhorage/zora 21.0.23 → 21.1.1

package/src/features/game/meta/gameEntityMeta.ts

@@ -0,0 +1,226 @@
+import type { ZoraComponentMeta } from '../../../types/authoring';
+
+/*** Describe one positioned generic game entity for ZORA authoring tools. */
+export const gameEntityMeta = {
+  name: 'GameEntity',
+  category: 'component',
+  description: 'Positions arbitrary visual content inside a GameField without owning game rules.',
+  directManifestNode: true,
+  allowedChildren: ['Badge', 'Icon', 'Image', 'Text', 'View'],
+  blueprint: {
+    label: 'Game entity',
+    defaultProps: { x: 0, y: 0, opacity: 1, scale: 1, rotation: 0, zIndex: 0 },
+  },
+  bindings: {
+    props: {
+      x: { value: { type: 'number' }, acceptsFallback: true },
+      y: { value: { type: 'number' }, acceptsFallback: true },
+      width: { value: { type: 'number' }, acceptsFallback: true },
+      height: { value: { type: 'number' }, acceptsFallback: true },
+      opacity: { value: { type: 'number' }, acceptsFallback: true },
+      scale: { value: { type: 'number' }, acceptsFallback: true },
+      rotation: { value: { type: 'number' }, acceptsFallback: true },
+      zIndex: { value: { type: 'number' }, acceptsFallback: true },
+      hidden: { value: { type: 'boolean' }, acceptsFallback: true },
+      measurementId: { value: { type: 'string' }, acceptsFallback: true },
+      transitionDurationMs: { value: { type: 'number' }, acceptsFallback: true },
+      transitionEasing: { value: { type: 'string' }, acceptsFallback: true },
+      motionOffsetX: { value: { type: 'number' }, acceptsFallback: true },
+      motionOffsetY: { value: { type: 'number' }, acceptsFallback: true },
+      motionOpacityDelta: { value: { type: 'number' }, acceptsFallback: true },
+      motionScaleDelta: { value: { type: 'number' }, acceptsFallback: true },
+      motionRotationDelta: { value: { type: 'number' }, acceptsFallback: true },
+      motionDurationMs: { value: { type: 'number' }, acceptsFallback: true },
+      motionDelayMs: { value: { type: 'number' }, acceptsFallback: true },
+      motionEasing: { value: { type: 'string' }, acceptsFallback: true },
+      motionRepeat: { value: { type: 'boolean' }, acceptsFallback: true },
+      motionAlternate: { value: { type: 'boolean' }, acceptsFallback: true },
+      motionPaused: { value: { type: 'boolean' }, acceptsFallback: true },
+      motionEssential: { value: { type: 'boolean' }, acceptsFallback: true },
+    },
+  },
+  props: {
+    x: {
+      type: 'number',
+      category: 'Position',
+      label: 'X (%)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    y: {
+      type: 'number',
+      category: 'Position',
+      label: 'Y (%)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    width: {
+      type: 'number',
+      category: 'Size',
+      label: 'Width',
+      authoring: { authority: 'instance' },
+    },
+    height: {
+      type: 'number',
+      category: 'Size',
+      label: 'Height',
+      authoring: { authority: 'instance' },
+    },
+    opacity: {
+      type: 'number',
+      category: 'Appearance',
+      label: 'Opacity',
+      default: 1,
+      authoring: { authority: 'instance' },
+    },
+    scale: {
+      type: 'number',
+      category: 'Transform',
+      label: 'Scale',
+      default: 1,
+      authoring: { authority: 'instance' },
+    },
+    rotation: {
+      type: 'number',
+      category: 'Transform',
+      label: 'Rotation',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    zIndex: {
+      type: 'number',
+      category: 'Position',
+      label: 'Z index',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    hidden: {
+      type: 'boolean',
+      category: 'State',
+      label: 'Hidden',
+      default: false,
+      authoring: { authority: 'instance' },
+    },
+    pointerEvents: {
+      type: 'enum',
+      category: 'Interaction',
+      label: 'Pointer events',
+      enum: ['auto', 'box-none', 'box-only', 'none'],
+      default: 'auto',
+      authoring: { authority: 'instance' },
+    },
+    measurementId: {
+      type: 'string',
+      category: 'Measurement',
+      label: 'Measurement id',
+      authoring: { authority: 'instance' },
+    },
+
+    transitionDurationMs: {
+      type: 'number',
+      category: 'Motion',
+      label: 'Transition duration (ms)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    transitionEasing: {
+      type: 'enum',
+      category: 'Motion',
+      label: 'Transition easing',
+      enum: ['linear', 'ease-in', 'ease-out', 'ease-in-out'],
+      default: 'linear',
+      authoring: { authority: 'instance' },
+    },
+    motionOffsetX: {
+      type: 'number',
+      category: 'Motion',
+      label: 'Motion X offset (%)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    motionOffsetY: {
+      type: 'number',
+      category: 'Motion',
+      label: 'Motion Y offset (%)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    motionOpacityDelta: {
+      type: 'number',
+      category: 'Motion',
+      label: 'Motion opacity delta',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    motionScaleDelta: {
+      type: 'number',
+      category: 'Motion',
+      label: 'Motion scale delta',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    motionRotationDelta: {
+      type: 'number',
+      category: 'Motion',
+      label: 'Motion rotation delta',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    motionDurationMs: {
+      type: 'number',
+      category: 'Motion',
+      label: 'Motion duration (ms)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    motionDelayMs: {
+      type: 'number',
+      category: 'Motion',
+      label: 'Motion delay (ms)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    motionEasing: {
+      type: 'enum',
+      category: 'Motion',
+      label: 'Motion easing',
+      enum: ['linear', 'ease-in', 'ease-out', 'ease-in-out'],
+      default: 'linear',
+      authoring: { authority: 'instance' },
+    },
+    motionRepeat: {
+      type: 'boolean',
+      category: 'Motion',
+      label: 'Repeat motion',
+      default: false,
+      authoring: { authority: 'instance' },
+    },
+    motionAlternate: {
+      type: 'boolean',
+      category: 'Motion',
+      label: 'Alternate motion',
+      default: false,
+      authoring: { authority: 'instance' },
+    },
+    motionPaused: {
+      type: 'boolean',
+      category: 'Motion',
+      label: 'Pause motion',
+      default: false,
+      authoring: { authority: 'instance' },
+    },
+    motionEssential: {
+      type: 'boolean',
+      category: 'Motion',
+      label: 'Essential motion',
+      default: false,
+      authoring: { authority: 'instance' },
+    },
+    accessibilityLabel: {
+      type: 'string',
+      category: 'Accessibility',
+      label: 'Accessibility label',
+      authoring: { authority: 'instance' },
+    },
+  },
+} as const satisfies ZoraComponentMeta;

package/src/features/game/meta/gameFieldMeta.ts

@@ -0,0 +1,49 @@
+import type { ZoraComponentMeta } from '../../../types/authoring';
+
+/*** Describe the embeddable game field for ZORA authoring tools. */
+export const gameFieldMeta = {
+  name: 'GameField',
+  category: 'layout',
+  description: 'Relative positioning surface for embeddable game presentation content.',
+  directManifestNode: true,
+  allowedChildren: ['GameEntity', 'GameOverlay', 'Gradient', 'Image', 'View'],
+  blueprint: {
+    label: 'Game field',
+    defaultProps: { minHeight: 320, clip: true },
+  },
+  props: {
+    aspectRatio: {
+      type: 'number',
+      category: 'Layout',
+      label: 'Aspect ratio',
+      authoring: { authority: 'instance' },
+    },
+    minHeight: {
+      type: 'number',
+      category: 'Layout',
+      label: 'Minimum height',
+      default: 320,
+      authoring: { authority: 'instance' },
+    },
+    fill: {
+      type: 'boolean',
+      category: 'Layout',
+      label: 'Fill available space',
+      default: false,
+      authoring: { authority: 'instance' },
+    },
+    clip: {
+      type: 'boolean',
+      category: 'Layout',
+      label: 'Clip overflow',
+      default: true,
+      authoring: { authority: 'instance' },
+    },
+    accessibilityLabel: {
+      type: 'string',
+      category: 'Accessibility',
+      label: 'Accessibility label',
+      authoring: { authority: 'instance' },
+    },
+  },
+} as const satisfies ZoraComponentMeta;

package/src/features/game/meta/gameInputZoneMeta.ts

@@ -0,0 +1,140 @@
+import type { ZoraComponentMeta } from '../../../types/authoring';
+
+/*** Describe a field-relative pointer/touch input adapter for one embeddable Game session. */
+export const gameInputZoneMeta = {
+  name: 'GameInputZone',
+  category: 'component',
+  description:
+    'Normalizes pointer/touch positions and optional keyboard bindings into generic game events.',
+  directManifestNode: true,
+  allowedChildren: [],
+  blueprint: {
+    label: 'Game input zone',
+    defaultProps: {
+      eventType: 'game.pointer',
+      x: 0,
+      y: 0,
+      width: 100,
+      height: 100,
+      zIndex: 1,
+      enabled: true,
+      continuous: true,
+    },
+  },
+  props: {
+    eventType: {
+      type: 'string',
+      category: 'Input',
+      label: 'Game event type',
+      default: 'game.pointer',
+      authoring: { authority: 'instance' },
+    },
+    entityId: {
+      type: 'string',
+      category: 'Input',
+      label: 'Entity id',
+      authoring: { authority: 'instance' },
+    },
+    x: {
+      type: 'number',
+      category: 'Position',
+      label: 'X (%)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    y: {
+      type: 'number',
+      category: 'Position',
+      label: 'Y (%)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    width: {
+      type: 'number',
+      category: 'Size',
+      label: 'Width (%)',
+      default: 100,
+      authoring: { authority: 'instance' },
+    },
+    height: {
+      type: 'number',
+      category: 'Size',
+      label: 'Height (%)',
+      default: 100,
+      authoring: { authority: 'instance' },
+    },
+    zIndex: {
+      type: 'number',
+      category: 'Position',
+      label: 'Z index',
+      default: 1,
+      authoring: { authority: 'instance' },
+    },
+    enabled: {
+      type: 'boolean',
+      category: 'State',
+      label: 'Enabled',
+      default: true,
+      authoring: { authority: 'instance' },
+    },
+    continuous: {
+      type: 'boolean',
+      category: 'Input',
+      label: 'Dispatch while moving',
+      default: true,
+      authoring: { authority: 'instance' },
+    },
+    keyboardBindings: {
+      type: 'array',
+      category: 'Input',
+      label: 'Keyboard bindings',
+      default: [],
+      itemSchema: [
+        {
+          key: 'key',
+          schema: {
+            type: 'string',
+            category: 'Input',
+            label: 'Key',
+            authoring: { authority: 'instance' },
+          },
+        },
+        {
+          key: 'eventType',
+          schema: {
+            type: 'string',
+            category: 'Input',
+            label: 'Event type',
+            authoring: { authority: 'instance' },
+          },
+        },
+        {
+          key: 'entityId',
+          schema: {
+            type: 'string',
+            category: 'Input',
+            label: 'Entity id',
+            authoring: { authority: 'instance' },
+          },
+        },
+        {
+          key: 'preventDefault',
+          schema: {
+            type: 'boolean',
+            category: 'Input',
+            label: 'Prevent browser default',
+            default: false,
+            authoring: { authority: 'instance' },
+          },
+        },
+      ],
+      authoring: { authority: 'instance' },
+    },
+    accessibilityLabel: {
+      type: 'string',
+      category: 'Accessibility',
+      label: 'Accessibility label',
+      authoring: { authority: 'instance' },
+    },
+  },
+} as const satisfies ZoraComponentMeta;

package/src/features/game/meta/gameMeasurementProbeMeta.ts

@@ -0,0 +1,72 @@
+import type { ZoraComponentMeta } from '../../../types/authoring';
+
+/*** Describe a non-visual source/target geometry sampling adapter for one Game instance. */
+export const gameMeasurementProbeMeta = {
+  name: 'GameMeasurementProbe',
+  category: 'component',
+  description:
+    'Measures two registered game entities and reports their raw rendered bounds through a generic Game event.',
+  directManifestNode: true,
+  allowedChildren: [],
+  blueprint: {
+    label: 'Game measurement probe',
+    defaultProps: {
+      sourceId: 'source',
+      targetId: 'target',
+      eventType: 'game.measurement',
+      delayMs: 0,
+      enabled: true,
+    },
+  },
+  bindings: {
+    props: {
+      sourceId: { value: { type: 'string' }, acceptsFallback: true },
+      targetId: { value: { type: 'string' }, acceptsFallback: true },
+      eventType: { value: { type: 'string' }, acceptsFallback: true },
+      entityId: { value: { type: 'string' }, acceptsFallback: true },
+      delayMs: { value: { type: 'number' }, acceptsFallback: true },
+      enabled: { value: { type: 'boolean' }, acceptsFallback: true },
+    },
+  },
+  props: {
+    sourceId: {
+      type: 'string',
+      category: 'Measurement',
+      label: 'Source id',
+      authoring: { authority: 'instance' },
+    },
+    targetId: {
+      type: 'string',
+      category: 'Measurement',
+      label: 'Target id',
+      authoring: { authority: 'instance' },
+    },
+    eventType: {
+      type: 'string',
+      category: 'Measurement',
+      label: 'Event type',
+      default: 'game.measurement',
+      authoring: { authority: 'instance' },
+    },
+    entityId: {
+      type: 'string',
+      category: 'Measurement',
+      label: 'Game entity id',
+      authoring: { authority: 'instance' },
+    },
+    delayMs: {
+      type: 'number',
+      category: 'Measurement',
+      label: 'Delay (ms)',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    enabled: {
+      type: 'boolean',
+      category: 'State',
+      label: 'Enabled',
+      default: true,
+      authoring: { authority: 'instance' },
+    },
+  },
+} as const satisfies ZoraComponentMeta;

package/src/features/game/meta/gameMeta.ts

@@ -0,0 +1,115 @@
+import type { ZoraComponentMeta } from '../../../types/authoring';
+
+/*** Describe the embeddable config-driven Game runtime/presentation boundary for ZORA authoring. */
+export const gameMeta = {
+  name: 'Game',
+  category: 'pattern',
+  description:
+    'Embeds one config-driven game session inside ordinary ZORA layout and emits domain-neutral game outputs.',
+  directManifestNode: true,
+  allowedChildren: [
+    'GameEntity',
+    'GameInputZone',
+    'GameMeasurementProbe',
+    'GameOverlay',
+    'Gradient',
+    'Image',
+    'View',
+  ],
+  blueprint: {
+    label: 'Game',
+    defaultProps: {
+      definition: {
+        id: 'game',
+        initialPhase: 'playing',
+        stages: [{ id: 'main' }],
+        rules: [],
+      },
+      seed: 0,
+      resetKey: '',
+      autoAdvanceTime: true,
+      minHeight: 320,
+      fill: false,
+      clip: true,
+    },
+  },
+  bindings: {
+    props: {
+      definition: {
+        value: { type: 'object' },
+        acceptsFallback: true,
+      },
+      input: {
+        value: { type: 'record' },
+        acceptsFallback: true,
+      },
+    },
+  },
+  events: {
+    output: {
+      label: 'Game output',
+      eventType: 'game.output',
+      description: 'Emitted when the platform-neutral game runtime produces an app/domain output.',
+      payloadFields: [
+        { path: 'type', type: 'string' },
+        { path: 'payload', type: 'record' },
+      ],
+    },
+  },
+  props: {
+    seed: {
+      type: 'number',
+      category: 'Runtime',
+      label: 'Initial seed',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    resetKey: {
+      type: 'string',
+      category: 'Runtime',
+      label: 'Reset key',
+      default: '',
+      authoring: { authority: 'instance' },
+    },
+    autoAdvanceTime: {
+      type: 'boolean',
+      category: 'Runtime',
+      label: 'Advance scheduled effects',
+      default: true,
+      authoring: { authority: 'instance' },
+    },
+    aspectRatio: {
+      type: 'number',
+      category: 'Layout',
+      label: 'Aspect ratio',
+      authoring: { authority: 'instance' },
+    },
+    minHeight: {
+      type: 'number',
+      category: 'Layout',
+      label: 'Minimum height',
+      default: 320,
+      authoring: { authority: 'instance' },
+    },
+    fill: {
+      type: 'boolean',
+      category: 'Layout',
+      label: 'Fill available space',
+      default: false,
+      authoring: { authority: 'instance' },
+    },
+    clip: {
+      type: 'boolean',
+      category: 'Layout',
+      label: 'Clip overflow',
+      default: true,
+      authoring: { authority: 'instance' },
+    },
+    accessibilityLabel: {
+      type: 'string',
+      category: 'Accessibility',
+      label: 'Accessibility label',
+      authoring: { authority: 'instance' },
+    },
+  },
+} as const satisfies ZoraComponentMeta;

package/src/features/game/meta/gameOverlayMeta.ts

@@ -0,0 +1,66 @@
+import type { ZoraComponentMeta } from '../../../types/authoring';
+
+/*** Describe a generic absolute game layer for HUD, feedback, and phase content. */
+export const gameOverlayMeta = {
+  name: 'GameOverlay',
+  category: 'layout',
+  description: 'Absolute presentation layer for HUD, feedback, controls, and phase content.',
+  directManifestNode: true,
+  allowedChildren: [
+    'Badge',
+    'Button',
+    'ButtonGroup',
+    'Card',
+    'GameEntity',
+    'Heading',
+    'Icon',
+    'Image',
+    'Progress',
+    'ProgressRing',
+    'Text',
+    'View',
+  ],
+  blueprint: {
+    label: 'Game overlay',
+    defaultProps: { placement: 'fill', blocking: false, padding: 0 },
+  },
+  props: {
+    placement: {
+      type: 'enum',
+      category: 'Layout',
+      label: 'Placement',
+      enum: [
+        'fill',
+        'center',
+        'top',
+        'bottom',
+        'top-left',
+        'top-right',
+        'bottom-left',
+        'bottom-right',
+      ],
+      default: 'fill',
+      authoring: { authority: 'instance' },
+    },
+    blocking: {
+      type: 'boolean',
+      category: 'Interaction',
+      label: 'Block pointer input',
+      default: false,
+      authoring: { authority: 'instance' },
+    },
+    padding: {
+      type: 'number',
+      category: 'Layout',
+      label: 'Padding',
+      default: 0,
+      authoring: { authority: 'instance' },
+    },
+    accessibilityLabel: {
+      type: 'string',
+      category: 'Accessibility',
+      label: 'Accessibility label',
+      authoring: { authority: 'instance' },
+    },
+  },
+} as const satisfies ZoraComponentMeta;