@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/WindowFunctionNode.json

@@ -0,0 +1,104 @@
+{
+  "$ref": "#/definitions/WindowFunctionNode",
+  "definitions": {
+    "WindowFunctionNode": {
+      "type": "object",
+      "properties": {
+        "function": {
+          "type": "string",
+          "enum": [
+            "row_number",
+            "rank",
+            "dense_rank",
+            "percent_rank",
+            "lag",
+            "lead",
+            "first_value",
+            "last_value",
+            "sum",
+            "avg",
+            "count",
+            "min",
+            "max"
+          ],
+          "description": "Window function name"
+        },
+        "field": {
+          "type": "string",
+          "description": "Field to operate on (for aggregate window functions)"
+        },
+        "alias": {
+          "type": "string",
+          "description": "Result column alias"
+        },
+        "over": {
+          "type": "object",
+          "properties": {
+            "partitionBy": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "PARTITION BY fields"
+            },
+            "orderBy": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "field": {
+                    "type": "string"
+                  },
+                  "order": {
+                    "type": "string",
+                    "enum": [
+                      "asc",
+                      "desc"
+                    ],
+                    "default": "asc"
+                  }
+                },
+                "required": [
+                  "field"
+                ],
+                "additionalProperties": false
+              },
+              "description": "ORDER BY specification"
+            },
+            "frame": {
+              "type": "object",
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "rows",
+                    "range"
+                  ]
+                },
+                "start": {
+                  "type": "string",
+                  "description": "Frame start (e.g., \"UNBOUNDED PRECEDING\", \"1 PRECEDING\")"
+                },
+                "end": {
+                  "type": "string",
+                  "description": "Frame end (e.g., \"CURRENT ROW\", \"1 FOLLOWING\")"
+                }
+              },
+              "additionalProperties": false,
+              "description": "Window frame specification"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Window specification (OVER clause)"
+        }
+      },
+      "required": [
+        "function",
+        "alias",
+        "over"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WindowSpec.json

@@ -0,0 +1,65 @@
+{
+  "$ref": "#/definitions/WindowSpec",
+  "definitions": {
+    "WindowSpec": {
+      "type": "object",
+      "properties": {
+        "partitionBy": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "PARTITION BY fields"
+        },
+        "orderBy": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "field": {
+                "type": "string"
+              },
+              "order": {
+                "type": "string",
+                "enum": [
+                  "asc",
+                  "desc"
+                ],
+                "default": "asc"
+              }
+            },
+            "required": [
+              "field"
+            ],
+            "additionalProperties": false
+          },
+          "description": "ORDER BY specification"
+        },
+        "frame": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "rows",
+                "range"
+              ]
+            },
+            "start": {
+              "type": "string",
+              "description": "Frame start (e.g., \"UNBOUNDED PRECEDING\", \"1 PRECEDING\")"
+            },
+            "end": {
+              "type": "string",
+              "description": "Frame end (e.g., \"CURRENT ROW\", \"1 FOLLOWING\")"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Window frame specification"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$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/json-schema/ZIndex.json

@@ -0,0 +1,44 @@
+{
+  "$ref": "#/definitions/ZIndex",
+  "definitions": {
+    "ZIndex": {
+      "type": "object",
+      "properties": {
+        "base": {
+          "type": "number",
+          "description": "Base z-index (e.g., 0)"
+        },
+        "dropdown": {
+          "type": "number",
+          "description": "Dropdown z-index (e.g., 1000)"
+        },
+        "sticky": {
+          "type": "number",
+          "description": "Sticky z-index (e.g., 1020)"
+        },
+        "fixed": {
+          "type": "number",
+          "description": "Fixed z-index (e.g., 1030)"
+        },
+        "modalBackdrop": {
+          "type": "number",
+          "description": "Modal backdrop z-index (e.g., 1040)"
+        },
+        "modal": {
+          "type": "number",
+          "description": "Modal z-index (e.g., 1050)"
+        },
+        "popover": {
+          "type": "number",
+          "description": "Popover z-index (e.g., 1060)"
+        },
+        "tooltip": {
+          "type": "number",
+          "description": "Tooltip z-index (e.g., 1070)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/package.json

@@ -1,34 +1,48 @@
 {
   "name": "@objectstack/spec",
-  "version": "0.1.0",
-  "description": "ObjectStack Protocol & Specification - Type definitions and schemas",
+  "version": "0.1.2",
+  "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",
+  "license": "Apache-2.0",
   "devDependencies": {
-    "@changesets/cli": "^2.29.8",
-    "typescript": "^5.9.3"
+    "@types/node": "^20.10.0",
+    "@vitest/coverage-v8": "^2.1.8",
+    "tsx": "^4.21.0",
+    "typescript": "^5.3.0",
+    "vitest": "^2.1.8",
+    "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",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
   }
-}
+}

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"}