forges 0.0.0 → 0.1.0

package/dist/schema/UpsertCommentResult.json

@@ -0,0 +1,355 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "comment": {
+      "$ref": "#/definitions/Comment",
+      "description": "The comment that was created or edited."
+    },
+    "created": {
+      "type": "boolean",
+      "description": "`false` when an existing comment with the same key was edited."
+    }
+  },
+  "required": [
+    "comment",
+    "created"
+  ],
+  "description": "What `threads.upsertComment()` did.",
+  "x-forges-type": "UpsertCommentResult",
+  "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"
+    },
+    "Comment": {
+      "type": "object",
+      "properties": {
+        "ref": {
+          "$ref": "#/definitions/CommentRef"
+        },
+        "body": {
+          "type": "string"
+        },
+        "author": {
+          "$ref": "#/definitions/Actor"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "url": {
+          "type": "string"
+        },
+        "reactions": {
+          "$ref": "#/definitions/ReactionSummary"
+        },
+        "thread": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "resolved": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "id",
+            "resolved"
+          ],
+          "description": "The resolvable conversation the comment belongs to, where the forge has one; `resolveReviewThread()` takes its id."
+        },
+        "raw": {}
+      },
+      "required": [
+        "ref",
+        "body",
+        "raw"
+      ],
+      "description": "A comment on a thread.",
+      "x-forges-type": "Comment"
+    },
+    "CommentRef": {
+      "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`."
+        },
+        "thread": {
+          "$ref": "#/definitions/ThreadRef"
+        },
+        "id": {
+          "type": "string",
+          "description": "Forge-native comment id; an AT-URI on Tangled."
+        }
+      },
+      "required": [
+        "forge",
+        "id",
+        "instance",
+        "thread"
+      ],
+      "description": "Reference to a comment on a thread.",
+      "x-forges-type": "CommentRef"
+    },
+    "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"
+    },
+    "ReactionContent": {
+      "type": "string",
+      "enum": [
+        "+1",
+        "-1",
+        "laugh",
+        "confused",
+        "heart",
+        "hooray",
+        "rocket",
+        "eyes"
+      ],
+      "description": "The reactions every forge with reactions has in common, named as GitHub names them. A {@link Reaction} whose forge-native name has no entry here has `content: 'other'`, with the forge-native name in `contentRaw`.",
+      "x-forges-type": "ReactionContent"
+    },
+    "ReactionSummary": {
+      "type": "object",
+      "properties": {
+        "total": {
+          "type": "number",
+          "description": "The number of reactions of every kind."
+        },
+        "counts": {
+          "type": "object",
+          "properties": {
+            "+1": {
+              "type": "number"
+            },
+            "-1": {
+              "type": "number"
+            },
+            "laugh": {
+              "type": "number"
+            },
+            "confused": {
+              "type": "number"
+            },
+            "heart": {
+              "type": "number"
+            },
+            "hooray": {
+              "type": "number"
+            },
+            "rocket": {
+              "type": "number"
+            },
+            "eyes": {
+              "type": "number"
+            }
+          },
+          "description": "The number of reactions of each kind. A reaction with no {@link ReactionContent} entry has no key here."
+        },
+        "viewerReacted": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/ReactionContent"
+          },
+          "description": "Reactions the authenticated account has left. Absent when the forge does not report them."
+        }
+      },
+      "required": [
+        "total",
+        "counts"
+      ],
+      "description": "The reactions on a thread or comment, counted.",
+      "x-forges-type": "ReactionSummary"
+    },
+    "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"
+    },
+    "ThreadKind": {
+      "type": "string",
+      "enum": [
+        "issue",
+        "pull_request",
+        "discussion",
+        "commit",
+        "other"
+      ],
+      "description": "Kind of thread. `'other'` holds forge-specific subjects with no shared kind (check suites, epics); `ThreadRef.typeRaw` names them.",
+      "x-forges-type": "ThreadKind"
+    },
+    "ThreadRef": {
+      "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"
+        },
+        "kind": {
+          "$ref": "#/definitions/ThreadKind"
+        },
+        "typeRaw": {
+          "type": "string",
+          "description": "Forge-native subject type, for example `PullRequest` or `MergeRequest`."
+        },
+        "number": {
+          "type": "string",
+          "description": "Per-repo thread number, the commit sha for `kind: 'commit'`, or the forge-native id for `kind: 'other'`. Absent when the forge did not identify the thread; such a ref cannot be fetched or keyed until enriched."
+        },
+        "displayNumber": {
+          "type": "string",
+          "description": "Human-facing per-repo number, when it differs from `number`. Tangled identifies threads by AT-URI but shows numbers in its UI and webhooks."
+        },
+        "externalId": {
+          "type": "string",
+          "description": "Globally unique forge-native identifier, where one exists: a GitHub `node_id`, a GitLab global id, or an atproto record URI."
+        }
+      },
+      "required": [
+        "forge",
+        "instance",
+        "kind",
+        "repo"
+      ],
+      "description": "Reference to a thread. A thread `number` is unique only within its repo, so the repo is always carried alongside it.",
+      "x-forges-type": "ThreadRef"
+    }
+  }
+}

