Types Reference

{
  type: 'seatSquirrelLayout',
  version: '1.0.0',
  layout: {
    sections: Section[],
    rows: Row[],
    areas?: Area[],
    tables?: Table[],
    pricingCategories: PricingCategory[],
    drawing?: Drawing,
    metadata: {
      name?: string,
      exportedAt: string,      // ISO 8601 timestamp
      dimensions: { width: number, height: number },
      currency?: string,       // ISO 4217 currency code (e.g., 'USD', 'EUR')
      locale?: string,         // BCP 47 locale code (e.g., 'en-US', 'de-DE')
      permissions?: DesignerPermissions  // Feature restrictions stored with layout
    }
  }
}

{
  id: "price_x7k2m9p4q1B2c3D4",
  label: "VIP",
  slug: "vip",
  price: 15000,        // e.g., $150.00
  color: "#8b5cf6",
  customerNotes: "Includes complimentary drinks"
}

{
  key: "entranceToUse",
  label: "Entrance to Use",
  value: "Door 3"
}

{
  id: "rowseat_x7k2m9p4q1B2c3D4",
  rowId: "row_d5E6f7G8h9I0j1K2",
  indexInRow: 0,
  label: "1",
  slug: "rowseat-row_a-1",
  pricingCategoryIds: ["price_x7k2m9p4q1B2c3D4"],
  isAccessible: true
}

// Example: All permissions with defaults shown
{
  readOnly: false,
  assignmentOnly: false,
  tools: {
    row: true,
    table: true,
    area: true,
    shape: true,
    text: true,
    traceImage: true
  },
  properties: {
    showProperties: true,
    settingsTab: true,
    pricingCategoriesCrud: true,
    currencySettings: true
  },
  warnings: {
    pricingCategoriesAssignmentSaveWarning: true,
    pricingCategoriesAssignmentPanelWarning: true
  }
}

{
  selections: [
    { type: 'row-seat', ... },
    { type: 'area', ... },
    { type: 'table-seat', ... },
    { type: 'whole-table', ... }
  ],
  lastSelection: { type: 'row-seat', id: '...', ... },  // or null on deselect/clear
  totals: {
    count: 5,        // Total items selected
    amount: 25000    // Sum of selections that have pricing in cents (e.g., $250.00)
  }
}

picker.setAvailability({
  mode: 'by-id',
  rowSeats: {
    rowseat_a1B2c3D4e5F6g7H8: true,
    rowseat_h8G7f6E5d4C3b2A1: false,
  },
  areas: {
    area_j9K0l1M2n3O4p5Q6: 50,
    area_x1Y2z3A4b5C6d7E8: false, // boolean: false = 0 (unavailable)
  },
  tables: {
    table_x1Y2z3: false,
  },
});

picker.setAvailability({
  mode: 'by-slug',
  rowSeats: {
    'row-a-seat-1': false,
    'row-a-seat-2': true,
  },
  areas: {
    'standing-room': 50,
    'vip-lounge': 0,
    'private-booth': false, // boolean: false = 0 (unavailable)
  },
  tables: {
    'vip-table-1': false,
  },
});

picker.setAvailability({
  mode: 'dangerously-by-labels',
  rowSeats: [
    { rowLabel: 'A', seatLabel: '1', isAvailable: false },
    { rowLabel: 'A', seatLabel: '2', isAvailable: true },
  ],
  areas: [{ areaLabel: 'Standing Room', availableCount: 50 }],
  tables: [{ tableLabel: 'VIP Table', isAvailable: false }],
});

// By pricing category ID — only "Standard" entities are available (full reset)
picker.setAvailability({
  mode: 'by-pricing-category',
  available: ['price_abc123'],
});

// By pricing category slug — same semantics, using slugs
picker.setAvailability({
  mode: 'by-pricing-category-slug',
  available: ['standard', 'vip'],
});

// Delta: make VIP-only entities unavailable (others unchanged)
picker.setAvailability({
  mode: 'by-pricing-category',
  unavailable: ['price_def456'],
});

// Combined + requirePricingCategory
picker.setAvailability({
  mode: 'by-pricing-category',
  available: ['price_abc123', 'price_def456'],
  unavailable: ['price_abc123'],
  requirePricingCategory: true,
});

picker.updatePricingCategoriesById({
  pricingCategories: [
    { id: 'price_a1B2c3D4e5F6g7H8', price: 7500, label: 'Standard (updated)' },
    { id: 'price_h8G7f6E5d4C3b2A1', color: '#10B981' },
  ],
});

picker.updatePricingCategoriesBySlug({
  pricingCategories: [
    { slug: 'standard', price: 7500, label: 'Standard (updated)' },
    { slug: 'vip', color: '#10B981' },
  ],
});

// By slug (recommended)
{
  mode: 'by-slug',
  rows: {
    'row-a': ['vip', 'standard'],
    'row-b': ['standard'],
  },
  areas: {
    'vip-lounge': ['vip'],
  }
}

