OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

marketplace.order.updateStatus

Update order status.

  • Type: operation (command)
  • Version: 1.0.0
  • Stability: stable
  • Owners: @example.marketplace
  • Tags: marketplace, order, status
  • File: packages/examples/marketplace/src/order/order.operations.ts
  • field.key.label
    marketplace.order.updateStatus
    field.version.label
    1.0.0
    field.type.label
    operation (command)
    field.title.label
    marketplace.order.updateStatus
    field.description.label

    Update order status.

  • Type: operation (command)
  • Version: 1.0.0
  • Stability: stable
  • Owners: @example.marketplace
  • Tags: marketplace, order, status
  • File: packages/examples/marketplace/src/order/order.operations.ts
  • field.tags.label
    marketplace,order,status
    field.owners.label
    @example.marketplace
    field.stability.label
    stable

    Update order status.

    Goal

    Track order fulfillment.

    Context

    Order management.

    Emitted Events

    `marketplace.order.statusUpdated` (v1.0.0)

    Source Definition

    import { defineCommand } from '@lssm-tech/lib.contracts-spec/operations';
    import {
    	CreateOrderInputModel,
    	OrderModel,
    	UpdateOrderStatusInputModel,
    } from './order.schema';
    
    export const UpdateOrderStatusContract = defineCommand({
    	meta: {
    		key: 'marketplace.order.updateStatus',
    		version: '1.0.0',
    		stability: 'stable',
    		owners: ['@example.marketplace'],
    		tags: ['marketplace', 'order', 'status'],
    		description: 'Update order status.',
    		goal: 'Track order fulfillment.',
    		context: 'Order management.',
    	},
    	io: { input: UpdateOrderStatusInputModel, output: OrderModel },
    	policy: { auth: 'user' },
    	sideEffects: {
    		emits: [
    			{
    				key: 'marketplace.order.statusUpdated',
    				version: '1.0.0',
    				when: 'Status changes',
    				payload: OrderModel,
    			},
    		],
    		audit: ['marketplace.order.statusUpdated'],
    	},
    	acceptance: {
    		scenarios: [
    			{
    				key: 'update-status-happy-path',
    				given: ['Order exists'],
    				when: ['Seller updates order status'],
    				then: ['Status is updated', 'OrderStatusUpdated event is emitted'],
    			},
    		],
    		examples: [
    			{
    				key: 'mark-shipped',
    				input: {
    					orderId: 'order-789',
    					status: 'shipped',
    					trackingNumber: 'TRACK123',
    				},
    				output: { id: 'order-789', status: 'shipped' },
    			},
    		],
    	},
    });