package/dist/schema/User.json

@@ -0,0 +1,123 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "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)."
+    },
+    "bio": {
+      "type": "string"
+    },
+    "company": {
+      "type": "string"
+    },
+    "location": {
+      "type": "string"
+    },
+    "websiteUrl": {
+      "type": "string"
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "followers": {
+      "type": "number"
+    },
+    "following": {
+      "type": "number"
+    },
+    "publicRepos": {
+      "type": "number"
+    },
+    "raw": {}
+  },
+  "required": [
+    "forge",
+    "id",
+    "instance",
+    "isBotHint",
+    "login",
+    "raw"
+  ],
+  "description": "A user or organisation account, as `users.get()` reads it.",
+  "x-forges-type": "User",
+  "definitions": {
+    "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"
+    }
+  }
+}

package/dist/schema/Webhook.json

@@ -0,0 +1,188 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "ref": {
+      "$ref": "#/definitions/WebhookRef"
+    },
+    "url": {
+      "type": "string"
+    },
+    "events": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/EventKind"
+      },
+      "description": "Normalised kinds the subscription covers, derived from `nativeEvents`."
+    },
+    "nativeEvents": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "description": "Forge-native event names exactly as the forge stores them."
+    },
+    "active": {
+      "type": "boolean"
+    },
+    "contentType": {
+      "type": "string",
+      "enum": [
+        "json",
+        "form"
+      ],
+      "description": "`'json'` or `'form'` where the forge offers a choice."
+    },
+    "createdAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "updatedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "secret": {
+      "not": {},
+      "description": "Never returned: no forge reads a webhook secret back."
+    },
+    "raw": {}
+  },
+  "required": [
+    "ref",
+    "url",
+    "events",
+    "nativeEvents",
+    "active",
+    "raw"
+  ],
+  "description": "A registered webhook. The secret is never readable, so it is never returned.",
+  "x-forges-type": "Webhook",
+  "definitions": {
+    "EventKind": {
+      "type": "string",
+      "enum": [
+        "comment",
+        "review",
+        "review_comment",
+        "commit",
+        "label",
+        "state_change",
+        "assignment",
+        "mention",
+        "referenced",
+        "reaction",
+        "push",
+        "ref",
+        "repo",
+        "installation",
+        "membership",
+        "release",
+        "other"
+      ],
+      "description": "What an event is about.",
+      "x-forges-type": "EventKind"
+    },
+    "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"
+    },
+    "WebhookRef": {
+      "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`."
+        },
+        "target": {
+          "$ref": "#/definitions/RepoRef",
+          "description": "The repository or namespace that the hook is registered on."
+        },
+        "id": {
+          "type": "string",
+          "description": "Forge-native hook id."
+        }
+      },
+      "required": [
+        "forge",
+        "id",
+        "instance",
+        "target"
+      ],
+      "description": "Reference to a registered webhook. `target` is the repository, or a namespace ref (`kind: 'namespace'`, empty `name`) for an organisation or workspace hook.",
+      "x-forges-type": "WebhookRef"
+    }
+  }
+}