forges 0.0.0 → 0.1.0

package/dist/schema/Comparison.json

@@ -0,0 +1,355 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "base": {
+      "type": "string",
+      "description": "The revision that the comparison starts from."
+    },
+    "head": {
+      "type": "string",
+      "description": "The revision that the comparison ends at."
+    },
+    "aheadBy": {
+      "type": "number",
+      "description": "The number of commits that `head` has and `base` lacks."
+    },
+    "behindBy": {
+      "type": "number",
+      "description": "The number of commits that `base` has and `head` lacks."
+    },
+    "commits": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/Commit"
+      },
+      "description": "The commits between the two revisions."
+    },
+    "files": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/ChangedFile"
+      }
+    },
+    "mergeBaseSha": {
+      "type": "string",
+      "description": "The merge base, where the forge reports it."
+    },
+    "raw": {}
+  },
+  "required": [
+    "base",
+    "head",
+    "commits",
+    "files",
+    "raw"
+  ],
+  "description": "The difference between two revisions.",
+  "x-forges-type": "Comparison",
+  "definitions": {
+    "Actor": {
+      "type": "object",
+      "properties": {
+        "forge": {
+          "$ref": "#/definitions/ForgeKind"
+        },
+        "instance": {
+          "$ref": "#/definitions/ForgeInstance",
+          "description": "The host of the instance, such as `github.com` or `git.example.com`."
+        },
+        "login": {
+          "type": "string"
+        },
+        "id": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "avatarUrl": {
+          "type": "string"
+        },
+        "url": {
+          "type": "string"
+        },
+        "typeRaw": {
+          "type": "string",
+          "description": "Forge-reported account type, retained verbatim for callers that classify further."
+        },
+        "isBotHint": {
+          "type": "boolean",
+          "description": "Hint derived from forge metadata that the actor is automation. Callers own the classification policy."
+        },
+        "app": {
+          "type": "object",
+          "properties": {
+            "slug": {
+              "type": "string"
+            },
+            "id": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "slug"
+          ],
+          "description": "The app behind a bot account, where the forge ties one to it (GitHub Apps' `slug[bot]` users)."
+        }
+      },
+      "required": [
+        "forge",
+        "id",
+        "instance",
+        "isBotHint",
+        "login"
+      ],
+      "description": "An account: a user, an organisation or a bot.",
+      "x-forges-type": "Actor"
+    },
+    "ChangedFile": {
+      "type": "object",
+      "properties": {
+        "path": {
+          "type": "string"
+        },
+        "previousPath": {
+          "type": "string",
+          "description": "Path before a rename or copy."
+        },
+        "status": {
+          "$ref": "#/definitions/FileStatus"
+        },
+        "statusRaw": {
+          "type": "string"
+        },
+        "additions": {
+          "type": "number"
+        },
+        "deletions": {
+          "type": "number"
+        },
+        "patch": {
+          "type": "string",
+          "description": "Unified diff for the file, where the forge returns one inline."
+        },
+        "sha": {
+          "type": "string",
+          "description": "Blob sha after the change."
+        },
+        "isBinary": {
+          "type": "boolean",
+          "description": "The file is binary, so it has no patch."
+        }
+      },
+      "required": [
+        "path",
+        "status"
+      ],
+      "description": "A file that a commit or pull request changed.",
+      "x-forges-type": "ChangedFile"
+    },
+    "Commit": {
+      "type": "object",
+      "properties": {
+        "ref": {
+          "$ref": "#/definitions/CommitRef"
+        },
+        "sha": {
+          "type": "string",
+          "description": "The full sha."
+        },
+        "message": {
+          "type": "string"
+        },
+        "author": {
+          "$ref": "#/definitions/CommitSignature",
+          "description": "Who wrote the change."
+        },
+        "committer": {
+          "$ref": "#/definitions/CommitSignature",
+          "description": "Who recorded the change."
+        },
+        "parents": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "url": {
+          "type": "string"
+        },
+        "stats": {
+          "type": "object",
+          "properties": {
+            "additions": {
+              "type": "number"
+            },
+            "deletions": {
+              "type": "number"
+            },
+            "total": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "additions",
+            "deletions"
+          ]
+        },
+        "files": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ChangedFile"
+          },
+          "description": "Present on `contents.commit`; absent from listings."
+        },
+        "raw": {}
+      },
+      "required": [
+        "ref",
+        "sha",
+        "message",
+        "parents",
+        "raw"
+      ],
+      "description": "A commit.",
+      "x-forges-type": "Commit"
+    },
+    "CommitRef": {
+      "type": "object",
+      "properties": {
+        "forge": {
+          "$ref": "#/definitions/ForgeKind"
+        },
+        "instance": {
+          "$ref": "#/definitions/ForgeInstance",
+          "description": "The host of the instance, such as `github.com` or `git.example.com`."
+        },
+        "repo": {
+          "$ref": "#/definitions/RepoRef"
+        },
+        "sha": {
+          "type": "string",
+          "description": "The full sha of the commit."
+        }
+      },
+      "required": [
+        "forge",
+        "instance",
+        "repo",
+        "sha"
+      ],
+      "description": "A commit addressed by its full sha.",
+      "x-forges-type": "CommitRef"
+    },
+    "CommitSignature": {
+      "type": "object",
+      "properties": {
+        "actor": {
+          "$ref": "#/definitions/Actor",
+          "description": "The account, where the forge can match it."
+        },
+        "name": {
+          "type": "string"
+        },
+        "email": {
+          "type": "string"
+        },
+        "date": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the commit was authored or committed."
+        }
+      },
+      "description": "Git authorship, with the forge account behind it where the forge matched one.",
+      "x-forges-type": "CommitSignature"
+    },
+    "FileStatus": {
+      "type": "string",
+      "enum": [
+        "added",
+        "modified",
+        "removed",
+        "renamed",
+        "copied",
+        "changed"
+      ],
+      "description": "How a commit or pull request changed a file.",
+      "x-forges-type": "FileStatus"
+    },
+    "ForgeInstance": {
+      "type": "string",
+      "description": "Host of a single forge deployment, for example `github.com` or `codeberg.org`.",
+      "x-forges-type": "ForgeInstance"
+    },
+    "ForgeKind": {
+      "anyOf": [
+        {
+          "$ref": "#/definitions/KnownForgeKind"
+        },
+        {
+          "type": "string"
+        }
+      ],
+      "description": "Identifier of a forge implementation. Unknown forges are permitted so that third-party providers can be registered without a core release.",
+      "x-forges-type": "ForgeKind"
+    },
+    "KnownForgeKind": {
+      "type": "string",
+      "enum": [
+        "github",
+        "gitlab",
+        "bitbucket",
+        "forgejo",
+        "gitea",
+        "tangled",
+        "gitee",
+        "azure-devops",
+        "cursor-origin",
+        "pushin"
+      ],
+      "description": "The forges this package ships providers for.",
+      "x-forges-type": "KnownForgeKind"
+    },
+    "RepoRef": {
+      "type": "object",
+      "properties": {
+        "forge": {
+          "$ref": "#/definitions/ForgeKind"
+        },
+        "instance": {
+          "$ref": "#/definitions/ForgeInstance",
+          "description": "The host of the instance, such as `github.com` or `git.example.com`."
+        },
+        "owner": {
+          "type": "string",
+          "description": "Full namespace path. On forges with nested groups (GitLab) this contains slashes, for example `acme/platform`; `name` never does."
+        },
+        "name": {
+          "type": "string",
+          "description": "Repository name. Empty for namespace-scoped refs."
+        },
+        "kind": {
+          "type": "string",
+          "enum": [
+            "repo",
+            "namespace"
+          ],
+          "description": "`'namespace'` for subjects that belong to a group rather than a repository (GitLab epics). Absent means a repository."
+        },
+        "externalId": {
+          "type": "string",
+          "description": "Stable forge-native identifier that survives renames and transfers: a GitHub, Forgejo or Gitea numeric id, a GitLab project or group id, a Bitbucket UUID or a Tangled repo DID. {@link repoKey} prefers it over `owner` and `name`."
+        }
+      },
+      "required": [
+        "forge",
+        "instance",
+        "name",
+        "owner"
+      ],
+      "description": "Addresses a repository by its forge, instance, owner and name.",
+      "x-forges-type": "RepoRef"
+    }
+  }
+}

