npm - @authorbot/schemas - Versions diffs - 0.1.0 - Mend

@authorbot/schemas 0.1.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 (47) hide show

package/LICENSE +21 -0
package/dist/annotation.d.ts +172 -0
package/dist/annotation.js +96 -0
package/dist/attribution.d.ts +25 -0
package/dist/attribution.js +19 -0
package/dist/book.d.ts +104 -0
package/dist/book.js +105 -0
package/dist/build.d.ts +44 -0
package/dist/build.js +28 -0
package/dist/chapter.d.ts +37 -0
package/dist/chapter.js +29 -0
package/dist/character.d.ts +15 -0
package/dist/character.js +16 -0
package/dist/decision.d.ts +34 -0
package/dist/decision.js +31 -0
package/dist/index.d.ts +29 -0
package/dist/index.js +15 -0
package/dist/instance.d.ts +260 -0
package/dist/instance.js +101 -0
package/dist/json-schemas.d.ts +455 -0
package/dist/json-schemas.js +61 -0
package/dist/primitives.d.ts +58 -0
package/dist/primitives.js +101 -0
package/dist/release.d.ts +17 -0
package/dist/release.js +19 -0
package/dist/scripts/generate-json-schemas.d.ts +2 -0
package/dist/scripts/generate-json-schemas.js +14 -0
package/dist/story-graph.d.ts +132 -0
package/dist/story-graph.js +56 -0
package/dist/timeline.d.ts +35 -0
package/dist/timeline.js +28 -0
package/dist/work-item.d.ts +75 -0
package/dist/work-item.js +48 -0
package/json/annotation.schema.json +279 -0
package/json/attribution.schema.json +52 -0
package/json/book.schema.json +270 -0
package/json/build.schema.json +84 -0
package/json/chapter.schema.json +89 -0
package/json/character.schema.json +39 -0
package/json/decision.schema.json +69 -0
package/json/instance.schema.json +273 -0
package/json/release.schema.json +52 -0
package/json/reply.schema.json +43 -0
package/json/story-graph.schema.json +159 -0
package/json/timeline.schema.json +91 -0
package/json/work-item.schema.json +78 -0
package/package.json +56 -0

package/json/annotation.schema.json ADDED Viewed

