@objectstack/spec 0.1.0 → 0.1.1

package/json-schema/Webhook.json

@@ -0,0 +1,88 @@
+{
+  "$ref": "#/definitions/Webhook",
+  "definitions": {
+    "Webhook": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$"
+        },
+        "label": {
+          "type": "string"
+        },
+        "object": {
+          "type": "string",
+          "description": "Object to listen to"
+        },
+        "triggers": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "create",
+              "update",
+              "delete",
+              "undelete",
+              "api"
+            ]
+          },
+          "description": "Events that trigger execution"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "External URL payload"
+        },
+        "method": {
+          "type": "string",
+          "enum": [
+            "POST",
+            "PUT",
+            "GET"
+          ],
+          "default": "POST"
+        },
+        "secret": {
+          "type": "string",
+          "description": "Signing secret (HMAC)"
+        },
+        "headers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Custom headers (Auth)"
+        },
+        "payloadFields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields to include. Empty = All"
+        },
+        "includeSession": {
+          "type": "boolean",
+          "default": false,
+          "description": "Include user session info"
+        },
+        "retryCount": {
+          "type": "number",
+          "default": 3
+        },
+        "isActive": {
+          "type": "boolean",
+          "default": true
+        }
+      },
+      "required": [
+        "name",
+        "object",
+        "triggers",
+        "url"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WebhookReceiver.json

@@ -0,0 +1,66 @@
+{
+  "$ref": "#/definitions/WebhookReceiver",
+  "definitions": {
+    "WebhookReceiver": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$"
+        },
+        "path": {
+          "type": "string",
+          "description": "URL Path (e.g. /webhooks/stripe)"
+        },
+        "verificationType": {
+          "type": "string",
+          "enum": [
+            "none",
+            "header_token",
+            "hmac",
+            "ip_whitelist"
+          ],
+          "default": "none"
+        },
+        "verificationParams": {
+          "type": "object",
+          "properties": {
+            "header": {
+              "type": "string"
+            },
+            "secret": {
+              "type": "string"
+            },
+            "ips": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "action": {
+          "type": "string",
+          "enum": [
+            "trigger_flow",
+            "script",
+            "upsert_record"
+          ],
+          "default": "trigger_flow"
+        },
+        "target": {
+          "type": "string",
+          "description": "Flow ID or Script name"
+        }
+      },
+      "required": [
+        "name",
+        "path",
+        "target"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WebhookTriggerType.json

@@ -0,0 +1,16 @@
+{
+  "$ref": "#/definitions/WebhookTriggerType",
+  "definitions": {
+    "WebhookTriggerType": {
+      "type": "string",
+      "enum": [
+        "create",
+        "update",
+        "delete",
+        "undelete",
+        "api"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WorkflowAction.json

@@ -0,0 +1,84 @@
+{
+  "$ref": "#/definitions/WorkflowAction",
+  "definitions": {
+    "WorkflowAction": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Action name"
+            },
+            "type": {
+              "type": "string",
+              "const": "field_update"
+            },
+            "field": {
+              "type": "string",
+              "description": "Field to update"
+            },
+            "value": {
+              "description": "Value or Formula to set"
+            }
+          },
+          "required": [
+            "name",
+            "type",
+            "field"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Action name"
+            },
+            "type": {
+              "type": "string",
+              "const": "email_alert"
+            },
+            "template": {
+              "type": "string",
+              "description": "Email template ID/DevName"
+            },
+            "recipients": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "List of recipient emails or user IDs"
+            }
+          },
+          "required": [
+            "name",
+            "type",
+            "template",
+            "recipients"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string"
+            },
+            "options": {}
+          },
+          "required": [
+            "name",
+            "type"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WorkflowRule.json

@@ -0,0 +1,128 @@
+{
+  "$ref": "#/definitions/WorkflowRule",
+  "definitions": {
+    "WorkflowRule": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique workflow name"
+        },
+        "objectName": {
+          "type": "string",
+          "description": "Target Object"
+        },
+        "triggerType": {
+          "type": "string",
+          "enum": [
+            "on_create",
+            "on_update",
+            "on_create_or_update",
+            "on_delete",
+            "schedule"
+          ],
+          "description": "When to evaluate"
+        },
+        "criteria": {
+          "type": "string",
+          "description": "Formula condition. If TRUE, actions execute."
+        },
+        "actions": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Action name"
+                  },
+                  "type": {
+                    "type": "string",
+                    "const": "field_update"
+                  },
+                  "field": {
+                    "type": "string",
+                    "description": "Field to update"
+                  },
+                  "value": {
+                    "description": "Value or Formula to set"
+                  }
+                },
+                "required": [
+                  "name",
+                  "type",
+                  "field"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Action name"
+                  },
+                  "type": {
+                    "type": "string",
+                    "const": "email_alert"
+                  },
+                  "template": {
+                    "type": "string",
+                    "description": "Email template ID/DevName"
+                  },
+                  "recipients": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "List of recipient emails or user IDs"
+                  }
+                },
+                "required": [
+                  "name",
+                  "type",
+                  "template",
+                  "recipients"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  },
+                  "type": {
+                    "type": "string"
+                  },
+                  "options": {}
+                },
+                "required": [
+                  "name",
+                  "type"
+                ],
+                "additionalProperties": false
+              }
+            ]
+          },
+          "description": "Immediate actions"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether this workflow is active"
+        }
+      },
+      "required": [
+        "name",
+        "objectName",
+        "triggerType"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WorkflowTriggerType.json

@@ -0,0 +1,16 @@
+{
+  "$ref": "#/definitions/WorkflowTriggerType",
+  "definitions": {
+    "WorkflowTriggerType": {
+      "type": "string",
+      "enum": [
+        "on_create",
+        "on_update",
+        "on_create_or_update",
+        "on_delete",
+        "schedule"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/package.json

@@ -1,34 +1,43 @@
 {
   "name": "@objectstack/spec",
-  "version": "0.1.0",
-  "description": "ObjectStack Protocol & Specification - Type definitions and schemas",
+  "version": "0.1.1",
+  "description": "ObjectStack Protocol & Specification - TypeScript Interfaces, JSON Schemas, and Convention Configurations",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "dist",
-    "src"
+    "json-schema",
+    "README.md"
   ],
-  "scripts": {
-    "build": "tsc",
-    "clean": "rm -rf dist",
-    "changeset": "changeset",
-    "version": "changeset version",
-    "release": "npm run build && changeset publish"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/objectstack-ai/spec.git"
-  },
   "keywords": [
     "objectstack",
+    "protocol",
     "specification",
-    "types",
-    "metamodel"
+    "schema",
+    "types"
   ],
   "author": "ObjectStack",
   "license": "MIT",
   "devDependencies": {
-    "@changesets/cli": "^2.29.8",
-    "typescript": "^5.9.3"
+    "@types/node": "^20.10.0",
+    "tsx": "^4.21.0",
+    "typescript": "^5.3.0",
+    "zod-to-json-schema": "^3.25.1"
+  },
+  "dependencies": {
+    "zod": "^3.22.4"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "pnpm gen:schema && pnpm gen:docs && tsc",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist",
+    "gen:schema": "tsx scripts/build-schemas.ts",
+    "gen:docs": "tsx scripts/build-docs.ts"
   }
-}
+}

package/dist/examples.d.ts

@@ -1,28 +0,0 @@
-/**
- * Example Usage of ObjectStack Metamodel
- *
- * This file demonstrates how to use the metamodel interfaces
- * to define entities and views.
- */
-import type { ObjectEntity, ObjectView } from './types/meta';
-/**
- * Example: User Entity Definition
- */
-export declare const UserEntity: ObjectEntity;
-/**
- * Example: All Users List View
- */
-export declare const AllUsersView: ObjectView;
-/**
- * Example: Active Users View (with filter)
- */
-export declare const ActiveUsersView: ObjectView;
-/**
- * Example: User Form View
- */
-export declare const UserFormView: ObjectView;
-/**
- * Example: Product Entity with Lookup
- */
-export declare const ProductEntity: ObjectEntity;
-//# sourceMappingURL=examples.d.ts.map

package/dist/examples.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"examples.d.ts","sourceRoot":"","sources":["../src/examples.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,YAgExB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,UA+C1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,UAiC7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,YAAY,EAAE,UAsB1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,YA0D3B,CAAC"}