package/dist/schema/Cursor.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "nextUrl": {
+      "type": "string",
+      "description": "Absolute URL of the next page, from a `Link` header or the body, on the requested origin."
+    },
+    "etag": {
+      "type": "string",
+      "description": "A validator for a conditional request."
+    },
+    "token": {
+      "type": "string",
+      "description": "Opaque forge-native cursor, for example a GraphQL `endCursor`."
+    }
+  },
+  "description": "Opaque-ish resumption token. Fields are optional because forges differ in what they support; callers should persist the whole object and hand it back.",
+  "x-forges-type": "Cursor",
+  "definitions": {}
+}

package/dist/schema/EventAction.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "opened",
+    "closed",
+    "reopened",
+    "merged",
+    "edited",
+    "created",
+    "deleted",
+    "submitted",
+    "labelled",
+    "unlabelled",
+    "assigned",
+    "unassigned",
+    "review_requested",
+    "synchronised",
+    "ready_for_review",
+    "converted_to_draft",
+    "published",
+    "renamed",
+    "transferred",
+    "archived",
+    "unarchived",
+    "added",
+    "removed",
+    "other"
+  ],
+  "description": "What happened, independent of `kind`, so \"anything that closed\" is `action === 'closed'` whatever the subject.",
+  "x-forges-type": "EventAction",
+  "definitions": {}
+}