npm - cox-protocol-package - Versions diffs - 1.0.2 → 1.2.0 - Mend

cox-protocol-package 1.0.2 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (74) hide show

package/CHANGELOG.md +22 -0
package/COX_FILE_FORMAT_SPECIFICATION_v1.0.md +40 -200
package/FINALIZATION.md +50 -0
package/LocalAppManager/Dashboard/analytics_sidebar_panels/analytics_sidebar_panels.cox +56 -0
package/LocalAppManager/Dashboard/analytics_sidebar_panels/analytics_sidebar_panels_screenshot.placeholder.txt +1 -0
package/LocalAppManager/Dashboard/dashboard.cox +62 -0
package/LocalAppManager/Dashboard/dashboard_screenshot.placeholder.txt +1 -0
package/LocalAppManager/Dashboard/left_navigation_sidebar/left_navigation_sidebar.cox +56 -0
package/LocalAppManager/Dashboard/left_navigation_sidebar/left_navigation_sidebar_screenshot.placeholder.txt +1 -0
package/LocalAppManager/Dashboard/projects_grid_cards/projects_grid_cards.cox +56 -0
package/LocalAppManager/Dashboard/projects_grid_cards/projects_grid_cards_screenshot.placeholder.txt +1 -0
package/LocalAppManager/Dashboard/top_header_stats_bar/top_header_stats_bar.cox +56 -0
package/LocalAppManager/Dashboard/top_header_stats_bar/top_header_stats_bar_screenshot.placeholder.txt +1 -0
package/MANIFEST.in +20 -0
package/README.md +67 -154
package/bin/cox-protocol.js +23 -97
package/cox_protocol/__init__.py +2 -0
package/cox_protocol/__main__.py +3 -0
package/cox_protocol/compiler.py +273 -0
package/cox_protocol/cox_cli.py +146 -0
package/cox_protocol/cox_lib.py +599 -0
package/cox_protocol/package_target.py +262 -0
package/cox_protocol/react_target.py +306 -0
package/cox_protocol/scaffold.py +56 -0
package/cox_protocol/schemas/cox.component.v1.schema.json +180 -0
package/cox_protocol/schemas/cox.crop_metadata.v1.schema.json +83 -0
package/cox_protocol/schemas/cox.manifest.v1.schema.json +172 -0
package/cox_protocol/schemas/cox.page.v1.schema.json +242 -0
package/cox_protocol/schemas/cox.protocol.v1.schema.json +38 -0
package/cox_protocol/starter/README.md +7 -0
package/cox_protocol/starter/manifest.cox +26 -0
package/cox_protocol/starter/page/action_button/action_button.cox +34 -0
package/cox_protocol/starter/page/action_button/reference.svg +1 -0
package/cox_protocol/starter/page/page.cox +39 -0
package/cox_protocol/starter/page/reference.svg +1 -0
package/editor-support/vscode/CHANGELOG.md +6 -0
package/editor-support/vscode/README.md +2 -1
package/editor-support/vscode/package.json +3 -3
package/editor-support/vscode/snippets/cox-common.json +1 -1
package/editor-support/vscode/snippets/cox-component.json +2 -1
package/editor-support/vscode/snippets/cox-crop-metadata.json +1 -1
package/editor-support/vscode/snippets/cox-manifest.json +1 -1
package/editor-support/vscode/snippets/cox-page.json +2 -1
package/editor-support/vscode/snippets/cox-protocol.json +1 -1
package/examples/quickstart/README.md +7 -0
package/examples/quickstart/manifest.cox +26 -0
package/examples/quickstart/page/action_button/action_button.cox +34 -0
package/examples/quickstart/page/action_button/reference.svg +1 -0
package/examples/quickstart/page/page.cox +39 -0
package/examples/quickstart/page/reference.svg +1 -0
package/guides/contract-demo.md +24 -0
package/guides/npm-installation.md +16 -287
package/manifest.cox +7 -4
package/package.json +30 -14
package/protocols/recursive_decomposition_protocol.cox +8 -8
package/pyproject.toml +17 -6
package/schemas/cox.component.v1.schema.json +17 -4
package/schemas/cox.crop_metadata.v1.schema.json +1 -1
package/schemas/cox.manifest.v1.schema.json +1 -1
package/schemas/cox.page.v1.schema.json +17 -4
package/schemas/cox.protocol.v1.schema.json +1 -1
package/scripts/check_distribution.py +87 -0
package/scripts/demo.py +62 -0
package/scripts/package-vscode.mjs +12 -0
package/scripts/release_check.py +86 -0
package/tests/conftest.py +21 -0
package/tests/test_cli_and_typescript.py +123 -0
package/tests/test_compiler.py +279 -0
package/tests/test_validation.py +215 -0
package/tools/__init__.py +2 -2
package/tools/cox_cli.py +2 -123
package/tools/cox_lib.py +2 -558
package/tools/package_target.py +2 -214
package/tools/react_target.py +2 -278

