forges 0.0.0 → 0.1.0

package/dist/schema/Notification.json

@@ -0,0 +1,498 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "ref": {
+      "$ref": "#/definitions/NotificationRef"
+    },
+    "subject": {
+      "$ref": "#/definitions/NotificationSubject"
+    },
+    "reason": {
+      "$ref": "#/definitions/NotificationReason",
+      "description": "Why the account got the notification."
+    },
+    "reasonRaw": {
+      "type": "string",
+      "description": "Forge-native reason string. Absent when the forge reports no reason at all."
+    },
+    "subjectTypeRaw": {
+      "type": "string",
+      "description": "Forge-native subject type, for example `PullRequest`, `Release` or `followed`."
+    },
+    "unread": {
+      "type": "boolean"
+    },
+    "title": {
+      "type": "string"
+    },
+    "subjectState": {
+      "$ref": "#/definitions/ThreadState",
+      "description": "State of a thread subject as reported by the notification payload."
+    },
+    "subjectStateRaw": {
+      "type": "string"
+    },
+    "updatedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "lastReadAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "url": {
+      "type": "string"
+    },
+    "raw": {
+      "description": "Unnormalised forge payload, retained for fidelity."
+    }
+  },
+  "required": [
+    "ref",
+    "subject",
+    "reason",
+    "unread",
+    "title",
+    "subjectState",
+    "updatedAt",
+    "raw"
+  ],
+  "description": "A notification of the authenticated account.",
+  "x-forges-type": "Notification",
+  "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"
+    },
+    "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"
+    },
+    "NotificationReason": {
+      "type": "string",
+      "enum": [
+        "access_requested",
+        "approval_requested",
+        "assigned",
+        "author",
+        "ci_activity",
+        "comment",
+        "followed",
+        "invitation",
+        "manual",
+        "mention",
+        "merge_blocked",
+        "review_requested",
+        "review_submitted",
+        "security_alert",
+        "starred",
+        "state_change",
+        "subscribed",
+        "team_mention",
+        "unknown"
+      ],
+      "description": "Why a notification was delivered. `'unknown'` covers forges that report no reason and native reasons with no normalised equivalent; `reasonRaw` keeps the original.",
+      "x-forges-type": "NotificationReason"
+    },
+    "NotificationRef": {
+      "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`."
+        },
+        "id": {
+          "type": "string",
+          "description": "Forge-native notification identifier, used for read/done/unsubscribe writes."
+        }
+      },
+      "required": [
+        "forge",
+        "id",
+        "instance"
+      ],
+      "description": "Reference to a notification. Distinct from {@link ThreadRef}: a notification is a per-user delivery record whose lifetime and identity are independent of the thread it points at.",
+      "x-forges-type": "NotificationRef"
+    },
+    "NotificationSubject": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "thread"
+            },
+            "thread": {
+              "$ref": "#/definitions/ThreadRef"
+            }
+          },
+          "required": [
+            "type",
+            "thread"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "repo"
+            },
+            "repo": {
+              "$ref": "#/definitions/RepoRef"
+            }
+          },
+          "required": [
+            "type",
+            "repo"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "actor"
+            },
+            "actor": {
+              "$ref": "#/definitions/Actor"
+            }
+          },
+          "required": [
+            "type",
+            "actor"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "release"
+            },
+            "release": {
+              "$ref": "#/definitions/ReleaseRef"
+            }
+          },
+          "required": [
+            "type",
+            "release"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "security_alert"
+            },
+            "alert": {
+              "$ref": "#/definitions/SecurityAlertRef"
+            }
+          },
+          "required": [
+            "type",
+            "alert"
+          ]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "other"
+            },
+            "typeRaw": {
+              "type": "string"
+            },
+            "repo": {
+              "$ref": "#/definitions/RepoRef"
+            },
+            "id": {
+              "type": "string"
+            },
+            "url": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "type",
+            "typeRaw"
+          ]
+        }
+      ],
+      "description": "What a notification is about. Not every notification concerns a thread.",
+      "x-forges-type": "NotificationSubject"
+    },
+    "ReleaseRef": {
+      "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"
+        },
+        "id": {
+          "type": "string",
+          "description": "Forge-native release id; the tag name on forges that key releases by tag."
+        },
+        "tag": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "forge",
+        "id",
+        "instance",
+        "repo"
+      ],
+      "description": "A release, as a notification subject or event target.",
+      "x-forges-type": "ReleaseRef"
+    },
+    "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"
+    },
+    "SecurityAlertKind": {
+      "type": "string",
+      "enum": [
+        "dependency",
+        "code_scanning",
+        "secret",
+        "advisory",
+        "other"
+      ],
+      "description": "What an alert is about. `other` is a kind that the model does not name.",
+      "x-forges-type": "SecurityAlertKind"
+    },
+    "SecurityAlertRef": {
+      "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"
+        },
+        "id": {
+          "type": "string",
+          "description": "Forge-native alert id. GitHub numbers each alert kind separately, so `kind` is needed to address one."
+        },
+        "kind": {
+          "$ref": "#/definitions/SecurityAlertKind"
+        },
+        "severityRaw": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "forge",
+        "id",
+        "instance",
+        "repo"
+      ],
+      "description": "A security alert: a vulnerable dependency, a code scanning result, a leaked secret or an advisory.",
+      "x-forges-type": "SecurityAlertRef"
+    },
+    "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"
+    },
+    "ThreadState": {
+      "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"
+    }
+  }
+}

package/dist/schema/NotificationReason.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "string",
+  "enum": [
+    "access_requested",
+    "approval_requested",
+    "assigned",
+    "author",
+    "ci_activity",
+    "comment",
+    "followed",
+    "invitation",
+    "manual",
+    "mention",
+    "merge_blocked",
+    "review_requested",
+    "review_submitted",
+    "security_alert",
+    "starred",
+    "state_change",
+    "subscribed",
+    "team_mention",
+    "unknown"
+  ],
+  "description": "Why a notification was delivered. `'unknown'` covers forges that report no reason and native reasons with no normalised equivalent; `reasonRaw` keeps the original.",
+  "x-forges-type": "NotificationReason",
+  "definitions": {}
+}

package/dist/schema/NotificationRef.json

@@ -0,0 +1,60 @@
+{
+  "$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`."
+    },
+    "id": {
+      "type": "string",
+      "description": "Forge-native notification identifier, used for read/done/unsubscribe writes."
+    }
+  },
+  "required": [
+    "forge",
+    "id",
+    "instance"
+  ],
+  "description": "Reference to a notification. Distinct from {@link ThreadRef}: a notification is a per-user delivery record whose lifetime and identity are independent of the thread it points at.",
+  "x-forges-type": "NotificationRef",
+  "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"
+    }
+  }
+}