forges 0.0.0 → 0.1.0

package/dist/schema/ThreadRef.json

@@ -0,0 +1,131 @@
+{
+  "$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`."
+    },
+    "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",
+  "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"
+    },
+    "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"
+    }
+  }
+}

package/dist/schema/ThreadStack.json

@@ -0,0 +1,146 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "description": "Forge-native stack id, where the forge names stacks."
+    },
+    "parent": {
+      "$ref": "#/definitions/ThreadRef",
+      "description": "The pull request this one is stacked on. Absent for the root of the stack."
+    }
+  },
+  "description": "Where a pull request sits in a stack of pull requests.",
+  "x-forges-type": "ThreadStack",
+  "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"
+    },
+    "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/ThreadState.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "open",
+    "closed",
+    "merged",
+    "unknown"
+  ],
+  "description": "Thread state. `'unknown'` is distinct from any real state and signals that the value was not present in the payload, so the caller may enrich it with `threads.get()`. Draft status is orthogonal; see `Thread.isDraft`.",
+  "x-forges-type": "ThreadState",
+  "definitions": {}
+}

package/dist/schema/TreeEntry.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "path": {
+      "type": "string",
+      "description": "Path from the repository root, without a leading slash."
+    },
+    "type": {
+      "$ref": "#/definitions/TreeEntryType"
+    },
+    "sha": {
+      "type": "string"
+    },
+    "size": {
+      "type": "number",
+      "description": "The size in bytes, for a file."
+    },
+    "mode": {
+      "type": "string",
+      "description": "POSIX mode as the forge reports it, for example `100644`."
+    },
+    "url": {
+      "type": "string"
+    }
+  },
+  "required": [
+    "path",
+    "type"
+  ],
+  "description": "One entry of a repository tree.",
+  "x-forges-type": "TreeEntry",
+  "definitions": {
+    "TreeEntryType": {
+      "type": "string",
+      "enum": [
+        "file",
+        "directory",
+        "symlink",
+        "submodule"
+      ],
+      "description": "What a tree entry is.",
+      "x-forges-type": "TreeEntryType"
+    }
+  }
+}

package/dist/schema/TreeEntryType.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "file",
+    "directory",
+    "symlink",
+    "submodule"
+  ],
+  "description": "What a tree entry is.",
+  "x-forges-type": "TreeEntryType",
+  "definitions": {}
+}