@objectstack/spec 0.1.0 → 0.1.1

package/json-schema/SharingLevel.json

@@ -0,0 +1,13 @@
+{
+  "$ref": "#/definitions/SharingLevel",
+  "definitions": {
+    "SharingLevel": {
+      "type": "string",
+      "enum": [
+        "read",
+        "edit"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

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/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/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/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#"
+}

package/json-schema/TransformType.json

@@ -0,0 +1,18 @@
+{
+  "$ref": "#/definitions/TransformType",
+  "definitions": {
+    "TransformType": {
+      "type": "string",
+      "enum": [
+        "none",
+        "constant",
+        "lookup",
+        "split",
+        "join",
+        "javascript",
+        "map"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/TranslationBundle.json

@@ -0,0 +1,78 @@
+{
+  "$ref": "#/definitions/TranslationBundle",
+  "definitions": {
+    "TranslationBundle": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "objects": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "properties": {
+                "label": {
+                  "type": "string"
+                },
+                "pluralLabel": {
+                  "type": "string"
+                },
+                "fields": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "object",
+                    "properties": {
+                      "label": {
+                        "type": "string"
+                      },
+                      "help": {
+                        "type": "string"
+                      },
+                      "options": {
+                        "type": "object",
+                        "additionalProperties": {
+                          "type": "string"
+                        }
+                      }
+                    },
+                    "additionalProperties": false
+                  }
+                }
+              },
+              "required": [
+                "label"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "apps": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "properties": {
+                "label": {
+                  "type": "string"
+                },
+                "description": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "label"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "messages": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            }
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/TranslationData.json

@@ -0,0 +1,75 @@
+{
+  "$ref": "#/definitions/TranslationData",
+  "definitions": {
+    "TranslationData": {
+      "type": "object",
+      "properties": {
+        "objects": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "label": {
+                "type": "string"
+              },
+              "pluralLabel": {
+                "type": "string"
+              },
+              "fields": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "object",
+                  "properties": {
+                    "label": {
+                      "type": "string"
+                    },
+                    "help": {
+                      "type": "string"
+                    },
+                    "options": {
+                      "type": "object",
+                      "additionalProperties": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "additionalProperties": false
+                }
+              }
+            },
+            "required": [
+              "label"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "apps": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "label": {
+                "type": "string"
+              },
+              "description": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "label"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "messages": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/UniquenessValidation.json

@@ -0,0 +1,59 @@
+{
+  "$ref": "#/definitions/UniquenessValidation",
+  "definitions": {
+    "UniquenessValidation": {
+      "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": "unique"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields that must be combined unique"
+        },
+        "scope": {
+          "type": "string",
+          "description": "Formula condition for scope (e.g. active = true)"
+        },
+        "caseSensitive": {
+          "type": "boolean",
+          "default": true
+        }
+      },
+      "required": [
+        "name",
+        "message",
+        "type",
+        "fields"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/UrlNavItem.json

@@ -0,0 +1,51 @@
+{
+  "$ref": "#/definitions/UrlNavItem",
+  "definitions": {
+    "UrlNavItem": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique identifier for this navigation item"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display proper label"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon name"
+        },
+        "visible": {
+          "type": "string",
+          "description": "Visibility formula condition"
+        },
+        "type": {
+          "type": "string",
+          "const": "url"
+        },
+        "url": {
+          "type": "string",
+          "description": "Target external URL"
+        },
+        "target": {
+          "type": "string",
+          "enum": [
+            "_self",
+            "_blank"
+          ],
+          "default": "_self",
+          "description": "Link target window"
+        }
+      },
+      "required": [
+        "id",
+        "label",
+        "type",
+        "url"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}