@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/SharingRule.json

@@ -0,0 +1,58 @@
+{
+  "$ref": "#/definitions/SharingRule",
+  "definitions": {
+    "SharingRule": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique rule name"
+        },
+        "label": {
+          "type": "string"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "object": {
+          "type": "string",
+          "description": "Object to share"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "owner",
+            "criteria",
+            "manual",
+            "guest"
+          ],
+          "default": "criteria"
+        },
+        "criteria": {
+          "type": "string"
+        },
+        "accessLevel": {
+          "type": "string",
+          "enum": [
+            "read",
+            "edit"
+          ],
+          "default": "read"
+        },
+        "sharedWith": {
+          "type": "string",
+          "description": "Group/Role ID to share records with"
+        }
+      },
+      "required": [
+        "name",
+        "object",
+        "sharedWith"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SharingRuleType.json

@@ -0,0 +1,15 @@
+{
+  "$ref": "#/definitions/SharingRuleType",
+  "definitions": {
+    "SharingRuleType": {
+      "type": "string",
+      "enum": [
+        "owner",
+        "criteria",
+        "manual",
+        "guest"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SingleRecordResponse.json

@@ -0,0 +1,69 @@
+{
+  "$ref": "#/definitions/SingleRecordResponse",
+  "definitions": {
+    "SingleRecordResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean",
+          "description": "Operation success status"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "description": "Error code (e.g. validation_error)"
+            },
+            "message": {
+              "type": "string",
+              "description": "Readable error message"
+            },
+            "details": {
+              "description": "Additional error context (e.g. field validation errors)"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Error details if success is false"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "timestamp": {
+              "type": "string"
+            },
+            "duration": {
+              "type": "number"
+            },
+            "requestId": {
+              "type": "string"
+            },
+            "traceId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "timestamp"
+          ],
+          "additionalProperties": false,
+          "description": "Response metadata"
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "The requested or modified record"
+        }
+      },
+      "required": [
+        "success",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SortNode.json

@@ -0,0 +1,26 @@
+{
+  "$ref": "#/definitions/SortNode",
+  "definitions": {
+    "SortNode": {
+      "type": "object",
+      "properties": {
+        "field": {
+          "type": "string"
+        },
+        "order": {
+          "type": "string",
+          "enum": [
+            "asc",
+            "desc"
+          ],
+          "default": "asc"
+        }
+      },
+      "required": [
+        "field"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Spacing.json

@@ -0,0 +1,64 @@
+{
+  "$ref": "#/definitions/Spacing",
+  "definitions": {
+    "Spacing": {
+      "type": "object",
+      "properties": {
+        "0": {
+          "type": "string",
+          "description": "0 spacing (0)"
+        },
+        "1": {
+          "type": "string",
+          "description": "Spacing unit 1 (e.g., 0.25rem)"
+        },
+        "2": {
+          "type": "string",
+          "description": "Spacing unit 2 (e.g., 0.5rem)"
+        },
+        "3": {
+          "type": "string",
+          "description": "Spacing unit 3 (e.g., 0.75rem)"
+        },
+        "4": {
+          "type": "string",
+          "description": "Spacing unit 4 (e.g., 1rem)"
+        },
+        "5": {
+          "type": "string",
+          "description": "Spacing unit 5 (e.g., 1.25rem)"
+        },
+        "6": {
+          "type": "string",
+          "description": "Spacing unit 6 (e.g., 1.5rem)"
+        },
+        "8": {
+          "type": "string",
+          "description": "Spacing unit 8 (e.g., 2rem)"
+        },
+        "10": {
+          "type": "string",
+          "description": "Spacing unit 10 (e.g., 2.5rem)"
+        },
+        "12": {
+          "type": "string",
+          "description": "Spacing unit 12 (e.g., 3rem)"
+        },
+        "16": {
+          "type": "string",
+          "description": "Spacing unit 16 (e.g., 4rem)"
+        },
+        "20": {
+          "type": "string",
+          "description": "Spacing unit 20 (e.g., 5rem)"
+        },
+        "24": {
+          "type": "string",
+          "description": "Spacing unit 24 (e.g., 6rem)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/StateMachineValidation.json

@@ -0,0 +1,59 @@
+{
+  "$ref": "#/definitions/StateMachineValidation",
+  "definitions": {
+    "StateMachineValidation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique rule name"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "severity": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warning",
+            "info"
+          ],
+          "default": "error"
+        },
+        "message": {
+          "type": "string",
+          "description": "Error message to display"
+        },
+        "type": {
+          "type": "string",
+          "const": "state_machine"
+        },
+        "field": {
+          "type": "string",
+          "description": "State field (e.g. status)"
+        },
+        "transitions": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "description": "Map of { OldState: [AllowedNewStates] }"
+        }
+      },
+      "required": [
+        "name",
+        "message",
+        "type",
+        "field",
+        "transitions"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SystemAPI.json

@@ -0,0 +1,12 @@
+{
+  "$ref": "#/definitions/SystemAPI",
+  "definitions": {
+    "SystemAPI": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false,
+      "description": "Access to System Core"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Territory.json

@@ -0,0 +1,77 @@
+{
+  "$ref": "#/definitions/Territory",
+  "definitions": {
+    "Territory": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$"
+        },
+        "label": {
+          "type": "string",
+          "description": "Territory Label (e.g. \"West Coast\")"
+        },
+        "modelId": {
+          "type": "string",
+          "description": "Belongs to which Territory Model"
+        },
+        "parent": {
+          "type": "string",
+          "description": "Parent Territory"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "geography",
+            "industry",
+            "named_account",
+            "product_line"
+          ],
+          "default": "geography"
+        },
+        "assignmentRule": {
+          "type": "string",
+          "description": "Criteria based assignment rule"
+        },
+        "assignedUsers": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "accountAccess": {
+          "type": "string",
+          "enum": [
+            "read",
+            "edit"
+          ],
+          "default": "read"
+        },
+        "opportunityAccess": {
+          "type": "string",
+          "enum": [
+            "read",
+            "edit"
+          ],
+          "default": "read"
+        },
+        "caseAccess": {
+          "type": "string",
+          "enum": [
+            "read",
+            "edit"
+          ],
+          "default": "read"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "modelId"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/TerritoryModel.json

@@ -0,0 +1,34 @@
+{
+  "$ref": "#/definitions/TerritoryModel",
+  "definitions": {
+    "TerritoryModel": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Model Name (e.g. FY24 Planning)"
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "planning",
+            "active",
+            "archived"
+          ],
+          "default": "planning"
+        },
+        "startDate": {
+          "type": "string"
+        },
+        "endDate": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/TerritoryType.json

@@ -0,0 +1,15 @@
+{
+  "$ref": "#/definitions/TerritoryType",
+  "definitions": {
+    "TerritoryType": {
+      "type": "string",
+      "enum": [
+        "geography",
+        "industry",
+        "named_account",
+        "product_line"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}