@walkeros/cli 4.8.1 → 4.8.3-next-1793115089237

package/examples/contracts/leadgen.json

@@ -0,0 +1,240 @@
+{
+  "leadgen": {
+    "description": "Events of a B2B lead generation site, from the lead form to the won deal and the company account.",
+    "extend": "default",
+    "schema": {
+      "description": "What every lead generation event adds.",
+      "type": "object",
+      "properties": {
+        "user": {
+          "type": "object",
+          "properties": {
+            "account": {
+              "type": "string",
+              "description": "The id of the company account the user belongs to.",
+              "examples": ["0e8c78ea9d97a7b8185e8632"]
+            }
+          }
+        }
+      }
+    },
+    "events": {
+      "lead": {
+        "submit": {
+          "title": "Lead submit",
+          "description": "A visitor sent a form that makes them a lead, such as a contact, demo or quote request. Every lead generation site needs it. The lead is named by its id, its form, or both.",
+          "examples": [
+            {
+              "name": "lead submit",
+              "data": {
+                "type": "contact",
+                "source": "Trade show",
+                "value": 2500,
+                "currency": "EUR"
+              },
+              "nested": [
+                {
+                  "entity": "form",
+                  "data": {
+                    "id": "contact-form",
+                    "name": "contact"
+                  }
+                }
+              ],
+              "trigger": "submit"
+            }
+          ],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The lead.",
+              "dependentRequired": {
+                "value": ["currency"]
+              },
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the lead in your own system."
+                },
+                "type": {
+                  "type": "string",
+                  "description": "What the visitor asked for, such as contact, demo or quote.",
+                  "examples": ["contact"]
+                },
+                "source": {
+                  "type": "string",
+                  "description": "Where the lead came from, such as a trade show.",
+                  "examples": ["Trade show"]
+                },
+                "value": {
+                  "type": "number",
+                  "description": "The expected value of the lead.",
+                  "examples": [2500]
+                },
+                "currency": {
+                  "type": "string",
+                  "description": "The currency of value, as a three-letter code.",
+                  "examples": ["EUR"]
+                }
+              }
+            },
+            "nested": {
+              "type": "array",
+              "description": "The form that was sent.",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "entity": {
+                    "type": "string",
+                    "description": "A form.",
+                    "examples": ["form"]
+                  },
+                  "data": {
+                    "type": "object",
+                    "description": "The form.",
+                    "properties": {
+                      "id": {
+                        "type": ["string", "number"],
+                        "description": "The id of the form.",
+                        "examples": ["contact-form"]
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "The name of the form.",
+                        "examples": ["contact"]
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "anyOf": [
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["id"]
+                }
+              }
+            },
+            {
+              "required": ["nested"],
+              "properties": {
+                "nested": {
+                  "contains": {
+                    "required": ["entity"],
+                    "properties": {
+                      "entity": {
+                        "enum": ["form"]
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "convert": {
+          "title": "Lead convert",
+          "description": "A lead became a customer, and the deal is won. Recommended for lead generation sites.",
+          "examples": [
+            {
+              "name": "lead convert",
+              "data": {
+                "id": "lead_4711",
+                "value": 2500,
+                "currency": "EUR"
+              }
+            }
+          ],
+          "required": ["data"],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The won lead.",
+              "required": ["id"],
+              "dependentRequired": {
+                "value": ["currency"]
+              },
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the lead in your own system.",
+                  "examples": ["lead_4711"]
+                },
+                "value": {
+                  "type": "number",
+                  "description": "The value of the won deal.",
+                  "examples": [2500]
+                },
+                "currency": {
+                  "type": "string",
+                  "description": "The currency of value, as a three-letter code.",
+                  "examples": ["EUR"]
+                }
+              }
+            }
+          }
+        }
+      },
+      "account": {
+        "create": {
+          "title": "Account create",
+          "description": "A company account was created. Recommended for B2B sites with company accounts.",
+          "examples": [
+            {
+              "name": "account create",
+              "data": {
+                "id": "0e8c78ea9d97a7b8185e8632",
+                "name": "Initech",
+                "industry": "Technology",
+                "employees": 329,
+                "plan": "enterprise"
+              },
+              "user": {
+                "id": "us3r",
+                "account": "0e8c78ea9d97a7b8185e8632"
+              }
+            }
+          ],
+          "required": ["data"],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The company account.",
+              "required": ["id"],
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the company account.",
+                  "examples": ["0e8c78ea9d97a7b8185e8632"]
+                },
+                "name": {
+                  "type": "string",
+                  "description": "The name of the company.",
+                  "examples": ["Initech"]
+                },
+                "industry": {
+                  "type": "string",
+                  "description": "The industry of the company.",
+                  "examples": ["Technology"]
+                },
+                "employees": {
+                  "type": "number",
+                  "description": "How many people work at the company.",
+                  "examples": [329]
+                },
+                "plan": {
+                  "type": "string",
+                  "description": "The plan of the account.",
+                  "examples": ["enterprise"]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/examples/contracts/publisher.json

@@ -0,0 +1,372 @@
+{
+  "publisher": {
+    "description": "Events of a publisher or media site: the pieces people read, the videos they watch and the pieces they share.",
+    "extend": "default",
+    "events": {
+      "content": {
+        "view": {
+          "title": "Content view",
+          "description": "A page about one piece, such as an article or a video, was shown. Recommended for every publisher.",
+          "examples": [
+            {
+              "name": "content view",
+              "data": {
+                "id": "C_12345",
+                "type": "article",
+                "title": "How to clean leather",
+                "category": "guides"
+              },
+              "trigger": "load"
+            }
+          ],
+          "required": ["data"],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The piece.",
+              "required": ["id"],
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the piece.",
+                  "examples": ["C_12345"]
+                },
+                "type": {
+                  "type": "string",
+                  "description": "The format of the piece, such as article or video.",
+                  "examples": ["article"]
+                },
+                "title": {
+                  "type": "string",
+                  "description": "The title of the piece.",
+                  "examples": ["How to clean leather"]
+                },
+                "category": {
+                  "type": "string",
+                  "description": "The category of the piece.",
+                  "examples": ["guides"]
+                },
+                "author": {
+                  "type": "string",
+                  "description": "The author named on the piece."
+                }
+              }
+            }
+          }
+        },
+        "share": {
+          "title": "Content share",
+          "description": "A reader shared a piece. Recommended for most publishers.",
+          "examples": [
+            {
+              "name": "content share",
+              "data": {
+                "id": "C_12345"
+              },
+              "trigger": "click"
+            }
+          ],
+          "required": ["data"],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The shared piece.",
+              "required": ["id"],
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the piece.",
+                  "examples": ["C_12345"]
+                },
+                "method": {
+                  "type": "string",
+                  "description": "How the piece was shared."
+                }
+              }
+            }
+          }
+        }
+      },
+      "video": {
+        "start": {
+          "title": "Video start",
+          "description": "A video started to play for the first time. Every publisher with video needs it. The video is named by its id, its URL, or both.",
+          "examples": [
+            {
+              "name": "video start",
+              "data": {
+                "id": "0129370",
+                "title": "walkerOS in 3 minutes",
+                "duration": 183,
+                "position": 0,
+                "live": false
+              }
+            }
+          ],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The video.",
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the video.",
+                  "examples": ["0129370"]
+                },
+                "url": {
+                  "type": "string",
+                  "description": "The address of the video."
+                },
+                "title": {
+                  "type": "string",
+                  "description": "The title of the video.",
+                  "examples": ["walkerOS in 3 minutes"]
+                },
+                "duration": {
+                  "type": "number",
+                  "description": "The length of the video in seconds.",
+                  "examples": [183]
+                },
+                "provider": {
+                  "type": "string",
+                  "description": "The player or video service that plays the video."
+                },
+                "position": {
+                  "type": "number",
+                  "description": "Where playback is, in seconds from the start.",
+                  "examples": [0]
+                },
+                "live": {
+                  "type": "boolean",
+                  "description": "True for a live stream.",
+                  "examples": [false]
+                }
+              }
+            }
+          },
+          "anyOf": [
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["id"]
+                }
+              }
+            },
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["url"]
+                }
+              }
+            }
+          ]
+        },
+        "progress": {
+          "title": "Video progress",
+          "description": "Playback passed 10, 25, 50 or 75 percent of the video. Recommended for publishers with video.",
+          "examples": [
+            {
+              "name": "video progress",
+              "data": {
+                "id": "0129370",
+                "title": "walkerOS in 3 minutes",
+                "duration": 183,
+                "percent": 25,
+                "position": 46
+              }
+            }
+          ],
+          "required": ["data"],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The video.",
+              "required": ["percent"],
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the video.",
+                  "examples": ["0129370"]
+                },
+                "url": {
+                  "type": "string",
+                  "description": "The address of the video."
+                },
+                "title": {
+                  "type": "string",
+                  "description": "The title of the video.",
+                  "examples": ["walkerOS in 3 minutes"]
+                },
+                "duration": {
+                  "type": "number",
+                  "description": "The length of the video in seconds.",
+                  "examples": [183]
+                },
+                "percent": {
+                  "type": "number",
+                  "description": "The mark playback passed, in percent of the duration: 10, 25, 50 or 75.",
+                  "examples": [25]
+                },
+                "position": {
+                  "type": "number",
+                  "description": "Where playback is, in seconds from the start.",
+                  "examples": [46]
+                }
+              }
+            }
+          },
+          "anyOf": [
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["id"]
+                }
+              }
+            },
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["url"]
+                }
+              }
+            }
+          ]
+        },
+        "pause": {
+          "title": "Video pause",
+          "description": "The viewer paused the video. Recommended for publishers with video.",
+          "examples": [
+            {
+              "name": "video pause",
+              "data": {
+                "id": "0129370",
+                "title": "walkerOS in 3 minutes",
+                "duration": 183,
+                "position": 46
+              }
+            }
+          ],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The video.",
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the video.",
+                  "examples": ["0129370"]
+                },
+                "url": {
+                  "type": "string",
+                  "description": "The address of the video."
+                },
+                "title": {
+                  "type": "string",
+                  "description": "The title of the video.",
+                  "examples": ["walkerOS in 3 minutes"]
+                },
+                "duration": {
+                  "type": "number",
+                  "description": "The length of the video in seconds.",
+                  "examples": [183]
+                },
+                "position": {
+                  "type": "number",
+                  "description": "Where playback was paused, in seconds from the start.",
+                  "examples": [46]
+                }
+              }
+            }
+          },
+          "anyOf": [
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["id"]
+                }
+              }
+            },
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["url"]
+                }
+              }
+            }
+          ]
+        },
+        "complete": {
+          "title": "Video complete",
+          "description": "The video played to its end. Every publisher with video needs it.",
+          "examples": [
+            {
+              "name": "video complete",
+              "data": {
+                "id": "0129370",
+                "title": "walkerOS in 3 minutes",
+                "duration": 183,
+                "position": 183
+              }
+            }
+          ],
+          "properties": {
+            "data": {
+              "type": "object",
+              "description": "The video.",
+              "properties": {
+                "id": {
+                  "type": ["string", "number"],
+                  "description": "The id of the video.",
+                  "examples": ["0129370"]
+                },
+                "url": {
+                  "type": "string",
+                  "description": "The address of the video."
+                },
+                "title": {
+                  "type": "string",
+                  "description": "The title of the video.",
+                  "examples": ["walkerOS in 3 minutes"]
+                },
+                "duration": {
+                  "type": "number",
+                  "description": "The length of the video in seconds.",
+                  "examples": [183]
+                },
+                "position": {
+                  "type": "number",
+                  "description": "Where playback ended, in seconds from the start.",
+                  "examples": [183]
+                }
+              }
+            }
+          },
+          "anyOf": [
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["id"]
+                }
+              }
+            },
+            {
+              "required": ["data"],
+              "properties": {
+                "data": {
+                  "required": ["url"]
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  }
+}