// By ID
{
  mode: 'by-id',
  rows: {
    'row-uuid-1': ['cat-uuid-1', 'cat-uuid-2'],
  },
  areas: {
    'area-uuid-1': ['cat-uuid-2'],
  }
}

// Dangerously by labels
{
  mode: 'dangerously-by-labels',
  rows: [
    { rowLabel: 'A', pricingCategorySlugs: ['vip', 'standard'] },
    { sectionId: 'section-uuid', rowLabel: 'A', pricingCategorySlugs: ['economy'] },
  ]
}

// Success
{ success: true }

// Failure — no assignments applied
{
  success: false,
  errors: [
    'No object found with slug "nonexistent-row"',
    'No pricing category found with slug "unknown-category"'
  ]
}

{
  type: 'seatSquirrelLayout',
  version: '1.0.0',
  layout: {
    sections: [{
      id: 'section_a1B2c3D4e5F6g7H8',
      label: 'Orchestra',
      slug: 'section-orchestra',
      pricingCategoryIds: ['price_v1I2p7R8s9T0u1W2', 'price_s3T4d5A6n7D8r9E0']
    }],
    rows: [{
      id: 'row_d5E6f7G8h9I0j1K2',
      label: 'A',
      slug: 'row-a',
      seatCount: 10,
      seatLabelType: 'numeric',
      seatLabelStart: 1,
      sectionId: 'section_a1B2c3D4e5F6g7H8',
      pricingCategoryIds: ['price_v1I2p7R8s9T0u1W2'],
      drawing: {
        startX: 100,
        startY: 200,
        endX: 400,
        endY: 200,
        curve: 0.1,
        angle: 0
      },
      seats: [
        {
          id: 'rowseat_x7k2m9p4q1B2c3D4',
          rowId: 'row_d5E6f7G8h9I0j1K2',
          indexInRow: 0,
          label: '1',
          slug: 'rowseat-row_a-1',
          pricingCategoryIds: ['price_v1I2p7R8s9T0u1W2']
        }
        // ... more seats
      ]
    }],
    areas: [{
      id: 'area_g1H2i3J4k5L6m7N8',
      label: 'General Admission',
      slug: 'area-general_admission',
      purchaseType: 'multiple-customer',
      pricingMethod: 'per-person',
      pricingCategoryIds: ['price_s3T4d5A6n7D8r9E0'],
      maxOccupancy: 200,
      displayUnit: 'standing',
      drawing: {
        shape: 'rectangle',
        shapeData: { x: 500, y: 100, width: 300, height: 200 },
        fill: '#e5e7eb'
      }
    }],
    tables: [{
      id: 'table_t1A2b3L4e5S6e7A8',
      label: 'Table 1',
      slug: 'table-table_1',
      seatCount: 6,
      seatLabelType: 'numeric',
      seatLabelStart: 1,
      purchaseType: 'multiple-customer',
      pricingMethod: 'per-person',
      pricingCategoryIds: ['price_s3T4d5A6n7D8r9E0'],
      sectionId: 'section_a1B2c3D4e5F6g7H8',
      drawing: {
        shape: 'circular',
        x: 600,
        y: 400,
        radius: 40,
        fill: '#d1d5db'
      },
      seats: [
        {
          id: 'tableseat_p1Q2r3S4t5U6v7W8',
          tableId: 'table_t1A2b3L4e5S6e7A8',
          indexInTable: 0,
          label: '1',
          slug: 'tableseat-table_1-1',
          pricingCategoryIds: ['price_s3T4d5A6n7D8r9E0']
        }
        // ... more seats
      ]
    }],
    pricingCategories: [
      { id: 'price_v1I2p7R8s9T0u1W2', label: 'VIP', slug: 'vip', price: 15000, color: '#8b5cf6' },
      { id: 'price_s3T4d5A6n7D8r9E0', label: 'Standard', slug: 'standard', price: 5000, color: '#3b82f6' }
    ],
    drawing: {
      backgroundColor: '#ffffff',
      rectangles: [{
        id: 'rect_j1K2l3M4n5O6p7Q8',
        x: 200,
        y: 50,
        width: 200,
        height: 60,
        fill: '#1f2937',
        cornerRadius: 4,
        label: 'STAGE',
        labelColor: '#ffffff',
        labelFontSize: 24,
        labelAlign: 'center'
      }],
      textElements: [{
        id: 'text_m1N2o3P4q5R6s7T8',
        x: 50,
        y: 400,
        text: 'EXIT',
        fontSize: 16,
        color: '#ef4444'
      }]
    },
    metadata: {
      name: 'Main Theater',
      exportedAt: '2024-01-15T10:30:00.000Z',
      dimensions: { width: 800, height: 600 },
      currency: 'USD',
      locale: 'en-US',
      permissions: {
        properties: { pricingCategoriesCrud: false }
      }
    }
  }
}