package/cox_protocol/schemas/cox.component.v1.schema.json ADDED Viewed

@@ -0,0 +1,180 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "cox.component.v1",
+  "title": "COX Component Spec",
+  "type": "object",
+  "required": [
+    "CoxVersion",
+    "FileType",
+    "ComponentName",
+    "Slug",
+    "Schema",
+    "Role",
+    "EvidenceSummary",
+    "VisibleStructure",
+    "Interactions",
+    "NamingDecision"
+  ],
+  "properties": {
+    "CoxVersion": {
+      "const": "1.0"
+    },
+    "FileType": {
+      "const": "component_spec"
+    },
+    "ComponentName": {
+      "type": "string",
+      "minLength": 1
+    },
+    "Slug": {
+      "type": "string",
+      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+    },
+    "Schema": {
+      "const": "cox.component.v1"
+    },
+    "Role": {
+      "type": "string"
+    },
+    "EvidenceSummary": {
+      "$ref": "#/$defs/evidenceSummary"
+    },
+    "VisibleStructure": {
+      "type": "object"
+    },
+    "Interactions": {
+      "$ref": "#/$defs/interactionSummary"
+    },
+    "NamingDecision": {
+      "$ref": "#/$defs/namingDecision"
+    },
+    "VisualStyle": {
+      "type": "object"
+    },
+    "Responsive": {
+      "type": "object"
+    },
+    "ImplementationHints": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "ChildSubcomponents": {
+      "type": "array"
+    }
+  },
+  "$defs": {
+    "evidenceSummary": {
+      "type": "object",
+      "properties": {
+        "Visible": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "UserSpecified": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Inferred": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Intended": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Recommended": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "interactionSummary": {
+      "type": "object",
+      "properties": {
+        "Visible": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Inferred": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Intended": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Recommended": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "UserSpecified": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "namingDecision": {
+      "type": "object",
+      "required": [
+        "ChosenName",
+        "Reason",
+        "RejectedAlternatives",
+        "AmbiguityRisk",
+        "EvidenceLevel"
+      ],
+      "properties": {
+        "ChosenName": {
+          "type": "string"
+        },
+        "Reason": {
+          "type": "string"
+        },
+        "RejectedAlternatives": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "AmbiguityRisk": {
+          "type": "string"
+        },
+        "EvidenceLevel": {
+          "type": "string",
+          "enum": [
+            "Visible",
+            "UserSpecified",
+            "Inferred",
+            "Intended",
+            "Recommended"
+          ]
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": true
+}

package/cox_protocol/schemas/cox.crop_metadata.v1.schema.json ADDED Viewed

@@ -0,0 +1,83 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "cox.crop_metadata.v1",
+  "title": "COX Crop Metadata",
+  "type": "object",
+  "required": [
+    "CoxVersion",
+    "FileType",
+    "Slug",
+    "Schema",
+    "SourceScreenshot",
+    "OutputScreenshot",
+    "BoundaryConfidence",
+    "EstimatedBoundingBox"
+  ],
+  "properties": {
+    "CoxVersion": {
+      "const": "1.0"
+    },
+    "FileType": {
+      "const": "crop_metadata"
+    },
+    "Slug": {
+      "type": "string",
+      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+    },
+    "Schema": {
+      "const": "cox.crop_metadata.v1"
+    },
+    "SourceScreenshot": {
+      "type": "string"
+    },
+    "OutputScreenshot": {
+      "type": "string"
+    },
+    "BoundaryConfidence": {
+      "type": "string",
+      "enum": [
+        "High",
+        "Medium",
+        "Low"
+      ]
+    },
+    "EstimatedBoundingBox": {
+      "type": "object",
+      "required": [
+        "Unit",
+        "X",
+        "Y",
+        "Width",
+        "Height"
+      ],
+      "properties": {
+        "Unit": {
+          "type": "string"
+        },
+        "X": {
+          "type": "string"
+        },
+        "Y": {
+          "type": "string"
+        },
+        "Width": {
+          "type": "string"
+        },
+        "Height": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    },
+    "IncludedPaddingReason": {
+      "type": "string"
+    },
+    "ExcludedRegions": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": true
+}

package/cox_protocol/schemas/cox.manifest.v1.schema.json ADDED Viewed

@@ -0,0 +1,172 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "cox.manifest.v1",
+  "title": "COX Manifest",
+  "type": "object",
+  "required": [
+    "CoxVersion",
+    "FileType",
+    "Slug",
+    "Schema",
+    "ProjectName",
+    "ProtocolExtension",
+    "MimeType",
+    "EntryPoint",
+    "Pages"
+  ],
+  "properties": {
+    "CoxVersion": {
+      "const": "1.0"
+    },
+    "FileType": {
+      "const": "manifest"
+    },
+    "Slug": {
+      "type": "string",
+      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+    },
+    "Schema": {
+      "const": "cox.manifest.v1"
+    },
+    "ProjectName": {
+      "type": "string",
+      "minLength": 1
+    },
+    "PackageName": {
+      "type": "string"
+    },
+    "ProtocolExtension": {
+      "const": ".cox"
+    },
+    "MimeType": {
+      "const": "application/vnd.cox+yaml"
+    },
+    "Encoding": {
+      "const": "UTF-8"
+    },
+    "SyntaxBase": {
+      "const": "YAML-compatible structured text"
+    },
+    "EntryPoint": {
+      "const": "manifest.cox"
+    },
+    "ReferenceDocs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "GuideDocs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "ProtocolDocs": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "SkillBundles": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "Schemas": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "ToolingFiles": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "Pages": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "required": [
+          "PageName",
+          "Slug",
+          "Folder",
+          "PageInstruction",
+          "PageScreenshotPlaceholder",
+          "Components"
+        ],
+        "properties": {
+          "PageName": {
+            "type": "string"
+          },
+          "Slug": {
+            "type": "string",
+            "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+          },
+          "Folder": {
+            "type": "string"
+          },
+          "PageInstruction": {
+            "type": "string"
+          },
+          "PageScreenshotPlaceholder": {
+            "type": "string"
+          },
+          "Components": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "required": [
+                "Slug",
+                "Folder",
+                "ComponentInstruction",
+                "ComponentScreenshotPlaceholder"
+              ],
+              "properties": {
+                "Slug": {
+                  "type": "string",
+                  "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+                },
+                "Folder": {
+                  "type": "string"
+                },
+                "ComponentInstruction": {
+                  "type": "string"
+                },
+                "ComponentScreenshotPlaceholder": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": true
+            }
+          }
+        },
+        "additionalProperties": true
+      }
+    },
+    "BuildTargets": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true,
+      "items": {
+        "type": "string",
+        "enum": [
+          "json",
+          "react",
+          "package"
+        ]
+      }
+    },
+    "VerificationRules": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": true
+}

package/cox_protocol/schemas/cox.page.v1.schema.json ADDED Viewed

@@ -0,0 +1,242 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "cox.page.v1",
+  "title": "COX Page Spec",
+  "type": "object",
+  "required": [
+    "CoxVersion",
+    "FileType",
+    "PageName",
+    "Slug",
+    "Schema",
+    "ProjectName",
+    "EvidenceSummary",
+    "VisibleStructure",
+    "Interactions",
+    "NamingDecision",
+    "Layout",
+    "Children",
+    "RecursiveDecompositionDecision"
+  ],
+  "properties": {
+    "CoxVersion": {
+      "const": "1.0"
+    },
+    "FileType": {
+      "const": "page_spec"
+    },
+    "PageName": {
+      "type": "string",
+      "minLength": 1
+    },
+    "Slug": {
+      "type": "string",
+      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+    },
+    "Schema": {
+      "const": "cox.page.v1"
+    },
+    "ProjectName": {
+      "type": "string",
+      "minLength": 1
+    },
+    "PageType": {
+      "type": "string"
+    },
+    "EvidenceSummary": {
+      "$ref": "#/$defs/evidenceSummary"
+    },
+    "VisibleStructure": {
+      "type": "object"
+    },
+    "Interactions": {
+      "$ref": "#/$defs/interactionSummary"
+    },
+    "NamingDecision": {
+      "$ref": "#/$defs/namingDecision"
+    },
+    "Layout": {
+      "type": "object",
+      "required": [
+        "Desktop",
+        "Tablet",
+        "Mobile"
+      ],
+      "properties": {
+        "Desktop": {
+          "type": "string"
+        },
+        "Tablet": {
+          "type": "string"
+        },
+        "Mobile": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    },
+    "Children": {
+      "type": "object",
+      "properties": {
+        "Components": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "required": [
+              "Slug",
+              "Folder",
+              "Role"
+            ],
+            "properties": {
+              "Slug": {
+                "type": "string",
+                "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+              },
+              "Folder": {
+                "type": "string"
+              },
+              "Role": {
+                "type": "string"
+              }
+            },
+            "additionalProperties": true
+          }
+        }
+      },
+      "additionalProperties": true
+    },
+    "RecursiveDecompositionDecision": {
+      "type": "object",
+      "required": [
+        "Complexity",
+        "Reason",
+        "Action"
+      ],
+      "properties": {
+        "Complexity": {
+          "type": "string"
+        },
+        "Reason": {
+          "type": "string"
+        },
+        "Action": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "$defs": {
+    "evidenceSummary": {
+      "type": "object",
+      "properties": {
+        "Visible": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "UserSpecified": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Inferred": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Intended": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Recommended": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "interactionSummary": {
+      "type": "object",
+      "properties": {
+        "Visible": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Inferred": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Intended": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "Recommended": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "UserSpecified": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "namingDecision": {
+      "type": "object",
+      "required": [
+        "ChosenName",
+        "Reason",
+        "RejectedAlternatives",
+        "AmbiguityRisk",
+        "EvidenceLevel"
+      ],
+      "properties": {
+        "ChosenName": {
+          "type": "string"
+        },
+        "Reason": {
+          "type": "string"
+        },
+        "RejectedAlternatives": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "AmbiguityRisk": {
+          "type": "string"
+        },
+        "EvidenceLevel": {
+          "type": "string",
+          "enum": [
+            "Visible",
+            "UserSpecified",
+            "Inferred",
+            "Intended",
+            "Recommended"
+          ]
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "additionalProperties": true
+}

package/cox_protocol/schemas/cox.protocol.v1.schema.json ADDED Viewed

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "cox.protocol.v1",
+  "title": "COX Protocol Document",
+  "type": "object",
+  "required": [
+    "CoxVersion",
+    "FileType",
+    "Slug",
+    "Schema",
+    "ProtocolName",
+    "Purpose"
+  ],
+  "properties": {
+    "CoxVersion": {
+      "const": "1.0"
+    },
+    "FileType": {
+      "const": "protocol_doc"
+    },
+    "Slug": {
+      "type": "string",
+      "pattern": "^[a-z0-9]+(_[a-z0-9]+)*$"
+    },
+    "Schema": {
+      "const": "cox.protocol.v1"
+    },
+    "ProtocolName": {
+      "type": "string",
+      "minLength": 1
+    },
+    "Purpose": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "additionalProperties": true
+}