json-rest-api 1.0.7 → 1.0.8

package/{README_2_Computed_and_hidden_fields.md → docs/README_VARIOUS/GUIDE_2_Computed_and_hidden_fields.md}

@@ -80,13 +80,12 @@ await api.addResource('products', {
     name: { type: 'string', required: true },
     price: { type: 'number', required: true },
     cost: { type: 'number', required: true, normallyHidden: true },
-    tax_rate: { type: 'number', required: true }
-  },
-  
-  // Computed fields are defined separately from schema
-  computed: {
+    tax_rate: { type: 'number', required: true },
+    
+    // Computed fields are defined in the schema with computed: true
     profit_margin: {
       type: 'number',
+      computed: true,  // Mark as computed field
       dependencies: ['price', 'cost'], // Fields needed for computation
       compute: ({ attributes }) => {
         if (attributes.price && attributes.cost) {
@@ -98,6 +97,7 @@ await api.addResource('products', {
     
     display_name: {
       type: 'string',
+      computed: true,  // Mark as computed field
       dependencies: ['name', 'price'],
       compute: ({ attributes }) => {
         return `${attributes.name} - $${attributes.price}`;
@@ -112,9 +112,12 @@ await api.addResource('products', {
 The compute function receives a rich context object:
 
 ```javascript
-computed: {
+schema: {
+  field1: { type: 'string' },
+  field2: { type: 'string' },
   advanced_calculation: {
     type: 'string',
+    computed: true,  // Mark as computed field
     dependencies: ['field1', 'field2'],
     compute: async (context) => {
       // Available in context:
@@ -149,11 +152,10 @@ await api.addResource('products', {
     name: { type: 'string' },
     price: { type: 'number' },
     cost: { type: 'number', normallyHidden: true },
-    tax_rate: { type: 'number', normallyHidden: true }
-  },
-  computed: {
+    tax_rate: { type: 'number', normallyHidden: true },
     profit_margin: {
       type: 'number',
+      computed: true,  // Mark as computed field
       dependencies: ['price', 'cost'],
       compute: ({ attributes }) => {
         return ((attributes.price - attributes.cost) / attributes.price * 100).toFixed(2);
@@ -208,13 +210,12 @@ await api.addResource('products', {
     
     // Internal fields - never exposed
     supplier_code: { type: 'string', hidden: true },
-    warehouse_location: { type: 'string', hidden: true }
-  },
-  
-  computed: {
+    warehouse_location: { type: 'string', hidden: true },
+    
     // Sale price after discount
     sale_price: {
       type: 'number',
+      computed: true,
       dependencies: ['list_price', 'discount_percent'],
       compute: ({ attributes }) => {
         const discount = attributes.discount_percent || 0;
@@ -225,6 +226,7 @@ await api.addResource('products', {
     // Profit margin (requires hidden cost fields)
     profit_margin: {
       type: 'number',
+      computed: true,
       dependencies: ['list_price', 'base_cost', 'shipping_cost', 'discount_percent'],
       compute: ({ attributes }) => {
         const salePrice = attributes.list_price * (1 - (attributes.discount_percent || 0) / 100);
@@ -237,6 +239,7 @@ await api.addResource('products', {
     // Display title for UI
     display_title: {
       type: 'string',
+      computed: true,
       dependencies: ['name', 'sku', 'discount_percent'],
       compute: ({ attributes }) => {
         let title = `${attributes.name} (${attributes.sku})`;
@@ -298,13 +301,12 @@ await api.addResource('users', {
     // Stats fields (updated by background jobs)
     post_count: { type: 'number', default: 0 },
     comment_count: { type: 'number', default: 0 },
-    last_login_at: { type: 'datetime', normallyHidden: true }
-  },
-  
-  computed: {
+    last_login_at: { type: 'datetime', normallyHidden: true },
+    
     // Full name from parts
     full_name: {
       type: 'string',
+      computed: true,
       dependencies: ['first_name', 'last_name'],
       compute: ({ attributes }) => {
         const parts = [attributes.first_name, attributes.last_name].filter(Boolean);
@@ -315,6 +317,7 @@ await api.addResource('users', {
     // Age calculation (requires hidden date_of_birth)
     age: {
       type: 'number',
+      computed: true,
       dependencies: ['date_of_birth'],
       compute: ({ attributes }) => {
         if (!attributes.date_of_birth) return null;
@@ -332,6 +335,7 @@ await api.addResource('users', {
     // Member duration
     member_for_days: {
       type: 'number',
+      computed: true,
       dependencies: ['created_at'],
       compute: ({ attributes }) => {
         const created = new Date(attributes.created_at);
@@ -344,6 +348,7 @@ await api.addResource('users', {
     // Activity level based on posts and comments
     activity_level: {
       type: 'string',
+      computed: true,
       dependencies: ['post_count', 'comment_count', 'created_at'],
       compute: ({ attributes }) => {
         const total = (attributes.post_count || 0) + (attributes.comment_count || 0);