@@ -0,0 +1,279 @@
+{
+  "$id": "authorbot.annotation/v1",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "oneOf": [
+    {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "type": "string",
+          "const": "authorbot.annotation/v1"
+        },
+        "id": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "comment",
+            "suggestion"
+          ]
+        },
+        "chapter_id": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "chapter_revision": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991
+        },
+        "author": {
+          "type": "string",
+          "pattern": "^(?:github|agent|system):[A-Za-z0-9][A-Za-z0-9._-]*$"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "open",
+            "work_item_created",
+            "accepted",
+            "resolved",
+            "rejected",
+            "withdrawn",
+            "superseded",
+            "orphaned",
+            "needs_reanchor"
+          ]
+        },
+        "created_at": {
+          "type": "string",
+          "pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:(?:[0-5]\\d|60)(?:\\.\\d{1,9})?Z$"
+        },
+        "scope": {
+          "type": "string",
+          "const": "range"
+        },
+        "target": {
+          "type": "object",
+          "properties": {
+            "blockId": {
+              "type": "string",
+              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+            },
+            "textPosition": {
+              "type": "object",
+              "properties": {
+                "start": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                },
+                "end": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991
+                }
+              },
+              "required": [
+                "start",
+                "end"
+              ],
+              "additionalProperties": false
+            },
+            "textQuote": {
+              "type": "object",
+              "properties": {
+                "exact": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 8192
+                },
+                "prefix": {
+                  "type": "string",
+                  "maxLength": 32
+                },
+                "suffix": {
+                  "type": "string",
+                  "maxLength": 32
+                }
+              },
+              "required": [
+                "exact"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "blockId",
+            "textPosition",
+            "textQuote"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "schema",
+        "id",
+        "kind",
+        "chapter_id",
+        "chapter_revision",
+        "author",
+        "status",
+        "created_at",
+        "scope",
+        "target"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "type": "string",
+          "const": "authorbot.annotation/v1"
+        },
+        "id": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "comment",
+            "suggestion"
+          ]
+        },
+        "chapter_id": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "chapter_revision": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991
+        },
+        "author": {
+          "type": "string",
+          "pattern": "^(?:github|agent|system):[A-Za-z0-9][A-Za-z0-9._-]*$"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "open",
+            "work_item_created",
+            "accepted",
+            "resolved",
+            "rejected",
+            "withdrawn",
+            "superseded",
+            "orphaned",
+            "needs_reanchor"
+          ]
+        },
+        "created_at": {
+          "type": "string",
+          "pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:(?:[0-5]\\d|60)(?:\\.\\d{1,9})?Z$"
+        },
+        "scope": {
+          "type": "string",
+          "const": "block"
+        },
+        "target": {
+          "type": "object",
+          "properties": {
+            "blockId": {
+              "type": "string",
+              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+            }
+          },
+          "required": [
+            "blockId"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "schema",
+        "id",
+        "kind",
+        "chapter_id",
+        "chapter_revision",
+        "author",
+        "status",
+        "created_at",
+        "scope",
+        "target"
+      ],
+      "additionalProperties": false
+    },
+    {
+      "type": "object",
+      "properties": {
+        "schema": {
+          "type": "string",
+          "const": "authorbot.annotation/v1"
+        },
+        "id": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "comment",
+            "suggestion"
+          ]
+        },
+        "chapter_id": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+        },
+        "chapter_revision": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 9007199254740991
+        },
+        "author": {
+          "type": "string",
+          "pattern": "^(?:github|agent|system):[A-Za-z0-9][A-Za-z0-9._-]*$"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "open",
+            "work_item_created",
+            "accepted",
+            "resolved",
+            "rejected",
+            "withdrawn",
+            "superseded",
+            "orphaned",
+            "needs_reanchor"
+          ]
+        },
+        "created_at": {
+          "type": "string",
+          "pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:(?:[0-5]\\d|60)(?:\\.\\d{1,9})?Z$"
+        },
+        "scope": {
+          "type": "string",
+          "const": "chapter"
+        }
+      },
+      "required": [
+        "schema",
+        "id",
+        "kind",
+        "chapter_id",
+        "chapter_revision",
+        "author",
+        "status",
+        "created_at",
+        "scope"
+      ],
+      "additionalProperties": false
+    }
+  ]
+}

package/json/attribution.schema.json ADDED Viewed

@@ -0,0 +1,52 @@
+{
+  "$id": "authorbot.attribution/v1",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schema": {
+      "type": "string",
+      "const": "authorbot.attribution/v1"
+    },
+    "chapter_id": {
+      "type": "string",
+      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+    },
+    "entries": {
+      "minItems": 1,
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "revision": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 9007199254740991
+          },
+          "actor": {
+            "type": "string",
+            "pattern": "^(?:github|agent|system):[A-Za-z0-9][A-Za-z0-9._-]*$"
+          },
+          "work_item_id": {
+            "type": "string",
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+          },
+          "commit": {
+            "type": "string",
+            "pattern": "^[0-9a-f]{7,64}$"
+          }
+        },
+        "required": [
+          "revision",
+          "actor"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "schema",
+    "chapter_id",
+    "entries"
+  ],
+  "additionalProperties": false
+}

package/json/book.schema.json ADDED Viewed

@@ -0,0 +1,270 @@
+{
+  "$id": "authorbot.book/v1",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schema": {
+      "type": "string",
+      "const": "authorbot.book/v1"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1
+    },
+    "slug": {
+      "type": "string",
+      "pattern": "^[a-z0-9][a-z0-9-]*$"
+    },
+    "language": {
+      "type": "string",
+      "pattern": "^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{1,8})*$"
+    },
+    "license": {
+      "type": "string",
+      "minLength": 1
+    },
+    "repository": {
+      "type": "object",
+      "properties": {
+        "default_branch": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "content": {
+      "type": "object",
+      "properties": {
+        "chapters_glob": {
+          "type": "string",
+          "minLength": 1
+        },
+        "raw_html": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "planning": {
+      "type": "object",
+      "properties": {
+        "method": {
+          "type": "string",
+          "minLength": 1
+        },
+        "outline": {
+          "type": "string",
+          "minLength": 1
+        },
+        "timeline": {
+          "type": "string",
+          "minLength": 1
+        },
+        "characters_glob": {
+          "type": "string",
+          "minLength": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "publication": {
+      "type": "object",
+      "properties": {
+        "chapter_url": {
+          "type": "string",
+          "minLength": 1
+        },
+        "api_url": {
+          "type": "string",
+          "minLength": 1
+        },
+        "show_revision": {
+          "type": "boolean"
+        },
+        "show_attribution": {
+          "type": "boolean"
+        },
+        "show_public_annotations": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "collaboration": {
+      "type": "object",
+      "properties": {
+        "annotation_policy": {
+          "type": "string",
+          "enum": [
+            "open",
+            "approval-gated",
+            "collaborators-only",
+            "locked"
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    "governance": {
+      "type": "object",
+      "properties": {
+        "rules": {
+          "type": "object",
+          "propertyNames": {
+            "type": "string",
+            "pattern": "^[a-z][a-z0-9_]*$"
+          },
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "version": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 9007199254740991
+              },
+              "trigger": {
+                "type": "string",
+                "enum": [
+                  "vote_changed"
+                ]
+              },
+              "when": {
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "all": {
+                        "minItems": 1,
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "metric": {
+                              "type": "string",
+                              "pattern": "^[a-z][a-z0-9_]*$"
+                            },
+                            "operator": {
+                              "type": "string",
+                              "enum": [
+                                "gte",
+                                "gt",
+                                "lte",
+                                "lt",
+                                "eq",
+                                "neq"
+                              ]
+                            },
+                            "value": {
+                              "type": "number"
+                            }
+                          },
+                          "required": [
+                            "metric",
+                            "operator",
+                            "value"
+                          ],
+                          "additionalProperties": false
+                        }
+                      }
+                    },
+                    "required": [
+                      "all"
+                    ],
+                    "additionalProperties": false
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "any": {
+                        "minItems": 1,
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "metric": {
+                              "type": "string",
+                              "pattern": "^[a-z][a-z0-9_]*$"
+                            },
+                            "operator": {
+                              "type": "string",
+                              "enum": [
+                                "gte",
+                                "gt",
+                                "lte",
+                                "lt",
+                                "eq",
+                                "neq"
+                              ]
+                            },
+                            "value": {
+                              "type": "number"
+                            }
+                          },
+                          "required": [
+                            "metric",
+                            "operator",
+                            "value"
+                          ],
+                          "additionalProperties": false
+                        }
+                      }
+                    },
+                    "required": [
+                      "any"
+                    ],
+                    "additionalProperties": false
+                  }
+                ]
+              },
+              "action": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "const": "create_work_item"
+                  },
+                  "work_type": {
+                    "type": "string",
+                    "enum": [
+                      "revise_range",
+                      "revise_block",
+                      "revise_chapter",
+                      "write_chapter",
+                      "resolve_conflict",
+                      "planning"
+                    ]
+                  }
+                },
+                "required": [
+                  "type",
+                  "work_type"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "version",
+              "when",
+              "action"
+            ],
+            "additionalProperties": false
+          }
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "schema",
+    "id",
+    "title",
+    "slug",
+    "language"
+  ],
+  "additionalProperties": false
+}

package/json/build.schema.json ADDED Viewed

@@ -0,0 +1,84 @@
+{
+  "$id": "authorbot.build/v1",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "schema": {
+      "type": "string",
+      "const": "authorbot.build/v1"
+    },
+    "commit": {
+      "anyOf": [
+        {
+          "type": "string",
+          "pattern": "^[0-9a-f]{7,64}$"
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "built_at": {
+      "type": "string",
+      "pattern": "^\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:(?:[0-5]\\d|60)(?:\\.\\d{1,9})?Z$"
+    },
+    "publisher_version": {
+      "type": "string",
+      "minLength": 1
+    },
+    "base_url": {
+      "type": "string",
+      "minLength": 1
+    },
+    "chapters": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
+          },
+          "slug": {
+            "type": "string",
+            "pattern": "^[a-z0-9][a-z0-9-]*$"
+          },
+          "revision": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 9007199254740991
+          },
+          "title": {
+            "type": "string",
+            "minLength": 1
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "draft",
+              "proposed",
+              "published",
+              "archived"
+            ]
+          }
+        },
+        "required": [
+          "id",
+          "slug",
+          "revision",
+          "title",
+          "status"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "schema",
+    "commit",
+    "built_at",
+    "publisher_version",
+    "chapters"
+  ],
+  "additionalProperties": false
+}